[ { "path": ".devcontainer/devcontainer.json", "content": "// For format details, see https://aka.ms/devcontainer.json. For config options, see the\n// README at: https://github.com/devcontainers/templates/tree/main/src/python\n{\n \"name\": \"Python 3\",\n // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile\n \"image\": \"mcr.microsoft.com/devcontainers/python:3-3.14-trixie\",\n \"features\": {\n \"ghcr.io/devcontainers/features/copilot-cli:1\": {},\n \"ghcr.io/devcontainers/features/github-cli:1\": {},\n \"ghcr.io/devcontainers/features/go:1\": {},\n \"ghcr.io/devcontainers/features/node:1\": {},\n \"ghcr.io/devcontainers-extra/features/uv:1\": {},\n \"ghcr.io/schlich/devcontainer-features/just:0\": {},\n \"ghcr.io/devcontainers/features/dotnet:2\": {}\n }\n\n // Features to add to the dev container. More info: https://containers.dev/features.\n // \"features\": {},\n\n // Use 'forwardPorts' to make a list of ports inside the container available locally.\n // \"forwardPorts\": [],\n\n // Use 'postCreateCommand' to run commands after the container is created.\n // \"postCreateCommand\": \"pip3 install --user -r requirements.txt\",\n\n // Configure tool-specific properties.\n // \"customizations\": {},\n\n // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.\n // \"remoteUser\": \"root\"\n}\n" }, { "path": ".gitattributes", "content": ".github/workflows/*.lock.yml linguist-generated=true merge=ours\n\n# Generated files — keep LF line endings so codegen output is deterministic across platforms.\nnodejs/src/generated/* eol=lf linguist-generated=true\ndotnet/src/Generated/* eol=lf linguist-generated=true\npython/copilot/generated/* eol=lf linguist-generated=true\ngo/generated_session_events.go eol=lf linguist-generated=true\ngo/rpc/generated_rpc.go eol=lf linguist-generated=true" }, { "path": ".github/CODEOWNERS", "content": "* @github/copilot-sdk\n" }, { "path": ".github/actions/setup-copilot/action.yml", "content": "name: \"Setup Copilot\"\ndescription: \"Setup Copilot based on the project's package.json file.\"\noutputs:\n cli-path:\n description: \"Path to the Copilot CLI\"\n value: ${{ steps.cli-path.outputs.path }}\nruns:\n using: \"composite\"\n steps:\n - uses: actions/setup-node@v6\n with:\n cache: \"npm\"\n cache-dependency-path: \"./nodejs/package-lock.json\"\n node-version: 22\n - name: Install dependencies\n run: npm --prefix \"$(pwd)/nodejs\" ci --ignore-scripts\n shell: bash\n - name: Set CLI path\n id: cli-path\n run: echo \"path=$(pwd)/nodejs/node_modules/@github/copilot/index.js\" >> $GITHUB_OUTPUT\n shell: bash\n - name: Verify CLI works\n run: node ${{ steps.cli-path.outputs.path }} --version\n shell: bash\n" }, { "path": ".github/agents/agentic-workflows.agent.md", "content": "---\ndescription: GitHub Agentic Workflows (gh-aw) - Create, debug, and upgrade AI-powered workflows with intelligent prompt routing\ndisable-model-invocation: true\n---\n\n# GitHub Agentic Workflows Agent\n\nThis agent helps you work with **GitHub Agentic Workflows (gh-aw)**, a CLI extension for creating AI-powered workflows in natural language using markdown files.\n\n## What This Agent Does\n\nThis is a **dispatcher agent** that routes your request to the appropriate specialized prompt based on your task:\n\n- **Creating new workflows**: Routes to `create` prompt\n- **Updating existing workflows**: Routes to `update` prompt\n- **Debugging workflows**: Routes to `debug` prompt \n- **Upgrading workflows**: Routes to `upgrade-agentic-workflows` prompt\n- **Creating report-generating workflows**: Routes to `report` prompt — consult this whenever the workflow posts status updates, audits, analyses, or any structured output as issues, discussions, or comments\n- **Creating shared components**: Routes to `create-shared-agentic-workflow` prompt\n- **Fixing Dependabot PRs**: Routes to `dependabot` prompt — use this when Dependabot opens PRs that modify generated manifest files (`.github/workflows/package.json`, `.github/workflows/requirements.txt`, `.github/workflows/go.mod`). Never merge those PRs directly; instead update the source `.md` files and rerun `gh aw compile --dependabot` to bundle all fixes\n- **Analyzing test coverage**: Routes to `test-coverage` prompt — consult this whenever the workflow reads, analyzes, or reports on test coverage data from PRs or CI runs\n\nWorkflows may optionally include:\n\n- **Project tracking / monitoring** (GitHub Projects updates, status reporting)\n- **Orchestration / coordination** (one workflow assigning agents or dispatching and coordinating other workflows)\n\n## Files This Applies To\n\n- Workflow files: `.github/workflows/*.md` and `.github/workflows/**/*.md`\n- Workflow lock files: `.github/workflows/*.lock.yml`\n- Shared components: `.github/workflows/shared/*.md`\n- Configuration: https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/github-agentic-workflows.md\n\n## Problems This Solves\n\n- **Workflow Creation**: Design secure, validated agentic workflows with proper triggers, tools, and permissions\n- **Workflow Debugging**: Analyze logs, identify missing tools, investigate failures, and fix configuration issues\n- **Version Upgrades**: Migrate workflows to new gh-aw versions, apply codemods, fix breaking changes\n- **Component Design**: Create reusable shared workflow components that wrap MCP servers\n\n## How to Use\n\nWhen you interact with this agent, it will:\n\n1. **Understand your intent** - Determine what kind of task you're trying to accomplish\n2. **Route to the right prompt** - Load the specialized prompt file for your task\n3. **Execute the task** - Follow the detailed instructions in the loaded prompt\n\n## Available Prompts\n\n### Create New Workflow\n**Load when**: User wants to create a new workflow from scratch, add automation, or design a workflow that doesn't exist yet\n\n**Prompt file**: https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/create-agentic-workflow.md\n\n**Use cases**:\n- \"Create a workflow that triages issues\"\n- \"I need a workflow to label pull requests\"\n- \"Design a weekly research automation\"\n\n### Update Existing Workflow \n**Load when**: User wants to modify, improve, or refactor an existing workflow\n\n**Prompt file**: https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/update-agentic-workflow.md\n\n**Use cases**:\n- \"Add web-fetch tool to the issue-classifier workflow\"\n- \"Update the PR reviewer to use discussions instead of issues\"\n- \"Improve the prompt for the weekly-research workflow\"\n\n### Debug Workflow \n**Load when**: User needs to investigate, audit, debug, or understand a workflow, troubleshoot issues, analyze logs, or fix errors\n\n**Prompt file**: https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/debug-agentic-workflow.md\n\n**Use cases**:\n- \"Why is this workflow failing?\"\n- \"Analyze the logs for workflow X\"\n- \"Investigate missing tool calls in run #12345\"\n\n### Upgrade Agentic Workflows\n**Load when**: User wants to upgrade workflows to a new gh-aw version or fix deprecations\n\n**Prompt file**: https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/upgrade-agentic-workflows.md\n\n**Use cases**:\n- \"Upgrade all workflows to the latest version\"\n- \"Fix deprecated fields in workflows\"\n- \"Apply breaking changes from the new release\"\n\n### Create a Report-Generating Workflow\n**Load when**: The workflow being created or updated produces reports — recurring status updates, audit summaries, analyses, or any structured output posted as a GitHub issue, discussion, or comment\n\n**Prompt file**: https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/report.md\n\n**Use cases**:\n- \"Create a weekly CI health report\"\n- \"Post a daily security audit to Discussions\"\n- \"Add a status update comment to open PRs\"\n\n### Create Shared Agentic Workflow\n**Load when**: User wants to create a reusable workflow component or wrap an MCP server\n\n**Prompt file**: https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/create-shared-agentic-workflow.md\n\n**Use cases**:\n- \"Create a shared component for Notion integration\"\n- \"Wrap the Slack MCP server as a reusable component\"\n- \"Design a shared workflow for database queries\"\n\n### Fix Dependabot PRs\n**Load when**: User needs to close or fix open Dependabot PRs that update dependencies in generated manifest files (`.github/workflows/package.json`, `.github/workflows/requirements.txt`, `.github/workflows/go.mod`)\n\n**Prompt file**: https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/dependabot.md\n\n**Use cases**:\n- \"Fix the open Dependabot PRs for npm dependencies\"\n- \"Bundle and close the Dependabot PRs for workflow dependencies\"\n- \"Update @playwright/test to fix the Dependabot PR\"\n\n### Analyze Test Coverage\n**Load when**: The workflow reads, analyzes, or reports test coverage — whether triggered by a PR, a schedule, or a slash command. Always consult this prompt before designing the coverage data strategy.\n\n**Prompt file**: https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/test-coverage.md\n\n**Use cases**:\n- \"Create a workflow that comments coverage on PRs\"\n- \"Analyze coverage trends over time\"\n- \"Add a coverage gate that blocks PRs below a threshold\"\n\n## Instructions\n\nWhen a user interacts with you:\n\n1. **Identify the task type** from the user's request\n2. **Load the appropriate prompt** from the GitHub repository URLs listed above\n3. **Follow the loaded prompt's instructions** exactly\n4. **If uncertain**, ask clarifying questions to determine the right prompt\n\n## Quick Reference\n\n```bash\n# Initialize repository for agentic workflows\ngh aw init\n\n# Generate the lock file for a workflow\ngh aw compile [workflow-name]\n\n# Debug workflow runs\ngh aw logs [workflow-name]\ngh aw audit \n\n# Upgrade workflows\ngh aw fix --write\ngh aw compile --validate\n```\n\n## Key Features of gh-aw\n\n- **Natural Language Workflows**: Write workflows in markdown with YAML frontmatter\n- **AI Engine Support**: Copilot, Claude, Codex, or custom engines\n- **MCP Server Integration**: Connect to Model Context Protocol servers for tools\n- **Safe Outputs**: Structured communication between AI and GitHub API\n- **Strict Mode**: Security-first validation and sandboxing\n- **Shared Components**: Reusable workflow building blocks\n- **Repo Memory**: Persistent git-backed storage for agents\n- **Sandboxed Execution**: All workflows run in the Agent Workflow Firewall (AWF) sandbox, enabling full `bash` and `edit` tools by default\n\n## Important Notes\n\n- Always reference the instructions file at https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/github-agentic-workflows.md for complete documentation\n- Use the MCP tool `agentic-workflows` when running in GitHub Copilot Cloud\n- Workflows must be compiled to `.lock.yml` files before running in GitHub Actions\n- **Bash tools are enabled by default** - Don't restrict bash commands unnecessarily since workflows are sandboxed by the AWF\n- Follow security best practices: minimal permissions, explicit network access, no template injection\n- **Network configuration**: Use ecosystem identifiers (`node`, `python`, `go`, etc.) or explicit FQDNs in `network.allowed`. Bare shorthands like `npm` or `pypi` are **not** valid. See https://github.com/github/gh-aw/blob/v0.64.2/.github/aw/network.md for the full list of valid ecosystem identifiers and domain patterns.\n- **Single-file output**: When creating a workflow, produce exactly **one** workflow `.md` file. Do not create separate documentation files (architecture docs, runbooks, usage guides, etc.). If documentation is needed, add a brief `## Usage` section inside the workflow file itself.\n" }, { "path": ".github/agents/docs-maintenance.agent.md", "content": "---\ndescription: Audit SDK documentation and generate an actionable improvement plan.\ntools:\n - grep\n - glob\n - view\n - create\n - edit\n---\n\n# SDK Documentation Maintenance Agent\n\nYou are a documentation auditor for the GitHub Copilot SDK. Your job is to analyze the documentation and **produce a prioritized action plan** of improvements needed.\n\n## IMPORTANT: Output Format\n\n**You do NOT make changes directly.** Instead, you:\n\n1. **Audit** the documentation against the standards below\n2. **Generate a plan** as a markdown file with actionable items\n\nThe human will then review the plan and selectively ask Copilot to implement specific items.\n\n> **Note:** When run from github.com, the platform will automatically create a PR with your changes. When run locally, you just create the file.\n\n### Plan Output Format\n\nCreate a file called `docs/IMPROVEMENT_PLAN.md` with this structure:\n\n```markdown\n# Documentation Improvement Plan\n\nGenerated: [date]\nAudited by: docs-maintenance agent\n\n## Summary\n\n- **Coverage**: X% of SDK features documented\n- **Sample Accuracy**: X issues found\n- **Link Health**: X broken links\n- **Multi-language**: X missing examples\n\n## Critical Issues (Fix Immediately)\n\n### 1. [Issue Title]\n- **File**: `docs/path/to/file.md`\n- **Line**: ~42\n- **Problem**: [description]\n- **Fix**: [specific action to take]\n\n### 2. ...\n\n## High Priority (Should Fix Soon)\n\n### 1. [Issue Title]\n- **File**: `docs/path/to/file.md`\n- **Problem**: [description]\n- **Fix**: [specific action to take]\n\n## Medium Priority (Nice to Have)\n\n### 1. ...\n\n## Low Priority (Future Improvement)\n\n### 1. ...\n\n## Missing Documentation\n\nThe following SDK features lack documentation:\n\n- [ ] `feature_name` - needs new doc at `docs/path/suggested.md`\n- [ ] ...\n\n## Sample Code Fixes Needed\n\nThe following code samples don't match the SDK interface:\n\n### File: `docs/example.md`\n\n**Line ~25 - TypeScript sample uses wrong method name:**\n```typescript\n// Current (wrong):\nawait client.create_session()\n\n// Should be:\nawait client.createSession()\n```\n\n**Line ~45 - Python sample has camelCase:**\n```python\n# Current (wrong):\nclient = CopilotClient(cliPath=\"/usr/bin/copilot\")\n\n# Should be:\nclient = CopilotClient(cli_path=\"/usr/bin/copilot\")\n```\n\n## Broken Links\n\n| Source File | Line | Broken Link | Suggested Fix |\n|-------------|------|-------------|---------------|\n| `docs/a.md` | 15 | `./missing.md` | Remove or create file |\n\n## Consistency Issues\n\n- [ ] Term \"XXX\" used inconsistently (file1.md says \"A\", file2.md says \"B\")\n- [ ] ...\n```\n\nAfter creating this plan file, your work is complete. The platform (github.com) will handle creating a PR if applicable.\n\n## Documentation Standards\n\nThe SDK documentation must meet these quality standards:\n\n### 1. Feature Coverage\n\nEvery major SDK feature should be documented. Core features include:\n\n**Client & Connection:**\n- Client initialization and configuration\n- Connection modes (stdio vs TCP)\n- Authentication options\n\n**Session Management:**\n- Creating sessions\n- Resuming sessions\n- Destroying/deleting sessions\n- Listing sessions\n- Infinite sessions and compaction\n\n**Messaging:**\n- Sending messages\n- Attachments (file, directory, selection)\n- Streaming responses\n- Aborting requests\n\n**Tools:**\n- Registering custom tools\n- Tool schemas (JSON Schema)\n- Tool handlers\n- Permission handling\n\n**Hooks:**\n- Pre-tool use (permission control)\n- Post-tool use (result modification)\n- User prompt submitted\n- Session start/end\n- Error handling\n\n**MCP Servers:**\n- Local/stdio servers\n- Remote HTTP/SSE servers\n- Configuration options\n- Debugging MCP issues\n\n**Events:**\n- Event subscription\n- Event types\n- Streaming vs final events\n\n**Advanced:**\n- Custom providers (BYOK)\n- System message customization\n- Custom agents\n- Skills\n\n### 2. Multi-Language Support\n\nAll documentation must include examples for all four SDKs:\n- **Node.js / TypeScript**\n- **Python**\n- **Go**\n- **.NET (C#)**\n\nUse collapsible `
` sections with the first language open by default.\n\n### 3. Content Structure\n\nEach documentation file should include:\n- Clear title and introduction\n- Table of contents for longer docs\n- Code examples for all languages\n- Reference tables for options/parameters\n- Common patterns and use cases\n- Best practices section\n- \"See Also\" links to related docs\n\n### 4. Link Integrity\n\nAll internal links must:\n- Point to existing files\n- Use relative paths (e.g., `./hooks/overview.md`, `../debugging.md`)\n- Include anchor links where appropriate (e.g., `#session-start`)\n\n### 5. Consistency\n\nMaintain consistency in:\n- Terminology (use same terms across all docs)\n- Code style (consistent formatting in examples)\n- Section ordering (similar docs should have similar structure)\n- Voice and tone (clear, direct, developer-friendly)\n\n## Audit Checklist\n\nWhen auditing documentation, check:\n\n### Completeness\n- [ ] All major SDK features are documented\n- [ ] All four languages have examples\n- [ ] API reference covers all public methods\n- [ ] Configuration options are documented\n- [ ] Error scenarios are explained\n\n### Accuracy\n- [ ] Code examples are correct and runnable\n- [ ] Type signatures match actual SDK types\n- [ ] Default values are accurate\n- [ ] Behavior descriptions match implementation\n\n### Links\n- [ ] All internal links resolve to existing files\n- [ ] External links are valid and relevant\n- [ ] Anchor links point to existing sections\n\n### Discoverability\n- [ ] Clear navigation between related topics\n- [ ] Consistent \"See Also\" sections\n- [ ] Searchable content (good headings, keywords)\n- [ ] README links to key documentation\n\n### Clarity\n- [ ] Jargon is explained or avoided\n- [ ] Examples are practical and realistic\n- [ ] Complex topics have step-by-step explanations\n- [ ] Error messages are helpful\n\n## Documentation Structure\n\nThe expected documentation structure is:\n\n```\ndocs/\n├── getting-started.md # Quick start tutorial\n├── debugging.md # General debugging guide\n├── compatibility.md # SDK vs CLI feature comparison\n├── hooks/\n│ ├── overview.md # Hooks introduction\n│ ├── pre-tool-use.md # Permission control\n│ ├── post-tool-use.md # Result transformation\n│ ├── user-prompt-submitted.md\n│ ├── session-lifecycle.md\n│ └── error-handling.md\n└── mcp/\n ├── overview.md # MCP configuration\n └── debugging.md # MCP troubleshooting\n```\n\nAdditional directories to consider:\n- `docs/tools/` - Custom tool development\n- `docs/events/` - Event reference\n- `docs/advanced/` - Advanced topics (providers, agents, skills)\n- `docs/api/` - API reference (auto-generated or manual)\n\n## Audit Process\n\n### Step 1: Inventory Current Docs\n\n```bash\n# List all documentation files\nfind docs -name \"*.md\" -type f | sort\n\n# Check for README references\ngrep -r \"docs/\" README.md\n```\n\n### Step 2: Check Feature Coverage\n\nCompare documented features against SDK types:\n\n```bash\n# Node.js types\ngrep -E \"export (interface|type|class)\" nodejs/src/types.ts nodejs/src/client.ts nodejs/src/session.ts\n\n# Python types\ngrep -E \"^class |^def \" python/copilot/types.py python/copilot/client.py python/copilot/session.py\n\n# Go types\ngrep -E \"^type |^func \" go/types.go go/client.go go/session.go\n\n# .NET types\ngrep -E \"public (class|interface|enum)\" dotnet/src/Types.cs dotnet/src/Client.cs dotnet/src/Session.cs\n```\n\n### Step 3: Validate Links\n\n```bash\n# Find all markdown links\ngrep -roh '\\[.*\\](\\..*\\.md[^)]*' docs/\n\n# Check each link exists\nfor link in $(grep -roh '\\](\\..*\\.md' docs/ | sed 's/\\](//' | sort -u); do\n # Resolve relative to docs/\n if [ ! -f \"docs/$link\" ]; then\n echo \"Broken link: $link\"\n fi\ndone\n```\n\n### Step 4: Check Multi-Language Examples\n\n```bash\n# Ensure all docs have examples for each language\nfor file in $(find docs -name \"*.md\"); do\n echo \"=== $file ===\"\n grep -c \"Node.js\\|TypeScript\" \"$file\" || echo \"Missing Node.js\"\n grep -c \"Python\" \"$file\" || echo \"Missing Python\"\n grep -c \"Go\" \"$file\" || echo \"Missing Go\"\n grep -c \"\\.NET\\|C#\" \"$file\" || echo \"Missing .NET\"\ndone\n```\n\n### Step 5: Validate Code Samples Against SDK Interface\n\n**CRITICAL**: All code examples must match the actual SDK interface. Verify method names, parameter names, types, and return values.\n\n#### Node.js/TypeScript Validation\n\nCheck that examples use correct method signatures:\n\n```bash\n# Extract public methods from SDK\ngrep -E \"^\\s*(async\\s+)?[a-z][a-zA-Z]+\\(\" nodejs/src/client.ts nodejs/src/session.ts | head -50\n\n# Key interfaces to verify against\ncat nodejs/src/types.ts | grep -A 20 \"export interface CopilotClientOptions\"\ncat nodejs/src/types.ts | grep -A 50 \"export interface SessionConfig\"\ncat nodejs/src/types.ts | grep -A 20 \"export interface SessionHooks\"\ncat nodejs/src/types.ts | grep -A 10 \"export interface ExportSessionOptions\"\n```\n\n**Must match:**\n- `CopilotClient` constructor options: `cliPath`, `cliUrl`, `useStdio`, `port`, `logLevel`, `autoStart`, `env`, `githubToken`, `useLoggedInUser`\n- `createSession()` config: `model`, `tools`, `hooks`, `systemMessage`, `mcpServers`, `availableTools`, `excludedTools`, `streaming`, `reasoningEffort`, `provider`, `infiniteSessions`, `customAgents`, `workingDirectory`\n- `CopilotSession` methods: `send()`, `sendAndWait()`, `getMessages()`, `disconnect()`, `abort()`, `on()`, `once()`, `off()`\n- Hook names: `onPreToolUse`, `onPostToolUse`, `onUserPromptSubmitted`, `onSessionStart`, `onSessionEnd`, `onErrorOccurred`\n\n#### Python Validation\n\n```bash\n# Extract public methods\ngrep -E \"^\\s+async def [a-z]\" python/copilot/client.py python/copilot/session.py\n\n# Key types\ncat python/copilot/types.py | grep -A 20 \"class CopilotClientOptions\"\ncat python/copilot/types.py | grep -A 30 \"class SessionConfig\"\ncat python/copilot/types.py | grep -A 15 \"class SessionHooks\"\n```\n\n**Must match (snake_case):**\n- `CopilotClient` options: `cli_path`, `cli_url`, `use_stdio`, `port`, `log_level`, `auto_start`, `env`, `github_token`, `use_logged_in_user`\n- `create_session()` config keys: `model`, `tools`, `hooks`, `system_message`, `mcp_servers`, `available_tools`, `excluded_tools`, `streaming`, `reasoning_effort`, `provider`, `infinite_sessions`, `custom_agents`, `working_directory`\n- `CopilotSession` methods: `send()`, `send_and_wait()`, `get_messages()`, `disconnect()`, `abort()`, `export_session()`\n- Hook names: `on_pre_tool_use`, `on_post_tool_use`, `on_user_prompt_submitted`, `on_session_start`, `on_session_end`, `on_error_occurred`\n\n#### Go Validation\n\n```bash\n# Extract public methods (capitalized = exported)\ngrep -E \"^func \\([a-z]+ \\*[A-Z]\" go/client.go go/session.go\n\n# Key types\ncat go/types.go | grep -A 20 \"type ClientOptions struct\"\ncat go/types.go | grep -A 30 \"type SessionConfig struct\"\ncat go/types.go | grep -A 15 \"type SessionHooks struct\"\n```\n\n**Must match (PascalCase for exported):**\n- `ClientOptions` fields: `CLIPath`, `CLIUrl`, `UseStdio`, `Port`, `LogLevel`, `AutoStart`, `Env`, `GithubToken`, `UseLoggedInUser`\n- `SessionConfig` fields: `Model`, `Tools`, `Hooks`, `SystemMessage`, `MCPServers`, `AvailableTools`, `ExcludedTools`, `Streaming`, `ReasoningEffort`, `Provider`, `InfiniteSessions`, `CustomAgents`, `WorkingDirectory`\n- `Session` methods: `Send()`, `SendAndWait()`, `GetMessages()`, `Disconnect()`, `Abort()`, `ExportSession()`\n- Hook fields: `OnPreToolUse`, `OnPostToolUse`, `OnUserPromptSubmitted`, `OnSessionStart`, `OnSessionEnd`, `OnErrorOccurred`\n\n#### .NET Validation\n\n```bash\n# Extract public methods\ngrep -E \"public (async Task|void|[A-Z])\" dotnet/src/Client.cs dotnet/src/Session.cs | head -50\n\n# Key types\ncat dotnet/src/Types.cs | grep -A 20 \"public class CopilotClientOptions\"\ncat dotnet/src/Types.cs | grep -A 40 \"public class SessionConfig\"\ncat dotnet/src/Types.cs | grep -A 15 \"public class SessionHooks\"\n```\n\n**Must match (PascalCase):**\n- `CopilotClientOptions` properties: `CliPath`, `CliUrl`, `UseStdio`, `Port`, `LogLevel`, `AutoStart`, `Environment`, `GithubToken`, `UseLoggedInUser`\n- `SessionConfig` properties: `Model`, `Tools`, `Hooks`, `SystemMessage`, `McpServers`, `AvailableTools`, `ExcludedTools`, `Streaming`, `ReasoningEffort`, `Provider`, `InfiniteSessions`, `CustomAgents`, `WorkingDirectory`\n- `CopilotSession` methods: `SendAsync()`, `SendAndWaitAsync()`, `GetMessagesAsync()`, `DisposeAsync()`, `AbortAsync()`, `ExportSessionAsync()`\n- Hook properties: `OnPreToolUse`, `OnPostToolUse`, `OnUserPromptSubmitted`, `OnSessionStart`, `OnSessionEnd`, `OnErrorOccurred`\n\n#### Common Sample Errors to Check\n\n1. **Wrong method names:**\n - ❌ `client.create_session()` in TypeScript (should be `createSession()`)\n - ❌ `session.SendAndWait()` in Python (should be `send_and_wait()`)\n - ❌ `client.CreateSession()` in Go without context (should be `CreateSession(ctx, config)`)\n\n2. **Wrong parameter names:**\n - ❌ `{ cli_path: \"...\" }` in TypeScript (should be `cliPath`)\n - ❌ `{ cliPath: \"...\" }` in Python (should be `cli_path`)\n - ❌ `McpServers` in Go (should be `MCPServers`)\n\n3. **Missing required parameters:**\n - Go methods require `context.Context` as first parameter\n - .NET async methods should use `CancellationToken`\n\n4. **Wrong hook structure:**\n - ❌ `hooks: { preToolUse: ... }` (should be `onPreToolUse`)\n - ❌ `hooks: { OnPreToolUse: ... }` in Python (should be `on_pre_tool_use`)\n\n5. **Outdated APIs:**\n - Check for deprecated method names\n - Verify against latest SDK version\n\n#### Validation Script\n\nRun this to extract all code blocks and check for common issues:\n\n```bash\n# Extract TypeScript examples and check for Python-style naming\ngrep -A 20 '```typescript' docs/**/*.md | grep -E \"cli_path|create_session|send_and_wait\" && echo \"ERROR: Python naming in TypeScript\"\n\n# Extract Python examples and check for camelCase\ngrep -A 20 '```python' docs/**/*.md | grep -E \"cliPath|createSession|sendAndWait\" && echo \"ERROR: camelCase in Python\"\n\n# Check Go examples have context parameter\ngrep -A 20 '```go' docs/**/*.md | grep -E \"CreateSession\\([^c]|Send\\([^c]\" && echo \"WARNING: Go method may be missing context\"\n```\n\n### Step 6: Create the Plan\n\nAfter completing the audit:\n\n1. Create `docs/IMPROVEMENT_PLAN.md` with all findings organized by priority\n2. Your work is complete - the platform handles PR creation\n\nThe human reviewer can then:\n- Review the plan\n- Comment on specific items to prioritize\n- Ask Copilot to implement specific fixes from the plan\n\n## Remember\n\n- **You are an auditor, not a fixer** - your job is to find issues and document them clearly\n- Each item in the plan should be **actionable** - specific enough that someone (or Copilot) can fix it\n- Include **file paths and line numbers** where possible\n- Show **before/after code** for sample fixes\n- Prioritize issues by **impact on developers**\n- The plan becomes the work queue for future improvements\n" }, { "path": ".github/aw/actions-lock.json", "content": "{\n \"entries\": {\n \"actions/checkout@v6.0.2\": {\n \"repo\": \"actions/checkout\",\n \"version\": \"v6.0.2\",\n \"sha\": \"de0fac2e4500dabe0009e67214ff5f5447ce83dd\"\n },\n \"actions/download-artifact@v8.0.0\": {\n \"repo\": \"actions/download-artifact\",\n \"version\": \"v8.0.0\",\n \"sha\": \"70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3\"\n },\n \"actions/github-script@v8\": {\n \"repo\": \"actions/github-script\",\n \"version\": \"v8\",\n \"sha\": \"ed597411d8f924073f98dfc5c65a23a2325f34cd\"\n },\n \"actions/upload-artifact@v7.0.0\": {\n \"repo\": \"actions/upload-artifact\",\n \"version\": \"v7.0.0\",\n \"sha\": \"bbbca2ddaa5d8feaa63e36b76fdaad77386f024f\"\n },\n \"github/gh-aw-actions/setup@v0.67.4\": {\n \"repo\": \"github/gh-aw-actions/setup\",\n \"version\": \"v0.67.4\",\n \"sha\": \"9d6ae06250fc0ec536a0e5f35de313b35bad7246\"\n },\n \"github/gh-aw/actions/setup@v0.52.1\": {\n \"repo\": \"github/gh-aw/actions/setup\",\n \"version\": \"v0.52.1\",\n \"sha\": \"a86e657586e4ac5f549a790628971ec02f6a4a8f\"\n }\n }\n}\n" }, { "path": ".github/aw/logs/.gitignore", "content": "# Ignore all downloaded workflow logs\n*\n# But keep the .gitignore file itself\n!.gitignore\n" }, { "path": ".github/commands/triage_feedback.yml", "content": "trigger: triage_feedback\ntitle: Triage feedback\ndescription: Provide feedback on the triage agent's classification of this issue\nsurfaces:\n - issue\nsteps:\n - type: form\n style: modal\n body:\n - type: textarea\n attributes:\n label: Feedback\n placeholder: Describe what the agent got wrong and what the correct action should have been...\n actions:\n submit: Submit feedback\n cancel: Cancel\n - type: repository_dispatch\n eventType: triage_feedback\n" }, { "path": ".github/copilot-instructions.md", "content": "# GitHub Copilot SDK — Assistant Instructions\n\n**Quick purpose:** Help contributors and AI coding agents quickly understand this mono-repo and be productive (build, test, add SDK features, add E2E tests). ✅\n\n## Big picture 🔧\n\n- The repo implements language SDKs (Node/TS, Python, Go, .NET) that speak to the **Copilot CLI** via **JSON‑RPC** (see `README.md` and `nodejs/src/client.ts`).\n- Typical flow: your App → SDK client → JSON-RPC → Copilot CLI (server mode). The CLI must be installed or you can connect to an external CLI server via the `CLI URL option (language-specific casing)` (Node: `cliUrl`, Go: `CLIUrl`, .NET: `CliUrl`, Python: `cli_url`).\n\n## Most important files to read first 📚\n\n- Top-level: `README.md` (architecture + quick start)\n- Language entry points: `nodejs/src/client.ts`, `python/README.md`, `go/README.md`, `dotnet/README.md`\n- Test harness & E2E: `test/harness/*`, Python harness wrapper `python/e2e/testharness/proxy.py`\n- Schemas & type generation: `nodejs/scripts/generate-session-types.ts`\n- Session snapshots used by E2E: `test/snapshots/` (used by the replay proxy)\n\n## Developer workflows (commands you’ll use often) ▶️\n\n- Monorepo helpers: use `just` tasks from repo root:\n - Install deps: `just install` (runs npm ci, uv pip install -e, go mod download, dotnet restore)\n - Format all: `just format` | Lint all: `just lint` | Test all: `just test`\n- Per-language:\n - Node: `cd nodejs && npm ci` → `npm test` (Vitest), `npm run generate:session-types` to regenerate session-event types\n - Python: `cd python && uv pip install -e \".[dev]\"` → `uv run pytest` (E2E tests use the test harness)\n - Go: `cd go && go test ./...`\n - .NET: `cd dotnet && dotnet test test/GitHub.Copilot.SDK.Test.csproj`\n - **.NET testing note:** Never add `InternalsVisibleTo` to any project file when writing tests. Tests must only access public APIs.\n\n## Testing & E2E tips ⚙️\n\n- E2E runs against a local **replaying CAPI proxy** (see `test/harness/server.ts`). Most language E2E harnesses spawn that server automatically (see `python/e2e/testharness/proxy.py`).\n- Tests rely on YAML snapshot exchanges under `test/snapshots/` — to add test scenarios, add or edit the appropriate YAML files and update tests.\n- The harness prints `Listening: http://...` — tests parse this URL to configure CLI or proxy.\n\n## Project-specific conventions & patterns ✅\n\n- Tools: each SDK has helper APIs to expose functions as tools; prefer the language's `DefineTool`/`@define_tool`/`AIFunctionFactory.Create` patterns (see language READMEs).\n- Infinite sessions are enabled by default and persist workspace state to `~/.copilot/session-state/{sessionId}`; compaction events are emitted (`session.compaction_start`, `session.compaction_complete`). See language READMEs for usage.\n- Streaming: when `streaming`/`Streaming=true` you receive delta events (`assistant.message_delta`, `assistant.reasoning_delta`) and final events (`assistant.message`, `assistant.reasoning`) — tests expect this behavior.\n- Type generation is centralized in `nodejs/scripts/generate-session-types.ts` and requires the `@github/copilot` schema to be present (often via `npm link` or installed package).\n\n## Integration & environment notes ⚠️\n\n- The SDK requires a Copilot CLI installation or an external server reachable via the `CLI URL option (language-specific casing)` (Node: `cliUrl`, Go: `CLIUrl`, .NET: `CliUrl`, Python: `cli_url`) or `COPILOT_CLI_PATH`.\n- Some scripts (typegen, formatting) call external tools: `gofmt`, `dotnet format`, `tsx` (available via npm), `quicktype`/`quicktype-core` (used by the Node typegen script), and `prettier` (provided as an npm devDependency). Most of these are available through the repo's package scripts or devDependencies—run `just install` (and `cd nodejs && npm ci`) to install them. Ensure the required tools are available in CI / developer machines.\n- Tests may assume `node >= 18`, `python >= 3.9`, platform differences handled (Windows uses `shell=True` for npx in harness).\n\n## Where to add new code or tests 🧭\n\n- SDK code: `nodejs/src`, `python/copilot`, `go`, `dotnet/src`\n- Unit tests: `nodejs/test`, `python/*`, `go/*`, `dotnet/test`\n- E2E tests: `*/e2e/` folders that use the shared replay proxy and `test/snapshots/`\n- Generated types: update schema in `@github/copilot` then run `cd nodejs && npm run generate:session-types` and commit generated files in `src/generated` or language generated location.\n" }, { "path": ".github/dependabot.yaml", "content": "version: 2\nmulti-ecosystem-groups:\n all:\n schedule:\n interval: 'weekly'\nupdates:\n - package-ecosystem: 'github-actions'\n directory: '/'\n multi-ecosystem-group: 'all'\n patterns: ['*']\n - package-ecosystem: 'devcontainers'\n directory: '/'\n multi-ecosystem-group: 'all'\n patterns: ['*']\n # Node.js dependencies\n - package-ecosystem: 'npm'\n directory: '/nodejs'\n multi-ecosystem-group: 'all'\n patterns: ['*']\n - package-ecosystem: 'npm'\n directory: '/test/harness'\n multi-ecosystem-group: 'all'\n patterns: ['*']\n # Python dependencies\n - package-ecosystem: 'pip'\n directory: '/python'\n multi-ecosystem-group: 'all'\n patterns: ['*']\n # Go dependencies\n - package-ecosystem: 'gomod'\n directory: '/go'\n multi-ecosystem-group: 'all'\n patterns: ['*']\n # .NET dependencies\n - package-ecosystem: 'nuget'\n directory: '/dotnet'\n multi-ecosystem-group: 'all'\n patterns: ['*']\n" }, { "path": ".github/lsp.json", "content": "{\n \"lspServers\": {\n \"csharp\": {\n \"command\": \"dotnet\",\n \"args\": [\n \"tool\",\n \"run\",\n \"roslyn-language-server\",\n \"--stdio\",\n \"--autoLoadProjects\"\n ],\n \"fileExtensions\": {\n \".cs\": \"csharp\"\n },\n \"rootUri\": \"dotnet\"\n },\n \"go\": {\n \"command\": \"gopls\",\n \"args\": [\"serve\"],\n \"fileExtensions\": {\n \".go\": \"go\"\n },\n \"rootUri\": \"go\"\n }\n }\n}\n" }, { "path": ".github/workflows/codegen-check.yml", "content": "name: \"Codegen Check\"\n\non:\n push:\n branches:\n - main\n pull_request:\n types: [opened, synchronize, reopened, ready_for_review]\n paths:\n - 'scripts/codegen/**'\n - 'nodejs/src/generated/**'\n - 'dotnet/src/Generated/**'\n - 'python/copilot/generated/**'\n - 'go/generated_*.go'\n - 'go/rpc/**'\n - '.github/workflows/codegen-check.yml'\n workflow_dispatch:\n\npermissions:\n contents: read\n\njobs:\n check:\n name: \"Verify generated files are up-to-date\"\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n\n - uses: actions/setup-node@v4\n with:\n node-version: 22\n\n - uses: actions/setup-go@v5\n with:\n go-version: '1.22'\n\n - name: Install nodejs SDK dependencies\n working-directory: ./nodejs\n run: npm ci\n\n - name: Install codegen dependencies\n working-directory: ./scripts/codegen\n run: npm ci\n\n - name: Run codegen\n working-directory: ./scripts/codegen\n run: npm run generate\n\n - name: Check for uncommitted changes\n run: |\n if [ -n \"$(git status --porcelain)\" ]; then\n echo \"::error::Generated files are out of date. Run 'cd scripts/codegen && npm run generate' and commit the changes.\"\n git diff --stat\n git diff\n exit 1\n fi\n echo \"✅ Generated files are up-to-date\"\n" }, { "path": ".github/workflows/collect-corrections.yml", "content": "name: Submit triage agent feedback\n\non:\n repository_dispatch:\n types: [triage_feedback]\n workflow_dispatch:\n inputs:\n issue_number:\n description: \"Issue number to submit feedback for\"\n required: true\n type: string\n feedback:\n description: \"Feedback text describing what the triage agent got wrong\"\n required: true\n type: string\n\nconcurrency:\n group: collect-corrections\n cancel-in-progress: false\n\npermissions:\n issues: write\n contents: read\n\njobs:\n collect:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - uses: actions/github-script@v8\n with:\n script: |\n const script = require('./scripts/corrections/collect-corrections.js')\n await script({ github, context })\n" }, { "path": ".github/workflows/copilot-setup-steps.yml", "content": "name: \"Copilot Setup Steps\"\n\n# This workflow configures the environment for GitHub Copilot Agent\n# Automatically run the setup steps when they are changed to allow for easy validation\non:\n workflow_dispatch:\n push:\n paths:\n - .github/workflows/copilot-setup-steps.yml\n pull_request:\n paths:\n - .github/workflows/copilot-setup-steps.yml\n\njobs:\n # The job MUST be called 'copilot-setup-steps' to be recognized by GitHub Copilot Agent\n copilot-setup-steps:\n runs-on: ubuntu-latest\n\n # Set minimal permissions for setup steps\n # Copilot Agent receives its own token with appropriate permissions\n permissions:\n contents: read\n\n steps:\n # Checkout the repository to install dependencies\n - name: Checkout code\n uses: actions/checkout@v6.0.2\n\n # Setup Node.js (for TypeScript/JavaScript SDK and tooling)\n - name: Set up Node.js\n uses: actions/setup-node@v6\n with:\n node-version: \"22\"\n cache: \"npm\"\n cache-dependency-path: |\n ./nodejs/package-lock.json\n ./test/harness/package-lock.json\n\n # Setup Python (for Python SDK)\n - name: Set up Python\n uses: actions/setup-python@v6\n with:\n python-version: \"3.12\"\n\n # Setup uv (Python package manager used in this repo)\n - name: Set up uv\n uses: astral-sh/setup-uv@v7\n with:\n enable-cache: true\n\n # Setup Go (for Go SDK)\n - name: Set up Go\n uses: actions/setup-go@v6\n with:\n go-version: \"1.24\"\n\n # Setup .NET (for .NET SDK)\n - name: Set up .NET\n uses: actions/setup-dotnet@v5\n with:\n dotnet-version: \"10.0.x\"\n\n # Install just command runner\n - name: Install just\n uses: extractions/setup-just@v3\n\n # Install gh-aw extension for advanced GitHub CLI features\n - name: Install gh-aw extension\n run: |\n curl -fsSL https://raw.githubusercontent.com/githubnext/gh-aw/refs/heads/main/install-gh-aw.sh | bash\n\n # Install JavaScript dependencies\n - name: Install Node.js dependencies\n working-directory: ./nodejs\n run: npm ci --ignore-scripts\n\n # Install Python dependencies\n - name: Install Python dependencies\n working-directory: ./python\n run: uv sync --all-extras --dev\n\n # Install Go dependencies\n - name: Install Go dependencies\n working-directory: ./go\n run: go mod download\n\n # Restore .NET dependencies\n - name: Restore .NET dependencies\n working-directory: ./dotnet\n run: dotnet restore\n\n # Install test harness dependencies\n - name: Install test harness dependencies\n working-directory: ./test/harness\n run: npm ci --ignore-scripts\n\n # Verify installations\n - name: Verify tool installations\n run: |\n echo \"=== Verifying installations ===\"\n node --version\n npm --version\n python --version\n uv --version\n go version\n dotnet --version\n just --version\n gh --version\n gh aw version\n echo \"✅ All tools installed successfully\"\n" }, { "path": ".github/workflows/corrections-tests.yml", "content": "name: \"Triage Agent Corrections Tests\"\n\non:\n push:\n branches: [main]\n paths:\n - 'scripts/corrections/**'\n pull_request:\n types: [opened, synchronize, reopened, ready_for_review]\n paths:\n - 'scripts/corrections/**'\n\npermissions:\n contents: read\n\njobs:\n test:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n with:\n node-version: 24\n - run: npm ci\n working-directory: scripts/corrections\n - run: npm test\n working-directory: scripts/corrections\n" }, { "path": ".github/workflows/cross-repo-issue-analysis.lock.yml", "content": "# ___ _ _ \n# / _ \\ | | (_) \n# | |_| | __ _ ___ _ __ | |_ _ ___ \n# | _ |/ _` |/ _ \\ '_ \\| __| |/ __|\n# | | | | (_| | __/ | | | |_| | (__ \n# \\_| |_/\\__, |\\___|_| |_|\\__|_|\\___|\n# __/ |\n# _ _ |___/ \n# | | | | / _| |\n# | | | | ___ _ __ _ __| |_| | _____ ____\n# | |/\\| |/ _ \\ '__| |/ /| _| |/ _ \\ \\ /\\ / / ___|\n# \\ /\\ / (_) | | | | ( | | | | (_) \\ V V /\\__ \\\n# \\/ \\/ \\___/|_| |_|\\_\\|_| |_|\\___/ \\_/\\_/ |___/\n#\n# This file was automatically generated by gh-aw (v0.65.5). DO NOT EDIT.\n#\n# To update this file, edit the corresponding .md file and run:\n# gh aw compile\n# Not all edits will cause changes to this file.\n#\n# For more information: https://github.github.com/gh-aw/introduction/overview/\n#\n# Analyzes copilot-sdk issues to determine if a fix is needed in copilot-agent-runtime, then opens a linked issue there\n#\n# gh-aw-metadata: {\"schema_version\":\"v3\",\"frontmatter_hash\":\"bbe407b2d324d84d7c6653015841817713551b010318cee1ec12dd5c1c077977\",\"compiler_version\":\"v0.65.5\",\"strict\":true,\"agent_id\":\"copilot\"}\n\nname: \"SDK Runtime Triage\"\n\"on\":\n issues:\n types:\n - labeled\n workflow_dispatch:\n inputs:\n aw_context:\n default: \"\"\n description: Agent caller context (used internally by Agentic Workflows).\n required: false\n type: string\n issue_number:\n description: Issue number to analyze\n required: true\n type: string\n\npermissions: {}\n\nconcurrency:\n group: \"gh-aw-${{ github.workflow }}-${{ github.event.issue.number || github.run_id }}\"\n\nrun-name: \"SDK Runtime Triage\"\n\njobs:\n activation:\n needs: pre_activation\n if: >\n needs.pre_activation.outputs.activated == 'true' && (github.event_name == 'workflow_dispatch' || github.event.label.name == 'runtime triage')\n runs-on: ubuntu-slim\n permissions:\n contents: read\n outputs:\n body: ${{ steps.sanitized.outputs.body }}\n comment_id: \"\"\n comment_repo: \"\"\n lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }}\n model: ${{ steps.generate_aw_info.outputs.model }}\n secret_verification_result: ${{ steps.validate-secret.outputs.verification_result }}\n text: ${{ steps.sanitized.outputs.text }}\n title: ${{ steps.sanitized.outputs.title }}\n steps:\n - name: Setup Scripts\n uses: github/gh-aw-actions/setup@15b2fa31e9a1b771c9773c162273924d8f5ea516 # v0.65.5\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n - name: Generate agentic run info\n id: generate_aw_info\n env:\n GH_AW_INFO_ENGINE_ID: \"copilot\"\n GH_AW_INFO_ENGINE_NAME: \"GitHub Copilot CLI\"\n GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'auto' }}\n GH_AW_INFO_VERSION: \"latest\"\n GH_AW_INFO_AGENT_VERSION: \"latest\"\n GH_AW_INFO_CLI_VERSION: \"v0.65.5\"\n GH_AW_INFO_WORKFLOW_NAME: \"SDK Runtime Triage\"\n GH_AW_INFO_EXPERIMENTAL: \"false\"\n GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: \"true\"\n GH_AW_INFO_STAGED: \"false\"\n GH_AW_INFO_ALLOWED_DOMAINS: '[\"defaults\"]'\n GH_AW_INFO_FIREWALL_ENABLED: \"true\"\n GH_AW_INFO_AWF_VERSION: \"v0.25.10\"\n GH_AW_INFO_AWMG_VERSION: \"\"\n GH_AW_INFO_FIREWALL_TYPE: \"squid\"\n GH_AW_COMPILED_STRICT: \"true\"\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs');\n await main(core, context);\n - name: Validate COPILOT_GITHUB_TOKEN secret\n id: validate-secret\n run: ${RUNNER_TEMP}/gh-aw/actions/validate_multi_secret.sh COPILOT_GITHUB_TOKEN 'GitHub Copilot CLI' https://github.github.com/gh-aw/reference/engines/#github-copilot-default\n env:\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n - name: Checkout .github and .agents folders\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n sparse-checkout: |\n .github\n .agents\n sparse-checkout-cone-mode: true\n fetch-depth: 1\n - name: Check workflow file timestamps\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_WORKFLOW_FILE: \"cross-repo-issue-analysis.lock.yml\"\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/check_workflow_timestamp_api.cjs');\n await main();\n - name: Check compile-agentic version\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_COMPILED_VERSION: \"v0.65.5\"\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/check_version_updates.cjs');\n await main();\n - name: Compute current body text\n id: sanitized\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/compute_text.cjs');\n await main();\n - name: Create prompt with built-in context\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_SAFE_OUTPUTS: ${{ runner.temp }}/gh-aw/safeoutputs/outputs.jsonl\n GH_AW_EXPR_54492A5B: ${{ github.event.issue.number || inputs.issue_number }}\n GH_AW_GITHUB_ACTOR: ${{ github.actor }}\n GH_AW_GITHUB_EVENT_COMMENT_ID: ${{ github.event.comment.id }}\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: ${{ github.event.discussion.number }}\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: ${{ github.event.issue.number }}\n GH_AW_GITHUB_EVENT_ISSUE_TITLE: ${{ github.event.issue.title }}\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n GH_AW_GITHUB_RUN_ID: ${{ github.run_id }}\n GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }}\n # poutine:ignore untrusted_checkout_exec\n run: |\n bash ${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh\n {\n cat << 'GH_AW_PROMPT_cf83d6980df47851_EOF'\n \n GH_AW_PROMPT_cf83d6980df47851_EOF\n cat \"${RUNNER_TEMP}/gh-aw/prompts/xpia.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/markdown.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md\"\n cat << 'GH_AW_PROMPT_cf83d6980df47851_EOF'\n \n Tools: create_issue, add_labels(max:3), missing_tool, missing_data, noop\n \n \n The following GitHub context information is available for this workflow:\n {{#if __GH_AW_GITHUB_ACTOR__ }}\n - **actor**: __GH_AW_GITHUB_ACTOR__\n {{/if}}\n {{#if __GH_AW_GITHUB_REPOSITORY__ }}\n - **repository**: __GH_AW_GITHUB_REPOSITORY__\n {{/if}}\n {{#if __GH_AW_GITHUB_WORKSPACE__ }}\n - **workspace**: __GH_AW_GITHUB_WORKSPACE__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_ISSUE_NUMBER__ }}\n - **issue-number**: #__GH_AW_GITHUB_EVENT_ISSUE_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER__ }}\n - **discussion-number**: #__GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER__ }}\n - **pull-request-number**: #__GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_COMMENT_ID__ }}\n - **comment-id**: __GH_AW_GITHUB_EVENT_COMMENT_ID__\n {{/if}}\n {{#if __GH_AW_GITHUB_RUN_ID__ }}\n - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__\n {{/if}}\n \n \n GH_AW_PROMPT_cf83d6980df47851_EOF\n cat \"${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md\"\n cat << 'GH_AW_PROMPT_cf83d6980df47851_EOF'\n \n {{#runtime-import .github/workflows/cross-repo-issue-analysis.md}}\n GH_AW_PROMPT_cf83d6980df47851_EOF\n } > \"$GH_AW_PROMPT\"\n - name: Interpolate variables and render templates\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_EXPR_54492A5B: ${{ github.event.issue.number || inputs.issue_number }}\n GH_AW_GITHUB_EVENT_ISSUE_TITLE: ${{ github.event.issue.title }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/interpolate_prompt.cjs');\n await main();\n - name: Substitute placeholders\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_EXPR_54492A5B: ${{ github.event.issue.number || inputs.issue_number }}\n GH_AW_GITHUB_ACTOR: ${{ github.actor }}\n GH_AW_GITHUB_EVENT_COMMENT_ID: ${{ github.event.comment.id }}\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: ${{ github.event.discussion.number }}\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: ${{ github.event.issue.number }}\n GH_AW_GITHUB_EVENT_ISSUE_TITLE: ${{ github.event.issue.title }}\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n GH_AW_GITHUB_RUN_ID: ${{ github.run_id }}\n GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }}\n GH_AW_NEEDS_PRE_ACTIVATION_OUTPUTS_ACTIVATED: ${{ needs.pre_activation.outputs.activated }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n \n const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs');\n \n // Call the substitution function\n return await substitutePlaceholders({\n file: process.env.GH_AW_PROMPT,\n substitutions: {\n GH_AW_EXPR_54492A5B: process.env.GH_AW_EXPR_54492A5B,\n GH_AW_GITHUB_ACTOR: process.env.GH_AW_GITHUB_ACTOR,\n GH_AW_GITHUB_EVENT_COMMENT_ID: process.env.GH_AW_GITHUB_EVENT_COMMENT_ID,\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: process.env.GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER,\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: process.env.GH_AW_GITHUB_EVENT_ISSUE_NUMBER,\n GH_AW_GITHUB_EVENT_ISSUE_TITLE: process.env.GH_AW_GITHUB_EVENT_ISSUE_TITLE,\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: process.env.GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER,\n GH_AW_GITHUB_REPOSITORY: process.env.GH_AW_GITHUB_REPOSITORY,\n GH_AW_GITHUB_RUN_ID: process.env.GH_AW_GITHUB_RUN_ID,\n GH_AW_GITHUB_WORKSPACE: process.env.GH_AW_GITHUB_WORKSPACE,\n GH_AW_NEEDS_PRE_ACTIVATION_OUTPUTS_ACTIVATED: process.env.GH_AW_NEEDS_PRE_ACTIVATION_OUTPUTS_ACTIVATED\n }\n });\n - name: Validate prompt placeholders\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n # poutine:ignore untrusted_checkout_exec\n run: bash ${RUNNER_TEMP}/gh-aw/actions/validate_prompt_placeholders.sh\n - name: Print prompt\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n # poutine:ignore untrusted_checkout_exec\n run: bash ${RUNNER_TEMP}/gh-aw/actions/print_prompt_summary.sh\n - name: Upload activation artifact\n if: success()\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: activation\n path: |\n /tmp/gh-aw/aw_info.json\n /tmp/gh-aw/aw-prompts/prompt.txt\n retention-days: 1\n\n agent:\n needs: activation\n runs-on: ubuntu-latest\n permissions:\n contents: read\n issues: read\n env:\n DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}\n GH_AW_ASSETS_ALLOWED_EXTS: \"\"\n GH_AW_ASSETS_BRANCH: \"\"\n GH_AW_ASSETS_MAX_SIZE_KB: 0\n GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs\n GH_AW_WORKFLOW_ID_SANITIZED: crossrepoissueanalysis\n outputs:\n checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }}\n has_patch: ${{ steps.collect_output.outputs.has_patch }}\n inference_access_error: ${{ steps.detect-inference-error.outputs.inference_access_error || 'false' }}\n model: ${{ needs.activation.outputs.model }}\n output: ${{ steps.collect_output.outputs.output }}\n output_types: ${{ steps.collect_output.outputs.output_types }}\n steps:\n - name: Setup Scripts\n uses: github/gh-aw-actions/setup@15b2fa31e9a1b771c9773c162273924d8f5ea516 # v0.65.5\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n - name: Set runtime paths\n id: set-runtime-paths\n run: |\n echo \"GH_AW_SAFE_OUTPUTS=${RUNNER_TEMP}/gh-aw/safeoutputs/outputs.jsonl\" >> \"$GITHUB_OUTPUT\"\n echo \"GH_AW_SAFE_OUTPUTS_CONFIG_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/config.json\" >> \"$GITHUB_OUTPUT\"\n echo \"GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json\" >> \"$GITHUB_OUTPUT\"\n - name: Checkout repository\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n - name: Create gh-aw temp directory\n run: bash ${RUNNER_TEMP}/gh-aw/actions/create_gh_aw_tmp_dir.sh\n - name: Configure gh CLI for GitHub Enterprise\n run: bash ${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh\n env:\n GH_TOKEN: ${{ github.token }}\n - name: Clone copilot-agent-runtime\n run: git clone --depth 1 https://x-access-token:${{ secrets.RUNTIME_TRIAGE_TOKEN }}@github.com/github/copilot-agent-runtime.git ${{ github.workspace }}/copilot-agent-runtime\n\n - name: Configure Git credentials\n env:\n REPO_NAME: ${{ github.repository }}\n SERVER_URL: ${{ github.server_url }}\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git config --global am.keepcr true\n # Re-authenticate git with GitHub token\n SERVER_URL_STRIPPED=\"${SERVER_URL#https://}\"\n git remote set-url origin \"https://x-access-token:${{ github.token }}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git\"\n echo \"Git configured with standard GitHub Actions identity\"\n - name: Checkout PR branch\n id: checkout-pr\n if: |\n github.event.pull_request || github.event.issue.pull_request\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_TOKEN: ${{ secrets.RUNTIME_TRIAGE_TOKEN }}\n with:\n github-token: ${{ secrets.RUNTIME_TRIAGE_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs');\n await main();\n - name: Install GitHub Copilot CLI\n run: ${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh latest\n - name: Install AWF binary\n run: bash ${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh v0.25.10\n - name: Determine automatic lockdown mode for GitHub MCP Server\n id: determine-automatic-lockdown\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }}\n GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }}\n with:\n script: |\n const determineAutomaticLockdown = require('${{ runner.temp }}/gh-aw/actions/determine_automatic_lockdown.cjs');\n await determineAutomaticLockdown(github, context, core);\n - name: Download container images\n run: bash ${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh ghcr.io/github/gh-aw-firewall/agent:0.25.10 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.10 ghcr.io/github/gh-aw-firewall/squid:0.25.10 ghcr.io/github/gh-aw-mcpg:v0.2.11 ghcr.io/github/github-mcp-server:v0.32.0 node:lts-alpine\n - name: Write Safe Outputs Config\n run: |\n mkdir -p ${RUNNER_TEMP}/gh-aw/safeoutputs\n mkdir -p /tmp/gh-aw/safeoutputs\n mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs\n cat > ${RUNNER_TEMP}/gh-aw/safeoutputs/config.json << 'GH_AW_SAFE_OUTPUTS_CONFIG_48b594175610bb45_EOF'\n {\"add_labels\":{\"allowed\":[\"runtime\",\"sdk-fix-only\",\"needs-investigation\"],\"max\":3,\"target\":\"triggering\"},\"create_issue\":{\"labels\":[\"upstream-from-sdk\",\"ai-triaged\"],\"max\":1,\"target-repo\":\"github/copilot-agent-runtime\",\"title_prefix\":\"[copilot-sdk] \"},\"missing_data\":{},\"missing_tool\":{},\"noop\":{\"max\":1,\"report-as-issue\":\"true\"}}\n GH_AW_SAFE_OUTPUTS_CONFIG_48b594175610bb45_EOF\n - name: Write Safe Outputs Tools\n run: |\n cat > ${RUNNER_TEMP}/gh-aw/safeoutputs/tools_meta.json << 'GH_AW_SAFE_OUTPUTS_TOOLS_META_b7411e2278a534bd_EOF'\n {\n \"description_suffixes\": {\n \"add_labels\": \" CONSTRAINTS: Maximum 3 label(s) can be added. Only these labels are allowed: [\\\"runtime\\\" \\\"sdk-fix-only\\\" \\\"needs-investigation\\\"]. Target: triggering.\",\n \"create_issue\": \" CONSTRAINTS: Maximum 1 issue(s) can be created. Title will be prefixed with \\\"[copilot-sdk] \\\". Labels [\\\"upstream-from-sdk\\\" \\\"ai-triaged\\\"] will be automatically added. Issues will be created in repository \\\"github/copilot-agent-runtime\\\".\"\n },\n \"repo_params\": {},\n \"dynamic_tools\": []\n }\n GH_AW_SAFE_OUTPUTS_TOOLS_META_b7411e2278a534bd_EOF\n cat > ${RUNNER_TEMP}/gh-aw/safeoutputs/validation.json << 'GH_AW_SAFE_OUTPUTS_VALIDATION_81274d71f66b7af3_EOF'\n {\n \"add_labels\": {\n \"defaultMax\": 5,\n \"fields\": {\n \"item_number\": {\n \"issueNumberOrTemporaryId\": true\n },\n \"labels\": {\n \"required\": true,\n \"type\": \"array\",\n \"itemType\": \"string\",\n \"itemSanitize\": true,\n \"itemMaxLength\": 128\n },\n \"repo\": {\n \"type\": \"string\",\n \"maxLength\": 256\n }\n }\n },\n \"create_issue\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"body\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"labels\": {\n \"type\": \"array\",\n \"itemType\": \"string\",\n \"itemSanitize\": true,\n \"itemMaxLength\": 128\n },\n \"parent\": {\n \"issueOrPRNumber\": true\n },\n \"repo\": {\n \"type\": \"string\",\n \"maxLength\": 256\n },\n \"temporary_id\": {\n \"type\": \"string\"\n },\n \"title\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n }\n }\n },\n \"missing_data\": {\n \"defaultMax\": 20,\n \"fields\": {\n \"alternatives\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"context\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"data_type\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n },\n \"reason\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n }\n }\n },\n \"missing_tool\": {\n \"defaultMax\": 20,\n \"fields\": {\n \"alternatives\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 512\n },\n \"reason\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"tool\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n }\n }\n },\n \"noop\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"message\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n }\n }\n }\n }\n GH_AW_SAFE_OUTPUTS_VALIDATION_81274d71f66b7af3_EOF\n node ${RUNNER_TEMP}/gh-aw/actions/generate_safe_outputs_tools.cjs\n - name: Generate Safe Outputs MCP Server Config\n id: safe-outputs-config\n run: |\n # Generate a secure random API key (360 bits of entropy, 40+ chars)\n # Mask immediately to prevent timing vulnerabilities\n API_KEY=$(openssl rand -base64 45 | tr -d '/+=')\n echo \"::add-mask::${API_KEY}\"\n \n PORT=3001\n \n # Set outputs for next steps\n {\n echo \"safe_outputs_api_key=${API_KEY}\"\n echo \"safe_outputs_port=${PORT}\"\n } >> \"$GITHUB_OUTPUT\"\n \n echo \"Safe Outputs MCP server will run on port ${PORT}\"\n \n - name: Start Safe Outputs MCP HTTP Server\n id: safe-outputs-start\n env:\n DEBUG: '*'\n GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-config.outputs.safe_outputs_port }}\n GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-config.outputs.safe_outputs_api_key }}\n GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/tools.json\n GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/config.json\n GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs\n run: |\n # Environment variables are set above to prevent template injection\n export DEBUG\n export GH_AW_SAFE_OUTPUTS_PORT\n export GH_AW_SAFE_OUTPUTS_API_KEY\n export GH_AW_SAFE_OUTPUTS_TOOLS_PATH\n export GH_AW_SAFE_OUTPUTS_CONFIG_PATH\n export GH_AW_MCP_LOG_DIR\n \n bash ${RUNNER_TEMP}/gh-aw/actions/start_safe_outputs_server.sh\n \n - name: Start MCP Gateway\n id: start-mcp-gateway\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-start.outputs.api_key }}\n GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-start.outputs.port }}\n GITHUB_MCP_GUARD_MIN_INTEGRITY: ${{ steps.determine-automatic-lockdown.outputs.min_integrity }}\n GITHUB_MCP_GUARD_REPOS: ${{ steps.determine-automatic-lockdown.outputs.repos }}\n GITHUB_MCP_SERVER_TOKEN: ${{ secrets.RUNTIME_TRIAGE_TOKEN }}\n run: |\n set -eo pipefail\n mkdir -p /tmp/gh-aw/mcp-config\n \n # Export gateway environment variables for MCP config and gateway script\n export MCP_GATEWAY_PORT=\"80\"\n export MCP_GATEWAY_DOMAIN=\"host.docker.internal\"\n MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=')\n echo \"::add-mask::${MCP_GATEWAY_API_KEY}\"\n export MCP_GATEWAY_API_KEY\n export MCP_GATEWAY_PAYLOAD_DIR=\"/tmp/gh-aw/mcp-payloads\"\n mkdir -p \"${MCP_GATEWAY_PAYLOAD_DIR}\"\n export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD=\"524288\"\n export DEBUG=\"*\"\n \n export GH_AW_ENGINE=\"copilot\"\n export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host -v /var/run/docker.sock:/var/run/docker.sock -e MCP_GATEWAY_PORT -e MCP_GATEWAY_DOMAIN -e MCP_GATEWAY_API_KEY -e MCP_GATEWAY_PAYLOAD_DIR -e MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD -e DEBUG -e MCP_GATEWAY_LOG_DIR -e GH_AW_MCP_LOG_DIR -e GH_AW_SAFE_OUTPUTS -e GH_AW_SAFE_OUTPUTS_CONFIG_PATH -e GH_AW_SAFE_OUTPUTS_TOOLS_PATH -e GH_AW_ASSETS_BRANCH -e GH_AW_ASSETS_MAX_SIZE_KB -e GH_AW_ASSETS_ALLOWED_EXTS -e DEFAULT_BRANCH -e GITHUB_MCP_SERVER_TOKEN -e GITHUB_MCP_GUARD_MIN_INTEGRITY -e GITHUB_MCP_GUARD_REPOS -e GITHUB_REPOSITORY -e GITHUB_SERVER_URL -e GITHUB_SHA -e GITHUB_WORKSPACE -e GITHUB_TOKEN -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RUN_ATTEMPT -e GITHUB_JOB -e GITHUB_ACTION -e GITHUB_EVENT_NAME -e GITHUB_EVENT_PATH -e GITHUB_ACTOR -e GITHUB_ACTOR_ID -e GITHUB_TRIGGERING_ACTOR -e GITHUB_WORKFLOW -e GITHUB_WORKFLOW_REF -e GITHUB_WORKFLOW_SHA -e GITHUB_REF -e GITHUB_REF_NAME -e GITHUB_REF_TYPE -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GH_AW_SAFE_OUTPUTS_PORT -e GH_AW_SAFE_OUTPUTS_API_KEY -v /tmp/gh-aw/mcp-payloads:/tmp/gh-aw/mcp-payloads:rw -v /opt:/opt:ro -v /tmp:/tmp:rw -v '\"${GITHUB_WORKSPACE}\"':'\"${GITHUB_WORKSPACE}\"':rw ghcr.io/github/gh-aw-mcpg:v0.2.11'\n \n mkdir -p /home/runner/.copilot\n cat << GH_AW_MCP_CONFIG_8a197b6974c2932c_EOF | bash ${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.sh\n {\n \"mcpServers\": {\n \"github\": {\n \"type\": \"stdio\",\n \"container\": \"ghcr.io/github/github-mcp-server:v0.32.0\",\n \"env\": {\n \"GITHUB_HOST\": \"\\${GITHUB_SERVER_URL}\",\n \"GITHUB_PERSONAL_ACCESS_TOKEN\": \"\\${GITHUB_MCP_SERVER_TOKEN}\",\n \"GITHUB_READ_ONLY\": \"1\",\n \"GITHUB_TOOLSETS\": \"context,repos,issues,pull_requests\"\n },\n \"guard-policies\": {\n \"allow-only\": {\n \"min-integrity\": \"$GITHUB_MCP_GUARD_MIN_INTEGRITY\",\n \"repos\": \"$GITHUB_MCP_GUARD_REPOS\"\n }\n }\n },\n \"safeoutputs\": {\n \"type\": \"http\",\n \"url\": \"http://host.docker.internal:$GH_AW_SAFE_OUTPUTS_PORT\",\n \"headers\": {\n \"Authorization\": \"\\${GH_AW_SAFE_OUTPUTS_API_KEY}\"\n },\n \"guard-policies\": {\n \"write-sink\": {\n \"accept\": [\n \"*\"\n ]\n }\n }\n }\n },\n \"gateway\": {\n \"port\": $MCP_GATEWAY_PORT,\n \"domain\": \"${MCP_GATEWAY_DOMAIN}\",\n \"apiKey\": \"${MCP_GATEWAY_API_KEY}\",\n \"payloadDir\": \"${MCP_GATEWAY_PAYLOAD_DIR}\"\n }\n }\n GH_AW_MCP_CONFIG_8a197b6974c2932c_EOF\n - name: Download activation artifact\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: activation\n path: /tmp/gh-aw\n - name: Clean git credentials\n continue-on-error: true\n run: bash ${RUNNER_TEMP}/gh-aw/actions/clean_git_credentials.sh\n - name: Execute GitHub Copilot CLI\n id: agentic_execution\n # Copilot CLI tool arguments (sorted):\n # --allow-tool github\n # --allow-tool safeoutputs\n # --allow-tool shell(cat)\n # --allow-tool shell(cat:*)\n # --allow-tool shell(date)\n # --allow-tool shell(echo)\n # --allow-tool shell(find:*)\n # --allow-tool shell(grep)\n # --allow-tool shell(grep:*)\n # --allow-tool shell(head)\n # --allow-tool shell(head:*)\n # --allow-tool shell(ls)\n # --allow-tool shell(ls:*)\n # --allow-tool shell(pwd)\n # --allow-tool shell(sort)\n # --allow-tool shell(tail)\n # --allow-tool shell(tail:*)\n # --allow-tool shell(uniq)\n # --allow-tool shell(wc)\n # --allow-tool shell(wc:*)\n # --allow-tool shell(yq)\n # --allow-tool write\n timeout-minutes: 20\n run: |\n set -o pipefail\n touch /tmp/gh-aw/agent-step-summary.md\n # shellcheck disable=SC1003\n sudo -E awf --container-workdir \"${GITHUB_WORKSPACE}\" --mount \"${RUNNER_TEMP}/gh-aw:${RUNNER_TEMP}/gh-aw:ro\" --mount \"${RUNNER_TEMP}/gh-aw:/host${RUNNER_TEMP}/gh-aw:ro\" --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --allow-domains api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --image-tag 0.25.10 --skip-pull --enable-api-proxy \\\n -- /bin/bash -c '/usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --allow-tool github --allow-tool safeoutputs --allow-tool '\\''shell(cat)'\\'' --allow-tool '\\''shell(cat:*)'\\'' --allow-tool '\\''shell(date)'\\'' --allow-tool '\\''shell(echo)'\\'' --allow-tool '\\''shell(find:*)'\\'' --allow-tool '\\''shell(grep)'\\'' --allow-tool '\\''shell(grep:*)'\\'' --allow-tool '\\''shell(head)'\\'' --allow-tool '\\''shell(head:*)'\\'' --allow-tool '\\''shell(ls)'\\'' --allow-tool '\\''shell(ls:*)'\\'' --allow-tool '\\''shell(pwd)'\\'' --allow-tool '\\''shell(sort)'\\'' --allow-tool '\\''shell(tail)'\\'' --allow-tool '\\''shell(tail:*)'\\'' --allow-tool '\\''shell(uniq)'\\'' --allow-tool '\\''shell(wc)'\\'' --allow-tool '\\''shell(wc:*)'\\'' --allow-tool '\\''shell(yq)'\\'' --allow-tool write --allow-all-paths --add-dir \"${GITHUB_WORKSPACE}\" --prompt \"$(cat /tmp/gh-aw/aw-prompts/prompt.txt)\"' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log\n env:\n COPILOT_AGENT_RUNNER_TYPE: STANDALONE\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || '' }}\n GH_AW_MCP_CONFIG: /home/runner/.copilot/mcp-config.json\n GH_AW_PHASE: agent\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_VERSION: v0.65.5\n GITHUB_API_URL: ${{ github.api_url }}\n GITHUB_AW: true\n GITHUB_HEAD_REF: ${{ github.head_ref }}\n GITHUB_MCP_SERVER_TOKEN: ${{ secrets.RUNTIME_TRIAGE_TOKEN }}\n GITHUB_REF_NAME: ${{ github.ref_name }}\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md\n GITHUB_WORKSPACE: ${{ github.workspace }}\n GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_AUTHOR_NAME: github-actions[bot]\n GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_COMMITTER_NAME: github-actions[bot]\n XDG_CONFIG_HOME: /home/runner\n - name: Detect inference access error\n id: detect-inference-error\n if: always()\n continue-on-error: true\n run: bash ${RUNNER_TEMP}/gh-aw/actions/detect_inference_access_error.sh\n - name: Configure Git credentials\n env:\n REPO_NAME: ${{ github.repository }}\n SERVER_URL: ${{ github.server_url }}\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git config --global am.keepcr true\n # Re-authenticate git with GitHub token\n SERVER_URL_STRIPPED=\"${SERVER_URL#https://}\"\n git remote set-url origin \"https://x-access-token:${{ github.token }}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git\"\n echo \"Git configured with standard GitHub Actions identity\"\n - name: Copy Copilot session state files to logs\n if: always()\n continue-on-error: true\n run: bash ${RUNNER_TEMP}/gh-aw/actions/copy_copilot_session_state.sh\n - name: Stop MCP Gateway\n if: always()\n continue-on-error: true\n env:\n MCP_GATEWAY_PORT: ${{ steps.start-mcp-gateway.outputs.gateway-port }}\n MCP_GATEWAY_API_KEY: ${{ steps.start-mcp-gateway.outputs.gateway-api-key }}\n GATEWAY_PID: ${{ steps.start-mcp-gateway.outputs.gateway-pid }}\n run: |\n bash ${RUNNER_TEMP}/gh-aw/actions/stop_mcp_gateway.sh \"$GATEWAY_PID\"\n - name: Redact secrets in logs\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs');\n await main();\n env:\n GH_AW_SECRET_NAMES: 'COPILOT_GITHUB_TOKEN,GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,RUNTIME_TRIAGE_TOKEN'\n SECRET_COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }}\n SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }}\n SECRET_RUNTIME_TRIAGE_TOKEN: ${{ secrets.RUNTIME_TRIAGE_TOKEN }}\n - name: Append agent step summary\n if: always()\n run: bash ${RUNNER_TEMP}/gh-aw/actions/append_agent_step_summary.sh\n - name: Copy Safe Outputs\n if: always()\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n run: |\n mkdir -p /tmp/gh-aw\n cp \"$GH_AW_SAFE_OUTPUTS\" /tmp/gh-aw/safeoutputs.jsonl 2>/dev/null || true\n - name: Ingest agent output\n id: collect_output\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_ALLOWED_DOMAINS: \"api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com\"\n GH_AW_ALLOWED_GITHUB_REFS: \"repo,github/copilot-agent-runtime\"\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_API_URL: ${{ github.api_url }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/collect_ndjson_output.cjs');\n await main();\n - name: Parse agent logs for step summary\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_copilot_log.cjs');\n await main();\n - name: Parse MCP Gateway logs for step summary\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_mcp_gateway_log.cjs');\n await main();\n - name: Print firewall logs\n if: always()\n continue-on-error: true\n env:\n AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs\n run: |\n # Fix permissions on firewall logs so they can be uploaded as artifacts\n # AWF runs with sudo, creating files owned by root\n sudo chmod -R a+r /tmp/gh-aw/sandbox/firewall/logs 2>/dev/null || true\n # Only run awf logs summary if awf command exists (it may not be installed if workflow failed before install step)\n if command -v awf &> /dev/null; then\n awf logs summary | tee -a \"$GITHUB_STEP_SUMMARY\"\n else\n echo 'AWF binary not installed, skipping firewall log summary'\n fi\n - name: Parse token usage for step summary\n if: always()\n continue-on-error: true\n run: bash ${RUNNER_TEMP}/gh-aw/actions/parse_token_usage.sh\n - name: Write agent output placeholder if missing\n if: always()\n run: |\n if [ ! -f /tmp/gh-aw/agent_output.json ]; then\n echo '{\"items\":[]}' > /tmp/gh-aw/agent_output.json\n fi\n - name: Upload agent artifacts\n if: always()\n continue-on-error: true\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: agent\n path: |\n /tmp/gh-aw/aw-prompts/prompt.txt\n /tmp/gh-aw/sandbox/agent/logs/\n /tmp/gh-aw/redacted-urls.log\n /tmp/gh-aw/mcp-logs/\n /tmp/gh-aw/agent-stdio.log\n /tmp/gh-aw/agent/\n /tmp/gh-aw/safeoutputs.jsonl\n /tmp/gh-aw/agent_output.json\n /tmp/gh-aw/aw-*.patch\n /tmp/gh-aw/aw-*.bundle\n if-no-files-found: ignore\n - name: Upload firewall audit logs\n if: always()\n continue-on-error: true\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: firewall-audit-logs\n path: |\n /tmp/gh-aw/sandbox/firewall/logs/\n /tmp/gh-aw/sandbox/firewall/audit/\n if-no-files-found: ignore\n\n conclusion:\n needs:\n - activation\n - agent\n - detection\n - safe_outputs\n if: always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true')\n runs-on: ubuntu-slim\n permissions:\n contents: read\n issues: write\n pull-requests: write\n concurrency:\n group: \"gh-aw-conclusion-cross-repo-issue-analysis\"\n cancel-in-progress: false\n outputs:\n noop_message: ${{ steps.noop.outputs.noop_message }}\n tools_reported: ${{ steps.missing_tool.outputs.tools_reported }}\n total_count: ${{ steps.missing_tool.outputs.total_count }}\n steps:\n - name: Setup Scripts\n uses: github/gh-aw-actions/setup@15b2fa31e9a1b771c9773c162273924d8f5ea516 # v0.65.5\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Process No-Op Messages\n id: noop\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_NOOP_MAX: \"1\"\n GH_AW_WORKFLOW_NAME: \"SDK Runtime Triage\"\n with:\n github-token: ${{ secrets.RUNTIME_TRIAGE_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/noop.cjs');\n await main();\n - name: Record Missing Tool\n id: missing_tool\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_MISSING_TOOL_CREATE_ISSUE: \"true\"\n GH_AW_WORKFLOW_NAME: \"SDK Runtime Triage\"\n with:\n github-token: ${{ secrets.RUNTIME_TRIAGE_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/missing_tool.cjs');\n await main();\n - name: Handle Agent Failure\n id: handle_agent_failure\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_WORKFLOW_NAME: \"SDK Runtime Triage\"\n GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\n GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }}\n GH_AW_WORKFLOW_ID: \"cross-repo-issue-analysis\"\n GH_AW_ENGINE_ID: \"copilot\"\n GH_AW_SECRET_VERIFICATION_RESULT: ${{ needs.activation.outputs.secret_verification_result }}\n GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }}\n GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }}\n GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }}\n GH_AW_GROUP_REPORTS: \"false\"\n GH_AW_FAILURE_REPORT_AS_ISSUE: \"true\"\n GH_AW_TIMEOUT_MINUTES: \"20\"\n with:\n github-token: ${{ secrets.RUNTIME_TRIAGE_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_agent_failure.cjs');\n await main();\n - name: Handle No-Op Message\n id: handle_noop_message\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_WORKFLOW_NAME: \"SDK Runtime Triage\"\n GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\n GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }}\n GH_AW_NOOP_MESSAGE: ${{ steps.noop.outputs.noop_message }}\n GH_AW_NOOP_REPORT_AS_ISSUE: \"true\"\n with:\n github-token: ${{ secrets.RUNTIME_TRIAGE_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_noop_message.cjs');\n await main();\n\n detection:\n needs: agent\n if: >\n always() && needs.agent.result != 'skipped' && (needs.agent.outputs.output_types != '' || needs.agent.outputs.has_patch == 'true')\n runs-on: ubuntu-latest\n permissions:\n contents: read\n outputs:\n detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }}\n detection_success: ${{ steps.detection_conclusion.outputs.success }}\n steps:\n - name: Setup Scripts\n uses: github/gh-aw-actions/setup@15b2fa31e9a1b771c9773c162273924d8f5ea516 # v0.65.5\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Checkout repository for patch context\n if: needs.agent.outputs.has_patch == 'true'\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n # --- Threat Detection ---\n - name: Download container images\n run: bash ${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh ghcr.io/github/gh-aw-firewall/agent:0.25.10 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.10 ghcr.io/github/gh-aw-firewall/squid:0.25.10\n - name: Check if detection needed\n id: detection_guard\n if: always()\n env:\n OUTPUT_TYPES: ${{ needs.agent.outputs.output_types }}\n HAS_PATCH: ${{ needs.agent.outputs.has_patch }}\n run: |\n if [[ -n \"$OUTPUT_TYPES\" || \"$HAS_PATCH\" == \"true\" ]]; then\n echo \"run_detection=true\" >> \"$GITHUB_OUTPUT\"\n echo \"Detection will run: output_types=$OUTPUT_TYPES, has_patch=$HAS_PATCH\"\n else\n echo \"run_detection=false\" >> \"$GITHUB_OUTPUT\"\n echo \"Detection skipped: no agent outputs or patches to analyze\"\n fi\n - name: Clear MCP configuration for detection\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n rm -f /tmp/gh-aw/mcp-config/mcp-servers.json\n rm -f /home/runner/.copilot/mcp-config.json\n rm -f \"$GITHUB_WORKSPACE/.gemini/settings.json\"\n - name: Prepare threat detection files\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n mkdir -p /tmp/gh-aw/threat-detection/aw-prompts\n cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true\n cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true\n for f in /tmp/gh-aw/aw-*.patch; do\n [ -f \"$f\" ] && cp \"$f\" /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n done\n for f in /tmp/gh-aw/aw-*.bundle; do\n [ -f \"$f\" ] && cp \"$f\" /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n done\n echo \"Prepared threat detection files:\"\n ls -la /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n - name: Setup threat detection\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n WORKFLOW_NAME: \"SDK Runtime Triage\"\n WORKFLOW_DESCRIPTION: \"Analyzes copilot-sdk issues to determine if a fix is needed in copilot-agent-runtime, then opens a linked issue there\"\n HAS_PATCH: ${{ needs.agent.outputs.has_patch }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/setup_threat_detection.cjs');\n await main();\n - name: Ensure threat-detection directory and log\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n mkdir -p /tmp/gh-aw/threat-detection\n touch /tmp/gh-aw/threat-detection/detection.log\n - name: Install GitHub Copilot CLI\n run: ${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh latest\n - name: Install AWF binary\n run: bash ${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh v0.25.10\n - name: Execute GitHub Copilot CLI\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n id: detection_agentic_execution\n # Copilot CLI tool arguments (sorted):\n timeout-minutes: 20\n run: |\n set -o pipefail\n touch /tmp/gh-aw/agent-step-summary.md\n # shellcheck disable=SC1003\n sudo -E awf --container-workdir \"${GITHUB_WORKSPACE}\" --mount \"${RUNNER_TEMP}/gh-aw:${RUNNER_TEMP}/gh-aw:ro\" --mount \"${RUNNER_TEMP}/gh-aw:/host${RUNNER_TEMP}/gh-aw:ro\" --env-all --exclude-env COPILOT_GITHUB_TOKEN --allow-domains api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,github.com,host.docker.internal,telemetry.enterprise.githubcopilot.com --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --image-tag 0.25.10 --skip-pull --enable-api-proxy \\\n -- /bin/bash -c '/usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --allow-all-tools --add-dir \"${GITHUB_WORKSPACE}\" --prompt \"$(cat /tmp/gh-aw/aw-prompts/prompt.txt)\"' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log\n env:\n COPILOT_AGENT_RUNNER_TYPE: STANDALONE\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || '' }}\n GH_AW_PHASE: detection\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_VERSION: v0.65.5\n GITHUB_API_URL: ${{ github.api_url }}\n GITHUB_AW: true\n GITHUB_HEAD_REF: ${{ github.head_ref }}\n GITHUB_REF_NAME: ${{ github.ref_name }}\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md\n GITHUB_WORKSPACE: ${{ github.workspace }}\n GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_AUTHOR_NAME: github-actions[bot]\n GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_COMMITTER_NAME: github-actions[bot]\n XDG_CONFIG_HOME: /home/runner\n - name: Upload threat detection log\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: detection\n path: /tmp/gh-aw/threat-detection/detection.log\n if-no-files-found: ignore\n - name: Parse and conclude threat detection\n id: detection_conclusion\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n RUN_DETECTION: ${{ steps.detection_guard.outputs.run_detection }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_threat_detection_results.cjs');\n await main();\n\n pre_activation:\n if: github.event_name == 'workflow_dispatch' || github.event.label.name == 'runtime triage'\n runs-on: ubuntu-slim\n outputs:\n activated: ${{ steps.check_membership.outputs.is_team_member == 'true' }}\n matched_command: ''\n steps:\n - name: Setup Scripts\n uses: github/gh-aw-actions/setup@15b2fa31e9a1b771c9773c162273924d8f5ea516 # v0.65.5\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n - name: Check team membership for workflow\n id: check_membership\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_REQUIRED_ROLES: \"admin,maintainer,write\"\n with:\n github-token: ${{ secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/check_membership.cjs');\n await main();\n\n safe_outputs:\n needs:\n - agent\n - detection\n if: (!cancelled()) && needs.agent.result != 'skipped' && needs.detection.result == 'success'\n runs-on: ubuntu-slim\n permissions:\n contents: read\n issues: write\n pull-requests: write\n timeout-minutes: 15\n env:\n GH_AW_CALLER_WORKFLOW_ID: \"${{ github.repository }}/cross-repo-issue-analysis\"\n GH_AW_ENGINE_ID: \"copilot\"\n GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }}\n GH_AW_WORKFLOW_ID: \"cross-repo-issue-analysis\"\n GH_AW_WORKFLOW_NAME: \"SDK Runtime Triage\"\n outputs:\n code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }}\n code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }}\n create_discussion_error_count: ${{ steps.process_safe_outputs.outputs.create_discussion_error_count }}\n create_discussion_errors: ${{ steps.process_safe_outputs.outputs.create_discussion_errors }}\n created_issue_number: ${{ steps.process_safe_outputs.outputs.created_issue_number }}\n created_issue_url: ${{ steps.process_safe_outputs.outputs.created_issue_url }}\n process_safe_outputs_processed_count: ${{ steps.process_safe_outputs.outputs.processed_count }}\n process_safe_outputs_temporary_id_map: ${{ steps.process_safe_outputs.outputs.temporary_id_map }}\n steps:\n - name: Setup Scripts\n uses: github/gh-aw-actions/setup@15b2fa31e9a1b771c9773c162273924d8f5ea516 # v0.65.5\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Configure GH_HOST for enterprise compatibility\n id: ghes-host-config\n shell: bash\n run: |\n # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct\n # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op.\n GH_HOST=\"${GITHUB_SERVER_URL#https://}\"\n GH_HOST=\"${GH_HOST#http://}\"\n echo \"GH_HOST=${GH_HOST}\" >> \"$GITHUB_ENV\"\n - name: Process Safe Outputs\n id: process_safe_outputs\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_ALLOWED_DOMAINS: \"api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com\"\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_API_URL: ${{ github.api_url }}\n GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: \"{\\\"add_labels\\\":{\\\"allowed\\\":[\\\"runtime\\\",\\\"sdk-fix-only\\\",\\\"needs-investigation\\\"],\\\"max\\\":3,\\\"target\\\":\\\"triggering\\\"},\\\"create_issue\\\":{\\\"labels\\\":[\\\"upstream-from-sdk\\\",\\\"ai-triaged\\\"],\\\"max\\\":1,\\\"target-repo\\\":\\\"github/copilot-agent-runtime\\\",\\\"title_prefix\\\":\\\"[copilot-sdk] \\\"},\\\"missing_data\\\":{},\\\"missing_tool\\\":{},\\\"noop\\\":{\\\"max\\\":1,\\\"report-as-issue\\\":\\\"true\\\"}}\"\n with:\n github-token: ${{ secrets.RUNTIME_TRIAGE_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/safe_output_handler_manager.cjs');\n await main();\n - name: Upload Safe Output Items\n if: always()\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: safe-output-items\n path: /tmp/gh-aw/safe-output-items.jsonl\n if-no-files-found: ignore\n\n" }, { "path": ".github/workflows/cross-repo-issue-analysis.md", "content": "---\ndescription: Analyzes copilot-sdk issues to determine if a fix is needed in copilot-agent-runtime, then opens a linked issue there\non:\n issues:\n types: [labeled]\n workflow_dispatch:\n inputs:\n issue_number:\n description: \"Issue number to analyze\"\n required: true\n type: string\nif: \"github.event_name == 'workflow_dispatch' || github.event.label.name == 'runtime triage'\"\npermissions:\n contents: read\n issues: read\nsteps:\n - name: Clone copilot-agent-runtime\n run: git clone --depth 1 https://x-access-token:${{ secrets.RUNTIME_TRIAGE_TOKEN }}@github.com/github/copilot-agent-runtime.git ${{ github.workspace }}/copilot-agent-runtime\ntools:\n github:\n toolsets: [default]\n github-token: ${{ secrets.RUNTIME_TRIAGE_TOKEN }}\n bash:\n - \"grep:*\"\n - \"find:*\"\n - \"cat:*\"\n - \"head:*\"\n - \"tail:*\"\n - \"wc:*\"\n - \"ls:*\"\nsafe-outputs:\n github-token: ${{ secrets.RUNTIME_TRIAGE_TOKEN }}\n allowed-github-references: [\"repo\", \"github/copilot-agent-runtime\"]\n add-labels:\n allowed: [runtime, sdk-fix-only, needs-investigation]\n max: 3\n target: triggering\n create-issue:\n title-prefix: \"[copilot-sdk] \"\n labels: [upstream-from-sdk, ai-triaged]\n target-repo: \"github/copilot-agent-runtime\"\n max: 1\ntimeout-minutes: 20\n---\n\n# SDK Runtime Triage\n\nYou are an expert agent that analyzes issues filed in the **copilot-sdk** repository to determine whether the root cause and fix live in this repo or in the **copilot-agent-runtime** repo (`github/copilot-agent-runtime`).\n\n## Context\n\n- Repository: ${{ github.repository }}\n- Issue number: ${{ github.event.issue.number || inputs.issue_number }}\n- Issue title: ${{ github.event.issue.title }}\n\nThe **copilot-sdk** repo is a multi-language SDK (Node/TS, Python, Go, .NET) that communicates with the Copilot CLI via JSON-RPC. The **copilot-agent-runtime** repo contains the CLI/server that the SDK talks to. Many issues filed against the SDK are actually caused by behavior in the runtime.\n\n## Your Task\n\n### Step 1: Understand the Issue\n\nUse GitHub tools to fetch the full issue body, comments, and any linked references for issue `${{ github.event.issue.number || inputs.issue_number }}` in `${{ github.repository }}`.\n\n### Step 2: Analyze Against copilot-sdk\n\nSearch the copilot-sdk codebase on disk to understand whether the reported problem could originate here. The repo is checked out at the default working directory.\n\n- Use bash tools (`grep`, `find`, `cat`) to search the relevant SDK language implementation (`nodejs/src/`, `python/copilot/`, `go/`, `dotnet/src/`)\n- Look at the JSON-RPC client layer, session management, event handling, and tool definitions\n- Check if the issue relates to SDK-side logic (type generation, streaming, event parsing, client options, etc.)\n\n### Step 3: Investigate copilot-agent-runtime\n\nIf the issue does NOT appear to be caused by SDK code, or you suspect the runtime is involved, investigate the **copilot-agent-runtime** repo. It has been cloned to `./copilot-agent-runtime/` in the current working directory.\n\n- Use bash tools (`grep`, `find`, `cat`) to search the runtime codebase at `./copilot-agent-runtime/`\n- Look at the server-side JSON-RPC handling, session management, tool execution, and response generation\n- Focus on the areas that correspond to the reported issue (e.g., if the issue is about streaming, look at the runtime's streaming implementation)\n\nCommon areas where runtime fixes are needed:\n- JSON-RPC protocol handling and response formatting\n- Session lifecycle (creation, persistence, compaction, destruction)\n- Tool execution and permission handling\n- Model/API interaction (prompt construction, response parsing)\n- Streaming event generation (deltas, completions)\n- Error handling and error response formatting\n\n### Step 4: Make Your Determination\n\nClassify the issue into one of these categories:\n\n1. **SDK-fix-only**: The bug/feature is entirely in the SDK code. Label the issue `sdk-fix-only`.\n\n2. **Runtime**: The root cause is in copilot-agent-runtime. Do ALL of the following:\n - Label the original issue `runtime`\n - Create an issue in `github/copilot-agent-runtime` that:\n - Clearly describes the problem and root cause\n - References the original SDK issue (e.g., `github/copilot-sdk#123`)\n - Includes the specific files and code paths involved\n - Suggests a fix approach\n\n3. **Needs-investigation**: You cannot confidently determine the root cause. Label the issue `needs-investigation`.\n\n## Guidelines\n\n1. **Be thorough but focused**: Read enough code to be confident in your analysis, but don't read every file in both repos\n2. **Err on the side of creating the runtime issue**: If there's a reasonable chance the fix is in the runtime, create the issue. False positives are better than missed upstream bugs.\n3. **Link everything**: Always cross-reference between the SDK issue and runtime issue so maintainers can follow the trail\n4. **Be specific**: When describing the root cause, point to specific files, functions, and line numbers in both repos\n5. **Don't duplicate**: Before creating a runtime issue, search existing open issues in `github/copilot-agent-runtime` to avoid duplicates. If a related issue exists, reference it instead of creating a new one.\n" }, { "path": ".github/workflows/docs-validation.yml", "content": "name: \"Documentation Validation\"\n\non:\n pull_request:\n types: [opened, synchronize, reopened, ready_for_review]\n paths:\n - 'docs/**'\n - 'nodejs/src/**'\n - 'python/copilot/**'\n - 'go/**/*.go'\n - 'dotnet/src/**'\n - 'scripts/docs-validation/**'\n - '.github/workflows/docs-validation.yml'\n workflow_dispatch:\n merge_group:\n\npermissions:\n contents: read\n\njobs:\n validate-typescript:\n name: \"Validate TypeScript\"\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n\n - uses: actions/setup-node@v6\n with:\n node-version: 22\n cache: \"npm\"\n cache-dependency-path: \"nodejs/package-lock.json\"\n\n - name: Install SDK dependencies\n working-directory: nodejs\n run: npm ci --ignore-scripts\n\n - name: Install validation dependencies\n working-directory: scripts/docs-validation\n run: npm ci\n\n - name: Extract and validate TypeScript\n working-directory: scripts/docs-validation\n run: npm run extract && npm run validate:ts\n\n validate-python:\n name: \"Validate Python\"\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n\n - uses: actions/setup-node@v6\n with:\n node-version: 22\n\n - uses: actions/setup-python@v6\n with:\n python-version: \"3.12\"\n\n - name: Install uv\n uses: astral-sh/setup-uv@v7\n\n - name: Install SDK dependencies\n working-directory: python\n run: uv sync\n\n - name: Install mypy\n run: pip install mypy\n\n - name: Install validation dependencies\n working-directory: scripts/docs-validation\n run: npm ci\n\n - name: Extract and validate Python\n working-directory: scripts/docs-validation\n run: npm run extract && npm run validate:py\n\n validate-go:\n name: \"Validate Go\"\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n\n - uses: actions/setup-node@v6\n with:\n node-version: 22\n\n - uses: actions/setup-go@v6\n with:\n go-version: \"1.24\"\n cache-dependency-path: \"go/go.sum\"\n\n - name: Install validation dependencies\n working-directory: scripts/docs-validation\n run: npm ci\n\n - name: Extract and validate Go\n working-directory: scripts/docs-validation\n run: npm run extract && npm run validate:go\n\n validate-csharp:\n name: \"Validate C#\"\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n\n - uses: actions/setup-node@v6\n with:\n node-version: 22\n\n - uses: actions/setup-dotnet@v5\n with:\n dotnet-version: \"10.0.x\"\n\n - name: Install validation dependencies\n working-directory: scripts/docs-validation\n run: npm ci\n\n - name: Restore SDK dependencies\n working-directory: dotnet\n run: dotnet restore\n\n - name: Extract and validate C#\n working-directory: scripts/docs-validation\n run: npm run extract && npm run validate:cs\n" }, { "path": ".github/workflows/dotnet-sdk-tests.yml", "content": "name: \".NET SDK Tests\"\n\non:\n push:\n branches:\n - main\n pull_request:\n types: [opened, synchronize, reopened, ready_for_review]\n paths:\n - 'dotnet/**'\n - 'test/**'\n - 'nodejs/package.json'\n - '.github/workflows/dotnet-sdk-tests.yml'\n - '!**/*.md'\n - '!**/LICENSE*'\n - '!**/.gitignore'\n - '!**/.editorconfig'\n - '!**/*.png'\n - '!**/*.jpg'\n - '!**/*.jpeg'\n - '!**/*.gif'\n - '!**/*.svg'\n workflow_dispatch:\n merge_group:\n\npermissions:\n contents: read\n\njobs:\n test:\n name: \".NET SDK Tests\"\n env:\n POWERSHELL_UPDATECHECK: Off\n strategy:\n fail-fast: false\n matrix:\n os: [ubuntu-latest, macos-latest, windows-latest]\n runs-on: ${{ matrix.os }}\n defaults:\n run:\n shell: bash\n working-directory: ./dotnet\n steps:\n - uses: actions/checkout@v6.0.2\n - uses: actions/setup-dotnet@v5\n with:\n dotnet-version: \"10.0.x\"\n - uses: actions/setup-node@v6\n with:\n node-version: \"22\"\n cache: \"npm\"\n cache-dependency-path: \"./nodejs/package-lock.json\"\n\n - name: Install Node.js dependencies (for CLI version extraction)\n working-directory: ./nodejs\n run: npm ci --ignore-scripts\n\n - name: Restore .NET dependencies\n run: dotnet restore\n\n - name: Run dotnet format check\n if: runner.os == 'Linux'\n run: |\n dotnet format --verify-no-changes\n if [ $? -ne 0 ]; then\n echo \"❌ dotnet format produced changes. Please run 'dotnet format' in dotnet\"\n exit 1\n fi\n echo \"✅ dotnet format produced no changes\"\n\n - name: Build SDK\n run: dotnet build --no-restore\n\n - name: Install test harness dependencies\n working-directory: ./test/harness\n run: npm ci --ignore-scripts\n\n - name: Warm up PowerShell\n if: runner.os == 'Windows'\n run: pwsh.exe -Command \"Write-Host 'PowerShell ready'\"\n\n - name: Run .NET SDK tests\n env:\n COPILOT_HMAC_KEY: ${{ secrets.COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY }}\n run: dotnet test --no-build -v n\n" }, { "path": ".github/workflows/go-sdk-tests.yml", "content": "name: \"Go SDK Tests\"\n\non:\n push:\n branches:\n - main\n pull_request:\n types: [opened, synchronize, reopened, ready_for_review]\n paths:\n - 'go/**'\n - 'test/**'\n - 'nodejs/package.json'\n - '.github/workflows/go-sdk-tests.yml'\n - '.github/actions/setup-copilot/**'\n - '!**/*.md'\n - '!**/LICENSE*'\n - '!**/.gitignore'\n - '!**/.editorconfig'\n - '!**/*.png'\n - '!**/*.jpg'\n - '!**/*.jpeg'\n - '!**/*.gif'\n - '!**/*.svg'\n workflow_dispatch:\n merge_group:\n\npermissions:\n contents: read\n\njobs:\n test:\n name: \"Go SDK Tests\"\n env:\n POWERSHELL_UPDATECHECK: Off\n strategy:\n fail-fast: false\n matrix:\n os: [ubuntu-latest, macos-latest, windows-latest]\n runs-on: ${{ matrix.os }}\n defaults:\n run:\n shell: bash\n working-directory: ./go\n steps:\n - uses: actions/checkout@v6.0.2\n - uses: ./.github/actions/setup-copilot\n id: setup-copilot\n - uses: actions/setup-go@v6\n with:\n go-version: \"1.24\"\n\n - name: Run go fmt\n if: runner.os == 'Linux'\n working-directory: ./go\n run: |\n go fmt ./...\n if [ -n \"$(git status --porcelain)\" ]; then\n echo \"❌ go fmt produced changes. Please run 'go fmt ./...' in go\"\n git --no-pager diff\n exit 1\n fi\n echo \"✅ go fmt produced no changes\"\n\n - name: Install golangci-lint\n if: runner.os == 'Linux'\n uses: golangci/golangci-lint-action@v9\n with:\n working-directory: ./go\n version: latest\n args: --timeout=5m\n\n - name: Install test harness dependencies\n working-directory: ./test/harness\n run: npm ci --ignore-scripts\n\n - name: Warm up PowerShell\n if: runner.os == 'Windows'\n run: pwsh.exe -Command \"Write-Host 'PowerShell ready'\"\n\n - name: Run Go SDK tests\n env:\n COPILOT_HMAC_KEY: ${{ secrets.COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY }}\n COPILOT_CLI_PATH: ${{ steps.setup-copilot.outputs.cli-path }}\n run: /bin/bash test.sh\n" }, { "path": ".github/workflows/handle-bug.lock.yml", "content": "# gh-aw-metadata: {\"schema_version\":\"v3\",\"frontmatter_hash\":\"a473a22cd67feb7f8f5225639fd989cf71705f78c9fe11c3fc757168e1672b0e\",\"compiler_version\":\"v0.67.4\",\"strict\":true,\"agent_id\":\"copilot\"}\n# gh-aw-manifest: {\"version\":1,\"secrets\":[\"COPILOT_GITHUB_TOKEN\",\"GH_AW_GITHUB_MCP_SERVER_TOKEN\",\"GH_AW_GITHUB_TOKEN\",\"GITHUB_TOKEN\"],\"actions\":[{\"repo\":\"actions/checkout\",\"sha\":\"de0fac2e4500dabe0009e67214ff5f5447ce83dd\",\"version\":\"v6.0.2\"},{\"repo\":\"actions/download-artifact\",\"sha\":\"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c\",\"version\":\"v8.0.1\"},{\"repo\":\"actions/github-script\",\"sha\":\"ed597411d8f924073f98dfc5c65a23a2325f34cd\",\"version\":\"v8\"},{\"repo\":\"actions/upload-artifact\",\"sha\":\"bbbca2ddaa5d8feaa63e36b76fdaad77386f024f\",\"version\":\"v7\"},{\"repo\":\"github/gh-aw-actions/setup\",\"sha\":\"9d6ae06250fc0ec536a0e5f35de313b35bad7246\",\"version\":\"v0.67.4\"}]}\n# ___ _ _ \n# / _ \\ | | (_) \n# | |_| | __ _ ___ _ __ | |_ _ ___ \n# | _ |/ _` |/ _ \\ '_ \\| __| |/ __|\n# | | | | (_| | __/ | | | |_| | (__ \n# \\_| |_/\\__, |\\___|_| |_|\\__|_|\\___|\n# __/ |\n# _ _ |___/ \n# | | | | / _| |\n# | | | | ___ _ __ _ __| |_| | _____ ____\n# | |/\\| |/ _ \\ '__| |/ /| _| |/ _ \\ \\ /\\ / / ___|\n# \\ /\\ / (_) | | | | ( | | | | (_) \\ V V /\\__ \\\n# \\/ \\/ \\___/|_| |_|\\_\\|_| |_|\\___/ \\_/\\_/ |___/\n#\n# This file was automatically generated by gh-aw (v0.67.4). DO NOT EDIT.\n#\n# To update this file, edit the corresponding .md file and run:\n# gh aw compile\n# Not all edits will cause changes to this file.\n#\n# For more information: https://github.github.com/gh-aw/introduction/overview/\n#\n# Handles issues classified as bugs by the triage classifier\n#\n# Secrets used:\n# - COPILOT_GITHUB_TOKEN\n# - GH_AW_GITHUB_MCP_SERVER_TOKEN\n# - GH_AW_GITHUB_TOKEN\n# - GITHUB_TOKEN\n#\n# Custom actions used:\n# - actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n# - actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n# - actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n# - actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n# - github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n\nname: \"Bug Handler\"\n\"on\":\n workflow_call:\n inputs:\n issue_number:\n required: true\n type: string\n payload:\n required: false\n type: string\n outputs:\n comment_id:\n description: ID of the first added comment\n value: ${{ jobs.safe_outputs.outputs.comment_id }}\n comment_url:\n description: URL of the first added comment\n value: ${{ jobs.safe_outputs.outputs.comment_url }}\n\npermissions: {}\n\nconcurrency:\n group: \"gh-aw-${{ github.workflow }}\"\n\nrun-name: \"Bug Handler\"\n\njobs:\n activation:\n runs-on: ubuntu-slim\n permissions:\n actions: read\n contents: read\n outputs:\n artifact_prefix: ${{ steps.artifact-prefix.outputs.prefix }}\n comment_id: \"\"\n comment_repo: \"\"\n lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }}\n model: ${{ steps.generate_aw_info.outputs.model }}\n secret_verification_result: ${{ steps.validate-secret.outputs.verification_result }}\n setup-trace-id: ${{ steps.setup.outputs.trace-id }}\n target_ref: ${{ steps.resolve-host-repo.outputs.target_ref }}\n target_repo: ${{ steps.resolve-host-repo.outputs.target_repo }}\n target_repo_name: ${{ steps.resolve-host-repo.outputs.target_repo_name }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n - name: Resolve host repo for activation checkout\n id: resolve-host-repo\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/resolve_host_repo.cjs');\n await main();\n - name: Compute artifact prefix\n id: artifact-prefix\n env:\n INPUTS_JSON: ${{ toJSON(inputs) }}\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/compute_artifact_prefix.sh\"\n - name: Generate agentic run info\n id: generate_aw_info\n env:\n GH_AW_INFO_ENGINE_ID: \"copilot\"\n GH_AW_INFO_ENGINE_NAME: \"GitHub Copilot CLI\"\n GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'auto' }}\n GH_AW_INFO_VERSION: \"1.0.20\"\n GH_AW_INFO_AGENT_VERSION: \"1.0.20\"\n GH_AW_INFO_CLI_VERSION: \"v0.67.4\"\n GH_AW_INFO_WORKFLOW_NAME: \"Bug Handler\"\n GH_AW_INFO_EXPERIMENTAL: \"false\"\n GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: \"true\"\n GH_AW_INFO_STAGED: \"false\"\n GH_AW_INFO_ALLOWED_DOMAINS: '[\"defaults\"]'\n GH_AW_INFO_FIREWALL_ENABLED: \"true\"\n GH_AW_INFO_AWF_VERSION: \"v0.25.18\"\n GH_AW_INFO_AWMG_VERSION: \"\"\n GH_AW_INFO_FIREWALL_TYPE: \"squid\"\n GH_AW_COMPILED_STRICT: \"true\"\n GH_AW_INFO_TARGET_REPO: ${{ steps.resolve-host-repo.outputs.target_repo }}\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs');\n await main(core, context);\n - name: Validate COPILOT_GITHUB_TOKEN secret\n id: validate-secret\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/validate_multi_secret.sh\" COPILOT_GITHUB_TOKEN 'GitHub Copilot CLI' https://github.github.com/gh-aw/reference/engines/#github-copilot-default\n env:\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n - name: Cross-repo setup guidance\n if: failure() && steps.resolve-host-repo.outputs.target_repo != github.repository\n run: |\n echo \"::error::COPILOT_GITHUB_TOKEN must be configured in the CALLER repository's secrets.\"\n echo \"::error::For cross-repo workflow_call, secrets must be set in the repository that triggers the workflow.\"\n echo \"::error::See: https://github.github.com/gh-aw/patterns/central-repo-ops/#cross-repo-setup\"\n - name: Checkout .github and .agents folders\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n repository: ${{ steps.resolve-host-repo.outputs.target_repo }}\n ref: ${{ steps.resolve-host-repo.outputs.target_ref }}\n sparse-checkout: |\n .github\n .agents\n sparse-checkout-cone-mode: true\n fetch-depth: 1\n - name: Check workflow lock file\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_WORKFLOW_FILE: \"handle-bug.lock.yml\"\n GH_AW_CONTEXT_WORKFLOW_REF: \"${{ github.workflow_ref }}\"\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/check_workflow_timestamp_api.cjs');\n await main();\n - name: Check compile-agentic version\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_COMPILED_VERSION: \"v0.67.4\"\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/check_version_updates.cjs');\n await main();\n - name: Create prompt with built-in context\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_SAFE_OUTPUTS: ${{ runner.temp }}/gh-aw/safeoutputs/outputs.jsonl\n GH_AW_GITHUB_ACTOR: ${{ github.actor }}\n GH_AW_GITHUB_EVENT_COMMENT_ID: ${{ github.event.comment.id }}\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: ${{ github.event.discussion.number }}\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: ${{ github.event.issue.number }}\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n GH_AW_GITHUB_RUN_ID: ${{ github.run_id }}\n GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }}\n GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }}\n # poutine:ignore untrusted_checkout_exec\n run: |\n bash \"${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh\"\n {\n cat << 'GH_AW_PROMPT_3df18ed0421fc8c1_EOF'\n \n GH_AW_PROMPT_3df18ed0421fc8c1_EOF\n cat \"${RUNNER_TEMP}/gh-aw/prompts/xpia.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/markdown.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md\"\n cat << 'GH_AW_PROMPT_3df18ed0421fc8c1_EOF'\n \n Tools: add_comment, add_labels, missing_tool, missing_data, noop\n \n \n The following GitHub context information is available for this workflow:\n {{#if __GH_AW_GITHUB_ACTOR__ }}\n - **actor**: __GH_AW_GITHUB_ACTOR__\n {{/if}}\n {{#if __GH_AW_GITHUB_REPOSITORY__ }}\n - **repository**: __GH_AW_GITHUB_REPOSITORY__\n {{/if}}\n {{#if __GH_AW_GITHUB_WORKSPACE__ }}\n - **workspace**: __GH_AW_GITHUB_WORKSPACE__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_ISSUE_NUMBER__ }}\n - **issue-number**: #__GH_AW_GITHUB_EVENT_ISSUE_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER__ }}\n - **discussion-number**: #__GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER__ }}\n - **pull-request-number**: #__GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_COMMENT_ID__ }}\n - **comment-id**: __GH_AW_GITHUB_EVENT_COMMENT_ID__\n {{/if}}\n {{#if __GH_AW_GITHUB_RUN_ID__ }}\n - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__\n {{/if}}\n \n \n GH_AW_PROMPT_3df18ed0421fc8c1_EOF\n cat \"${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md\"\n cat << 'GH_AW_PROMPT_3df18ed0421fc8c1_EOF'\n \n {{#runtime-import .github/workflows/handle-bug.md}}\n GH_AW_PROMPT_3df18ed0421fc8c1_EOF\n } > \"$GH_AW_PROMPT\"\n - name: Interpolate variables and render templates\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/interpolate_prompt.cjs');\n await main();\n - name: Substitute placeholders\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_GITHUB_ACTOR: ${{ github.actor }}\n GH_AW_GITHUB_EVENT_COMMENT_ID: ${{ github.event.comment.id }}\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: ${{ github.event.discussion.number }}\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: ${{ github.event.issue.number }}\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n GH_AW_GITHUB_RUN_ID: ${{ github.run_id }}\n GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }}\n GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n \n const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs');\n \n // Call the substitution function\n return await substitutePlaceholders({\n file: process.env.GH_AW_PROMPT,\n substitutions: {\n GH_AW_GITHUB_ACTOR: process.env.GH_AW_GITHUB_ACTOR,\n GH_AW_GITHUB_EVENT_COMMENT_ID: process.env.GH_AW_GITHUB_EVENT_COMMENT_ID,\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: process.env.GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER,\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: process.env.GH_AW_GITHUB_EVENT_ISSUE_NUMBER,\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: process.env.GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER,\n GH_AW_GITHUB_REPOSITORY: process.env.GH_AW_GITHUB_REPOSITORY,\n GH_AW_GITHUB_RUN_ID: process.env.GH_AW_GITHUB_RUN_ID,\n GH_AW_GITHUB_WORKSPACE: process.env.GH_AW_GITHUB_WORKSPACE,\n GH_AW_INPUTS_ISSUE_NUMBER: process.env.GH_AW_INPUTS_ISSUE_NUMBER\n }\n });\n - name: Validate prompt placeholders\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n # poutine:ignore untrusted_checkout_exec\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/validate_prompt_placeholders.sh\"\n - name: Print prompt\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n # poutine:ignore untrusted_checkout_exec\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/print_prompt_summary.sh\"\n - name: Upload activation artifact\n if: success()\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ steps.artifact-prefix.outputs.prefix }}activation\n path: |\n /tmp/gh-aw/aw_info.json\n /tmp/gh-aw/aw-prompts/prompt.txt\n /tmp/gh-aw/github_rate_limits.jsonl\n if-no-files-found: ignore\n retention-days: 1\n\n agent:\n needs: activation\n runs-on: ubuntu-latest\n permissions:\n contents: read\n issues: read\n pull-requests: read\n concurrency:\n group: \"gh-aw-copilot-${{ github.workflow }}-${{ inputs.issue_number }}\"\n env:\n DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}\n GH_AW_ASSETS_ALLOWED_EXTS: \"\"\n GH_AW_ASSETS_BRANCH: \"\"\n GH_AW_ASSETS_MAX_SIZE_KB: 0\n GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs\n GH_AW_WORKFLOW_ID_SANITIZED: handlebug\n outputs:\n artifact_prefix: ${{ needs.activation.outputs.artifact_prefix }}\n checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }}\n effective_tokens: ${{ steps.parse-mcp-gateway.outputs.effective_tokens }}\n has_patch: ${{ steps.collect_output.outputs.has_patch }}\n inference_access_error: ${{ steps.detect-inference-error.outputs.inference_access_error || 'false' }}\n model: ${{ needs.activation.outputs.model }}\n output: ${{ steps.collect_output.outputs.output }}\n output_types: ${{ steps.collect_output.outputs.output_types }}\n setup-trace-id: ${{ steps.setup.outputs.trace-id }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Set runtime paths\n id: set-runtime-paths\n run: |\n echo \"GH_AW_SAFE_OUTPUTS=${RUNNER_TEMP}/gh-aw/safeoutputs/outputs.jsonl\" >> \"$GITHUB_OUTPUT\"\n echo \"GH_AW_SAFE_OUTPUTS_CONFIG_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/config.json\" >> \"$GITHUB_OUTPUT\"\n echo \"GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json\" >> \"$GITHUB_OUTPUT\"\n - name: Checkout repository\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n - name: Create gh-aw temp directory\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/create_gh_aw_tmp_dir.sh\"\n - name: Configure gh CLI for GitHub Enterprise\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh\"\n env:\n GH_TOKEN: ${{ github.token }}\n - name: Configure Git credentials\n env:\n REPO_NAME: ${{ github.repository }}\n SERVER_URL: ${{ github.server_url }}\n GITHUB_TOKEN: ${{ github.token }}\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git config --global am.keepcr true\n # Re-authenticate git with GitHub token\n SERVER_URL_STRIPPED=\"${SERVER_URL#https://}\"\n git remote set-url origin \"https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git\"\n echo \"Git configured with standard GitHub Actions identity\"\n - name: Checkout PR branch\n id: checkout-pr\n if: |\n github.event.pull_request || github.event.issue.pull_request\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs');\n await main();\n - name: Install GitHub Copilot CLI\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh\" 1.0.20\n env:\n GH_HOST: github.com\n - name: Install AWF binary\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh\" v0.25.18\n - name: Parse integrity filter lists\n id: parse-guard-vars\n env:\n GH_AW_BLOCKED_USERS_VAR: ${{ vars.GH_AW_GITHUB_BLOCKED_USERS || '' }}\n GH_AW_TRUSTED_USERS_VAR: ${{ vars.GH_AW_GITHUB_TRUSTED_USERS || '' }}\n GH_AW_APPROVAL_LABELS_VAR: ${{ vars.GH_AW_GITHUB_APPROVAL_LABELS || '' }}\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/parse_guard_list.sh\"\n - name: Download container images\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh\" ghcr.io/github/gh-aw-firewall/agent:0.25.18 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.18 ghcr.io/github/gh-aw-firewall/squid:0.25.18 ghcr.io/github/gh-aw-mcpg:v0.2.17 ghcr.io/github/github-mcp-server:v0.32.0 node:lts-alpine\n - name: Write Safe Outputs Config\n run: |\n mkdir -p \"${RUNNER_TEMP}/gh-aw/safeoutputs\"\n mkdir -p /tmp/gh-aw/safeoutputs\n mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs\n cat > \"${RUNNER_TEMP}/gh-aw/safeoutputs/config.json\" << 'GH_AW_SAFE_OUTPUTS_CONFIG_788bfbc2e8cbcb67_EOF'\n {\"add_comment\":{\"max\":1,\"target\":\"*\"},\"add_labels\":{\"allowed\":[\"bug\",\"enhancement\",\"question\",\"documentation\"],\"max\":1,\"target\":\"*\"},\"create_report_incomplete_issue\":{},\"missing_data\":{},\"missing_tool\":{},\"noop\":{\"max\":1,\"report-as-issue\":\"true\"},\"report_incomplete\":{}}\n GH_AW_SAFE_OUTPUTS_CONFIG_788bfbc2e8cbcb67_EOF\n - name: Write Safe Outputs Tools\n env:\n GH_AW_TOOLS_META_JSON: |\n {\n \"description_suffixes\": {\n \"add_comment\": \" CONSTRAINTS: Maximum 1 comment(s) can be added. Target: *.\",\n \"add_labels\": \" CONSTRAINTS: Maximum 1 label(s) can be added. Only these labels are allowed: [\\\"bug\\\" \\\"enhancement\\\" \\\"question\\\" \\\"documentation\\\"]. Target: *.\"\n },\n \"repo_params\": {},\n \"dynamic_tools\": []\n }\n GH_AW_VALIDATION_JSON: |\n {\n \"add_comment\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"body\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"item_number\": {\n \"issueOrPRNumber\": true\n },\n \"repo\": {\n \"type\": \"string\",\n \"maxLength\": 256\n }\n }\n },\n \"add_labels\": {\n \"defaultMax\": 5,\n \"fields\": {\n \"item_number\": {\n \"issueNumberOrTemporaryId\": true\n },\n \"labels\": {\n \"required\": true,\n \"type\": \"array\",\n \"itemType\": \"string\",\n \"itemSanitize\": true,\n \"itemMaxLength\": 128\n },\n \"repo\": {\n \"type\": \"string\",\n \"maxLength\": 256\n }\n }\n },\n \"missing_data\": {\n \"defaultMax\": 20,\n \"fields\": {\n \"alternatives\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"context\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"data_type\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n },\n \"reason\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n }\n }\n },\n \"missing_tool\": {\n \"defaultMax\": 20,\n \"fields\": {\n \"alternatives\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 512\n },\n \"reason\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"tool\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n }\n }\n },\n \"noop\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"message\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n }\n }\n },\n \"report_incomplete\": {\n \"defaultMax\": 5,\n \"fields\": {\n \"details\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"reason\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 1024\n }\n }\n }\n }\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_safe_outputs_tools.cjs');\n await main();\n - name: Generate Safe Outputs MCP Server Config\n id: safe-outputs-config\n run: |\n # Generate a secure random API key (360 bits of entropy, 40+ chars)\n # Mask immediately to prevent timing vulnerabilities\n API_KEY=$(openssl rand -base64 45 | tr -d '/+=')\n echo \"::add-mask::${API_KEY}\"\n \n PORT=3001\n \n # Set outputs for next steps\n {\n echo \"safe_outputs_api_key=${API_KEY}\"\n echo \"safe_outputs_port=${PORT}\"\n } >> \"$GITHUB_OUTPUT\"\n \n echo \"Safe Outputs MCP server will run on port ${PORT}\"\n \n - name: Start Safe Outputs MCP HTTP Server\n id: safe-outputs-start\n env:\n DEBUG: '*'\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-config.outputs.safe_outputs_port }}\n GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-config.outputs.safe_outputs_api_key }}\n GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/tools.json\n GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/config.json\n GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs\n run: |\n # Environment variables are set above to prevent template injection\n export DEBUG\n export GH_AW_SAFE_OUTPUTS\n export GH_AW_SAFE_OUTPUTS_PORT\n export GH_AW_SAFE_OUTPUTS_API_KEY\n export GH_AW_SAFE_OUTPUTS_TOOLS_PATH\n export GH_AW_SAFE_OUTPUTS_CONFIG_PATH\n export GH_AW_MCP_LOG_DIR\n \n bash \"${RUNNER_TEMP}/gh-aw/actions/start_safe_outputs_server.sh\"\n \n - name: Start MCP Gateway\n id: start-mcp-gateway\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-start.outputs.api_key }}\n GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-start.outputs.port }}\n GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n run: |\n set -eo pipefail\n mkdir -p /tmp/gh-aw/mcp-config\n \n # Export gateway environment variables for MCP config and gateway script\n export MCP_GATEWAY_PORT=\"80\"\n export MCP_GATEWAY_DOMAIN=\"host.docker.internal\"\n MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=')\n echo \"::add-mask::${MCP_GATEWAY_API_KEY}\"\n export MCP_GATEWAY_API_KEY\n export MCP_GATEWAY_PAYLOAD_DIR=\"/tmp/gh-aw/mcp-payloads\"\n mkdir -p \"${MCP_GATEWAY_PAYLOAD_DIR}\"\n export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD=\"524288\"\n export DEBUG=\"*\"\n \n export GH_AW_ENGINE=\"copilot\"\n export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host -v /var/run/docker.sock:/var/run/docker.sock -e MCP_GATEWAY_PORT -e MCP_GATEWAY_DOMAIN -e MCP_GATEWAY_API_KEY -e MCP_GATEWAY_PAYLOAD_DIR -e MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD -e DEBUG -e MCP_GATEWAY_LOG_DIR -e GH_AW_MCP_LOG_DIR -e GH_AW_SAFE_OUTPUTS -e GH_AW_SAFE_OUTPUTS_CONFIG_PATH -e GH_AW_SAFE_OUTPUTS_TOOLS_PATH -e GH_AW_ASSETS_BRANCH -e GH_AW_ASSETS_MAX_SIZE_KB -e GH_AW_ASSETS_ALLOWED_EXTS -e DEFAULT_BRANCH -e GITHUB_MCP_SERVER_TOKEN -e GITHUB_MCP_GUARD_MIN_INTEGRITY -e GITHUB_MCP_GUARD_REPOS -e GITHUB_REPOSITORY -e GITHUB_SERVER_URL -e GITHUB_SHA -e GITHUB_WORKSPACE -e GITHUB_TOKEN -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RUN_ATTEMPT -e GITHUB_JOB -e GITHUB_ACTION -e GITHUB_EVENT_NAME -e GITHUB_EVENT_PATH -e GITHUB_ACTOR -e GITHUB_ACTOR_ID -e GITHUB_TRIGGERING_ACTOR -e GITHUB_WORKFLOW -e GITHUB_WORKFLOW_REF -e GITHUB_WORKFLOW_SHA -e GITHUB_REF -e GITHUB_REF_NAME -e GITHUB_REF_TYPE -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GH_AW_SAFE_OUTPUTS_PORT -e GH_AW_SAFE_OUTPUTS_API_KEY -v /tmp/gh-aw/mcp-payloads:/tmp/gh-aw/mcp-payloads:rw -v /opt:/opt:ro -v /tmp:/tmp:rw -v '\"${GITHUB_WORKSPACE}\"':'\"${GITHUB_WORKSPACE}\"':rw ghcr.io/github/gh-aw-mcpg:v0.2.17'\n \n mkdir -p /home/runner/.copilot\n cat << GH_AW_MCP_CONFIG_5cf2254bdcfe4a71_EOF | bash \"${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.sh\"\n {\n \"mcpServers\": {\n \"github\": {\n \"type\": \"stdio\",\n \"container\": \"ghcr.io/github/github-mcp-server:v0.32.0\",\n \"env\": {\n \"GITHUB_HOST\": \"\\${GITHUB_SERVER_URL}\",\n \"GITHUB_PERSONAL_ACCESS_TOKEN\": \"\\${GITHUB_MCP_SERVER_TOKEN}\",\n \"GITHUB_READ_ONLY\": \"1\",\n \"GITHUB_TOOLSETS\": \"context,repos,issues,pull_requests\"\n },\n \"guard-policies\": {\n \"allow-only\": {\n \"approval-labels\": ${{ steps.parse-guard-vars.outputs.approval_labels }},\n \"blocked-users\": ${{ steps.parse-guard-vars.outputs.blocked_users }},\n \"min-integrity\": \"none\",\n \"repos\": \"all\",\n \"trusted-users\": ${{ steps.parse-guard-vars.outputs.trusted_users }}\n }\n }\n },\n \"safeoutputs\": {\n \"type\": \"http\",\n \"url\": \"http://host.docker.internal:$GH_AW_SAFE_OUTPUTS_PORT\",\n \"headers\": {\n \"Authorization\": \"\\${GH_AW_SAFE_OUTPUTS_API_KEY}\"\n },\n \"guard-policies\": {\n \"write-sink\": {\n \"accept\": [\n \"*\"\n ]\n }\n }\n }\n },\n \"gateway\": {\n \"port\": $MCP_GATEWAY_PORT,\n \"domain\": \"${MCP_GATEWAY_DOMAIN}\",\n \"apiKey\": \"${MCP_GATEWAY_API_KEY}\",\n \"payloadDir\": \"${MCP_GATEWAY_PAYLOAD_DIR}\"\n }\n }\n GH_AW_MCP_CONFIG_5cf2254bdcfe4a71_EOF\n - name: Download activation artifact\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}activation\n path: /tmp/gh-aw\n - name: Clean git credentials\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/clean_git_credentials.sh\"\n - name: Execute GitHub Copilot CLI\n id: agentic_execution\n # Copilot CLI tool arguments (sorted):\n timeout-minutes: 20\n run: |\n set -o pipefail\n touch /tmp/gh-aw/agent-step-summary.md\n # shellcheck disable=SC1003\n sudo -E awf --container-workdir \"${GITHUB_WORKSPACE}\" --mount \"${RUNNER_TEMP}/gh-aw:${RUNNER_TEMP}/gh-aw:ro\" --mount \"${RUNNER_TEMP}/gh-aw:/host${RUNNER_TEMP}/gh-aw:ro\" --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --allow-domains api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --image-tag 0.25.18 --skip-pull --enable-api-proxy \\\n -- /bin/bash -c 'node ${RUNNER_TEMP}/gh-aw/actions/copilot_driver.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --allow-all-tools --allow-all-paths --add-dir \"${GITHUB_WORKSPACE}\" --prompt \"$(cat /tmp/gh-aw/aw-prompts/prompt.txt)\"' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log\n env:\n COPILOT_AGENT_RUNNER_TYPE: STANDALONE\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || '' }}\n GH_AW_MCP_CONFIG: /home/runner/.copilot/mcp-config.json\n GH_AW_PHASE: agent\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_VERSION: v0.67.4\n GITHUB_API_URL: ${{ github.api_url }}\n GITHUB_AW: true\n GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows\n GITHUB_HEAD_REF: ${{ github.head_ref }}\n GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n GITHUB_REF_NAME: ${{ github.ref_name }}\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md\n GITHUB_WORKSPACE: ${{ github.workspace }}\n GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_AUTHOR_NAME: github-actions[bot]\n GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_COMMITTER_NAME: github-actions[bot]\n XDG_CONFIG_HOME: /home/runner\n - name: Detect inference access error\n id: detect-inference-error\n if: always()\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/detect_inference_access_error.sh\"\n - name: Configure Git credentials\n env:\n REPO_NAME: ${{ github.repository }}\n SERVER_URL: ${{ github.server_url }}\n GITHUB_TOKEN: ${{ github.token }}\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git config --global am.keepcr true\n # Re-authenticate git with GitHub token\n SERVER_URL_STRIPPED=\"${SERVER_URL#https://}\"\n git remote set-url origin \"https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git\"\n echo \"Git configured with standard GitHub Actions identity\"\n - name: Copy Copilot session state files to logs\n if: always()\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/copy_copilot_session_state.sh\"\n - name: Stop MCP Gateway\n if: always()\n continue-on-error: true\n env:\n MCP_GATEWAY_PORT: ${{ steps.start-mcp-gateway.outputs.gateway-port }}\n MCP_GATEWAY_API_KEY: ${{ steps.start-mcp-gateway.outputs.gateway-api-key }}\n GATEWAY_PID: ${{ steps.start-mcp-gateway.outputs.gateway-pid }}\n run: |\n bash \"${RUNNER_TEMP}/gh-aw/actions/stop_mcp_gateway.sh\" \"$GATEWAY_PID\"\n - name: Redact secrets in logs\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs');\n await main();\n env:\n GH_AW_SECRET_NAMES: 'COPILOT_GITHUB_TOKEN,GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN'\n SECRET_COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }}\n SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }}\n SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n - name: Append agent step summary\n if: always()\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/append_agent_step_summary.sh\"\n - name: Copy Safe Outputs\n if: always()\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n run: |\n mkdir -p /tmp/gh-aw\n cp \"$GH_AW_SAFE_OUTPUTS\" /tmp/gh-aw/safeoutputs.jsonl 2>/dev/null || true\n - name: Ingest agent output\n id: collect_output\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_ALLOWED_DOMAINS: \"api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com\"\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_API_URL: ${{ github.api_url }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/collect_ndjson_output.cjs');\n await main();\n - name: Parse agent logs for step summary\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_copilot_log.cjs');\n await main();\n - name: Parse MCP Gateway logs for step summary\n if: always()\n id: parse-mcp-gateway\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_mcp_gateway_log.cjs');\n await main();\n - name: Print firewall logs\n if: always()\n continue-on-error: true\n env:\n AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs\n run: |\n # Fix permissions on firewall logs so they can be uploaded as artifacts\n # AWF runs with sudo, creating files owned by root\n sudo chmod -R a+r /tmp/gh-aw/sandbox/firewall/logs 2>/dev/null || true\n # Only run awf logs summary if awf command exists (it may not be installed if workflow failed before install step)\n if command -v awf &> /dev/null; then\n awf logs summary | tee -a \"$GITHUB_STEP_SUMMARY\"\n else\n echo 'AWF binary not installed, skipping firewall log summary'\n fi\n - name: Parse token usage for step summary\n if: always()\n continue-on-error: true\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs');\n await main();\n - name: Write agent output placeholder if missing\n if: always()\n run: |\n if [ ! -f /tmp/gh-aw/agent_output.json ]; then\n echo '{\"items\":[]}' > /tmp/gh-aw/agent_output.json\n fi\n - name: Upload agent artifacts\n if: always()\n continue-on-error: true\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}agent\n path: |\n /tmp/gh-aw/aw-prompts/prompt.txt\n /tmp/gh-aw/sandbox/agent/logs/\n /tmp/gh-aw/redacted-urls.log\n /tmp/gh-aw/mcp-logs/\n /tmp/gh-aw/proxy-logs/\n !/tmp/gh-aw/proxy-logs/proxy-tls/\n /tmp/gh-aw/agent_usage.json\n /tmp/gh-aw/agent-stdio.log\n /tmp/gh-aw/agent/\n /tmp/gh-aw/github_rate_limits.jsonl\n /tmp/gh-aw/safeoutputs.jsonl\n /tmp/gh-aw/agent_output.json\n /tmp/gh-aw/aw-*.patch\n /tmp/gh-aw/aw-*.bundle\n if-no-files-found: ignore\n - name: Upload firewall audit logs\n if: always()\n continue-on-error: true\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}firewall-audit-logs\n path: |\n /tmp/gh-aw/sandbox/firewall/logs/\n /tmp/gh-aw/sandbox/firewall/audit/\n if-no-files-found: ignore\n\n conclusion:\n needs:\n - activation\n - agent\n - detection\n - safe_outputs\n if: always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true')\n runs-on: ubuntu-slim\n permissions:\n contents: read\n discussions: write\n issues: write\n pull-requests: write\n concurrency:\n group: \"gh-aw-conclusion-handle-bug-${{ inputs.issue_number }}\"\n cancel-in-progress: false\n outputs:\n incomplete_count: ${{ steps.report_incomplete.outputs.incomplete_count }}\n noop_message: ${{ steps.noop.outputs.noop_message }}\n tools_reported: ${{ steps.missing_tool.outputs.tools_reported }}\n total_count: ${{ steps.missing_tool.outputs.total_count }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Process No-Op Messages\n id: noop\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_NOOP_MAX: \"1\"\n GH_AW_WORKFLOW_NAME: \"Bug Handler\"\n GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\n GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }}\n GH_AW_NOOP_REPORT_AS_ISSUE: \"true\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_noop_message.cjs');\n await main();\n - name: Record missing tool\n id: missing_tool\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_MISSING_TOOL_CREATE_ISSUE: \"true\"\n GH_AW_WORKFLOW_NAME: \"Bug Handler\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/missing_tool.cjs');\n await main();\n - name: Record incomplete\n id: report_incomplete\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_REPORT_INCOMPLETE_CREATE_ISSUE: \"true\"\n GH_AW_WORKFLOW_NAME: \"Bug Handler\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/report_incomplete_handler.cjs');\n await main();\n - name: Handle agent failure\n id: handle_agent_failure\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_WORKFLOW_NAME: \"Bug Handler\"\n GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\n GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }}\n GH_AW_WORKFLOW_ID: \"handle-bug\"\n GH_AW_ENGINE_ID: \"copilot\"\n GH_AW_SECRET_VERIFICATION_RESULT: ${{ needs.activation.outputs.secret_verification_result }}\n GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }}\n GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }}\n GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }}\n GH_AW_GROUP_REPORTS: \"false\"\n GH_AW_FAILURE_REPORT_AS_ISSUE: \"true\"\n GH_AW_TIMEOUT_MINUTES: \"20\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_agent_failure.cjs');\n await main();\n\n detection:\n needs:\n - activation\n - agent\n if: >\n always() && needs.agent.result != 'skipped' && (needs.agent.outputs.output_types != '' || needs.agent.outputs.has_patch == 'true')\n runs-on: ubuntu-latest\n permissions:\n contents: read\n outputs:\n detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }}\n detection_success: ${{ steps.detection_conclusion.outputs.success }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: ${{ needs.agent.outputs.artifact_prefix }}agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Checkout repository for patch context\n if: needs.agent.outputs.has_patch == 'true'\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n # --- Threat Detection ---\n - name: Download container images\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh\" ghcr.io/github/gh-aw-firewall/agent:0.25.18 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.18 ghcr.io/github/gh-aw-firewall/squid:0.25.18\n - name: Check if detection needed\n id: detection_guard\n if: always()\n env:\n OUTPUT_TYPES: ${{ needs.agent.outputs.output_types }}\n HAS_PATCH: ${{ needs.agent.outputs.has_patch }}\n run: |\n if [[ -n \"$OUTPUT_TYPES\" || \"$HAS_PATCH\" == \"true\" ]]; then\n echo \"run_detection=true\" >> \"$GITHUB_OUTPUT\"\n echo \"Detection will run: output_types=$OUTPUT_TYPES, has_patch=$HAS_PATCH\"\n else\n echo \"run_detection=false\" >> \"$GITHUB_OUTPUT\"\n echo \"Detection skipped: no agent outputs or patches to analyze\"\n fi\n - name: Clear MCP configuration for detection\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n rm -f /tmp/gh-aw/mcp-config/mcp-servers.json\n rm -f /home/runner/.copilot/mcp-config.json\n rm -f \"$GITHUB_WORKSPACE/.gemini/settings.json\"\n - name: Prepare threat detection files\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n mkdir -p /tmp/gh-aw/threat-detection/aw-prompts\n cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true\n cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true\n for f in /tmp/gh-aw/aw-*.patch; do\n [ -f \"$f\" ] && cp \"$f\" /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n done\n for f in /tmp/gh-aw/aw-*.bundle; do\n [ -f \"$f\" ] && cp \"$f\" /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n done\n echo \"Prepared threat detection files:\"\n ls -la /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n - name: Setup threat detection\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n WORKFLOW_NAME: \"Bug Handler\"\n WORKFLOW_DESCRIPTION: \"Handles issues classified as bugs by the triage classifier\"\n HAS_PATCH: ${{ needs.agent.outputs.has_patch }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/setup_threat_detection.cjs');\n await main();\n - name: Ensure threat-detection directory and log\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n mkdir -p /tmp/gh-aw/threat-detection\n touch /tmp/gh-aw/threat-detection/detection.log\n - name: Install GitHub Copilot CLI\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh\" 1.0.20\n env:\n GH_HOST: github.com\n - name: Install AWF binary\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh\" v0.25.18\n - name: Execute GitHub Copilot CLI\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n id: detection_agentic_execution\n # Copilot CLI tool arguments (sorted):\n timeout-minutes: 20\n run: |\n set -o pipefail\n touch /tmp/gh-aw/agent-step-summary.md\n # shellcheck disable=SC1003\n sudo -E awf --container-workdir \"${GITHUB_WORKSPACE}\" --mount \"${RUNNER_TEMP}/gh-aw:${RUNNER_TEMP}/gh-aw:ro\" --mount \"${RUNNER_TEMP}/gh-aw:/host${RUNNER_TEMP}/gh-aw:ro\" --env-all --exclude-env COPILOT_GITHUB_TOKEN --allow-domains api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,github.com,host.docker.internal,telemetry.enterprise.githubcopilot.com --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --image-tag 0.25.18 --skip-pull --enable-api-proxy \\\n -- /bin/bash -c 'node ${RUNNER_TEMP}/gh-aw/actions/copilot_driver.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --allow-all-tools --add-dir \"${GITHUB_WORKSPACE}\" --prompt \"$(cat /tmp/gh-aw/aw-prompts/prompt.txt)\"' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log\n env:\n COPILOT_AGENT_RUNNER_TYPE: STANDALONE\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || '' }}\n GH_AW_PHASE: detection\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_VERSION: v0.67.4\n GITHUB_API_URL: ${{ github.api_url }}\n GITHUB_AW: true\n GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows\n GITHUB_HEAD_REF: ${{ github.head_ref }}\n GITHUB_REF_NAME: ${{ github.ref_name }}\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md\n GITHUB_WORKSPACE: ${{ github.workspace }}\n GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_AUTHOR_NAME: github-actions[bot]\n GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_COMMITTER_NAME: github-actions[bot]\n XDG_CONFIG_HOME: /home/runner\n - name: Upload threat detection log\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ needs.agent.outputs.artifact_prefix }}detection\n path: /tmp/gh-aw/threat-detection/detection.log\n if-no-files-found: ignore\n - name: Parse and conclude threat detection\n id: detection_conclusion\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n RUN_DETECTION: ${{ steps.detection_guard.outputs.run_detection }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_threat_detection_results.cjs');\n await main();\n\n safe_outputs:\n needs:\n - activation\n - agent\n - detection\n if: (!cancelled()) && needs.agent.result != 'skipped' && needs.detection.result == 'success'\n runs-on: ubuntu-slim\n permissions:\n contents: read\n discussions: write\n issues: write\n pull-requests: write\n timeout-minutes: 15\n env:\n GH_AW_CALLER_WORKFLOW_ID: \"${{ github.repository }}/handle-bug\"\n GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens }}\n GH_AW_ENGINE_ID: \"copilot\"\n GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }}\n GH_AW_WORKFLOW_ID: \"handle-bug\"\n GH_AW_WORKFLOW_NAME: \"Bug Handler\"\n outputs:\n code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }}\n code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }}\n comment_id: ${{ steps.process_safe_outputs.outputs.comment_id }}\n comment_url: ${{ steps.process_safe_outputs.outputs.comment_url }}\n create_discussion_error_count: ${{ steps.process_safe_outputs.outputs.create_discussion_error_count }}\n create_discussion_errors: ${{ steps.process_safe_outputs.outputs.create_discussion_errors }}\n process_safe_outputs_processed_count: ${{ steps.process_safe_outputs.outputs.processed_count }}\n process_safe_outputs_temporary_id_map: ${{ steps.process_safe_outputs.outputs.temporary_id_map }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Configure GH_HOST for enterprise compatibility\n id: ghes-host-config\n shell: bash\n run: |\n # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct\n # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op.\n GH_HOST=\"${GITHUB_SERVER_URL#https://}\"\n GH_HOST=\"${GH_HOST#http://}\"\n echo \"GH_HOST=${GH_HOST}\" >> \"$GITHUB_ENV\"\n - name: Process Safe Outputs\n id: process_safe_outputs\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_ALLOWED_DOMAINS: \"api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com\"\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_API_URL: ${{ github.api_url }}\n GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: \"{\\\"add_comment\\\":{\\\"max\\\":1,\\\"target\\\":\\\"*\\\"},\\\"add_labels\\\":{\\\"allowed\\\":[\\\"bug\\\",\\\"enhancement\\\",\\\"question\\\",\\\"documentation\\\"],\\\"max\\\":1,\\\"target\\\":\\\"*\\\"},\\\"create_report_incomplete_issue\\\":{},\\\"missing_data\\\":{},\\\"missing_tool\\\":{},\\\"noop\\\":{\\\"max\\\":1,\\\"report-as-issue\\\":\\\"true\\\"},\\\"report_incomplete\\\":{}}\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/safe_output_handler_manager.cjs');\n await main();\n - name: Upload Safe Outputs Items\n if: always()\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}safe-outputs-items\n path: /tmp/gh-aw/safe-output-items.jsonl\n if-no-files-found: ignore\n\n" }, { "path": ".github/workflows/handle-bug.md", "content": "---\ndescription: Handles issues classified as bugs by the triage classifier\nconcurrency:\n job-discriminator: ${{ inputs.issue_number }}\non:\n workflow_call:\n inputs:\n payload:\n type: string\n required: false\n issue_number:\n type: string\n required: true\n roles: all\npermissions:\n contents: read\n issues: read\n pull-requests: read\ntools:\n github:\n toolsets: [default]\n min-integrity: none\nsafe-outputs:\n add-labels:\n allowed: [bug, enhancement, question, documentation]\n max: 1\n target: \"*\"\n add-comment:\n max: 1\n target: \"*\"\ntimeout-minutes: 20\n---\n\n# Bug Handler\n\nYou are an AI agent that investigates issues routed to you as potential bugs in the copilot-sdk repository. Your job is to determine whether the reported issue is genuinely a bug or has been misclassified, and to share your findings.\n\n## Your Task\n\n1. Fetch the full issue content (title, body, and comments) for issue #${{ inputs.issue_number }} using GitHub tools\n2. Investigate the reported behavior by analyzing the relevant source code in the repository\n3. Determine whether the behavior described is actually a bug or whether the product is working as designed\n4. Apply the appropriate label and leave a comment with your findings\n\n## Investigation Steps\n\n1. **Understand the claim** — read the issue carefully to identify what specific behavior the author considers broken and what they expect instead.\n2. **Analyze the codebase** — search the repository for the relevant code paths. Look at the implementation to understand whether the current behavior is intentional or accidental.\n3. **Try to reproduce** — if the issue includes steps to reproduce, attempt to reproduce the bug using available tools (e.g., running tests, executing code). Document whether the bug reproduces and under what conditions.\n4. **Check for related context** — look at recent commits, related tests, or documentation that might clarify whether the behavior is by design.\n\n## Decision and Action\n\nBased on your investigation, take **one** of the following actions:\n\n- **If the behavior is genuinely a bug** (the code is not working as intended): add the `bug` label and leave a comment summarizing the root cause you identified.\n- **If the behavior is working as designed** but the author wants it changed: add the `enhancement` label and leave a comment explaining that the current behavior is intentional and that the issue has been reclassified as a feature request.\n- **If the issue is actually a usage question**: add the `question` label and leave a comment clarifying the intended behavior and how to use the feature correctly.\n- **If the issue is about documentation**, or if the root cause is misuse of the product and there is a clear gap in documentation that would have prevented the issue: add the `documentation` label and leave a comment explaining the reclassification. The comment **must** describe the specific documentation gap — identify which docs are missing, incorrect, or unclear, and explain what content should be added or improved to address the issue.\n\n**Always leave a comment** explaining your findings, even when confirming the issue is a bug. Include:\n- What you investigated (which files/code paths you looked at)\n- What you found (is the behavior intentional or not)\n- Why you applied the label you chose\n" }, { "path": ".github/workflows/handle-documentation.lock.yml", "content": "# gh-aw-metadata: {\"schema_version\":\"v3\",\"frontmatter_hash\":\"258058e9a5e3bb707bbcfc9157b7b69f64c06547642da2526a1ff441e3a358dd\",\"compiler_version\":\"v0.67.4\",\"strict\":true,\"agent_id\":\"copilot\"}\n# gh-aw-manifest: {\"version\":1,\"secrets\":[\"COPILOT_GITHUB_TOKEN\",\"GH_AW_GITHUB_MCP_SERVER_TOKEN\",\"GH_AW_GITHUB_TOKEN\",\"GITHUB_TOKEN\"],\"actions\":[{\"repo\":\"actions/checkout\",\"sha\":\"de0fac2e4500dabe0009e67214ff5f5447ce83dd\",\"version\":\"v6.0.2\"},{\"repo\":\"actions/download-artifact\",\"sha\":\"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c\",\"version\":\"v8.0.1\"},{\"repo\":\"actions/github-script\",\"sha\":\"ed597411d8f924073f98dfc5c65a23a2325f34cd\",\"version\":\"v8\"},{\"repo\":\"actions/upload-artifact\",\"sha\":\"bbbca2ddaa5d8feaa63e36b76fdaad77386f024f\",\"version\":\"v7\"},{\"repo\":\"github/gh-aw-actions/setup\",\"sha\":\"9d6ae06250fc0ec536a0e5f35de313b35bad7246\",\"version\":\"v0.67.4\"}]}\n# ___ _ _ \n# / _ \\ | | (_) \n# | |_| | __ _ ___ _ __ | |_ _ ___ \n# | _ |/ _` |/ _ \\ '_ \\| __| |/ __|\n# | | | | (_| | __/ | | | |_| | (__ \n# \\_| |_/\\__, |\\___|_| |_|\\__|_|\\___|\n# __/ |\n# _ _ |___/ \n# | | | | / _| |\n# | | | | ___ _ __ _ __| |_| | _____ ____\n# | |/\\| |/ _ \\ '__| |/ /| _| |/ _ \\ \\ /\\ / / ___|\n# \\ /\\ / (_) | | | | ( | | | | (_) \\ V V /\\__ \\\n# \\/ \\/ \\___/|_| |_|\\_\\|_| |_|\\___/ \\_/\\_/ |___/\n#\n# This file was automatically generated by gh-aw (v0.67.4). DO NOT EDIT.\n#\n# To update this file, edit the corresponding .md file and run:\n# gh aw compile\n# Not all edits will cause changes to this file.\n#\n# For more information: https://github.github.com/gh-aw/introduction/overview/\n#\n# Handles issues classified as documentation-related by the triage classifier\n#\n# Secrets used:\n# - COPILOT_GITHUB_TOKEN\n# - GH_AW_GITHUB_MCP_SERVER_TOKEN\n# - GH_AW_GITHUB_TOKEN\n# - GITHUB_TOKEN\n#\n# Custom actions used:\n# - actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n# - actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n# - actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n# - actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n# - github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n\nname: \"Documentation Handler\"\n\"on\":\n workflow_call:\n inputs:\n issue_number:\n required: true\n type: string\n payload:\n required: false\n type: string\n outputs:\n comment_id:\n description: ID of the first added comment\n value: ${{ jobs.safe_outputs.outputs.comment_id }}\n comment_url:\n description: URL of the first added comment\n value: ${{ jobs.safe_outputs.outputs.comment_url }}\n\npermissions: {}\n\nconcurrency:\n group: \"gh-aw-${{ github.workflow }}\"\n\nrun-name: \"Documentation Handler\"\n\njobs:\n activation:\n runs-on: ubuntu-slim\n permissions:\n actions: read\n contents: read\n outputs:\n artifact_prefix: ${{ steps.artifact-prefix.outputs.prefix }}\n comment_id: \"\"\n comment_repo: \"\"\n lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }}\n model: ${{ steps.generate_aw_info.outputs.model }}\n secret_verification_result: ${{ steps.validate-secret.outputs.verification_result }}\n setup-trace-id: ${{ steps.setup.outputs.trace-id }}\n target_ref: ${{ steps.resolve-host-repo.outputs.target_ref }}\n target_repo: ${{ steps.resolve-host-repo.outputs.target_repo }}\n target_repo_name: ${{ steps.resolve-host-repo.outputs.target_repo_name }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n - name: Resolve host repo for activation checkout\n id: resolve-host-repo\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/resolve_host_repo.cjs');\n await main();\n - name: Compute artifact prefix\n id: artifact-prefix\n env:\n INPUTS_JSON: ${{ toJSON(inputs) }}\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/compute_artifact_prefix.sh\"\n - name: Generate agentic run info\n id: generate_aw_info\n env:\n GH_AW_INFO_ENGINE_ID: \"copilot\"\n GH_AW_INFO_ENGINE_NAME: \"GitHub Copilot CLI\"\n GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'auto' }}\n GH_AW_INFO_VERSION: \"1.0.20\"\n GH_AW_INFO_AGENT_VERSION: \"1.0.20\"\n GH_AW_INFO_CLI_VERSION: \"v0.67.4\"\n GH_AW_INFO_WORKFLOW_NAME: \"Documentation Handler\"\n GH_AW_INFO_EXPERIMENTAL: \"false\"\n GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: \"true\"\n GH_AW_INFO_STAGED: \"false\"\n GH_AW_INFO_ALLOWED_DOMAINS: '[\"defaults\"]'\n GH_AW_INFO_FIREWALL_ENABLED: \"true\"\n GH_AW_INFO_AWF_VERSION: \"v0.25.18\"\n GH_AW_INFO_AWMG_VERSION: \"\"\n GH_AW_INFO_FIREWALL_TYPE: \"squid\"\n GH_AW_COMPILED_STRICT: \"true\"\n GH_AW_INFO_TARGET_REPO: ${{ steps.resolve-host-repo.outputs.target_repo }}\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs');\n await main(core, context);\n - name: Validate COPILOT_GITHUB_TOKEN secret\n id: validate-secret\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/validate_multi_secret.sh\" COPILOT_GITHUB_TOKEN 'GitHub Copilot CLI' https://github.github.com/gh-aw/reference/engines/#github-copilot-default\n env:\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n - name: Cross-repo setup guidance\n if: failure() && steps.resolve-host-repo.outputs.target_repo != github.repository\n run: |\n echo \"::error::COPILOT_GITHUB_TOKEN must be configured in the CALLER repository's secrets.\"\n echo \"::error::For cross-repo workflow_call, secrets must be set in the repository that triggers the workflow.\"\n echo \"::error::See: https://github.github.com/gh-aw/patterns/central-repo-ops/#cross-repo-setup\"\n - name: Checkout .github and .agents folders\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n repository: ${{ steps.resolve-host-repo.outputs.target_repo }}\n ref: ${{ steps.resolve-host-repo.outputs.target_ref }}\n sparse-checkout: |\n .github\n .agents\n sparse-checkout-cone-mode: true\n fetch-depth: 1\n - name: Check workflow lock file\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_WORKFLOW_FILE: \"handle-documentation.lock.yml\"\n GH_AW_CONTEXT_WORKFLOW_REF: \"${{ github.workflow_ref }}\"\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/check_workflow_timestamp_api.cjs');\n await main();\n - name: Check compile-agentic version\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_COMPILED_VERSION: \"v0.67.4\"\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/check_version_updates.cjs');\n await main();\n - name: Create prompt with built-in context\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_SAFE_OUTPUTS: ${{ runner.temp }}/gh-aw/safeoutputs/outputs.jsonl\n GH_AW_GITHUB_ACTOR: ${{ github.actor }}\n GH_AW_GITHUB_EVENT_COMMENT_ID: ${{ github.event.comment.id }}\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: ${{ github.event.discussion.number }}\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: ${{ github.event.issue.number }}\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n GH_AW_GITHUB_RUN_ID: ${{ github.run_id }}\n GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }}\n GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }}\n # poutine:ignore untrusted_checkout_exec\n run: |\n bash \"${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh\"\n {\n cat << 'GH_AW_PROMPT_c1995fcb77e4eb7d_EOF'\n \n GH_AW_PROMPT_c1995fcb77e4eb7d_EOF\n cat \"${RUNNER_TEMP}/gh-aw/prompts/xpia.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/markdown.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md\"\n cat << 'GH_AW_PROMPT_c1995fcb77e4eb7d_EOF'\n \n Tools: add_comment, add_labels, missing_tool, missing_data, noop\n \n \n The following GitHub context information is available for this workflow:\n {{#if __GH_AW_GITHUB_ACTOR__ }}\n - **actor**: __GH_AW_GITHUB_ACTOR__\n {{/if}}\n {{#if __GH_AW_GITHUB_REPOSITORY__ }}\n - **repository**: __GH_AW_GITHUB_REPOSITORY__\n {{/if}}\n {{#if __GH_AW_GITHUB_WORKSPACE__ }}\n - **workspace**: __GH_AW_GITHUB_WORKSPACE__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_ISSUE_NUMBER__ }}\n - **issue-number**: #__GH_AW_GITHUB_EVENT_ISSUE_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER__ }}\n - **discussion-number**: #__GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER__ }}\n - **pull-request-number**: #__GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_COMMENT_ID__ }}\n - **comment-id**: __GH_AW_GITHUB_EVENT_COMMENT_ID__\n {{/if}}\n {{#if __GH_AW_GITHUB_RUN_ID__ }}\n - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__\n {{/if}}\n \n \n GH_AW_PROMPT_c1995fcb77e4eb7d_EOF\n cat \"${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md\"\n cat << 'GH_AW_PROMPT_c1995fcb77e4eb7d_EOF'\n \n {{#runtime-import .github/workflows/handle-documentation.md}}\n GH_AW_PROMPT_c1995fcb77e4eb7d_EOF\n } > \"$GH_AW_PROMPT\"\n - name: Interpolate variables and render templates\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/interpolate_prompt.cjs');\n await main();\n - name: Substitute placeholders\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_GITHUB_ACTOR: ${{ github.actor }}\n GH_AW_GITHUB_EVENT_COMMENT_ID: ${{ github.event.comment.id }}\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: ${{ github.event.discussion.number }}\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: ${{ github.event.issue.number }}\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n GH_AW_GITHUB_RUN_ID: ${{ github.run_id }}\n GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }}\n GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n \n const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs');\n \n // Call the substitution function\n return await substitutePlaceholders({\n file: process.env.GH_AW_PROMPT,\n substitutions: {\n GH_AW_GITHUB_ACTOR: process.env.GH_AW_GITHUB_ACTOR,\n GH_AW_GITHUB_EVENT_COMMENT_ID: process.env.GH_AW_GITHUB_EVENT_COMMENT_ID,\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: process.env.GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER,\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: process.env.GH_AW_GITHUB_EVENT_ISSUE_NUMBER,\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: process.env.GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER,\n GH_AW_GITHUB_REPOSITORY: process.env.GH_AW_GITHUB_REPOSITORY,\n GH_AW_GITHUB_RUN_ID: process.env.GH_AW_GITHUB_RUN_ID,\n GH_AW_GITHUB_WORKSPACE: process.env.GH_AW_GITHUB_WORKSPACE,\n GH_AW_INPUTS_ISSUE_NUMBER: process.env.GH_AW_INPUTS_ISSUE_NUMBER\n }\n });\n - name: Validate prompt placeholders\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n # poutine:ignore untrusted_checkout_exec\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/validate_prompt_placeholders.sh\"\n - name: Print prompt\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n # poutine:ignore untrusted_checkout_exec\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/print_prompt_summary.sh\"\n - name: Upload activation artifact\n if: success()\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ steps.artifact-prefix.outputs.prefix }}activation\n path: |\n /tmp/gh-aw/aw_info.json\n /tmp/gh-aw/aw-prompts/prompt.txt\n /tmp/gh-aw/github_rate_limits.jsonl\n if-no-files-found: ignore\n retention-days: 1\n\n agent:\n needs: activation\n runs-on: ubuntu-latest\n permissions:\n contents: read\n issues: read\n pull-requests: read\n concurrency:\n group: \"gh-aw-copilot-${{ github.workflow }}-${{ inputs.issue_number }}\"\n env:\n DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}\n GH_AW_ASSETS_ALLOWED_EXTS: \"\"\n GH_AW_ASSETS_BRANCH: \"\"\n GH_AW_ASSETS_MAX_SIZE_KB: 0\n GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs\n GH_AW_WORKFLOW_ID_SANITIZED: handledocumentation\n outputs:\n artifact_prefix: ${{ needs.activation.outputs.artifact_prefix }}\n checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }}\n effective_tokens: ${{ steps.parse-mcp-gateway.outputs.effective_tokens }}\n has_patch: ${{ steps.collect_output.outputs.has_patch }}\n inference_access_error: ${{ steps.detect-inference-error.outputs.inference_access_error || 'false' }}\n model: ${{ needs.activation.outputs.model }}\n output: ${{ steps.collect_output.outputs.output }}\n output_types: ${{ steps.collect_output.outputs.output_types }}\n setup-trace-id: ${{ steps.setup.outputs.trace-id }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Set runtime paths\n id: set-runtime-paths\n run: |\n echo \"GH_AW_SAFE_OUTPUTS=${RUNNER_TEMP}/gh-aw/safeoutputs/outputs.jsonl\" >> \"$GITHUB_OUTPUT\"\n echo \"GH_AW_SAFE_OUTPUTS_CONFIG_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/config.json\" >> \"$GITHUB_OUTPUT\"\n echo \"GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json\" >> \"$GITHUB_OUTPUT\"\n - name: Checkout repository\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n - name: Create gh-aw temp directory\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/create_gh_aw_tmp_dir.sh\"\n - name: Configure gh CLI for GitHub Enterprise\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh\"\n env:\n GH_TOKEN: ${{ github.token }}\n - name: Configure Git credentials\n env:\n REPO_NAME: ${{ github.repository }}\n SERVER_URL: ${{ github.server_url }}\n GITHUB_TOKEN: ${{ github.token }}\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git config --global am.keepcr true\n # Re-authenticate git with GitHub token\n SERVER_URL_STRIPPED=\"${SERVER_URL#https://}\"\n git remote set-url origin \"https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git\"\n echo \"Git configured with standard GitHub Actions identity\"\n - name: Checkout PR branch\n id: checkout-pr\n if: |\n github.event.pull_request || github.event.issue.pull_request\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs');\n await main();\n - name: Install GitHub Copilot CLI\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh\" 1.0.20\n env:\n GH_HOST: github.com\n - name: Install AWF binary\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh\" v0.25.18\n - name: Parse integrity filter lists\n id: parse-guard-vars\n env:\n GH_AW_BLOCKED_USERS_VAR: ${{ vars.GH_AW_GITHUB_BLOCKED_USERS || '' }}\n GH_AW_TRUSTED_USERS_VAR: ${{ vars.GH_AW_GITHUB_TRUSTED_USERS || '' }}\n GH_AW_APPROVAL_LABELS_VAR: ${{ vars.GH_AW_GITHUB_APPROVAL_LABELS || '' }}\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/parse_guard_list.sh\"\n - name: Download container images\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh\" ghcr.io/github/gh-aw-firewall/agent:0.25.18 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.18 ghcr.io/github/gh-aw-firewall/squid:0.25.18 ghcr.io/github/gh-aw-mcpg:v0.2.17 ghcr.io/github/github-mcp-server:v0.32.0 node:lts-alpine\n - name: Write Safe Outputs Config\n run: |\n mkdir -p \"${RUNNER_TEMP}/gh-aw/safeoutputs\"\n mkdir -p /tmp/gh-aw/safeoutputs\n mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs\n cat > \"${RUNNER_TEMP}/gh-aw/safeoutputs/config.json\" << 'GH_AW_SAFE_OUTPUTS_CONFIG_f287fa0f078c345e_EOF'\n {\"add_comment\":{\"max\":1,\"target\":\"*\"},\"add_labels\":{\"allowed\":[\"documentation\"],\"max\":1,\"target\":\"*\"},\"create_report_incomplete_issue\":{},\"missing_data\":{},\"missing_tool\":{},\"noop\":{\"max\":1,\"report-as-issue\":\"true\"},\"report_incomplete\":{}}\n GH_AW_SAFE_OUTPUTS_CONFIG_f287fa0f078c345e_EOF\n - name: Write Safe Outputs Tools\n env:\n GH_AW_TOOLS_META_JSON: |\n {\n \"description_suffixes\": {\n \"add_comment\": \" CONSTRAINTS: Maximum 1 comment(s) can be added. Target: *.\",\n \"add_labels\": \" CONSTRAINTS: Maximum 1 label(s) can be added. Only these labels are allowed: [\\\"documentation\\\"]. Target: *.\"\n },\n \"repo_params\": {},\n \"dynamic_tools\": []\n }\n GH_AW_VALIDATION_JSON: |\n {\n \"add_comment\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"body\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"item_number\": {\n \"issueOrPRNumber\": true\n },\n \"repo\": {\n \"type\": \"string\",\n \"maxLength\": 256\n }\n }\n },\n \"add_labels\": {\n \"defaultMax\": 5,\n \"fields\": {\n \"item_number\": {\n \"issueNumberOrTemporaryId\": true\n },\n \"labels\": {\n \"required\": true,\n \"type\": \"array\",\n \"itemType\": \"string\",\n \"itemSanitize\": true,\n \"itemMaxLength\": 128\n },\n \"repo\": {\n \"type\": \"string\",\n \"maxLength\": 256\n }\n }\n },\n \"missing_data\": {\n \"defaultMax\": 20,\n \"fields\": {\n \"alternatives\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"context\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"data_type\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n },\n \"reason\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n }\n }\n },\n \"missing_tool\": {\n \"defaultMax\": 20,\n \"fields\": {\n \"alternatives\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 512\n },\n \"reason\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"tool\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n }\n }\n },\n \"noop\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"message\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n }\n }\n },\n \"report_incomplete\": {\n \"defaultMax\": 5,\n \"fields\": {\n \"details\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"reason\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 1024\n }\n }\n }\n }\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_safe_outputs_tools.cjs');\n await main();\n - name: Generate Safe Outputs MCP Server Config\n id: safe-outputs-config\n run: |\n # Generate a secure random API key (360 bits of entropy, 40+ chars)\n # Mask immediately to prevent timing vulnerabilities\n API_KEY=$(openssl rand -base64 45 | tr -d '/+=')\n echo \"::add-mask::${API_KEY}\"\n \n PORT=3001\n \n # Set outputs for next steps\n {\n echo \"safe_outputs_api_key=${API_KEY}\"\n echo \"safe_outputs_port=${PORT}\"\n } >> \"$GITHUB_OUTPUT\"\n \n echo \"Safe Outputs MCP server will run on port ${PORT}\"\n \n - name: Start Safe Outputs MCP HTTP Server\n id: safe-outputs-start\n env:\n DEBUG: '*'\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-config.outputs.safe_outputs_port }}\n GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-config.outputs.safe_outputs_api_key }}\n GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/tools.json\n GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/config.json\n GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs\n run: |\n # Environment variables are set above to prevent template injection\n export DEBUG\n export GH_AW_SAFE_OUTPUTS\n export GH_AW_SAFE_OUTPUTS_PORT\n export GH_AW_SAFE_OUTPUTS_API_KEY\n export GH_AW_SAFE_OUTPUTS_TOOLS_PATH\n export GH_AW_SAFE_OUTPUTS_CONFIG_PATH\n export GH_AW_MCP_LOG_DIR\n \n bash \"${RUNNER_TEMP}/gh-aw/actions/start_safe_outputs_server.sh\"\n \n - name: Start MCP Gateway\n id: start-mcp-gateway\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-start.outputs.api_key }}\n GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-start.outputs.port }}\n GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n run: |\n set -eo pipefail\n mkdir -p /tmp/gh-aw/mcp-config\n \n # Export gateway environment variables for MCP config and gateway script\n export MCP_GATEWAY_PORT=\"80\"\n export MCP_GATEWAY_DOMAIN=\"host.docker.internal\"\n MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=')\n echo \"::add-mask::${MCP_GATEWAY_API_KEY}\"\n export MCP_GATEWAY_API_KEY\n export MCP_GATEWAY_PAYLOAD_DIR=\"/tmp/gh-aw/mcp-payloads\"\n mkdir -p \"${MCP_GATEWAY_PAYLOAD_DIR}\"\n export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD=\"524288\"\n export DEBUG=\"*\"\n \n export GH_AW_ENGINE=\"copilot\"\n export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host -v /var/run/docker.sock:/var/run/docker.sock -e MCP_GATEWAY_PORT -e MCP_GATEWAY_DOMAIN -e MCP_GATEWAY_API_KEY -e MCP_GATEWAY_PAYLOAD_DIR -e MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD -e DEBUG -e MCP_GATEWAY_LOG_DIR -e GH_AW_MCP_LOG_DIR -e GH_AW_SAFE_OUTPUTS -e GH_AW_SAFE_OUTPUTS_CONFIG_PATH -e GH_AW_SAFE_OUTPUTS_TOOLS_PATH -e GH_AW_ASSETS_BRANCH -e GH_AW_ASSETS_MAX_SIZE_KB -e GH_AW_ASSETS_ALLOWED_EXTS -e DEFAULT_BRANCH -e GITHUB_MCP_SERVER_TOKEN -e GITHUB_MCP_GUARD_MIN_INTEGRITY -e GITHUB_MCP_GUARD_REPOS -e GITHUB_REPOSITORY -e GITHUB_SERVER_URL -e GITHUB_SHA -e GITHUB_WORKSPACE -e GITHUB_TOKEN -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RUN_ATTEMPT -e GITHUB_JOB -e GITHUB_ACTION -e GITHUB_EVENT_NAME -e GITHUB_EVENT_PATH -e GITHUB_ACTOR -e GITHUB_ACTOR_ID -e GITHUB_TRIGGERING_ACTOR -e GITHUB_WORKFLOW -e GITHUB_WORKFLOW_REF -e GITHUB_WORKFLOW_SHA -e GITHUB_REF -e GITHUB_REF_NAME -e GITHUB_REF_TYPE -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GH_AW_SAFE_OUTPUTS_PORT -e GH_AW_SAFE_OUTPUTS_API_KEY -v /tmp/gh-aw/mcp-payloads:/tmp/gh-aw/mcp-payloads:rw -v /opt:/opt:ro -v /tmp:/tmp:rw -v '\"${GITHUB_WORKSPACE}\"':'\"${GITHUB_WORKSPACE}\"':rw ghcr.io/github/gh-aw-mcpg:v0.2.17'\n \n mkdir -p /home/runner/.copilot\n cat << GH_AW_MCP_CONFIG_728828b4ea6e4249_EOF | bash \"${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.sh\"\n {\n \"mcpServers\": {\n \"github\": {\n \"type\": \"stdio\",\n \"container\": \"ghcr.io/github/github-mcp-server:v0.32.0\",\n \"env\": {\n \"GITHUB_HOST\": \"\\${GITHUB_SERVER_URL}\",\n \"GITHUB_PERSONAL_ACCESS_TOKEN\": \"\\${GITHUB_MCP_SERVER_TOKEN}\",\n \"GITHUB_READ_ONLY\": \"1\",\n \"GITHUB_TOOLSETS\": \"context,repos,issues,pull_requests\"\n },\n \"guard-policies\": {\n \"allow-only\": {\n \"approval-labels\": ${{ steps.parse-guard-vars.outputs.approval_labels }},\n \"blocked-users\": ${{ steps.parse-guard-vars.outputs.blocked_users }},\n \"min-integrity\": \"none\",\n \"repos\": \"all\",\n \"trusted-users\": ${{ steps.parse-guard-vars.outputs.trusted_users }}\n }\n }\n },\n \"safeoutputs\": {\n \"type\": \"http\",\n \"url\": \"http://host.docker.internal:$GH_AW_SAFE_OUTPUTS_PORT\",\n \"headers\": {\n \"Authorization\": \"\\${GH_AW_SAFE_OUTPUTS_API_KEY}\"\n },\n \"guard-policies\": {\n \"write-sink\": {\n \"accept\": [\n \"*\"\n ]\n }\n }\n }\n },\n \"gateway\": {\n \"port\": $MCP_GATEWAY_PORT,\n \"domain\": \"${MCP_GATEWAY_DOMAIN}\",\n \"apiKey\": \"${MCP_GATEWAY_API_KEY}\",\n \"payloadDir\": \"${MCP_GATEWAY_PAYLOAD_DIR}\"\n }\n }\n GH_AW_MCP_CONFIG_728828b4ea6e4249_EOF\n - name: Download activation artifact\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}activation\n path: /tmp/gh-aw\n - name: Clean git credentials\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/clean_git_credentials.sh\"\n - name: Execute GitHub Copilot CLI\n id: agentic_execution\n # Copilot CLI tool arguments (sorted):\n timeout-minutes: 5\n run: |\n set -o pipefail\n touch /tmp/gh-aw/agent-step-summary.md\n # shellcheck disable=SC1003\n sudo -E awf --container-workdir \"${GITHUB_WORKSPACE}\" --mount \"${RUNNER_TEMP}/gh-aw:${RUNNER_TEMP}/gh-aw:ro\" --mount \"${RUNNER_TEMP}/gh-aw:/host${RUNNER_TEMP}/gh-aw:ro\" --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --allow-domains api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --image-tag 0.25.18 --skip-pull --enable-api-proxy \\\n -- /bin/bash -c 'node ${RUNNER_TEMP}/gh-aw/actions/copilot_driver.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --allow-all-tools --allow-all-paths --add-dir \"${GITHUB_WORKSPACE}\" --prompt \"$(cat /tmp/gh-aw/aw-prompts/prompt.txt)\"' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log\n env:\n COPILOT_AGENT_RUNNER_TYPE: STANDALONE\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || '' }}\n GH_AW_MCP_CONFIG: /home/runner/.copilot/mcp-config.json\n GH_AW_PHASE: agent\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_VERSION: v0.67.4\n GITHUB_API_URL: ${{ github.api_url }}\n GITHUB_AW: true\n GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows\n GITHUB_HEAD_REF: ${{ github.head_ref }}\n GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n GITHUB_REF_NAME: ${{ github.ref_name }}\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md\n GITHUB_WORKSPACE: ${{ github.workspace }}\n GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_AUTHOR_NAME: github-actions[bot]\n GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_COMMITTER_NAME: github-actions[bot]\n XDG_CONFIG_HOME: /home/runner\n - name: Detect inference access error\n id: detect-inference-error\n if: always()\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/detect_inference_access_error.sh\"\n - name: Configure Git credentials\n env:\n REPO_NAME: ${{ github.repository }}\n SERVER_URL: ${{ github.server_url }}\n GITHUB_TOKEN: ${{ github.token }}\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git config --global am.keepcr true\n # Re-authenticate git with GitHub token\n SERVER_URL_STRIPPED=\"${SERVER_URL#https://}\"\n git remote set-url origin \"https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git\"\n echo \"Git configured with standard GitHub Actions identity\"\n - name: Copy Copilot session state files to logs\n if: always()\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/copy_copilot_session_state.sh\"\n - name: Stop MCP Gateway\n if: always()\n continue-on-error: true\n env:\n MCP_GATEWAY_PORT: ${{ steps.start-mcp-gateway.outputs.gateway-port }}\n MCP_GATEWAY_API_KEY: ${{ steps.start-mcp-gateway.outputs.gateway-api-key }}\n GATEWAY_PID: ${{ steps.start-mcp-gateway.outputs.gateway-pid }}\n run: |\n bash \"${RUNNER_TEMP}/gh-aw/actions/stop_mcp_gateway.sh\" \"$GATEWAY_PID\"\n - name: Redact secrets in logs\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs');\n await main();\n env:\n GH_AW_SECRET_NAMES: 'COPILOT_GITHUB_TOKEN,GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN'\n SECRET_COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }}\n SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }}\n SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n - name: Append agent step summary\n if: always()\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/append_agent_step_summary.sh\"\n - name: Copy Safe Outputs\n if: always()\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n run: |\n mkdir -p /tmp/gh-aw\n cp \"$GH_AW_SAFE_OUTPUTS\" /tmp/gh-aw/safeoutputs.jsonl 2>/dev/null || true\n - name: Ingest agent output\n id: collect_output\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_ALLOWED_DOMAINS: \"api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com\"\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_API_URL: ${{ github.api_url }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/collect_ndjson_output.cjs');\n await main();\n - name: Parse agent logs for step summary\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_copilot_log.cjs');\n await main();\n - name: Parse MCP Gateway logs for step summary\n if: always()\n id: parse-mcp-gateway\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_mcp_gateway_log.cjs');\n await main();\n - name: Print firewall logs\n if: always()\n continue-on-error: true\n env:\n AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs\n run: |\n # Fix permissions on firewall logs so they can be uploaded as artifacts\n # AWF runs with sudo, creating files owned by root\n sudo chmod -R a+r /tmp/gh-aw/sandbox/firewall/logs 2>/dev/null || true\n # Only run awf logs summary if awf command exists (it may not be installed if workflow failed before install step)\n if command -v awf &> /dev/null; then\n awf logs summary | tee -a \"$GITHUB_STEP_SUMMARY\"\n else\n echo 'AWF binary not installed, skipping firewall log summary'\n fi\n - name: Parse token usage for step summary\n if: always()\n continue-on-error: true\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs');\n await main();\n - name: Write agent output placeholder if missing\n if: always()\n run: |\n if [ ! -f /tmp/gh-aw/agent_output.json ]; then\n echo '{\"items\":[]}' > /tmp/gh-aw/agent_output.json\n fi\n - name: Upload agent artifacts\n if: always()\n continue-on-error: true\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}agent\n path: |\n /tmp/gh-aw/aw-prompts/prompt.txt\n /tmp/gh-aw/sandbox/agent/logs/\n /tmp/gh-aw/redacted-urls.log\n /tmp/gh-aw/mcp-logs/\n /tmp/gh-aw/proxy-logs/\n !/tmp/gh-aw/proxy-logs/proxy-tls/\n /tmp/gh-aw/agent_usage.json\n /tmp/gh-aw/agent-stdio.log\n /tmp/gh-aw/agent/\n /tmp/gh-aw/github_rate_limits.jsonl\n /tmp/gh-aw/safeoutputs.jsonl\n /tmp/gh-aw/agent_output.json\n /tmp/gh-aw/aw-*.patch\n /tmp/gh-aw/aw-*.bundle\n if-no-files-found: ignore\n - name: Upload firewall audit logs\n if: always()\n continue-on-error: true\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}firewall-audit-logs\n path: |\n /tmp/gh-aw/sandbox/firewall/logs/\n /tmp/gh-aw/sandbox/firewall/audit/\n if-no-files-found: ignore\n\n conclusion:\n needs:\n - activation\n - agent\n - detection\n - safe_outputs\n if: always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true')\n runs-on: ubuntu-slim\n permissions:\n contents: read\n discussions: write\n issues: write\n pull-requests: write\n concurrency:\n group: \"gh-aw-conclusion-handle-documentation-${{ inputs.issue_number }}\"\n cancel-in-progress: false\n outputs:\n incomplete_count: ${{ steps.report_incomplete.outputs.incomplete_count }}\n noop_message: ${{ steps.noop.outputs.noop_message }}\n tools_reported: ${{ steps.missing_tool.outputs.tools_reported }}\n total_count: ${{ steps.missing_tool.outputs.total_count }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Process No-Op Messages\n id: noop\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_NOOP_MAX: \"1\"\n GH_AW_WORKFLOW_NAME: \"Documentation Handler\"\n GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\n GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }}\n GH_AW_NOOP_REPORT_AS_ISSUE: \"true\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_noop_message.cjs');\n await main();\n - name: Record missing tool\n id: missing_tool\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_MISSING_TOOL_CREATE_ISSUE: \"true\"\n GH_AW_WORKFLOW_NAME: \"Documentation Handler\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/missing_tool.cjs');\n await main();\n - name: Record incomplete\n id: report_incomplete\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_REPORT_INCOMPLETE_CREATE_ISSUE: \"true\"\n GH_AW_WORKFLOW_NAME: \"Documentation Handler\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/report_incomplete_handler.cjs');\n await main();\n - name: Handle agent failure\n id: handle_agent_failure\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_WORKFLOW_NAME: \"Documentation Handler\"\n GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\n GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }}\n GH_AW_WORKFLOW_ID: \"handle-documentation\"\n GH_AW_ENGINE_ID: \"copilot\"\n GH_AW_SECRET_VERIFICATION_RESULT: ${{ needs.activation.outputs.secret_verification_result }}\n GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }}\n GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }}\n GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }}\n GH_AW_GROUP_REPORTS: \"false\"\n GH_AW_FAILURE_REPORT_AS_ISSUE: \"true\"\n GH_AW_TIMEOUT_MINUTES: \"5\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_agent_failure.cjs');\n await main();\n\n detection:\n needs:\n - activation\n - agent\n if: >\n always() && needs.agent.result != 'skipped' && (needs.agent.outputs.output_types != '' || needs.agent.outputs.has_patch == 'true')\n runs-on: ubuntu-latest\n permissions:\n contents: read\n outputs:\n detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }}\n detection_success: ${{ steps.detection_conclusion.outputs.success }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: ${{ needs.agent.outputs.artifact_prefix }}agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Checkout repository for patch context\n if: needs.agent.outputs.has_patch == 'true'\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n # --- Threat Detection ---\n - name: Download container images\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh\" ghcr.io/github/gh-aw-firewall/agent:0.25.18 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.18 ghcr.io/github/gh-aw-firewall/squid:0.25.18\n - name: Check if detection needed\n id: detection_guard\n if: always()\n env:\n OUTPUT_TYPES: ${{ needs.agent.outputs.output_types }}\n HAS_PATCH: ${{ needs.agent.outputs.has_patch }}\n run: |\n if [[ -n \"$OUTPUT_TYPES\" || \"$HAS_PATCH\" == \"true\" ]]; then\n echo \"run_detection=true\" >> \"$GITHUB_OUTPUT\"\n echo \"Detection will run: output_types=$OUTPUT_TYPES, has_patch=$HAS_PATCH\"\n else\n echo \"run_detection=false\" >> \"$GITHUB_OUTPUT\"\n echo \"Detection skipped: no agent outputs or patches to analyze\"\n fi\n - name: Clear MCP configuration for detection\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n rm -f /tmp/gh-aw/mcp-config/mcp-servers.json\n rm -f /home/runner/.copilot/mcp-config.json\n rm -f \"$GITHUB_WORKSPACE/.gemini/settings.json\"\n - name: Prepare threat detection files\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n mkdir -p /tmp/gh-aw/threat-detection/aw-prompts\n cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true\n cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true\n for f in /tmp/gh-aw/aw-*.patch; do\n [ -f \"$f\" ] && cp \"$f\" /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n done\n for f in /tmp/gh-aw/aw-*.bundle; do\n [ -f \"$f\" ] && cp \"$f\" /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n done\n echo \"Prepared threat detection files:\"\n ls -la /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n - name: Setup threat detection\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n WORKFLOW_NAME: \"Documentation Handler\"\n WORKFLOW_DESCRIPTION: \"Handles issues classified as documentation-related by the triage classifier\"\n HAS_PATCH: ${{ needs.agent.outputs.has_patch }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/setup_threat_detection.cjs');\n await main();\n - name: Ensure threat-detection directory and log\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n mkdir -p /tmp/gh-aw/threat-detection\n touch /tmp/gh-aw/threat-detection/detection.log\n - name: Install GitHub Copilot CLI\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh\" 1.0.20\n env:\n GH_HOST: github.com\n - name: Install AWF binary\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh\" v0.25.18\n - name: Execute GitHub Copilot CLI\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n id: detection_agentic_execution\n # Copilot CLI tool arguments (sorted):\n timeout-minutes: 20\n run: |\n set -o pipefail\n touch /tmp/gh-aw/agent-step-summary.md\n # shellcheck disable=SC1003\n sudo -E awf --container-workdir \"${GITHUB_WORKSPACE}\" --mount \"${RUNNER_TEMP}/gh-aw:${RUNNER_TEMP}/gh-aw:ro\" --mount \"${RUNNER_TEMP}/gh-aw:/host${RUNNER_TEMP}/gh-aw:ro\" --env-all --exclude-env COPILOT_GITHUB_TOKEN --allow-domains api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,github.com,host.docker.internal,telemetry.enterprise.githubcopilot.com --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --image-tag 0.25.18 --skip-pull --enable-api-proxy \\\n -- /bin/bash -c 'node ${RUNNER_TEMP}/gh-aw/actions/copilot_driver.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --allow-all-tools --add-dir \"${GITHUB_WORKSPACE}\" --prompt \"$(cat /tmp/gh-aw/aw-prompts/prompt.txt)\"' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log\n env:\n COPILOT_AGENT_RUNNER_TYPE: STANDALONE\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || '' }}\n GH_AW_PHASE: detection\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_VERSION: v0.67.4\n GITHUB_API_URL: ${{ github.api_url }}\n GITHUB_AW: true\n GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows\n GITHUB_HEAD_REF: ${{ github.head_ref }}\n GITHUB_REF_NAME: ${{ github.ref_name }}\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md\n GITHUB_WORKSPACE: ${{ github.workspace }}\n GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_AUTHOR_NAME: github-actions[bot]\n GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_COMMITTER_NAME: github-actions[bot]\n XDG_CONFIG_HOME: /home/runner\n - name: Upload threat detection log\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ needs.agent.outputs.artifact_prefix }}detection\n path: /tmp/gh-aw/threat-detection/detection.log\n if-no-files-found: ignore\n - name: Parse and conclude threat detection\n id: detection_conclusion\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n RUN_DETECTION: ${{ steps.detection_guard.outputs.run_detection }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_threat_detection_results.cjs');\n await main();\n\n safe_outputs:\n needs:\n - activation\n - agent\n - detection\n if: (!cancelled()) && needs.agent.result != 'skipped' && needs.detection.result == 'success'\n runs-on: ubuntu-slim\n permissions:\n contents: read\n discussions: write\n issues: write\n pull-requests: write\n timeout-minutes: 15\n env:\n GH_AW_CALLER_WORKFLOW_ID: \"${{ github.repository }}/handle-documentation\"\n GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens }}\n GH_AW_ENGINE_ID: \"copilot\"\n GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }}\n GH_AW_WORKFLOW_ID: \"handle-documentation\"\n GH_AW_WORKFLOW_NAME: \"Documentation Handler\"\n outputs:\n code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }}\n code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }}\n comment_id: ${{ steps.process_safe_outputs.outputs.comment_id }}\n comment_url: ${{ steps.process_safe_outputs.outputs.comment_url }}\n create_discussion_error_count: ${{ steps.process_safe_outputs.outputs.create_discussion_error_count }}\n create_discussion_errors: ${{ steps.process_safe_outputs.outputs.create_discussion_errors }}\n process_safe_outputs_processed_count: ${{ steps.process_safe_outputs.outputs.processed_count }}\n process_safe_outputs_temporary_id_map: ${{ steps.process_safe_outputs.outputs.temporary_id_map }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Configure GH_HOST for enterprise compatibility\n id: ghes-host-config\n shell: bash\n run: |\n # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct\n # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op.\n GH_HOST=\"${GITHUB_SERVER_URL#https://}\"\n GH_HOST=\"${GH_HOST#http://}\"\n echo \"GH_HOST=${GH_HOST}\" >> \"$GITHUB_ENV\"\n - name: Process Safe Outputs\n id: process_safe_outputs\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_ALLOWED_DOMAINS: \"api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com\"\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_API_URL: ${{ github.api_url }}\n GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: \"{\\\"add_comment\\\":{\\\"max\\\":1,\\\"target\\\":\\\"*\\\"},\\\"add_labels\\\":{\\\"allowed\\\":[\\\"documentation\\\"],\\\"max\\\":1,\\\"target\\\":\\\"*\\\"},\\\"create_report_incomplete_issue\\\":{},\\\"missing_data\\\":{},\\\"missing_tool\\\":{},\\\"noop\\\":{\\\"max\\\":1,\\\"report-as-issue\\\":\\\"true\\\"},\\\"report_incomplete\\\":{}}\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/safe_output_handler_manager.cjs');\n await main();\n - name: Upload Safe Outputs Items\n if: always()\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}safe-outputs-items\n path: /tmp/gh-aw/safe-output-items.jsonl\n if-no-files-found: ignore\n\n" }, { "path": ".github/workflows/handle-documentation.md", "content": "---\ndescription: Handles issues classified as documentation-related by the triage classifier\nconcurrency:\n job-discriminator: ${{ inputs.issue_number }}\non:\n workflow_call:\n inputs:\n payload:\n type: string\n required: false\n issue_number:\n type: string\n required: true\n roles: all\npermissions:\n contents: read\n issues: read\n pull-requests: read\ntools:\n github:\n toolsets: [default]\n min-integrity: none\nsafe-outputs:\n add-labels:\n allowed: [documentation]\n max: 1\n target: \"*\"\n add-comment:\n max: 1\n target: \"*\"\ntimeout-minutes: 5\n---\n\n# Documentation Handler\n\nYou are an AI agent that handles issues classified as documentation-related in the copilot-sdk repository. Your job is to confirm the documentation gap, label the issue, and leave a helpful comment.\n\n## Your Task\n\n1. Fetch the full issue content (title, body, and comments) for issue #${{ inputs.issue_number }} using GitHub tools\n2. Identify the specific documentation gap or problem described in the issue\n3. Add the `documentation` label\n4. Leave a comment that includes:\n - A summary of the documentation gap (what is missing, incorrect, or unclear)\n - Which documentation pages, files, or sections are affected\n - A brief description of what content should be added or improved to resolve the issue\n" }, { "path": ".github/workflows/handle-enhancement.lock.yml", "content": "# gh-aw-metadata: {\"schema_version\":\"v3\",\"frontmatter_hash\":\"0a1cd53da97b1be36f489e58d1153583dc96c9b436fab3392437a8d498d4d8fb\",\"compiler_version\":\"v0.67.4\",\"strict\":true,\"agent_id\":\"copilot\"}\n# gh-aw-manifest: {\"version\":1,\"secrets\":[\"COPILOT_GITHUB_TOKEN\",\"GH_AW_GITHUB_MCP_SERVER_TOKEN\",\"GH_AW_GITHUB_TOKEN\",\"GITHUB_TOKEN\"],\"actions\":[{\"repo\":\"actions/checkout\",\"sha\":\"de0fac2e4500dabe0009e67214ff5f5447ce83dd\",\"version\":\"v6.0.2\"},{\"repo\":\"actions/download-artifact\",\"sha\":\"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c\",\"version\":\"v8.0.1\"},{\"repo\":\"actions/github-script\",\"sha\":\"ed597411d8f924073f98dfc5c65a23a2325f34cd\",\"version\":\"v8\"},{\"repo\":\"actions/upload-artifact\",\"sha\":\"bbbca2ddaa5d8feaa63e36b76fdaad77386f024f\",\"version\":\"v7\"},{\"repo\":\"github/gh-aw-actions/setup\",\"sha\":\"9d6ae06250fc0ec536a0e5f35de313b35bad7246\",\"version\":\"v0.67.4\"}]}\n# ___ _ _ \n# / _ \\ | | (_) \n# | |_| | __ _ ___ _ __ | |_ _ ___ \n# | _ |/ _` |/ _ \\ '_ \\| __| |/ __|\n# | | | | (_| | __/ | | | |_| | (__ \n# \\_| |_/\\__, |\\___|_| |_|\\__|_|\\___|\n# __/ |\n# _ _ |___/ \n# | | | | / _| |\n# | | | | ___ _ __ _ __| |_| | _____ ____\n# | |/\\| |/ _ \\ '__| |/ /| _| |/ _ \\ \\ /\\ / / ___|\n# \\ /\\ / (_) | | | | ( | | | | (_) \\ V V /\\__ \\\n# \\/ \\/ \\___/|_| |_|\\_\\|_| |_|\\___/ \\_/\\_/ |___/\n#\n# This file was automatically generated by gh-aw (v0.67.4). DO NOT EDIT.\n#\n# To update this file, edit the corresponding .md file and run:\n# gh aw compile\n# Not all edits will cause changes to this file.\n#\n# For more information: https://github.github.com/gh-aw/introduction/overview/\n#\n# Handles issues classified as enhancements by the triage classifier\n#\n# Secrets used:\n# - COPILOT_GITHUB_TOKEN\n# - GH_AW_GITHUB_MCP_SERVER_TOKEN\n# - GH_AW_GITHUB_TOKEN\n# - GITHUB_TOKEN\n#\n# Custom actions used:\n# - actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n# - actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n# - actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n# - actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n# - github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n\nname: \"Enhancement Handler\"\n\"on\":\n workflow_call:\n inputs:\n issue_number:\n required: true\n type: string\n payload:\n required: false\n type: string\n outputs:\n comment_id:\n description: ID of the first added comment\n value: ${{ jobs.safe_outputs.outputs.comment_id }}\n comment_url:\n description: URL of the first added comment\n value: ${{ jobs.safe_outputs.outputs.comment_url }}\n\npermissions: {}\n\nconcurrency:\n group: \"gh-aw-${{ github.workflow }}\"\n\nrun-name: \"Enhancement Handler\"\n\njobs:\n activation:\n runs-on: ubuntu-slim\n permissions:\n actions: read\n contents: read\n outputs:\n artifact_prefix: ${{ steps.artifact-prefix.outputs.prefix }}\n comment_id: \"\"\n comment_repo: \"\"\n lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }}\n model: ${{ steps.generate_aw_info.outputs.model }}\n secret_verification_result: ${{ steps.validate-secret.outputs.verification_result }}\n setup-trace-id: ${{ steps.setup.outputs.trace-id }}\n target_ref: ${{ steps.resolve-host-repo.outputs.target_ref }}\n target_repo: ${{ steps.resolve-host-repo.outputs.target_repo }}\n target_repo_name: ${{ steps.resolve-host-repo.outputs.target_repo_name }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n - name: Resolve host repo for activation checkout\n id: resolve-host-repo\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/resolve_host_repo.cjs');\n await main();\n - name: Compute artifact prefix\n id: artifact-prefix\n env:\n INPUTS_JSON: ${{ toJSON(inputs) }}\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/compute_artifact_prefix.sh\"\n - name: Generate agentic run info\n id: generate_aw_info\n env:\n GH_AW_INFO_ENGINE_ID: \"copilot\"\n GH_AW_INFO_ENGINE_NAME: \"GitHub Copilot CLI\"\n GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'auto' }}\n GH_AW_INFO_VERSION: \"1.0.20\"\n GH_AW_INFO_AGENT_VERSION: \"1.0.20\"\n GH_AW_INFO_CLI_VERSION: \"v0.67.4\"\n GH_AW_INFO_WORKFLOW_NAME: \"Enhancement Handler\"\n GH_AW_INFO_EXPERIMENTAL: \"false\"\n GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: \"true\"\n GH_AW_INFO_STAGED: \"false\"\n GH_AW_INFO_ALLOWED_DOMAINS: '[\"defaults\"]'\n GH_AW_INFO_FIREWALL_ENABLED: \"true\"\n GH_AW_INFO_AWF_VERSION: \"v0.25.18\"\n GH_AW_INFO_AWMG_VERSION: \"\"\n GH_AW_INFO_FIREWALL_TYPE: \"squid\"\n GH_AW_COMPILED_STRICT: \"true\"\n GH_AW_INFO_TARGET_REPO: ${{ steps.resolve-host-repo.outputs.target_repo }}\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs');\n await main(core, context);\n - name: Validate COPILOT_GITHUB_TOKEN secret\n id: validate-secret\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/validate_multi_secret.sh\" COPILOT_GITHUB_TOKEN 'GitHub Copilot CLI' https://github.github.com/gh-aw/reference/engines/#github-copilot-default\n env:\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n - name: Cross-repo setup guidance\n if: failure() && steps.resolve-host-repo.outputs.target_repo != github.repository\n run: |\n echo \"::error::COPILOT_GITHUB_TOKEN must be configured in the CALLER repository's secrets.\"\n echo \"::error::For cross-repo workflow_call, secrets must be set in the repository that triggers the workflow.\"\n echo \"::error::See: https://github.github.com/gh-aw/patterns/central-repo-ops/#cross-repo-setup\"\n - name: Checkout .github and .agents folders\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n repository: ${{ steps.resolve-host-repo.outputs.target_repo }}\n ref: ${{ steps.resolve-host-repo.outputs.target_ref }}\n sparse-checkout: |\n .github\n .agents\n sparse-checkout-cone-mode: true\n fetch-depth: 1\n - name: Check workflow lock file\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_WORKFLOW_FILE: \"handle-enhancement.lock.yml\"\n GH_AW_CONTEXT_WORKFLOW_REF: \"${{ github.workflow_ref }}\"\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/check_workflow_timestamp_api.cjs');\n await main();\n - name: Check compile-agentic version\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_COMPILED_VERSION: \"v0.67.4\"\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/check_version_updates.cjs');\n await main();\n - name: Create prompt with built-in context\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_SAFE_OUTPUTS: ${{ runner.temp }}/gh-aw/safeoutputs/outputs.jsonl\n GH_AW_GITHUB_ACTOR: ${{ github.actor }}\n GH_AW_GITHUB_EVENT_COMMENT_ID: ${{ github.event.comment.id }}\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: ${{ github.event.discussion.number }}\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: ${{ github.event.issue.number }}\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n GH_AW_GITHUB_RUN_ID: ${{ github.run_id }}\n GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }}\n GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }}\n # poutine:ignore untrusted_checkout_exec\n run: |\n bash \"${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh\"\n {\n cat << 'GH_AW_PROMPT_192f9f111edce454_EOF'\n \n GH_AW_PROMPT_192f9f111edce454_EOF\n cat \"${RUNNER_TEMP}/gh-aw/prompts/xpia.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/markdown.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md\"\n cat << 'GH_AW_PROMPT_192f9f111edce454_EOF'\n \n Tools: add_comment, add_labels, missing_tool, missing_data, noop\n \n \n The following GitHub context information is available for this workflow:\n {{#if __GH_AW_GITHUB_ACTOR__ }}\n - **actor**: __GH_AW_GITHUB_ACTOR__\n {{/if}}\n {{#if __GH_AW_GITHUB_REPOSITORY__ }}\n - **repository**: __GH_AW_GITHUB_REPOSITORY__\n {{/if}}\n {{#if __GH_AW_GITHUB_WORKSPACE__ }}\n - **workspace**: __GH_AW_GITHUB_WORKSPACE__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_ISSUE_NUMBER__ }}\n - **issue-number**: #__GH_AW_GITHUB_EVENT_ISSUE_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER__ }}\n - **discussion-number**: #__GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER__ }}\n - **pull-request-number**: #__GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_COMMENT_ID__ }}\n - **comment-id**: __GH_AW_GITHUB_EVENT_COMMENT_ID__\n {{/if}}\n {{#if __GH_AW_GITHUB_RUN_ID__ }}\n - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__\n {{/if}}\n \n \n GH_AW_PROMPT_192f9f111edce454_EOF\n cat \"${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md\"\n cat << 'GH_AW_PROMPT_192f9f111edce454_EOF'\n \n {{#runtime-import .github/workflows/handle-enhancement.md}}\n GH_AW_PROMPT_192f9f111edce454_EOF\n } > \"$GH_AW_PROMPT\"\n - name: Interpolate variables and render templates\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/interpolate_prompt.cjs');\n await main();\n - name: Substitute placeholders\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_GITHUB_ACTOR: ${{ github.actor }}\n GH_AW_GITHUB_EVENT_COMMENT_ID: ${{ github.event.comment.id }}\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: ${{ github.event.discussion.number }}\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: ${{ github.event.issue.number }}\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n GH_AW_GITHUB_RUN_ID: ${{ github.run_id }}\n GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }}\n GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n \n const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs');\n \n // Call the substitution function\n return await substitutePlaceholders({\n file: process.env.GH_AW_PROMPT,\n substitutions: {\n GH_AW_GITHUB_ACTOR: process.env.GH_AW_GITHUB_ACTOR,\n GH_AW_GITHUB_EVENT_COMMENT_ID: process.env.GH_AW_GITHUB_EVENT_COMMENT_ID,\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: process.env.GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER,\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: process.env.GH_AW_GITHUB_EVENT_ISSUE_NUMBER,\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: process.env.GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER,\n GH_AW_GITHUB_REPOSITORY: process.env.GH_AW_GITHUB_REPOSITORY,\n GH_AW_GITHUB_RUN_ID: process.env.GH_AW_GITHUB_RUN_ID,\n GH_AW_GITHUB_WORKSPACE: process.env.GH_AW_GITHUB_WORKSPACE,\n GH_AW_INPUTS_ISSUE_NUMBER: process.env.GH_AW_INPUTS_ISSUE_NUMBER\n }\n });\n - name: Validate prompt placeholders\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n # poutine:ignore untrusted_checkout_exec\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/validate_prompt_placeholders.sh\"\n - name: Print prompt\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n # poutine:ignore untrusted_checkout_exec\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/print_prompt_summary.sh\"\n - name: Upload activation artifact\n if: success()\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ steps.artifact-prefix.outputs.prefix }}activation\n path: |\n /tmp/gh-aw/aw_info.json\n /tmp/gh-aw/aw-prompts/prompt.txt\n /tmp/gh-aw/github_rate_limits.jsonl\n if-no-files-found: ignore\n retention-days: 1\n\n agent:\n needs: activation\n runs-on: ubuntu-latest\n permissions:\n contents: read\n issues: read\n pull-requests: read\n concurrency:\n group: \"gh-aw-copilot-${{ github.workflow }}-${{ inputs.issue_number }}\"\n env:\n DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}\n GH_AW_ASSETS_ALLOWED_EXTS: \"\"\n GH_AW_ASSETS_BRANCH: \"\"\n GH_AW_ASSETS_MAX_SIZE_KB: 0\n GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs\n GH_AW_WORKFLOW_ID_SANITIZED: handleenhancement\n outputs:\n artifact_prefix: ${{ needs.activation.outputs.artifact_prefix }}\n checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }}\n effective_tokens: ${{ steps.parse-mcp-gateway.outputs.effective_tokens }}\n has_patch: ${{ steps.collect_output.outputs.has_patch }}\n inference_access_error: ${{ steps.detect-inference-error.outputs.inference_access_error || 'false' }}\n model: ${{ needs.activation.outputs.model }}\n output: ${{ steps.collect_output.outputs.output }}\n output_types: ${{ steps.collect_output.outputs.output_types }}\n setup-trace-id: ${{ steps.setup.outputs.trace-id }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Set runtime paths\n id: set-runtime-paths\n run: |\n echo \"GH_AW_SAFE_OUTPUTS=${RUNNER_TEMP}/gh-aw/safeoutputs/outputs.jsonl\" >> \"$GITHUB_OUTPUT\"\n echo \"GH_AW_SAFE_OUTPUTS_CONFIG_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/config.json\" >> \"$GITHUB_OUTPUT\"\n echo \"GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json\" >> \"$GITHUB_OUTPUT\"\n - name: Checkout repository\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n - name: Create gh-aw temp directory\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/create_gh_aw_tmp_dir.sh\"\n - name: Configure gh CLI for GitHub Enterprise\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh\"\n env:\n GH_TOKEN: ${{ github.token }}\n - name: Configure Git credentials\n env:\n REPO_NAME: ${{ github.repository }}\n SERVER_URL: ${{ github.server_url }}\n GITHUB_TOKEN: ${{ github.token }}\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git config --global am.keepcr true\n # Re-authenticate git with GitHub token\n SERVER_URL_STRIPPED=\"${SERVER_URL#https://}\"\n git remote set-url origin \"https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git\"\n echo \"Git configured with standard GitHub Actions identity\"\n - name: Checkout PR branch\n id: checkout-pr\n if: |\n github.event.pull_request || github.event.issue.pull_request\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs');\n await main();\n - name: Install GitHub Copilot CLI\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh\" 1.0.20\n env:\n GH_HOST: github.com\n - name: Install AWF binary\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh\" v0.25.18\n - name: Parse integrity filter lists\n id: parse-guard-vars\n env:\n GH_AW_BLOCKED_USERS_VAR: ${{ vars.GH_AW_GITHUB_BLOCKED_USERS || '' }}\n GH_AW_TRUSTED_USERS_VAR: ${{ vars.GH_AW_GITHUB_TRUSTED_USERS || '' }}\n GH_AW_APPROVAL_LABELS_VAR: ${{ vars.GH_AW_GITHUB_APPROVAL_LABELS || '' }}\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/parse_guard_list.sh\"\n - name: Download container images\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh\" ghcr.io/github/gh-aw-firewall/agent:0.25.18 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.18 ghcr.io/github/gh-aw-firewall/squid:0.25.18 ghcr.io/github/gh-aw-mcpg:v0.2.17 ghcr.io/github/github-mcp-server:v0.32.0 node:lts-alpine\n - name: Write Safe Outputs Config\n run: |\n mkdir -p \"${RUNNER_TEMP}/gh-aw/safeoutputs\"\n mkdir -p /tmp/gh-aw/safeoutputs\n mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs\n cat > \"${RUNNER_TEMP}/gh-aw/safeoutputs/config.json\" << 'GH_AW_SAFE_OUTPUTS_CONFIG_7a0b9826ce5c2de6_EOF'\n {\"add_comment\":{\"max\":1,\"target\":\"*\"},\"add_labels\":{\"allowed\":[\"enhancement\"],\"max\":1,\"target\":\"*\"},\"create_report_incomplete_issue\":{},\"missing_data\":{},\"missing_tool\":{},\"noop\":{\"max\":1,\"report-as-issue\":\"true\"},\"report_incomplete\":{}}\n GH_AW_SAFE_OUTPUTS_CONFIG_7a0b9826ce5c2de6_EOF\n - name: Write Safe Outputs Tools\n env:\n GH_AW_TOOLS_META_JSON: |\n {\n \"description_suffixes\": {\n \"add_comment\": \" CONSTRAINTS: Maximum 1 comment(s) can be added. Target: *.\",\n \"add_labels\": \" CONSTRAINTS: Maximum 1 label(s) can be added. Only these labels are allowed: [\\\"enhancement\\\"]. Target: *.\"\n },\n \"repo_params\": {},\n \"dynamic_tools\": []\n }\n GH_AW_VALIDATION_JSON: |\n {\n \"add_comment\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"body\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"item_number\": {\n \"issueOrPRNumber\": true\n },\n \"repo\": {\n \"type\": \"string\",\n \"maxLength\": 256\n }\n }\n },\n \"add_labels\": {\n \"defaultMax\": 5,\n \"fields\": {\n \"item_number\": {\n \"issueNumberOrTemporaryId\": true\n },\n \"labels\": {\n \"required\": true,\n \"type\": \"array\",\n \"itemType\": \"string\",\n \"itemSanitize\": true,\n \"itemMaxLength\": 128\n },\n \"repo\": {\n \"type\": \"string\",\n \"maxLength\": 256\n }\n }\n },\n \"missing_data\": {\n \"defaultMax\": 20,\n \"fields\": {\n \"alternatives\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"context\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"data_type\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n },\n \"reason\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n }\n }\n },\n \"missing_tool\": {\n \"defaultMax\": 20,\n \"fields\": {\n \"alternatives\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 512\n },\n \"reason\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"tool\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n }\n }\n },\n \"noop\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"message\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n }\n }\n },\n \"report_incomplete\": {\n \"defaultMax\": 5,\n \"fields\": {\n \"details\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"reason\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 1024\n }\n }\n }\n }\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_safe_outputs_tools.cjs');\n await main();\n - name: Generate Safe Outputs MCP Server Config\n id: safe-outputs-config\n run: |\n # Generate a secure random API key (360 bits of entropy, 40+ chars)\n # Mask immediately to prevent timing vulnerabilities\n API_KEY=$(openssl rand -base64 45 | tr -d '/+=')\n echo \"::add-mask::${API_KEY}\"\n \n PORT=3001\n \n # Set outputs for next steps\n {\n echo \"safe_outputs_api_key=${API_KEY}\"\n echo \"safe_outputs_port=${PORT}\"\n } >> \"$GITHUB_OUTPUT\"\n \n echo \"Safe Outputs MCP server will run on port ${PORT}\"\n \n - name: Start Safe Outputs MCP HTTP Server\n id: safe-outputs-start\n env:\n DEBUG: '*'\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-config.outputs.safe_outputs_port }}\n GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-config.outputs.safe_outputs_api_key }}\n GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/tools.json\n GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/config.json\n GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs\n run: |\n # Environment variables are set above to prevent template injection\n export DEBUG\n export GH_AW_SAFE_OUTPUTS\n export GH_AW_SAFE_OUTPUTS_PORT\n export GH_AW_SAFE_OUTPUTS_API_KEY\n export GH_AW_SAFE_OUTPUTS_TOOLS_PATH\n export GH_AW_SAFE_OUTPUTS_CONFIG_PATH\n export GH_AW_MCP_LOG_DIR\n \n bash \"${RUNNER_TEMP}/gh-aw/actions/start_safe_outputs_server.sh\"\n \n - name: Start MCP Gateway\n id: start-mcp-gateway\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-start.outputs.api_key }}\n GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-start.outputs.port }}\n GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n run: |\n set -eo pipefail\n mkdir -p /tmp/gh-aw/mcp-config\n \n # Export gateway environment variables for MCP config and gateway script\n export MCP_GATEWAY_PORT=\"80\"\n export MCP_GATEWAY_DOMAIN=\"host.docker.internal\"\n MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=')\n echo \"::add-mask::${MCP_GATEWAY_API_KEY}\"\n export MCP_GATEWAY_API_KEY\n export MCP_GATEWAY_PAYLOAD_DIR=\"/tmp/gh-aw/mcp-payloads\"\n mkdir -p \"${MCP_GATEWAY_PAYLOAD_DIR}\"\n export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD=\"524288\"\n export DEBUG=\"*\"\n \n export GH_AW_ENGINE=\"copilot\"\n export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host -v /var/run/docker.sock:/var/run/docker.sock -e MCP_GATEWAY_PORT -e MCP_GATEWAY_DOMAIN -e MCP_GATEWAY_API_KEY -e MCP_GATEWAY_PAYLOAD_DIR -e MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD -e DEBUG -e MCP_GATEWAY_LOG_DIR -e GH_AW_MCP_LOG_DIR -e GH_AW_SAFE_OUTPUTS -e GH_AW_SAFE_OUTPUTS_CONFIG_PATH -e GH_AW_SAFE_OUTPUTS_TOOLS_PATH -e GH_AW_ASSETS_BRANCH -e GH_AW_ASSETS_MAX_SIZE_KB -e GH_AW_ASSETS_ALLOWED_EXTS -e DEFAULT_BRANCH -e GITHUB_MCP_SERVER_TOKEN -e GITHUB_MCP_GUARD_MIN_INTEGRITY -e GITHUB_MCP_GUARD_REPOS -e GITHUB_REPOSITORY -e GITHUB_SERVER_URL -e GITHUB_SHA -e GITHUB_WORKSPACE -e GITHUB_TOKEN -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RUN_ATTEMPT -e GITHUB_JOB -e GITHUB_ACTION -e GITHUB_EVENT_NAME -e GITHUB_EVENT_PATH -e GITHUB_ACTOR -e GITHUB_ACTOR_ID -e GITHUB_TRIGGERING_ACTOR -e GITHUB_WORKFLOW -e GITHUB_WORKFLOW_REF -e GITHUB_WORKFLOW_SHA -e GITHUB_REF -e GITHUB_REF_NAME -e GITHUB_REF_TYPE -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GH_AW_SAFE_OUTPUTS_PORT -e GH_AW_SAFE_OUTPUTS_API_KEY -v /tmp/gh-aw/mcp-payloads:/tmp/gh-aw/mcp-payloads:rw -v /opt:/opt:ro -v /tmp:/tmp:rw -v '\"${GITHUB_WORKSPACE}\"':'\"${GITHUB_WORKSPACE}\"':rw ghcr.io/github/gh-aw-mcpg:v0.2.17'\n \n mkdir -p /home/runner/.copilot\n cat << GH_AW_MCP_CONFIG_fc710c56a8354bbf_EOF | bash \"${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.sh\"\n {\n \"mcpServers\": {\n \"github\": {\n \"type\": \"stdio\",\n \"container\": \"ghcr.io/github/github-mcp-server:v0.32.0\",\n \"env\": {\n \"GITHUB_HOST\": \"\\${GITHUB_SERVER_URL}\",\n \"GITHUB_PERSONAL_ACCESS_TOKEN\": \"\\${GITHUB_MCP_SERVER_TOKEN}\",\n \"GITHUB_READ_ONLY\": \"1\",\n \"GITHUB_TOOLSETS\": \"context,repos,issues,pull_requests\"\n },\n \"guard-policies\": {\n \"allow-only\": {\n \"approval-labels\": ${{ steps.parse-guard-vars.outputs.approval_labels }},\n \"blocked-users\": ${{ steps.parse-guard-vars.outputs.blocked_users }},\n \"min-integrity\": \"none\",\n \"repos\": \"all\",\n \"trusted-users\": ${{ steps.parse-guard-vars.outputs.trusted_users }}\n }\n }\n },\n \"safeoutputs\": {\n \"type\": \"http\",\n \"url\": \"http://host.docker.internal:$GH_AW_SAFE_OUTPUTS_PORT\",\n \"headers\": {\n \"Authorization\": \"\\${GH_AW_SAFE_OUTPUTS_API_KEY}\"\n },\n \"guard-policies\": {\n \"write-sink\": {\n \"accept\": [\n \"*\"\n ]\n }\n }\n }\n },\n \"gateway\": {\n \"port\": $MCP_GATEWAY_PORT,\n \"domain\": \"${MCP_GATEWAY_DOMAIN}\",\n \"apiKey\": \"${MCP_GATEWAY_API_KEY}\",\n \"payloadDir\": \"${MCP_GATEWAY_PAYLOAD_DIR}\"\n }\n }\n GH_AW_MCP_CONFIG_fc710c56a8354bbf_EOF\n - name: Download activation artifact\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}activation\n path: /tmp/gh-aw\n - name: Clean git credentials\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/clean_git_credentials.sh\"\n - name: Execute GitHub Copilot CLI\n id: agentic_execution\n # Copilot CLI tool arguments (sorted):\n timeout-minutes: 5\n run: |\n set -o pipefail\n touch /tmp/gh-aw/agent-step-summary.md\n # shellcheck disable=SC1003\n sudo -E awf --container-workdir \"${GITHUB_WORKSPACE}\" --mount \"${RUNNER_TEMP}/gh-aw:${RUNNER_TEMP}/gh-aw:ro\" --mount \"${RUNNER_TEMP}/gh-aw:/host${RUNNER_TEMP}/gh-aw:ro\" --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --allow-domains api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --image-tag 0.25.18 --skip-pull --enable-api-proxy \\\n -- /bin/bash -c 'node ${RUNNER_TEMP}/gh-aw/actions/copilot_driver.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --allow-all-tools --allow-all-paths --add-dir \"${GITHUB_WORKSPACE}\" --prompt \"$(cat /tmp/gh-aw/aw-prompts/prompt.txt)\"' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log\n env:\n COPILOT_AGENT_RUNNER_TYPE: STANDALONE\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || '' }}\n GH_AW_MCP_CONFIG: /home/runner/.copilot/mcp-config.json\n GH_AW_PHASE: agent\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_VERSION: v0.67.4\n GITHUB_API_URL: ${{ github.api_url }}\n GITHUB_AW: true\n GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows\n GITHUB_HEAD_REF: ${{ github.head_ref }}\n GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n GITHUB_REF_NAME: ${{ github.ref_name }}\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md\n GITHUB_WORKSPACE: ${{ github.workspace }}\n GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_AUTHOR_NAME: github-actions[bot]\n GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_COMMITTER_NAME: github-actions[bot]\n XDG_CONFIG_HOME: /home/runner\n - name: Detect inference access error\n id: detect-inference-error\n if: always()\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/detect_inference_access_error.sh\"\n - name: Configure Git credentials\n env:\n REPO_NAME: ${{ github.repository }}\n SERVER_URL: ${{ github.server_url }}\n GITHUB_TOKEN: ${{ github.token }}\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git config --global am.keepcr true\n # Re-authenticate git with GitHub token\n SERVER_URL_STRIPPED=\"${SERVER_URL#https://}\"\n git remote set-url origin \"https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git\"\n echo \"Git configured with standard GitHub Actions identity\"\n - name: Copy Copilot session state files to logs\n if: always()\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/copy_copilot_session_state.sh\"\n - name: Stop MCP Gateway\n if: always()\n continue-on-error: true\n env:\n MCP_GATEWAY_PORT: ${{ steps.start-mcp-gateway.outputs.gateway-port }}\n MCP_GATEWAY_API_KEY: ${{ steps.start-mcp-gateway.outputs.gateway-api-key }}\n GATEWAY_PID: ${{ steps.start-mcp-gateway.outputs.gateway-pid }}\n run: |\n bash \"${RUNNER_TEMP}/gh-aw/actions/stop_mcp_gateway.sh\" \"$GATEWAY_PID\"\n - name: Redact secrets in logs\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs');\n await main();\n env:\n GH_AW_SECRET_NAMES: 'COPILOT_GITHUB_TOKEN,GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN'\n SECRET_COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }}\n SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }}\n SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n - name: Append agent step summary\n if: always()\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/append_agent_step_summary.sh\"\n - name: Copy Safe Outputs\n if: always()\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n run: |\n mkdir -p /tmp/gh-aw\n cp \"$GH_AW_SAFE_OUTPUTS\" /tmp/gh-aw/safeoutputs.jsonl 2>/dev/null || true\n - name: Ingest agent output\n id: collect_output\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_ALLOWED_DOMAINS: \"api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com\"\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_API_URL: ${{ github.api_url }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/collect_ndjson_output.cjs');\n await main();\n - name: Parse agent logs for step summary\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_copilot_log.cjs');\n await main();\n - name: Parse MCP Gateway logs for step summary\n if: always()\n id: parse-mcp-gateway\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_mcp_gateway_log.cjs');\n await main();\n - name: Print firewall logs\n if: always()\n continue-on-error: true\n env:\n AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs\n run: |\n # Fix permissions on firewall logs so they can be uploaded as artifacts\n # AWF runs with sudo, creating files owned by root\n sudo chmod -R a+r /tmp/gh-aw/sandbox/firewall/logs 2>/dev/null || true\n # Only run awf logs summary if awf command exists (it may not be installed if workflow failed before install step)\n if command -v awf &> /dev/null; then\n awf logs summary | tee -a \"$GITHUB_STEP_SUMMARY\"\n else\n echo 'AWF binary not installed, skipping firewall log summary'\n fi\n - name: Parse token usage for step summary\n if: always()\n continue-on-error: true\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs');\n await main();\n - name: Write agent output placeholder if missing\n if: always()\n run: |\n if [ ! -f /tmp/gh-aw/agent_output.json ]; then\n echo '{\"items\":[]}' > /tmp/gh-aw/agent_output.json\n fi\n - name: Upload agent artifacts\n if: always()\n continue-on-error: true\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}agent\n path: |\n /tmp/gh-aw/aw-prompts/prompt.txt\n /tmp/gh-aw/sandbox/agent/logs/\n /tmp/gh-aw/redacted-urls.log\n /tmp/gh-aw/mcp-logs/\n /tmp/gh-aw/proxy-logs/\n !/tmp/gh-aw/proxy-logs/proxy-tls/\n /tmp/gh-aw/agent_usage.json\n /tmp/gh-aw/agent-stdio.log\n /tmp/gh-aw/agent/\n /tmp/gh-aw/github_rate_limits.jsonl\n /tmp/gh-aw/safeoutputs.jsonl\n /tmp/gh-aw/agent_output.json\n /tmp/gh-aw/aw-*.patch\n /tmp/gh-aw/aw-*.bundle\n if-no-files-found: ignore\n - name: Upload firewall audit logs\n if: always()\n continue-on-error: true\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}firewall-audit-logs\n path: |\n /tmp/gh-aw/sandbox/firewall/logs/\n /tmp/gh-aw/sandbox/firewall/audit/\n if-no-files-found: ignore\n\n conclusion:\n needs:\n - activation\n - agent\n - detection\n - safe_outputs\n if: always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true')\n runs-on: ubuntu-slim\n permissions:\n contents: read\n discussions: write\n issues: write\n pull-requests: write\n concurrency:\n group: \"gh-aw-conclusion-handle-enhancement-${{ inputs.issue_number }}\"\n cancel-in-progress: false\n outputs:\n incomplete_count: ${{ steps.report_incomplete.outputs.incomplete_count }}\n noop_message: ${{ steps.noop.outputs.noop_message }}\n tools_reported: ${{ steps.missing_tool.outputs.tools_reported }}\n total_count: ${{ steps.missing_tool.outputs.total_count }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Process No-Op Messages\n id: noop\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_NOOP_MAX: \"1\"\n GH_AW_WORKFLOW_NAME: \"Enhancement Handler\"\n GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\n GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }}\n GH_AW_NOOP_REPORT_AS_ISSUE: \"true\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_noop_message.cjs');\n await main();\n - name: Record missing tool\n id: missing_tool\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_MISSING_TOOL_CREATE_ISSUE: \"true\"\n GH_AW_WORKFLOW_NAME: \"Enhancement Handler\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/missing_tool.cjs');\n await main();\n - name: Record incomplete\n id: report_incomplete\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_REPORT_INCOMPLETE_CREATE_ISSUE: \"true\"\n GH_AW_WORKFLOW_NAME: \"Enhancement Handler\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/report_incomplete_handler.cjs');\n await main();\n - name: Handle agent failure\n id: handle_agent_failure\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_WORKFLOW_NAME: \"Enhancement Handler\"\n GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\n GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }}\n GH_AW_WORKFLOW_ID: \"handle-enhancement\"\n GH_AW_ENGINE_ID: \"copilot\"\n GH_AW_SECRET_VERIFICATION_RESULT: ${{ needs.activation.outputs.secret_verification_result }}\n GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }}\n GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }}\n GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }}\n GH_AW_GROUP_REPORTS: \"false\"\n GH_AW_FAILURE_REPORT_AS_ISSUE: \"true\"\n GH_AW_TIMEOUT_MINUTES: \"5\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_agent_failure.cjs');\n await main();\n\n detection:\n needs:\n - activation\n - agent\n if: >\n always() && needs.agent.result != 'skipped' && (needs.agent.outputs.output_types != '' || needs.agent.outputs.has_patch == 'true')\n runs-on: ubuntu-latest\n permissions:\n contents: read\n outputs:\n detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }}\n detection_success: ${{ steps.detection_conclusion.outputs.success }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: ${{ needs.agent.outputs.artifact_prefix }}agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Checkout repository for patch context\n if: needs.agent.outputs.has_patch == 'true'\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n # --- Threat Detection ---\n - name: Download container images\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh\" ghcr.io/github/gh-aw-firewall/agent:0.25.18 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.18 ghcr.io/github/gh-aw-firewall/squid:0.25.18\n - name: Check if detection needed\n id: detection_guard\n if: always()\n env:\n OUTPUT_TYPES: ${{ needs.agent.outputs.output_types }}\n HAS_PATCH: ${{ needs.agent.outputs.has_patch }}\n run: |\n if [[ -n \"$OUTPUT_TYPES\" || \"$HAS_PATCH\" == \"true\" ]]; then\n echo \"run_detection=true\" >> \"$GITHUB_OUTPUT\"\n echo \"Detection will run: output_types=$OUTPUT_TYPES, has_patch=$HAS_PATCH\"\n else\n echo \"run_detection=false\" >> \"$GITHUB_OUTPUT\"\n echo \"Detection skipped: no agent outputs or patches to analyze\"\n fi\n - name: Clear MCP configuration for detection\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n rm -f /tmp/gh-aw/mcp-config/mcp-servers.json\n rm -f /home/runner/.copilot/mcp-config.json\n rm -f \"$GITHUB_WORKSPACE/.gemini/settings.json\"\n - name: Prepare threat detection files\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n mkdir -p /tmp/gh-aw/threat-detection/aw-prompts\n cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true\n cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true\n for f in /tmp/gh-aw/aw-*.patch; do\n [ -f \"$f\" ] && cp \"$f\" /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n done\n for f in /tmp/gh-aw/aw-*.bundle; do\n [ -f \"$f\" ] && cp \"$f\" /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n done\n echo \"Prepared threat detection files:\"\n ls -la /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n - name: Setup threat detection\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n WORKFLOW_NAME: \"Enhancement Handler\"\n WORKFLOW_DESCRIPTION: \"Handles issues classified as enhancements by the triage classifier\"\n HAS_PATCH: ${{ needs.agent.outputs.has_patch }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/setup_threat_detection.cjs');\n await main();\n - name: Ensure threat-detection directory and log\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n mkdir -p /tmp/gh-aw/threat-detection\n touch /tmp/gh-aw/threat-detection/detection.log\n - name: Install GitHub Copilot CLI\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh\" 1.0.20\n env:\n GH_HOST: github.com\n - name: Install AWF binary\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh\" v0.25.18\n - name: Execute GitHub Copilot CLI\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n id: detection_agentic_execution\n # Copilot CLI tool arguments (sorted):\n timeout-minutes: 20\n run: |\n set -o pipefail\n touch /tmp/gh-aw/agent-step-summary.md\n # shellcheck disable=SC1003\n sudo -E awf --container-workdir \"${GITHUB_WORKSPACE}\" --mount \"${RUNNER_TEMP}/gh-aw:${RUNNER_TEMP}/gh-aw:ro\" --mount \"${RUNNER_TEMP}/gh-aw:/host${RUNNER_TEMP}/gh-aw:ro\" --env-all --exclude-env COPILOT_GITHUB_TOKEN --allow-domains api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,github.com,host.docker.internal,telemetry.enterprise.githubcopilot.com --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --image-tag 0.25.18 --skip-pull --enable-api-proxy \\\n -- /bin/bash -c 'node ${RUNNER_TEMP}/gh-aw/actions/copilot_driver.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --allow-all-tools --add-dir \"${GITHUB_WORKSPACE}\" --prompt \"$(cat /tmp/gh-aw/aw-prompts/prompt.txt)\"' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log\n env:\n COPILOT_AGENT_RUNNER_TYPE: STANDALONE\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || '' }}\n GH_AW_PHASE: detection\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_VERSION: v0.67.4\n GITHUB_API_URL: ${{ github.api_url }}\n GITHUB_AW: true\n GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows\n GITHUB_HEAD_REF: ${{ github.head_ref }}\n GITHUB_REF_NAME: ${{ github.ref_name }}\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md\n GITHUB_WORKSPACE: ${{ github.workspace }}\n GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_AUTHOR_NAME: github-actions[bot]\n GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_COMMITTER_NAME: github-actions[bot]\n XDG_CONFIG_HOME: /home/runner\n - name: Upload threat detection log\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ needs.agent.outputs.artifact_prefix }}detection\n path: /tmp/gh-aw/threat-detection/detection.log\n if-no-files-found: ignore\n - name: Parse and conclude threat detection\n id: detection_conclusion\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n RUN_DETECTION: ${{ steps.detection_guard.outputs.run_detection }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_threat_detection_results.cjs');\n await main();\n\n safe_outputs:\n needs:\n - activation\n - agent\n - detection\n if: (!cancelled()) && needs.agent.result != 'skipped' && needs.detection.result == 'success'\n runs-on: ubuntu-slim\n permissions:\n contents: read\n discussions: write\n issues: write\n pull-requests: write\n timeout-minutes: 15\n env:\n GH_AW_CALLER_WORKFLOW_ID: \"${{ github.repository }}/handle-enhancement\"\n GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens }}\n GH_AW_ENGINE_ID: \"copilot\"\n GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }}\n GH_AW_WORKFLOW_ID: \"handle-enhancement\"\n GH_AW_WORKFLOW_NAME: \"Enhancement Handler\"\n outputs:\n code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }}\n code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }}\n comment_id: ${{ steps.process_safe_outputs.outputs.comment_id }}\n comment_url: ${{ steps.process_safe_outputs.outputs.comment_url }}\n create_discussion_error_count: ${{ steps.process_safe_outputs.outputs.create_discussion_error_count }}\n create_discussion_errors: ${{ steps.process_safe_outputs.outputs.create_discussion_errors }}\n process_safe_outputs_processed_count: ${{ steps.process_safe_outputs.outputs.processed_count }}\n process_safe_outputs_temporary_id_map: ${{ steps.process_safe_outputs.outputs.temporary_id_map }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Configure GH_HOST for enterprise compatibility\n id: ghes-host-config\n shell: bash\n run: |\n # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct\n # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op.\n GH_HOST=\"${GITHUB_SERVER_URL#https://}\"\n GH_HOST=\"${GH_HOST#http://}\"\n echo \"GH_HOST=${GH_HOST}\" >> \"$GITHUB_ENV\"\n - name: Process Safe Outputs\n id: process_safe_outputs\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_ALLOWED_DOMAINS: \"api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com\"\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_API_URL: ${{ github.api_url }}\n GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: \"{\\\"add_comment\\\":{\\\"max\\\":1,\\\"target\\\":\\\"*\\\"},\\\"add_labels\\\":{\\\"allowed\\\":[\\\"enhancement\\\"],\\\"max\\\":1,\\\"target\\\":\\\"*\\\"},\\\"create_report_incomplete_issue\\\":{},\\\"missing_data\\\":{},\\\"missing_tool\\\":{},\\\"noop\\\":{\\\"max\\\":1,\\\"report-as-issue\\\":\\\"true\\\"},\\\"report_incomplete\\\":{}}\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/safe_output_handler_manager.cjs');\n await main();\n - name: Upload Safe Outputs Items\n if: always()\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}safe-outputs-items\n path: /tmp/gh-aw/safe-output-items.jsonl\n if-no-files-found: ignore\n\n" }, { "path": ".github/workflows/handle-enhancement.md", "content": "---\ndescription: Handles issues classified as enhancements by the triage classifier\nconcurrency:\n job-discriminator: ${{ inputs.issue_number }}\non:\n workflow_call:\n inputs:\n payload:\n type: string\n required: false\n issue_number:\n type: string\n required: true\n roles: all\npermissions:\n contents: read\n issues: read\n pull-requests: read\ntools:\n github:\n toolsets: [default]\n min-integrity: none\nsafe-outputs:\n add-labels:\n allowed: [enhancement]\n max: 1\n target: \"*\"\n add-comment:\n max: 1\n target: \"*\"\ntimeout-minutes: 5\n---\n\n# Enhancement Handler\n\nAdd the `enhancement` label to issue #${{ inputs.issue_number }}.\n" }, { "path": ".github/workflows/handle-question.lock.yml", "content": "# gh-aw-metadata: {\"schema_version\":\"v3\",\"frontmatter_hash\":\"fb6cc48845814496ea0da474d3030f9e02e7d38b5bb346b70ca525c06c271cb1\",\"compiler_version\":\"v0.67.4\",\"strict\":true,\"agent_id\":\"copilot\"}\n# gh-aw-manifest: {\"version\":1,\"secrets\":[\"COPILOT_GITHUB_TOKEN\",\"GH_AW_GITHUB_MCP_SERVER_TOKEN\",\"GH_AW_GITHUB_TOKEN\",\"GITHUB_TOKEN\"],\"actions\":[{\"repo\":\"actions/checkout\",\"sha\":\"de0fac2e4500dabe0009e67214ff5f5447ce83dd\",\"version\":\"v6.0.2\"},{\"repo\":\"actions/download-artifact\",\"sha\":\"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c\",\"version\":\"v8.0.1\"},{\"repo\":\"actions/github-script\",\"sha\":\"ed597411d8f924073f98dfc5c65a23a2325f34cd\",\"version\":\"v8\"},{\"repo\":\"actions/upload-artifact\",\"sha\":\"bbbca2ddaa5d8feaa63e36b76fdaad77386f024f\",\"version\":\"v7\"},{\"repo\":\"github/gh-aw-actions/setup\",\"sha\":\"9d6ae06250fc0ec536a0e5f35de313b35bad7246\",\"version\":\"v0.67.4\"}]}\n# ___ _ _ \n# / _ \\ | | (_) \n# | |_| | __ _ ___ _ __ | |_ _ ___ \n# | _ |/ _` |/ _ \\ '_ \\| __| |/ __|\n# | | | | (_| | __/ | | | |_| | (__ \n# \\_| |_/\\__, |\\___|_| |_|\\__|_|\\___|\n# __/ |\n# _ _ |___/ \n# | | | | / _| |\n# | | | | ___ _ __ _ __| |_| | _____ ____\n# | |/\\| |/ _ \\ '__| |/ /| _| |/ _ \\ \\ /\\ / / ___|\n# \\ /\\ / (_) | | | | ( | | | | (_) \\ V V /\\__ \\\n# \\/ \\/ \\___/|_| |_|\\_\\|_| |_|\\___/ \\_/\\_/ |___/\n#\n# This file was automatically generated by gh-aw (v0.67.4). DO NOT EDIT.\n#\n# To update this file, edit the corresponding .md file and run:\n# gh aw compile\n# Not all edits will cause changes to this file.\n#\n# For more information: https://github.github.com/gh-aw/introduction/overview/\n#\n# Handles issues classified as questions by the triage classifier\n#\n# Secrets used:\n# - COPILOT_GITHUB_TOKEN\n# - GH_AW_GITHUB_MCP_SERVER_TOKEN\n# - GH_AW_GITHUB_TOKEN\n# - GITHUB_TOKEN\n#\n# Custom actions used:\n# - actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n# - actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n# - actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n# - actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n# - github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n\nname: \"Question Handler\"\n\"on\":\n workflow_call:\n inputs:\n issue_number:\n required: true\n type: string\n payload:\n required: false\n type: string\n outputs:\n comment_id:\n description: ID of the first added comment\n value: ${{ jobs.safe_outputs.outputs.comment_id }}\n comment_url:\n description: URL of the first added comment\n value: ${{ jobs.safe_outputs.outputs.comment_url }}\n\npermissions: {}\n\nconcurrency:\n group: \"gh-aw-${{ github.workflow }}\"\n\nrun-name: \"Question Handler\"\n\njobs:\n activation:\n runs-on: ubuntu-slim\n permissions:\n actions: read\n contents: read\n outputs:\n artifact_prefix: ${{ steps.artifact-prefix.outputs.prefix }}\n comment_id: \"\"\n comment_repo: \"\"\n lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }}\n model: ${{ steps.generate_aw_info.outputs.model }}\n secret_verification_result: ${{ steps.validate-secret.outputs.verification_result }}\n setup-trace-id: ${{ steps.setup.outputs.trace-id }}\n target_ref: ${{ steps.resolve-host-repo.outputs.target_ref }}\n target_repo: ${{ steps.resolve-host-repo.outputs.target_repo }}\n target_repo_name: ${{ steps.resolve-host-repo.outputs.target_repo_name }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n - name: Resolve host repo for activation checkout\n id: resolve-host-repo\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/resolve_host_repo.cjs');\n await main();\n - name: Compute artifact prefix\n id: artifact-prefix\n env:\n INPUTS_JSON: ${{ toJSON(inputs) }}\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/compute_artifact_prefix.sh\"\n - name: Generate agentic run info\n id: generate_aw_info\n env:\n GH_AW_INFO_ENGINE_ID: \"copilot\"\n GH_AW_INFO_ENGINE_NAME: \"GitHub Copilot CLI\"\n GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'auto' }}\n GH_AW_INFO_VERSION: \"1.0.20\"\n GH_AW_INFO_AGENT_VERSION: \"1.0.20\"\n GH_AW_INFO_CLI_VERSION: \"v0.67.4\"\n GH_AW_INFO_WORKFLOW_NAME: \"Question Handler\"\n GH_AW_INFO_EXPERIMENTAL: \"false\"\n GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: \"true\"\n GH_AW_INFO_STAGED: \"false\"\n GH_AW_INFO_ALLOWED_DOMAINS: '[\"defaults\"]'\n GH_AW_INFO_FIREWALL_ENABLED: \"true\"\n GH_AW_INFO_AWF_VERSION: \"v0.25.18\"\n GH_AW_INFO_AWMG_VERSION: \"\"\n GH_AW_INFO_FIREWALL_TYPE: \"squid\"\n GH_AW_COMPILED_STRICT: \"true\"\n GH_AW_INFO_TARGET_REPO: ${{ steps.resolve-host-repo.outputs.target_repo }}\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs');\n await main(core, context);\n - name: Validate COPILOT_GITHUB_TOKEN secret\n id: validate-secret\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/validate_multi_secret.sh\" COPILOT_GITHUB_TOKEN 'GitHub Copilot CLI' https://github.github.com/gh-aw/reference/engines/#github-copilot-default\n env:\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n - name: Cross-repo setup guidance\n if: failure() && steps.resolve-host-repo.outputs.target_repo != github.repository\n run: |\n echo \"::error::COPILOT_GITHUB_TOKEN must be configured in the CALLER repository's secrets.\"\n echo \"::error::For cross-repo workflow_call, secrets must be set in the repository that triggers the workflow.\"\n echo \"::error::See: https://github.github.com/gh-aw/patterns/central-repo-ops/#cross-repo-setup\"\n - name: Checkout .github and .agents folders\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n repository: ${{ steps.resolve-host-repo.outputs.target_repo }}\n ref: ${{ steps.resolve-host-repo.outputs.target_ref }}\n sparse-checkout: |\n .github\n .agents\n sparse-checkout-cone-mode: true\n fetch-depth: 1\n - name: Check workflow lock file\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_WORKFLOW_FILE: \"handle-question.lock.yml\"\n GH_AW_CONTEXT_WORKFLOW_REF: \"${{ github.workflow_ref }}\"\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/check_workflow_timestamp_api.cjs');\n await main();\n - name: Check compile-agentic version\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_COMPILED_VERSION: \"v0.67.4\"\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/check_version_updates.cjs');\n await main();\n - name: Create prompt with built-in context\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_SAFE_OUTPUTS: ${{ runner.temp }}/gh-aw/safeoutputs/outputs.jsonl\n GH_AW_GITHUB_ACTOR: ${{ github.actor }}\n GH_AW_GITHUB_EVENT_COMMENT_ID: ${{ github.event.comment.id }}\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: ${{ github.event.discussion.number }}\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: ${{ github.event.issue.number }}\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n GH_AW_GITHUB_RUN_ID: ${{ github.run_id }}\n GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }}\n GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }}\n # poutine:ignore untrusted_checkout_exec\n run: |\n bash \"${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh\"\n {\n cat << 'GH_AW_PROMPT_0e4131663d1691aa_EOF'\n \n GH_AW_PROMPT_0e4131663d1691aa_EOF\n cat \"${RUNNER_TEMP}/gh-aw/prompts/xpia.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/markdown.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md\"\n cat << 'GH_AW_PROMPT_0e4131663d1691aa_EOF'\n \n Tools: add_comment, add_labels, missing_tool, missing_data, noop\n \n \n The following GitHub context information is available for this workflow:\n {{#if __GH_AW_GITHUB_ACTOR__ }}\n - **actor**: __GH_AW_GITHUB_ACTOR__\n {{/if}}\n {{#if __GH_AW_GITHUB_REPOSITORY__ }}\n - **repository**: __GH_AW_GITHUB_REPOSITORY__\n {{/if}}\n {{#if __GH_AW_GITHUB_WORKSPACE__ }}\n - **workspace**: __GH_AW_GITHUB_WORKSPACE__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_ISSUE_NUMBER__ }}\n - **issue-number**: #__GH_AW_GITHUB_EVENT_ISSUE_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER__ }}\n - **discussion-number**: #__GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER__ }}\n - **pull-request-number**: #__GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_COMMENT_ID__ }}\n - **comment-id**: __GH_AW_GITHUB_EVENT_COMMENT_ID__\n {{/if}}\n {{#if __GH_AW_GITHUB_RUN_ID__ }}\n - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__\n {{/if}}\n \n \n GH_AW_PROMPT_0e4131663d1691aa_EOF\n cat \"${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md\"\n cat << 'GH_AW_PROMPT_0e4131663d1691aa_EOF'\n \n {{#runtime-import .github/workflows/handle-question.md}}\n GH_AW_PROMPT_0e4131663d1691aa_EOF\n } > \"$GH_AW_PROMPT\"\n - name: Interpolate variables and render templates\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/interpolate_prompt.cjs');\n await main();\n - name: Substitute placeholders\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_GITHUB_ACTOR: ${{ github.actor }}\n GH_AW_GITHUB_EVENT_COMMENT_ID: ${{ github.event.comment.id }}\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: ${{ github.event.discussion.number }}\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: ${{ github.event.issue.number }}\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n GH_AW_GITHUB_RUN_ID: ${{ github.run_id }}\n GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }}\n GH_AW_INPUTS_ISSUE_NUMBER: ${{ inputs.issue_number }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n \n const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs');\n \n // Call the substitution function\n return await substitutePlaceholders({\n file: process.env.GH_AW_PROMPT,\n substitutions: {\n GH_AW_GITHUB_ACTOR: process.env.GH_AW_GITHUB_ACTOR,\n GH_AW_GITHUB_EVENT_COMMENT_ID: process.env.GH_AW_GITHUB_EVENT_COMMENT_ID,\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: process.env.GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER,\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: process.env.GH_AW_GITHUB_EVENT_ISSUE_NUMBER,\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: process.env.GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER,\n GH_AW_GITHUB_REPOSITORY: process.env.GH_AW_GITHUB_REPOSITORY,\n GH_AW_GITHUB_RUN_ID: process.env.GH_AW_GITHUB_RUN_ID,\n GH_AW_GITHUB_WORKSPACE: process.env.GH_AW_GITHUB_WORKSPACE,\n GH_AW_INPUTS_ISSUE_NUMBER: process.env.GH_AW_INPUTS_ISSUE_NUMBER\n }\n });\n - name: Validate prompt placeholders\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n # poutine:ignore untrusted_checkout_exec\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/validate_prompt_placeholders.sh\"\n - name: Print prompt\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n # poutine:ignore untrusted_checkout_exec\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/print_prompt_summary.sh\"\n - name: Upload activation artifact\n if: success()\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ steps.artifact-prefix.outputs.prefix }}activation\n path: |\n /tmp/gh-aw/aw_info.json\n /tmp/gh-aw/aw-prompts/prompt.txt\n /tmp/gh-aw/github_rate_limits.jsonl\n if-no-files-found: ignore\n retention-days: 1\n\n agent:\n needs: activation\n runs-on: ubuntu-latest\n permissions:\n contents: read\n issues: read\n pull-requests: read\n concurrency:\n group: \"gh-aw-copilot-${{ github.workflow }}-${{ inputs.issue_number }}\"\n env:\n DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}\n GH_AW_ASSETS_ALLOWED_EXTS: \"\"\n GH_AW_ASSETS_BRANCH: \"\"\n GH_AW_ASSETS_MAX_SIZE_KB: 0\n GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs\n GH_AW_WORKFLOW_ID_SANITIZED: handlequestion\n outputs:\n artifact_prefix: ${{ needs.activation.outputs.artifact_prefix }}\n checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }}\n effective_tokens: ${{ steps.parse-mcp-gateway.outputs.effective_tokens }}\n has_patch: ${{ steps.collect_output.outputs.has_patch }}\n inference_access_error: ${{ steps.detect-inference-error.outputs.inference_access_error || 'false' }}\n model: ${{ needs.activation.outputs.model }}\n output: ${{ steps.collect_output.outputs.output }}\n output_types: ${{ steps.collect_output.outputs.output_types }}\n setup-trace-id: ${{ steps.setup.outputs.trace-id }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Set runtime paths\n id: set-runtime-paths\n run: |\n echo \"GH_AW_SAFE_OUTPUTS=${RUNNER_TEMP}/gh-aw/safeoutputs/outputs.jsonl\" >> \"$GITHUB_OUTPUT\"\n echo \"GH_AW_SAFE_OUTPUTS_CONFIG_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/config.json\" >> \"$GITHUB_OUTPUT\"\n echo \"GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json\" >> \"$GITHUB_OUTPUT\"\n - name: Checkout repository\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n - name: Create gh-aw temp directory\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/create_gh_aw_tmp_dir.sh\"\n - name: Configure gh CLI for GitHub Enterprise\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh\"\n env:\n GH_TOKEN: ${{ github.token }}\n - name: Configure Git credentials\n env:\n REPO_NAME: ${{ github.repository }}\n SERVER_URL: ${{ github.server_url }}\n GITHUB_TOKEN: ${{ github.token }}\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git config --global am.keepcr true\n # Re-authenticate git with GitHub token\n SERVER_URL_STRIPPED=\"${SERVER_URL#https://}\"\n git remote set-url origin \"https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git\"\n echo \"Git configured with standard GitHub Actions identity\"\n - name: Checkout PR branch\n id: checkout-pr\n if: |\n github.event.pull_request || github.event.issue.pull_request\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs');\n await main();\n - name: Install GitHub Copilot CLI\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh\" 1.0.20\n env:\n GH_HOST: github.com\n - name: Install AWF binary\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh\" v0.25.18\n - name: Parse integrity filter lists\n id: parse-guard-vars\n env:\n GH_AW_BLOCKED_USERS_VAR: ${{ vars.GH_AW_GITHUB_BLOCKED_USERS || '' }}\n GH_AW_TRUSTED_USERS_VAR: ${{ vars.GH_AW_GITHUB_TRUSTED_USERS || '' }}\n GH_AW_APPROVAL_LABELS_VAR: ${{ vars.GH_AW_GITHUB_APPROVAL_LABELS || '' }}\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/parse_guard_list.sh\"\n - name: Download container images\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh\" ghcr.io/github/gh-aw-firewall/agent:0.25.18 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.18 ghcr.io/github/gh-aw-firewall/squid:0.25.18 ghcr.io/github/gh-aw-mcpg:v0.2.17 ghcr.io/github/github-mcp-server:v0.32.0 node:lts-alpine\n - name: Write Safe Outputs Config\n run: |\n mkdir -p \"${RUNNER_TEMP}/gh-aw/safeoutputs\"\n mkdir -p /tmp/gh-aw/safeoutputs\n mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs\n cat > \"${RUNNER_TEMP}/gh-aw/safeoutputs/config.json\" << 'GH_AW_SAFE_OUTPUTS_CONFIG_f18ff0beb4e2bc07_EOF'\n {\"add_comment\":{\"max\":1,\"target\":\"*\"},\"add_labels\":{\"allowed\":[\"question\"],\"max\":1,\"target\":\"*\"},\"create_report_incomplete_issue\":{},\"missing_data\":{},\"missing_tool\":{},\"noop\":{\"max\":1,\"report-as-issue\":\"true\"},\"report_incomplete\":{}}\n GH_AW_SAFE_OUTPUTS_CONFIG_f18ff0beb4e2bc07_EOF\n - name: Write Safe Outputs Tools\n env:\n GH_AW_TOOLS_META_JSON: |\n {\n \"description_suffixes\": {\n \"add_comment\": \" CONSTRAINTS: Maximum 1 comment(s) can be added. Target: *.\",\n \"add_labels\": \" CONSTRAINTS: Maximum 1 label(s) can be added. Only these labels are allowed: [\\\"question\\\"]. Target: *.\"\n },\n \"repo_params\": {},\n \"dynamic_tools\": []\n }\n GH_AW_VALIDATION_JSON: |\n {\n \"add_comment\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"body\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"item_number\": {\n \"issueOrPRNumber\": true\n },\n \"repo\": {\n \"type\": \"string\",\n \"maxLength\": 256\n }\n }\n },\n \"add_labels\": {\n \"defaultMax\": 5,\n \"fields\": {\n \"item_number\": {\n \"issueNumberOrTemporaryId\": true\n },\n \"labels\": {\n \"required\": true,\n \"type\": \"array\",\n \"itemType\": \"string\",\n \"itemSanitize\": true,\n \"itemMaxLength\": 128\n },\n \"repo\": {\n \"type\": \"string\",\n \"maxLength\": 256\n }\n }\n },\n \"missing_data\": {\n \"defaultMax\": 20,\n \"fields\": {\n \"alternatives\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"context\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"data_type\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n },\n \"reason\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n }\n }\n },\n \"missing_tool\": {\n \"defaultMax\": 20,\n \"fields\": {\n \"alternatives\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 512\n },\n \"reason\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"tool\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n }\n }\n },\n \"noop\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"message\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n }\n }\n },\n \"report_incomplete\": {\n \"defaultMax\": 5,\n \"fields\": {\n \"details\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"reason\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 1024\n }\n }\n }\n }\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_safe_outputs_tools.cjs');\n await main();\n - name: Generate Safe Outputs MCP Server Config\n id: safe-outputs-config\n run: |\n # Generate a secure random API key (360 bits of entropy, 40+ chars)\n # Mask immediately to prevent timing vulnerabilities\n API_KEY=$(openssl rand -base64 45 | tr -d '/+=')\n echo \"::add-mask::${API_KEY}\"\n \n PORT=3001\n \n # Set outputs for next steps\n {\n echo \"safe_outputs_api_key=${API_KEY}\"\n echo \"safe_outputs_port=${PORT}\"\n } >> \"$GITHUB_OUTPUT\"\n \n echo \"Safe Outputs MCP server will run on port ${PORT}\"\n \n - name: Start Safe Outputs MCP HTTP Server\n id: safe-outputs-start\n env:\n DEBUG: '*'\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-config.outputs.safe_outputs_port }}\n GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-config.outputs.safe_outputs_api_key }}\n GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/tools.json\n GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/config.json\n GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs\n run: |\n # Environment variables are set above to prevent template injection\n export DEBUG\n export GH_AW_SAFE_OUTPUTS\n export GH_AW_SAFE_OUTPUTS_PORT\n export GH_AW_SAFE_OUTPUTS_API_KEY\n export GH_AW_SAFE_OUTPUTS_TOOLS_PATH\n export GH_AW_SAFE_OUTPUTS_CONFIG_PATH\n export GH_AW_MCP_LOG_DIR\n \n bash \"${RUNNER_TEMP}/gh-aw/actions/start_safe_outputs_server.sh\"\n \n - name: Start MCP Gateway\n id: start-mcp-gateway\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-start.outputs.api_key }}\n GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-start.outputs.port }}\n GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n run: |\n set -eo pipefail\n mkdir -p /tmp/gh-aw/mcp-config\n \n # Export gateway environment variables for MCP config and gateway script\n export MCP_GATEWAY_PORT=\"80\"\n export MCP_GATEWAY_DOMAIN=\"host.docker.internal\"\n MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=')\n echo \"::add-mask::${MCP_GATEWAY_API_KEY}\"\n export MCP_GATEWAY_API_KEY\n export MCP_GATEWAY_PAYLOAD_DIR=\"/tmp/gh-aw/mcp-payloads\"\n mkdir -p \"${MCP_GATEWAY_PAYLOAD_DIR}\"\n export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD=\"524288\"\n export DEBUG=\"*\"\n \n export GH_AW_ENGINE=\"copilot\"\n export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host -v /var/run/docker.sock:/var/run/docker.sock -e MCP_GATEWAY_PORT -e MCP_GATEWAY_DOMAIN -e MCP_GATEWAY_API_KEY -e MCP_GATEWAY_PAYLOAD_DIR -e MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD -e DEBUG -e MCP_GATEWAY_LOG_DIR -e GH_AW_MCP_LOG_DIR -e GH_AW_SAFE_OUTPUTS -e GH_AW_SAFE_OUTPUTS_CONFIG_PATH -e GH_AW_SAFE_OUTPUTS_TOOLS_PATH -e GH_AW_ASSETS_BRANCH -e GH_AW_ASSETS_MAX_SIZE_KB -e GH_AW_ASSETS_ALLOWED_EXTS -e DEFAULT_BRANCH -e GITHUB_MCP_SERVER_TOKEN -e GITHUB_MCP_GUARD_MIN_INTEGRITY -e GITHUB_MCP_GUARD_REPOS -e GITHUB_REPOSITORY -e GITHUB_SERVER_URL -e GITHUB_SHA -e GITHUB_WORKSPACE -e GITHUB_TOKEN -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RUN_ATTEMPT -e GITHUB_JOB -e GITHUB_ACTION -e GITHUB_EVENT_NAME -e GITHUB_EVENT_PATH -e GITHUB_ACTOR -e GITHUB_ACTOR_ID -e GITHUB_TRIGGERING_ACTOR -e GITHUB_WORKFLOW -e GITHUB_WORKFLOW_REF -e GITHUB_WORKFLOW_SHA -e GITHUB_REF -e GITHUB_REF_NAME -e GITHUB_REF_TYPE -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GH_AW_SAFE_OUTPUTS_PORT -e GH_AW_SAFE_OUTPUTS_API_KEY -v /tmp/gh-aw/mcp-payloads:/tmp/gh-aw/mcp-payloads:rw -v /opt:/opt:ro -v /tmp:/tmp:rw -v '\"${GITHUB_WORKSPACE}\"':'\"${GITHUB_WORKSPACE}\"':rw ghcr.io/github/gh-aw-mcpg:v0.2.17'\n \n mkdir -p /home/runner/.copilot\n cat << GH_AW_MCP_CONFIG_878c9f46d6eeb406_EOF | bash \"${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.sh\"\n {\n \"mcpServers\": {\n \"github\": {\n \"type\": \"stdio\",\n \"container\": \"ghcr.io/github/github-mcp-server:v0.32.0\",\n \"env\": {\n \"GITHUB_HOST\": \"\\${GITHUB_SERVER_URL}\",\n \"GITHUB_PERSONAL_ACCESS_TOKEN\": \"\\${GITHUB_MCP_SERVER_TOKEN}\",\n \"GITHUB_READ_ONLY\": \"1\",\n \"GITHUB_TOOLSETS\": \"context,repos,issues,pull_requests\"\n },\n \"guard-policies\": {\n \"allow-only\": {\n \"approval-labels\": ${{ steps.parse-guard-vars.outputs.approval_labels }},\n \"blocked-users\": ${{ steps.parse-guard-vars.outputs.blocked_users }},\n \"min-integrity\": \"none\",\n \"repos\": \"all\",\n \"trusted-users\": ${{ steps.parse-guard-vars.outputs.trusted_users }}\n }\n }\n },\n \"safeoutputs\": {\n \"type\": \"http\",\n \"url\": \"http://host.docker.internal:$GH_AW_SAFE_OUTPUTS_PORT\",\n \"headers\": {\n \"Authorization\": \"\\${GH_AW_SAFE_OUTPUTS_API_KEY}\"\n },\n \"guard-policies\": {\n \"write-sink\": {\n \"accept\": [\n \"*\"\n ]\n }\n }\n }\n },\n \"gateway\": {\n \"port\": $MCP_GATEWAY_PORT,\n \"domain\": \"${MCP_GATEWAY_DOMAIN}\",\n \"apiKey\": \"${MCP_GATEWAY_API_KEY}\",\n \"payloadDir\": \"${MCP_GATEWAY_PAYLOAD_DIR}\"\n }\n }\n GH_AW_MCP_CONFIG_878c9f46d6eeb406_EOF\n - name: Download activation artifact\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}activation\n path: /tmp/gh-aw\n - name: Clean git credentials\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/clean_git_credentials.sh\"\n - name: Execute GitHub Copilot CLI\n id: agentic_execution\n # Copilot CLI tool arguments (sorted):\n timeout-minutes: 5\n run: |\n set -o pipefail\n touch /tmp/gh-aw/agent-step-summary.md\n # shellcheck disable=SC1003\n sudo -E awf --container-workdir \"${GITHUB_WORKSPACE}\" --mount \"${RUNNER_TEMP}/gh-aw:${RUNNER_TEMP}/gh-aw:ro\" --mount \"${RUNNER_TEMP}/gh-aw:/host${RUNNER_TEMP}/gh-aw:ro\" --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --allow-domains api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --image-tag 0.25.18 --skip-pull --enable-api-proxy \\\n -- /bin/bash -c 'node ${RUNNER_TEMP}/gh-aw/actions/copilot_driver.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --allow-all-tools --allow-all-paths --add-dir \"${GITHUB_WORKSPACE}\" --prompt \"$(cat /tmp/gh-aw/aw-prompts/prompt.txt)\"' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log\n env:\n COPILOT_AGENT_RUNNER_TYPE: STANDALONE\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || '' }}\n GH_AW_MCP_CONFIG: /home/runner/.copilot/mcp-config.json\n GH_AW_PHASE: agent\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_VERSION: v0.67.4\n GITHUB_API_URL: ${{ github.api_url }}\n GITHUB_AW: true\n GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows\n GITHUB_HEAD_REF: ${{ github.head_ref }}\n GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n GITHUB_REF_NAME: ${{ github.ref_name }}\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md\n GITHUB_WORKSPACE: ${{ github.workspace }}\n GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_AUTHOR_NAME: github-actions[bot]\n GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_COMMITTER_NAME: github-actions[bot]\n XDG_CONFIG_HOME: /home/runner\n - name: Detect inference access error\n id: detect-inference-error\n if: always()\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/detect_inference_access_error.sh\"\n - name: Configure Git credentials\n env:\n REPO_NAME: ${{ github.repository }}\n SERVER_URL: ${{ github.server_url }}\n GITHUB_TOKEN: ${{ github.token }}\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git config --global am.keepcr true\n # Re-authenticate git with GitHub token\n SERVER_URL_STRIPPED=\"${SERVER_URL#https://}\"\n git remote set-url origin \"https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git\"\n echo \"Git configured with standard GitHub Actions identity\"\n - name: Copy Copilot session state files to logs\n if: always()\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/copy_copilot_session_state.sh\"\n - name: Stop MCP Gateway\n if: always()\n continue-on-error: true\n env:\n MCP_GATEWAY_PORT: ${{ steps.start-mcp-gateway.outputs.gateway-port }}\n MCP_GATEWAY_API_KEY: ${{ steps.start-mcp-gateway.outputs.gateway-api-key }}\n GATEWAY_PID: ${{ steps.start-mcp-gateway.outputs.gateway-pid }}\n run: |\n bash \"${RUNNER_TEMP}/gh-aw/actions/stop_mcp_gateway.sh\" \"$GATEWAY_PID\"\n - name: Redact secrets in logs\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs');\n await main();\n env:\n GH_AW_SECRET_NAMES: 'COPILOT_GITHUB_TOKEN,GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN'\n SECRET_COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }}\n SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }}\n SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n - name: Append agent step summary\n if: always()\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/append_agent_step_summary.sh\"\n - name: Copy Safe Outputs\n if: always()\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n run: |\n mkdir -p /tmp/gh-aw\n cp \"$GH_AW_SAFE_OUTPUTS\" /tmp/gh-aw/safeoutputs.jsonl 2>/dev/null || true\n - name: Ingest agent output\n id: collect_output\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_ALLOWED_DOMAINS: \"api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com\"\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_API_URL: ${{ github.api_url }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/collect_ndjson_output.cjs');\n await main();\n - name: Parse agent logs for step summary\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_copilot_log.cjs');\n await main();\n - name: Parse MCP Gateway logs for step summary\n if: always()\n id: parse-mcp-gateway\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_mcp_gateway_log.cjs');\n await main();\n - name: Print firewall logs\n if: always()\n continue-on-error: true\n env:\n AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs\n run: |\n # Fix permissions on firewall logs so they can be uploaded as artifacts\n # AWF runs with sudo, creating files owned by root\n sudo chmod -R a+r /tmp/gh-aw/sandbox/firewall/logs 2>/dev/null || true\n # Only run awf logs summary if awf command exists (it may not be installed if workflow failed before install step)\n if command -v awf &> /dev/null; then\n awf logs summary | tee -a \"$GITHUB_STEP_SUMMARY\"\n else\n echo 'AWF binary not installed, skipping firewall log summary'\n fi\n - name: Parse token usage for step summary\n if: always()\n continue-on-error: true\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs');\n await main();\n - name: Write agent output placeholder if missing\n if: always()\n run: |\n if [ ! -f /tmp/gh-aw/agent_output.json ]; then\n echo '{\"items\":[]}' > /tmp/gh-aw/agent_output.json\n fi\n - name: Upload agent artifacts\n if: always()\n continue-on-error: true\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}agent\n path: |\n /tmp/gh-aw/aw-prompts/prompt.txt\n /tmp/gh-aw/sandbox/agent/logs/\n /tmp/gh-aw/redacted-urls.log\n /tmp/gh-aw/mcp-logs/\n /tmp/gh-aw/proxy-logs/\n !/tmp/gh-aw/proxy-logs/proxy-tls/\n /tmp/gh-aw/agent_usage.json\n /tmp/gh-aw/agent-stdio.log\n /tmp/gh-aw/agent/\n /tmp/gh-aw/github_rate_limits.jsonl\n /tmp/gh-aw/safeoutputs.jsonl\n /tmp/gh-aw/agent_output.json\n /tmp/gh-aw/aw-*.patch\n /tmp/gh-aw/aw-*.bundle\n if-no-files-found: ignore\n - name: Upload firewall audit logs\n if: always()\n continue-on-error: true\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}firewall-audit-logs\n path: |\n /tmp/gh-aw/sandbox/firewall/logs/\n /tmp/gh-aw/sandbox/firewall/audit/\n if-no-files-found: ignore\n\n conclusion:\n needs:\n - activation\n - agent\n - detection\n - safe_outputs\n if: always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true')\n runs-on: ubuntu-slim\n permissions:\n contents: read\n discussions: write\n issues: write\n pull-requests: write\n concurrency:\n group: \"gh-aw-conclusion-handle-question-${{ inputs.issue_number }}\"\n cancel-in-progress: false\n outputs:\n incomplete_count: ${{ steps.report_incomplete.outputs.incomplete_count }}\n noop_message: ${{ steps.noop.outputs.noop_message }}\n tools_reported: ${{ steps.missing_tool.outputs.tools_reported }}\n total_count: ${{ steps.missing_tool.outputs.total_count }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Process No-Op Messages\n id: noop\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_NOOP_MAX: \"1\"\n GH_AW_WORKFLOW_NAME: \"Question Handler\"\n GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\n GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }}\n GH_AW_NOOP_REPORT_AS_ISSUE: \"true\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_noop_message.cjs');\n await main();\n - name: Record missing tool\n id: missing_tool\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_MISSING_TOOL_CREATE_ISSUE: \"true\"\n GH_AW_WORKFLOW_NAME: \"Question Handler\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/missing_tool.cjs');\n await main();\n - name: Record incomplete\n id: report_incomplete\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_REPORT_INCOMPLETE_CREATE_ISSUE: \"true\"\n GH_AW_WORKFLOW_NAME: \"Question Handler\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/report_incomplete_handler.cjs');\n await main();\n - name: Handle agent failure\n id: handle_agent_failure\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_WORKFLOW_NAME: \"Question Handler\"\n GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\n GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }}\n GH_AW_WORKFLOW_ID: \"handle-question\"\n GH_AW_ENGINE_ID: \"copilot\"\n GH_AW_SECRET_VERIFICATION_RESULT: ${{ needs.activation.outputs.secret_verification_result }}\n GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }}\n GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }}\n GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }}\n GH_AW_GROUP_REPORTS: \"false\"\n GH_AW_FAILURE_REPORT_AS_ISSUE: \"true\"\n GH_AW_TIMEOUT_MINUTES: \"5\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_agent_failure.cjs');\n await main();\n\n detection:\n needs:\n - activation\n - agent\n if: >\n always() && needs.agent.result != 'skipped' && (needs.agent.outputs.output_types != '' || needs.agent.outputs.has_patch == 'true')\n runs-on: ubuntu-latest\n permissions:\n contents: read\n outputs:\n detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }}\n detection_success: ${{ steps.detection_conclusion.outputs.success }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: ${{ needs.agent.outputs.artifact_prefix }}agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Checkout repository for patch context\n if: needs.agent.outputs.has_patch == 'true'\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n # --- Threat Detection ---\n - name: Download container images\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh\" ghcr.io/github/gh-aw-firewall/agent:0.25.18 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.18 ghcr.io/github/gh-aw-firewall/squid:0.25.18\n - name: Check if detection needed\n id: detection_guard\n if: always()\n env:\n OUTPUT_TYPES: ${{ needs.agent.outputs.output_types }}\n HAS_PATCH: ${{ needs.agent.outputs.has_patch }}\n run: |\n if [[ -n \"$OUTPUT_TYPES\" || \"$HAS_PATCH\" == \"true\" ]]; then\n echo \"run_detection=true\" >> \"$GITHUB_OUTPUT\"\n echo \"Detection will run: output_types=$OUTPUT_TYPES, has_patch=$HAS_PATCH\"\n else\n echo \"run_detection=false\" >> \"$GITHUB_OUTPUT\"\n echo \"Detection skipped: no agent outputs or patches to analyze\"\n fi\n - name: Clear MCP configuration for detection\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n rm -f /tmp/gh-aw/mcp-config/mcp-servers.json\n rm -f /home/runner/.copilot/mcp-config.json\n rm -f \"$GITHUB_WORKSPACE/.gemini/settings.json\"\n - name: Prepare threat detection files\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n mkdir -p /tmp/gh-aw/threat-detection/aw-prompts\n cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true\n cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true\n for f in /tmp/gh-aw/aw-*.patch; do\n [ -f \"$f\" ] && cp \"$f\" /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n done\n for f in /tmp/gh-aw/aw-*.bundle; do\n [ -f \"$f\" ] && cp \"$f\" /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n done\n echo \"Prepared threat detection files:\"\n ls -la /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n - name: Setup threat detection\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n WORKFLOW_NAME: \"Question Handler\"\n WORKFLOW_DESCRIPTION: \"Handles issues classified as questions by the triage classifier\"\n HAS_PATCH: ${{ needs.agent.outputs.has_patch }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/setup_threat_detection.cjs');\n await main();\n - name: Ensure threat-detection directory and log\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n mkdir -p /tmp/gh-aw/threat-detection\n touch /tmp/gh-aw/threat-detection/detection.log\n - name: Install GitHub Copilot CLI\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh\" 1.0.20\n env:\n GH_HOST: github.com\n - name: Install AWF binary\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh\" v0.25.18\n - name: Execute GitHub Copilot CLI\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n id: detection_agentic_execution\n # Copilot CLI tool arguments (sorted):\n timeout-minutes: 20\n run: |\n set -o pipefail\n touch /tmp/gh-aw/agent-step-summary.md\n # shellcheck disable=SC1003\n sudo -E awf --container-workdir \"${GITHUB_WORKSPACE}\" --mount \"${RUNNER_TEMP}/gh-aw:${RUNNER_TEMP}/gh-aw:ro\" --mount \"${RUNNER_TEMP}/gh-aw:/host${RUNNER_TEMP}/gh-aw:ro\" --env-all --exclude-env COPILOT_GITHUB_TOKEN --allow-domains api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,github.com,host.docker.internal,telemetry.enterprise.githubcopilot.com --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --image-tag 0.25.18 --skip-pull --enable-api-proxy \\\n -- /bin/bash -c 'node ${RUNNER_TEMP}/gh-aw/actions/copilot_driver.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --allow-all-tools --add-dir \"${GITHUB_WORKSPACE}\" --prompt \"$(cat /tmp/gh-aw/aw-prompts/prompt.txt)\"' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log\n env:\n COPILOT_AGENT_RUNNER_TYPE: STANDALONE\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || '' }}\n GH_AW_PHASE: detection\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_VERSION: v0.67.4\n GITHUB_API_URL: ${{ github.api_url }}\n GITHUB_AW: true\n GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows\n GITHUB_HEAD_REF: ${{ github.head_ref }}\n GITHUB_REF_NAME: ${{ github.ref_name }}\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md\n GITHUB_WORKSPACE: ${{ github.workspace }}\n GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_AUTHOR_NAME: github-actions[bot]\n GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_COMMITTER_NAME: github-actions[bot]\n XDG_CONFIG_HOME: /home/runner\n - name: Upload threat detection log\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ needs.agent.outputs.artifact_prefix }}detection\n path: /tmp/gh-aw/threat-detection/detection.log\n if-no-files-found: ignore\n - name: Parse and conclude threat detection\n id: detection_conclusion\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n RUN_DETECTION: ${{ steps.detection_guard.outputs.run_detection }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_threat_detection_results.cjs');\n await main();\n\n safe_outputs:\n needs:\n - activation\n - agent\n - detection\n if: (!cancelled()) && needs.agent.result != 'skipped' && needs.detection.result == 'success'\n runs-on: ubuntu-slim\n permissions:\n contents: read\n discussions: write\n issues: write\n pull-requests: write\n timeout-minutes: 15\n env:\n GH_AW_CALLER_WORKFLOW_ID: \"${{ github.repository }}/handle-question\"\n GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens }}\n GH_AW_ENGINE_ID: \"copilot\"\n GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }}\n GH_AW_WORKFLOW_ID: \"handle-question\"\n GH_AW_WORKFLOW_NAME: \"Question Handler\"\n outputs:\n code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }}\n code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }}\n comment_id: ${{ steps.process_safe_outputs.outputs.comment_id }}\n comment_url: ${{ steps.process_safe_outputs.outputs.comment_url }}\n create_discussion_error_count: ${{ steps.process_safe_outputs.outputs.create_discussion_error_count }}\n create_discussion_errors: ${{ steps.process_safe_outputs.outputs.create_discussion_errors }}\n process_safe_outputs_processed_count: ${{ steps.process_safe_outputs.outputs.processed_count }}\n process_safe_outputs_temporary_id_map: ${{ steps.process_safe_outputs.outputs.temporary_id_map }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Configure GH_HOST for enterprise compatibility\n id: ghes-host-config\n shell: bash\n run: |\n # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct\n # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op.\n GH_HOST=\"${GITHUB_SERVER_URL#https://}\"\n GH_HOST=\"${GH_HOST#http://}\"\n echo \"GH_HOST=${GH_HOST}\" >> \"$GITHUB_ENV\"\n - name: Process Safe Outputs\n id: process_safe_outputs\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_ALLOWED_DOMAINS: \"api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com\"\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_API_URL: ${{ github.api_url }}\n GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: \"{\\\"add_comment\\\":{\\\"max\\\":1,\\\"target\\\":\\\"*\\\"},\\\"add_labels\\\":{\\\"allowed\\\":[\\\"question\\\"],\\\"max\\\":1,\\\"target\\\":\\\"*\\\"},\\\"create_report_incomplete_issue\\\":{},\\\"missing_data\\\":{},\\\"missing_tool\\\":{},\\\"noop\\\":{\\\"max\\\":1,\\\"report-as-issue\\\":\\\"true\\\"},\\\"report_incomplete\\\":{}}\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/safe_output_handler_manager.cjs');\n await main();\n - name: Upload Safe Outputs Items\n if: always()\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: ${{ needs.activation.outputs.artifact_prefix }}safe-outputs-items\n path: /tmp/gh-aw/safe-output-items.jsonl\n if-no-files-found: ignore\n\n" }, { "path": ".github/workflows/handle-question.md", "content": "---\ndescription: Handles issues classified as questions by the triage classifier\nconcurrency:\n job-discriminator: ${{ inputs.issue_number }}\non:\n workflow_call:\n inputs:\n payload:\n type: string\n required: false\n issue_number:\n type: string\n required: true\n roles: all\npermissions:\n contents: read\n issues: read\n pull-requests: read\ntools:\n github:\n toolsets: [default]\n min-integrity: none\nsafe-outputs:\n add-labels:\n allowed: [question]\n max: 1\n target: \"*\"\n add-comment:\n max: 1\n target: \"*\"\ntimeout-minutes: 5\n---\n\n# Question Handler\n\nAdd the `question` label to issue #${{ inputs.issue_number }}.\n" }, { "path": ".github/workflows/issue-classification.lock.yml", "content": "# gh-aw-metadata: {\"schema_version\":\"v3\",\"frontmatter_hash\":\"1c9f9a62a510a7796b96187fbe0537fd05da1c082d8fab86cd7b99bf001aee01\",\"compiler_version\":\"v0.67.4\",\"strict\":true,\"agent_id\":\"copilot\"}\n# gh-aw-manifest: {\"version\":1,\"secrets\":[\"COPILOT_GITHUB_TOKEN\",\"GH_AW_GITHUB_MCP_SERVER_TOKEN\",\"GH_AW_GITHUB_TOKEN\",\"GITHUB_TOKEN\"],\"actions\":[{\"repo\":\"actions/checkout\",\"sha\":\"de0fac2e4500dabe0009e67214ff5f5447ce83dd\",\"version\":\"v6.0.2\"},{\"repo\":\"actions/download-artifact\",\"sha\":\"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c\",\"version\":\"v8.0.1\"},{\"repo\":\"actions/github-script\",\"sha\":\"ed597411d8f924073f98dfc5c65a23a2325f34cd\",\"version\":\"v8\"},{\"repo\":\"actions/upload-artifact\",\"sha\":\"bbbca2ddaa5d8feaa63e36b76fdaad77386f024f\",\"version\":\"v7\"},{\"repo\":\"github/gh-aw-actions/setup\",\"sha\":\"9d6ae06250fc0ec536a0e5f35de313b35bad7246\",\"version\":\"v0.67.4\"}]}\n# ___ _ _ \n# / _ \\ | | (_) \n# | |_| | __ _ ___ _ __ | |_ _ ___ \n# | _ |/ _` |/ _ \\ '_ \\| __| |/ __|\n# | | | | (_| | __/ | | | |_| | (__ \n# \\_| |_/\\__, |\\___|_| |_|\\__|_|\\___|\n# __/ |\n# _ _ |___/ \n# | | | | / _| |\n# | | | | ___ _ __ _ __| |_| | _____ ____\n# | |/\\| |/ _ \\ '__| |/ /| _| |/ _ \\ \\ /\\ / / ___|\n# \\ /\\ / (_) | | | | ( | | | | (_) \\ V V /\\__ \\\n# \\/ \\/ \\___/|_| |_|\\_\\|_| |_|\\___/ \\_/\\_/ |___/\n#\n# This file was automatically generated by gh-aw (v0.67.4). DO NOT EDIT.\n#\n# To update this file, edit the corresponding .md file and run:\n# gh aw compile\n# Not all edits will cause changes to this file.\n#\n# For more information: https://github.github.com/gh-aw/introduction/overview/\n#\n# Classifies newly opened issues and delegates to type-specific handler workflows\n#\n# Secrets used:\n# - COPILOT_GITHUB_TOKEN\n# - GH_AW_GITHUB_MCP_SERVER_TOKEN\n# - GH_AW_GITHUB_TOKEN\n# - GITHUB_TOKEN\n#\n# Custom actions used:\n# - actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n# - actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n# - actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n# - actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n# - github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n\nname: \"Issue Classification Agent\"\n\"on\":\n issues:\n types:\n - opened\n # roles: all # Roles processed as role check in pre-activation job\n workflow_dispatch:\n inputs:\n aw_context:\n default: \"\"\n description: Agent caller context (used internally by Agentic Workflows).\n required: false\n type: string\n issue_number:\n description: Issue number to triage\n required: true\n type: string\n\npermissions: {}\n\nconcurrency:\n group: \"gh-aw-${{ github.workflow }}-${{ github.event.issue.number || github.run_id }}\"\n\nrun-name: \"Issue Classification Agent\"\n\njobs:\n activation:\n runs-on: ubuntu-slim\n permissions:\n actions: read\n contents: read\n outputs:\n body: ${{ steps.sanitized.outputs.body }}\n comment_id: \"\"\n comment_repo: \"\"\n lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }}\n model: ${{ steps.generate_aw_info.outputs.model }}\n secret_verification_result: ${{ steps.validate-secret.outputs.verification_result }}\n setup-trace-id: ${{ steps.setup.outputs.trace-id }}\n text: ${{ steps.sanitized.outputs.text }}\n title: ${{ steps.sanitized.outputs.title }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n - name: Generate agentic run info\n id: generate_aw_info\n env:\n GH_AW_INFO_ENGINE_ID: \"copilot\"\n GH_AW_INFO_ENGINE_NAME: \"GitHub Copilot CLI\"\n GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'auto' }}\n GH_AW_INFO_VERSION: \"1.0.20\"\n GH_AW_INFO_AGENT_VERSION: \"1.0.20\"\n GH_AW_INFO_CLI_VERSION: \"v0.67.4\"\n GH_AW_INFO_WORKFLOW_NAME: \"Issue Classification Agent\"\n GH_AW_INFO_EXPERIMENTAL: \"false\"\n GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: \"true\"\n GH_AW_INFO_STAGED: \"false\"\n GH_AW_INFO_ALLOWED_DOMAINS: '[\"defaults\"]'\n GH_AW_INFO_FIREWALL_ENABLED: \"true\"\n GH_AW_INFO_AWF_VERSION: \"v0.25.18\"\n GH_AW_INFO_AWMG_VERSION: \"\"\n GH_AW_INFO_FIREWALL_TYPE: \"squid\"\n GH_AW_COMPILED_STRICT: \"true\"\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs');\n await main(core, context);\n - name: Validate COPILOT_GITHUB_TOKEN secret\n id: validate-secret\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/validate_multi_secret.sh\" COPILOT_GITHUB_TOKEN 'GitHub Copilot CLI' https://github.github.com/gh-aw/reference/engines/#github-copilot-default\n env:\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n - name: Checkout .github and .agents folders\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n sparse-checkout: |\n .github\n .agents\n sparse-checkout-cone-mode: true\n fetch-depth: 1\n - name: Check workflow lock file\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_WORKFLOW_FILE: \"issue-classification.lock.yml\"\n GH_AW_CONTEXT_WORKFLOW_REF: \"${{ github.workflow_ref }}\"\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/check_workflow_timestamp_api.cjs');\n await main();\n - name: Check compile-agentic version\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_COMPILED_VERSION: \"v0.67.4\"\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/check_version_updates.cjs');\n await main();\n - name: Compute current body text\n id: sanitized\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/compute_text.cjs');\n await main();\n - name: Create prompt with built-in context\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_SAFE_OUTPUTS: ${{ runner.temp }}/gh-aw/safeoutputs/outputs.jsonl\n GH_AW_EXPR_54492A5B: ${{ github.event.issue.number || inputs.issue_number }}\n GH_AW_GITHUB_ACTOR: ${{ github.actor }}\n GH_AW_GITHUB_EVENT_COMMENT_ID: ${{ github.event.comment.id }}\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: ${{ github.event.discussion.number }}\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: ${{ github.event.issue.number }}\n GH_AW_GITHUB_EVENT_ISSUE_TITLE: ${{ github.event.issue.title }}\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n GH_AW_GITHUB_RUN_ID: ${{ github.run_id }}\n GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }}\n # poutine:ignore untrusted_checkout_exec\n run: |\n bash \"${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh\"\n {\n cat << 'GH_AW_PROMPT_0e5e0cb2acba7dc0_EOF'\n \n GH_AW_PROMPT_0e5e0cb2acba7dc0_EOF\n cat \"${RUNNER_TEMP}/gh-aw/prompts/xpia.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/markdown.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md\"\n cat << 'GH_AW_PROMPT_0e5e0cb2acba7dc0_EOF'\n \n Tools: add_comment, call_workflow, missing_tool, missing_data, noop\n \n \n The following GitHub context information is available for this workflow:\n {{#if __GH_AW_GITHUB_ACTOR__ }}\n - **actor**: __GH_AW_GITHUB_ACTOR__\n {{/if}}\n {{#if __GH_AW_GITHUB_REPOSITORY__ }}\n - **repository**: __GH_AW_GITHUB_REPOSITORY__\n {{/if}}\n {{#if __GH_AW_GITHUB_WORKSPACE__ }}\n - **workspace**: __GH_AW_GITHUB_WORKSPACE__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_ISSUE_NUMBER__ }}\n - **issue-number**: #__GH_AW_GITHUB_EVENT_ISSUE_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER__ }}\n - **discussion-number**: #__GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER__ }}\n - **pull-request-number**: #__GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_COMMENT_ID__ }}\n - **comment-id**: __GH_AW_GITHUB_EVENT_COMMENT_ID__\n {{/if}}\n {{#if __GH_AW_GITHUB_RUN_ID__ }}\n - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__\n {{/if}}\n \n \n GH_AW_PROMPT_0e5e0cb2acba7dc0_EOF\n cat \"${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md\"\n cat << 'GH_AW_PROMPT_0e5e0cb2acba7dc0_EOF'\n \n {{#runtime-import .github/workflows/issue-classification.md}}\n GH_AW_PROMPT_0e5e0cb2acba7dc0_EOF\n } > \"$GH_AW_PROMPT\"\n - name: Interpolate variables and render templates\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_EXPR_54492A5B: ${{ github.event.issue.number || inputs.issue_number }}\n GH_AW_GITHUB_EVENT_ISSUE_TITLE: ${{ github.event.issue.title }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/interpolate_prompt.cjs');\n await main();\n - name: Substitute placeholders\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_EXPR_54492A5B: ${{ github.event.issue.number || inputs.issue_number }}\n GH_AW_GITHUB_ACTOR: ${{ github.actor }}\n GH_AW_GITHUB_EVENT_COMMENT_ID: ${{ github.event.comment.id }}\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: ${{ github.event.discussion.number }}\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: ${{ github.event.issue.number }}\n GH_AW_GITHUB_EVENT_ISSUE_TITLE: ${{ github.event.issue.title }}\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n GH_AW_GITHUB_RUN_ID: ${{ github.run_id }}\n GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n \n const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs');\n \n // Call the substitution function\n return await substitutePlaceholders({\n file: process.env.GH_AW_PROMPT,\n substitutions: {\n GH_AW_EXPR_54492A5B: process.env.GH_AW_EXPR_54492A5B,\n GH_AW_GITHUB_ACTOR: process.env.GH_AW_GITHUB_ACTOR,\n GH_AW_GITHUB_EVENT_COMMENT_ID: process.env.GH_AW_GITHUB_EVENT_COMMENT_ID,\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: process.env.GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER,\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: process.env.GH_AW_GITHUB_EVENT_ISSUE_NUMBER,\n GH_AW_GITHUB_EVENT_ISSUE_TITLE: process.env.GH_AW_GITHUB_EVENT_ISSUE_TITLE,\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: process.env.GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER,\n GH_AW_GITHUB_REPOSITORY: process.env.GH_AW_GITHUB_REPOSITORY,\n GH_AW_GITHUB_RUN_ID: process.env.GH_AW_GITHUB_RUN_ID,\n GH_AW_GITHUB_WORKSPACE: process.env.GH_AW_GITHUB_WORKSPACE\n }\n });\n - name: Validate prompt placeholders\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n # poutine:ignore untrusted_checkout_exec\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/validate_prompt_placeholders.sh\"\n - name: Print prompt\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n # poutine:ignore untrusted_checkout_exec\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/print_prompt_summary.sh\"\n - name: Upload activation artifact\n if: success()\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: activation\n path: |\n /tmp/gh-aw/aw_info.json\n /tmp/gh-aw/aw-prompts/prompt.txt\n /tmp/gh-aw/github_rate_limits.jsonl\n if-no-files-found: ignore\n retention-days: 1\n\n agent:\n needs: activation\n runs-on: ubuntu-latest\n permissions:\n contents: read\n issues: read\n pull-requests: read\n env:\n DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}\n GH_AW_ASSETS_ALLOWED_EXTS: \"\"\n GH_AW_ASSETS_BRANCH: \"\"\n GH_AW_ASSETS_MAX_SIZE_KB: 0\n GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs\n GH_AW_WORKFLOW_ID_SANITIZED: issueclassification\n outputs:\n checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }}\n effective_tokens: ${{ steps.parse-mcp-gateway.outputs.effective_tokens }}\n has_patch: ${{ steps.collect_output.outputs.has_patch }}\n inference_access_error: ${{ steps.detect-inference-error.outputs.inference_access_error || 'false' }}\n model: ${{ needs.activation.outputs.model }}\n output: ${{ steps.collect_output.outputs.output }}\n output_types: ${{ steps.collect_output.outputs.output_types }}\n setup-trace-id: ${{ steps.setup.outputs.trace-id }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Set runtime paths\n id: set-runtime-paths\n run: |\n echo \"GH_AW_SAFE_OUTPUTS=${RUNNER_TEMP}/gh-aw/safeoutputs/outputs.jsonl\" >> \"$GITHUB_OUTPUT\"\n echo \"GH_AW_SAFE_OUTPUTS_CONFIG_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/config.json\" >> \"$GITHUB_OUTPUT\"\n echo \"GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json\" >> \"$GITHUB_OUTPUT\"\n - name: Checkout repository\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n - name: Create gh-aw temp directory\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/create_gh_aw_tmp_dir.sh\"\n - name: Configure gh CLI for GitHub Enterprise\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh\"\n env:\n GH_TOKEN: ${{ github.token }}\n - name: Configure Git credentials\n env:\n REPO_NAME: ${{ github.repository }}\n SERVER_URL: ${{ github.server_url }}\n GITHUB_TOKEN: ${{ github.token }}\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git config --global am.keepcr true\n # Re-authenticate git with GitHub token\n SERVER_URL_STRIPPED=\"${SERVER_URL#https://}\"\n git remote set-url origin \"https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git\"\n echo \"Git configured with standard GitHub Actions identity\"\n - name: Checkout PR branch\n id: checkout-pr\n if: |\n github.event.pull_request || github.event.issue.pull_request\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs');\n await main();\n - name: Install GitHub Copilot CLI\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh\" 1.0.20\n env:\n GH_HOST: github.com\n - name: Install AWF binary\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh\" v0.25.18\n - name: Parse integrity filter lists\n id: parse-guard-vars\n env:\n GH_AW_BLOCKED_USERS_VAR: ${{ vars.GH_AW_GITHUB_BLOCKED_USERS || '' }}\n GH_AW_TRUSTED_USERS_VAR: ${{ vars.GH_AW_GITHUB_TRUSTED_USERS || '' }}\n GH_AW_APPROVAL_LABELS_VAR: ${{ vars.GH_AW_GITHUB_APPROVAL_LABELS || '' }}\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/parse_guard_list.sh\"\n - name: Download container images\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh\" ghcr.io/github/gh-aw-firewall/agent:0.25.18 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.18 ghcr.io/github/gh-aw-firewall/squid:0.25.18 ghcr.io/github/gh-aw-mcpg:v0.2.17 ghcr.io/github/github-mcp-server:v0.32.0 node:lts-alpine\n - name: Write Safe Outputs Config\n run: |\n mkdir -p \"${RUNNER_TEMP}/gh-aw/safeoutputs\"\n mkdir -p /tmp/gh-aw/safeoutputs\n mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs\n cat > \"${RUNNER_TEMP}/gh-aw/safeoutputs/config.json\" << 'GH_AW_SAFE_OUTPUTS_CONFIG_0e1d49da13fc6a56_EOF'\n {\"add_comment\":{\"max\":1,\"target\":\"triggering\"},\"call_workflow\":{\"max\":1,\"workflow_files\":{\"handle-bug\":\"./.github/workflows/handle-bug.lock.yml\",\"handle-documentation\":\"./.github/workflows/handle-documentation.lock.yml\",\"handle-enhancement\":\"./.github/workflows/handle-enhancement.lock.yml\",\"handle-question\":\"./.github/workflows/handle-question.lock.yml\"},\"workflows\":[\"handle-bug\",\"handle-enhancement\",\"handle-question\",\"handle-documentation\"]},\"create_report_incomplete_issue\":{},\"missing_data\":{},\"missing_tool\":{},\"noop\":{\"max\":1,\"report-as-issue\":\"true\"},\"report_incomplete\":{}}\n GH_AW_SAFE_OUTPUTS_CONFIG_0e1d49da13fc6a56_EOF\n - name: Write Safe Outputs Tools\n env:\n GH_AW_TOOLS_META_JSON: |\n {\n \"description_suffixes\": {\n \"add_comment\": \" CONSTRAINTS: Maximum 1 comment(s) can be added. Target: triggering.\"\n },\n \"repo_params\": {},\n \"dynamic_tools\": [\n {\n \"_call_workflow_name\": \"handle-bug\",\n \"description\": \"Call the 'handle-bug' reusable workflow via workflow_call. This workflow must support workflow_call and be in .github/workflows/ directory in the same repository.\",\n \"inputSchema\": {\n \"additionalProperties\": false,\n \"properties\": {\n \"issue_number\": {\n \"description\": \"Input parameter 'issue_number' for workflow handle-bug\",\n \"type\": \"string\"\n },\n \"payload\": {\n \"description\": \"Input parameter 'payload' for workflow handle-bug\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"issue_number\"\n ],\n \"type\": \"object\"\n },\n \"name\": \"handle_bug\"\n },\n {\n \"_call_workflow_name\": \"handle-enhancement\",\n \"description\": \"Call the 'handle-enhancement' reusable workflow via workflow_call. This workflow must support workflow_call and be in .github/workflows/ directory in the same repository.\",\n \"inputSchema\": {\n \"additionalProperties\": false,\n \"properties\": {\n \"issue_number\": {\n \"description\": \"Input parameter 'issue_number' for workflow handle-enhancement\",\n \"type\": \"string\"\n },\n \"payload\": {\n \"description\": \"Input parameter 'payload' for workflow handle-enhancement\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"issue_number\"\n ],\n \"type\": \"object\"\n },\n \"name\": \"handle_enhancement\"\n },\n {\n \"_call_workflow_name\": \"handle-question\",\n \"description\": \"Call the 'handle-question' reusable workflow via workflow_call. This workflow must support workflow_call and be in .github/workflows/ directory in the same repository.\",\n \"inputSchema\": {\n \"additionalProperties\": false,\n \"properties\": {\n \"issue_number\": {\n \"description\": \"Input parameter 'issue_number' for workflow handle-question\",\n \"type\": \"string\"\n },\n \"payload\": {\n \"description\": \"Input parameter 'payload' for workflow handle-question\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"issue_number\"\n ],\n \"type\": \"object\"\n },\n \"name\": \"handle_question\"\n },\n {\n \"_call_workflow_name\": \"handle-documentation\",\n \"description\": \"Call the 'handle-documentation' reusable workflow via workflow_call. This workflow must support workflow_call and be in .github/workflows/ directory in the same repository.\",\n \"inputSchema\": {\n \"additionalProperties\": false,\n \"properties\": {\n \"issue_number\": {\n \"description\": \"Input parameter 'issue_number' for workflow handle-documentation\",\n \"type\": \"string\"\n },\n \"payload\": {\n \"description\": \"Input parameter 'payload' for workflow handle-documentation\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"issue_number\"\n ],\n \"type\": \"object\"\n },\n \"name\": \"handle_documentation\"\n }\n ]\n }\n GH_AW_VALIDATION_JSON: |\n {\n \"add_comment\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"body\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"item_number\": {\n \"issueOrPRNumber\": true\n },\n \"repo\": {\n \"type\": \"string\",\n \"maxLength\": 256\n }\n }\n },\n \"missing_data\": {\n \"defaultMax\": 20,\n \"fields\": {\n \"alternatives\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"context\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"data_type\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n },\n \"reason\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n }\n }\n },\n \"missing_tool\": {\n \"defaultMax\": 20,\n \"fields\": {\n \"alternatives\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 512\n },\n \"reason\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"tool\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n }\n }\n },\n \"noop\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"message\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n }\n }\n },\n \"report_incomplete\": {\n \"defaultMax\": 5,\n \"fields\": {\n \"details\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"reason\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 1024\n }\n }\n }\n }\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_safe_outputs_tools.cjs');\n await main();\n - name: Generate Safe Outputs MCP Server Config\n id: safe-outputs-config\n run: |\n # Generate a secure random API key (360 bits of entropy, 40+ chars)\n # Mask immediately to prevent timing vulnerabilities\n API_KEY=$(openssl rand -base64 45 | tr -d '/+=')\n echo \"::add-mask::${API_KEY}\"\n \n PORT=3001\n \n # Set outputs for next steps\n {\n echo \"safe_outputs_api_key=${API_KEY}\"\n echo \"safe_outputs_port=${PORT}\"\n } >> \"$GITHUB_OUTPUT\"\n \n echo \"Safe Outputs MCP server will run on port ${PORT}\"\n \n - name: Start Safe Outputs MCP HTTP Server\n id: safe-outputs-start\n env:\n DEBUG: '*'\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-config.outputs.safe_outputs_port }}\n GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-config.outputs.safe_outputs_api_key }}\n GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/tools.json\n GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/config.json\n GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs\n run: |\n # Environment variables are set above to prevent template injection\n export DEBUG\n export GH_AW_SAFE_OUTPUTS\n export GH_AW_SAFE_OUTPUTS_PORT\n export GH_AW_SAFE_OUTPUTS_API_KEY\n export GH_AW_SAFE_OUTPUTS_TOOLS_PATH\n export GH_AW_SAFE_OUTPUTS_CONFIG_PATH\n export GH_AW_MCP_LOG_DIR\n \n bash \"${RUNNER_TEMP}/gh-aw/actions/start_safe_outputs_server.sh\"\n \n - name: Start MCP Gateway\n id: start-mcp-gateway\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-start.outputs.api_key }}\n GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-start.outputs.port }}\n GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n run: |\n set -eo pipefail\n mkdir -p /tmp/gh-aw/mcp-config\n \n # Export gateway environment variables for MCP config and gateway script\n export MCP_GATEWAY_PORT=\"80\"\n export MCP_GATEWAY_DOMAIN=\"host.docker.internal\"\n MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=')\n echo \"::add-mask::${MCP_GATEWAY_API_KEY}\"\n export MCP_GATEWAY_API_KEY\n export MCP_GATEWAY_PAYLOAD_DIR=\"/tmp/gh-aw/mcp-payloads\"\n mkdir -p \"${MCP_GATEWAY_PAYLOAD_DIR}\"\n export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD=\"524288\"\n export DEBUG=\"*\"\n \n export GH_AW_ENGINE=\"copilot\"\n export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host -v /var/run/docker.sock:/var/run/docker.sock -e MCP_GATEWAY_PORT -e MCP_GATEWAY_DOMAIN -e MCP_GATEWAY_API_KEY -e MCP_GATEWAY_PAYLOAD_DIR -e MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD -e DEBUG -e MCP_GATEWAY_LOG_DIR -e GH_AW_MCP_LOG_DIR -e GH_AW_SAFE_OUTPUTS -e GH_AW_SAFE_OUTPUTS_CONFIG_PATH -e GH_AW_SAFE_OUTPUTS_TOOLS_PATH -e GH_AW_ASSETS_BRANCH -e GH_AW_ASSETS_MAX_SIZE_KB -e GH_AW_ASSETS_ALLOWED_EXTS -e DEFAULT_BRANCH -e GITHUB_MCP_SERVER_TOKEN -e GITHUB_MCP_GUARD_MIN_INTEGRITY -e GITHUB_MCP_GUARD_REPOS -e GITHUB_REPOSITORY -e GITHUB_SERVER_URL -e GITHUB_SHA -e GITHUB_WORKSPACE -e GITHUB_TOKEN -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RUN_ATTEMPT -e GITHUB_JOB -e GITHUB_ACTION -e GITHUB_EVENT_NAME -e GITHUB_EVENT_PATH -e GITHUB_ACTOR -e GITHUB_ACTOR_ID -e GITHUB_TRIGGERING_ACTOR -e GITHUB_WORKFLOW -e GITHUB_WORKFLOW_REF -e GITHUB_WORKFLOW_SHA -e GITHUB_REF -e GITHUB_REF_NAME -e GITHUB_REF_TYPE -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GH_AW_SAFE_OUTPUTS_PORT -e GH_AW_SAFE_OUTPUTS_API_KEY -v /tmp/gh-aw/mcp-payloads:/tmp/gh-aw/mcp-payloads:rw -v /opt:/opt:ro -v /tmp:/tmp:rw -v '\"${GITHUB_WORKSPACE}\"':'\"${GITHUB_WORKSPACE}\"':rw ghcr.io/github/gh-aw-mcpg:v0.2.17'\n \n mkdir -p /home/runner/.copilot\n cat << GH_AW_MCP_CONFIG_5ad084c2b5bc2d53_EOF | bash \"${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.sh\"\n {\n \"mcpServers\": {\n \"github\": {\n \"type\": \"stdio\",\n \"container\": \"ghcr.io/github/github-mcp-server:v0.32.0\",\n \"env\": {\n \"GITHUB_HOST\": \"\\${GITHUB_SERVER_URL}\",\n \"GITHUB_PERSONAL_ACCESS_TOKEN\": \"\\${GITHUB_MCP_SERVER_TOKEN}\",\n \"GITHUB_READ_ONLY\": \"1\",\n \"GITHUB_TOOLSETS\": \"context,repos,issues,pull_requests\"\n },\n \"guard-policies\": {\n \"allow-only\": {\n \"approval-labels\": ${{ steps.parse-guard-vars.outputs.approval_labels }},\n \"blocked-users\": ${{ steps.parse-guard-vars.outputs.blocked_users }},\n \"min-integrity\": \"none\",\n \"repos\": \"all\",\n \"trusted-users\": ${{ steps.parse-guard-vars.outputs.trusted_users }}\n }\n }\n },\n \"safeoutputs\": {\n \"type\": \"http\",\n \"url\": \"http://host.docker.internal:$GH_AW_SAFE_OUTPUTS_PORT\",\n \"headers\": {\n \"Authorization\": \"\\${GH_AW_SAFE_OUTPUTS_API_KEY}\"\n },\n \"guard-policies\": {\n \"write-sink\": {\n \"accept\": [\n \"*\"\n ]\n }\n }\n }\n },\n \"gateway\": {\n \"port\": $MCP_GATEWAY_PORT,\n \"domain\": \"${MCP_GATEWAY_DOMAIN}\",\n \"apiKey\": \"${MCP_GATEWAY_API_KEY}\",\n \"payloadDir\": \"${MCP_GATEWAY_PAYLOAD_DIR}\"\n }\n }\n GH_AW_MCP_CONFIG_5ad084c2b5bc2d53_EOF\n - name: Download activation artifact\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: activation\n path: /tmp/gh-aw\n - name: Clean git credentials\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/clean_git_credentials.sh\"\n - name: Execute GitHub Copilot CLI\n id: agentic_execution\n # Copilot CLI tool arguments (sorted):\n timeout-minutes: 10\n run: |\n set -o pipefail\n touch /tmp/gh-aw/agent-step-summary.md\n # shellcheck disable=SC1003\n sudo -E awf --container-workdir \"${GITHUB_WORKSPACE}\" --mount \"${RUNNER_TEMP}/gh-aw:${RUNNER_TEMP}/gh-aw:ro\" --mount \"${RUNNER_TEMP}/gh-aw:/host${RUNNER_TEMP}/gh-aw:ro\" --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --allow-domains api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --image-tag 0.25.18 --skip-pull --enable-api-proxy \\\n -- /bin/bash -c 'node ${RUNNER_TEMP}/gh-aw/actions/copilot_driver.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --allow-all-tools --allow-all-paths --add-dir \"${GITHUB_WORKSPACE}\" --prompt \"$(cat /tmp/gh-aw/aw-prompts/prompt.txt)\"' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log\n env:\n COPILOT_AGENT_RUNNER_TYPE: STANDALONE\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || '' }}\n GH_AW_MCP_CONFIG: /home/runner/.copilot/mcp-config.json\n GH_AW_PHASE: agent\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_VERSION: v0.67.4\n GITHUB_API_URL: ${{ github.api_url }}\n GITHUB_AW: true\n GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows\n GITHUB_HEAD_REF: ${{ github.head_ref }}\n GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n GITHUB_REF_NAME: ${{ github.ref_name }}\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md\n GITHUB_WORKSPACE: ${{ github.workspace }}\n GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_AUTHOR_NAME: github-actions[bot]\n GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_COMMITTER_NAME: github-actions[bot]\n XDG_CONFIG_HOME: /home/runner\n - name: Detect inference access error\n id: detect-inference-error\n if: always()\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/detect_inference_access_error.sh\"\n - name: Configure Git credentials\n env:\n REPO_NAME: ${{ github.repository }}\n SERVER_URL: ${{ github.server_url }}\n GITHUB_TOKEN: ${{ github.token }}\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git config --global am.keepcr true\n # Re-authenticate git with GitHub token\n SERVER_URL_STRIPPED=\"${SERVER_URL#https://}\"\n git remote set-url origin \"https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git\"\n echo \"Git configured with standard GitHub Actions identity\"\n - name: Copy Copilot session state files to logs\n if: always()\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/copy_copilot_session_state.sh\"\n - name: Stop MCP Gateway\n if: always()\n continue-on-error: true\n env:\n MCP_GATEWAY_PORT: ${{ steps.start-mcp-gateway.outputs.gateway-port }}\n MCP_GATEWAY_API_KEY: ${{ steps.start-mcp-gateway.outputs.gateway-api-key }}\n GATEWAY_PID: ${{ steps.start-mcp-gateway.outputs.gateway-pid }}\n run: |\n bash \"${RUNNER_TEMP}/gh-aw/actions/stop_mcp_gateway.sh\" \"$GATEWAY_PID\"\n - name: Redact secrets in logs\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs');\n await main();\n env:\n GH_AW_SECRET_NAMES: 'COPILOT_GITHUB_TOKEN,GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN'\n SECRET_COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }}\n SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }}\n SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n - name: Append agent step summary\n if: always()\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/append_agent_step_summary.sh\"\n - name: Copy Safe Outputs\n if: always()\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n run: |\n mkdir -p /tmp/gh-aw\n cp \"$GH_AW_SAFE_OUTPUTS\" /tmp/gh-aw/safeoutputs.jsonl 2>/dev/null || true\n - name: Ingest agent output\n id: collect_output\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_ALLOWED_DOMAINS: \"api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com\"\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_API_URL: ${{ github.api_url }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/collect_ndjson_output.cjs');\n await main();\n - name: Parse agent logs for step summary\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_copilot_log.cjs');\n await main();\n - name: Parse MCP Gateway logs for step summary\n if: always()\n id: parse-mcp-gateway\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_mcp_gateway_log.cjs');\n await main();\n - name: Print firewall logs\n if: always()\n continue-on-error: true\n env:\n AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs\n run: |\n # Fix permissions on firewall logs so they can be uploaded as artifacts\n # AWF runs with sudo, creating files owned by root\n sudo chmod -R a+r /tmp/gh-aw/sandbox/firewall/logs 2>/dev/null || true\n # Only run awf logs summary if awf command exists (it may not be installed if workflow failed before install step)\n if command -v awf &> /dev/null; then\n awf logs summary | tee -a \"$GITHUB_STEP_SUMMARY\"\n else\n echo 'AWF binary not installed, skipping firewall log summary'\n fi\n - name: Parse token usage for step summary\n if: always()\n continue-on-error: true\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs');\n await main();\n - name: Write agent output placeholder if missing\n if: always()\n run: |\n if [ ! -f /tmp/gh-aw/agent_output.json ]; then\n echo '{\"items\":[]}' > /tmp/gh-aw/agent_output.json\n fi\n - name: Upload agent artifacts\n if: always()\n continue-on-error: true\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: agent\n path: |\n /tmp/gh-aw/aw-prompts/prompt.txt\n /tmp/gh-aw/sandbox/agent/logs/\n /tmp/gh-aw/redacted-urls.log\n /tmp/gh-aw/mcp-logs/\n /tmp/gh-aw/proxy-logs/\n !/tmp/gh-aw/proxy-logs/proxy-tls/\n /tmp/gh-aw/agent_usage.json\n /tmp/gh-aw/agent-stdio.log\n /tmp/gh-aw/agent/\n /tmp/gh-aw/github_rate_limits.jsonl\n /tmp/gh-aw/safeoutputs.jsonl\n /tmp/gh-aw/agent_output.json\n /tmp/gh-aw/aw-*.patch\n /tmp/gh-aw/aw-*.bundle\n if-no-files-found: ignore\n - name: Upload firewall audit logs\n if: always()\n continue-on-error: true\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: firewall-audit-logs\n path: |\n /tmp/gh-aw/sandbox/firewall/logs/\n /tmp/gh-aw/sandbox/firewall/audit/\n if-no-files-found: ignore\n\n call-handle-bug:\n needs: safe_outputs\n if: needs.safe_outputs.outputs.call_workflow_name == 'handle-bug'\n permissions:\n actions: read\n contents: read\n discussions: write\n issues: write\n pull-requests: write\n uses: ./.github/workflows/handle-bug.lock.yml\n with:\n issue_number: ${{ fromJSON(needs.safe_outputs.outputs.call_workflow_payload).issue_number }}\n payload: ${{ needs.safe_outputs.outputs.call_workflow_payload }}\n secrets: inherit\n\n call-handle-documentation:\n needs: safe_outputs\n if: needs.safe_outputs.outputs.call_workflow_name == 'handle-documentation'\n permissions:\n actions: read\n contents: read\n discussions: write\n issues: write\n pull-requests: write\n uses: ./.github/workflows/handle-documentation.lock.yml\n with:\n issue_number: ${{ fromJSON(needs.safe_outputs.outputs.call_workflow_payload).issue_number }}\n payload: ${{ needs.safe_outputs.outputs.call_workflow_payload }}\n secrets: inherit\n\n call-handle-enhancement:\n needs: safe_outputs\n if: needs.safe_outputs.outputs.call_workflow_name == 'handle-enhancement'\n permissions:\n actions: read\n contents: read\n discussions: write\n issues: write\n pull-requests: write\n uses: ./.github/workflows/handle-enhancement.lock.yml\n with:\n issue_number: ${{ fromJSON(needs.safe_outputs.outputs.call_workflow_payload).issue_number }}\n payload: ${{ needs.safe_outputs.outputs.call_workflow_payload }}\n secrets: inherit\n\n call-handle-question:\n needs: safe_outputs\n if: needs.safe_outputs.outputs.call_workflow_name == 'handle-question'\n permissions:\n actions: read\n contents: read\n discussions: write\n issues: write\n pull-requests: write\n uses: ./.github/workflows/handle-question.lock.yml\n with:\n issue_number: ${{ fromJSON(needs.safe_outputs.outputs.call_workflow_payload).issue_number }}\n payload: ${{ needs.safe_outputs.outputs.call_workflow_payload }}\n secrets: inherit\n\n conclusion:\n needs:\n - activation\n - agent\n - call-handle-bug\n - call-handle-documentation\n - call-handle-enhancement\n - call-handle-question\n - detection\n - safe_outputs\n if: always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true')\n runs-on: ubuntu-slim\n permissions:\n contents: read\n discussions: write\n issues: write\n pull-requests: write\n concurrency:\n group: \"gh-aw-conclusion-issue-classification\"\n cancel-in-progress: false\n outputs:\n incomplete_count: ${{ steps.report_incomplete.outputs.incomplete_count }}\n noop_message: ${{ steps.noop.outputs.noop_message }}\n tools_reported: ${{ steps.missing_tool.outputs.tools_reported }}\n total_count: ${{ steps.missing_tool.outputs.total_count }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Process No-Op Messages\n id: noop\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_NOOP_MAX: \"1\"\n GH_AW_WORKFLOW_NAME: \"Issue Classification Agent\"\n GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\n GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }}\n GH_AW_NOOP_REPORT_AS_ISSUE: \"true\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_noop_message.cjs');\n await main();\n - name: Record missing tool\n id: missing_tool\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_MISSING_TOOL_CREATE_ISSUE: \"true\"\n GH_AW_WORKFLOW_NAME: \"Issue Classification Agent\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/missing_tool.cjs');\n await main();\n - name: Record incomplete\n id: report_incomplete\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_REPORT_INCOMPLETE_CREATE_ISSUE: \"true\"\n GH_AW_WORKFLOW_NAME: \"Issue Classification Agent\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/report_incomplete_handler.cjs');\n await main();\n - name: Handle agent failure\n id: handle_agent_failure\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_WORKFLOW_NAME: \"Issue Classification Agent\"\n GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\n GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }}\n GH_AW_WORKFLOW_ID: \"issue-classification\"\n GH_AW_ENGINE_ID: \"copilot\"\n GH_AW_SECRET_VERIFICATION_RESULT: ${{ needs.activation.outputs.secret_verification_result }}\n GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }}\n GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }}\n GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }}\n GH_AW_GROUP_REPORTS: \"false\"\n GH_AW_FAILURE_REPORT_AS_ISSUE: \"true\"\n GH_AW_TIMEOUT_MINUTES: \"10\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_agent_failure.cjs');\n await main();\n\n detection:\n needs:\n - activation\n - agent\n if: >\n always() && needs.agent.result != 'skipped' && (needs.agent.outputs.output_types != '' || needs.agent.outputs.has_patch == 'true')\n runs-on: ubuntu-latest\n permissions:\n contents: read\n outputs:\n detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }}\n detection_success: ${{ steps.detection_conclusion.outputs.success }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Checkout repository for patch context\n if: needs.agent.outputs.has_patch == 'true'\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n # --- Threat Detection ---\n - name: Download container images\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh\" ghcr.io/github/gh-aw-firewall/agent:0.25.18 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.18 ghcr.io/github/gh-aw-firewall/squid:0.25.18\n - name: Check if detection needed\n id: detection_guard\n if: always()\n env:\n OUTPUT_TYPES: ${{ needs.agent.outputs.output_types }}\n HAS_PATCH: ${{ needs.agent.outputs.has_patch }}\n run: |\n if [[ -n \"$OUTPUT_TYPES\" || \"$HAS_PATCH\" == \"true\" ]]; then\n echo \"run_detection=true\" >> \"$GITHUB_OUTPUT\"\n echo \"Detection will run: output_types=$OUTPUT_TYPES, has_patch=$HAS_PATCH\"\n else\n echo \"run_detection=false\" >> \"$GITHUB_OUTPUT\"\n echo \"Detection skipped: no agent outputs or patches to analyze\"\n fi\n - name: Clear MCP configuration for detection\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n rm -f /tmp/gh-aw/mcp-config/mcp-servers.json\n rm -f /home/runner/.copilot/mcp-config.json\n rm -f \"$GITHUB_WORKSPACE/.gemini/settings.json\"\n - name: Prepare threat detection files\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n mkdir -p /tmp/gh-aw/threat-detection/aw-prompts\n cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true\n cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true\n for f in /tmp/gh-aw/aw-*.patch; do\n [ -f \"$f\" ] && cp \"$f\" /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n done\n for f in /tmp/gh-aw/aw-*.bundle; do\n [ -f \"$f\" ] && cp \"$f\" /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n done\n echo \"Prepared threat detection files:\"\n ls -la /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n - name: Setup threat detection\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n WORKFLOW_NAME: \"Issue Classification Agent\"\n WORKFLOW_DESCRIPTION: \"Classifies newly opened issues and delegates to type-specific handler workflows\"\n HAS_PATCH: ${{ needs.agent.outputs.has_patch }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/setup_threat_detection.cjs');\n await main();\n - name: Ensure threat-detection directory and log\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n mkdir -p /tmp/gh-aw/threat-detection\n touch /tmp/gh-aw/threat-detection/detection.log\n - name: Install GitHub Copilot CLI\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh\" 1.0.20\n env:\n GH_HOST: github.com\n - name: Install AWF binary\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh\" v0.25.18\n - name: Execute GitHub Copilot CLI\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n id: detection_agentic_execution\n # Copilot CLI tool arguments (sorted):\n timeout-minutes: 20\n run: |\n set -o pipefail\n touch /tmp/gh-aw/agent-step-summary.md\n # shellcheck disable=SC1003\n sudo -E awf --container-workdir \"${GITHUB_WORKSPACE}\" --mount \"${RUNNER_TEMP}/gh-aw:${RUNNER_TEMP}/gh-aw:ro\" --mount \"${RUNNER_TEMP}/gh-aw:/host${RUNNER_TEMP}/gh-aw:ro\" --env-all --exclude-env COPILOT_GITHUB_TOKEN --allow-domains api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,github.com,host.docker.internal,telemetry.enterprise.githubcopilot.com --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --image-tag 0.25.18 --skip-pull --enable-api-proxy \\\n -- /bin/bash -c 'node ${RUNNER_TEMP}/gh-aw/actions/copilot_driver.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --allow-all-tools --add-dir \"${GITHUB_WORKSPACE}\" --prompt \"$(cat /tmp/gh-aw/aw-prompts/prompt.txt)\"' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log\n env:\n COPILOT_AGENT_RUNNER_TYPE: STANDALONE\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || '' }}\n GH_AW_PHASE: detection\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_VERSION: v0.67.4\n GITHUB_API_URL: ${{ github.api_url }}\n GITHUB_AW: true\n GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows\n GITHUB_HEAD_REF: ${{ github.head_ref }}\n GITHUB_REF_NAME: ${{ github.ref_name }}\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md\n GITHUB_WORKSPACE: ${{ github.workspace }}\n GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_AUTHOR_NAME: github-actions[bot]\n GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_COMMITTER_NAME: github-actions[bot]\n XDG_CONFIG_HOME: /home/runner\n - name: Upload threat detection log\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: detection\n path: /tmp/gh-aw/threat-detection/detection.log\n if-no-files-found: ignore\n - name: Parse and conclude threat detection\n id: detection_conclusion\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n RUN_DETECTION: ${{ steps.detection_guard.outputs.run_detection }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_threat_detection_results.cjs');\n await main();\n\n safe_outputs:\n needs:\n - activation\n - agent\n - detection\n if: (!cancelled()) && needs.agent.result != 'skipped' && needs.detection.result == 'success'\n runs-on: ubuntu-slim\n permissions:\n contents: read\n discussions: write\n issues: write\n pull-requests: write\n timeout-minutes: 15\n env:\n GH_AW_CALLER_WORKFLOW_ID: \"${{ github.repository }}/issue-classification\"\n GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens }}\n GH_AW_ENGINE_ID: \"copilot\"\n GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }}\n GH_AW_WORKFLOW_ID: \"issue-classification\"\n GH_AW_WORKFLOW_NAME: \"Issue Classification Agent\"\n outputs:\n call_workflow_name: ${{ steps.process_safe_outputs.outputs.call_workflow_name }}\n call_workflow_payload: ${{ steps.process_safe_outputs.outputs.call_workflow_payload }}\n code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }}\n code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }}\n comment_id: ${{ steps.process_safe_outputs.outputs.comment_id }}\n comment_url: ${{ steps.process_safe_outputs.outputs.comment_url }}\n create_discussion_error_count: ${{ steps.process_safe_outputs.outputs.create_discussion_error_count }}\n create_discussion_errors: ${{ steps.process_safe_outputs.outputs.create_discussion_errors }}\n process_safe_outputs_processed_count: ${{ steps.process_safe_outputs.outputs.processed_count }}\n process_safe_outputs_temporary_id_map: ${{ steps.process_safe_outputs.outputs.temporary_id_map }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Configure GH_HOST for enterprise compatibility\n id: ghes-host-config\n shell: bash\n run: |\n # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct\n # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op.\n GH_HOST=\"${GITHUB_SERVER_URL#https://}\"\n GH_HOST=\"${GH_HOST#http://}\"\n echo \"GH_HOST=${GH_HOST}\" >> \"$GITHUB_ENV\"\n - name: Process Safe Outputs\n id: process_safe_outputs\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_ALLOWED_DOMAINS: \"api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com\"\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_API_URL: ${{ github.api_url }}\n GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: \"{\\\"add_comment\\\":{\\\"max\\\":1,\\\"target\\\":\\\"triggering\\\"},\\\"call_workflow\\\":{\\\"max\\\":1,\\\"workflow_files\\\":{\\\"handle-bug\\\":\\\"./.github/workflows/handle-bug.lock.yml\\\",\\\"handle-documentation\\\":\\\"./.github/workflows/handle-documentation.lock.yml\\\",\\\"handle-enhancement\\\":\\\"./.github/workflows/handle-enhancement.lock.yml\\\",\\\"handle-question\\\":\\\"./.github/workflows/handle-question.lock.yml\\\"},\\\"workflows\\\":[\\\"handle-bug\\\",\\\"handle-enhancement\\\",\\\"handle-question\\\",\\\"handle-documentation\\\"]},\\\"create_report_incomplete_issue\\\":{},\\\"missing_data\\\":{},\\\"missing_tool\\\":{},\\\"noop\\\":{\\\"max\\\":1,\\\"report-as-issue\\\":\\\"true\\\"},\\\"report_incomplete\\\":{}}\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/safe_output_handler_manager.cjs');\n await main();\n - name: Upload Safe Outputs Items\n if: always()\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: safe-outputs-items\n path: /tmp/gh-aw/safe-output-items.jsonl\n if-no-files-found: ignore\n\n" }, { "path": ".github/workflows/issue-classification.md", "content": "---\ndescription: Classifies newly opened issues and delegates to type-specific handler workflows\non:\n issues:\n types: [opened]\n workflow_dispatch:\n inputs:\n issue_number:\n description: \"Issue number to triage\"\n required: true\n type: string\n roles: all\npermissions:\n contents: read\n issues: read\n pull-requests: read\ntools:\n github:\n toolsets: [default]\n min-integrity: none\nsafe-outputs:\n call-workflow: [handle-bug, handle-enhancement, handle-question, handle-documentation]\n add-comment:\n max: 1\n target: triggering\ntimeout-minutes: 10\n---\n\n# Issue Classification Agent\n\nYou are an AI agent that classifies newly opened issues in the copilot-sdk repository and delegates them to the appropriate handler.\n\nYour **only** job is to classify the issue and delegate to a handler workflow, or leave a comment if the issue can't be classified. You do not close issues or modify them in any other way.\n\n## Your Task\n\n1. Fetch the full issue content using GitHub tools\n2. Read the issue title, body, and author information\n3. Follow the classification instructions below to determine the correct classification\n4. Take action:\n - If the issue is a **bug**: call the `handle-bug` workflow with the issue number\n - If the issue is an **enhancement**: call the `handle-enhancement` workflow with the issue number\n - If the issue is a **question**: call the `handle-question` workflow with the issue number\n - If the issue is a **documentation** issue: call the `handle-documentation` workflow with the issue number\n - If the issue does **not** clearly fit any category: leave a brief comment explaining why the issue couldn't be classified and that a human will review it\n\nWhen calling a handler workflow, pass `issue_number` set to the issue number.\n\n## Issue Classification Instructions\n\nYou are classifying issues for the **copilot-sdk** repository — a multi-language SDK (Node.js/TypeScript, Python, Go, .NET) that communicates with the Copilot CLI via JSON-RPC.\n\n### Classifications\n\nClassify each issue into **exactly one** of the following categories. If none fit, see \"Unclassifiable Issues\" below.\n\n#### `bug`\nSomething isn't working correctly. The issue describes unexpected behavior, errors, crashes, or regressions in existing functionality.\n\nExamples:\n- \"Session creation fails with timeout error\"\n- \"Python SDK throws TypeError when streaming is enabled\"\n- \"Go client panics on malformed JSON-RPC response\"\n\n#### `enhancement`\nA request for new functionality or improvement to existing behavior. The issue proposes something that doesn't exist yet or asks for a change in how something works.\n\nExamples:\n- \"Add retry logic to the Node.js client\"\n- \"Support custom headers in the .NET SDK\"\n- \"Allow configuring connection timeout per-session\"\n\n#### `question`\nA general question about SDK usage, behavior, or capabilities. The author is seeking help or clarification, not reporting a problem or requesting a feature.\n\nExamples:\n- \"How do I use streaming with the Python SDK?\"\n- \"What's the difference between create and resume session?\"\n- \"Is there a way to set custom tool permissions?\"\n\n#### `documentation`\nThe issue relates to documentation — missing docs, incorrect docs, unclear explanations, or requests for new documentation.\n\nExamples:\n- \"README is missing Go SDK installation steps\"\n- \"API reference for session.ui is outdated\"\n- \"Add migration guide from v1 to v2\"\n\n### Unclassifiable Issues\n\nIf the issue doesn't clearly fit any of the above categories (e.g., meta discussions, process questions, infrastructure issues, license questions), do **not** delegate to a handler. Instead, leave a brief comment explaining why the issue couldn't be automatically classified and that a human will review it.\n\n### Classification Guidelines\n\n1. **Read the full issue** — title, body, and any initial comments from the author.\n2. **Be skeptical of the author's framing** — users often mislabel their own issues. Someone may claim something is a \"bug\" when the product is working as designed (making it an enhancement). Classify based on the actual content, not the author's label.\n3. **When in doubt between `bug` and `question`** — if the author is unsure whether something is a bug or they're using the SDK incorrectly, classify as `bug`. It's easier to reclassify later.\n4. **When in doubt between `enhancement` and `bug`** — if the author describes behavior they find undesirable but the SDK is working as designed, classify as `enhancement`. This applies even if the author explicitly calls it a bug — what matters is whether the current behavior is actually broken or functioning as intended.\n5. **Classify into exactly one category** — never delegate to two handlers for the same issue.\n6. **Verify whether reported behavior is actually a bug** — confirm that the described behavior is genuinely broken before classifying as `bug`. If the product is working as designed, classify as `enhancement` instead. Do not assess reproducibility, priority, or duplicates — those are for downstream handlers.\n\n### Repository Context\n\nThe copilot-sdk is a monorepo with four SDK implementations:\n\n- **Node.js/TypeScript** (`nodejs/src/`): The primary/reference implementation\n- **Python** (`python/copilot/`): Python SDK with async support\n- **Go** (`go/`): Go SDK with OpenTelemetry integration\n- **.NET** (`dotnet/src/`): .NET SDK targeting net8.0\n\nCommon areas of issues:\n- **JSON-RPC client**: Session creation, resumption, event handling\n- **Streaming**: Delta events, message completion, reasoning events\n- **Tools**: Tool definition, execution, permissions\n- **Type generation**: Generated types from `@github/copilot` schema\n- **E2E testing**: Test harness, replay proxy, snapshot fixtures\n- **UI elicitation**: Confirm, select, input dialogs via session.ui\n\n## Context\n\n- Repository: ${{ github.repository }}\n- Issue number: ${{ github.event.issue.number || inputs.issue_number }}\n- Issue title: ${{ github.event.issue.title }}\n\nUse the GitHub tools to fetch the full issue details, especially when triggered manually via `workflow_dispatch`.\n" }, { "path": ".github/workflows/issue-triage.lock.yml", "content": "# gh-aw-metadata: {\"schema_version\":\"v3\",\"frontmatter_hash\":\"22ed351fca21814391eea23a7470028e8321a9e2fe21fb95e31b13d0353aee4b\",\"compiler_version\":\"v0.67.4\",\"strict\":true,\"agent_id\":\"copilot\"}\n# gh-aw-manifest: {\"version\":1,\"secrets\":[\"COPILOT_GITHUB_TOKEN\",\"GH_AW_GITHUB_MCP_SERVER_TOKEN\",\"GH_AW_GITHUB_TOKEN\",\"GITHUB_TOKEN\"],\"actions\":[{\"repo\":\"actions/checkout\",\"sha\":\"de0fac2e4500dabe0009e67214ff5f5447ce83dd\",\"version\":\"v6.0.2\"},{\"repo\":\"actions/download-artifact\",\"sha\":\"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c\",\"version\":\"v8.0.1\"},{\"repo\":\"actions/github-script\",\"sha\":\"ed597411d8f924073f98dfc5c65a23a2325f34cd\",\"version\":\"v8\"},{\"repo\":\"actions/upload-artifact\",\"sha\":\"bbbca2ddaa5d8feaa63e36b76fdaad77386f024f\",\"version\":\"v7\"},{\"repo\":\"github/gh-aw-actions/setup\",\"sha\":\"9d6ae06250fc0ec536a0e5f35de313b35bad7246\",\"version\":\"v0.67.4\"}]}\n# ___ _ _ \n# / _ \\ | | (_) \n# | |_| | __ _ ___ _ __ | |_ _ ___ \n# | _ |/ _` |/ _ \\ '_ \\| __| |/ __|\n# | | | | (_| | __/ | | | |_| | (__ \n# \\_| |_/\\__, |\\___|_| |_|\\__|_|\\___|\n# __/ |\n# _ _ |___/ \n# | | | | / _| |\n# | | | | ___ _ __ _ __| |_| | _____ ____\n# | |/\\| |/ _ \\ '__| |/ /| _| |/ _ \\ \\ /\\ / / ___|\n# \\ /\\ / (_) | | | | ( | | | | (_) \\ V V /\\__ \\\n# \\/ \\/ \\___/|_| |_|\\_\\|_| |_|\\___/ \\_/\\_/ |___/\n#\n# This file was automatically generated by gh-aw (v0.67.4). DO NOT EDIT.\n#\n# To update this file, edit the corresponding .md file and run:\n# gh aw compile\n# Not all edits will cause changes to this file.\n#\n# For more information: https://github.github.com/gh-aw/introduction/overview/\n#\n# Triages newly opened issues by labeling, acknowledging, requesting clarification, and closing duplicates\n#\n# Secrets used:\n# - COPILOT_GITHUB_TOKEN\n# - GH_AW_GITHUB_MCP_SERVER_TOKEN\n# - GH_AW_GITHUB_TOKEN\n# - GITHUB_TOKEN\n#\n# Custom actions used:\n# - actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n# - actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n# - actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n# - actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n# - github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n\nname: \"Issue Triage Agent\"\n\"on\":\n issues:\n types:\n - opened\n # roles: all # Roles processed as role check in pre-activation job\n workflow_dispatch:\n inputs:\n aw_context:\n default: \"\"\n description: Agent caller context (used internally by Agentic Workflows).\n required: false\n type: string\n issue_number:\n description: Issue number to triage\n required: true\n type: string\n\npermissions: {}\n\nconcurrency:\n group: \"gh-aw-${{ github.workflow }}-${{ github.event.issue.number || github.run_id }}\"\n\nrun-name: \"Issue Triage Agent\"\n\njobs:\n activation:\n runs-on: ubuntu-slim\n permissions:\n actions: read\n contents: read\n outputs:\n body: ${{ steps.sanitized.outputs.body }}\n comment_id: \"\"\n comment_repo: \"\"\n lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }}\n model: ${{ steps.generate_aw_info.outputs.model }}\n secret_verification_result: ${{ steps.validate-secret.outputs.verification_result }}\n setup-trace-id: ${{ steps.setup.outputs.trace-id }}\n text: ${{ steps.sanitized.outputs.text }}\n title: ${{ steps.sanitized.outputs.title }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n - name: Generate agentic run info\n id: generate_aw_info\n env:\n GH_AW_INFO_ENGINE_ID: \"copilot\"\n GH_AW_INFO_ENGINE_NAME: \"GitHub Copilot CLI\"\n GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'auto' }}\n GH_AW_INFO_VERSION: \"1.0.20\"\n GH_AW_INFO_AGENT_VERSION: \"1.0.20\"\n GH_AW_INFO_CLI_VERSION: \"v0.67.4\"\n GH_AW_INFO_WORKFLOW_NAME: \"Issue Triage Agent\"\n GH_AW_INFO_EXPERIMENTAL: \"false\"\n GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: \"true\"\n GH_AW_INFO_STAGED: \"false\"\n GH_AW_INFO_ALLOWED_DOMAINS: '[\"defaults\"]'\n GH_AW_INFO_FIREWALL_ENABLED: \"true\"\n GH_AW_INFO_AWF_VERSION: \"v0.25.18\"\n GH_AW_INFO_AWMG_VERSION: \"\"\n GH_AW_INFO_FIREWALL_TYPE: \"squid\"\n GH_AW_COMPILED_STRICT: \"true\"\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs');\n await main(core, context);\n - name: Validate COPILOT_GITHUB_TOKEN secret\n id: validate-secret\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/validate_multi_secret.sh\" COPILOT_GITHUB_TOKEN 'GitHub Copilot CLI' https://github.github.com/gh-aw/reference/engines/#github-copilot-default\n env:\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n - name: Checkout .github and .agents folders\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n sparse-checkout: |\n .github\n .agents\n sparse-checkout-cone-mode: true\n fetch-depth: 1\n - name: Check workflow lock file\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_WORKFLOW_FILE: \"issue-triage.lock.yml\"\n GH_AW_CONTEXT_WORKFLOW_REF: \"${{ github.workflow_ref }}\"\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/check_workflow_timestamp_api.cjs');\n await main();\n - name: Check compile-agentic version\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_COMPILED_VERSION: \"v0.67.4\"\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/check_version_updates.cjs');\n await main();\n - name: Compute current body text\n id: sanitized\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/compute_text.cjs');\n await main();\n - name: Create prompt with built-in context\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_SAFE_OUTPUTS: ${{ runner.temp }}/gh-aw/safeoutputs/outputs.jsonl\n GH_AW_EXPR_54492A5B: ${{ github.event.issue.number || inputs.issue_number }}\n GH_AW_GITHUB_ACTOR: ${{ github.actor }}\n GH_AW_GITHUB_EVENT_COMMENT_ID: ${{ github.event.comment.id }}\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: ${{ github.event.discussion.number }}\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: ${{ github.event.issue.number }}\n GH_AW_GITHUB_EVENT_ISSUE_TITLE: ${{ github.event.issue.title }}\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n GH_AW_GITHUB_RUN_ID: ${{ github.run_id }}\n GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }}\n # poutine:ignore untrusted_checkout_exec\n run: |\n bash \"${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh\"\n {\n cat << 'GH_AW_PROMPT_e74a3944dc48d8ab_EOF'\n \n GH_AW_PROMPT_e74a3944dc48d8ab_EOF\n cat \"${RUNNER_TEMP}/gh-aw/prompts/xpia.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/markdown.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md\"\n cat << 'GH_AW_PROMPT_e74a3944dc48d8ab_EOF'\n \n Tools: add_comment(max:2), close_issue, update_issue, add_labels(max:10), missing_tool, missing_data, noop\n \n \n The following GitHub context information is available for this workflow:\n {{#if __GH_AW_GITHUB_ACTOR__ }}\n - **actor**: __GH_AW_GITHUB_ACTOR__\n {{/if}}\n {{#if __GH_AW_GITHUB_REPOSITORY__ }}\n - **repository**: __GH_AW_GITHUB_REPOSITORY__\n {{/if}}\n {{#if __GH_AW_GITHUB_WORKSPACE__ }}\n - **workspace**: __GH_AW_GITHUB_WORKSPACE__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_ISSUE_NUMBER__ }}\n - **issue-number**: #__GH_AW_GITHUB_EVENT_ISSUE_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER__ }}\n - **discussion-number**: #__GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER__ }}\n - **pull-request-number**: #__GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_COMMENT_ID__ }}\n - **comment-id**: __GH_AW_GITHUB_EVENT_COMMENT_ID__\n {{/if}}\n {{#if __GH_AW_GITHUB_RUN_ID__ }}\n - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__\n {{/if}}\n \n \n GH_AW_PROMPT_e74a3944dc48d8ab_EOF\n cat \"${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md\"\n cat << 'GH_AW_PROMPT_e74a3944dc48d8ab_EOF'\n \n {{#runtime-import .github/workflows/issue-triage.md}}\n GH_AW_PROMPT_e74a3944dc48d8ab_EOF\n } > \"$GH_AW_PROMPT\"\n - name: Interpolate variables and render templates\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_EXPR_54492A5B: ${{ github.event.issue.number || inputs.issue_number }}\n GH_AW_GITHUB_EVENT_ISSUE_TITLE: ${{ github.event.issue.title }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/interpolate_prompt.cjs');\n await main();\n - name: Substitute placeholders\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_EXPR_54492A5B: ${{ github.event.issue.number || inputs.issue_number }}\n GH_AW_GITHUB_ACTOR: ${{ github.actor }}\n GH_AW_GITHUB_EVENT_COMMENT_ID: ${{ github.event.comment.id }}\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: ${{ github.event.discussion.number }}\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: ${{ github.event.issue.number }}\n GH_AW_GITHUB_EVENT_ISSUE_TITLE: ${{ github.event.issue.title }}\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n GH_AW_GITHUB_RUN_ID: ${{ github.run_id }}\n GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n \n const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs');\n \n // Call the substitution function\n return await substitutePlaceholders({\n file: process.env.GH_AW_PROMPT,\n substitutions: {\n GH_AW_EXPR_54492A5B: process.env.GH_AW_EXPR_54492A5B,\n GH_AW_GITHUB_ACTOR: process.env.GH_AW_GITHUB_ACTOR,\n GH_AW_GITHUB_EVENT_COMMENT_ID: process.env.GH_AW_GITHUB_EVENT_COMMENT_ID,\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: process.env.GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER,\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: process.env.GH_AW_GITHUB_EVENT_ISSUE_NUMBER,\n GH_AW_GITHUB_EVENT_ISSUE_TITLE: process.env.GH_AW_GITHUB_EVENT_ISSUE_TITLE,\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: process.env.GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER,\n GH_AW_GITHUB_REPOSITORY: process.env.GH_AW_GITHUB_REPOSITORY,\n GH_AW_GITHUB_RUN_ID: process.env.GH_AW_GITHUB_RUN_ID,\n GH_AW_GITHUB_WORKSPACE: process.env.GH_AW_GITHUB_WORKSPACE\n }\n });\n - name: Validate prompt placeholders\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n # poutine:ignore untrusted_checkout_exec\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/validate_prompt_placeholders.sh\"\n - name: Print prompt\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n # poutine:ignore untrusted_checkout_exec\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/print_prompt_summary.sh\"\n - name: Upload activation artifact\n if: success()\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: activation\n path: |\n /tmp/gh-aw/aw_info.json\n /tmp/gh-aw/aw-prompts/prompt.txt\n /tmp/gh-aw/github_rate_limits.jsonl\n if-no-files-found: ignore\n retention-days: 1\n\n agent:\n needs: activation\n runs-on: ubuntu-latest\n permissions:\n contents: read\n issues: read\n pull-requests: read\n env:\n DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}\n GH_AW_ASSETS_ALLOWED_EXTS: \"\"\n GH_AW_ASSETS_BRANCH: \"\"\n GH_AW_ASSETS_MAX_SIZE_KB: 0\n GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs\n GH_AW_WORKFLOW_ID_SANITIZED: issuetriage\n outputs:\n checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }}\n effective_tokens: ${{ steps.parse-mcp-gateway.outputs.effective_tokens }}\n has_patch: ${{ steps.collect_output.outputs.has_patch }}\n inference_access_error: ${{ steps.detect-inference-error.outputs.inference_access_error || 'false' }}\n model: ${{ needs.activation.outputs.model }}\n output: ${{ steps.collect_output.outputs.output }}\n output_types: ${{ steps.collect_output.outputs.output_types }}\n setup-trace-id: ${{ steps.setup.outputs.trace-id }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Set runtime paths\n id: set-runtime-paths\n run: |\n echo \"GH_AW_SAFE_OUTPUTS=${RUNNER_TEMP}/gh-aw/safeoutputs/outputs.jsonl\" >> \"$GITHUB_OUTPUT\"\n echo \"GH_AW_SAFE_OUTPUTS_CONFIG_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/config.json\" >> \"$GITHUB_OUTPUT\"\n echo \"GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json\" >> \"$GITHUB_OUTPUT\"\n - name: Checkout repository\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n - name: Create gh-aw temp directory\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/create_gh_aw_tmp_dir.sh\"\n - name: Configure gh CLI for GitHub Enterprise\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh\"\n env:\n GH_TOKEN: ${{ github.token }}\n - name: Configure Git credentials\n env:\n REPO_NAME: ${{ github.repository }}\n SERVER_URL: ${{ github.server_url }}\n GITHUB_TOKEN: ${{ github.token }}\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git config --global am.keepcr true\n # Re-authenticate git with GitHub token\n SERVER_URL_STRIPPED=\"${SERVER_URL#https://}\"\n git remote set-url origin \"https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git\"\n echo \"Git configured with standard GitHub Actions identity\"\n - name: Checkout PR branch\n id: checkout-pr\n if: |\n github.event.pull_request || github.event.issue.pull_request\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs');\n await main();\n - name: Install GitHub Copilot CLI\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh\" 1.0.20\n env:\n GH_HOST: github.com\n - name: Install AWF binary\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh\" v0.25.18\n - name: Determine automatic lockdown mode for GitHub MCP Server\n id: determine-automatic-lockdown\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }}\n GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }}\n with:\n script: |\n const determineAutomaticLockdown = require('${{ runner.temp }}/gh-aw/actions/determine_automatic_lockdown.cjs');\n await determineAutomaticLockdown(github, context, core);\n - name: Download container images\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh\" ghcr.io/github/gh-aw-firewall/agent:0.25.18 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.18 ghcr.io/github/gh-aw-firewall/squid:0.25.18 ghcr.io/github/gh-aw-mcpg:v0.2.17 ghcr.io/github/github-mcp-server:v0.32.0 node:lts-alpine\n - name: Write Safe Outputs Config\n run: |\n mkdir -p \"${RUNNER_TEMP}/gh-aw/safeoutputs\"\n mkdir -p /tmp/gh-aw/safeoutputs\n mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs\n cat > \"${RUNNER_TEMP}/gh-aw/safeoutputs/config.json\" << 'GH_AW_SAFE_OUTPUTS_CONFIG_6607c9cdef4a0243_EOF'\n {\"add_comment\":{\"max\":2},\"add_labels\":{\"allowed\":[\"bug\",\"enhancement\",\"question\",\"documentation\",\"sdk/dotnet\",\"sdk/go\",\"sdk/nodejs\",\"sdk/python\",\"priority/high\",\"priority/low\",\"testing\",\"security\",\"needs-info\",\"duplicate\"],\"max\":10,\"target\":\"triggering\"},\"close_issue\":{\"max\":1,\"target\":\"triggering\"},\"create_report_incomplete_issue\":{},\"missing_data\":{},\"missing_tool\":{},\"noop\":{\"max\":1,\"report-as-issue\":\"true\"},\"report_incomplete\":{},\"update_issue\":{\"allow_body\":true,\"max\":1,\"target\":\"triggering\"}}\n GH_AW_SAFE_OUTPUTS_CONFIG_6607c9cdef4a0243_EOF\n - name: Write Safe Outputs Tools\n env:\n GH_AW_TOOLS_META_JSON: |\n {\n \"description_suffixes\": {\n \"add_comment\": \" CONSTRAINTS: Maximum 2 comment(s) can be added.\",\n \"add_labels\": \" CONSTRAINTS: Maximum 10 label(s) can be added. Only these labels are allowed: [\\\"bug\\\" \\\"enhancement\\\" \\\"question\\\" \\\"documentation\\\" \\\"sdk/dotnet\\\" \\\"sdk/go\\\" \\\"sdk/nodejs\\\" \\\"sdk/python\\\" \\\"priority/high\\\" \\\"priority/low\\\" \\\"testing\\\" \\\"security\\\" \\\"needs-info\\\" \\\"duplicate\\\"]. Target: triggering.\",\n \"close_issue\": \" CONSTRAINTS: Maximum 1 issue(s) can be closed. Target: triggering.\",\n \"update_issue\": \" CONSTRAINTS: Maximum 1 issue(s) can be updated. Target: triggering.\"\n },\n \"repo_params\": {},\n \"dynamic_tools\": []\n }\n GH_AW_VALIDATION_JSON: |\n {\n \"add_comment\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"body\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"item_number\": {\n \"issueOrPRNumber\": true\n },\n \"repo\": {\n \"type\": \"string\",\n \"maxLength\": 256\n }\n }\n },\n \"add_labels\": {\n \"defaultMax\": 5,\n \"fields\": {\n \"item_number\": {\n \"issueNumberOrTemporaryId\": true\n },\n \"labels\": {\n \"required\": true,\n \"type\": \"array\",\n \"itemType\": \"string\",\n \"itemSanitize\": true,\n \"itemMaxLength\": 128\n },\n \"repo\": {\n \"type\": \"string\",\n \"maxLength\": 256\n }\n }\n },\n \"close_issue\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"body\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"issue_number\": {\n \"optionalPositiveInteger\": true\n },\n \"repo\": {\n \"type\": \"string\",\n \"maxLength\": 256\n }\n }\n },\n \"missing_data\": {\n \"defaultMax\": 20,\n \"fields\": {\n \"alternatives\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"context\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"data_type\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n },\n \"reason\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n }\n }\n },\n \"missing_tool\": {\n \"defaultMax\": 20,\n \"fields\": {\n \"alternatives\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 512\n },\n \"reason\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"tool\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n }\n }\n },\n \"noop\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"message\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n }\n }\n },\n \"report_incomplete\": {\n \"defaultMax\": 5,\n \"fields\": {\n \"details\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"reason\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 1024\n }\n }\n },\n \"update_issue\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"assignees\": {\n \"type\": \"array\",\n \"itemType\": \"string\",\n \"itemSanitize\": true,\n \"itemMaxLength\": 39\n },\n \"body\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"issue_number\": {\n \"issueOrPRNumber\": true\n },\n \"labels\": {\n \"type\": \"array\",\n \"itemType\": \"string\",\n \"itemSanitize\": true,\n \"itemMaxLength\": 128\n },\n \"milestone\": {\n \"optionalPositiveInteger\": true\n },\n \"operation\": {\n \"type\": \"string\",\n \"enum\": [\n \"replace\",\n \"append\",\n \"prepend\",\n \"replace-island\"\n ]\n },\n \"repo\": {\n \"type\": \"string\",\n \"maxLength\": 256\n },\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"open\",\n \"closed\"\n ]\n },\n \"title\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n }\n },\n \"customValidation\": \"requiresOneOf:status,title,body\"\n }\n }\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_safe_outputs_tools.cjs');\n await main();\n - name: Generate Safe Outputs MCP Server Config\n id: safe-outputs-config\n run: |\n # Generate a secure random API key (360 bits of entropy, 40+ chars)\n # Mask immediately to prevent timing vulnerabilities\n API_KEY=$(openssl rand -base64 45 | tr -d '/+=')\n echo \"::add-mask::${API_KEY}\"\n \n PORT=3001\n \n # Set outputs for next steps\n {\n echo \"safe_outputs_api_key=${API_KEY}\"\n echo \"safe_outputs_port=${PORT}\"\n } >> \"$GITHUB_OUTPUT\"\n \n echo \"Safe Outputs MCP server will run on port ${PORT}\"\n \n - name: Start Safe Outputs MCP HTTP Server\n id: safe-outputs-start\n env:\n DEBUG: '*'\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-config.outputs.safe_outputs_port }}\n GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-config.outputs.safe_outputs_api_key }}\n GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/tools.json\n GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/config.json\n GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs\n run: |\n # Environment variables are set above to prevent template injection\n export DEBUG\n export GH_AW_SAFE_OUTPUTS\n export GH_AW_SAFE_OUTPUTS_PORT\n export GH_AW_SAFE_OUTPUTS_API_KEY\n export GH_AW_SAFE_OUTPUTS_TOOLS_PATH\n export GH_AW_SAFE_OUTPUTS_CONFIG_PATH\n export GH_AW_MCP_LOG_DIR\n \n bash \"${RUNNER_TEMP}/gh-aw/actions/start_safe_outputs_server.sh\"\n \n - name: Start MCP Gateway\n id: start-mcp-gateway\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-start.outputs.api_key }}\n GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-start.outputs.port }}\n GITHUB_MCP_GUARD_MIN_INTEGRITY: ${{ steps.determine-automatic-lockdown.outputs.min_integrity }}\n GITHUB_MCP_GUARD_REPOS: ${{ steps.determine-automatic-lockdown.outputs.repos }}\n GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n run: |\n set -eo pipefail\n mkdir -p /tmp/gh-aw/mcp-config\n \n # Export gateway environment variables for MCP config and gateway script\n export MCP_GATEWAY_PORT=\"80\"\n export MCP_GATEWAY_DOMAIN=\"host.docker.internal\"\n MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=')\n echo \"::add-mask::${MCP_GATEWAY_API_KEY}\"\n export MCP_GATEWAY_API_KEY\n export MCP_GATEWAY_PAYLOAD_DIR=\"/tmp/gh-aw/mcp-payloads\"\n mkdir -p \"${MCP_GATEWAY_PAYLOAD_DIR}\"\n export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD=\"524288\"\n export DEBUG=\"*\"\n \n export GH_AW_ENGINE=\"copilot\"\n export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host -v /var/run/docker.sock:/var/run/docker.sock -e MCP_GATEWAY_PORT -e MCP_GATEWAY_DOMAIN -e MCP_GATEWAY_API_KEY -e MCP_GATEWAY_PAYLOAD_DIR -e MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD -e DEBUG -e MCP_GATEWAY_LOG_DIR -e GH_AW_MCP_LOG_DIR -e GH_AW_SAFE_OUTPUTS -e GH_AW_SAFE_OUTPUTS_CONFIG_PATH -e GH_AW_SAFE_OUTPUTS_TOOLS_PATH -e GH_AW_ASSETS_BRANCH -e GH_AW_ASSETS_MAX_SIZE_KB -e GH_AW_ASSETS_ALLOWED_EXTS -e DEFAULT_BRANCH -e GITHUB_MCP_SERVER_TOKEN -e GITHUB_MCP_GUARD_MIN_INTEGRITY -e GITHUB_MCP_GUARD_REPOS -e GITHUB_REPOSITORY -e GITHUB_SERVER_URL -e GITHUB_SHA -e GITHUB_WORKSPACE -e GITHUB_TOKEN -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RUN_ATTEMPT -e GITHUB_JOB -e GITHUB_ACTION -e GITHUB_EVENT_NAME -e GITHUB_EVENT_PATH -e GITHUB_ACTOR -e GITHUB_ACTOR_ID -e GITHUB_TRIGGERING_ACTOR -e GITHUB_WORKFLOW -e GITHUB_WORKFLOW_REF -e GITHUB_WORKFLOW_SHA -e GITHUB_REF -e GITHUB_REF_NAME -e GITHUB_REF_TYPE -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GH_AW_SAFE_OUTPUTS_PORT -e GH_AW_SAFE_OUTPUTS_API_KEY -v /tmp/gh-aw/mcp-payloads:/tmp/gh-aw/mcp-payloads:rw -v /opt:/opt:ro -v /tmp:/tmp:rw -v '\"${GITHUB_WORKSPACE}\"':'\"${GITHUB_WORKSPACE}\"':rw ghcr.io/github/gh-aw-mcpg:v0.2.17'\n \n mkdir -p /home/runner/.copilot\n cat << GH_AW_MCP_CONFIG_b6b29985f1ee0a9c_EOF | bash \"${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.sh\"\n {\n \"mcpServers\": {\n \"github\": {\n \"type\": \"stdio\",\n \"container\": \"ghcr.io/github/github-mcp-server:v0.32.0\",\n \"env\": {\n \"GITHUB_HOST\": \"\\${GITHUB_SERVER_URL}\",\n \"GITHUB_PERSONAL_ACCESS_TOKEN\": \"\\${GITHUB_MCP_SERVER_TOKEN}\",\n \"GITHUB_READ_ONLY\": \"1\",\n \"GITHUB_TOOLSETS\": \"context,repos,issues,pull_requests\"\n },\n \"guard-policies\": {\n \"allow-only\": {\n \"min-integrity\": \"$GITHUB_MCP_GUARD_MIN_INTEGRITY\",\n \"repos\": \"$GITHUB_MCP_GUARD_REPOS\"\n }\n }\n },\n \"safeoutputs\": {\n \"type\": \"http\",\n \"url\": \"http://host.docker.internal:$GH_AW_SAFE_OUTPUTS_PORT\",\n \"headers\": {\n \"Authorization\": \"\\${GH_AW_SAFE_OUTPUTS_API_KEY}\"\n },\n \"guard-policies\": {\n \"write-sink\": {\n \"accept\": [\n \"*\"\n ]\n }\n }\n }\n },\n \"gateway\": {\n \"port\": $MCP_GATEWAY_PORT,\n \"domain\": \"${MCP_GATEWAY_DOMAIN}\",\n \"apiKey\": \"${MCP_GATEWAY_API_KEY}\",\n \"payloadDir\": \"${MCP_GATEWAY_PAYLOAD_DIR}\"\n }\n }\n GH_AW_MCP_CONFIG_b6b29985f1ee0a9c_EOF\n - name: Download activation artifact\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: activation\n path: /tmp/gh-aw\n - name: Clean git credentials\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/clean_git_credentials.sh\"\n - name: Execute GitHub Copilot CLI\n id: agentic_execution\n # Copilot CLI tool arguments (sorted):\n timeout-minutes: 10\n run: |\n set -o pipefail\n touch /tmp/gh-aw/agent-step-summary.md\n # shellcheck disable=SC1003\n sudo -E awf --container-workdir \"${GITHUB_WORKSPACE}\" --mount \"${RUNNER_TEMP}/gh-aw:${RUNNER_TEMP}/gh-aw:ro\" --mount \"${RUNNER_TEMP}/gh-aw:/host${RUNNER_TEMP}/gh-aw:ro\" --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --allow-domains api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --image-tag 0.25.18 --skip-pull --enable-api-proxy \\\n -- /bin/bash -c 'node ${RUNNER_TEMP}/gh-aw/actions/copilot_driver.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --allow-all-tools --allow-all-paths --add-dir \"${GITHUB_WORKSPACE}\" --prompt \"$(cat /tmp/gh-aw/aw-prompts/prompt.txt)\"' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log\n env:\n COPILOT_AGENT_RUNNER_TYPE: STANDALONE\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || '' }}\n GH_AW_MCP_CONFIG: /home/runner/.copilot/mcp-config.json\n GH_AW_PHASE: agent\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_VERSION: v0.67.4\n GITHUB_API_URL: ${{ github.api_url }}\n GITHUB_AW: true\n GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows\n GITHUB_HEAD_REF: ${{ github.head_ref }}\n GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n GITHUB_REF_NAME: ${{ github.ref_name }}\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md\n GITHUB_WORKSPACE: ${{ github.workspace }}\n GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_AUTHOR_NAME: github-actions[bot]\n GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_COMMITTER_NAME: github-actions[bot]\n XDG_CONFIG_HOME: /home/runner\n - name: Detect inference access error\n id: detect-inference-error\n if: always()\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/detect_inference_access_error.sh\"\n - name: Configure Git credentials\n env:\n REPO_NAME: ${{ github.repository }}\n SERVER_URL: ${{ github.server_url }}\n GITHUB_TOKEN: ${{ github.token }}\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git config --global am.keepcr true\n # Re-authenticate git with GitHub token\n SERVER_URL_STRIPPED=\"${SERVER_URL#https://}\"\n git remote set-url origin \"https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git\"\n echo \"Git configured with standard GitHub Actions identity\"\n - name: Copy Copilot session state files to logs\n if: always()\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/copy_copilot_session_state.sh\"\n - name: Stop MCP Gateway\n if: always()\n continue-on-error: true\n env:\n MCP_GATEWAY_PORT: ${{ steps.start-mcp-gateway.outputs.gateway-port }}\n MCP_GATEWAY_API_KEY: ${{ steps.start-mcp-gateway.outputs.gateway-api-key }}\n GATEWAY_PID: ${{ steps.start-mcp-gateway.outputs.gateway-pid }}\n run: |\n bash \"${RUNNER_TEMP}/gh-aw/actions/stop_mcp_gateway.sh\" \"$GATEWAY_PID\"\n - name: Redact secrets in logs\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs');\n await main();\n env:\n GH_AW_SECRET_NAMES: 'COPILOT_GITHUB_TOKEN,GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN'\n SECRET_COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }}\n SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }}\n SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n - name: Append agent step summary\n if: always()\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/append_agent_step_summary.sh\"\n - name: Copy Safe Outputs\n if: always()\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n run: |\n mkdir -p /tmp/gh-aw\n cp \"$GH_AW_SAFE_OUTPUTS\" /tmp/gh-aw/safeoutputs.jsonl 2>/dev/null || true\n - name: Ingest agent output\n id: collect_output\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_ALLOWED_DOMAINS: \"api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com\"\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_API_URL: ${{ github.api_url }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/collect_ndjson_output.cjs');\n await main();\n - name: Parse agent logs for step summary\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_copilot_log.cjs');\n await main();\n - name: Parse MCP Gateway logs for step summary\n if: always()\n id: parse-mcp-gateway\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_mcp_gateway_log.cjs');\n await main();\n - name: Print firewall logs\n if: always()\n continue-on-error: true\n env:\n AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs\n run: |\n # Fix permissions on firewall logs so they can be uploaded as artifacts\n # AWF runs with sudo, creating files owned by root\n sudo chmod -R a+r /tmp/gh-aw/sandbox/firewall/logs 2>/dev/null || true\n # Only run awf logs summary if awf command exists (it may not be installed if workflow failed before install step)\n if command -v awf &> /dev/null; then\n awf logs summary | tee -a \"$GITHUB_STEP_SUMMARY\"\n else\n echo 'AWF binary not installed, skipping firewall log summary'\n fi\n - name: Parse token usage for step summary\n if: always()\n continue-on-error: true\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs');\n await main();\n - name: Write agent output placeholder if missing\n if: always()\n run: |\n if [ ! -f /tmp/gh-aw/agent_output.json ]; then\n echo '{\"items\":[]}' > /tmp/gh-aw/agent_output.json\n fi\n - name: Upload agent artifacts\n if: always()\n continue-on-error: true\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: agent\n path: |\n /tmp/gh-aw/aw-prompts/prompt.txt\n /tmp/gh-aw/sandbox/agent/logs/\n /tmp/gh-aw/redacted-urls.log\n /tmp/gh-aw/mcp-logs/\n /tmp/gh-aw/agent_usage.json\n /tmp/gh-aw/agent-stdio.log\n /tmp/gh-aw/agent/\n /tmp/gh-aw/github_rate_limits.jsonl\n /tmp/gh-aw/safeoutputs.jsonl\n /tmp/gh-aw/agent_output.json\n /tmp/gh-aw/aw-*.patch\n /tmp/gh-aw/aw-*.bundle\n if-no-files-found: ignore\n - name: Upload firewall audit logs\n if: always()\n continue-on-error: true\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: firewall-audit-logs\n path: |\n /tmp/gh-aw/sandbox/firewall/logs/\n /tmp/gh-aw/sandbox/firewall/audit/\n if-no-files-found: ignore\n\n conclusion:\n needs:\n - activation\n - agent\n - detection\n - safe_outputs\n if: always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true')\n runs-on: ubuntu-slim\n permissions:\n contents: read\n discussions: write\n issues: write\n pull-requests: write\n concurrency:\n group: \"gh-aw-conclusion-issue-triage\"\n cancel-in-progress: false\n outputs:\n incomplete_count: ${{ steps.report_incomplete.outputs.incomplete_count }}\n noop_message: ${{ steps.noop.outputs.noop_message }}\n tools_reported: ${{ steps.missing_tool.outputs.tools_reported }}\n total_count: ${{ steps.missing_tool.outputs.total_count }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Process No-Op Messages\n id: noop\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_NOOP_MAX: \"1\"\n GH_AW_WORKFLOW_NAME: \"Issue Triage Agent\"\n GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\n GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }}\n GH_AW_NOOP_REPORT_AS_ISSUE: \"true\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_noop_message.cjs');\n await main();\n - name: Record missing tool\n id: missing_tool\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_MISSING_TOOL_CREATE_ISSUE: \"true\"\n GH_AW_WORKFLOW_NAME: \"Issue Triage Agent\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/missing_tool.cjs');\n await main();\n - name: Record incomplete\n id: report_incomplete\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_REPORT_INCOMPLETE_CREATE_ISSUE: \"true\"\n GH_AW_WORKFLOW_NAME: \"Issue Triage Agent\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/report_incomplete_handler.cjs');\n await main();\n - name: Handle agent failure\n id: handle_agent_failure\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_WORKFLOW_NAME: \"Issue Triage Agent\"\n GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\n GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }}\n GH_AW_WORKFLOW_ID: \"issue-triage\"\n GH_AW_ENGINE_ID: \"copilot\"\n GH_AW_SECRET_VERIFICATION_RESULT: ${{ needs.activation.outputs.secret_verification_result }}\n GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }}\n GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }}\n GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }}\n GH_AW_GROUP_REPORTS: \"false\"\n GH_AW_FAILURE_REPORT_AS_ISSUE: \"true\"\n GH_AW_TIMEOUT_MINUTES: \"10\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_agent_failure.cjs');\n await main();\n\n detection:\n needs:\n - activation\n - agent\n if: >\n always() && needs.agent.result != 'skipped' && (needs.agent.outputs.output_types != '' || needs.agent.outputs.has_patch == 'true')\n runs-on: ubuntu-latest\n permissions:\n contents: read\n outputs:\n detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }}\n detection_success: ${{ steps.detection_conclusion.outputs.success }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Checkout repository for patch context\n if: needs.agent.outputs.has_patch == 'true'\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n # --- Threat Detection ---\n - name: Download container images\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh\" ghcr.io/github/gh-aw-firewall/agent:0.25.18 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.18 ghcr.io/github/gh-aw-firewall/squid:0.25.18\n - name: Check if detection needed\n id: detection_guard\n if: always()\n env:\n OUTPUT_TYPES: ${{ needs.agent.outputs.output_types }}\n HAS_PATCH: ${{ needs.agent.outputs.has_patch }}\n run: |\n if [[ -n \"$OUTPUT_TYPES\" || \"$HAS_PATCH\" == \"true\" ]]; then\n echo \"run_detection=true\" >> \"$GITHUB_OUTPUT\"\n echo \"Detection will run: output_types=$OUTPUT_TYPES, has_patch=$HAS_PATCH\"\n else\n echo \"run_detection=false\" >> \"$GITHUB_OUTPUT\"\n echo \"Detection skipped: no agent outputs or patches to analyze\"\n fi\n - name: Clear MCP configuration for detection\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n rm -f /tmp/gh-aw/mcp-config/mcp-servers.json\n rm -f /home/runner/.copilot/mcp-config.json\n rm -f \"$GITHUB_WORKSPACE/.gemini/settings.json\"\n - name: Prepare threat detection files\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n mkdir -p /tmp/gh-aw/threat-detection/aw-prompts\n cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true\n cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true\n for f in /tmp/gh-aw/aw-*.patch; do\n [ -f \"$f\" ] && cp \"$f\" /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n done\n for f in /tmp/gh-aw/aw-*.bundle; do\n [ -f \"$f\" ] && cp \"$f\" /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n done\n echo \"Prepared threat detection files:\"\n ls -la /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n - name: Setup threat detection\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n WORKFLOW_NAME: \"Issue Triage Agent\"\n WORKFLOW_DESCRIPTION: \"Triages newly opened issues by labeling, acknowledging, requesting clarification, and closing duplicates\"\n HAS_PATCH: ${{ needs.agent.outputs.has_patch }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/setup_threat_detection.cjs');\n await main();\n - name: Ensure threat-detection directory and log\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n mkdir -p /tmp/gh-aw/threat-detection\n touch /tmp/gh-aw/threat-detection/detection.log\n - name: Install GitHub Copilot CLI\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh\" 1.0.20\n env:\n GH_HOST: github.com\n - name: Install AWF binary\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh\" v0.25.18\n - name: Execute GitHub Copilot CLI\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n id: detection_agentic_execution\n # Copilot CLI tool arguments (sorted):\n timeout-minutes: 20\n run: |\n set -o pipefail\n touch /tmp/gh-aw/agent-step-summary.md\n # shellcheck disable=SC1003\n sudo -E awf --container-workdir \"${GITHUB_WORKSPACE}\" --mount \"${RUNNER_TEMP}/gh-aw:${RUNNER_TEMP}/gh-aw:ro\" --mount \"${RUNNER_TEMP}/gh-aw:/host${RUNNER_TEMP}/gh-aw:ro\" --env-all --exclude-env COPILOT_GITHUB_TOKEN --allow-domains api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,github.com,host.docker.internal,telemetry.enterprise.githubcopilot.com --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --image-tag 0.25.18 --skip-pull --enable-api-proxy \\\n -- /bin/bash -c 'node ${RUNNER_TEMP}/gh-aw/actions/copilot_driver.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --allow-all-tools --add-dir \"${GITHUB_WORKSPACE}\" --prompt \"$(cat /tmp/gh-aw/aw-prompts/prompt.txt)\"' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log\n env:\n COPILOT_AGENT_RUNNER_TYPE: STANDALONE\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || '' }}\n GH_AW_PHASE: detection\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_VERSION: v0.67.4\n GITHUB_API_URL: ${{ github.api_url }}\n GITHUB_AW: true\n GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows\n GITHUB_HEAD_REF: ${{ github.head_ref }}\n GITHUB_REF_NAME: ${{ github.ref_name }}\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md\n GITHUB_WORKSPACE: ${{ github.workspace }}\n GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_AUTHOR_NAME: github-actions[bot]\n GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_COMMITTER_NAME: github-actions[bot]\n XDG_CONFIG_HOME: /home/runner\n - name: Upload threat detection log\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: detection\n path: /tmp/gh-aw/threat-detection/detection.log\n if-no-files-found: ignore\n - name: Parse and conclude threat detection\n id: detection_conclusion\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n RUN_DETECTION: ${{ steps.detection_guard.outputs.run_detection }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_threat_detection_results.cjs');\n await main();\n\n safe_outputs:\n needs:\n - activation\n - agent\n - detection\n if: (!cancelled()) && needs.agent.result != 'skipped' && needs.detection.result == 'success'\n runs-on: ubuntu-slim\n permissions:\n contents: read\n discussions: write\n issues: write\n pull-requests: write\n timeout-minutes: 15\n env:\n GH_AW_CALLER_WORKFLOW_ID: \"${{ github.repository }}/issue-triage\"\n GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens }}\n GH_AW_ENGINE_ID: \"copilot\"\n GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }}\n GH_AW_WORKFLOW_ID: \"issue-triage\"\n GH_AW_WORKFLOW_NAME: \"Issue Triage Agent\"\n outputs:\n code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }}\n code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }}\n comment_id: ${{ steps.process_safe_outputs.outputs.comment_id }}\n comment_url: ${{ steps.process_safe_outputs.outputs.comment_url }}\n create_discussion_error_count: ${{ steps.process_safe_outputs.outputs.create_discussion_error_count }}\n create_discussion_errors: ${{ steps.process_safe_outputs.outputs.create_discussion_errors }}\n process_safe_outputs_processed_count: ${{ steps.process_safe_outputs.outputs.processed_count }}\n process_safe_outputs_temporary_id_map: ${{ steps.process_safe_outputs.outputs.temporary_id_map }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Configure GH_HOST for enterprise compatibility\n id: ghes-host-config\n shell: bash\n run: |\n # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct\n # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op.\n GH_HOST=\"${GITHUB_SERVER_URL#https://}\"\n GH_HOST=\"${GH_HOST#http://}\"\n echo \"GH_HOST=${GH_HOST}\" >> \"$GITHUB_ENV\"\n - name: Process Safe Outputs\n id: process_safe_outputs\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_ALLOWED_DOMAINS: \"api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com\"\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_API_URL: ${{ github.api_url }}\n GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: \"{\\\"add_comment\\\":{\\\"max\\\":2},\\\"add_labels\\\":{\\\"allowed\\\":[\\\"bug\\\",\\\"enhancement\\\",\\\"question\\\",\\\"documentation\\\",\\\"sdk/dotnet\\\",\\\"sdk/go\\\",\\\"sdk/nodejs\\\",\\\"sdk/python\\\",\\\"priority/high\\\",\\\"priority/low\\\",\\\"testing\\\",\\\"security\\\",\\\"needs-info\\\",\\\"duplicate\\\"],\\\"max\\\":10,\\\"target\\\":\\\"triggering\\\"},\\\"close_issue\\\":{\\\"max\\\":1,\\\"target\\\":\\\"triggering\\\"},\\\"create_report_incomplete_issue\\\":{},\\\"missing_data\\\":{},\\\"missing_tool\\\":{},\\\"noop\\\":{\\\"max\\\":1,\\\"report-as-issue\\\":\\\"true\\\"},\\\"report_incomplete\\\":{},\\\"update_issue\\\":{\\\"allow_body\\\":true,\\\"max\\\":1,\\\"target\\\":\\\"triggering\\\"}}\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/safe_output_handler_manager.cjs');\n await main();\n - name: Upload Safe Outputs Items\n if: always()\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: safe-outputs-items\n path: /tmp/gh-aw/safe-output-items.jsonl\n if-no-files-found: ignore\n\n" }, { "path": ".github/workflows/issue-triage.md", "content": "---\ndescription: Triages newly opened issues by labeling, acknowledging, requesting clarification, and closing duplicates\non:\n roles: all\n issues:\n types: [opened]\n workflow_dispatch:\n inputs:\n issue_number:\n description: \"Issue number to triage\"\n required: true\n type: string\npermissions:\n contents: read\n issues: read\n pull-requests: read\ntools:\n github:\n toolsets: [default]\nsafe-outputs:\n add-comment:\n max: 2\n add-labels:\n allowed: [bug, enhancement, question, documentation, sdk/dotnet, sdk/go, sdk/nodejs, sdk/python, priority/high, priority/low, testing, security, needs-info, duplicate]\n max: 10\n target: triggering\n update-issue:\n target: triggering\n close-issue:\n target: triggering\ntimeout-minutes: 10\n---\n\n# Issue Triage Agent\n\nYou are an AI agent that triages newly opened issues in the copilot-sdk repository — a multi-language SDK with implementations in .NET, Go, Node.js, and Python.\n\n## Your Task\n\nWhen a new issue is opened, analyze it and perform the following actions:\n\n1. **Add appropriate labels** based on the issue content\n2. **Post an acknowledgment comment** thanking the author\n3. **Request clarification** if the issue lacks sufficient detail\n4. **Close duplicates** if you find a matching existing issue\n\n## Available Labels\n\n### SDK/Language Labels (apply one or more if the issue relates to specific SDKs):\n- `sdk/dotnet` — .NET SDK issues\n- `sdk/go` — Go SDK issues \n- `sdk/nodejs` — Node.js SDK issues\n- `sdk/python` — Python SDK issues\n\n### Type Labels (apply exactly one):\n- `bug` — Something isn't working correctly\n- `enhancement` — New feature or improvement request\n- `question` — General question about usage\n- `documentation` — Documentation improvements needed\n\n### Priority Labels (apply if clearly indicated):\n- `priority/high` — Urgent or blocking issue\n- `priority/low` — Nice-to-have or minor issue\n\n### Area Labels (apply if relevant):\n- `testing` — Related to tests or test infrastructure\n- `security` — Security-related concerns\n\n### Status Labels:\n- `needs-info` — Issue requires more information from author\n- `duplicate` — Issue duplicates an existing one\n\n## Guidelines\n\n1. **Labeling**: Always apply at least one type label. Apply SDK labels when the issue clearly relates to specific language implementations. Use `needs-info` when the issue is unclear or missing reproduction steps.\n\n2. **Acknowledgment**: Post a friendly comment thanking the author for opening the issue. Mention which labels you applied and why.\n\n3. **Clarification**: If the issue lacks:\n - Steps to reproduce (for bugs)\n - Expected vs actual behavior\n - SDK version or language being used\n - Error messages or logs\n \n Then apply the `needs-info` label and ask specific clarifying questions.\n\n4. **Duplicate Detection**: Search existing open issues. If you find a likely duplicate:\n - Apply the `duplicate` label\n - Comment referencing the original issue\n - Close the issue using `close-issue`\n\n5. **Be concise**: Keep comments brief and actionable. Don't over-explain.\n\n## Context\n\n- Repository: ${{ github.repository }}\n- Issue number: ${{ github.event.issue.number || inputs.issue_number }}\n- Issue title: ${{ github.event.issue.title }}\n\nUse the GitHub tools to fetch the issue details (especially when triggered manually via workflow_dispatch)." }, { "path": ".github/workflows/nodejs-sdk-tests.yml", "content": "name: \"Node.js SDK Tests\"\n\nenv:\n HUSKY: 0\n\non:\n push:\n branches:\n - main\n pull_request:\n types: [opened, synchronize, reopened, ready_for_review]\n paths:\n - 'nodejs/**'\n - 'test/**'\n - '.github/workflows/nodejs-sdk-tests.yml'\n - '!nodejs/scripts/**'\n - '!**/*.md'\n - '!**/LICENSE*'\n - '!**/.gitignore'\n - '!**/.editorconfig'\n - '!**/*.png'\n - '!**/*.jpg'\n - '!**/*.jpeg'\n - '!**/*.gif'\n - '!**/*.svg'\n workflow_dispatch:\n merge_group:\n\npermissions:\n contents: read\n\njobs:\n test:\n name: \"Node.js SDK Tests\"\n env:\n POWERSHELL_UPDATECHECK: Off\n strategy:\n fail-fast: false\n matrix:\n os: [ubuntu-latest, macos-latest, windows-latest]\n runs-on: ${{ matrix.os }}\n defaults:\n run:\n shell: bash\n working-directory: ./nodejs\n steps:\n - uses: actions/checkout@v6.0.2\n - uses: actions/setup-node@v6\n with:\n cache: \"npm\"\n cache-dependency-path: \"./nodejs/package-lock.json\"\n node-version: 22\n - name: Install dependencies\n run: npm ci --ignore-scripts\n\n - name: Run prettier check\n if: runner.os == 'Linux'\n run: npm run format:check\n\n - name: Run ESLint\n run: npm run lint\n\n - name: Typecheck SDK\n run: npm run typecheck\n\n - name: Build SDK\n run: npm run build\n\n - name: Install test harness dependencies\n working-directory: ./test/harness\n run: npm ci --ignore-scripts\n\n - name: Warm up PowerShell\n if: runner.os == 'Windows'\n run: pwsh.exe -Command \"Write-Host 'PowerShell ready'\"\n\n - name: Run Node.js SDK tests\n env:\n COPILOT_HMAC_KEY: ${{ secrets.COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY }}\n run: npm test\n" }, { "path": ".github/workflows/publish.yml", "content": "name: Publish SDK packages\n\nenv:\n HUSKY: 0\n\non:\n workflow_dispatch:\n inputs:\n dist-tag:\n description: \"Tag to publish under\"\n type: choice\n required: true\n default: \"latest\"\n options:\n - latest\n - prerelease\n - unstable\n version:\n description: \"Version override (optional, e.g., 1.0.0). If empty, auto-increments.\"\n type: string\n required: false\n\npermissions:\n contents: write\n id-token: write # Required for OIDC\n actions: write # Required to trigger changelog workflow\n\nconcurrency:\n group: publish\n cancel-in-progress: false\n\njobs:\n # Shared job to calculate version once for all publish jobs\n version:\n name: Calculate Version\n runs-on: ubuntu-latest\n outputs:\n version: ${{ steps.version.outputs.VERSION }}\n current: ${{ steps.version.outputs.CURRENT }}\n current-prerelease: ${{ steps.version.outputs.CURRENT_PRERELEASE }}\n defaults:\n run:\n working-directory: ./nodejs\n steps:\n - uses: actions/checkout@v6.0.2\n - uses: actions/setup-node@v6\n with:\n node-version: \"22.x\"\n - run: npm ci --ignore-scripts\n - name: Get version\n id: version\n run: |\n CURRENT=\"$(node scripts/get-version.js current)\"\n echo \"CURRENT=$CURRENT\" >> $GITHUB_OUTPUT\n echo \"Current latest version: $CURRENT\" >> $GITHUB_STEP_SUMMARY\n CURRENT_PRERELEASE=\"$(node scripts/get-version.js current-prerelease)\"\n echo \"CURRENT_PRERELEASE=$CURRENT_PRERELEASE\" >> $GITHUB_OUTPUT\n echo \"Current prerelease version: $CURRENT_PRERELEASE\" >> $GITHUB_STEP_SUMMARY\n if [ -n \"${{ github.event.inputs.version }}\" ]; then\n VERSION=\"${{ github.event.inputs.version }}\"\n # Validate version format matches dist-tag\n if [ \"${{ github.event.inputs.dist-tag }}\" = \"latest\" ]; then\n if [[ \"$VERSION\" == *-* ]]; then\n echo \"❌ Error: Version '$VERSION' has a prerelease suffix but dist-tag is 'latest'\" >> $GITHUB_STEP_SUMMARY\n echo \"Use a version without suffix (e.g., '1.0.0') for latest releases\"\n exit 1\n fi\n else\n if [[ \"$VERSION\" != *-* ]]; then\n echo \"❌ Error: Version '$VERSION' has no prerelease suffix but dist-tag is '${{ github.event.inputs.dist-tag }}'\" >> $GITHUB_STEP_SUMMARY\n echo \"Use a version with suffix (e.g., '1.0.0-preview.0') for prerelease/unstable\"\n exit 1\n fi\n fi\n echo \"Using manual version override: $VERSION\" >> $GITHUB_STEP_SUMMARY\n else\n VERSION=\"$(node scripts/get-version.js ${{ github.event.inputs.dist-tag }})\"\n echo \"Auto-incremented version: $VERSION\" >> $GITHUB_STEP_SUMMARY\n fi\n echo \"VERSION=$VERSION\" >> $GITHUB_OUTPUT\n\n publish-nodejs:\n name: Publish Node.js SDK\n needs: version\n runs-on: ubuntu-latest\n defaults:\n run:\n working-directory: ./nodejs\n steps:\n - uses: actions/checkout@v6.0.2\n - uses: actions/setup-node@v6\n with:\n node-version: \"22.x\"\n - name: Update npm for OIDC support\n run: npm i -g \"npm@11.6.3\"\n - run: npm ci --ignore-scripts\n - name: Set version\n run: node scripts/set-version.js\n env:\n VERSION: ${{ needs.version.outputs.version }}\n - name: Build\n run: npm run build\n - name: Pack\n run: npm pack\n - name: Upload artifact\n uses: actions/upload-artifact@v7.0.0\n with:\n name: nodejs-package\n path: nodejs/*.tgz\n - name: Publish to npm\n if: github.ref == 'refs/heads/main' || github.event.inputs.dist-tag == 'unstable'\n run: npm publish --tag ${{ github.event.inputs.dist-tag }} --access public --registry https://registry.npmjs.org\n\n publish-dotnet:\n name: Publish .NET SDK\n if: github.event.inputs.dist-tag != 'unstable'\n needs: version\n runs-on: ubuntu-latest\n defaults:\n run:\n working-directory: ./dotnet\n steps:\n - uses: actions/checkout@v6.0.2\n - uses: actions/setup-dotnet@v5\n with:\n dotnet-version: \"10.0.x\"\n - name: Restore dependencies\n run: dotnet restore\n - name: Build and pack\n run: dotnet pack src/GitHub.Copilot.SDK.csproj -c Release -p:Version=${{ needs.version.outputs.version }} -o ./artifacts\n - name: Upload artifact\n uses: actions/upload-artifact@v7.0.0\n with:\n name: dotnet-package\n path: dotnet/artifacts/*.nupkg\n - name: NuGet login (OIDC)\n if: github.ref == 'refs/heads/main'\n uses: NuGet/login@v1\n id: nuget-login\n with:\n # The following must be a username, not an organization name, and that user must have configured Trusted Publishing\n # for this owner/repo/workflow combination in their NuGet.org account settings. We could set up a dedicated user for\n # this purpose if needed, but then we'd have to manage that account separately. Other GitHub-owned packages on NuGet\n # are associated with individual maintainers' accounts too.\n user: stevesanderson\n - name: Publish to NuGet\n if: github.ref == 'refs/heads/main'\n run: dotnet nuget push ./artifacts/*.nupkg --api-key ${{ steps.nuget-login.outputs.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json --skip-duplicate\n\n publish-python:\n name: Publish Python SDK\n if: github.event.inputs.dist-tag != 'unstable'\n needs: version\n runs-on: ubuntu-latest\n defaults:\n run:\n working-directory: ./python\n steps:\n - uses: actions/checkout@v6.0.2\n - uses: actions/setup-python@v6\n with:\n python-version: \"3.12\"\n - uses: actions/setup-node@v6\n with:\n node-version: \"22.x\"\n - name: Set up uv\n uses: astral-sh/setup-uv@v7\n - name: Install Node.js dependencies (for CLI version)\n working-directory: ./nodejs\n run: npm ci --ignore-scripts\n - name: Set version\n run: sed -i \"s/^version = .*/version = \\\"${{ needs.version.outputs.version }}\\\"/\" pyproject.toml\n - name: Build platform wheels\n run: node scripts/build-wheels.mjs --output-dir dist\n - name: Upload artifact\n uses: actions/upload-artifact@v7.0.0\n with:\n name: python-package\n path: python/dist/*\n - name: Publish to PyPI\n if: github.ref == 'refs/heads/main'\n uses: pypa/gh-action-pypi-publish@release/v1\n with:\n packages-dir: python/dist/\n\n github-release:\n name: Create GitHub Release\n needs: [version, publish-nodejs, publish-dotnet, publish-python]\n if: github.ref == 'refs/heads/main' && github.event.inputs.dist-tag != 'unstable'\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6.0.2\n - name: Create GitHub Release\n if: github.event.inputs.dist-tag == 'latest'\n run: |\n NOTES_FLAG=\"\"\n if git rev-parse \"v${{ needs.version.outputs.current }}\" >/dev/null 2>&1; then\n NOTES_FLAG=\"--notes-start-tag v${{ needs.version.outputs.current }}\"\n fi\n gh release create \"v${{ needs.version.outputs.version }}\" \\\n --title \"v${{ needs.version.outputs.version }}\" \\\n --generate-notes $NOTES_FLAG \\\n --target ${{ github.sha }}\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n - name: Create GitHub Pre-Release\n if: github.event.inputs.dist-tag == 'prerelease'\n run: |\n NOTES_FLAG=\"\"\n if git rev-parse \"v${{ needs.version.outputs.current-prerelease }}\" >/dev/null 2>&1; then\n NOTES_FLAG=\"--notes-start-tag v${{ needs.version.outputs.current-prerelease }}\"\n fi\n gh release create \"v${{ needs.version.outputs.version }}\" \\\n --prerelease \\\n --title \"v${{ needs.version.outputs.version }}\" \\\n --generate-notes $NOTES_FLAG \\\n --target ${{ github.sha }}\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n - name: Trigger changelog generation\n run: gh workflow run release-changelog.lock.yml -f tag=\"v${{ needs.version.outputs.version }}\"\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n - name: Tag Go SDK submodule\n if: github.event.inputs.dist-tag == 'latest' || github.event.inputs.dist-tag == 'prerelease'\n run: |\n set -e\n git config user.name \"github-actions[bot]\"\n git config user.email \"github-actions[bot]@users.noreply.github.com\"\n git fetch --tags\n TAG_NAME=\"go/v${{ needs.version.outputs.version }}\"\n # Try to create the tag - will fail if it already exists\n if git tag \"$TAG_NAME\" ${{ github.sha }} 2>/dev/null; then\n git push https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git \"$TAG_NAME\"\n echo \"Created and pushed tag $TAG_NAME\"\n else\n echo \"Tag $TAG_NAME already exists, skipping\"\n fi\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n" }, { "path": ".github/workflows/python-sdk-tests.yml", "content": "name: \"Python SDK Tests\"\n\nenv:\n PYTHONUTF8: 1\n\non:\n push:\n branches:\n - main\n pull_request:\n types: [opened, synchronize, reopened, ready_for_review]\n paths:\n - 'python/**'\n - 'test/**'\n - 'nodejs/package.json'\n - '.github/workflows/python-sdk-tests.yml'\n - '!**/*.md'\n - '!**/LICENSE*'\n - '!**/.gitignore'\n - '!**/.editorconfig'\n - '!**/*.png'\n - '!**/*.jpg'\n - '!**/*.jpeg'\n - '!**/*.gif'\n - '!**/*.svg'\n workflow_dispatch:\n merge_group:\n\npermissions:\n contents: read\n\njobs:\n test:\n name: \"Python SDK Tests\"\n env:\n POWERSHELL_UPDATECHECK: Off\n strategy:\n fail-fast: false\n matrix:\n os: [ubuntu-latest, macos-latest, windows-latest]\n # Test the oldest supported Python version to make sure compatibility is maintained.\n python-version: [\"3.11\"]\n runs-on: ${{ matrix.os }}\n defaults:\n run:\n shell: bash\n working-directory: ./python\n steps:\n - uses: actions/checkout@v6.0.2\n - uses: actions/setup-python@v6\n with:\n python-version: ${{ matrix.python-version }}\n - uses: actions/setup-node@v6\n with:\n node-version: \"22\"\n cache: \"npm\"\n cache-dependency-path: \"./nodejs/package-lock.json\"\n\n - name: Set up uv\n uses: astral-sh/setup-uv@v7\n with:\n enable-cache: true\n\n - name: Install Python dev dependencies\n run: uv sync --all-extras --dev\n\n - name: Install Node.js dependencies (for CLI in tests)\n working-directory: ./nodejs\n run: npm ci --ignore-scripts\n\n - name: Run ruff format check\n run: uv run ruff format --check .\n\n - name: Run ruff lint\n run: uv run ruff check\n\n - name: Run ty type checking\n run: uv run ty check copilot\n\n - name: Install test harness dependencies\n working-directory: ./test/harness\n run: npm ci --ignore-scripts\n\n - name: Warm up PowerShell\n if: runner.os == 'Windows'\n run: pwsh.exe -Command \"Write-Host 'PowerShell ready'\"\n\n - name: Run Python SDK tests\n env:\n COPILOT_HMAC_KEY: ${{ secrets.COPILOT_DEVELOPER_CLI_INTEGRATION_HMAC_KEY }}\n run: uv run pytest -v -s\n" }, { "path": ".github/workflows/release-changelog.lock.yml", "content": "# gh-aw-metadata: {\"schema_version\":\"v3\",\"frontmatter_hash\":\"c06cce5802b74e1280963eef2e92515d84870d76d9cfdefa84b56c038e2b8da1\",\"compiler_version\":\"v0.67.4\",\"strict\":true,\"agent_id\":\"copilot\"}\n# gh-aw-manifest: {\"version\":1,\"secrets\":[\"COPILOT_GITHUB_TOKEN\",\"GH_AW_CI_TRIGGER_TOKEN\",\"GH_AW_GITHUB_MCP_SERVER_TOKEN\",\"GH_AW_GITHUB_TOKEN\",\"GITHUB_TOKEN\"],\"actions\":[{\"repo\":\"actions/checkout\",\"sha\":\"de0fac2e4500dabe0009e67214ff5f5447ce83dd\",\"version\":\"v6.0.2\"},{\"repo\":\"actions/download-artifact\",\"sha\":\"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c\",\"version\":\"v8.0.1\"},{\"repo\":\"actions/github-script\",\"sha\":\"ed597411d8f924073f98dfc5c65a23a2325f34cd\",\"version\":\"v8\"},{\"repo\":\"actions/upload-artifact\",\"sha\":\"bbbca2ddaa5d8feaa63e36b76fdaad77386f024f\",\"version\":\"v7\"},{\"repo\":\"github/gh-aw-actions/setup\",\"sha\":\"9d6ae06250fc0ec536a0e5f35de313b35bad7246\",\"version\":\"v0.67.4\"}]}\n# ___ _ _ \n# / _ \\ | | (_) \n# | |_| | __ _ ___ _ __ | |_ _ ___ \n# | _ |/ _` |/ _ \\ '_ \\| __| |/ __|\n# | | | | (_| | __/ | | | |_| | (__ \n# \\_| |_/\\__, |\\___|_| |_|\\__|_|\\___|\n# __/ |\n# _ _ |___/ \n# | | | | / _| |\n# | | | | ___ _ __ _ __| |_| | _____ ____\n# | |/\\| |/ _ \\ '__| |/ /| _| |/ _ \\ \\ /\\ / / ___|\n# \\ /\\ / (_) | | | | ( | | | | (_) \\ V V /\\__ \\\n# \\/ \\/ \\___/|_| |_|\\_\\|_| |_|\\___/ \\_/\\_/ |___/\n#\n# This file was automatically generated by gh-aw (v0.67.4). DO NOT EDIT.\n#\n# To update this file, edit the corresponding .md file and run:\n# gh aw compile\n# Not all edits will cause changes to this file.\n#\n# For more information: https://github.github.com/gh-aw/introduction/overview/\n#\n# Generates release notes from merged PRs/commits. Triggered by the publish workflow or manually via workflow_dispatch.\n#\n# Secrets used:\n# - COPILOT_GITHUB_TOKEN\n# - GH_AW_CI_TRIGGER_TOKEN\n# - GH_AW_GITHUB_MCP_SERVER_TOKEN\n# - GH_AW_GITHUB_TOKEN\n# - GITHUB_TOKEN\n#\n# Custom actions used:\n# - actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n# - actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n# - actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n# - actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n# - github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n\nname: \"Release Changelog Generator\"\n\"on\":\n workflow_dispatch:\n inputs:\n aw_context:\n default: \"\"\n description: Agent caller context (used internally by Agentic Workflows).\n required: false\n type: string\n tag:\n description: Release tag to generate changelog for (e.g., v0.1.30)\n required: true\n type: string\n\npermissions: {}\n\nconcurrency:\n group: \"gh-aw-${{ github.workflow }}\"\n\nrun-name: \"Release Changelog Generator\"\n\njobs:\n activation:\n runs-on: ubuntu-slim\n permissions:\n actions: read\n contents: read\n outputs:\n comment_id: \"\"\n comment_repo: \"\"\n lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }}\n model: ${{ steps.generate_aw_info.outputs.model }}\n secret_verification_result: ${{ steps.validate-secret.outputs.verification_result }}\n setup-trace-id: ${{ steps.setup.outputs.trace-id }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n - name: Generate agentic run info\n id: generate_aw_info\n env:\n GH_AW_INFO_ENGINE_ID: \"copilot\"\n GH_AW_INFO_ENGINE_NAME: \"GitHub Copilot CLI\"\n GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'auto' }}\n GH_AW_INFO_VERSION: \"1.0.20\"\n GH_AW_INFO_AGENT_VERSION: \"1.0.20\"\n GH_AW_INFO_CLI_VERSION: \"v0.67.4\"\n GH_AW_INFO_WORKFLOW_NAME: \"Release Changelog Generator\"\n GH_AW_INFO_EXPERIMENTAL: \"false\"\n GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: \"true\"\n GH_AW_INFO_STAGED: \"false\"\n GH_AW_INFO_ALLOWED_DOMAINS: '[\"defaults\"]'\n GH_AW_INFO_FIREWALL_ENABLED: \"true\"\n GH_AW_INFO_AWF_VERSION: \"v0.25.18\"\n GH_AW_INFO_AWMG_VERSION: \"\"\n GH_AW_INFO_FIREWALL_TYPE: \"squid\"\n GH_AW_COMPILED_STRICT: \"true\"\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs');\n await main(core, context);\n - name: Validate COPILOT_GITHUB_TOKEN secret\n id: validate-secret\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/validate_multi_secret.sh\" COPILOT_GITHUB_TOKEN 'GitHub Copilot CLI' https://github.github.com/gh-aw/reference/engines/#github-copilot-default\n env:\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n - name: Checkout .github and .agents folders\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n sparse-checkout: |\n .github\n .agents\n sparse-checkout-cone-mode: true\n fetch-depth: 1\n - name: Check workflow lock file\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_WORKFLOW_FILE: \"release-changelog.lock.yml\"\n GH_AW_CONTEXT_WORKFLOW_REF: \"${{ github.workflow_ref }}\"\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/check_workflow_timestamp_api.cjs');\n await main();\n - name: Check compile-agentic version\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_COMPILED_VERSION: \"v0.67.4\"\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/check_version_updates.cjs');\n await main();\n - name: Create prompt with built-in context\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_SAFE_OUTPUTS: ${{ runner.temp }}/gh-aw/safeoutputs/outputs.jsonl\n GH_AW_GITHUB_ACTOR: ${{ github.actor }}\n GH_AW_GITHUB_EVENT_COMMENT_ID: ${{ github.event.comment.id }}\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: ${{ github.event.discussion.number }}\n GH_AW_GITHUB_EVENT_INPUTS_TAG: ${{ github.event.inputs.tag }}\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: ${{ github.event.issue.number }}\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n GH_AW_GITHUB_RUN_ID: ${{ github.run_id }}\n GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }}\n # poutine:ignore untrusted_checkout_exec\n run: |\n bash \"${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh\"\n {\n cat << 'GH_AW_PROMPT_41d0179c6df1e6c3_EOF'\n \n GH_AW_PROMPT_41d0179c6df1e6c3_EOF\n cat \"${RUNNER_TEMP}/gh-aw/prompts/xpia.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/markdown.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md\"\n cat << 'GH_AW_PROMPT_41d0179c6df1e6c3_EOF'\n \n Tools: create_pull_request, update_release, missing_tool, missing_data, noop\n GH_AW_PROMPT_41d0179c6df1e6c3_EOF\n cat \"${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_create_pull_request.md\"\n cat << 'GH_AW_PROMPT_41d0179c6df1e6c3_EOF'\n \n \n The following GitHub context information is available for this workflow:\n {{#if __GH_AW_GITHUB_ACTOR__ }}\n - **actor**: __GH_AW_GITHUB_ACTOR__\n {{/if}}\n {{#if __GH_AW_GITHUB_REPOSITORY__ }}\n - **repository**: __GH_AW_GITHUB_REPOSITORY__\n {{/if}}\n {{#if __GH_AW_GITHUB_WORKSPACE__ }}\n - **workspace**: __GH_AW_GITHUB_WORKSPACE__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_ISSUE_NUMBER__ }}\n - **issue-number**: #__GH_AW_GITHUB_EVENT_ISSUE_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER__ }}\n - **discussion-number**: #__GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER__ }}\n - **pull-request-number**: #__GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_COMMENT_ID__ }}\n - **comment-id**: __GH_AW_GITHUB_EVENT_COMMENT_ID__\n {{/if}}\n {{#if __GH_AW_GITHUB_RUN_ID__ }}\n - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__\n {{/if}}\n \n \n GH_AW_PROMPT_41d0179c6df1e6c3_EOF\n cat \"${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md\"\n cat << 'GH_AW_PROMPT_41d0179c6df1e6c3_EOF'\n \n {{#runtime-import .github/workflows/release-changelog.md}}\n GH_AW_PROMPT_41d0179c6df1e6c3_EOF\n } > \"$GH_AW_PROMPT\"\n - name: Interpolate variables and render templates\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_GITHUB_EVENT_INPUTS_TAG: ${{ github.event.inputs.tag }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/interpolate_prompt.cjs');\n await main();\n - name: Substitute placeholders\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_GITHUB_ACTOR: ${{ github.actor }}\n GH_AW_GITHUB_EVENT_COMMENT_ID: ${{ github.event.comment.id }}\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: ${{ github.event.discussion.number }}\n GH_AW_GITHUB_EVENT_INPUTS_TAG: ${{ github.event.inputs.tag }}\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: ${{ github.event.issue.number }}\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n GH_AW_GITHUB_RUN_ID: ${{ github.run_id }}\n GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n \n const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs');\n \n // Call the substitution function\n return await substitutePlaceholders({\n file: process.env.GH_AW_PROMPT,\n substitutions: {\n GH_AW_GITHUB_ACTOR: process.env.GH_AW_GITHUB_ACTOR,\n GH_AW_GITHUB_EVENT_COMMENT_ID: process.env.GH_AW_GITHUB_EVENT_COMMENT_ID,\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: process.env.GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER,\n GH_AW_GITHUB_EVENT_INPUTS_TAG: process.env.GH_AW_GITHUB_EVENT_INPUTS_TAG,\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: process.env.GH_AW_GITHUB_EVENT_ISSUE_NUMBER,\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: process.env.GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER,\n GH_AW_GITHUB_REPOSITORY: process.env.GH_AW_GITHUB_REPOSITORY,\n GH_AW_GITHUB_RUN_ID: process.env.GH_AW_GITHUB_RUN_ID,\n GH_AW_GITHUB_WORKSPACE: process.env.GH_AW_GITHUB_WORKSPACE\n }\n });\n - name: Validate prompt placeholders\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n # poutine:ignore untrusted_checkout_exec\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/validate_prompt_placeholders.sh\"\n - name: Print prompt\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n # poutine:ignore untrusted_checkout_exec\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/print_prompt_summary.sh\"\n - name: Upload activation artifact\n if: success()\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: activation\n path: |\n /tmp/gh-aw/aw_info.json\n /tmp/gh-aw/aw-prompts/prompt.txt\n /tmp/gh-aw/github_rate_limits.jsonl\n if-no-files-found: ignore\n retention-days: 1\n\n agent:\n needs: activation\n runs-on: ubuntu-latest\n permissions:\n actions: read\n contents: read\n issues: read\n pull-requests: read\n env:\n DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}\n GH_AW_ASSETS_ALLOWED_EXTS: \"\"\n GH_AW_ASSETS_BRANCH: \"\"\n GH_AW_ASSETS_MAX_SIZE_KB: 0\n GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs\n GH_AW_WORKFLOW_ID_SANITIZED: releasechangelog\n outputs:\n checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }}\n effective_tokens: ${{ steps.parse-mcp-gateway.outputs.effective_tokens }}\n has_patch: ${{ steps.collect_output.outputs.has_patch }}\n inference_access_error: ${{ steps.detect-inference-error.outputs.inference_access_error || 'false' }}\n model: ${{ needs.activation.outputs.model }}\n output: ${{ steps.collect_output.outputs.output }}\n output_types: ${{ steps.collect_output.outputs.output_types }}\n setup-trace-id: ${{ steps.setup.outputs.trace-id }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Set runtime paths\n id: set-runtime-paths\n run: |\n echo \"GH_AW_SAFE_OUTPUTS=${RUNNER_TEMP}/gh-aw/safeoutputs/outputs.jsonl\" >> \"$GITHUB_OUTPUT\"\n echo \"GH_AW_SAFE_OUTPUTS_CONFIG_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/config.json\" >> \"$GITHUB_OUTPUT\"\n echo \"GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json\" >> \"$GITHUB_OUTPUT\"\n - name: Checkout repository\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n - name: Create gh-aw temp directory\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/create_gh_aw_tmp_dir.sh\"\n - name: Configure gh CLI for GitHub Enterprise\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh\"\n env:\n GH_TOKEN: ${{ github.token }}\n - name: Configure Git credentials\n env:\n REPO_NAME: ${{ github.repository }}\n SERVER_URL: ${{ github.server_url }}\n GITHUB_TOKEN: ${{ github.token }}\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git config --global am.keepcr true\n # Re-authenticate git with GitHub token\n SERVER_URL_STRIPPED=\"${SERVER_URL#https://}\"\n git remote set-url origin \"https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git\"\n echo \"Git configured with standard GitHub Actions identity\"\n - name: Checkout PR branch\n id: checkout-pr\n if: |\n github.event.pull_request || github.event.issue.pull_request\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs');\n await main();\n - name: Install GitHub Copilot CLI\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh\" 1.0.20\n env:\n GH_HOST: github.com\n - name: Install AWF binary\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh\" v0.25.18\n - name: Determine automatic lockdown mode for GitHub MCP Server\n id: determine-automatic-lockdown\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }}\n GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }}\n with:\n script: |\n const determineAutomaticLockdown = require('${{ runner.temp }}/gh-aw/actions/determine_automatic_lockdown.cjs');\n await determineAutomaticLockdown(github, context, core);\n - name: Download container images\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh\" ghcr.io/github/gh-aw-firewall/agent:0.25.18 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.18 ghcr.io/github/gh-aw-firewall/squid:0.25.18 ghcr.io/github/gh-aw-mcpg:v0.2.17 ghcr.io/github/github-mcp-server:v0.32.0 node:lts-alpine\n - name: Write Safe Outputs Config\n run: |\n mkdir -p \"${RUNNER_TEMP}/gh-aw/safeoutputs\"\n mkdir -p /tmp/gh-aw/safeoutputs\n mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs\n cat > \"${RUNNER_TEMP}/gh-aw/safeoutputs/config.json\" << 'GH_AW_SAFE_OUTPUTS_CONFIG_185484bc160cdce2_EOF'\n {\"create_pull_request\":{\"draft\":false,\"labels\":[\"automation\",\"changelog\"],\"max\":1,\"max_patch_size\":1024,\"protected_files\":[\"package.json\",\"bun.lockb\",\"bunfig.toml\",\"deno.json\",\"deno.jsonc\",\"deno.lock\",\"global.json\",\"NuGet.Config\",\"Directory.Packages.props\",\"mix.exs\",\"mix.lock\",\"go.mod\",\"go.sum\",\"stack.yaml\",\"stack.yaml.lock\",\"pom.xml\",\"build.gradle\",\"build.gradle.kts\",\"settings.gradle\",\"settings.gradle.kts\",\"gradle.properties\",\"package-lock.json\",\"yarn.lock\",\"pnpm-lock.yaml\",\"npm-shrinkwrap.json\",\"requirements.txt\",\"Pipfile\",\"Pipfile.lock\",\"pyproject.toml\",\"setup.py\",\"setup.cfg\",\"Gemfile\",\"Gemfile.lock\",\"uv.lock\",\"CODEOWNERS\"],\"protected_path_prefixes\":[\".github/\",\".agents/\"],\"title_prefix\":\"[changelog] \"},\"create_report_incomplete_issue\":{},\"missing_data\":{},\"missing_tool\":{},\"noop\":{\"max\":1,\"report-as-issue\":\"true\"},\"report_incomplete\":{},\"update_release\":{\"max\":1}}\n GH_AW_SAFE_OUTPUTS_CONFIG_185484bc160cdce2_EOF\n - name: Write Safe Outputs Tools\n env:\n GH_AW_TOOLS_META_JSON: |\n {\n \"description_suffixes\": {\n \"create_pull_request\": \" CONSTRAINTS: Maximum 1 pull request(s) can be created. Title will be prefixed with \\\"[changelog] \\\". Labels [\\\"automation\\\" \\\"changelog\\\"] will be automatically added.\",\n \"update_release\": \" CONSTRAINTS: Maximum 1 release(s) can be updated.\"\n },\n \"repo_params\": {},\n \"dynamic_tools\": []\n }\n GH_AW_VALIDATION_JSON: |\n {\n \"create_pull_request\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"body\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"branch\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"draft\": {\n \"type\": \"boolean\"\n },\n \"labels\": {\n \"type\": \"array\",\n \"itemType\": \"string\",\n \"itemSanitize\": true,\n \"itemMaxLength\": 128\n },\n \"repo\": {\n \"type\": \"string\",\n \"maxLength\": 256\n },\n \"title\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n }\n }\n },\n \"missing_data\": {\n \"defaultMax\": 20,\n \"fields\": {\n \"alternatives\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"context\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"data_type\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n },\n \"reason\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n }\n }\n },\n \"missing_tool\": {\n \"defaultMax\": 20,\n \"fields\": {\n \"alternatives\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 512\n },\n \"reason\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"tool\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n }\n }\n },\n \"noop\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"message\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n }\n }\n },\n \"report_incomplete\": {\n \"defaultMax\": 5,\n \"fields\": {\n \"details\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"reason\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 1024\n }\n }\n },\n \"update_release\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"body\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"operation\": {\n \"required\": true,\n \"type\": \"string\",\n \"enum\": [\n \"replace\",\n \"append\",\n \"prepend\"\n ]\n },\n \"tag\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n }\n }\n }\n }\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_safe_outputs_tools.cjs');\n await main();\n - name: Generate Safe Outputs MCP Server Config\n id: safe-outputs-config\n run: |\n # Generate a secure random API key (360 bits of entropy, 40+ chars)\n # Mask immediately to prevent timing vulnerabilities\n API_KEY=$(openssl rand -base64 45 | tr -d '/+=')\n echo \"::add-mask::${API_KEY}\"\n \n PORT=3001\n \n # Set outputs for next steps\n {\n echo \"safe_outputs_api_key=${API_KEY}\"\n echo \"safe_outputs_port=${PORT}\"\n } >> \"$GITHUB_OUTPUT\"\n \n echo \"Safe Outputs MCP server will run on port ${PORT}\"\n \n - name: Start Safe Outputs MCP HTTP Server\n id: safe-outputs-start\n env:\n DEBUG: '*'\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-config.outputs.safe_outputs_port }}\n GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-config.outputs.safe_outputs_api_key }}\n GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/tools.json\n GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/config.json\n GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs\n run: |\n # Environment variables are set above to prevent template injection\n export DEBUG\n export GH_AW_SAFE_OUTPUTS\n export GH_AW_SAFE_OUTPUTS_PORT\n export GH_AW_SAFE_OUTPUTS_API_KEY\n export GH_AW_SAFE_OUTPUTS_TOOLS_PATH\n export GH_AW_SAFE_OUTPUTS_CONFIG_PATH\n export GH_AW_MCP_LOG_DIR\n \n bash \"${RUNNER_TEMP}/gh-aw/actions/start_safe_outputs_server.sh\"\n \n - name: Start MCP Gateway\n id: start-mcp-gateway\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-start.outputs.api_key }}\n GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-start.outputs.port }}\n GITHUB_MCP_GUARD_MIN_INTEGRITY: ${{ steps.determine-automatic-lockdown.outputs.min_integrity }}\n GITHUB_MCP_GUARD_REPOS: ${{ steps.determine-automatic-lockdown.outputs.repos }}\n GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n run: |\n set -eo pipefail\n mkdir -p /tmp/gh-aw/mcp-config\n \n # Export gateway environment variables for MCP config and gateway script\n export MCP_GATEWAY_PORT=\"80\"\n export MCP_GATEWAY_DOMAIN=\"host.docker.internal\"\n MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=')\n echo \"::add-mask::${MCP_GATEWAY_API_KEY}\"\n export MCP_GATEWAY_API_KEY\n export MCP_GATEWAY_PAYLOAD_DIR=\"/tmp/gh-aw/mcp-payloads\"\n mkdir -p \"${MCP_GATEWAY_PAYLOAD_DIR}\"\n export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD=\"524288\"\n export DEBUG=\"*\"\n \n export GH_AW_ENGINE=\"copilot\"\n export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host -v /var/run/docker.sock:/var/run/docker.sock -e MCP_GATEWAY_PORT -e MCP_GATEWAY_DOMAIN -e MCP_GATEWAY_API_KEY -e MCP_GATEWAY_PAYLOAD_DIR -e MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD -e DEBUG -e MCP_GATEWAY_LOG_DIR -e GH_AW_MCP_LOG_DIR -e GH_AW_SAFE_OUTPUTS -e GH_AW_SAFE_OUTPUTS_CONFIG_PATH -e GH_AW_SAFE_OUTPUTS_TOOLS_PATH -e GH_AW_ASSETS_BRANCH -e GH_AW_ASSETS_MAX_SIZE_KB -e GH_AW_ASSETS_ALLOWED_EXTS -e DEFAULT_BRANCH -e GITHUB_MCP_SERVER_TOKEN -e GITHUB_MCP_GUARD_MIN_INTEGRITY -e GITHUB_MCP_GUARD_REPOS -e GITHUB_REPOSITORY -e GITHUB_SERVER_URL -e GITHUB_SHA -e GITHUB_WORKSPACE -e GITHUB_TOKEN -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RUN_ATTEMPT -e GITHUB_JOB -e GITHUB_ACTION -e GITHUB_EVENT_NAME -e GITHUB_EVENT_PATH -e GITHUB_ACTOR -e GITHUB_ACTOR_ID -e GITHUB_TRIGGERING_ACTOR -e GITHUB_WORKFLOW -e GITHUB_WORKFLOW_REF -e GITHUB_WORKFLOW_SHA -e GITHUB_REF -e GITHUB_REF_NAME -e GITHUB_REF_TYPE -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GH_AW_SAFE_OUTPUTS_PORT -e GH_AW_SAFE_OUTPUTS_API_KEY -v /tmp/gh-aw/mcp-payloads:/tmp/gh-aw/mcp-payloads:rw -v /opt:/opt:ro -v /tmp:/tmp:rw -v '\"${GITHUB_WORKSPACE}\"':'\"${GITHUB_WORKSPACE}\"':rw ghcr.io/github/gh-aw-mcpg:v0.2.17'\n \n mkdir -p /home/runner/.copilot\n cat << GH_AW_MCP_CONFIG_d0d73da3b3e2991f_EOF | bash \"${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.sh\"\n {\n \"mcpServers\": {\n \"github\": {\n \"type\": \"stdio\",\n \"container\": \"ghcr.io/github/github-mcp-server:v0.32.0\",\n \"env\": {\n \"GITHUB_HOST\": \"\\${GITHUB_SERVER_URL}\",\n \"GITHUB_PERSONAL_ACCESS_TOKEN\": \"\\${GITHUB_MCP_SERVER_TOKEN}\",\n \"GITHUB_READ_ONLY\": \"1\",\n \"GITHUB_TOOLSETS\": \"context,repos,issues,pull_requests\"\n },\n \"guard-policies\": {\n \"allow-only\": {\n \"min-integrity\": \"$GITHUB_MCP_GUARD_MIN_INTEGRITY\",\n \"repos\": \"$GITHUB_MCP_GUARD_REPOS\"\n }\n }\n },\n \"safeoutputs\": {\n \"type\": \"http\",\n \"url\": \"http://host.docker.internal:$GH_AW_SAFE_OUTPUTS_PORT\",\n \"headers\": {\n \"Authorization\": \"\\${GH_AW_SAFE_OUTPUTS_API_KEY}\"\n },\n \"guard-policies\": {\n \"write-sink\": {\n \"accept\": [\n \"*\"\n ]\n }\n }\n }\n },\n \"gateway\": {\n \"port\": $MCP_GATEWAY_PORT,\n \"domain\": \"${MCP_GATEWAY_DOMAIN}\",\n \"apiKey\": \"${MCP_GATEWAY_API_KEY}\",\n \"payloadDir\": \"${MCP_GATEWAY_PAYLOAD_DIR}\"\n }\n }\n GH_AW_MCP_CONFIG_d0d73da3b3e2991f_EOF\n - name: Download activation artifact\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: activation\n path: /tmp/gh-aw\n - name: Clean git credentials\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/clean_git_credentials.sh\"\n - name: Execute GitHub Copilot CLI\n id: agentic_execution\n # Copilot CLI tool arguments (sorted):\n timeout-minutes: 15\n run: |\n set -o pipefail\n touch /tmp/gh-aw/agent-step-summary.md\n # shellcheck disable=SC1003\n sudo -E awf --container-workdir \"${GITHUB_WORKSPACE}\" --mount \"${RUNNER_TEMP}/gh-aw:${RUNNER_TEMP}/gh-aw:ro\" --mount \"${RUNNER_TEMP}/gh-aw:/host${RUNNER_TEMP}/gh-aw:ro\" --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --allow-domains api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --image-tag 0.25.18 --skip-pull --enable-api-proxy \\\n -- /bin/bash -c 'node ${RUNNER_TEMP}/gh-aw/actions/copilot_driver.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --allow-all-tools --allow-all-paths --add-dir \"${GITHUB_WORKSPACE}\" --prompt \"$(cat /tmp/gh-aw/aw-prompts/prompt.txt)\"' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log\n env:\n COPILOT_AGENT_RUNNER_TYPE: STANDALONE\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || '' }}\n GH_AW_MCP_CONFIG: /home/runner/.copilot/mcp-config.json\n GH_AW_PHASE: agent\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_VERSION: v0.67.4\n GITHUB_API_URL: ${{ github.api_url }}\n GITHUB_AW: true\n GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows\n GITHUB_HEAD_REF: ${{ github.head_ref }}\n GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n GITHUB_REF_NAME: ${{ github.ref_name }}\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md\n GITHUB_WORKSPACE: ${{ github.workspace }}\n GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_AUTHOR_NAME: github-actions[bot]\n GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_COMMITTER_NAME: github-actions[bot]\n XDG_CONFIG_HOME: /home/runner\n - name: Detect inference access error\n id: detect-inference-error\n if: always()\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/detect_inference_access_error.sh\"\n - name: Configure Git credentials\n env:\n REPO_NAME: ${{ github.repository }}\n SERVER_URL: ${{ github.server_url }}\n GITHUB_TOKEN: ${{ github.token }}\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git config --global am.keepcr true\n # Re-authenticate git with GitHub token\n SERVER_URL_STRIPPED=\"${SERVER_URL#https://}\"\n git remote set-url origin \"https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git\"\n echo \"Git configured with standard GitHub Actions identity\"\n - name: Copy Copilot session state files to logs\n if: always()\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/copy_copilot_session_state.sh\"\n - name: Stop MCP Gateway\n if: always()\n continue-on-error: true\n env:\n MCP_GATEWAY_PORT: ${{ steps.start-mcp-gateway.outputs.gateway-port }}\n MCP_GATEWAY_API_KEY: ${{ steps.start-mcp-gateway.outputs.gateway-api-key }}\n GATEWAY_PID: ${{ steps.start-mcp-gateway.outputs.gateway-pid }}\n run: |\n bash \"${RUNNER_TEMP}/gh-aw/actions/stop_mcp_gateway.sh\" \"$GATEWAY_PID\"\n - name: Redact secrets in logs\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs');\n await main();\n env:\n GH_AW_SECRET_NAMES: 'COPILOT_GITHUB_TOKEN,GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN'\n SECRET_COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }}\n SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }}\n SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n - name: Append agent step summary\n if: always()\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/append_agent_step_summary.sh\"\n - name: Copy Safe Outputs\n if: always()\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n run: |\n mkdir -p /tmp/gh-aw\n cp \"$GH_AW_SAFE_OUTPUTS\" /tmp/gh-aw/safeoutputs.jsonl 2>/dev/null || true\n - name: Ingest agent output\n id: collect_output\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_ALLOWED_DOMAINS: \"api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com\"\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_API_URL: ${{ github.api_url }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/collect_ndjson_output.cjs');\n await main();\n - name: Parse agent logs for step summary\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_copilot_log.cjs');\n await main();\n - name: Parse MCP Gateway logs for step summary\n if: always()\n id: parse-mcp-gateway\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_mcp_gateway_log.cjs');\n await main();\n - name: Print firewall logs\n if: always()\n continue-on-error: true\n env:\n AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs\n run: |\n # Fix permissions on firewall logs so they can be uploaded as artifacts\n # AWF runs with sudo, creating files owned by root\n sudo chmod -R a+r /tmp/gh-aw/sandbox/firewall/logs 2>/dev/null || true\n # Only run awf logs summary if awf command exists (it may not be installed if workflow failed before install step)\n if command -v awf &> /dev/null; then\n awf logs summary | tee -a \"$GITHUB_STEP_SUMMARY\"\n else\n echo 'AWF binary not installed, skipping firewall log summary'\n fi\n - name: Parse token usage for step summary\n if: always()\n continue-on-error: true\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs');\n await main();\n - name: Write agent output placeholder if missing\n if: always()\n run: |\n if [ ! -f /tmp/gh-aw/agent_output.json ]; then\n echo '{\"items\":[]}' > /tmp/gh-aw/agent_output.json\n fi\n - name: Upload agent artifacts\n if: always()\n continue-on-error: true\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: agent\n path: |\n /tmp/gh-aw/aw-prompts/prompt.txt\n /tmp/gh-aw/sandbox/agent/logs/\n /tmp/gh-aw/redacted-urls.log\n /tmp/gh-aw/mcp-logs/\n /tmp/gh-aw/agent_usage.json\n /tmp/gh-aw/agent-stdio.log\n /tmp/gh-aw/agent/\n /tmp/gh-aw/github_rate_limits.jsonl\n /tmp/gh-aw/safeoutputs.jsonl\n /tmp/gh-aw/agent_output.json\n /tmp/gh-aw/aw-*.patch\n /tmp/gh-aw/aw-*.bundle\n if-no-files-found: ignore\n - name: Upload firewall audit logs\n if: always()\n continue-on-error: true\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: firewall-audit-logs\n path: |\n /tmp/gh-aw/sandbox/firewall/logs/\n /tmp/gh-aw/sandbox/firewall/audit/\n if-no-files-found: ignore\n\n conclusion:\n needs:\n - activation\n - agent\n - detection\n - safe_outputs\n if: always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true')\n runs-on: ubuntu-slim\n permissions:\n contents: write\n issues: write\n pull-requests: write\n concurrency:\n group: \"gh-aw-conclusion-release-changelog\"\n cancel-in-progress: false\n outputs:\n incomplete_count: ${{ steps.report_incomplete.outputs.incomplete_count }}\n noop_message: ${{ steps.noop.outputs.noop_message }}\n tools_reported: ${{ steps.missing_tool.outputs.tools_reported }}\n total_count: ${{ steps.missing_tool.outputs.total_count }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Process No-Op Messages\n id: noop\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_NOOP_MAX: \"1\"\n GH_AW_WORKFLOW_NAME: \"Release Changelog Generator\"\n GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\n GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }}\n GH_AW_NOOP_REPORT_AS_ISSUE: \"true\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_noop_message.cjs');\n await main();\n - name: Record missing tool\n id: missing_tool\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_MISSING_TOOL_CREATE_ISSUE: \"true\"\n GH_AW_WORKFLOW_NAME: \"Release Changelog Generator\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/missing_tool.cjs');\n await main();\n - name: Record incomplete\n id: report_incomplete\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_REPORT_INCOMPLETE_CREATE_ISSUE: \"true\"\n GH_AW_WORKFLOW_NAME: \"Release Changelog Generator\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/report_incomplete_handler.cjs');\n await main();\n - name: Handle agent failure\n id: handle_agent_failure\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_WORKFLOW_NAME: \"Release Changelog Generator\"\n GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\n GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }}\n GH_AW_WORKFLOW_ID: \"release-changelog\"\n GH_AW_ENGINE_ID: \"copilot\"\n GH_AW_SECRET_VERIFICATION_RESULT: ${{ needs.activation.outputs.secret_verification_result }}\n GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }}\n GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }}\n GH_AW_CODE_PUSH_FAILURE_ERRORS: ${{ needs.safe_outputs.outputs.code_push_failure_errors }}\n GH_AW_CODE_PUSH_FAILURE_COUNT: ${{ needs.safe_outputs.outputs.code_push_failure_count }}\n GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }}\n GH_AW_GROUP_REPORTS: \"false\"\n GH_AW_FAILURE_REPORT_AS_ISSUE: \"true\"\n GH_AW_TIMEOUT_MINUTES: \"15\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_agent_failure.cjs');\n await main();\n\n detection:\n needs:\n - activation\n - agent\n if: >\n always() && needs.agent.result != 'skipped' && (needs.agent.outputs.output_types != '' || needs.agent.outputs.has_patch == 'true')\n runs-on: ubuntu-latest\n permissions:\n contents: read\n outputs:\n detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }}\n detection_success: ${{ steps.detection_conclusion.outputs.success }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Checkout repository for patch context\n if: needs.agent.outputs.has_patch == 'true'\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n # --- Threat Detection ---\n - name: Download container images\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh\" ghcr.io/github/gh-aw-firewall/agent:0.25.18 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.18 ghcr.io/github/gh-aw-firewall/squid:0.25.18\n - name: Check if detection needed\n id: detection_guard\n if: always()\n env:\n OUTPUT_TYPES: ${{ needs.agent.outputs.output_types }}\n HAS_PATCH: ${{ needs.agent.outputs.has_patch }}\n run: |\n if [[ -n \"$OUTPUT_TYPES\" || \"$HAS_PATCH\" == \"true\" ]]; then\n echo \"run_detection=true\" >> \"$GITHUB_OUTPUT\"\n echo \"Detection will run: output_types=$OUTPUT_TYPES, has_patch=$HAS_PATCH\"\n else\n echo \"run_detection=false\" >> \"$GITHUB_OUTPUT\"\n echo \"Detection skipped: no agent outputs or patches to analyze\"\n fi\n - name: Clear MCP configuration for detection\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n rm -f /tmp/gh-aw/mcp-config/mcp-servers.json\n rm -f /home/runner/.copilot/mcp-config.json\n rm -f \"$GITHUB_WORKSPACE/.gemini/settings.json\"\n - name: Prepare threat detection files\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n mkdir -p /tmp/gh-aw/threat-detection/aw-prompts\n cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true\n cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true\n for f in /tmp/gh-aw/aw-*.patch; do\n [ -f \"$f\" ] && cp \"$f\" /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n done\n for f in /tmp/gh-aw/aw-*.bundle; do\n [ -f \"$f\" ] && cp \"$f\" /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n done\n echo \"Prepared threat detection files:\"\n ls -la /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n - name: Setup threat detection\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n WORKFLOW_NAME: \"Release Changelog Generator\"\n WORKFLOW_DESCRIPTION: \"Generates release notes from merged PRs/commits. Triggered by the publish workflow or manually via workflow_dispatch.\"\n HAS_PATCH: ${{ needs.agent.outputs.has_patch }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/setup_threat_detection.cjs');\n await main();\n - name: Ensure threat-detection directory and log\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n mkdir -p /tmp/gh-aw/threat-detection\n touch /tmp/gh-aw/threat-detection/detection.log\n - name: Install GitHub Copilot CLI\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh\" 1.0.20\n env:\n GH_HOST: github.com\n - name: Install AWF binary\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh\" v0.25.18\n - name: Execute GitHub Copilot CLI\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n id: detection_agentic_execution\n # Copilot CLI tool arguments (sorted):\n timeout-minutes: 20\n run: |\n set -o pipefail\n touch /tmp/gh-aw/agent-step-summary.md\n # shellcheck disable=SC1003\n sudo -E awf --container-workdir \"${GITHUB_WORKSPACE}\" --mount \"${RUNNER_TEMP}/gh-aw:${RUNNER_TEMP}/gh-aw:ro\" --mount \"${RUNNER_TEMP}/gh-aw:/host${RUNNER_TEMP}/gh-aw:ro\" --env-all --exclude-env COPILOT_GITHUB_TOKEN --allow-domains api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,github.com,host.docker.internal,telemetry.enterprise.githubcopilot.com --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --image-tag 0.25.18 --skip-pull --enable-api-proxy \\\n -- /bin/bash -c 'node ${RUNNER_TEMP}/gh-aw/actions/copilot_driver.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --allow-all-tools --add-dir \"${GITHUB_WORKSPACE}\" --prompt \"$(cat /tmp/gh-aw/aw-prompts/prompt.txt)\"' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log\n env:\n COPILOT_AGENT_RUNNER_TYPE: STANDALONE\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || '' }}\n GH_AW_PHASE: detection\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_VERSION: v0.67.4\n GITHUB_API_URL: ${{ github.api_url }}\n GITHUB_AW: true\n GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows\n GITHUB_HEAD_REF: ${{ github.head_ref }}\n GITHUB_REF_NAME: ${{ github.ref_name }}\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md\n GITHUB_WORKSPACE: ${{ github.workspace }}\n GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_AUTHOR_NAME: github-actions[bot]\n GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_COMMITTER_NAME: github-actions[bot]\n XDG_CONFIG_HOME: /home/runner\n - name: Upload threat detection log\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: detection\n path: /tmp/gh-aw/threat-detection/detection.log\n if-no-files-found: ignore\n - name: Parse and conclude threat detection\n id: detection_conclusion\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n RUN_DETECTION: ${{ steps.detection_guard.outputs.run_detection }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_threat_detection_results.cjs');\n await main();\n\n safe_outputs:\n needs:\n - activation\n - agent\n - detection\n if: (!cancelled()) && needs.agent.result != 'skipped' && needs.detection.result == 'success'\n runs-on: ubuntu-slim\n permissions:\n contents: write\n issues: write\n pull-requests: write\n timeout-minutes: 15\n env:\n GH_AW_CALLER_WORKFLOW_ID: \"${{ github.repository }}/release-changelog\"\n GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens }}\n GH_AW_ENGINE_ID: \"copilot\"\n GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }}\n GH_AW_WORKFLOW_ID: \"release-changelog\"\n GH_AW_WORKFLOW_NAME: \"Release Changelog Generator\"\n outputs:\n code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }}\n code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }}\n create_discussion_error_count: ${{ steps.process_safe_outputs.outputs.create_discussion_error_count }}\n create_discussion_errors: ${{ steps.process_safe_outputs.outputs.create_discussion_errors }}\n created_pr_number: ${{ steps.process_safe_outputs.outputs.created_pr_number }}\n created_pr_url: ${{ steps.process_safe_outputs.outputs.created_pr_url }}\n process_safe_outputs_processed_count: ${{ steps.process_safe_outputs.outputs.processed_count }}\n process_safe_outputs_temporary_id_map: ${{ steps.process_safe_outputs.outputs.temporary_id_map }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Download patch artifact\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: agent\n path: /tmp/gh-aw/\n - name: Checkout repository\n if: (!cancelled()) && needs.agent.result != 'skipped' && contains(needs.agent.outputs.output_types, 'create_pull_request')\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n ref: ${{ github.base_ref || github.event.pull_request.base.ref || github.ref_name || github.event.repository.default_branch }}\n token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n persist-credentials: false\n fetch-depth: 1\n - name: Configure Git credentials\n if: (!cancelled()) && needs.agent.result != 'skipped' && contains(needs.agent.outputs.output_types, 'create_pull_request')\n env:\n REPO_NAME: ${{ github.repository }}\n SERVER_URL: ${{ github.server_url }}\n GIT_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git config --global am.keepcr true\n # Re-authenticate git with GitHub token\n SERVER_URL_STRIPPED=\"${SERVER_URL#https://}\"\n git remote set-url origin \"https://x-access-token:${GIT_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git\"\n echo \"Git configured with standard GitHub Actions identity\"\n - name: Configure GH_HOST for enterprise compatibility\n id: ghes-host-config\n shell: bash\n run: |\n # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct\n # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op.\n GH_HOST=\"${GITHUB_SERVER_URL#https://}\"\n GH_HOST=\"${GH_HOST#http://}\"\n echo \"GH_HOST=${GH_HOST}\" >> \"$GITHUB_ENV\"\n - name: Process Safe Outputs\n id: process_safe_outputs\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_ALLOWED_DOMAINS: \"api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com\"\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_API_URL: ${{ github.api_url }}\n GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: \"{\\\"create_pull_request\\\":{\\\"draft\\\":false,\\\"labels\\\":[\\\"automation\\\",\\\"changelog\\\"],\\\"max\\\":1,\\\"max_patch_size\\\":1024,\\\"protected_files\\\":[\\\"package.json\\\",\\\"bun.lockb\\\",\\\"bunfig.toml\\\",\\\"deno.json\\\",\\\"deno.jsonc\\\",\\\"deno.lock\\\",\\\"global.json\\\",\\\"NuGet.Config\\\",\\\"Directory.Packages.props\\\",\\\"mix.exs\\\",\\\"mix.lock\\\",\\\"go.mod\\\",\\\"go.sum\\\",\\\"stack.yaml\\\",\\\"stack.yaml.lock\\\",\\\"pom.xml\\\",\\\"build.gradle\\\",\\\"build.gradle.kts\\\",\\\"settings.gradle\\\",\\\"settings.gradle.kts\\\",\\\"gradle.properties\\\",\\\"package-lock.json\\\",\\\"yarn.lock\\\",\\\"pnpm-lock.yaml\\\",\\\"npm-shrinkwrap.json\\\",\\\"requirements.txt\\\",\\\"Pipfile\\\",\\\"Pipfile.lock\\\",\\\"pyproject.toml\\\",\\\"setup.py\\\",\\\"setup.cfg\\\",\\\"Gemfile\\\",\\\"Gemfile.lock\\\",\\\"uv.lock\\\",\\\"CODEOWNERS\\\",\\\"AGENTS.md\\\"],\\\"protected_path_prefixes\\\":[\\\".github/\\\",\\\".agents/\\\"],\\\"title_prefix\\\":\\\"[changelog] \\\"},\\\"create_report_incomplete_issue\\\":{},\\\"missing_data\\\":{},\\\"missing_tool\\\":{},\\\"noop\\\":{\\\"max\\\":1,\\\"report-as-issue\\\":\\\"true\\\"},\\\"report_incomplete\\\":{},\\\"update_release\\\":{\\\"max\\\":1}}\"\n GH_AW_CI_TRIGGER_TOKEN: ${{ secrets.GH_AW_CI_TRIGGER_TOKEN }}\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/safe_output_handler_manager.cjs');\n await main();\n - name: Upload Safe Outputs Items\n if: always()\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: safe-outputs-items\n path: /tmp/gh-aw/safe-output-items.jsonl\n if-no-files-found: ignore\n\n" }, { "path": ".github/workflows/release-changelog.md", "content": "---\ndescription: Generates release notes from merged PRs/commits. Triggered by the publish workflow or manually via workflow_dispatch.\non:\n workflow_dispatch:\n inputs:\n tag:\n description: \"Release tag to generate changelog for (e.g., v0.1.30)\"\n required: true\n type: string\npermissions:\n contents: read\n actions: read\n issues: read\n pull-requests: read\ntools:\n github:\n toolsets: [default]\n edit:\nsafe-outputs:\n create-pull-request:\n title-prefix: \"[changelog] \"\n labels: [automation, changelog]\n draft: false\n update-release:\n max: 1\ntimeout-minutes: 15\n---\n\n# Release Changelog Generator\n\nYou are an AI agent that generates well-formatted release notes when a release of the Copilot SDK is published.\n\n- **For stable releases** (tag has no prerelease suffix like `-preview`): update `CHANGELOG.md` via a PR AND update the GitHub Release notes.\n- **For prerelease releases** (tag contains `-preview` or similar suffix): update the GitHub Release notes ONLY. Do NOT modify `CHANGELOG.md` or create a PR.\n\nDetermine which type of release this is by inspecting the tag or fetching the release metadata.\n\n## Context\n\n- Repository: ${{ github.repository }}\n- Release tag: ${{ github.event.inputs.tag }}\n\nUse the GitHub API to fetch the release corresponding to `${{ github.event.inputs.tag }}` to get its name, publish date, prerelease status, and other metadata.\n\n## Your Task\n\n### Step 1: Identify the version range\n\n1. **Before any `git log`, `git show`, tag lookup, or commit-range query, first convert the workflow checkout into a full clone by running:**\n ```bash\n git fetch --prune --tags --unshallow origin || git fetch --prune --tags origin\n ```\n This is **mandatory**. The workflow checkout may be shallow, which can make tag ranges and commit counts incomplete or outright wrong. Do not trust local git history until this command succeeds.\n2. The **new version** is the release tag: `${{ github.event.inputs.tag }}`\n3. Fetch the release metadata to determine if this is a **stable** or **prerelease** release.\n4. Determine the **previous version** to diff against:\n - **For stable releases**: find the previous **stable** release (skip prereleases). Check `CHANGELOG.md` for the most recent version heading (`## [vX.Y.Z](...)`), or fall back to listing releases via the API. This means stable changelogs include ALL changes since the last stable release, even if some were already mentioned in prerelease notes.\n - **For prerelease releases**: find the most recent release of **any kind** (stable or prerelease) that precedes this one. This way prerelease notes only cover what's new since the last release.\n5. If no previous release exists at all, use the first commit in the repo as the starting point.\n6. After identifying the range, verify it by listing the commits in `PREVIOUS_TAG..NEW_TAG`. If the local result still looks suspiciously small or inconsistent, do **not** proceed based on local git alone — use the GitHub tools as the source of truth for the commits and PRs in the release.\n\n### Step 2: Gather changes\n\n1. Use the GitHub tools to list commits between the last documented tag (from Step 1) and the new release tag.\n2. Also list merged pull requests in that range. For each PR, note:\n - PR number and title\n - The PR author\n - Which SDK(s) were affected (look for prefixes like `[C#]`, `[Python]`, `[Go]`, `[Node]` in the title, or infer from changed files)\n3. Ignore:\n - Dependabot/bot PRs that only bump internal dependencies (like `Update @github/copilot to ...`) unless they bring user-facing changes\n - Merge commits with no meaningful content\n - Preview/prerelease-only changes that were already documented\n\n### Step 3: Categorize and write up\n\nSeparate the changes into two groups:\n\n1. **Highlighted features**: Any interesting new feature or significant improvement that deserves its own section with a description and code snippet(s). Read the PR diff and source code to understand the feature well enough to write about it.\n2. **Other changes**: Bug fixes, minor improvements, and smaller features that can be summarized in a single bullet each.\n\nOnly include changes that are **user-visible in the published SDK packages**. Skip anything that only affects docs, CI, build tooling, GitHub workflows, test infrastructure, or other internal-only concerns.\n\nAdditionally, identify **new contributors** — anyone whose first merged PR to this repo falls within this release range. You can determine this by checking whether the author has any earlier merged PRs in the repository.\n\n### Step 4: Update CHANGELOG.md (stable releases only)\n\n**Skip this step entirely for prerelease releases.**\n\n1. Read the current `CHANGELOG.md` file.\n2. Add the new version entry **at the top** of the file, right after the title/header.\n\n**Format for each highlighted feature** — use an `### Feature:` or `### Fix:` heading, a 1-2 sentence description explaining what it does and why it matters, and at least one short code snippet (max 3 lines). Focus on **TypeScript** and **C#** as the primary languages. Only show Go/Python when giving a list of one-liner equivalents across all languages, or when their usage pattern is meaningfully different.\n\n**Format for other changes** — a single `### Other changes` section with a flat bulleted list. Each bullet has a lowercase prefix (`feature:`, `bugfix:`, `improvement:`) and a one-line description linking to the PR. **However, if there are no highlighted features above it, omit the `### Other changes` heading entirely** — just list the bullets directly under the version heading.\n\n3. Use the release's publish date (from the GitHub Release metadata), not today's date. For `workflow_dispatch` runs, fetch the release by tag to get the date.\n4. If there are new contributors, add a `### New contributors` section at the end listing each with a link to their first PR:\n ```\n ### New contributors\n - @username made their first contribution in [#123](https://github.com/github/copilot-sdk/pull/123)\n ```\n Omit this section if there are no new contributors.\n5. Make sure the existing content below is preserved exactly as-is.\n\n### Step 5: Create a Pull Request (stable releases only)\n\n**Skip this step entirely for prerelease releases.**\n\nUse the `create-pull-request` output to submit your changes. The PR should:\n- Have a clear title like \"Add changelog for vX.Y.Z\"\n- Include a brief body summarizing the number of changes\n\n### Step 6: Update the GitHub Release\n\nUse the `update-release` output to replace the auto-generated release notes with your nicely formatted changelog. **Do not include the version heading** (`## [vX.Y.Z](...) (date)`) in the release notes — the release already has a title showing the version. Start directly with the feature sections or other changes list.\n\n## Example Output\n\nHere is an example of what a changelog entry should look like, based on real commits from this repo. **Follow this style exactly.**\n\n````markdown\n## [v0.1.28](https://github.com/github/copilot-sdk/releases/tag/v0.1.28) (2026-02-14)\n\n### Feature: support overriding built-in tools\n\nApplications can now override built-in tools such as `edit` or `grep`. To do this, register a custom tool with the same name and set the override flag. ([#636](https://github.com/github/copilot-sdk/pull/636))\n\n```ts\nsession.defineTool(\"edit\", { isOverride: true }, async (params) => {\n // custom edit implementation\n});\n```\n\n```cs\nsession.DefineTool(\"edit\", new ToolOptions { IsOverride = true }, async (params) => {\n // custom edit implementation\n});\n```\n\n### Feature: simpler API for changing model mid-session\n\nWhile `session.rpc.models.setModel()` already worked, there is now a convenience method directly on the session object. ([#621](https://github.com/github/copilot-sdk/pull/621))\n\n- TypeScript: `session.setModel(\"gpt-4o\")`\n- C#: `session.SetModel(\"gpt-4o\")`\n- Python: `session.set_model(\"gpt-4o\")`\n- Go: `session.SetModel(\"gpt-4o\")`\n\n### Other changes\n\n- bugfix: **[Python]** correct `PermissionHandler.approve_all` type annotations ([#618](https://github.com/github/copilot-sdk/pull/618))\n- improvement: **[C#]** use event delegate for thread-safe, insertion-ordered event handler dispatch ([#624](https://github.com/github/copilot-sdk/pull/624))\n- improvement: **[C#]** deduplicate `OnDisposeCall` and improve implementation ([#626](https://github.com/github/copilot-sdk/pull/626))\n- improvement: **[C#]** remove unnecessary `SemaphoreSlim` locks for handler fields ([#625](https://github.com/github/copilot-sdk/pull/625))\n\n### New contributors\n\n- @chlowell made their first contribution in [#586](https://github.com/github/copilot-sdk/pull/586)\n- @feici02 made their first contribution in [#566](https://github.com/github/copilot-sdk/pull/566)\n````\n\n**Key rules visible in the example:**\n- Highlighted features get their own `### Feature:` heading, a short description, and code snippets\n- Code snippets are TypeScript and C# primarily; Go/Python only when listing one-liner equivalents or when meaningfully different\n- The `### Other changes` section is a flat bulleted list with lowercase `bugfix:` / `feature:` / `improvement:` prefixes\n- PR numbers are linked inline, not at the end with author attribution (keep it clean)\n\n## Guidelines\n\n1. **Be concise**: Each bullet should be one short sentence. Don't over-explain.\n2. **Be accurate**: Only include changes that actually landed in this release range. Don't hallucinate PRs.\n3. **Attribute correctly**: Always link to the PR number. Do not add explicit author attribution.\n4. **Skip noise**: Don't include trivial changes (typo fixes in comments, whitespace changes) unless they're the only changes.\n5. **Preserve history**: Never modify existing entries in CHANGELOG.md — only prepend new ones.\n6. **Handle edge cases**: If there are no meaningful changes (e.g., only internal dependency bumps), still create an entry noting \"Internal dependency updates only\" or similar.\n" }, { "path": ".github/workflows/scenario-builds.yml", "content": "name: \"Scenario Build Verification\"\n\non:\n pull_request:\n types: [opened, synchronize, reopened, ready_for_review]\n paths:\n - \"test/scenarios/**\"\n - \"nodejs/src/**\"\n - \"python/copilot/**\"\n - \"go/**/*.go\"\n - \"dotnet/src/**\"\n - \".github/workflows/scenario-builds.yml\"\n push:\n branches:\n - main\n paths:\n - \"test/scenarios/**\"\n - \".github/workflows/scenario-builds.yml\"\n workflow_dispatch:\n merge_group:\n\npermissions:\n contents: read\n\njobs:\n # ── TypeScript ──────────────────────────────────────────────────────\n build-typescript:\n name: \"TypeScript scenarios\"\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n\n - uses: actions/setup-node@v6\n with:\n node-version: 22\n\n - uses: actions/cache@v4\n with:\n path: ~/.npm\n key: ${{ runner.os }}-npm-scenarios-${{ hashFiles('test/scenarios/**/package.json') }}\n restore-keys: |\n ${{ runner.os }}-npm-scenarios-\n\n # Build the SDK so local file: references resolve\n - name: Build SDK\n working-directory: nodejs\n run: npm ci --ignore-scripts\n\n - name: Build all TypeScript scenarios\n run: |\n PASS=0; FAIL=0; FAILURES=\"\"\n for dir in $(find test/scenarios -path '*/typescript/package.json' -exec dirname {} \\; | sort); do\n scenario=\"${dir#test/scenarios/}\"\n echo \"::group::$scenario\"\n if (cd \"$dir\" && npm install --ignore-scripts 2>&1); then\n echo \"✅ $scenario\"\n PASS=$((PASS + 1))\n else\n echo \"❌ $scenario\"\n FAIL=$((FAIL + 1))\n FAILURES=\"$FAILURES\\n $scenario\"\n fi\n echo \"::endgroup::\"\n done\n echo \"\"\n echo \"TypeScript builds: $PASS passed, $FAIL failed\"\n if [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$FAILURES\"\n exit 1\n fi\n\n # ── Python ──────────────────────────────────────────────────────────\n build-python:\n name: \"Python scenarios\"\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n\n - uses: actions/setup-python@v6\n with:\n python-version: \"3.12\"\n\n - name: Install Python SDK\n run: pip install -e python/\n\n - name: Compile and import-check all Python scenarios\n run: |\n PASS=0; FAIL=0; FAILURES=\"\"\n for main in $(find test/scenarios -path '*/python/main.py' | sort); do\n dir=$(dirname \"$main\")\n scenario=\"${dir#test/scenarios/}\"\n echo \"::group::$scenario\"\n if python3 -m py_compile \"$main\" 2>&1 && python3 -c \"import copilot\" 2>&1; then\n echo \"✅ $scenario\"\n PASS=$((PASS + 1))\n else\n echo \"❌ $scenario\"\n FAIL=$((FAIL + 1))\n FAILURES=\"$FAILURES\\n $scenario\"\n fi\n echo \"::endgroup::\"\n done\n echo \"\"\n echo \"Python builds: $PASS passed, $FAIL failed\"\n if [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$FAILURES\"\n exit 1\n fi\n\n # ── Go ──────────────────────────────────────────────────────────────\n build-go:\n name: \"Go scenarios\"\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n\n - uses: actions/setup-go@v6\n with:\n go-version: \"1.24\"\n cache: true\n cache-dependency-path: test/scenarios/**/go.sum\n\n - name: Build all Go scenarios\n run: |\n PASS=0; FAIL=0; FAILURES=\"\"\n for mod in $(find test/scenarios -path '*/go/go.mod' | sort); do\n dir=$(dirname \"$mod\")\n scenario=\"${dir#test/scenarios/}\"\n echo \"::group::$scenario\"\n if (cd \"$dir\" && go build ./... 2>&1); then\n echo \"✅ $scenario\"\n PASS=$((PASS + 1))\n else\n echo \"❌ $scenario\"\n FAIL=$((FAIL + 1))\n FAILURES=\"$FAILURES\\n $scenario\"\n fi\n echo \"::endgroup::\"\n done\n echo \"\"\n echo \"Go builds: $PASS passed, $FAIL failed\"\n if [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$FAILURES\"\n exit 1\n fi\n\n # ── C# ─────────────────────────────────────────────────────────────\n build-csharp:\n name: \"C# scenarios\"\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n\n - uses: actions/setup-dotnet@v5\n with:\n dotnet-version: \"10.0.x\"\n\n - uses: actions/cache@v4\n with:\n path: ~/.nuget/packages\n key: ${{ runner.os }}-nuget-scenarios-${{ hashFiles('test/scenarios/**/*.csproj') }}\n restore-keys: |\n ${{ runner.os }}-nuget-scenarios-\n\n - name: Build all C# scenarios\n run: |\n PASS=0; FAIL=0; FAILURES=\"\"\n for proj in $(find test/scenarios -name '*.csproj' | sort); do\n dir=$(dirname \"$proj\")\n scenario=\"${dir#test/scenarios/}\"\n echo \"::group::$scenario\"\n if (cd \"$dir\" && dotnet build --nologo 2>&1); then\n echo \"✅ $scenario\"\n PASS=$((PASS + 1))\n else\n echo \"❌ $scenario\"\n FAIL=$((FAIL + 1))\n FAILURES=\"$FAILURES\\n $scenario\"\n fi\n echo \"::endgroup::\"\n done\n echo \"\"\n echo \"C# builds: $PASS passed, $FAIL failed\"\n if [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$FAILURES\"\n exit 1\n fi\n" }, { "path": ".github/workflows/sdk-consistency-review.lock.yml", "content": "# gh-aw-metadata: {\"schema_version\":\"v3\",\"frontmatter_hash\":\"b1f707a5df4bab2e9be118c097a5767ac0b909cf3ee1547f71895c5b33ca342d\",\"compiler_version\":\"v0.67.4\",\"strict\":true,\"agent_id\":\"copilot\"}\n# gh-aw-manifest: {\"version\":1,\"secrets\":[\"COPILOT_GITHUB_TOKEN\",\"GH_AW_GITHUB_MCP_SERVER_TOKEN\",\"GH_AW_GITHUB_TOKEN\",\"GITHUB_TOKEN\"],\"actions\":[{\"repo\":\"actions/checkout\",\"sha\":\"de0fac2e4500dabe0009e67214ff5f5447ce83dd\",\"version\":\"v6.0.2\"},{\"repo\":\"actions/download-artifact\",\"sha\":\"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c\",\"version\":\"v8.0.1\"},{\"repo\":\"actions/github-script\",\"sha\":\"ed597411d8f924073f98dfc5c65a23a2325f34cd\",\"version\":\"v8\"},{\"repo\":\"actions/upload-artifact\",\"sha\":\"bbbca2ddaa5d8feaa63e36b76fdaad77386f024f\",\"version\":\"v7\"},{\"repo\":\"github/gh-aw-actions/setup\",\"sha\":\"9d6ae06250fc0ec536a0e5f35de313b35bad7246\",\"version\":\"v0.67.4\"}]}\n# ___ _ _ \n# / _ \\ | | (_) \n# | |_| | __ _ ___ _ __ | |_ _ ___ \n# | _ |/ _` |/ _ \\ '_ \\| __| |/ __|\n# | | | | (_| | __/ | | | |_| | (__ \n# \\_| |_/\\__, |\\___|_| |_|\\__|_|\\___|\n# __/ |\n# _ _ |___/ \n# | | | | / _| |\n# | | | | ___ _ __ _ __| |_| | _____ ____\n# | |/\\| |/ _ \\ '__| |/ /| _| |/ _ \\ \\ /\\ / / ___|\n# \\ /\\ / (_) | | | | ( | | | | (_) \\ V V /\\__ \\\n# \\/ \\/ \\___/|_| |_|\\_\\|_| |_|\\___/ \\_/\\_/ |___/\n#\n# This file was automatically generated by gh-aw (v0.67.4). DO NOT EDIT.\n#\n# To update this file, edit the corresponding .md file and run:\n# gh aw compile\n# Not all edits will cause changes to this file.\n#\n# For more information: https://github.github.com/gh-aw/introduction/overview/\n#\n# Reviews PRs to ensure features are implemented consistently across all SDK language implementations\n#\n# Secrets used:\n# - COPILOT_GITHUB_TOKEN\n# - GH_AW_GITHUB_MCP_SERVER_TOKEN\n# - GH_AW_GITHUB_TOKEN\n# - GITHUB_TOKEN\n#\n# Custom actions used:\n# - actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n# - actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n# - actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n# - actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n# - github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n\nname: \"SDK Consistency Review Agent\"\n\"on\":\n pull_request:\n paths:\n - nodejs/**\n - python/**\n - go/**\n - dotnet/**\n types:\n - opened\n - synchronize\n - reopened\n # roles: all # Roles processed as role check in pre-activation job\n workflow_dispatch:\n inputs:\n aw_context:\n default: \"\"\n description: Agent caller context (used internally by Agentic Workflows).\n required: false\n type: string\n pr_number:\n description: PR number to review\n required: true\n type: string\n\npermissions: {}\n\nconcurrency:\n group: \"gh-aw-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref || github.run_id }}\"\n cancel-in-progress: true\n\nrun-name: \"SDK Consistency Review Agent\"\n\njobs:\n activation:\n if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.id == github.repository_id\n runs-on: ubuntu-slim\n permissions:\n actions: read\n contents: read\n outputs:\n body: ${{ steps.sanitized.outputs.body }}\n comment_id: \"\"\n comment_repo: \"\"\n lockdown_check_failed: ${{ steps.generate_aw_info.outputs.lockdown_check_failed == 'true' }}\n model: ${{ steps.generate_aw_info.outputs.model }}\n secret_verification_result: ${{ steps.validate-secret.outputs.verification_result }}\n setup-trace-id: ${{ steps.setup.outputs.trace-id }}\n text: ${{ steps.sanitized.outputs.text }}\n title: ${{ steps.sanitized.outputs.title }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n - name: Generate agentic run info\n id: generate_aw_info\n env:\n GH_AW_INFO_ENGINE_ID: \"copilot\"\n GH_AW_INFO_ENGINE_NAME: \"GitHub Copilot CLI\"\n GH_AW_INFO_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || 'auto' }}\n GH_AW_INFO_VERSION: \"1.0.20\"\n GH_AW_INFO_AGENT_VERSION: \"1.0.20\"\n GH_AW_INFO_CLI_VERSION: \"v0.67.4\"\n GH_AW_INFO_WORKFLOW_NAME: \"SDK Consistency Review Agent\"\n GH_AW_INFO_EXPERIMENTAL: \"false\"\n GH_AW_INFO_SUPPORTS_TOOLS_ALLOWLIST: \"true\"\n GH_AW_INFO_STAGED: \"false\"\n GH_AW_INFO_ALLOWED_DOMAINS: '[\"defaults\"]'\n GH_AW_INFO_FIREWALL_ENABLED: \"true\"\n GH_AW_INFO_AWF_VERSION: \"v0.25.18\"\n GH_AW_INFO_AWMG_VERSION: \"\"\n GH_AW_INFO_FIREWALL_TYPE: \"squid\"\n GH_AW_COMPILED_STRICT: \"true\"\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_aw_info.cjs');\n await main(core, context);\n - name: Validate COPILOT_GITHUB_TOKEN secret\n id: validate-secret\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/validate_multi_secret.sh\" COPILOT_GITHUB_TOKEN 'GitHub Copilot CLI' https://github.github.com/gh-aw/reference/engines/#github-copilot-default\n env:\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n - name: Checkout .github and .agents folders\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n sparse-checkout: |\n .github\n .agents\n sparse-checkout-cone-mode: true\n fetch-depth: 1\n - name: Check workflow lock file\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_WORKFLOW_FILE: \"sdk-consistency-review.lock.yml\"\n GH_AW_CONTEXT_WORKFLOW_REF: \"${{ github.workflow_ref }}\"\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/check_workflow_timestamp_api.cjs');\n await main();\n - name: Check compile-agentic version\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_COMPILED_VERSION: \"v0.67.4\"\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/check_version_updates.cjs');\n await main();\n - name: Compute current body text\n id: sanitized\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/compute_text.cjs');\n await main();\n - name: Create prompt with built-in context\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_SAFE_OUTPUTS: ${{ runner.temp }}/gh-aw/safeoutputs/outputs.jsonl\n GH_AW_EXPR_A0E5D436: ${{ github.event.pull_request.number || inputs.pr_number }}\n GH_AW_GITHUB_ACTOR: ${{ github.actor }}\n GH_AW_GITHUB_EVENT_COMMENT_ID: ${{ github.event.comment.id }}\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: ${{ github.event.discussion.number }}\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: ${{ github.event.issue.number }}\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n GH_AW_GITHUB_RUN_ID: ${{ github.run_id }}\n GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }}\n # poutine:ignore untrusted_checkout_exec\n run: |\n bash \"${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh\"\n {\n cat << 'GH_AW_PROMPT_ba8cce6b4497d40e_EOF'\n \n GH_AW_PROMPT_ba8cce6b4497d40e_EOF\n cat \"${RUNNER_TEMP}/gh-aw/prompts/xpia.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/markdown.md\"\n cat \"${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md\"\n cat << 'GH_AW_PROMPT_ba8cce6b4497d40e_EOF'\n \n Tools: add_comment, create_pull_request_review_comment(max:10), missing_tool, missing_data, noop\n \n \n The following GitHub context information is available for this workflow:\n {{#if __GH_AW_GITHUB_ACTOR__ }}\n - **actor**: __GH_AW_GITHUB_ACTOR__\n {{/if}}\n {{#if __GH_AW_GITHUB_REPOSITORY__ }}\n - **repository**: __GH_AW_GITHUB_REPOSITORY__\n {{/if}}\n {{#if __GH_AW_GITHUB_WORKSPACE__ }}\n - **workspace**: __GH_AW_GITHUB_WORKSPACE__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_ISSUE_NUMBER__ }}\n - **issue-number**: #__GH_AW_GITHUB_EVENT_ISSUE_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER__ }}\n - **discussion-number**: #__GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER__ }}\n - **pull-request-number**: #__GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER__\n {{/if}}\n {{#if __GH_AW_GITHUB_EVENT_COMMENT_ID__ }}\n - **comment-id**: __GH_AW_GITHUB_EVENT_COMMENT_ID__\n {{/if}}\n {{#if __GH_AW_GITHUB_RUN_ID__ }}\n - **workflow-run-id**: __GH_AW_GITHUB_RUN_ID__\n {{/if}}\n \n \n GH_AW_PROMPT_ba8cce6b4497d40e_EOF\n cat \"${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md\"\n cat << 'GH_AW_PROMPT_ba8cce6b4497d40e_EOF'\n \n {{#runtime-import .github/workflows/sdk-consistency-review.md}}\n GH_AW_PROMPT_ba8cce6b4497d40e_EOF\n } > \"$GH_AW_PROMPT\"\n - name: Interpolate variables and render templates\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_EXPR_A0E5D436: ${{ github.event.pull_request.number || inputs.pr_number }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/interpolate_prompt.cjs');\n await main();\n - name: Substitute placeholders\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_EXPR_A0E5D436: ${{ github.event.pull_request.number || inputs.pr_number }}\n GH_AW_GITHUB_ACTOR: ${{ github.actor }}\n GH_AW_GITHUB_EVENT_COMMENT_ID: ${{ github.event.comment.id }}\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: ${{ github.event.discussion.number }}\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: ${{ github.event.issue.number }}\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}\n GH_AW_GITHUB_REPOSITORY: ${{ github.repository }}\n GH_AW_GITHUB_RUN_ID: ${{ github.run_id }}\n GH_AW_GITHUB_WORKSPACE: ${{ github.workspace }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n \n const substitutePlaceholders = require('${{ runner.temp }}/gh-aw/actions/substitute_placeholders.cjs');\n \n // Call the substitution function\n return await substitutePlaceholders({\n file: process.env.GH_AW_PROMPT,\n substitutions: {\n GH_AW_EXPR_A0E5D436: process.env.GH_AW_EXPR_A0E5D436,\n GH_AW_GITHUB_ACTOR: process.env.GH_AW_GITHUB_ACTOR,\n GH_AW_GITHUB_EVENT_COMMENT_ID: process.env.GH_AW_GITHUB_EVENT_COMMENT_ID,\n GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER: process.env.GH_AW_GITHUB_EVENT_DISCUSSION_NUMBER,\n GH_AW_GITHUB_EVENT_ISSUE_NUMBER: process.env.GH_AW_GITHUB_EVENT_ISSUE_NUMBER,\n GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER: process.env.GH_AW_GITHUB_EVENT_PULL_REQUEST_NUMBER,\n GH_AW_GITHUB_REPOSITORY: process.env.GH_AW_GITHUB_REPOSITORY,\n GH_AW_GITHUB_RUN_ID: process.env.GH_AW_GITHUB_RUN_ID,\n GH_AW_GITHUB_WORKSPACE: process.env.GH_AW_GITHUB_WORKSPACE\n }\n });\n - name: Validate prompt placeholders\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n # poutine:ignore untrusted_checkout_exec\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/validate_prompt_placeholders.sh\"\n - name: Print prompt\n env:\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n # poutine:ignore untrusted_checkout_exec\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/print_prompt_summary.sh\"\n - name: Upload activation artifact\n if: success()\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: activation\n path: |\n /tmp/gh-aw/aw_info.json\n /tmp/gh-aw/aw-prompts/prompt.txt\n /tmp/gh-aw/github_rate_limits.jsonl\n if-no-files-found: ignore\n retention-days: 1\n\n agent:\n needs: activation\n runs-on: ubuntu-latest\n permissions:\n contents: read\n issues: read\n pull-requests: read\n env:\n DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}\n GH_AW_ASSETS_ALLOWED_EXTS: \"\"\n GH_AW_ASSETS_BRANCH: \"\"\n GH_AW_ASSETS_MAX_SIZE_KB: 0\n GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs\n GH_AW_WORKFLOW_ID_SANITIZED: sdkconsistencyreview\n outputs:\n checkout_pr_success: ${{ steps.checkout-pr.outputs.checkout_pr_success || 'true' }}\n effective_tokens: ${{ steps.parse-mcp-gateway.outputs.effective_tokens }}\n has_patch: ${{ steps.collect_output.outputs.has_patch }}\n inference_access_error: ${{ steps.detect-inference-error.outputs.inference_access_error || 'false' }}\n model: ${{ needs.activation.outputs.model }}\n output: ${{ steps.collect_output.outputs.output }}\n output_types: ${{ steps.collect_output.outputs.output_types }}\n setup-trace-id: ${{ steps.setup.outputs.trace-id }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Set runtime paths\n id: set-runtime-paths\n run: |\n echo \"GH_AW_SAFE_OUTPUTS=${RUNNER_TEMP}/gh-aw/safeoutputs/outputs.jsonl\" >> \"$GITHUB_OUTPUT\"\n echo \"GH_AW_SAFE_OUTPUTS_CONFIG_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/config.json\" >> \"$GITHUB_OUTPUT\"\n echo \"GH_AW_SAFE_OUTPUTS_TOOLS_PATH=${RUNNER_TEMP}/gh-aw/safeoutputs/tools.json\" >> \"$GITHUB_OUTPUT\"\n - name: Checkout repository\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n - name: Create gh-aw temp directory\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/create_gh_aw_tmp_dir.sh\"\n - name: Configure gh CLI for GitHub Enterprise\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/configure_gh_for_ghe.sh\"\n env:\n GH_TOKEN: ${{ github.token }}\n - name: Configure Git credentials\n env:\n REPO_NAME: ${{ github.repository }}\n SERVER_URL: ${{ github.server_url }}\n GITHUB_TOKEN: ${{ github.token }}\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git config --global am.keepcr true\n # Re-authenticate git with GitHub token\n SERVER_URL_STRIPPED=\"${SERVER_URL#https://}\"\n git remote set-url origin \"https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git\"\n echo \"Git configured with standard GitHub Actions identity\"\n - name: Checkout PR branch\n id: checkout-pr\n if: |\n github.event.pull_request || github.event.issue.pull_request\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/checkout_pr_branch.cjs');\n await main();\n - name: Install GitHub Copilot CLI\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh\" 1.0.20\n env:\n GH_HOST: github.com\n - name: Install AWF binary\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh\" v0.25.18\n - name: Determine automatic lockdown mode for GitHub MCP Server\n id: determine-automatic-lockdown\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }}\n GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }}\n with:\n script: |\n const determineAutomaticLockdown = require('${{ runner.temp }}/gh-aw/actions/determine_automatic_lockdown.cjs');\n await determineAutomaticLockdown(github, context, core);\n - name: Download container images\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh\" ghcr.io/github/gh-aw-firewall/agent:0.25.18 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.18 ghcr.io/github/gh-aw-firewall/squid:0.25.18 ghcr.io/github/gh-aw-mcpg:v0.2.17 ghcr.io/github/github-mcp-server:v0.32.0 node:lts-alpine\n - name: Write Safe Outputs Config\n run: |\n mkdir -p \"${RUNNER_TEMP}/gh-aw/safeoutputs\"\n mkdir -p /tmp/gh-aw/safeoutputs\n mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs\n cat > \"${RUNNER_TEMP}/gh-aw/safeoutputs/config.json\" << 'GH_AW_SAFE_OUTPUTS_CONFIG_8507857a3b512809_EOF'\n {\"add_comment\":{\"hide_older_comments\":true,\"max\":1},\"create_pull_request_review_comment\":{\"max\":10,\"side\":\"RIGHT\"},\"create_report_incomplete_issue\":{},\"missing_data\":{},\"missing_tool\":{},\"noop\":{\"max\":1,\"report-as-issue\":\"true\"},\"report_incomplete\":{}}\n GH_AW_SAFE_OUTPUTS_CONFIG_8507857a3b512809_EOF\n - name: Write Safe Outputs Tools\n env:\n GH_AW_TOOLS_META_JSON: |\n {\n \"description_suffixes\": {\n \"add_comment\": \" CONSTRAINTS: Maximum 1 comment(s) can be added.\",\n \"create_pull_request_review_comment\": \" CONSTRAINTS: Maximum 10 review comment(s) can be created. Comments will be on the RIGHT side of the diff.\"\n },\n \"repo_params\": {},\n \"dynamic_tools\": []\n }\n GH_AW_VALIDATION_JSON: |\n {\n \"add_comment\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"body\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"item_number\": {\n \"issueOrPRNumber\": true\n },\n \"repo\": {\n \"type\": \"string\",\n \"maxLength\": 256\n }\n }\n },\n \"create_pull_request_review_comment\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"body\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"line\": {\n \"required\": true,\n \"positiveInteger\": true\n },\n \"path\": {\n \"required\": true,\n \"type\": \"string\"\n },\n \"pull_request_number\": {\n \"optionalPositiveInteger\": true\n },\n \"repo\": {\n \"type\": \"string\",\n \"maxLength\": 256\n },\n \"side\": {\n \"type\": \"string\",\n \"enum\": [\n \"LEFT\",\n \"RIGHT\"\n ]\n },\n \"start_line\": {\n \"optionalPositiveInteger\": true\n }\n },\n \"customValidation\": \"startLineLessOrEqualLine\"\n },\n \"missing_data\": {\n \"defaultMax\": 20,\n \"fields\": {\n \"alternatives\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"context\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"data_type\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n },\n \"reason\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n }\n }\n },\n \"missing_tool\": {\n \"defaultMax\": 20,\n \"fields\": {\n \"alternatives\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 512\n },\n \"reason\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 256\n },\n \"tool\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 128\n }\n }\n },\n \"noop\": {\n \"defaultMax\": 1,\n \"fields\": {\n \"message\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n }\n }\n },\n \"report_incomplete\": {\n \"defaultMax\": 5,\n \"fields\": {\n \"details\": {\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 65000\n },\n \"reason\": {\n \"required\": true,\n \"type\": \"string\",\n \"sanitize\": true,\n \"maxLength\": 1024\n }\n }\n }\n }\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/generate_safe_outputs_tools.cjs');\n await main();\n - name: Generate Safe Outputs MCP Server Config\n id: safe-outputs-config\n run: |\n # Generate a secure random API key (360 bits of entropy, 40+ chars)\n # Mask immediately to prevent timing vulnerabilities\n API_KEY=$(openssl rand -base64 45 | tr -d '/+=')\n echo \"::add-mask::${API_KEY}\"\n \n PORT=3001\n \n # Set outputs for next steps\n {\n echo \"safe_outputs_api_key=${API_KEY}\"\n echo \"safe_outputs_port=${PORT}\"\n } >> \"$GITHUB_OUTPUT\"\n \n echo \"Safe Outputs MCP server will run on port ${PORT}\"\n \n - name: Start Safe Outputs MCP HTTP Server\n id: safe-outputs-start\n env:\n DEBUG: '*'\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-config.outputs.safe_outputs_port }}\n GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-config.outputs.safe_outputs_api_key }}\n GH_AW_SAFE_OUTPUTS_TOOLS_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/tools.json\n GH_AW_SAFE_OUTPUTS_CONFIG_PATH: ${{ runner.temp }}/gh-aw/safeoutputs/config.json\n GH_AW_MCP_LOG_DIR: /tmp/gh-aw/mcp-logs/safeoutputs\n run: |\n # Environment variables are set above to prevent template injection\n export DEBUG\n export GH_AW_SAFE_OUTPUTS\n export GH_AW_SAFE_OUTPUTS_PORT\n export GH_AW_SAFE_OUTPUTS_API_KEY\n export GH_AW_SAFE_OUTPUTS_TOOLS_PATH\n export GH_AW_SAFE_OUTPUTS_CONFIG_PATH\n export GH_AW_MCP_LOG_DIR\n \n bash \"${RUNNER_TEMP}/gh-aw/actions/start_safe_outputs_server.sh\"\n \n - name: Start MCP Gateway\n id: start-mcp-gateway\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_SAFE_OUTPUTS_API_KEY: ${{ steps.safe-outputs-start.outputs.api_key }}\n GH_AW_SAFE_OUTPUTS_PORT: ${{ steps.safe-outputs-start.outputs.port }}\n GITHUB_MCP_GUARD_MIN_INTEGRITY: ${{ steps.determine-automatic-lockdown.outputs.min_integrity }}\n GITHUB_MCP_GUARD_REPOS: ${{ steps.determine-automatic-lockdown.outputs.repos }}\n GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n run: |\n set -eo pipefail\n mkdir -p /tmp/gh-aw/mcp-config\n \n # Export gateway environment variables for MCP config and gateway script\n export MCP_GATEWAY_PORT=\"80\"\n export MCP_GATEWAY_DOMAIN=\"host.docker.internal\"\n MCP_GATEWAY_API_KEY=$(openssl rand -base64 45 | tr -d '/+=')\n echo \"::add-mask::${MCP_GATEWAY_API_KEY}\"\n export MCP_GATEWAY_API_KEY\n export MCP_GATEWAY_PAYLOAD_DIR=\"/tmp/gh-aw/mcp-payloads\"\n mkdir -p \"${MCP_GATEWAY_PAYLOAD_DIR}\"\n export MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD=\"524288\"\n export DEBUG=\"*\"\n \n export GH_AW_ENGINE=\"copilot\"\n export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host -v /var/run/docker.sock:/var/run/docker.sock -e MCP_GATEWAY_PORT -e MCP_GATEWAY_DOMAIN -e MCP_GATEWAY_API_KEY -e MCP_GATEWAY_PAYLOAD_DIR -e MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD -e DEBUG -e MCP_GATEWAY_LOG_DIR -e GH_AW_MCP_LOG_DIR -e GH_AW_SAFE_OUTPUTS -e GH_AW_SAFE_OUTPUTS_CONFIG_PATH -e GH_AW_SAFE_OUTPUTS_TOOLS_PATH -e GH_AW_ASSETS_BRANCH -e GH_AW_ASSETS_MAX_SIZE_KB -e GH_AW_ASSETS_ALLOWED_EXTS -e DEFAULT_BRANCH -e GITHUB_MCP_SERVER_TOKEN -e GITHUB_MCP_GUARD_MIN_INTEGRITY -e GITHUB_MCP_GUARD_REPOS -e GITHUB_REPOSITORY -e GITHUB_SERVER_URL -e GITHUB_SHA -e GITHUB_WORKSPACE -e GITHUB_TOKEN -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RUN_ATTEMPT -e GITHUB_JOB -e GITHUB_ACTION -e GITHUB_EVENT_NAME -e GITHUB_EVENT_PATH -e GITHUB_ACTOR -e GITHUB_ACTOR_ID -e GITHUB_TRIGGERING_ACTOR -e GITHUB_WORKFLOW -e GITHUB_WORKFLOW_REF -e GITHUB_WORKFLOW_SHA -e GITHUB_REF -e GITHUB_REF_NAME -e GITHUB_REF_TYPE -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GH_AW_SAFE_OUTPUTS_PORT -e GH_AW_SAFE_OUTPUTS_API_KEY -v /tmp/gh-aw/mcp-payloads:/tmp/gh-aw/mcp-payloads:rw -v /opt:/opt:ro -v /tmp:/tmp:rw -v '\"${GITHUB_WORKSPACE}\"':'\"${GITHUB_WORKSPACE}\"':rw ghcr.io/github/gh-aw-mcpg:v0.2.17'\n \n mkdir -p /home/runner/.copilot\n cat << GH_AW_MCP_CONFIG_73099b6c804f5a74_EOF | bash \"${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.sh\"\n {\n \"mcpServers\": {\n \"github\": {\n \"type\": \"stdio\",\n \"container\": \"ghcr.io/github/github-mcp-server:v0.32.0\",\n \"env\": {\n \"GITHUB_HOST\": \"\\${GITHUB_SERVER_URL}\",\n \"GITHUB_PERSONAL_ACCESS_TOKEN\": \"\\${GITHUB_MCP_SERVER_TOKEN}\",\n \"GITHUB_READ_ONLY\": \"1\",\n \"GITHUB_TOOLSETS\": \"context,repos,issues,pull_requests\"\n },\n \"guard-policies\": {\n \"allow-only\": {\n \"min-integrity\": \"$GITHUB_MCP_GUARD_MIN_INTEGRITY\",\n \"repos\": \"$GITHUB_MCP_GUARD_REPOS\"\n }\n }\n },\n \"safeoutputs\": {\n \"type\": \"http\",\n \"url\": \"http://host.docker.internal:$GH_AW_SAFE_OUTPUTS_PORT\",\n \"headers\": {\n \"Authorization\": \"\\${GH_AW_SAFE_OUTPUTS_API_KEY}\"\n },\n \"guard-policies\": {\n \"write-sink\": {\n \"accept\": [\n \"*\"\n ]\n }\n }\n }\n },\n \"gateway\": {\n \"port\": $MCP_GATEWAY_PORT,\n \"domain\": \"${MCP_GATEWAY_DOMAIN}\",\n \"apiKey\": \"${MCP_GATEWAY_API_KEY}\",\n \"payloadDir\": \"${MCP_GATEWAY_PAYLOAD_DIR}\"\n }\n }\n GH_AW_MCP_CONFIG_73099b6c804f5a74_EOF\n - name: Download activation artifact\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: activation\n path: /tmp/gh-aw\n - name: Clean git credentials\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/clean_git_credentials.sh\"\n - name: Execute GitHub Copilot CLI\n id: agentic_execution\n # Copilot CLI tool arguments (sorted):\n timeout-minutes: 15\n run: |\n set -o pipefail\n touch /tmp/gh-aw/agent-step-summary.md\n # shellcheck disable=SC1003\n sudo -E awf --container-workdir \"${GITHUB_WORKSPACE}\" --mount \"${RUNNER_TEMP}/gh-aw:${RUNNER_TEMP}/gh-aw:ro\" --mount \"${RUNNER_TEMP}/gh-aw:/host${RUNNER_TEMP}/gh-aw:ro\" --env-all --exclude-env COPILOT_GITHUB_TOKEN --exclude-env GITHUB_MCP_SERVER_TOKEN --exclude-env MCP_GATEWAY_API_KEY --allow-domains api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --image-tag 0.25.18 --skip-pull --enable-api-proxy \\\n -- /bin/bash -c 'node ${RUNNER_TEMP}/gh-aw/actions/copilot_driver.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --allow-all-tools --allow-all-paths --add-dir \"${GITHUB_WORKSPACE}\" --prompt \"$(cat /tmp/gh-aw/aw-prompts/prompt.txt)\"' 2>&1 | tee -a /tmp/gh-aw/agent-stdio.log\n env:\n COPILOT_AGENT_RUNNER_TYPE: STANDALONE\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n COPILOT_MODEL: ${{ vars.GH_AW_MODEL_AGENT_COPILOT || '' }}\n GH_AW_MCP_CONFIG: /home/runner/.copilot/mcp-config.json\n GH_AW_PHASE: agent\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_VERSION: v0.67.4\n GITHUB_API_URL: ${{ github.api_url }}\n GITHUB_AW: true\n GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows\n GITHUB_HEAD_REF: ${{ github.head_ref }}\n GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN || secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n GITHUB_REF_NAME: ${{ github.ref_name }}\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md\n GITHUB_WORKSPACE: ${{ github.workspace }}\n GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_AUTHOR_NAME: github-actions[bot]\n GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_COMMITTER_NAME: github-actions[bot]\n XDG_CONFIG_HOME: /home/runner\n - name: Detect inference access error\n id: detect-inference-error\n if: always()\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/detect_inference_access_error.sh\"\n - name: Configure Git credentials\n env:\n REPO_NAME: ${{ github.repository }}\n SERVER_URL: ${{ github.server_url }}\n GITHUB_TOKEN: ${{ github.token }}\n run: |\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git config --global user.name \"github-actions[bot]\"\n git config --global am.keepcr true\n # Re-authenticate git with GitHub token\n SERVER_URL_STRIPPED=\"${SERVER_URL#https://}\"\n git remote set-url origin \"https://x-access-token:${GITHUB_TOKEN}@${SERVER_URL_STRIPPED}/${REPO_NAME}.git\"\n echo \"Git configured with standard GitHub Actions identity\"\n - name: Copy Copilot session state files to logs\n if: always()\n continue-on-error: true\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/copy_copilot_session_state.sh\"\n - name: Stop MCP Gateway\n if: always()\n continue-on-error: true\n env:\n MCP_GATEWAY_PORT: ${{ steps.start-mcp-gateway.outputs.gateway-port }}\n MCP_GATEWAY_API_KEY: ${{ steps.start-mcp-gateway.outputs.gateway-api-key }}\n GATEWAY_PID: ${{ steps.start-mcp-gateway.outputs.gateway-pid }}\n run: |\n bash \"${RUNNER_TEMP}/gh-aw/actions/stop_mcp_gateway.sh\" \"$GATEWAY_PID\"\n - name: Redact secrets in logs\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/redact_secrets.cjs');\n await main();\n env:\n GH_AW_SECRET_NAMES: 'COPILOT_GITHUB_TOKEN,GH_AW_GITHUB_MCP_SERVER_TOKEN,GH_AW_GITHUB_TOKEN,GITHUB_TOKEN'\n SECRET_COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n SECRET_GH_AW_GITHUB_MCP_SERVER_TOKEN: ${{ secrets.GH_AW_GITHUB_MCP_SERVER_TOKEN }}\n SECRET_GH_AW_GITHUB_TOKEN: ${{ secrets.GH_AW_GITHUB_TOKEN }}\n SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n - name: Append agent step summary\n if: always()\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/append_agent_step_summary.sh\"\n - name: Copy Safe Outputs\n if: always()\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n run: |\n mkdir -p /tmp/gh-aw\n cp \"$GH_AW_SAFE_OUTPUTS\" /tmp/gh-aw/safeoutputs.jsonl 2>/dev/null || true\n - name: Ingest agent output\n id: collect_output\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }}\n GH_AW_ALLOWED_DOMAINS: \"api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com\"\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_API_URL: ${{ github.api_url }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/collect_ndjson_output.cjs');\n await main();\n - name: Parse agent logs for step summary\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: /tmp/gh-aw/sandbox/agent/logs/\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_copilot_log.cjs');\n await main();\n - name: Parse MCP Gateway logs for step summary\n if: always()\n id: parse-mcp-gateway\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_mcp_gateway_log.cjs');\n await main();\n - name: Print firewall logs\n if: always()\n continue-on-error: true\n env:\n AWF_LOGS_DIR: /tmp/gh-aw/sandbox/firewall/logs\n run: |\n # Fix permissions on firewall logs so they can be uploaded as artifacts\n # AWF runs with sudo, creating files owned by root\n sudo chmod -R a+r /tmp/gh-aw/sandbox/firewall/logs 2>/dev/null || true\n # Only run awf logs summary if awf command exists (it may not be installed if workflow failed before install step)\n if command -v awf &> /dev/null; then\n awf logs summary | tee -a \"$GITHUB_STEP_SUMMARY\"\n else\n echo 'AWF binary not installed, skipping firewall log summary'\n fi\n - name: Parse token usage for step summary\n if: always()\n continue-on-error: true\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_token_usage.cjs');\n await main();\n - name: Write agent output placeholder if missing\n if: always()\n run: |\n if [ ! -f /tmp/gh-aw/agent_output.json ]; then\n echo '{\"items\":[]}' > /tmp/gh-aw/agent_output.json\n fi\n - name: Upload agent artifacts\n if: always()\n continue-on-error: true\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: agent\n path: |\n /tmp/gh-aw/aw-prompts/prompt.txt\n /tmp/gh-aw/sandbox/agent/logs/\n /tmp/gh-aw/redacted-urls.log\n /tmp/gh-aw/mcp-logs/\n /tmp/gh-aw/agent_usage.json\n /tmp/gh-aw/agent-stdio.log\n /tmp/gh-aw/agent/\n /tmp/gh-aw/github_rate_limits.jsonl\n /tmp/gh-aw/safeoutputs.jsonl\n /tmp/gh-aw/agent_output.json\n /tmp/gh-aw/aw-*.patch\n /tmp/gh-aw/aw-*.bundle\n if-no-files-found: ignore\n - name: Upload firewall audit logs\n if: always()\n continue-on-error: true\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: firewall-audit-logs\n path: |\n /tmp/gh-aw/sandbox/firewall/logs/\n /tmp/gh-aw/sandbox/firewall/audit/\n if-no-files-found: ignore\n\n conclusion:\n needs:\n - activation\n - agent\n - detection\n - safe_outputs\n if: always() && (needs.agent.result != 'skipped' || needs.activation.outputs.lockdown_check_failed == 'true')\n runs-on: ubuntu-slim\n permissions:\n contents: read\n discussions: write\n issues: write\n pull-requests: write\n concurrency:\n group: \"gh-aw-conclusion-sdk-consistency-review\"\n cancel-in-progress: false\n outputs:\n incomplete_count: ${{ steps.report_incomplete.outputs.incomplete_count }}\n noop_message: ${{ steps.noop.outputs.noop_message }}\n tools_reported: ${{ steps.missing_tool.outputs.tools_reported }}\n total_count: ${{ steps.missing_tool.outputs.total_count }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Process No-Op Messages\n id: noop\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_NOOP_MAX: \"1\"\n GH_AW_WORKFLOW_NAME: \"SDK Consistency Review Agent\"\n GH_AW_TRACKER_ID: \"sdk-consistency-review\"\n GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\n GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }}\n GH_AW_NOOP_REPORT_AS_ISSUE: \"true\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_noop_message.cjs');\n await main();\n - name: Record missing tool\n id: missing_tool\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_MISSING_TOOL_CREATE_ISSUE: \"true\"\n GH_AW_WORKFLOW_NAME: \"SDK Consistency Review Agent\"\n GH_AW_TRACKER_ID: \"sdk-consistency-review\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/missing_tool.cjs');\n await main();\n - name: Record incomplete\n id: report_incomplete\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_REPORT_INCOMPLETE_CREATE_ISSUE: \"true\"\n GH_AW_WORKFLOW_NAME: \"SDK Consistency Review Agent\"\n GH_AW_TRACKER_ID: \"sdk-consistency-review\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/report_incomplete_handler.cjs');\n await main();\n - name: Handle agent failure\n id: handle_agent_failure\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_WORKFLOW_NAME: \"SDK Consistency Review Agent\"\n GH_AW_TRACKER_ID: \"sdk-consistency-review\"\n GH_AW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}\n GH_AW_AGENT_CONCLUSION: ${{ needs.agent.result }}\n GH_AW_WORKFLOW_ID: \"sdk-consistency-review\"\n GH_AW_ENGINE_ID: \"copilot\"\n GH_AW_SECRET_VERIFICATION_RESULT: ${{ needs.activation.outputs.secret_verification_result }}\n GH_AW_CHECKOUT_PR_SUCCESS: ${{ needs.agent.outputs.checkout_pr_success }}\n GH_AW_INFERENCE_ACCESS_ERROR: ${{ needs.agent.outputs.inference_access_error }}\n GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }}\n GH_AW_GROUP_REPORTS: \"false\"\n GH_AW_FAILURE_REPORT_AS_ISSUE: \"true\"\n GH_AW_TIMEOUT_MINUTES: \"15\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/handle_agent_failure.cjs');\n await main();\n\n detection:\n needs:\n - activation\n - agent\n if: >\n always() && needs.agent.result != 'skipped' && (needs.agent.outputs.output_types != '' || needs.agent.outputs.has_patch == 'true')\n runs-on: ubuntu-latest\n permissions:\n contents: read\n outputs:\n detection_conclusion: ${{ steps.detection_conclusion.outputs.conclusion }}\n detection_success: ${{ steps.detection_conclusion.outputs.success }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Checkout repository for patch context\n if: needs.agent.outputs.has_patch == 'true'\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n persist-credentials: false\n # --- Threat Detection ---\n - name: Download container images\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/download_docker_images.sh\" ghcr.io/github/gh-aw-firewall/agent:0.25.18 ghcr.io/github/gh-aw-firewall/api-proxy:0.25.18 ghcr.io/github/gh-aw-firewall/squid:0.25.18\n - name: Check if detection needed\n id: detection_guard\n if: always()\n env:\n OUTPUT_TYPES: ${{ needs.agent.outputs.output_types }}\n HAS_PATCH: ${{ needs.agent.outputs.has_patch }}\n run: |\n if [[ -n \"$OUTPUT_TYPES\" || \"$HAS_PATCH\" == \"true\" ]]; then\n echo \"run_detection=true\" >> \"$GITHUB_OUTPUT\"\n echo \"Detection will run: output_types=$OUTPUT_TYPES, has_patch=$HAS_PATCH\"\n else\n echo \"run_detection=false\" >> \"$GITHUB_OUTPUT\"\n echo \"Detection skipped: no agent outputs or patches to analyze\"\n fi\n - name: Clear MCP configuration for detection\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n rm -f /tmp/gh-aw/mcp-config/mcp-servers.json\n rm -f /home/runner/.copilot/mcp-config.json\n rm -f \"$GITHUB_WORKSPACE/.gemini/settings.json\"\n - name: Prepare threat detection files\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n mkdir -p /tmp/gh-aw/threat-detection/aw-prompts\n cp /tmp/gh-aw/aw-prompts/prompt.txt /tmp/gh-aw/threat-detection/aw-prompts/prompt.txt 2>/dev/null || true\n cp /tmp/gh-aw/agent_output.json /tmp/gh-aw/threat-detection/agent_output.json 2>/dev/null || true\n for f in /tmp/gh-aw/aw-*.patch; do\n [ -f \"$f\" ] && cp \"$f\" /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n done\n for f in /tmp/gh-aw/aw-*.bundle; do\n [ -f \"$f\" ] && cp \"$f\" /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n done\n echo \"Prepared threat detection files:\"\n ls -la /tmp/gh-aw/threat-detection/ 2>/dev/null || true\n - name: Setup threat detection\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n WORKFLOW_NAME: \"SDK Consistency Review Agent\"\n WORKFLOW_DESCRIPTION: \"Reviews PRs to ensure features are implemented consistently across all SDK language implementations\"\n HAS_PATCH: ${{ needs.agent.outputs.has_patch }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/setup_threat_detection.cjs');\n await main();\n - name: Ensure threat-detection directory and log\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n run: |\n mkdir -p /tmp/gh-aw/threat-detection\n touch /tmp/gh-aw/threat-detection/detection.log\n - name: Install GitHub Copilot CLI\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_copilot_cli.sh\" 1.0.20\n env:\n GH_HOST: github.com\n - name: Install AWF binary\n run: bash \"${RUNNER_TEMP}/gh-aw/actions/install_awf_binary.sh\" v0.25.18\n - name: Execute GitHub Copilot CLI\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n id: detection_agentic_execution\n # Copilot CLI tool arguments (sorted):\n timeout-minutes: 20\n run: |\n set -o pipefail\n touch /tmp/gh-aw/agent-step-summary.md\n # shellcheck disable=SC1003\n sudo -E awf --container-workdir \"${GITHUB_WORKSPACE}\" --mount \"${RUNNER_TEMP}/gh-aw:${RUNNER_TEMP}/gh-aw:ro\" --mount \"${RUNNER_TEMP}/gh-aw:/host${RUNNER_TEMP}/gh-aw:ro\" --env-all --exclude-env COPILOT_GITHUB_TOKEN --allow-domains api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,github.com,host.docker.internal,telemetry.enterprise.githubcopilot.com --log-level info --proxy-logs-dir /tmp/gh-aw/sandbox/firewall/logs --audit-dir /tmp/gh-aw/sandbox/firewall/audit --enable-host-access --image-tag 0.25.18 --skip-pull --enable-api-proxy \\\n -- /bin/bash -c 'node ${RUNNER_TEMP}/gh-aw/actions/copilot_driver.cjs /usr/local/bin/copilot --add-dir /tmp/gh-aw/ --log-level all --log-dir /tmp/gh-aw/sandbox/agent/logs/ --disable-builtin-mcps --allow-all-tools --add-dir \"${GITHUB_WORKSPACE}\" --prompt \"$(cat /tmp/gh-aw/aw-prompts/prompt.txt)\"' 2>&1 | tee -a /tmp/gh-aw/threat-detection/detection.log\n env:\n COPILOT_AGENT_RUNNER_TYPE: STANDALONE\n COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}\n COPILOT_MODEL: ${{ vars.GH_AW_MODEL_DETECTION_COPILOT || '' }}\n GH_AW_PHASE: detection\n GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt\n GH_AW_VERSION: v0.67.4\n GITHUB_API_URL: ${{ github.api_url }}\n GITHUB_AW: true\n GITHUB_COPILOT_INTEGRATION_ID: agentic-workflows\n GITHUB_HEAD_REF: ${{ github.head_ref }}\n GITHUB_REF_NAME: ${{ github.ref_name }}\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_STEP_SUMMARY: /tmp/gh-aw/agent-step-summary.md\n GITHUB_WORKSPACE: ${{ github.workspace }}\n GIT_AUTHOR_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_AUTHOR_NAME: github-actions[bot]\n GIT_COMMITTER_EMAIL: github-actions[bot]@users.noreply.github.com\n GIT_COMMITTER_NAME: github-actions[bot]\n XDG_CONFIG_HOME: /home/runner\n - name: Upload threat detection log\n if: always() && steps.detection_guard.outputs.run_detection == 'true'\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: detection\n path: /tmp/gh-aw/threat-detection/detection.log\n if-no-files-found: ignore\n - name: Parse and conclude threat detection\n id: detection_conclusion\n if: always()\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n RUN_DETECTION: ${{ steps.detection_guard.outputs.run_detection }}\n with:\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/parse_threat_detection_results.cjs');\n await main();\n\n safe_outputs:\n needs:\n - activation\n - agent\n - detection\n if: (!cancelled()) && needs.agent.result != 'skipped' && needs.detection.result == 'success'\n runs-on: ubuntu-slim\n permissions:\n contents: read\n discussions: write\n issues: write\n pull-requests: write\n timeout-minutes: 15\n env:\n GH_AW_CALLER_WORKFLOW_ID: \"${{ github.repository }}/sdk-consistency-review\"\n GH_AW_EFFECTIVE_TOKENS: ${{ needs.agent.outputs.effective_tokens }}\n GH_AW_ENGINE_ID: \"copilot\"\n GH_AW_ENGINE_MODEL: ${{ needs.agent.outputs.model }}\n GH_AW_TRACKER_ID: \"sdk-consistency-review\"\n GH_AW_WORKFLOW_ID: \"sdk-consistency-review\"\n GH_AW_WORKFLOW_NAME: \"SDK Consistency Review Agent\"\n outputs:\n code_push_failure_count: ${{ steps.process_safe_outputs.outputs.code_push_failure_count }}\n code_push_failure_errors: ${{ steps.process_safe_outputs.outputs.code_push_failure_errors }}\n comment_id: ${{ steps.process_safe_outputs.outputs.comment_id }}\n comment_url: ${{ steps.process_safe_outputs.outputs.comment_url }}\n create_discussion_error_count: ${{ steps.process_safe_outputs.outputs.create_discussion_error_count }}\n create_discussion_errors: ${{ steps.process_safe_outputs.outputs.create_discussion_errors }}\n process_safe_outputs_processed_count: ${{ steps.process_safe_outputs.outputs.processed_count }}\n process_safe_outputs_temporary_id_map: ${{ steps.process_safe_outputs.outputs.temporary_id_map }}\n steps:\n - name: Setup Scripts\n id: setup\n uses: github/gh-aw-actions/setup@9d6ae06250fc0ec536a0e5f35de313b35bad7246 # v0.67.4\n with:\n destination: ${{ runner.temp }}/gh-aw/actions\n job-name: ${{ github.job }}\n trace-id: ${{ needs.activation.outputs.setup-trace-id }}\n - name: Download agent output artifact\n id: download-agent-output\n continue-on-error: true\n uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n name: agent\n path: /tmp/gh-aw/\n - name: Setup agent output environment variable\n id: setup-agent-output-env\n if: steps.download-agent-output.outcome == 'success'\n run: |\n mkdir -p /tmp/gh-aw/\n find \"/tmp/gh-aw/\" -type f -print\n echo \"GH_AW_AGENT_OUTPUT=/tmp/gh-aw/agent_output.json\" >> \"$GITHUB_OUTPUT\"\n - name: Configure GH_HOST for enterprise compatibility\n id: ghes-host-config\n shell: bash\n run: |\n # Derive GH_HOST from GITHUB_SERVER_URL so the gh CLI targets the correct\n # GitHub instance (GHES/GHEC). On github.com this is a harmless no-op.\n GH_HOST=\"${GITHUB_SERVER_URL#https://}\"\n GH_HOST=\"${GH_HOST#http://}\"\n echo \"GH_HOST=${GH_HOST}\" >> \"$GITHUB_ENV\"\n - name: Process Safe Outputs\n id: process_safe_outputs\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8\n env:\n GH_AW_AGENT_OUTPUT: ${{ steps.setup-agent-output-env.outputs.GH_AW_AGENT_OUTPUT }}\n GH_AW_ALLOWED_DOMAINS: \"api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com,www.googleapis.com\"\n GITHUB_SERVER_URL: ${{ github.server_url }}\n GITHUB_API_URL: ${{ github.api_url }}\n GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: \"{\\\"add_comment\\\":{\\\"hide_older_comments\\\":true,\\\"max\\\":1},\\\"create_pull_request_review_comment\\\":{\\\"max\\\":10,\\\"side\\\":\\\"RIGHT\\\"},\\\"create_report_incomplete_issue\\\":{},\\\"missing_data\\\":{},\\\"missing_tool\\\":{},\\\"noop\\\":{\\\"max\\\":1,\\\"report-as-issue\\\":\\\"true\\\"},\\\"report_incomplete\\\":{}}\"\n with:\n github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}\n script: |\n const { setupGlobals } = require('${{ runner.temp }}/gh-aw/actions/setup_globals.cjs');\n setupGlobals(core, github, context, exec, io);\n const { main } = require('${{ runner.temp }}/gh-aw/actions/safe_output_handler_manager.cjs');\n await main();\n - name: Upload Safe Outputs Items\n if: always()\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7\n with:\n name: safe-outputs-items\n path: /tmp/gh-aw/safe-output-items.jsonl\n if-no-files-found: ignore\n\n" }, { "path": ".github/workflows/sdk-consistency-review.md", "content": "---\ndescription: Reviews PRs to ensure features are implemented consistently across all SDK language implementations\ntracker-id: sdk-consistency-review\non:\n roles: all\n pull_request:\n types: [opened, synchronize, reopened]\n paths:\n - 'nodejs/**'\n - 'python/**'\n - 'go/**'\n - 'dotnet/**'\n workflow_dispatch:\n inputs:\n pr_number:\n description: \"PR number to review\"\n required: true\n type: string\npermissions:\n contents: read\n pull-requests: read\n issues: read\ntools:\n github:\n toolsets: [default]\nsafe-outputs:\n create-pull-request-review-comment:\n max: 10\n add-comment:\n max: 1\n hide-older-comments: true\n allowed-reasons: [outdated]\ntimeout-minutes: 15\n---\n\n# SDK Consistency Review Agent\n\nYou are an AI code reviewer specialized in ensuring consistency across multi-language SDK implementations. This repository contains four SDK implementations (Node.js/TypeScript, Python, Go, and .NET) that should maintain feature parity and consistent API design.\n\n## Your Task\n\nWhen a pull request modifies any SDK client code, review it to ensure:\n\n1. **Cross-language consistency**: If a feature is added/modified in one SDK, check whether:\n - The same feature exists in other SDK implementations\n - The feature is implemented consistently across all languages\n - API naming and structure are parallel (accounting for language conventions)\n\n2. **Feature parity**: Identify if this PR creates inconsistencies by:\n - Adding a feature to only one language\n - Changing behavior in one SDK that differs from others\n - Introducing language-specific functionality that should be available everywhere\n\n3. **API design consistency**: Check that:\n - Method/function names follow the same semantic pattern (e.g., `createSession` vs `create_session` vs `CreateSession`)\n - Parameter names and types are equivalent\n - Return types are analogous\n - Error handling patterns are similar\n\n## Context\n\n- Repository: ${{ github.repository }}\n- PR number: ${{ github.event.pull_request.number || inputs.pr_number }}\n- Modified files: Use GitHub tools to fetch the list of changed files\n\n## SDK Locations\n\n- **Node.js/TypeScript**: `nodejs/src/`\n- **Python**: `python/copilot/`\n- **Go**: `go/`\n- **.NET**: `dotnet/src/`\n\n## Review Process\n\n1. **Identify the changed SDK(s)**: Determine which language implementation(s) are modified in this PR\n2. **Analyze the changes**: Understand what feature/fix is being implemented\n3. **Cross-reference other SDKs**: Check if the equivalent functionality exists in other language implementations:\n - Read the corresponding files in other SDK directories\n - Compare method signatures, behavior, and documentation\n4. **Report findings**: If inconsistencies are found:\n - Use `create-pull-request-review-comment` to add inline comments on specific lines where changes should be made\n - Use `add-comment` to provide a summary of cross-SDK consistency findings\n - Be specific about which SDKs need updates and what changes would bring them into alignment\n\n## Guidelines\n\n1. **Be respectful**: This is a technical review focusing on consistency, not code quality judgments\n2. **Account for language idioms**: \n - TypeScript uses camelCase (e.g., `createSession`)\n - Python uses snake_case (e.g., `create_session`)\n - Go uses PascalCase for exported/public functions (e.g., `CreateSession`) and camelCase for unexported/private functions\n - .NET uses PascalCase (e.g., `CreateSession`)\n - Focus on public API methods when comparing across languages\n3. **Focus on API surface**: Prioritize public APIs over internal implementation details\n4. **Distinguish between bugs and features**:\n - Bug fixes in one SDK might reveal bugs in others\n - New features should be considered for all SDKs\n5. **Suggest, don't demand**: Frame feedback as suggestions for maintaining consistency\n6. **Skip trivial changes**: Don't flag minor differences like comment styles or variable naming\n7. **Only comment if there are actual consistency issues**: If the PR maintains consistency or only touches one SDK's internal implementation, acknowledge it positively in a summary comment\n\n## Example Scenarios\n\n### Good: Consistent feature addition\nIf a PR adds a new `setTimeout` option to the Node.js SDK and the equivalent feature already exists or is added to Python, Go, and .NET in the same PR.\n\n### Bad: Inconsistent feature\nIf a PR adds a `withRetry` method to only the Python SDK, but this functionality doesn't exist in other SDKs and would be useful everywhere.\n\n### Good: Language-specific optimization\nIf a PR optimizes JSON parsing in Go using native libraries specific to Go's ecosystem—this doesn't need to be mirrored exactly in other languages.\n\n## Output Format\n\n- **If consistency issues found**: Add specific review comments pointing to the gaps and suggest which other SDKs need similar changes\n- **If no issues found**: Add a brief summary comment confirming the changes maintain cross-SDK consistency" }, { "path": ".github/workflows/update-copilot-dependency.yml", "content": "name: \"Update @github/copilot Dependency\"\n\non:\n workflow_dispatch:\n inputs:\n version:\n description: 'Target version of @github/copilot (e.g. 0.0.420)'\n required: true\n type: string\n\npermissions:\n contents: write\n pull-requests: write\n\njobs:\n update:\n name: \"Update @github/copilot to ${{ inputs.version }}\"\n runs-on: ubuntu-latest\n steps:\n - name: Validate version input\n env:\n VERSION: ${{ inputs.version }}\n run: |\n if [[ ! \"$VERSION\" =~ ^[0-9]+\\.[0-9]+\\.[0-9]+(-[a-zA-Z0-9._-]+)?$ ]]; then\n echo \"::error::Invalid version format '$VERSION'. Expected semver (e.g. 0.0.420).\"\n exit 1\n fi\n\n - uses: actions/checkout@v4\n\n - uses: actions/setup-node@v4\n with:\n node-version: 22\n\n - uses: actions/setup-go@v5\n with:\n go-version: '1.22'\n\n - uses: actions/setup-dotnet@v5\n with:\n dotnet-version: \"10.0.x\"\n\n - name: Update @github/copilot in nodejs\n env:\n VERSION: ${{ inputs.version }}\n working-directory: ./nodejs\n run: npm install \"@github/copilot@$VERSION\"\n\n - name: Update @github/copilot in test harness\n env:\n VERSION: ${{ inputs.version }}\n working-directory: ./test/harness\n run: npm install \"@github/copilot@$VERSION\"\n\n - name: Refresh nodejs/samples lockfile\n working-directory: ./nodejs/samples\n run: npm install\n\n - name: Install codegen dependencies\n working-directory: ./scripts/codegen\n run: npm ci\n\n - name: Run codegen\n working-directory: ./scripts/codegen\n run: npm run generate\n\n - name: Format generated code\n run: |\n cd nodejs && npx prettier --write \"src/generated/**/*.ts\"\n cd ../dotnet && dotnet format src/GitHub.Copilot.SDK.csproj\n\n - name: Create pull request\n env:\n GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n VERSION: ${{ inputs.version }}\n run: |\n BRANCH=\"update-copilot-$VERSION\"\n git config user.name \"github-actions[bot]\"\n git config user.email \"41898282+github-actions[bot]@users.noreply.github.com\"\n\n if git rev-parse --verify \"origin/$BRANCH\" >/dev/null 2>&1; then\n git fetch origin \"$BRANCH\"\n git checkout \"$BRANCH\"\n git reset --hard \"origin/$BRANCH\"\n else\n git checkout -b \"$BRANCH\"\n fi\n\n git add -A\n\n if git diff --cached --quiet; then\n echo \"No changes detected; skipping commit and PR creation.\"\n exit 0\n fi\n\n git commit -m \"Update @github/copilot to $VERSION\n\n - Updated nodejs and test harness dependencies\n - Re-ran code generators\n - Formatted generated code\"\n git push origin \"$BRANCH\" --force-with-lease\n\n PR_STATE=\"$(gh pr view \"$BRANCH\" --json state --jq '.state' 2>/dev/null || echo \"\")\"\n if [ \"$PR_STATE\" = \"OPEN\" ]; then\n if [ \"$(gh pr view \"$BRANCH\" --json isDraft --jq '.isDraft')\" = \"false\" ]; then\n gh pr ready \"$BRANCH\" --undo\n echo \"Pull request for branch '$BRANCH' already existed and was moved back to draft after updating the branch.\"\n else\n echo \"Pull request for branch '$BRANCH' already exists and is already a draft; updated branch only.\"\n fi\n else\n gh pr create \\\n --draft \\\n --title \"Update @github/copilot to $VERSION\" \\\n --body \"Automated update of \\`@github/copilot\\` to version \\`$VERSION\\`.\n\n ### Changes\n - Updated \\`@github/copilot\\` in \\`nodejs/package.json\\` and \\`test/harness/package.json\\`\n - Re-ran all code generators (\\`scripts/codegen\\`)\n - Formatted generated output\n\n ### Next steps\n When ready, click **Ready for review** to trigger CI checks.\n\n > Created by the **Update @github/copilot Dependency** workflow.\" \\\n --base main \\\n --head \"$BRANCH\"\n fi\n" }, { "path": ".github/workflows/verify-compiled.yml", "content": "name: Verify compiled workflows\n\non:\n pull_request:\n types: [opened, synchronize, reopened, ready_for_review]\n paths:\n - '.github/workflows/*.md'\n - '.github/workflows/*.lock.yml'\n\npermissions:\n contents: read\n\njobs:\n verify:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - name: Install gh-aw CLI\n uses: github/gh-aw/actions/setup-cli@main\n with:\n version: v0.65.5\n - name: Recompile workflows\n run: gh aw compile\n - name: Check for uncommitted changes\n run: |\n if [ -n \"$(git diff)\" ]; then\n echo \"::error::Lock files are out of date. Run 'gh aw compile' and commit the results.\"\n echo \"\"\n git diff --stat\n echo \"\"\n git diff -- '*.lock.yml'\n exit 1\n fi\n echo \"All lock files are up to date.\"\n" }, { "path": ".gitignore", "content": "\n# Documentation validation output\ndocs/.validation/\n.DS_Store\n\n# Visual Studio\n.vs/\n" }, { "path": ".vscode/launch.json", "content": "{\n \"version\": \"0.2.0\",\n \"configurations\": [\n {\n \"name\": \"Debug Node.js SDK (chat sample)\",\n \"type\": \"node\",\n \"request\": \"launch\",\n \"runtimeArgs\": [\"--enable-source-maps\", \"--import\", \"tsx\"],\n \"program\": \"samples/chat.ts\",\n \"cwd\": \"${workspaceFolder}/nodejs\",\n \"env\": {\n \"COPILOT_CLI_PATH\": \"${workspaceFolder}/../copilot-agent-runtime/dist-cli/index.js\"\n },\n \"console\": \"integratedTerminal\",\n \"autoAttachChildProcesses\": true,\n \"sourceMaps\": true,\n \"resolveSourceMapLocations\": [\n \"${workspaceFolder}/**\",\n \"${workspaceFolder}/../copilot-agent-runtime/**\"\n ]\n }\n ]\n}\n" }, { "path": ".vscode/settings.json", "content": "{\n \"editor.defaultFormatter\": \"esbenp.prettier-vscode\",\n \"editor.formatOnSave\": true,\n \"files.trimTrailingWhitespace\": true,\n \"files.insertFinalNewline\": true,\n \"editor.tabSize\": 4,\n \"editor.insertSpaces\": true,\n \"[typescript][javascript][typescriptreact]\": {\n \"editor.defaultFormatter\": \"esbenp.prettier-vscode\",\n \"editor.codeActionsOnSave\": {\n \"source.organizeImports\": \"explicit\"\n }\n },\n \"python.testing.pytestEnabled\": true,\n \"python.testing.unittestEnabled\": false,\n \"python.testing.pytestArgs\": [\"python\"],\n \"[python]\": {\n \"editor.defaultFormatter\": \"charliermarsh.ruff\"\n },\n \"[go]\": {\n \"editor.defaultFormatter\": \"golang.go\"\n }\n}\n" }, { "path": "CHANGELOG.md", "content": "# Changelog\n\nAll notable changes to the Copilot SDK are documented in this file.\n\nThis changelog is automatically generated by an AI agent when stable releases are published.\nSee [GitHub Releases](https://github.com/github/copilot-sdk/releases) for the full list.\n\n## [v0.2.2](https://github.com/github/copilot-sdk/releases/tag/v0.2.2) (2026-04-10)\n\n### Feature: `enableConfigDiscovery` for automatic MCP and skill config loading\n\nSet `enableConfigDiscovery: true` when creating a session to let the runtime automatically discover MCP server configurations (`.mcp.json`, `.vscode/mcp.json`) and skill directories from the working directory. Discovered settings are merged with any explicitly provided values; explicit values take precedence on name collision. ([#1044](https://github.com/github/copilot-sdk/pull/1044))\n\n```ts\nconst session = await client.createSession({\n enableConfigDiscovery: true,\n});\n```\n\n```cs\nvar session = await client.CreateSessionAsync(new SessionConfig {\n EnableConfigDiscovery = true,\n});\n```\n\n- Python: `await client.create_session(enable_config_discovery=True)`\n- Go: `client.CreateSession(ctx, &copilot.SessionConfig{EnableConfigDiscovery: ptr(true)})`\n\n## [v0.2.1](https://github.com/github/copilot-sdk/releases/tag/v0.2.1) (2026-04-03)\n\n### Feature: commands and UI elicitation across all four SDKs\n\nRegister slash commands that CLI users can invoke and drive interactive input dialogs from any SDK language. This feature was previously Node.js-only; it now ships in Python, Go, and .NET as well. ([#906](https://github.com/github/copilot-sdk/pull/906), [#908](https://github.com/github/copilot-sdk/pull/908), [#960](https://github.com/github/copilot-sdk/pull/960))\n\n```ts\nconst session = await client.createSession({\n onPermissionRequest: approveAll,\n commands: [{\n name: \"summarize\",\n description: \"Summarize the conversation\",\n handler: async (context) => { /* ... */ },\n }],\n onElicitationRequest: async (context) => {\n if (context.type === \"confirm\") return { action: \"confirm\" };\n },\n});\n\n// Drive dialogs from the session\nconst confirmed = await session.ui.confirm({ message: \"Proceed?\" });\nconst choice = await session.ui.select({ message: \"Pick one\", options: [\"A\", \"B\"] });\n```\n\n```cs\nvar session = await client.CreateSessionAsync(new SessionConfig {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Commands = [\n new CommandDefinition {\n Name = \"summarize\",\n Description = \"Summarize the conversation\",\n Handler = async (context) => { /* ... */ },\n }\n ],\n});\n\n// Drive dialogs from the session\nvar confirmed = await session.Ui.ConfirmAsync(new ConfirmOptions { Message = \"Proceed?\" });\n```\n\n> **⚠️ Breaking change (Node.js):** The `onElicitationRequest` handler signature changed from two arguments (`request, invocation`) to a single `ElicitationContext` that combines both. Update callers to use `context.sessionId` and `context.message` directly.\n\n### Feature: `session.getMetadata` across all SDKs\n\nEfficiently fetch metadata for a single session by ID without listing all sessions. Returns `undefined`/`null` (not an error) when the session is not found. ([#899](https://github.com/github/copilot-sdk/pull/899))\n\n- TypeScript: `const meta = await client.getSessionMetadata(sessionId);`\n- C#: `var meta = await client.GetSessionMetadataAsync(sessionId);`\n- Python: `meta = await client.get_session_metadata(session_id)`\n- Go: `meta, err := client.GetSessionMetadata(ctx, sessionID)`\n\n### Feature: `sessionFs` for virtualizing per-session storage (Node SDK)\n\nSupply a custom `sessionFs` adapter in Node SDK session config to redirect the runtime's per-session storage (event log, large output files) to any backing store — useful for serverless deployments or custom persistence layers. ([#917](https://github.com/github/copilot-sdk/pull/917))\n\n### Other changes\n\n- bugfix: structured tool results (with `toolTelemetry`, `resultType`, etc.) now sent via RPC as objects instead of being stringified, preserving metadata for Node, Go, and Python SDKs ([#970](https://github.com/github/copilot-sdk/pull/970))\n- feature: **[Python]** `CopilotClient` and `CopilotSession` now support `async with` for automatic resource cleanup ([#475](https://github.com/github/copilot-sdk/pull/475))\n- improvement: **[Python]** `copilot.types` module removed; import types directly from `copilot` ([#871](https://github.com/github/copilot-sdk/pull/871))\n- improvement: **[Python]** `workspace_path` now accepts any `os.PathLike` and `session.workspace_path` returns a `pathlib.Path` ([#901](https://github.com/github/copilot-sdk/pull/901))\n- improvement: **[Go]** simplified `rpc` package API: renamed structs drop the redundant `Rpc` infix (e.g. `ModelRpcApi` → `ModelApi`) ([#905](https://github.com/github/copilot-sdk/pull/905))\n- fix: **[Go]** `Session.SetModel` now takes a pointer for optional options instead of a variadic argument ([#904](https://github.com/github/copilot-sdk/pull/904))\n\n### New contributors\n\n- @Sumanth007 made their first contribution in [#475](https://github.com/github/copilot-sdk/pull/475)\n- @jongalloway made their first contribution in [#957](https://github.com/github/copilot-sdk/pull/957)\n- @Morabbin made their first contribution in [#970](https://github.com/github/copilot-sdk/pull/970)\n- @schneidafunk made their first contribution in [#998](https://github.com/github/copilot-sdk/pull/998)\n\n## [v0.2.0](https://github.com/github/copilot-sdk/releases/tag/v0.2.0) (2026-03-20)\n\nThis is a big update with a broad round of API refinements, new capabilities, and cross-SDK consistency improvements that have shipped incrementally through preview releases since v0.1.32.\n\n## Highlights\n\n### Fine-grained system prompt customization\n\nA new `\"customize\"` mode for `systemMessage` lets you surgically edit individual sections of the Copilot system prompt — without replacing the entire thing. Ten sections are configurable: `identity`, `tone`, `tool_efficiency`, `environment_context`, `code_change_rules`, `guidelines`, `safety`, `tool_instructions`, `custom_instructions`, and `last_instructions`.\n\nEach section supports four static actions (`replace`, `remove`, `append`, `prepend`) and a `transform` callback that receives the current rendered content and returns modified text — useful for regex mutations, conditional edits, or logging what the prompt contains. ([#816](https://github.com/github/copilot-sdk/pull/816))\n\n```ts\nconst session = await client.createSession({\n onPermissionRequest: approveAll,\n systemMessage: {\n mode: \"customize\",\n sections: {\n identity: {\n action: (current) => current.replace(\"GitHub Copilot\", \"Acme Assistant\"),\n },\n tone: { action: \"replace\", content: \"Be concise and professional.\" },\n code_change_rules: { action: \"remove\" },\n },\n },\n});\n```\n\n```cs\nvar session = await client.CreateSessionAsync(new SessionConfig {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n SystemMessage = new SystemMessageConfig {\n Mode = SystemMessageMode.Customize,\n Sections = new Dictionary {\n [\"identity\"] = new() {\n Transform = current => Task.FromResult(current.Replace(\"GitHub Copilot\", \"Acme Assistant\")),\n },\n [\"tone\"] = new() { Action = SectionOverrideAction.Replace, Content = \"Be concise and professional.\" },\n [\"code_change_rules\"] = new() { Action = SectionOverrideAction.Remove },\n },\n },\n});\n```\n\n### OpenTelemetry support across all SDKs\n\nAll four SDK languages now support distributed tracing with the Copilot CLI. Set `telemetry` in your client options to configure an OTLP exporter; W3C trace context is automatically propagated on `session.create`, `session.resume`, and `session.send`, and restored in tool handlers so tool execution is linked to the originating trace. ([#785](https://github.com/github/copilot-sdk/pull/785))\n\n```ts\nconst client = new CopilotClient({\n telemetry: {\n otlpEndpoint: \"http://localhost:4318\",\n sourceName: \"my-app\",\n },\n});\n```\n\n```cs\nvar client = new CopilotClient(new CopilotClientOptions {\n Telemetry = new TelemetryConfig {\n OtlpEndpoint = \"http://localhost:4318\",\n SourceName = \"my-app\",\n },\n});\n```\n\n- Python: `CopilotClient(SubprocessConfig(telemetry={\"otlp_endpoint\": \"http://localhost:4318\", \"source_name\": \"my-app\"}))`\n- Go: `copilot.NewClient(&copilot.ClientOptions{Telemetry: &copilot.TelemetryConfig{OTLPEndpoint: \"http://localhost:4318\", SourceName: \"my-app\"}})`\n\n### Blob attachments for inline binary data\n\nA new `blob` attachment type lets you send images or other binary content directly to a session without writing to disk — useful when data is already in memory (screenshots, API responses, generated images). ([#731](https://github.com/github/copilot-sdk/pull/731))\n\n```ts\nawait session.send({\n prompt: \"What's in this image?\",\n attachments: [{ type: \"blob\", data: base64Str, mimeType: \"image/png\" }],\n});\n```\n\n```cs\nawait session.SendAsync(new MessageOptions {\n Prompt = \"What's in this image?\",\n Attachments = [new UserMessageDataAttachmentsItemBlob { Data = base64Str, MimeType = \"image/png\" }],\n});\n```\n\n### Pre-select a custom agent at session creation\n\nYou can now specify which custom agent should be active when a session starts, eliminating the need for a separate `session.rpc.agent.select()` call. ([#722](https://github.com/github/copilot-sdk/pull/722))\n\n```ts\nconst session = await client.createSession({\n customAgents: [\n { name: \"researcher\", prompt: \"You are a research assistant.\" },\n { name: \"editor\", prompt: \"You are a code editor.\" },\n ],\n agent: \"researcher\",\n onPermissionRequest: approveAll,\n});\n```\n\n```cs\nvar session = await client.CreateSessionAsync(new SessionConfig {\n CustomAgents = [\n new CustomAgentConfig { Name = \"researcher\", Prompt = \"You are a research assistant.\" },\n new CustomAgentConfig { Name = \"editor\", Prompt = \"You are a code editor.\" },\n ],\n Agent = \"researcher\",\n OnPermissionRequest = PermissionHandler.ApproveAll,\n});\n```\n\n---\n\n## New features\n\n- **`skipPermission` on tool definitions** — Tools can now be registered with `skipPermission: true` to bypass the confirmation prompt for low-risk operations like read-only queries. Available in all four SDKs. ([#808](https://github.com/github/copilot-sdk/pull/808))\n- **`reasoningEffort` when switching models** — All SDKs now accept an optional `reasoningEffort` parameter in `setModel()` for models that support it. ([#712](https://github.com/github/copilot-sdk/pull/712))\n- **Custom model listing for BYOK** — Applications using bring-your-own-key providers can supply `onListModels` in client options to override `client.listModels()` with their own model list. ([#730](https://github.com/github/copilot-sdk/pull/730))\n- **`no-result` permission outcome** — Permission handlers can now return `\"no-result\"` so extensions can attach to sessions without actively answering permission requests. ([#802](https://github.com/github/copilot-sdk/pull/802))\n- **`SessionConfig.onEvent` catch-all** — A new `onEvent` handler on session config is registered *before* the RPC is issued, guaranteeing that early events like `session.start` are never dropped. ([#664](https://github.com/github/copilot-sdk/pull/664))\n- **Node.js CJS compatibility** — The Node.js SDK now ships both ESM and CJS builds, fixing crashes in VS Code extensions and other tools bundled with esbuild's `format: \"cjs\"`. No changes needed in consumer code. ([#546](https://github.com/github/copilot-sdk/pull/546))\n- **Experimental API annotations** — APIs marked experimental in the schema (agent, fleet, compaction groups) are now annotated in all four SDKs: `[Experimental]` in C#, `/** @experimental */` in TypeScript, and comments in Python and Go. ([#875](https://github.com/github/copilot-sdk/pull/875))\n- **System notifications and session log APIs** — Updated to match the latest CLI runtime, adding `system.notification` events and a session log RPC API. ([#737](https://github.com/github/copilot-sdk/pull/737))\n\n## Improvements\n\n- **[.NET, Go]** Serialize event dispatch so handlers are invoked in registration order with no concurrent calls ([#791](https://github.com/github/copilot-sdk/pull/791))\n- **[Go]** Detach CLI process lifespan from the context passed to `Client.Start` so cancellation no longer kills the child process ([#689](https://github.com/github/copilot-sdk/pull/689))\n- **[Go]** Stop RPC client logging expected EOF errors ([#609](https://github.com/github/copilot-sdk/pull/609))\n- **[.NET]** Emit XML doc comments from schema descriptions in generated RPC code ([#724](https://github.com/github/copilot-sdk/pull/724))\n- **[.NET]** Use lazy property initialization in generated RPC classes ([#725](https://github.com/github/copilot-sdk/pull/725))\n- **[.NET]** Add `DebuggerDisplay` attribute to `SessionEvent` for easier debugging ([#726](https://github.com/github/copilot-sdk/pull/726))\n- **[.NET]** Optional RPC params are now represented as optional method params for forward-compatible generated code ([#733](https://github.com/github/copilot-sdk/pull/733))\n- **[.NET]** Replace `Task.WhenAny` + `Task.Delay` timeout pattern with `.WaitAsync(TimeSpan)` ([#805](https://github.com/github/copilot-sdk/pull/805))\n- **[.NET]** Add NuGet package icon ([#688](https://github.com/github/copilot-sdk/pull/688))\n- **[Node]** Don't resolve `cliPath` when `cliUrl` is already set ([#787](https://github.com/github/copilot-sdk/pull/787))\n\n## New RPC methods\n\nWe've added low-level RPC methods to control a lot more of what's going on in the session. These are emerging APIs that don't yet have friendly wrappers, and some may be flagged as experimental or subject to change.\n\n- `session.rpc.skills.list()`, `.enable(name)`, `.disable(name)`, `.reload()`\n- `session.rpc.mcp.list()`, `.enable(name)`, `.disable(name)`, `.reload()`\n- `session.rpc.extensions.list()`, `.enable(name)`, `.disable(name)`, `.reload()`\n- `session.rpc.plugins.list()`\n- `session.rpc.ui.elicitation(...)` — structured user input\n- `session.rpc.shell.exec(command)`, `.kill(pid)`\n- `session.log(message, level, ephemeral)`\n\nIn an forthcoming update, we'll add friendlier wrappers for these.\n\n## Bug fixes\n\n- **[.NET]** Fix `SessionEvent.ToJson()` failing for events with `JsonElement`-backed payloads (`assistant.message`, `tool.execution_start`, etc.) ([#868](https://github.com/github/copilot-sdk/pull/868))\n- **[.NET]** Add fallback `TypeInfoResolver` for `StreamJsonRpc.RequestId` to fix NativeAOT compatibility ([#783](https://github.com/github/copilot-sdk/pull/783))\n- **[.NET]** Fix codegen for discriminated unions nested within other types ([#736](https://github.com/github/copilot-sdk/pull/736))\n- **[.NET]** Handle unknown session event types gracefully instead of throwing ([#881](https://github.com/github/copilot-sdk/pull/881))\n\n---\n\n## ⚠️ Breaking changes\n\n### All SDKs\n\n- **`autoRestart` removed** — The `autoRestart` option has been deprecated across all SDKs (it was never fully implemented). The property still exists but has no effect and will be removed in a future release. Remove any references to `autoRestart` from your client options. ([#803](https://github.com/github/copilot-sdk/pull/803))\n\n### Python\n\nThe Python SDK received a significant API surface overhaul in this release, replacing loosely-typed `TypedDict` config objects with proper keyword arguments and dataclasses. These changes improve IDE autocompletion, type safety, and readability.\n\n- **`CopilotClient` constructor redesigned** — The `CopilotClientOptions` TypedDict has been replaced by two typed config dataclasses. ([#793](https://github.com/github/copilot-sdk/pull/793))\n\n ```python\n # Before (v0.1.x)\n client = CopilotClient({\"cli_url\": \"localhost:3000\"})\n client = CopilotClient({\"cli_path\": \"/usr/bin/copilot\", \"log_level\": \"debug\"})\n\n # After (v0.2.0)\n client = CopilotClient(ExternalServerConfig(url=\"localhost:3000\"))\n client = CopilotClient(SubprocessConfig(cli_path=\"/usr/bin/copilot\", log_level=\"debug\"))\n ```\n\n- **`create_session()` and `resume_session()` now take keyword arguments** instead of a `SessionConfig` / `ResumeSessionConfig` TypedDict. `on_permission_request` is now a required keyword argument. ([#587](https://github.com/github/copilot-sdk/pull/587))\n\n ```python\n # Before\n session = await client.create_session({\n \"on_permission_request\": PermissionHandler.approve_all,\n \"model\": \"gpt-4.1\",\n })\n\n # After\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model=\"gpt-4.1\",\n )\n ```\n\n- **`send()` and `send_and_wait()` take a positional `prompt` string** instead of a `MessageOptions` TypedDict. Attachments and mode are now keyword arguments. ([#814](https://github.com/github/copilot-sdk/pull/814))\n\n ```python\n # Before\n await session.send({\"prompt\": \"Hello!\"})\n await session.send_and_wait({\"prompt\": \"What is 2+2?\"})\n\n # After\n await session.send(\"Hello!\")\n await session.send_and_wait(\"What is 2+2?\")\n ```\n\n- **`MessageOptions`, `SessionConfig`, and `ResumeSessionConfig` removed from public API** — These TypedDicts are no longer exported. Use the new keyword-argument signatures directly. ([#587](https://github.com/github/copilot-sdk/pull/587), [#814](https://github.com/github/copilot-sdk/pull/814))\n\n- **Internal modules renamed to private** — `copilot.jsonrpc`, `copilot.sdk_protocol_version`, and `copilot.telemetry` are now `copilot._jsonrpc`, `copilot._sdk_protocol_version`, and `copilot._telemetry`. If you were importing from these modules directly, update your imports. ([#884](https://github.com/github/copilot-sdk/pull/884))\n\n- **Typed overloads for `CopilotClient.on()`** — Event registration now uses typed overloads for better autocomplete. This shouldn't break existing code but changes the type signature. ([#589](https://github.com/github/copilot-sdk/pull/589))\n\n### Go\n\n- **`Client.Start()` context no longer kills the CLI process** — Previously, canceling the `context.Context` passed to `Start()` would terminate the spawned CLI process (it used `exec.CommandContext`). Now the CLI process lifespan is independent of that context — call `client.Stop()` or `client.ForceStop()` to shut it down. ([#689](https://github.com/github/copilot-sdk/pull/689))\n\n- **`LogOptions.Ephemeral` changed from `bool` to `*bool`** — This enables proper three-state semantics (unset/true/false). Use `copilot.Bool(true)` instead of a bare `true`. ([#827](https://github.com/github/copilot-sdk/pull/827))\n\n ```go\n // Before\n session.Log(ctx, copilot.LogOptions{Level: copilot.LevelInfo, Ephemeral: true}, \"message\")\n\n // After\n session.Log(ctx, copilot.LogOptions{Level: copilot.LevelInfo, Ephemeral: copilot.Bool(true)}, \"message\")\n ```\n\n## [v0.1.32](https://github.com/github/copilot-sdk/releases/tag/v0.1.32) (2026-03-07)\n\n### Feature: backward compatibility with v2 CLI servers\n\nSDK applications written against the v3 API now also work when connected to a v2 CLI server, with no code changes required. The SDK detects the server's protocol version and automatically adapts v2 `tool.call` and `permission.request` messages into the same user-facing handlers used by v3. ([#706](https://github.com/github/copilot-sdk/pull/706))\n\n```ts\nconst session = await client.createSession({\n tools: [myTool], // unchanged — works with v2 and v3 servers\n onPermissionRequest: approveAll,\n});\n```\n\n```cs\nvar session = await client.CreateSessionAsync(new SessionConfig {\n Tools = [myTool], // unchanged — works with v2 and v3 servers\n OnPermissionRequest = approveAll,\n});\n```\n\n## [v0.1.31](https://github.com/github/copilot-sdk/releases/tag/v0.1.31) (2026-03-07)\n\n### Feature: multi-client tool and permission broadcasts (protocol v3)\n\nThe SDK now uses protocol version 3, where the runtime broadcasts `external_tool.requested` and `permission.requested` as session events to all connected clients. This enables multi-client architectures where different clients contribute different tools, or where multiple clients observe the same permission prompts — if one client approves, all clients see the result. Your existing tool and permission handler code is unchanged. ([#686](https://github.com/github/copilot-sdk/pull/686))\n\n```ts\n// Two clients each register different tools; the agent can use both\nconst session1 = await client1.createSession({\n tools: [defineTool(\"search\", { handler: doSearch })],\n onPermissionRequest: approveAll,\n});\nconst session2 = await client2.resumeSession(session1.id, {\n tools: [defineTool(\"analyze\", { handler: doAnalyze })],\n onPermissionRequest: approveAll,\n});\n```\n\n```cs\nvar session1 = await client1.CreateSessionAsync(new SessionConfig {\n Tools = [AIFunctionFactory.Create(DoSearch, \"search\")],\n OnPermissionRequest = PermissionHandlers.ApproveAll,\n});\nvar session2 = await client2.ResumeSessionAsync(session1.Id, new ResumeSessionConfig {\n Tools = [AIFunctionFactory.Create(DoAnalyze, \"analyze\")],\n OnPermissionRequest = PermissionHandlers.ApproveAll,\n});\n```\n\n### Feature: strongly-typed `PermissionRequestResultKind` for .NET and Go\n\nRather than comparing `result.Kind` against undiscoverable magic strings like `\"approved\"` or `\"denied-interactively-by-user\"`, .NET and Go now provide typed constants. Node and Python already had typed unions for this; this brings full parity. ([#631](https://github.com/github/copilot-sdk/pull/631))\n\n```cs\nsession.OnPermissionCompleted += (e) => {\n if (e.Result.Kind == PermissionRequestResultKind.Approved) { /* ... */ }\n if (e.Result.Kind == PermissionRequestResultKind.DeniedInteractivelyByUser) { /* ... */ }\n};\n```\n\n```go\n// Go: PermissionKindApproved, PermissionKindDeniedByRules,\n// PermissionKindDeniedCouldNotRequestFromUser, PermissionKindDeniedInteractivelyByUser\nif result.Kind == copilot.PermissionKindApproved { /* ... */ }\n```\n\n### Other changes\n\n- feature: **[Python]** **[Go]** add `get_last_session_id()` / `GetLastSessionID()` for SDK-wide parity (was already available in Node and .NET) ([#671](https://github.com/github/copilot-sdk/pull/671))\n- improvement: **[Python]** add `timeout` parameter to generated RPC methods, allowing callers to override the default 30s timeout for long-running operations ([#681](https://github.com/github/copilot-sdk/pull/681))\n- bugfix: **[Go]** `PermissionRequest` fields are now properly typed (`ToolName`, `Diff`, `Path`, etc.) instead of a generic `Extra map[string]any` catch-all ([#685](https://github.com/github/copilot-sdk/pull/685))\n\n## [v0.1.30](https://github.com/github/copilot-sdk/releases/tag/v0.1.30) (2026-03-03)\n\n### Feature: support overriding built-in tools\n\nApplications can now override built-in tools such as `grep`, `edit_file`, or `read_file`. To do this, register a custom tool with the same name and set the override flag. Without the flag, the runtime will return an error if the name clashes with a built-in. ([#636](https://github.com/github/copilot-sdk/pull/636))\n\n```ts\nimport { defineTool } from \"@github/copilot-sdk\";\n\nconst session = await client.createSession({\n tools: [defineTool(\"grep\", {\n overridesBuiltInTool: true,\n handler: async (params) => `CUSTOM_GREP_RESULT: ${params.query}`,\n })],\n onPermissionRequest: approveAll,\n});\n```\n\n```cs\nvar grep = AIFunctionFactory.Create(\n ([Description(\"Search query\")] string query) => $\"CUSTOM_GREP_RESULT: {query}\",\n \"grep\",\n \"Custom grep implementation\",\n new AIFunctionFactoryOptions\n {\n AdditionalProperties = new ReadOnlyDictionary(\n new Dictionary { [\"is_override\"] = true })\n });\n```\n\n### Feature: simpler API for changing model mid-session\n\nWhile `session.rpc.model.switchTo()` already worked, there is now a convenience method directly on the session object. ([#621](https://github.com/github/copilot-sdk/pull/621))\n\n- TypeScript: `await session.setModel(\"gpt-4.1\")`\n- C#: `await session.SetModelAsync(\"gpt-4.1\")`\n- Python: `await session.set_model(\"gpt-4.1\")`\n- Go: `err := session.SetModel(ctx, \"gpt-4.1\")`\n\n### Other changes\n\n- improvement: **[C#]** use event delegate for thread-safe, insertion-ordered event handler dispatch ([#624](https://github.com/github/copilot-sdk/pull/624))\n- improvement: **[C#]** deduplicate `OnDisposeCall` and improve implementation ([#626](https://github.com/github/copilot-sdk/pull/626))\n- improvement: **[C#]** remove unnecessary `SemaphoreSlim` locks for handler fields ([#625](https://github.com/github/copilot-sdk/pull/625))\n- bugfix: **[Python]** correct `PermissionHandler.approve_all` type annotations ([#618](https://github.com/github/copilot-sdk/pull/618))\n\n### New contributors\n\n- @giulio-leone made their first contribution in [#618](https://github.com/github/copilot-sdk/pull/618)\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as\ncontributors and maintainers pledge to making participation in our project and\nour community a harassment-free experience for everyone, regardless of age, body\nsize, disability, ethnicity, gender identity and expression, level of experience,\nnationality, personal appearance, race, religion, or sexual identity and\norientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment\ninclude:\n\n- Using welcoming and inclusive language\n- Being respectful of differing viewpoints and experiences\n- Gracefully accepting constructive criticism\n- Focusing on what is best for the community\n- Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n- The use of sexualized language or imagery and unwelcome sexual attention or\n advance\n- Trolling, insulting/derogatory comments, and personal or political attacks\n- Public or private harassment\n- Publishing others' private information, such as a physical or electronic\n address, without explicit permission\n- Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable\nbehavior and are expected to take appropriate and fair corrective action in\nresponse to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or\nreject comments, commits, code, wiki edits, issues, and other contributions\nthat are not aligned to this Code of Conduct, or to ban temporarily or\npermanently any contributor for other behaviors that they deem inappropriate,\nthreatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces\nwhen an individual is representing the project or its community. Examples of\nrepresenting a project or community include using an official project e-mail\naddress, posting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event. Representation of a project may be\nfurther defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported by contacting the project team at . All\ncomplaints will be reviewed and investigated and will result in a response that\nis deemed necessary and appropriate to the circumstances. The project team is\nobligated to maintain confidentiality with regard to the reporter of an incident.\nFurther details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good\nfaith may face temporary or permanent repercussions as determined by other\nmembers of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,\navailable at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" }, { "path": "CONTRIBUTING.md", "content": "# Contributing\n\nThanks for your interest in contributing!\n\nThis repository contains the Copilot SDK, a set of multi-language SDKs (Node/TypeScript, Python, Go, .NET) for building applications with the GitHub Copilot agent, maintained by the GitHub Copilot team.\n\nContributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).\n\nPlease note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.\n\n## Before You Submit a PR\n\n**Please discuss any feature work with us before writing code.**\n\nThe team already has a committed product roadmap, and features must be maintained in sync across all supported languages. Pull requests that introduce features not previously aligned with the team are unlikely to be accepted, regardless of their quality or scope.\n\nIf you submit a PR, **be sure to link to an associated issue describing the bug or agreed feature**. No PRs without context :)\n\n## What We're Looking For\n\nWe welcome:\n\n- Bug fixes with clear reproduction steps\n- Improvements to documentation\n- Making the SDKs more idiomatic and nice to use for each supported language\n- Bug reports and feature suggestions on [our issue tracker](https://github.com/github/copilot-sdk/issues) — especially for bugs with repro steps\n\nWe are generally **not** looking for:\n\n- New features, capabilities, or UX changes that haven't been discussed and agreed with the team\n- Refactors or architectural changes\n- Integrations with external tools or services\n- Additional documentation\n- **SDKs for other languages** — if you want to create a Copilot SDK for another language, we'd love to hear from you and may offer to link to your SDK from our repo. However we do not plan to add further language-specific SDKs to this repo in the short term, since we need to retain our maintenance capacity for moving forwards quickly with the existing language set. For other languages, please consider running your own external project.\n\n## Prerequisites for Running and Testing Code\n\nThis is a multi-language SDK repository. Install the tools for the SDK(s) you plan to work on:\n\n### All SDKs\n\n1. The end-to-end tests across all languages use a shared test harness written in Node.js. Before running tests in any language, `cd test/harness && npm ci`.\n\n### Node.js/TypeScript SDK\n\n1. Install [Node.js](https://nodejs.org/) (v18+)\n1. Install dependencies: `cd nodejs && npm ci`\n\n### Python SDK\n\n1. Install [Python 3.8+](https://www.python.org/downloads/)\n1. Install [uv](https://github.com/astral-sh/uv)\n1. Install dependencies: `cd python && uv pip install -e \".[dev]\"`\n\n### Go SDK\n\n1. Install [Go 1.24+](https://go.dev/doc/install)\n1. Install [golangci-lint](https://golangci-lint.run/welcome/install/#local-installation)\n1. Install dependencies: `cd go && go mod download`\n\n### .NET SDK\n\n1. Install [.NET 8.0+](https://dotnet.microsoft.com/download)\n1. Install .NET dependencies: `cd dotnet && dotnet restore`\n\n## Submitting a Pull Request\n\n1. Fork and clone the repository\n1. Install dependencies for the SDK(s) you're modifying (see above)\n1. Make sure the tests pass on your machine (see commands below)\n1. Make sure linter passes on your machine (see commands below)\n1. Create a new branch: `git checkout -b my-branch-name`\n1. Make your change, add tests, and make sure the tests and linter still pass\n1. Push to your fork and [submit a pull request][pr]\n1. Pat yourself on the back and wait for your pull request to be reviewed and merged.\n\n### Running Tests and Linters\n\n```bash\n# Node.js\ncd nodejs && npm test && npm run lint\n\n# Python\ncd python && uv run pytest && uv run ruff check .\n\n# Go\ncd go && go test ./... && golangci-lint run ./...\n\n# .NET\ncd dotnet && dotnet test test/GitHub.Copilot.SDK.Test.csproj\n```\n\nHere are a few things you can do that will increase the likelihood of your pull request being accepted:\n\n- Write tests.\n- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.\n- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).\n\n## Resources\n\n- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)\n- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)\n- [GitHub Help](https://help.github.com)\n" }, { "path": "LICENSE", "content": "MIT License\n\nCopyright GitHub, Inc.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "README.md", "content": "# GitHub Copilot CLI SDKs\n\n![GitHub Copilot SDK](./assets/RepoHeader_01.png)\n\n[![NPM Downloads](https://img.shields.io/npm/dm/%40github%2Fcopilot-sdk?label=npm)](https://www.npmjs.com/package/@github/copilot-sdk)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/github-copilot-sdk?label=PyPI)](https://pypi.org/project/github-copilot-sdk/)\n[![NuGet Downloads](https://img.shields.io/nuget/dt/GitHub.Copilot.SDK?label=NuGet)](https://www.nuget.org/packages/GitHub.Copilot.SDK)\n\nAgents for every app.\n\nEmbed Copilot's agentic workflows in your application—now available in public preview as a programmable SDK for Python, TypeScript, Go, .NET, and Java.\n\nThe GitHub Copilot SDK exposes the same engine behind Copilot CLI: a production-tested agent runtime you can invoke programmatically. No need to build your own orchestration—you define agent behavior, Copilot handles planning, tool invocation, file edits, and more.\n\n## Available SDKs\n\n| SDK | Location | Cookbook | Installation |\n| ------------------------ | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| **Node.js / TypeScript** | [`nodejs/`](./nodejs/) | [Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/nodejs/README.md) | `npm install @github/copilot-sdk` |\n| **Python** | [`python/`](./python/) | [Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/python/README.md) | `pip install github-copilot-sdk` |\n| **Go** | [`go/`](./go/) | [Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/go/README.md) | `go get github.com/github/copilot-sdk/go` |\n| **.NET** | [`dotnet/`](./dotnet/) | [Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/dotnet/README.md) | `dotnet add package GitHub.Copilot.SDK` |\n| **Java** | [`github/copilot-sdk-java`](https://github.com/github/copilot-sdk-java) | [Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk/java/README.md) | Maven coordinates
`com.github:copilot-sdk-java`
See instructions for [Maven](https://github.com/github/copilot-sdk-java?tab=readme-ov-file#maven) and [Gradle](https://github.com/github/copilot-sdk-java?tab=readme-ov-file#gradle) |\n\nSee the individual SDK READMEs for installation, usage examples, and API reference.\n\n## Getting Started\n\nFor a complete walkthrough, see the **[Getting Started Guide](./docs/getting-started.md)**.\n\nQuick steps:\n\n1. **(Optional) Install the Copilot CLI**\n\nFor Node.js, Python, and .NET SDKs, the Copilot CLI is bundled automatically and no separate installation is required.\nFor the Go SDK, [install the CLI manually](https://github.com/features/copilot/cli) or ensure `copilot` is available in your PATH.\n\n2. **Install your preferred SDK** using the commands above.\n\n3. **See the SDK README** for usage examples and API documentation.\n\n## Architecture\n\nAll SDKs communicate with the Copilot CLI server via JSON-RPC:\n\n```\nYour Application\n ↓\n SDK Client\n ↓ JSON-RPC\n Copilot CLI (server mode)\n```\n\nThe SDK manages the CLI process lifecycle automatically. You can also connect to an external CLI server—see the [Getting Started Guide](./docs/getting-started.md#connecting-to-an-external-cli-server) for details on running the CLI in server mode.\n\n## FAQ\n\n### Do I need a GitHub Copilot subscription to use the SDK?\n\nYes, a GitHub Copilot subscription is required to use the GitHub Copilot SDK, **unless you are using BYOK (Bring Your Own Key)**. With BYOK, you can use the SDK without GitHub authentication by configuring your own API keys from supported LLM providers. For standard usage (non-BYOK), refer to the [GitHub Copilot pricing page](https://github.com/features/copilot#pricing), which includes a free tier with limited usage.\n\n### How does billing work for SDK usage?\n\nBilling for the GitHub Copilot SDK is based on the same model as the Copilot CLI, with each prompt being counted towards your premium request quota. For more information on premium requests, see [Requests in GitHub Copilot](https://docs.github.com/en/copilot/concepts/billing/copilot-requests).\n\n### Does it support BYOK (Bring Your Own Key)?\n\nYes, the GitHub Copilot SDK supports BYOK (Bring Your Own Key). You can configure the SDK to use your own API keys from supported LLM providers (e.g. OpenAI, Azure AI Foundry, Anthropic) to access models through those providers. See the **[BYOK documentation](./docs/auth/byok.md)** for setup instructions and examples.\n\n**Note:** BYOK uses key-based authentication only. Microsoft Entra ID (Azure AD), managed identities, and third-party identity providers are not supported.\n\n### What authentication methods are supported?\n\nThe SDK supports multiple authentication methods:\n\n- **GitHub signed-in user** - Uses stored OAuth credentials from `copilot` CLI login\n- **OAuth GitHub App** - Pass user tokens from your GitHub OAuth app\n- **Environment variables** - `COPILOT_GITHUB_TOKEN`, `GH_TOKEN`, `GITHUB_TOKEN`\n- **BYOK** - Use your own API keys (no GitHub auth required)\n\nSee the **[Authentication documentation](./docs/auth/index.md)** for details on each method.\n\n### Do I need to install the Copilot CLI separately?\n\nNo — for Node.js, Python, and .NET SDKs, the Copilot CLI is bundled automatically as a dependency. You do not need to install it separately.\n\nFor Go SDK, you may still need to install the CLI manually.\n\nAdvanced: You can override the bundled CLI using `cliPath` or `cliUrl` if you want to use a custom CLI binary or connect to an external server.\n\n### What tools are enabled by default?\n\nBy default, the SDK will operate the Copilot CLI in the equivalent of `--allow-all` being passed to the CLI, enabling all first-party tools, which means that the agents can perform a wide range of actions, including file system operations, Git operations, and web requests. You can customize tool availability by configuring the SDK client options to enable and disable specific tools. Refer to the individual SDK documentation for details on tool configuration and Copilot CLI for the list of tools available.\n\n### Can I use custom agents, skills or tools?\n\nYes, the GitHub Copilot SDK allows you to define custom agents, skills, and tools. You can extend the functionality of the agents by implementing your own logic and integrating additional tools as needed. Refer to the SDK documentation of your preferred language for more details.\n\n### Are there instructions for Copilot to speed up development with the SDK?\n\nYes, check out the custom instructions for each SDK:\n\n- **[Node.js / TypeScript](https://github.com/github/awesome-copilot/blob/main/instructions/copilot-sdk-nodejs.instructions.md)**\n- **[Python](https://github.com/github/awesome-copilot/blob/main/instructions/copilot-sdk-python.instructions.md)**\n- **[.NET](https://github.com/github/awesome-copilot/blob/main/instructions/copilot-sdk-csharp.instructions.md)**\n- **[Go](https://github.com/github/awesome-copilot/blob/main/instructions/copilot-sdk-go.instructions.md)**\n- **[Java](https://github.com/github/copilot-sdk-java/blob/main/instructions/copilot-sdk-java.instructions.md)**\n\n### What models are supported?\n\nAll models available via Copilot CLI are supported in the SDK. The SDK also exposes a method which will return the models available so they can be accessed at runtime.\n\n### Is the SDK production-ready?\n\nThe GitHub Copilot SDK is currently in Public Preview. While it is functional and can be used for development and testing, it may not yet be suitable for production use.\n\n### How do I report issues or request features?\n\nPlease use the [GitHub Issues](https://github.com/github/copilot-sdk/issues) page to report bugs or request new features. We welcome your feedback to help improve the SDK.\n\n## Quick Links\n\n- **[Documentation](./docs/index.md)** – Full documentation index\n- **[Getting Started](./docs/getting-started.md)** – Tutorial to get up and running\n- **[Setup Guides](./docs/setup/index.md)** – Architecture, deployment, and scaling\n- **[Authentication](./docs/auth/index.md)** – GitHub OAuth, BYOK, and more\n- **[Features](./docs/features/index.md)** – Hooks, custom agents, MCP, skills, and more\n- **[Troubleshooting](./docs/troubleshooting/debugging.md)** – Common issues and solutions\n- **[Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk)** – Practical recipes for common tasks across all languages\n- **[More Resources](https://github.com/github/awesome-copilot/blob/main/collections/copilot-sdk.md)** – Additional examples, tutorials, and community resources\n\n## Unofficial, Community-maintained SDKs\n\n⚠️ Disclaimer: These are unofficial, community-driven SDKs and they are not supported by GitHub. Use at your own risk.\n\n| SDK | Location |\n| ----------- | -------------------------------------------------------- |\n| **Rust** | [copilot-community-sdk/copilot-sdk-rust][sdk-rust] |\n| **Clojure** | [copilot-community-sdk/copilot-sdk-clojure][sdk-clojure] |\n| **C++** | [0xeb/copilot-sdk-cpp][sdk-cpp] |\n\n[sdk-rust]: https://github.com/copilot-community-sdk/copilot-sdk-rust\n[sdk-cpp]: https://github.com/0xeb/copilot-sdk-cpp\n[sdk-clojure]: https://github.com/copilot-community-sdk/copilot-sdk-clojure\n\n## Contributing\n\nSee [CONTRIBUTING.md](./CONTRIBUTING.md) for contribution guidelines.\n\n## License\n\nMIT\n" }, { "path": "SECURITY.md", "content": "Thanks for helping make GitHub safe for everyone.\n\n# Security\n\nGitHub takes the security of our software products and services seriously, including all of the open source code repositories managed through our GitHub organizations, such as [GitHub](https://github.com/GitHub).\n\nEven though [open source repositories are outside of the scope of our bug bounty program](https://bounty.github.com/index.html#scope) and therefore not eligible for bounty rewards, we will ensure that your finding gets passed along to the appropriate maintainers for remediation.\n\n## Reporting Security Issues\n\nIf you believe you have found a security vulnerability in any GitHub-owned repository, please report it to us through coordinated disclosure.\n\n**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**\n\nInstead, please send an email to opensource-security[@]github.com.\n\nPlease include as much of the information listed below as you can to help us better understand and resolve the issue:\n\n- The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)\n- Full paths of source file(s) related to the manifestation of the issue\n- The location of the affected source code (tag/branch/commit or direct URL)\n- Any special configuration required to reproduce the issue\n- Step-by-step instructions to reproduce the issue\n- Proof-of-concept or exploit code (if possible)\n- Impact of the issue, including how an attacker might exploit the issue\n\nThis information will help us triage your report more quickly.\n\n## Policy\n\nSee [GitHub's Safe Harbor Policy](https://docs.github.com/en/site-policy/security-policies/github-bug-bounty-program-legal-safe-harbor#1-safe-harbor-terms)\n" }, { "path": "SUPPORT.md", "content": "# Support\n\n## How to file issues and get help\n\nThis project uses GitHub issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new issue.\n\nFor help or questions about using this project, please file an issue.\n\n**Copilot SDK** is under active development and maintained by GitHub staff **AND THE COMMUNITY**. We will do our best to respond to support, feature requests, and community questions in a timely manner.\n\n## GitHub Support Policy\n\nSupport for this project is limited to the resources listed above.\n" }, { "path": "docs/auth/byok.md", "content": "# BYOK (Bring Your Own Key)\n\nBYOK allows you to use the Copilot SDK with your own API keys from model providers, bypassing GitHub Copilot authentication. This is useful for enterprise deployments, custom model hosting, or when you want direct billing with your model provider.\n\n## Supported Providers\n\n| Provider | Type Value | Notes |\n|----------|------------|-------|\n| OpenAI | `\"openai\"` | OpenAI API and OpenAI-compatible endpoints |\n| Azure OpenAI / Azure AI Foundry | `\"azure\"` | Azure-hosted models |\n| Anthropic | `\"anthropic\"` | Claude models |\n| Ollama | `\"openai\"` | Local models via OpenAI-compatible API |\n| Microsoft Foundry Local | `\"openai\"` | Run AI models locally on your device via OpenAI-compatible API |\n| Other OpenAI-compatible | `\"openai\"` | vLLM, LiteLLM, etc. |\n\n## Quick Start: Azure AI Foundry\n\nAzure AI Foundry (formerly Azure OpenAI) is a common BYOK deployment target for enterprises. Here's a complete example:\n\n
\nPython\n\n```python\nimport asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionHandler\n\nFOUNDRY_MODEL_URL = \"https://your-resource.openai.azure.com/openai/v1/\"\n# Set FOUNDRY_API_KEY environment variable\n\nasync def main():\n client = CopilotClient()\n await client.start()\n\n session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model=\"gpt-5.2-codex\", provider={\n \"type\": \"openai\",\n \"base_url\": FOUNDRY_MODEL_URL,\n \"wire_api\": \"responses\", # Use \"completions\" for older models\n \"api_key\": os.environ[\"FOUNDRY_API_KEY\"],\n })\n\n done = asyncio.Event()\n\n def on_event(event):\n if event.type.value == \"assistant.message\":\n print(event.data.content)\n elif event.type.value == \"session.idle\":\n done.set()\n\n session.on(on_event)\n await session.send({\"prompt\": \"What is 2+2?\"})\n await done.wait()\n\n await session.disconnect()\n await client.stop()\n\nasyncio.run(main())\n```\n\n
\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst FOUNDRY_MODEL_URL = \"https://your-resource.openai.azure.com/openai/v1/\";\n\nconst client = new CopilotClient();\nconst session = await client.createSession({\n model: \"gpt-5.2-codex\", // Your deployment name\n provider: {\n type: \"openai\",\n baseUrl: FOUNDRY_MODEL_URL,\n wireApi: \"responses\", // Use \"completions\" for older models\n apiKey: process.env.FOUNDRY_API_KEY,\n },\n});\n\nsession.on(\"assistant.message\", (event) => {\n console.log(event.data.content);\n});\n\nawait session.sendAndWait({ prompt: \"What is 2+2?\" });\nawait client.stop();\n```\n\n
\n\n
\nGo\n\n```go\npackage main\n\nimport (\n \"context\"\n \"fmt\"\n \"os\"\n copilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n client := copilot.NewClient(nil)\n if err := client.Start(ctx); err != nil {\n panic(err)\n }\n defer client.Stop()\n\n session, err := client.CreateSession(ctx, &copilot.SessionConfig{\n Model: \"gpt-5.2-codex\", // Your deployment name\n Provider: &copilot.ProviderConfig{\n Type: \"openai\",\n BaseURL: \"https://your-resource.openai.azure.com/openai/v1/\",\n WireApi: \"responses\", // Use \"completions\" for older models\n APIKey: os.Getenv(\"FOUNDRY_API_KEY\"),\n },\n })\n if err != nil {\n panic(err)\n }\n\n response, err := session.SendAndWait(ctx, copilot.MessageOptions{\n Prompt: \"What is 2+2?\",\n })\n if err != nil {\n panic(err)\n }\n\n if d, ok := response.Data.(*copilot.AssistantMessageData); ok {\n fmt.Println(d.Content)\n }\n}\n```\n\n
\n\n
\n.NET\n\n```csharp\nusing GitHub.Copilot.SDK;\n\nawait using var client = new CopilotClient();\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5.2-codex\", // Your deployment name\n Provider = new ProviderConfig\n {\n Type = \"openai\",\n BaseUrl = \"https://your-resource.openai.azure.com/openai/v1/\",\n WireApi = \"responses\", // Use \"completions\" for older models\n ApiKey = Environment.GetEnvironmentVariable(\"FOUNDRY_API_KEY\"),\n },\n});\n\nvar response = await session.SendAndWaitAsync(new MessageOptions\n{\n Prompt = \"What is 2+2?\",\n});\nConsole.WriteLine(response?.Data.Content);\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\n\nvar client = new CopilotClient();\nclient.start().get();\n\nvar session = client.createSession(new SessionConfig()\n .setModel(\"gpt-5.2-codex\") // Your deployment name\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n .setProvider(new ProviderConfig()\n .setType(\"openai\")\n .setBaseUrl(\"https://your-resource.openai.azure.com/openai/v1/\")\n .setWireApi(\"responses\") // Use \"completions\" for older models\n .setApiKey(System.getenv(\"FOUNDRY_API_KEY\")))\n).get();\n\nvar response = session.sendAndWait(new MessageOptions()\n .setPrompt(\"What is 2+2?\")).get();\nSystem.out.println(response.getData().content());\n\nclient.stop().get();\n```\n\n
\n\n## Provider Configuration Reference\n\n### ProviderConfig Fields\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `type` | `\"openai\"` \\| `\"azure\"` \\| `\"anthropic\"` | Provider type (default: `\"openai\"`) |\n| `baseUrl` / `base_url` | string | **Required.** API endpoint URL |\n| `apiKey` / `api_key` | string | API key (optional for local providers like Ollama) |\n| `bearerToken` / `bearer_token` | string | Bearer token auth (takes precedence over apiKey) |\n| `wireApi` / `wire_api` | `\"completions\"` \\| `\"responses\"` | API format (default: `\"completions\"`) |\n| `azure.apiVersion` / `azure.api_version` | string | Azure API version (default: `\"2024-10-21\"`) |\n\n### Wire API Format\n\nThe `wireApi` setting determines which OpenAI API format to use:\n\n- **`\"completions\"`** (default) - Chat Completions API (`/chat/completions`). Use for most models.\n- **`\"responses\"`** - Responses API. Use for GPT-5 series models that support the newer responses format.\n\n### Type-Specific Notes\n\n**OpenAI (`type: \"openai\"`)**\n- Works with OpenAI API and any OpenAI-compatible endpoint\n- `baseUrl` should include the full path (e.g., `https://api.openai.com/v1`)\n\n**Azure (`type: \"azure\"`)**\n- Use for native Azure OpenAI endpoints\n- `baseUrl` should be just the host (e.g., `https://my-resource.openai.azure.com`)\n- Do NOT include `/openai/v1` in the URL—the SDK handles path construction\n\n**Anthropic (`type: \"anthropic\"`)**\n- For direct Anthropic API access\n- Uses Claude-specific API format\n\n## Example Configurations\n\n### OpenAI Direct\n\n```typescript\nprovider: {\n type: \"openai\",\n baseUrl: \"https://api.openai.com/v1\",\n apiKey: process.env.OPENAI_API_KEY,\n}\n```\n\n### Azure OpenAI (Native Azure Endpoint)\n\nUse `type: \"azure\"` for endpoints at `*.openai.azure.com`:\n\n```typescript\nprovider: {\n type: \"azure\",\n baseUrl: \"https://my-resource.openai.azure.com\", // Just the host\n apiKey: process.env.AZURE_OPENAI_KEY,\n azure: {\n apiVersion: \"2024-10-21\",\n },\n}\n```\n\n### Azure AI Foundry (OpenAI-Compatible Endpoint)\n\nFor Azure AI Foundry deployments with `/openai/v1/` endpoints, use `type: \"openai\"`:\n\n```typescript\nprovider: {\n type: \"openai\",\n baseUrl: \"https://your-resource.openai.azure.com/openai/v1/\",\n apiKey: process.env.FOUNDRY_API_KEY,\n wireApi: \"responses\", // For GPT-5 series models\n}\n```\n\n### Ollama (Local)\n\n```typescript\nprovider: {\n type: \"openai\",\n baseUrl: \"http://localhost:11434/v1\",\n // No apiKey needed for local Ollama\n}\n```\n\n### Microsoft Foundry Local\n\n[Microsoft Foundry Local](https://foundrylocal.ai) lets you run AI models locally on your own device with an OpenAI-compatible API. Install it via the Foundry Local CLI, then point the SDK at your local endpoint:\n\n```typescript\nprovider: {\n type: \"openai\",\n baseUrl: \"http://localhost:/v1\",\n // No apiKey needed for local Foundry Local\n}\n```\n\n> **Note:** Foundry Local starts on a **dynamic port** — the port is not fixed. Use `foundry service status` to confirm the port the service is currently listening on, then use that port in your `baseUrl`.\n\nTo get started with Foundry Local:\n\n```bash\n# Windows: Install Foundry Local CLI (requires winget)\nwinget install Microsoft.FoundryLocal\n\n# macOS / Linux: see https://foundrylocal.ai for installation instructions\n# List available models\nfoundry model list\n\n# Run a model (starts the local server automatically)\nfoundry model run phi-4-mini\n\n# Check the port the service is running on\nfoundry service status\n```\n\n### Anthropic\n\n```typescript\nprovider: {\n type: \"anthropic\",\n baseUrl: \"https://api.anthropic.com\",\n apiKey: process.env.ANTHROPIC_API_KEY,\n}\n```\n\n### Bearer Token Authentication\n\nSome providers require bearer token authentication instead of API keys:\n\n```typescript\nprovider: {\n type: \"openai\",\n baseUrl: \"https://my-custom-endpoint.example.com/v1\",\n bearerToken: process.env.MY_BEARER_TOKEN, // Sets Authorization header\n}\n```\n\n> **Note:** The `bearerToken` option accepts a **static token string** only. The SDK does not refresh this token automatically. If your token expires, requests will fail and you'll need to create a new session with a fresh token.\n\n## Custom Model Listing\n\nWhen using BYOK, the CLI server may not know which models your provider supports. You can supply a custom `onListModels` handler at the client level so that `client.listModels()` returns your provider's models in the standard `ModelInfo` format. This lets downstream consumers discover available models without querying the CLI.\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\nimport type { ModelInfo } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient({\n onListModels: () => [\n {\n id: \"my-custom-model\",\n name: \"My Custom Model\",\n capabilities: {\n supports: { vision: false, reasoningEffort: false },\n limits: { max_context_window_tokens: 128000 },\n },\n },\n ],\n});\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.client import ModelInfo, ModelCapabilities, ModelSupports, ModelLimits\n\nclient = CopilotClient({\n \"on_list_models\": lambda: [\n ModelInfo(\n id=\"my-custom-model\",\n name=\"My Custom Model\",\n capabilities=ModelCapabilities(\n supports=ModelSupports(vision=False, reasoning_effort=False),\n limits=ModelLimits(max_context_window_tokens=128000),\n ),\n )\n ],\n})\n```\n\n
\n\n
\nGo\n\n```go\npackage main\n\nimport (\n \"context\"\n copilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n client := copilot.NewClient(&copilot.ClientOptions{\n OnListModels: func(ctx context.Context) ([]copilot.ModelInfo, error) {\n return []copilot.ModelInfo{\n {\n ID: \"my-custom-model\",\n Name: \"My Custom Model\",\n Capabilities: copilot.ModelCapabilities{\n Supports: copilot.ModelSupports{Vision: false, ReasoningEffort: false},\n Limits: copilot.ModelLimits{MaxContextWindowTokens: 128000},\n },\n },\n }, nil\n },\n })\n _ = client\n}\n```\n\n
\n\n
\n.NET\n\n```csharp\nusing GitHub.Copilot.SDK;\n\nvar client = new CopilotClient(new CopilotClientOptions\n{\n OnListModels = (ct) => Task.FromResult>(new List\n {\n new()\n {\n Id = \"my-custom-model\",\n Name = \"My Custom Model\",\n Capabilities = new ModelCapabilities\n {\n Supports = new ModelSupports { Vision = false, ReasoningEffort = false },\n Limits = new ModelLimits { MaxContextWindowTokens = 128000 }\n }\n }\n })\n});\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.json.*;\nimport java.util.List;\nimport java.util.concurrent.CompletableFuture;\n\nvar client = new CopilotClient(new CopilotClientOptions()\n .setOnListModels(() -> CompletableFuture.completedFuture(List.of(\n new ModelInfo()\n .setId(\"my-custom-model\")\n .setName(\"My Custom Model\")\n .setCapabilities(new ModelCapabilities()\n .setSupports(new ModelSupports().setVision(false).setReasoningEffort(false))\n .setLimits(new ModelLimits().setMaxContextWindowTokens(128000)))\n )))\n);\n```\n\n
\n\nResults are cached after the first call, just like the default behavior. The handler completely replaces the CLI's `models.list` RPC — no fallback to the server occurs.\n\n## Limitations\n\nWhen using BYOK, be aware of these limitations:\n\n### Identity Limitations\n\nBYOK authentication uses **static credentials only**. The following identity providers are NOT supported:\n\n- ❌ **Microsoft Entra ID (Azure AD)** - No support for Entra managed identities or service principals\n- ❌ **Third-party identity providers** - No OIDC, SAML, or other federated identity\n- ❌ **Managed identities** - Azure Managed Identity is not supported\n\nYou must use an API key or static bearer token that you manage yourself.\n\n**Why not Entra ID?** While Entra ID does issue bearer tokens, these tokens are short-lived (typically 1 hour) and require automatic refresh via the Azure Identity SDK. The `bearerToken` option only accepts a static string—there is no callback mechanism for the SDK to request fresh tokens. For long-running workloads requiring Entra authentication, you would need to implement your own token refresh logic and create new sessions with updated tokens.\n\n### Feature Limitations\n\nSome Copilot features may behave differently with BYOK:\n\n- **Model availability** - Only models supported by your provider are available\n- **Rate limiting** - Subject to your provider's rate limits, not Copilot's\n- **Usage tracking** - Usage is tracked by your provider, not GitHub Copilot\n- **Premium requests** - Do not count against Copilot premium request quotas\n\n### Provider-Specific Limitations\n\n| Provider | Limitations |\n|----------|-------------|\n| Azure AI Foundry | No Entra ID auth; must use API keys |\n| Ollama | No API key; local only; model support varies |\n| [Microsoft Foundry Local](https://foundrylocal.ai) | Local only; model availability depends on device hardware; no API key required |\n| OpenAI | Subject to OpenAI rate limits and quotas |\n\n## Troubleshooting\n\n### \"Model not specified\" Error\n\nWhen using BYOK, the `model` parameter is **required**:\n\n```typescript\n// ❌ Error: Model required with custom provider\nconst session = await client.createSession({\n provider: { type: \"openai\", baseUrl: \"...\" },\n});\n\n// ✅ Correct: Model specified\nconst session = await client.createSession({\n model: \"gpt-4\", // Required!\n provider: { type: \"openai\", baseUrl: \"...\" },\n});\n```\n\n### Azure Endpoint Type Confusion\n\nFor Azure OpenAI endpoints (`*.openai.azure.com`), use the correct type:\n\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\nconst session = await client.createSession({\n model: \"gpt-4.1\",\n provider: {\n type: \"azure\",\n baseUrl: \"https://my-resource.openai.azure.com\",\n },\n});\n```\n\n\n```typescript\n// ❌ Wrong: Using \"openai\" type with native Azure endpoint\nprovider: {\n type: \"openai\", // This won't work correctly\n baseUrl: \"https://my-resource.openai.azure.com\",\n}\n\n// ✅ Correct: Using \"azure\" type\nprovider: {\n type: \"azure\",\n baseUrl: \"https://my-resource.openai.azure.com\",\n}\n```\n\nHowever, if your Azure AI Foundry deployment provides an OpenAI-compatible endpoint path (e.g., `/openai/v1/`), use `type: \"openai\"`:\n\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\nconst session = await client.createSession({\n model: \"gpt-4.1\",\n provider: {\n type: \"openai\",\n baseUrl: \"https://your-resource.openai.azure.com/openai/v1/\",\n },\n});\n```\n\n\n```typescript\n// ✅ Correct: OpenAI-compatible Azure AI Foundry endpoint\nprovider: {\n type: \"openai\",\n baseUrl: \"https://your-resource.openai.azure.com/openai/v1/\",\n}\n```\n\n### Connection Refused (Ollama)\n\nEnsure Ollama is running and accessible:\n\n```bash\n# Check Ollama is running\ncurl http://localhost:11434/v1/models\n\n# Start Ollama if not running\nollama serve\n```\n\n### Connection Refused (Foundry Local)\n\nFoundry Local uses a dynamic port that may change between restarts. Confirm the active port:\n\n```bash\n# Check the service status and port\nfoundry service status\n```\n\nUpdate your `baseUrl` to match the port shown in the output. If the service is not running, start a model to launch it:\n\n```bash\nfoundry model run phi-4-mini\n```\n\n### Authentication Failed\n\n1. Verify your API key is correct and not expired\n2. Check the `baseUrl` matches your provider's expected format\n3. For bearer tokens, ensure the full token is provided (not just a prefix)\n\n## Next Steps\n\n- [Authentication Overview](./index.md) - Learn about all authentication methods\n- [Getting Started Guide](../getting-started.md) - Build your first Copilot-powered app\n" }, { "path": "docs/auth/index.md", "content": "# Authentication\n\nThe GitHub Copilot SDK supports multiple authentication methods to fit different use cases. Choose the method that best matches your deployment scenario.\n\n## Authentication Methods\n\n| Method | Use Case | Copilot Subscription Required |\n|--------|----------|-------------------------------|\n| [GitHub Signed-in User](#github-signed-in-user) | Interactive apps where users sign in with GitHub | Yes |\n| [OAuth GitHub App](#oauth-github-app) | Apps acting on behalf of users via OAuth | Yes |\n| [Environment Variables](#environment-variables) | CI/CD, automation, server-to-server | Yes |\n| [BYOK (Bring Your Own Key)](./byok.md) | Using your own API keys (Azure AI Foundry, OpenAI, etc.) | No |\n\n## GitHub Signed-in User\n\nThis is the default authentication method when running the Copilot CLI interactively. Users authenticate via GitHub OAuth device flow, and the SDK uses their stored credentials.\n\n**How it works:**\n1. User runs `copilot` CLI and signs in via GitHub OAuth\n2. Credentials are stored securely in the system keychain\n3. SDK automatically uses stored credentials\n\n**SDK Configuration:**\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\n// Default: uses logged-in user credentials\nconst client = new CopilotClient();\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot import CopilotClient\n\n# Default: uses logged-in user credentials\nclient = CopilotClient()\nawait client.start()\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport copilot \"github.com/github/copilot-sdk/go\"\n\nfunc main() {\n\t// Default: uses logged-in user credentials\n\tclient := copilot.NewClient(nil)\n\t_ = client\n}\n```\n\n\n```go\nimport copilot \"github.com/github/copilot-sdk/go\"\n\n// Default: uses logged-in user credentials\nclient := copilot.NewClient(nil)\n```\n\n
\n\n
\n.NET\n\n```csharp\nusing GitHub.Copilot.SDK;\n\n// Default: uses logged-in user credentials\nawait using var client = new CopilotClient();\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\n\n// Default: uses logged-in user credentials\nvar client = new CopilotClient();\nclient.start().get();\n```\n\n
\n\n**When to use:**\n- Desktop applications where users interact directly\n- Development and testing environments\n- Any scenario where a user can sign in interactively\n\n## OAuth GitHub App\n\nUse an OAuth GitHub App to authenticate users through your application and pass their credentials to the SDK. This enables your application to make Copilot API requests on behalf of users who authorize your app.\n\n**How it works:**\n1. User authorizes your OAuth GitHub App\n2. Your app receives a user access token (`gho_` or `ghu_` prefix)\n3. Pass the token to the SDK via `gitHubToken` option\n\n**SDK Configuration:**\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient({\n gitHubToken: userAccessToken, // Token from OAuth flow\n useLoggedInUser: false, // Don't use stored CLI credentials\n});\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot import CopilotClient\n\nclient = CopilotClient({\n \"github_token\": user_access_token, # Token from OAuth flow\n \"use_logged_in_user\": False, # Don't use stored CLI credentials\n})\nawait client.start()\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport copilot \"github.com/github/copilot-sdk/go\"\n\nfunc main() {\n\tuserAccessToken := \"token\"\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: userAccessToken,\n\t\tUseLoggedInUser: copilot.Bool(false),\n\t})\n\t_ = client\n}\n```\n\n\n```go\nimport copilot \"github.com/github/copilot-sdk/go\"\n\nclient := copilot.NewClient(&copilot.ClientOptions{\n GithubToken: userAccessToken, // Token from OAuth flow\n UseLoggedInUser: copilot.Bool(false), // Don't use stored CLI credentials\n})\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\nvar userAccessToken = \"token\";\nawait using var client = new CopilotClient(new CopilotClientOptions\n{\n GithubToken = userAccessToken,\n UseLoggedInUser = false,\n});\n```\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\nawait using var client = new CopilotClient(new CopilotClientOptions\n{\n GithubToken = userAccessToken, // Token from OAuth flow\n UseLoggedInUser = false, // Don't use stored CLI credentials\n});\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.json.*;\n\nvar client = new CopilotClient(new CopilotClientOptions()\n .setGitHubToken(userAccessToken) // Token from OAuth flow\n .setUseLoggedInUser(false) // Don't use stored CLI credentials\n);\nclient.start().get();\n```\n\n
\n\n**Supported token types:**\n- `gho_` - OAuth user access tokens\n- `ghu_` - GitHub App user access tokens \n- `github_pat_` - Fine-grained personal access tokens\n\n**Not supported:**\n- `ghp_` - Classic personal access tokens (deprecated)\n\n**When to use:**\n- Web applications where users sign in via GitHub\n- SaaS applications building on top of Copilot\n- Any multi-user application where you need to make requests on behalf of different users\n\n## Environment Variables\n\nFor automation, CI/CD pipelines, and server-to-server scenarios, you can authenticate using environment variables.\n\n**Supported environment variables (in priority order):**\n1. `COPILOT_GITHUB_TOKEN` - Recommended for explicit Copilot usage\n2. `GH_TOKEN` - GitHub CLI compatible\n3. `GITHUB_TOKEN` - GitHub Actions compatible\n\n**How it works:**\n1. Set one of the supported environment variables with a valid token\n2. The SDK automatically detects and uses the token\n\n**SDK Configuration:**\n\nNo code changes needed—the SDK automatically detects environment variables:\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\n// Token is read from environment variable automatically\nconst client = new CopilotClient();\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot import CopilotClient\n\n# Token is read from environment variable automatically\nclient = CopilotClient()\nawait client.start()\n```\n\n
\n\n**When to use:**\n- CI/CD pipelines (GitHub Actions, Jenkins, etc.)\n- Automated testing\n- Server-side applications with service accounts\n- Development when you don't want to use interactive login\n\n## BYOK (Bring Your Own Key)\n\nBYOK allows you to use your own API keys from model providers like Azure AI Foundry, OpenAI, or Anthropic. This bypasses GitHub Copilot authentication entirely.\n\n**Key benefits:**\n- No GitHub Copilot subscription required\n- Use enterprise model deployments\n- Direct billing with your model provider\n- Support for Azure AI Foundry, OpenAI, Anthropic, and OpenAI-compatible endpoints\n\n**See the [BYOK documentation](./byok.md) for complete details**, including:\n- Azure AI Foundry setup\n- Provider configuration options\n- Limitations and considerations\n- Complete code examples\n\n## Authentication Priority\n\nWhen multiple authentication methods are available, the SDK uses them in this priority order:\n\n1. **Explicit `gitHubToken`** - Token passed directly to SDK constructor\n2. **HMAC key** - `CAPI_HMAC_KEY` or `COPILOT_HMAC_KEY` environment variables\n3. **Direct API token** - `GITHUB_COPILOT_API_TOKEN` with `COPILOT_API_URL`\n4. **Environment variable tokens** - `COPILOT_GITHUB_TOKEN` → `GH_TOKEN` → `GITHUB_TOKEN`\n5. **Stored OAuth credentials** - From previous `copilot` CLI login\n6. **GitHub CLI** - `gh auth` credentials\n\n## Disabling Auto-Login\n\nTo prevent the SDK from automatically using stored credentials or `gh` CLI auth, use the `useLoggedInUser: false` option:\n\n
\nNode.js / TypeScript\n\n```typescript\nconst client = new CopilotClient({\n useLoggedInUser: false, // Only use explicit tokens\n});\n```\n\n
\n\n
\nPython\n\n\n```python\nfrom copilot import CopilotClient\n\nclient = CopilotClient({\n \"use_logged_in_user\": False,\n})\n```\n\n\n```python\nclient = CopilotClient({\n \"use_logged_in_user\": False, # Only use explicit tokens\n})\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport copilot \"github.com/github/copilot-sdk/go\"\n\nfunc main() {\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tUseLoggedInUser: copilot.Bool(false),\n\t})\n\t_ = client\n}\n```\n\n\n```go\nclient := copilot.NewClient(&copilot.ClientOptions{\n UseLoggedInUser: copilot.Bool(false), // Only use explicit tokens\n})\n```\n\n
\n\n
\n.NET\n\n```csharp\nawait using var client = new CopilotClient(new CopilotClientOptions\n{\n UseLoggedInUser = false, // Only use explicit tokens\n});\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.json.*;\n\nvar client = new CopilotClient(new CopilotClientOptions()\n .setUseLoggedInUser(false) // Only use explicit tokens\n);\nclient.start().get();\n```\n\n
\n\n## Next Steps\n\n- [BYOK Documentation](./byok.md) - Learn how to use your own API keys\n- [Getting Started Guide](../getting-started.md) - Build your first Copilot-powered app\n- [MCP Servers](../features/mcp.md) - Connect to external tools\n" }, { "path": "docs/features/agent-loop.md", "content": "# The Agent Loop\r\n\r\nHow the Copilot CLI processes a user message end-to-end: from prompt to `session.idle`.\r\n\r\n## Architecture\r\n\r\n```mermaid\r\ngraph LR\r\n App[\"Your App\"] -->|send prompt| SDK[\"SDK Session\"]\r\n SDK -->|JSON-RPC| CLI[\"Copilot CLI\"]\r\n CLI -->|API calls| LLM[\"LLM\"]\r\n LLM -->|response| CLI\r\n CLI -->|events| SDK\r\n SDK -->|events| App\r\n```\r\n\r\nThe **SDK** is a transport layer — it sends your prompt to the **Copilot CLI** over JSON-RPC and surfaces events back to your app. The **CLI** is the orchestrator that runs the agentic tool-use loop, making one or more LLM API calls until the task is done.\r\n\r\n## The Tool-Use Loop\r\n\r\nWhen you call `session.send({ prompt })`, the CLI enters a loop:\r\n\r\n```mermaid\r\nflowchart TD\r\n A[\"User prompt\"] --> B[\"LLM API call\\n(= one turn)\"]\r\n B --> C{\"toolRequests\\nin response?\"}\r\n C -->|Yes| D[\"Execute tools\\nCollect results\"]\r\n D -->|\"Results fed back\\nas next turn input\"| B\r\n C -->|No| E[\"Final text\\nresponse\"]\r\n E --> F([\"session.idle\"])\r\n\r\n style B fill:#1a1a2e,stroke:#58a6ff,color:#c9d1d9\r\n style D fill:#1a1a2e,stroke:#3fb950,color:#c9d1d9\r\n style F fill:#0d1117,stroke:#f0883e,color:#f0883e\r\n```\r\n\r\nThe model sees the **full conversation history** on each call — system prompt, user message, and all prior tool calls and results.\r\n\r\n**Key insight:** Each iteration of this loop is exactly one LLM API call, visible as one `assistant.turn_start` / `assistant.turn_end` pair in the event log. There are no hidden calls.\r\n\r\n## Turns — What They Are\r\n\r\nA **turn** is a single LLM API call and its consequences:\r\n\r\n1. The CLI sends the conversation history to the LLM\r\n2. The LLM responds (possibly with tool requests)\r\n3. If tools were requested, the CLI executes them\r\n4. `assistant.turn_end` is emitted\r\n\r\nA single user message typically results in **multiple turns**. For example, a question like \"how does X work in this codebase?\" might produce:\r\n\r\n| Turn | What the model does | toolRequests? |\r\n|------|-------------------|---------------|\r\n| 1 | Calls `grep` and `glob` to search the codebase | ✅ Yes |\r\n| 2 | Reads specific files based on search results | ✅ Yes |\r\n| 3 | Reads more files for deeper context | ✅ Yes |\r\n| 4 | Produces the final text answer | ❌ No → loop ends |\r\n\r\nThe model decides on each turn whether to request more tools or produce a final answer. Each call sees the **full accumulated context** (all prior tool calls and results), so it can make an informed decision about whether it has enough information.\r\n\r\n## Event Flow for a Multi-Turn Interaction\r\n\r\n```mermaid\r\nflowchart TD\r\n send[\"session.send({ prompt: "Fix the bug in auth.ts" })\"]\r\n\r\n subgraph Turn1 [\"Turn 1\"]\r\n t1s[\"assistant.turn_start\"]\r\n t1m[\"assistant.message (toolRequests)\"]\r\n t1ts[\"tool.execution_start (read_file)\"]\r\n t1tc[\"tool.execution_complete\"]\r\n t1e[\"assistant.turn_end\"]\r\n t1s --> t1m --> t1ts --> t1tc --> t1e\r\n end\r\n\r\n subgraph Turn2 [\"Turn 2 — auto-triggered by CLI\"]\r\n t2s[\"assistant.turn_start\"]\r\n t2m[\"assistant.message (toolRequests)\"]\r\n t2ts[\"tool.execution_start (edit_file)\"]\r\n t2tc[\"tool.execution_complete\"]\r\n t2e[\"assistant.turn_end\"]\r\n t2s --> t2m --> t2ts --> t2tc --> t2e\r\n end\r\n\r\n subgraph Turn3 [\"Turn 3\"]\r\n t3s[\"assistant.turn_start\"]\r\n t3m[\"assistant.message (no toolRequests)\\n"Done, here's what I changed"\"]\r\n t3e[\"assistant.turn_end\"]\r\n t3s --> t3m --> t3e\r\n end\r\n\r\n idle([\"session.idle — ready for next message\"])\r\n\r\n send --> Turn1 --> Turn2 --> Turn3 --> idle\r\n```\r\n\r\n## Who Triggers Each Turn?\r\n\r\n| Actor | Responsibility |\r\n|-------|---------------|\r\n| **Your app** | Sends the initial prompt via `session.send()` |\r\n| **Copilot CLI** | Runs the tool-use loop — executes tools and feeds results back to the LLM for the next turn |\r\n| **LLM** | Decides whether to request tools (continue looping) or produce a final response (stop) |\r\n| **SDK** | Passes events through; does not control the loop |\r\n\r\nThe CLI is purely mechanical: \"model asked for tools → execute → call model again.\" The **model** is the decision-maker for when to stop.\r\n\r\n## `session.idle` vs `session.task_complete`\r\n\r\nThese are two different completion signals with very different guarantees:\r\n\r\n### `session.idle`\r\n\r\n- **Always emitted** when the tool-use loop ends\r\n- **Ephemeral** — not persisted to disk, not replayed on session resume\r\n- Means: \"the agent has stopped processing and is ready for the next message\"\r\n- **Use this** as your reliable \"done\" signal\r\n\r\nThe SDK's `sendAndWait()` method waits for this event:\r\n\r\n```typescript\r\n// Blocks until session.idle fires\r\nconst response = await session.sendAndWait({ prompt: \"Fix the bug\" });\r\n```\r\n\r\n### `session.task_complete`\r\n\r\n- **Optionally emitted** — requires the model to explicitly signal it\r\n- **Persisted** — saved to the session event log on disk\r\n- Means: \"the agent considers the overall task fulfilled\"\r\n- Carries an optional `summary` field\r\n\r\n```typescript\r\nsession.on(\"session.task_complete\", (event) => {\r\n console.log(\"Task done:\", event.data.summary);\r\n});\r\n```\r\n\r\n### Autopilot mode: the CLI nudges for `task_complete`\r\n\r\nIn **autopilot mode** (headless/autonomous operation), the CLI actively tracks whether the model has called `task_complete`. If the tool-use loop ends without it, the CLI injects a synthetic user message nudging the model:\r\n\r\n> *\"You have not yet marked the task as complete using the task_complete tool. If you were planning, stop planning and start implementing. You aren't done until you have fully completed the task.\"*\r\n\r\nThis effectively restarts the tool-use loop — the model sees the nudge as a new user message and continues working. The nudge also instructs the model **not** to call `task_complete` prematurely:\r\n\r\n- Don't call it if you have open questions — make decisions and keep working\r\n- Don't call it if you hit an error — try to resolve it\r\n- Don't call it if there are remaining steps — complete them first\r\n\r\nThis creates a **two-level completion mechanism** in autopilot:\r\n1. The model calls `task_complete` with a summary → CLI emits `session.task_complete` → done\r\n2. The model stops without calling it → CLI nudges → model continues or calls `task_complete`\r\n\r\n### Why `task_complete` might not appear\r\n\r\nIn **interactive mode** (normal chat), the CLI does not nudge for `task_complete`. The model may skip it entirely. Common reasons:\r\n\r\n- **Conversational Q&A**: The model answers a question and simply stops — there's no discrete \"task\" to complete\r\n- **Model discretion**: The model produces a final text response without calling the task-complete signal\r\n- **Interrupted sessions**: The session ends before the model reaches a completion point\r\n\r\nThe CLI emits `session.idle` regardless, because it's a mechanical signal (the loop ended), not a semantic one (the model thinks it's done).\r\n\r\n### Which should you use?\r\n\r\n| Use case | Signal |\r\n|----------|--------|\r\n| \"Wait for the agent to finish processing\" | `session.idle` ✅ |\r\n| \"Know when a coding task is done\" | `session.task_complete` (best-effort) |\r\n| \"Timeout/error handling\" | `session.idle` + `session.error` ✅ |\r\n\r\n## Counting LLM Calls\r\n\r\nThe number of `assistant.turn_start` / `assistant.turn_end` pairs in the event log equals the total number of LLM API calls made. There are no hidden calls for planning, evaluation, or completion checking.\r\n\r\nTo inspect turn count for a session:\r\n\r\n```bash\r\n# Count turns in a session's event log\r\ngrep -c \"assistant.turn_start\" ~/.copilot/session-state//events.jsonl\r\n```\r\n\r\n## Further Reading\r\n\r\n- [Streaming Events Reference](./streaming-events.md) — Full field-level reference for every event type\r\n- [Session Persistence](./session-persistence.md) — How sessions are saved and resumed\r\n- [Hooks](./hooks.md) — Intercepting events in the loop (permissions, tools)\r\n" }, { "path": "docs/features/custom-agents.md", "content": "# Custom Agents & Sub-Agent Orchestration\n\nDefine specialized agents with scoped tools and prompts, then let Copilot orchestrate them as sub-agents within a single session.\n\n## Overview\n\nCustom agents are lightweight agent definitions you attach to a session. Each agent has its own system prompt, tool restrictions, and optional MCP servers. When a user's request matches an agent's expertise, the Copilot runtime automatically delegates to that agent as a **sub-agent** — running it in an isolated context while streaming lifecycle events back to the parent session.\n\n```mermaid\nflowchart TD\n U[User prompt] --> P[Parent agent]\n P -->|delegates| S1[🔍 researcher sub-agent]\n P -->|delegates| S2[✏️ editor sub-agent]\n S1 -->|subagent.completed| P\n S2 -->|subagent.completed| P\n P --> R[Final response]\n```\n\n| Concept | Description |\n|---------|-------------|\n| **Custom agent** | A named agent config with its own prompt and tool set |\n| **Sub-agent** | A custom agent invoked by the runtime to handle part of a task |\n| **Inference** | The runtime's ability to auto-select an agent based on the user's intent |\n| **Parent session** | The session that spawned the sub-agent; receives all lifecycle events |\n\n## Defining Custom Agents\n\nPass `customAgents` when creating a session. Each agent needs at minimum a `name` and `prompt`.\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\nawait client.start();\n\nconst session = await client.createSession({\n model: \"gpt-4.1\",\n customAgents: [\n {\n name: \"researcher\",\n displayName: \"Research Agent\",\n description: \"Explores codebases and answers questions using read-only tools\",\n tools: [\"grep\", \"glob\", \"view\"],\n prompt: \"You are a research assistant. Analyze code and answer questions. Do not modify any files.\",\n },\n {\n name: \"editor\",\n displayName: \"Editor Agent\",\n description: \"Makes targeted code changes\",\n tools: [\"view\", \"edit\", \"bash\"],\n prompt: \"You are a code editor. Make minimal, surgical changes to files as requested.\",\n },\n ],\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionRequestResult\n\nclient = CopilotClient()\nawait client.start()\n\nsession = await client.create_session(\n on_permission_request=lambda req, inv: PermissionRequestResult(kind=\"approved\"),\n model=\"gpt-4.1\",\n custom_agents=[\n {\n \"name\": \"researcher\",\n \"display_name\": \"Research Agent\",\n \"description\": \"Explores codebases and answers questions using read-only tools\",\n \"tools\": [\"grep\", \"glob\", \"view\"],\n \"prompt\": \"You are a research assistant. Analyze code and answer questions. Do not modify any files.\",\n },\n {\n \"name\": \"editor\",\n \"display_name\": \"Editor Agent\",\n \"description\": \"Makes targeted code changes\",\n \"tools\": [\"view\", \"edit\", \"bash\"],\n \"prompt\": \"You are a code editor. Make minimal, surgical changes to files as requested.\",\n },\n ],\n)\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclient := copilot.NewClient(nil)\n\tclient.Start(ctx)\n\n\tsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"gpt-4.1\",\n\t\tCustomAgents: []copilot.CustomAgentConfig{\n\t\t\t{\n\t\t\t\tName: \"researcher\",\n\t\t\t\tDisplayName: \"Research Agent\",\n\t\t\t\tDescription: \"Explores codebases and answers questions using read-only tools\",\n\t\t\t\tTools: []string{\"grep\", \"glob\", \"view\"},\n\t\t\t\tPrompt: \"You are a research assistant. Analyze code and answer questions. Do not modify any files.\",\n\t\t\t},\n\t\t\t{\n\t\t\t\tName: \"editor\",\n\t\t\t\tDisplayName: \"Editor Agent\",\n\t\t\t\tDescription: \"Makes targeted code changes\",\n\t\t\t\tTools: []string{\"view\", \"edit\", \"bash\"},\n\t\t\t\tPrompt: \"You are a code editor. Make minimal, surgical changes to files as requested.\",\n\t\t\t},\n\t\t},\n\t\tOnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n\t\t},\n\t})\n\t_ = session\n}\n```\n\n\n```go\nctx := context.Background()\nclient := copilot.NewClient(nil)\nclient.Start(ctx)\n\nsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n Model: \"gpt-4.1\",\n CustomAgents: []copilot.CustomAgentConfig{\n {\n Name: \"researcher\",\n DisplayName: \"Research Agent\",\n Description: \"Explores codebases and answers questions using read-only tools\",\n Tools: []string{\"grep\", \"glob\", \"view\"},\n Prompt: \"You are a research assistant. Analyze code and answer questions. Do not modify any files.\",\n },\n {\n Name: \"editor\",\n DisplayName: \"Editor Agent\",\n Description: \"Makes targeted code changes\",\n Tools: []string{\"view\", \"edit\", \"bash\"},\n Prompt: \"You are a code editor. Make minimal, surgical changes to files as requested.\",\n },\n },\n OnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n return copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n },\n})\n```\n\n
\n\n
\n.NET\n\n```csharp\nusing GitHub.Copilot.SDK;\n\nawait using var client = new CopilotClient();\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-4.1\",\n CustomAgents = new List\n {\n new()\n {\n Name = \"researcher\",\n DisplayName = \"Research Agent\",\n Description = \"Explores codebases and answers questions using read-only tools\",\n Tools = new List { \"grep\", \"glob\", \"view\" },\n Prompt = \"You are a research assistant. Analyze code and answer questions. Do not modify any files.\",\n },\n new()\n {\n Name = \"editor\",\n DisplayName = \"Editor Agent\",\n Description = \"Makes targeted code changes\",\n Tools = new List { \"view\", \"edit\", \"bash\" },\n Prompt = \"You are a code editor. Make minimal, surgical changes to files as requested.\",\n },\n },\n OnPermissionRequest = (req, inv) =>\n Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved }),\n});\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\nimport java.util.List;\n\ntry (var client = new CopilotClient()) {\n client.start().get();\n\n var session = client.createSession(\n new SessionConfig()\n .setModel(\"gpt-4.1\")\n .setCustomAgents(List.of(\n new CustomAgentConfig()\n .setName(\"researcher\")\n .setDisplayName(\"Research Agent\")\n .setDescription(\"Explores codebases and answers questions using read-only tools\")\n .setTools(List.of(\"grep\", \"glob\", \"view\"))\n .setPrompt(\"You are a research assistant. Analyze code and answer questions. Do not modify any files.\"),\n new CustomAgentConfig()\n .setName(\"editor\")\n .setDisplayName(\"Editor Agent\")\n .setDescription(\"Makes targeted code changes\")\n .setTools(List.of(\"view\", \"edit\", \"bash\"))\n .setPrompt(\"You are a code editor. Make minimal, surgical changes to files as requested.\")\n ))\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n ).get();\n}\n```\n\n
\n\n## Configuration Reference\n\n| Property | Type | Required | Description |\n|----------|------|----------|-------------|\n| `name` | `string` | ✅ | Unique identifier for the agent |\n| `displayName` | `string` | | Human-readable name shown in events |\n| `description` | `string` | | What the agent does — helps the runtime select it |\n| `tools` | `string[]` or `null` | | Tool names the agent can use. `null` or omitted = all tools |\n| `prompt` | `string` | ✅ | System prompt for the agent |\n| `mcpServers` | `object` | | MCP server configurations specific to this agent |\n| `infer` | `boolean` | | Whether the runtime can auto-select this agent (default: `true`) |\n| `skills` | `string[]` | | Skill names to preload into the agent's context at startup |\n\n> **Tip:** A good `description` helps the runtime match user intent to the right agent. Be specific about the agent's expertise and capabilities.\n\nIn addition to per-agent configuration above, you can set `agent` on the **session config** itself to pre-select which custom agent is active when the session starts. See [Selecting an Agent at Session Creation](#selecting-an-agent-at-session-creation) below.\n\n| Session Config Property | Type | Description |\n|-------------------------|------|-------------|\n| `agent` | `string` | Name of the custom agent to pre-select at session creation. Must match a `name` in `customAgents`. |\n\n## Per-Agent Skills\n\nYou can preload skills into an agent's context using the `skills` property. When specified, the **full content** of each listed skill is eagerly injected into the agent's context at startup — the agent doesn't need to invoke a skill tool; the instructions are already present. Skills are **opt-in**: agents receive no skills by default, and sub-agents do not inherit skills from the parent. Skill names are resolved from the session-level `skillDirectories`.\n\n```typescript\nconst session = await client.createSession({\n skillDirectories: [\"./skills\"],\n customAgents: [\n {\n name: \"security-auditor\",\n description: \"Security-focused code reviewer\",\n prompt: \"Focus on OWASP Top 10 vulnerabilities\",\n skills: [\"security-scan\", \"dependency-check\"],\n },\n {\n name: \"docs-writer\",\n description: \"Technical documentation writer\",\n prompt: \"Write clear, concise documentation\",\n skills: [\"markdown-lint\"],\n },\n ],\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n```\n\nIn this example, `security-auditor` starts with `security-scan` and `dependency-check` already injected into its context, while `docs-writer` starts with `markdown-lint`. An agent without a `skills` field receives no skill content.\n\n## Selecting an Agent at Session Creation\n\nYou can pass `agent` in the session config to pre-select which custom agent should be active when the session starts. The value must match the `name` of one of the agents defined in `customAgents`.\n\nThis is equivalent to calling `session.rpc.agent.select()` after creation, but avoids the extra API call and ensures the agent is active from the very first prompt.\n\n
\nNode.js / TypeScript\n\n\n```typescript\nconst session = await client.createSession({\n customAgents: [\n {\n name: \"researcher\",\n prompt: \"You are a research assistant. Analyze code and answer questions.\",\n },\n {\n name: \"editor\",\n prompt: \"You are a code editor. Make minimal, surgical changes.\",\n },\n ],\n agent: \"researcher\", // Pre-select the researcher agent\n});\n```\n\n
\n\n
\nPython\n\n\n```python\nsession = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n custom_agents=[\n {\n \"name\": \"researcher\",\n \"prompt\": \"You are a research assistant. Analyze code and answer questions.\",\n },\n {\n \"name\": \"editor\",\n \"prompt\": \"You are a code editor. Make minimal, surgical changes.\",\n },\n ],\n agent=\"researcher\", # Pre-select the researcher agent\n)\n```\n\n
\n\n
\nGo\n\n\n```go\nsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n CustomAgents: []copilot.CustomAgentConfig{\n {\n Name: \"researcher\",\n Prompt: \"You are a research assistant. Analyze code and answer questions.\",\n },\n {\n Name: \"editor\",\n Prompt: \"You are a code editor. Make minimal, surgical changes.\",\n },\n },\n Agent: \"researcher\", // Pre-select the researcher agent\n})\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n CustomAgents = new List\n {\n new() { Name = \"researcher\", Prompt = \"You are a research assistant. Analyze code and answer questions.\" },\n new() { Name = \"editor\", Prompt = \"You are a code editor. Make minimal, surgical changes.\" },\n },\n Agent = \"researcher\", // Pre-select the researcher agent\n});\n```\n\n
\n\n
\nJava\n\n\n```java\nimport com.github.copilot.sdk.json.*;\nimport java.util.List;\n\nvar session = client.createSession(\n new SessionConfig()\n .setCustomAgents(List.of(\n new CustomAgentConfig()\n .setName(\"researcher\")\n .setPrompt(\"You are a research assistant. Analyze code and answer questions.\"),\n new CustomAgentConfig()\n .setName(\"editor\")\n .setPrompt(\"You are a code editor. Make minimal, surgical changes.\")\n ))\n .setAgent(\"researcher\") // Pre-select the researcher agent\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n).get();\n```\n\n
\n\n## How Sub-Agent Delegation Works\n\nWhen you send a prompt to a session with custom agents, the runtime evaluates whether to delegate to a sub-agent:\n\n1. **Intent matching** — The runtime analyzes the user's prompt against each agent's `name` and `description`\n2. **Agent selection** — If a match is found and `infer` is not `false`, the runtime selects the agent\n3. **Isolated execution** — The sub-agent runs with its own prompt and restricted tool set\n4. **Event streaming** — Lifecycle events (`subagent.started`, `subagent.completed`, etc.) stream back to the parent session\n5. **Result integration** — The sub-agent's output is incorporated into the parent agent's response\n\n### Controlling Inference\n\nBy default, all custom agents are available for automatic selection (`infer: true`). Set `infer: false` to prevent the runtime from auto-selecting an agent — useful for agents you only want invoked through explicit user requests:\n\n```typescript\n{\n name: \"dangerous-cleanup\",\n description: \"Deletes unused files and dead code\",\n tools: [\"bash\", \"edit\", \"view\"],\n prompt: \"You clean up codebases by removing dead code and unused files.\",\n infer: false, // Only invoked when user explicitly asks for this agent\n}\n```\n\n## Listening to Sub-Agent Events\n\nWhen a sub-agent runs, the parent session emits lifecycle events. Subscribe to these events to build UIs that visualize agent activity.\n\n### Event Types\n\n| Event | Emitted when | Data |\n|-------|-------------|------|\n| `subagent.selected` | Runtime selects an agent for the task | `agentName`, `agentDisplayName`, `tools` |\n| `subagent.started` | Sub-agent begins execution | `toolCallId`, `agentName`, `agentDisplayName`, `agentDescription` |\n| `subagent.completed` | Sub-agent finishes successfully | `toolCallId`, `agentName`, `agentDisplayName` |\n| `subagent.failed` | Sub-agent encounters an error | `toolCallId`, `agentName`, `agentDisplayName`, `error` |\n| `subagent.deselected` | Runtime switches away from the sub-agent | — |\n\n### Subscribing to Events\n\n
\nNode.js / TypeScript\n\n```typescript\nsession.on((event) => {\n switch (event.type) {\n case \"subagent.started\":\n console.log(`▶ Sub-agent started: ${event.data.agentDisplayName}`);\n console.log(` Description: ${event.data.agentDescription}`);\n console.log(` Tool call ID: ${event.data.toolCallId}`);\n break;\n\n case \"subagent.completed\":\n console.log(`✅ Sub-agent completed: ${event.data.agentDisplayName}`);\n break;\n\n case \"subagent.failed\":\n console.log(`❌ Sub-agent failed: ${event.data.agentDisplayName}`);\n console.log(` Error: ${event.data.error}`);\n break;\n\n case \"subagent.selected\":\n console.log(`🎯 Agent selected: ${event.data.agentDisplayName}`);\n console.log(` Tools: ${event.data.tools?.join(\", \") ?? \"all\"}`);\n break;\n\n case \"subagent.deselected\":\n console.log(\"↩ Agent deselected, returning to parent\");\n break;\n }\n});\n\nconst response = await session.sendAndWait({\n prompt: \"Research how authentication works in this codebase\",\n});\n```\n\n
\n\n
\nPython\n\n```python\ndef handle_event(event):\n if event.type == \"subagent.started\":\n print(f\"▶ Sub-agent started: {event.data.agent_display_name}\")\n print(f\" Description: {event.data.agent_description}\")\n elif event.type == \"subagent.completed\":\n print(f\"✅ Sub-agent completed: {event.data.agent_display_name}\")\n elif event.type == \"subagent.failed\":\n print(f\"❌ Sub-agent failed: {event.data.agent_display_name}\")\n print(f\" Error: {event.data.error}\")\n elif event.type == \"subagent.selected\":\n tools = event.data.tools or \"all\"\n print(f\"🎯 Agent selected: {event.data.agent_display_name} (tools: {tools})\")\n\nunsubscribe = session.on(handle_event)\n\nresponse = await session.send_and_wait(\"Research how authentication works in this codebase\")\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclient := copilot.NewClient(nil)\n\tclient.Start(ctx)\n\n\tsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"gpt-4.1\",\n\t\tOnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n\t\t},\n\t})\n\n\tsession.On(func(event copilot.SessionEvent) {\n\t\tswitch d := event.Data.(type) {\n\t\tcase *copilot.SubagentStartedData:\n\t\t\tfmt.Printf(\"▶ Sub-agent started: %s\\n\", d.AgentDisplayName)\n\t\t\tfmt.Printf(\" Description: %s\\n\", d.AgentDescription)\n\t\t\tfmt.Printf(\" Tool call ID: %s\\n\", d.ToolCallID)\n\t\tcase *copilot.SubagentCompletedData:\n\t\t\tfmt.Printf(\"✅ Sub-agent completed: %s\\n\", d.AgentDisplayName)\n\t\tcase *copilot.SubagentFailedData:\n\t\t\tfmt.Printf(\"❌ Sub-agent failed: %s — %v\\n\", d.AgentDisplayName, d.Error)\n\t\tcase *copilot.SubagentSelectedData:\n\t\t\tfmt.Printf(\"🎯 Agent selected: %s\\n\", d.AgentDisplayName)\n\t\t}\n\t})\n\n\t_, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"Research how authentication works in this codebase\",\n\t})\n\t_ = err\n}\n```\n\n\n```go\nsession.On(func(event copilot.SessionEvent) {\n switch d := event.Data.(type) {\n case *copilot.SubagentStartedData:\n fmt.Printf(\"▶ Sub-agent started: %s\\n\", d.AgentDisplayName)\n fmt.Printf(\" Description: %s\\n\", d.AgentDescription)\n fmt.Printf(\" Tool call ID: %s\\n\", d.ToolCallID)\n case *copilot.SubagentCompletedData:\n fmt.Printf(\"✅ Sub-agent completed: %s\\n\", d.AgentDisplayName)\n case *copilot.SubagentFailedData:\n fmt.Printf(\"❌ Sub-agent failed: %s — %v\\n\", d.AgentDisplayName, d.Error)\n case *copilot.SubagentSelectedData:\n fmt.Printf(\"🎯 Agent selected: %s\\n\", d.AgentDisplayName)\n }\n})\n\n_, err := session.SendAndWait(ctx, copilot.MessageOptions{\n Prompt: \"Research how authentication works in this codebase\",\n})\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic static class SubAgentEventsExample\n{\n public static async Task Example(CopilotSession session)\n {\n using var subscription = session.On(evt =>\n {\n switch (evt)\n {\n case SubagentStartedEvent started:\n Console.WriteLine($\"▶ Sub-agent started: {started.Data.AgentDisplayName}\");\n Console.WriteLine($\" Description: {started.Data.AgentDescription}\");\n Console.WriteLine($\" Tool call ID: {started.Data.ToolCallId}\");\n break;\n case SubagentCompletedEvent completed:\n Console.WriteLine($\"✅ Sub-agent completed: {completed.Data.AgentDisplayName}\");\n break;\n case SubagentFailedEvent failed:\n Console.WriteLine($\"❌ Sub-agent failed: {failed.Data.AgentDisplayName} — {failed.Data.Error}\");\n break;\n case SubagentSelectedEvent selected:\n Console.WriteLine($\"🎯 Agent selected: {selected.Data.AgentDisplayName}\");\n break;\n }\n });\n\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Research how authentication works in this codebase\"\n });\n }\n}\n```\n\n\n```csharp\nusing var subscription = session.On(evt =>\n{\n switch (evt)\n {\n case SubagentStartedEvent started:\n Console.WriteLine($\"▶ Sub-agent started: {started.Data.AgentDisplayName}\");\n Console.WriteLine($\" Description: {started.Data.AgentDescription}\");\n Console.WriteLine($\" Tool call ID: {started.Data.ToolCallId}\");\n break;\n case SubagentCompletedEvent completed:\n Console.WriteLine($\"✅ Sub-agent completed: {completed.Data.AgentDisplayName}\");\n break;\n case SubagentFailedEvent failed:\n Console.WriteLine($\"❌ Sub-agent failed: {failed.Data.AgentDisplayName} — {failed.Data.Error}\");\n break;\n case SubagentSelectedEvent selected:\n Console.WriteLine($\"🎯 Agent selected: {selected.Data.AgentDisplayName}\");\n break;\n }\n});\n\nawait session.SendAndWaitAsync(new MessageOptions\n{\n Prompt = \"Research how authentication works in this codebase\"\n});\n```\n\n
\n\n
\nJava\n\n```java\nsession.on(event -> {\n if (event instanceof SubagentStartedEvent e) {\n System.out.println(\"▶ Sub-agent started: \" + e.getData().agentDisplayName());\n System.out.println(\" Description: \" + e.getData().agentDescription());\n System.out.println(\" Tool call ID: \" + e.getData().toolCallId());\n } else if (event instanceof SubagentCompletedEvent e) {\n System.out.println(\"✅ Sub-agent completed: \" + e.getData().agentName());\n } else if (event instanceof SubagentFailedEvent e) {\n System.out.println(\"❌ Sub-agent failed: \" + e.getData().agentName());\n System.out.println(\" Error: \" + e.getData().error());\n } else if (event instanceof SubagentSelectedEvent e) {\n System.out.println(\"🎯 Agent selected: \" + e.getData().agentDisplayName());\n } else if (event instanceof SubagentDeselectedEvent e) {\n System.out.println(\"↩ Agent deselected, returning to parent\");\n }\n});\n\nvar response = session.sendAndWait(\n new MessageOptions().setPrompt(\"Research how authentication works in this codebase\")\n).get();\n```\n\n
\n\n## Building an Agent Tree UI\n\nSub-agent events include `toolCallId` fields that let you reconstruct the execution tree. Here's a pattern for tracking agent activity:\n\n```typescript\ninterface AgentNode {\n toolCallId: string;\n name: string;\n displayName: string;\n status: \"running\" | \"completed\" | \"failed\";\n error?: string;\n startedAt: Date;\n completedAt?: Date;\n}\n\nconst agentTree = new Map();\n\nsession.on((event) => {\n if (event.type === \"subagent.started\") {\n agentTree.set(event.data.toolCallId, {\n toolCallId: event.data.toolCallId,\n name: event.data.agentName,\n displayName: event.data.agentDisplayName,\n status: \"running\",\n startedAt: new Date(event.timestamp),\n });\n }\n\n if (event.type === \"subagent.completed\") {\n const node = agentTree.get(event.data.toolCallId);\n if (node) {\n node.status = \"completed\";\n node.completedAt = new Date(event.timestamp);\n }\n }\n\n if (event.type === \"subagent.failed\") {\n const node = agentTree.get(event.data.toolCallId);\n if (node) {\n node.status = \"failed\";\n node.error = event.data.error;\n node.completedAt = new Date(event.timestamp);\n }\n }\n\n // Render your UI with the updated tree\n renderAgentTree(agentTree);\n});\n```\n\n## Scoping Tools per Agent\n\nUse the `tools` property to restrict which tools an agent can access. This is essential for security and for keeping agents focused:\n\n```typescript\nconst session = await client.createSession({\n customAgents: [\n {\n name: \"reader\",\n description: \"Read-only exploration of the codebase\",\n tools: [\"grep\", \"glob\", \"view\"], // No write access\n prompt: \"You explore and analyze code. Never suggest modifications directly.\",\n },\n {\n name: \"writer\",\n description: \"Makes code changes\",\n tools: [\"view\", \"edit\", \"bash\"], // Write access\n prompt: \"You make precise code changes as instructed.\",\n },\n {\n name: \"unrestricted\",\n description: \"Full access agent for complex tasks\",\n tools: null, // All tools available\n prompt: \"You handle complex multi-step tasks using any available tools.\",\n },\n ],\n});\n```\n\n> **Note:** When `tools` is `null` or omitted, the agent inherits access to all tools configured on the session. Use explicit tool lists to enforce the principle of least privilege.\n\n## Agent-Exclusive Tools\n\nUse the `defaultAgent` property on the session configuration to hide specific tools from the default agent (the built-in agent that handles turns when no custom agent is selected). This forces the main agent to delegate to sub-agents when those tools' capabilities are needed, keeping the main agent's context clean.\n\nThis is useful when:\n- Certain tools generate large amounts of context that would overwhelm the main agent\n- You want the main agent to act as an orchestrator, delegating heavy work to specialized sub-agents\n- You need strict separation between orchestration and execution\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient, defineTool, approveAll } from \"@github/copilot-sdk\";\nimport { z } from \"zod\";\n\nconst heavyContextTool = defineTool(\"analyze-codebase\", {\n description: \"Performs deep analysis of the codebase, generating extensive context\",\n parameters: z.object({ query: z.string() }),\n handler: async ({ query }) => {\n // ... expensive analysis that returns lots of data\n return { analysis: \"...\" };\n },\n});\n\nconst session = await client.createSession({\n tools: [heavyContextTool],\n defaultAgent: {\n excludedTools: [\"analyze-codebase\"],\n },\n customAgents: [\n {\n name: \"researcher\",\n description: \"Deep codebase analysis agent with access to heavy-context tools\",\n tools: [\"analyze-codebase\"],\n prompt: \"You perform thorough codebase analysis using the analyze-codebase tool.\",\n },\n ],\n});\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.tools import Tool\n\nheavy_tool = Tool(\n name=\"analyze-codebase\",\n description=\"Performs deep analysis of the codebase\",\n handler=analyze_handler,\n parameters={\"type\": \"object\", \"properties\": {\"query\": {\"type\": \"string\"}}},\n)\n\nsession = await client.create_session(\n tools=[heavy_tool],\n default_agent={\"excluded_tools\": [\"analyze-codebase\"]},\n custom_agents=[\n {\n \"name\": \"researcher\",\n \"description\": \"Deep codebase analysis agent\",\n \"tools\": [\"analyze-codebase\"],\n \"prompt\": \"You perform thorough codebase analysis.\",\n },\n ],\n on_permission_request=approve_all,\n)\n```\n\n
\n\n
\nGo\n\n\n```go\nsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n Tools: []copilot.Tool{heavyTool},\n DefaultAgent: &copilot.DefaultAgentConfig{\n ExcludedTools: []string{\"analyze-codebase\"},\n },\n CustomAgents: []copilot.CustomAgentConfig{\n {\n Name: \"researcher\",\n Description: \"Deep codebase analysis agent\",\n Tools: []string{\"analyze-codebase\"},\n Prompt: \"You perform thorough codebase analysis.\",\n },\n },\n})\n```\n\n
\n\n
\nC# / .NET\n\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Tools = [analyzeCodebaseTool],\n DefaultAgent = new DefaultAgentConfig\n {\n ExcludedTools = [\"analyze-codebase\"],\n },\n CustomAgents =\n [\n new CustomAgentConfig\n {\n Name = \"researcher\",\n Description = \"Deep codebase analysis agent\",\n Tools = [\"analyze-codebase\"],\n Prompt = \"You perform thorough codebase analysis.\",\n },\n ],\n});\n```\n\n
\n\n### How It Works\n\nTools listed in `defaultAgent.excludedTools`:\n\n1. **Are registered** — their handlers are available for execution\n2. **Are hidden** from the main agent's tool list — the LLM won't see or call them directly\n3. **Remain available** to any custom sub-agent that includes them in its `tools` array\n\n### Interaction with Other Tool Filters\n\n`defaultAgent.excludedTools` is orthogonal to the session-level `availableTools` and `excludedTools`:\n\n| Filter | Scope | Effect |\n|--------|-------|--------|\n| `availableTools` | Session-wide | Allowlist — only these tools exist for anyone |\n| `excludedTools` | Session-wide | Blocklist — these tools are blocked for everyone |\n| `defaultAgent.excludedTools` | Main agent only | These tools are hidden from the main agent but available to sub-agents |\n\nPrecedence:\n1. Session-level `availableTools`/`excludedTools` are applied first (globally)\n2. `defaultAgent.excludedTools` is applied on top, further restricting the main agent only\n\n> **Note:** If a tool is in both `excludedTools` (session-level) and `defaultAgent.excludedTools`, the session-level exclusion takes precedence — the tool is unavailable to everyone.\n\n## Attaching MCP Servers to Agents\n\nEach custom agent can have its own MCP (Model Context Protocol) servers, giving it access to specialized data sources:\n\n```typescript\nconst session = await client.createSession({\n customAgents: [\n {\n name: \"db-analyst\",\n description: \"Analyzes database schemas and queries\",\n prompt: \"You are a database expert. Use the database MCP server to analyze schemas.\",\n mcpServers: {\n \"database\": {\n command: \"npx\",\n args: [\"-y\", \"@modelcontextprotocol/server-postgres\", \"postgresql://localhost/mydb\"],\n },\n },\n },\n ],\n});\n```\n\n## Patterns & Best Practices\n\n### Pair a researcher with an editor\n\nA common pattern is to define a read-only researcher agent and a write-capable editor agent. The runtime delegates exploration tasks to the researcher and modification tasks to the editor:\n\n```typescript\ncustomAgents: [\n {\n name: \"researcher\",\n description: \"Analyzes code structure, finds patterns, and answers questions\",\n tools: [\"grep\", \"glob\", \"view\"],\n prompt: \"You are a code analyst. Thoroughly explore the codebase to answer questions.\",\n },\n {\n name: \"implementer\",\n description: \"Implements code changes based on analysis\",\n tools: [\"view\", \"edit\", \"bash\"],\n prompt: \"You make minimal, targeted code changes. Always verify changes compile.\",\n },\n]\n```\n\n### Keep agent descriptions specific\n\nThe runtime uses the `description` to match user intent. Vague descriptions lead to poor delegation:\n\n```typescript\n// ❌ Too vague — runtime can't distinguish from other agents\n{ description: \"Helps with code\" }\n\n// ✅ Specific — runtime knows when to delegate\n{ description: \"Analyzes Python test coverage and identifies untested code paths\" }\n```\n\n### Handle failures gracefully\n\nSub-agents can fail. Always listen for `subagent.failed` events and handle them in your application:\n\n```typescript\nsession.on((event) => {\n if (event.type === \"subagent.failed\") {\n logger.error(`Agent ${event.data.agentName} failed: ${event.data.error}`);\n // Show error in UI, retry, or fall back to parent agent\n }\n});\n```\n" }, { "path": "docs/features/hooks.md", "content": "# Working with Hooks\n\nHooks let you plug custom logic into every stage of a Copilot session — from the moment it starts, through each user prompt and tool call, to the moment it ends. This guide walks through practical use cases so you can ship permissions, auditing, notifications, and more without modifying the core agent behavior.\n\n## Overview\n\nA hook is a callback you register once when creating a session. The SDK invokes it at a well-defined point in the conversation lifecycle, passes contextual input, and optionally accepts output that modifies the session's behavior.\n\n```mermaid\nflowchart LR\n A[Session starts] -->|onSessionStart| B[User sends prompt]\n B -->|onUserPromptSubmitted| C[Agent picks a tool]\n C -->|onPreToolUse| D[Tool executes]\n D -->|onPostToolUse| E{More work?}\n E -->|yes| C\n E -->|no| F[Session ends]\n F -->|onSessionEnd| G((Done))\n C -.->|error| H[onErrorOccurred]\n D -.->|error| H\n```\n\n| Hook | When it fires | What you can do |\n|------|---------------|-----------------|\n| [`onSessionStart`](../hooks/session-lifecycle.md#session-start) | Session begins (new or resumed) | Inject context, load preferences |\n| [`onUserPromptSubmitted`](../hooks/user-prompt-submitted.md) | User sends a message | Rewrite prompts, add context, filter input |\n| [`onPreToolUse`](../hooks/pre-tool-use.md) | Before a tool executes | Allow / deny / modify the call |\n| [`onPostToolUse`](../hooks/post-tool-use.md) | After a tool returns | Transform results, redact secrets, audit |\n| [`onSessionEnd`](../hooks/session-lifecycle.md#session-end) | Session ends | Clean up, record metrics |\n| [`onErrorOccurred`](../hooks/error-handling.md) | An error is raised | Custom logging, retry logic, alerts |\n\nAll hooks are **optional** — register only the ones you need. Returning `null` (or the language equivalent) from any hook tells the SDK to continue with default behavior.\n\n## Registering Hooks\n\nPass a `hooks` object when you create (or resume) a session. Every example below follows this pattern.\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\nawait client.start();\n\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async (input, invocation) => { /* ... */ },\n onPreToolUse: async (input, invocation) => { /* ... */ },\n onPostToolUse: async (input, invocation) => { /* ... */ },\n // ... add only the hooks you need\n },\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot import CopilotClient\n\nclient = CopilotClient()\nawait client.start()\n\nsession = await client.create_session(\n on_permission_request=lambda req, inv: {\"kind\": \"approved\"},\n hooks={\n \"on_session_start\": on_session_start,\n \"on_pre_tool_use\": on_pre_tool_use,\n \"on_post_tool_use\": on_post_tool_use,\n # ... add only the hooks you need\n },\n)\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc onSessionStart(input copilot.SessionStartHookInput, inv copilot.HookInvocation) (*copilot.SessionStartHookOutput, error) {\n\treturn nil, nil\n}\n\nfunc onPreToolUse(input copilot.PreToolUseHookInput, inv copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {\n\treturn nil, nil\n}\n\nfunc onPostToolUse(input copilot.PostToolUseHookInput, inv copilot.HookInvocation) (*copilot.PostToolUseHookOutput, error) {\n\treturn nil, nil\n}\n\nfunc main() {\n\tctx := context.Background()\n\tclient := copilot.NewClient(nil)\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tHooks: &copilot.SessionHooks{\n\t\t\tOnSessionStart: onSessionStart,\n\t\t\tOnPreToolUse: onPreToolUse,\n\t\t\tOnPostToolUse: onPostToolUse,\n\t\t},\n\t\tOnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\treturn copilot.PermissionRequestResult{Kind: \"approved\"}, nil\n\t\t},\n\t})\n\t_ = session\n\t_ = err\n}\n```\n\n\n```go\nclient := copilot.NewClient(nil)\n\nsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n Hooks: &copilot.SessionHooks{\n OnSessionStart: onSessionStart,\n OnPreToolUse: onPreToolUse,\n OnPostToolUse: onPostToolUse,\n // ... add only the hooks you need\n },\n OnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n return copilot.PermissionRequestResult{Kind: \"approved\"}, nil\n },\n})\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic static class HooksExample\n{\n static Task onSessionStart(SessionStartHookInput input, HookInvocation invocation) =>\n Task.FromResult(null);\n static Task onPreToolUse(PreToolUseHookInput input, HookInvocation invocation) =>\n Task.FromResult(null);\n static Task onPostToolUse(PostToolUseHookInput input, HookInvocation invocation) =>\n Task.FromResult(null);\n\n public static async Task Main()\n {\n var client = new CopilotClient();\n\n var session = await client.CreateSessionAsync(new SessionConfig\n {\n Hooks = new SessionHooks\n {\n OnSessionStart = onSessionStart,\n OnPreToolUse = onPreToolUse,\n OnPostToolUse = onPostToolUse,\n },\n OnPermissionRequest = (req, inv) =>\n Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved }),\n });\n }\n}\n```\n\n\n```csharp\nvar client = new CopilotClient();\n\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Hooks = new SessionHooks\n {\n OnSessionStart = onSessionStart,\n OnPreToolUse = onPreToolUse,\n OnPostToolUse = onPostToolUse,\n // ... add only the hooks you need\n },\n OnPermissionRequest = (req, inv) =>\n Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved }),\n});\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\nimport java.util.concurrent.CompletableFuture;\n\ntry (var client = new CopilotClient()) {\n client.start().get();\n\n var hooks = new SessionHooks()\n .setOnSessionStart((input, inv) -> CompletableFuture.completedFuture(null))\n .setOnPreToolUse((input, inv) -> CompletableFuture.completedFuture(null))\n .setOnPostToolUse((input, inv) -> CompletableFuture.completedFuture(null));\n // ... add only the hooks you need\n\n var session = client.createSession(\n new SessionConfig()\n .setHooks(hooks)\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n ).get();\n}\n```\n\n
\n\n> **Tip:** Every hook handler receives an `invocation` parameter containing the `sessionId`, which is useful for correlating logs and maintaining per-session state.\n\n---\n\n## Use Case: Permission Control\n\nUse `onPreToolUse` to build a permission layer that decides which tools the agent may run, what arguments are allowed, and whether the user should be prompted before execution.\n\n### Allow-list a safe set of tools\n\n
\nNode.js / TypeScript\n\n```typescript\nconst READ_ONLY_TOOLS = [\"read_file\", \"glob\", \"grep\", \"view\"];\n\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n if (!READ_ONLY_TOOLS.includes(input.toolName)) {\n return {\n permissionDecision: \"deny\",\n permissionDecisionReason:\n `Only read-only tools are allowed. \"${input.toolName}\" was blocked.`,\n };\n }\n return { permissionDecision: \"allow\" };\n },\n },\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n```\n\n
\n\n
\nPython\n\n```python\nREAD_ONLY_TOOLS = [\"read_file\", \"glob\", \"grep\", \"view\"]\n\nasync def on_pre_tool_use(input_data, invocation):\n if input_data[\"toolName\"] not in READ_ONLY_TOOLS:\n return {\n \"permissionDecision\": \"deny\",\n \"permissionDecisionReason\":\n f'Only read-only tools are allowed. \"{input_data[\"toolName\"]}\" was blocked.',\n }\n return {\"permissionDecision\": \"allow\"}\n\nsession = await client.create_session(\n on_permission_request=lambda req, inv: {\"kind\": \"approved\"},\n hooks={\"on_pre_tool_use\": on_pre_tool_use},\n)\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclient := copilot.NewClient(nil)\n\n\treadOnlyTools := map[string]bool{\"read_file\": true, \"glob\": true, \"grep\": true, \"view\": true}\n\n\tsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tHooks: &copilot.SessionHooks{\n\t\t\tOnPreToolUse: func(input copilot.PreToolUseHookInput, inv copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {\n\t\t\t\tif !readOnlyTools[input.ToolName] {\n\t\t\t\t\treturn &copilot.PreToolUseHookOutput{\n\t\t\t\t\t\tPermissionDecision: \"deny\",\n\t\t\t\t\t\tPermissionDecisionReason: fmt.Sprintf(\"Only read-only tools are allowed. %q was blocked.\", input.ToolName),\n\t\t\t\t\t}, nil\n\t\t\t\t}\n\t\t\t\treturn &copilot.PreToolUseHookOutput{PermissionDecision: \"allow\"}, nil\n\t\t\t},\n\t\t},\n\t\tOnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n\t\t},\n\t})\n\t_ = session\n}\n```\n\n\n```go\nreadOnlyTools := map[string]bool{\"read_file\": true, \"glob\": true, \"grep\": true, \"view\": true}\n\nsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n Hooks: &copilot.SessionHooks{\n OnPreToolUse: func(input copilot.PreToolUseHookInput, inv copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {\n if !readOnlyTools[input.ToolName] {\n return &copilot.PreToolUseHookOutput{\n PermissionDecision: \"deny\",\n PermissionDecisionReason: fmt.Sprintf(\"Only read-only tools are allowed. %q was blocked.\", input.ToolName),\n }, nil\n }\n return &copilot.PreToolUseHookOutput{PermissionDecision: \"allow\"}, nil\n },\n },\n})\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic static class PermissionControlExample\n{\n public static async Task Main()\n {\n await using var client = new CopilotClient();\n\n var readOnlyTools = new HashSet { \"read_file\", \"glob\", \"grep\", \"view\" };\n\n var session = await client.CreateSessionAsync(new SessionConfig\n {\n Hooks = new SessionHooks\n {\n OnPreToolUse = (input, invocation) =>\n {\n if (!readOnlyTools.Contains(input.ToolName))\n {\n return Task.FromResult(new PreToolUseHookOutput\n {\n PermissionDecision = \"deny\",\n PermissionDecisionReason = $\"Only read-only tools are allowed. \\\"{input.ToolName}\\\" was blocked.\",\n });\n }\n return Task.FromResult(\n new PreToolUseHookOutput { PermissionDecision = \"allow\" });\n },\n },\n OnPermissionRequest = (req, inv) =>\n Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved }),\n });\n }\n}\n```\n\n\n```csharp\nvar readOnlyTools = new HashSet { \"read_file\", \"glob\", \"grep\", \"view\" };\n\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Hooks = new SessionHooks\n {\n OnPreToolUse = (input, invocation) =>\n {\n if (!readOnlyTools.Contains(input.ToolName))\n {\n return Task.FromResult(new PreToolUseHookOutput\n {\n PermissionDecision = \"deny\",\n PermissionDecisionReason = $\"Only read-only tools are allowed. \\\"{input.ToolName}\\\" was blocked.\",\n });\n }\n return Task.FromResult(\n new PreToolUseHookOutput { PermissionDecision = \"allow\" });\n },\n },\n});\n```\n\n
\n\n
\nJava\n\n```java\nimport java.util.Set;\nimport java.util.concurrent.CompletableFuture;\n\nimport com.github.copilot.sdk.PermissionHandler;\nimport com.github.copilot.sdk.SessionConfig;\nimport com.github.copilot.sdk.SessionHooks;\nimport com.github.copilot.sdk.json.PreToolUseHookOutput;\nvar readOnlyTools = Set.of(\"read_file\", \"glob\", \"grep\", \"view\");\n\nvar hooks = new SessionHooks()\n .setOnPreToolUse((input, invocation) -> {\n if (!readOnlyTools.contains(input.getToolName())) {\n return CompletableFuture.completedFuture(\n PreToolUseHookOutput.deny(\n \"Only read-only tools are allowed. \\\"\" + input.getToolName() + \"\\\" was blocked.\")\n );\n }\n return CompletableFuture.completedFuture(PreToolUseHookOutput.allow());\n });\n\nvar session = client.createSession(\n new SessionConfig()\n .setHooks(hooks)\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n).get();\n```\n\n
\n\n### Restrict file access to specific directories\n\n```typescript\nconst ALLOWED_DIRS = [\"/home/user/projects\", \"/tmp\"];\n\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n if ([\"read_file\", \"write_file\", \"edit\"].includes(input.toolName)) {\n const filePath = (input.toolArgs as { path: string }).path;\n const allowed = ALLOWED_DIRS.some((dir) => filePath.startsWith(dir));\n\n if (!allowed) {\n return {\n permissionDecision: \"deny\",\n permissionDecisionReason:\n `Access to \"${filePath}\" is outside the allowed directories.`,\n };\n }\n }\n return { permissionDecision: \"allow\" };\n },\n },\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n```\n\n### Ask the user before destructive operations\n\n```typescript\nconst DESTRUCTIVE_TOOLS = [\"delete_file\", \"shell\", \"bash\"];\n\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n if (DESTRUCTIVE_TOOLS.includes(input.toolName)) {\n return { permissionDecision: \"ask\" };\n }\n return { permissionDecision: \"allow\" };\n },\n },\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n```\n\nReturning `\"ask\"` delegates the decision to the user at runtime — useful for destructive actions where you want a human in the loop.\n\n---\n\n## Use Case: Auditing & Compliance\n\nCombine `onPreToolUse`, `onPostToolUse`, and the session lifecycle hooks to build a complete audit trail that records every action the agent takes.\n\n### Structured audit log\n\n
\nNode.js / TypeScript\n\n```typescript\ninterface AuditEntry {\n timestamp: number;\n sessionId: string;\n event: string;\n toolName?: string;\n toolArgs?: unknown;\n toolResult?: unknown;\n prompt?: string;\n}\n\nconst auditLog: AuditEntry[] = [];\n\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async (input, invocation) => {\n auditLog.push({\n timestamp: input.timestamp,\n sessionId: invocation.sessionId,\n event: \"session_start\",\n });\n return null;\n },\n onUserPromptSubmitted: async (input, invocation) => {\n auditLog.push({\n timestamp: input.timestamp,\n sessionId: invocation.sessionId,\n event: \"user_prompt\",\n prompt: input.prompt,\n });\n return null;\n },\n onPreToolUse: async (input, invocation) => {\n auditLog.push({\n timestamp: input.timestamp,\n sessionId: invocation.sessionId,\n event: \"tool_call\",\n toolName: input.toolName,\n toolArgs: input.toolArgs,\n });\n return { permissionDecision: \"allow\" };\n },\n onPostToolUse: async (input, invocation) => {\n auditLog.push({\n timestamp: input.timestamp,\n sessionId: invocation.sessionId,\n event: \"tool_result\",\n toolName: input.toolName,\n toolResult: input.toolResult,\n });\n return null;\n },\n onSessionEnd: async (input, invocation) => {\n auditLog.push({\n timestamp: input.timestamp,\n sessionId: invocation.sessionId,\n event: \"session_end\",\n });\n\n // Persist the log — swap this with your own storage backend\n await fs.promises.writeFile(\n `audit-${invocation.sessionId}.json`,\n JSON.stringify(auditLog, null, 2),\n );\n return null;\n },\n },\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n```\n\n
\n\n
\nPython\n\n\n```python\nimport json, aiofiles\n\naudit_log = []\n\nasync def on_session_start(input_data, invocation):\n audit_log.append({\n \"timestamp\": input_data[\"timestamp\"],\n \"session_id\": invocation[\"session_id\"],\n \"event\": \"session_start\",\n })\n return None\n\nasync def on_user_prompt_submitted(input_data, invocation):\n audit_log.append({\n \"timestamp\": input_data[\"timestamp\"],\n \"session_id\": invocation[\"session_id\"],\n \"event\": \"user_prompt\",\n \"prompt\": input_data[\"prompt\"],\n })\n return None\n\nasync def on_pre_tool_use(input_data, invocation):\n audit_log.append({\n \"timestamp\": input_data[\"timestamp\"],\n \"session_id\": invocation[\"session_id\"],\n \"event\": \"tool_call\",\n \"tool_name\": input_data[\"toolName\"],\n \"tool_args\": input_data[\"toolArgs\"],\n })\n return {\"permissionDecision\": \"allow\"}\n\nasync def on_post_tool_use(input_data, invocation):\n audit_log.append({\n \"timestamp\": input_data[\"timestamp\"],\n \"session_id\": invocation[\"session_id\"],\n \"event\": \"tool_result\",\n \"tool_name\": input_data[\"toolName\"],\n \"tool_result\": input_data[\"toolResult\"],\n })\n return None\n\nasync def on_session_end(input_data, invocation):\n audit_log.append({\n \"timestamp\": input_data[\"timestamp\"],\n \"session_id\": invocation[\"session_id\"],\n \"event\": \"session_end\",\n })\n async with aiofiles.open(f\"audit-{invocation['session_id']}.json\", \"w\") as f:\n await f.write(json.dumps(audit_log, indent=2))\n return None\n\nsession = await client.create_session(\n on_permission_request=lambda req, inv: {\"kind\": \"approved\"},\n hooks={\n \"on_session_start\": on_session_start,\n \"on_user_prompt_submitted\": on_user_prompt_submitted,\n \"on_pre_tool_use\": on_pre_tool_use,\n \"on_post_tool_use\": on_post_tool_use,\n \"on_session_end\": on_session_end,\n },\n)\n```\n\n
\n\n### Redact secrets from tool results\n\n```typescript\nconst SECRET_PATTERNS = [\n /(?:api[_-]?key|token|secret|password)\\s*[:=]\\s*[\"']?[\\w\\-\\.]+[\"']?/gi,\n];\n\nconst session = await client.createSession({\n hooks: {\n onPostToolUse: async (input) => {\n if (typeof input.toolResult !== \"string\") return null;\n\n let redacted = input.toolResult;\n for (const pattern of SECRET_PATTERNS) {\n redacted = redacted.replace(pattern, \"[REDACTED]\");\n }\n\n return redacted !== input.toolResult\n ? { modifiedResult: redacted }\n : null;\n },\n },\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n```\n\n---\n\n## Use Case: Notifications & Sounds\n\nHooks fire in your application's process, so you can trigger any side-effect — desktop notifications, sounds, Slack messages, or webhook calls.\n\n### Desktop notification on session events\n\n
\nNode.js / TypeScript\n\n```typescript\nimport notifier from \"node-notifier\"; // npm install node-notifier\n\nconst session = await client.createSession({\n hooks: {\n onSessionEnd: async (input, invocation) => {\n notifier.notify({\n title: \"Copilot Session Complete\",\n message: `Session ${invocation.sessionId.slice(0, 8)} finished (${input.reason}).`,\n });\n return null;\n },\n onErrorOccurred: async (input) => {\n notifier.notify({\n title: \"Copilot Error\",\n message: input.error.slice(0, 200),\n });\n return null;\n },\n },\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n```\n\n
\n\n
\nPython\n\n```python\nimport subprocess\n\nasync def on_session_end(input_data, invocation):\n sid = invocation[\"session_id\"][:8]\n reason = input_data[\"reason\"]\n subprocess.Popen([\n \"notify-send\", \"Copilot Session Complete\",\n f\"Session {sid} finished ({reason}).\",\n ])\n return None\n\nasync def on_error_occurred(input_data, invocation):\n subprocess.Popen([\n \"notify-send\", \"Copilot Error\",\n input_data[\"error\"][:200],\n ])\n return None\n\nsession = await client.create_session(\n on_permission_request=lambda req, inv: {\"kind\": \"approved\"},\n hooks={\n \"on_session_end\": on_session_end,\n \"on_error_occurred\": on_error_occurred,\n },\n)\n```\n\n
\n\n### Play a sound when a tool finishes\n\n```typescript\nimport { exec } from \"node:child_process\";\n\nconst session = await client.createSession({\n hooks: {\n onPostToolUse: async (input) => {\n // macOS: play a system sound after every tool call\n exec(\"afplay /System/Library/Sounds/Pop.aiff\");\n return null;\n },\n onErrorOccurred: async () => {\n exec(\"afplay /System/Library/Sounds/Basso.aiff\");\n return null;\n },\n },\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n```\n\n### Post to Slack on errors\n\n```typescript\nconst SLACK_WEBHOOK_URL = process.env.SLACK_WEBHOOK_URL!;\n\nconst session = await client.createSession({\n hooks: {\n onErrorOccurred: async (input, invocation) => {\n if (!input.recoverable) {\n await fetch(SLACK_WEBHOOK_URL, {\n method: \"POST\",\n headers: { \"Content-Type\": \"application/json\" },\n body: JSON.stringify({\n text: `🚨 Unrecoverable error in session \\`${invocation.sessionId.slice(0, 8)}\\`:\\n\\`\\`\\`${input.error}\\`\\`\\``,\n }),\n });\n }\n return null;\n },\n },\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n```\n\n---\n\n## Use Case: Prompt Enrichment\n\nUse `onSessionStart` and `onUserPromptSubmitted` to automatically inject context so users don't have to repeat themselves.\n\n### Inject project metadata at session start\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async (input) => {\n const pkg = JSON.parse(\n await fs.promises.readFile(\"package.json\", \"utf-8\"),\n );\n return {\n additionalContext: [\n `Project: ${pkg.name} v${pkg.version}`,\n `Node: ${process.version}`,\n `CWD: ${input.cwd}`,\n ].join(\"\\n\"),\n };\n },\n },\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n```\n\n### Expand shorthand commands in prompts\n\n```typescript\nconst SHORTCUTS: Record = {\n \"/fix\": \"Find and fix all errors in the current file\",\n \"/test\": \"Write comprehensive unit tests for this code\",\n \"/explain\": \"Explain this code in detail\",\n \"/refactor\": \"Refactor this code to improve readability\",\n};\n\nconst session = await client.createSession({\n hooks: {\n onUserPromptSubmitted: async (input) => {\n for (const [shortcut, expansion] of Object.entries(SHORTCUTS)) {\n if (input.prompt.startsWith(shortcut)) {\n const rest = input.prompt.slice(shortcut.length).trim();\n return { modifiedPrompt: rest ? `${expansion}: ${rest}` : expansion };\n }\n }\n return null;\n },\n },\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n```\n\n---\n\n## Use Case: Error Handling & Recovery\n\nThe `onErrorOccurred` hook gives you a chance to react to failures — whether that means retrying, notifying a human, or gracefully shutting down.\n\n### Retry transient model errors\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onErrorOccurred: async (input) => {\n if (input.errorContext === \"model_call\" && input.recoverable) {\n return {\n errorHandling: \"retry\",\n retryCount: 3,\n userNotification: \"Temporary model issue — retrying…\",\n };\n }\n return null;\n },\n },\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n```\n\n### Friendly error messages\n\n```typescript\nconst FRIENDLY_MESSAGES: Record = {\n model_call: \"The AI model is temporarily unavailable. Please try again.\",\n tool_execution: \"A tool encountered an error. Check inputs and try again.\",\n system: \"A system error occurred. Please try again later.\",\n};\n\nconst session = await client.createSession({\n hooks: {\n onErrorOccurred: async (input) => {\n return {\n userNotification: FRIENDLY_MESSAGES[input.errorContext] ?? input.error,\n };\n },\n },\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n```\n\n---\n\n## Use Case: Session Metrics\n\nTrack how long sessions run, how many tools are invoked, and why sessions end — useful for dashboards and cost monitoring.\n\n
\nNode.js / TypeScript\n\n```typescript\nconst metrics = new Map();\n\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async (input, invocation) => {\n metrics.set(invocation.sessionId, {\n start: input.timestamp,\n toolCalls: 0,\n prompts: 0,\n });\n return null;\n },\n onUserPromptSubmitted: async (_input, invocation) => {\n metrics.get(invocation.sessionId)!.prompts++;\n return null;\n },\n onPreToolUse: async (_input, invocation) => {\n metrics.get(invocation.sessionId)!.toolCalls++;\n return { permissionDecision: \"allow\" };\n },\n onSessionEnd: async (input, invocation) => {\n const m = metrics.get(invocation.sessionId)!;\n const durationSec = (input.timestamp - m.start) / 1000;\n\n console.log(\n `Session ${invocation.sessionId.slice(0, 8)}: ` +\n `${durationSec.toFixed(1)}s, ${m.prompts} prompts, ` +\n `${m.toolCalls} tool calls, ended: ${input.reason}`,\n );\n\n metrics.delete(invocation.sessionId);\n return null;\n },\n },\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n```\n\n
\n\n
\nPython\n\n```python\nsession_metrics = {}\n\nasync def on_session_start(input_data, invocation):\n session_metrics[invocation[\"session_id\"]] = {\n \"start\": input_data[\"timestamp\"],\n \"tool_calls\": 0,\n \"prompts\": 0,\n }\n return None\n\nasync def on_user_prompt_submitted(input_data, invocation):\n session_metrics[invocation[\"session_id\"]][\"prompts\"] += 1\n return None\n\nasync def on_pre_tool_use(input_data, invocation):\n session_metrics[invocation[\"session_id\"]][\"tool_calls\"] += 1\n return {\"permissionDecision\": \"allow\"}\n\nasync def on_session_end(input_data, invocation):\n m = session_metrics.pop(invocation[\"session_id\"])\n duration = (input_data[\"timestamp\"] - m[\"start\"]) / 1000\n sid = invocation[\"session_id\"][:8]\n print(\n f\"Session {sid}: {duration:.1f}s, {m['prompts']} prompts, \"\n f\"{m['tool_calls']} tool calls, ended: {input_data['reason']}\"\n )\n return None\n\nsession = await client.create_session(\n on_permission_request=lambda req, inv: {\"kind\": \"approved\"},\n hooks={\n \"on_session_start\": on_session_start,\n \"on_user_prompt_submitted\": on_user_prompt_submitted,\n \"on_pre_tool_use\": on_pre_tool_use,\n \"on_session_end\": on_session_end,\n },\n)\n```\n\n
\n\n---\n\n## Combining Hooks\n\nHooks compose naturally. A single `hooks` object can handle permissions **and** auditing **and** notifications — each hook does its own job.\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async (input) => {\n console.log(`[audit] session started in ${input.cwd}`);\n return { additionalContext: \"Project uses TypeScript and Vitest.\" };\n },\n onPreToolUse: async (input) => {\n console.log(`[audit] tool requested: ${input.toolName}`);\n if (input.toolName === \"shell\") {\n return { permissionDecision: \"ask\" };\n }\n return { permissionDecision: \"allow\" };\n },\n onPostToolUse: async (input) => {\n console.log(`[audit] tool completed: ${input.toolName}`);\n return null;\n },\n onErrorOccurred: async (input) => {\n console.error(`[alert] ${input.errorContext}: ${input.error}`);\n return null;\n },\n onSessionEnd: async (input, invocation) => {\n console.log(`[audit] session ${invocation.sessionId.slice(0, 8)} ended: ${input.reason}`);\n return null;\n },\n },\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n```\n\n## Best Practices\n\n1. **Keep hooks fast.** Every hook runs inline — slow hooks delay the conversation. Offload heavy work (database writes, HTTP calls) to a background queue when possible.\n\n2. **Return `null` when you have nothing to change.** This tells the SDK to proceed with defaults and avoids unnecessary object allocation.\n\n3. **Be explicit with permission decisions.** Returning `{ permissionDecision: \"allow\" }` is clearer than returning `null`, even though both allow the tool.\n\n4. **Don't swallow critical errors.** It's fine to suppress recoverable tool errors, but always log or alert on unrecoverable ones.\n\n5. **Use `additionalContext` instead of `modifiedPrompt` when possible.** Appending context preserves the user's original intent while still guiding the model.\n\n6. **Scope state by session ID.** If you track per-session data, key it on `invocation.sessionId` and clean up in `onSessionEnd`.\n\n## Reference\n\nFor full type definitions, input/output field tables, and additional examples for every hook, see the API reference:\n\n- [Hooks Overview](../hooks/index.md)\n- [Pre-Tool Use](../hooks/pre-tool-use.md)\n- [Post-Tool Use](../hooks/post-tool-use.md)\n- [User Prompt Submitted](../hooks/user-prompt-submitted.md)\n- [Session Lifecycle](../hooks/session-lifecycle.md)\n- [Error Handling](../hooks/error-handling.md)\n\n## See Also\n\n- [Getting Started](../getting-started.md)\n- [Custom Agents & Sub-Agent Orchestration](./custom-agents.md)\n- [Streaming Session Events](./streaming-events.md)\n- [Debugging Guide](../troubleshooting/debugging.md)\n" }, { "path": "docs/features/image-input.md", "content": "# Image Input\n\nSend images to Copilot sessions as attachments. There are two ways to attach images:\n\n- **File attachment** (`type: \"file\"`) — provide an absolute path; the runtime reads the file from disk, converts it to base64, and sends it to the LLM.\n- **Blob attachment** (`type: \"blob\"`) — provide base64-encoded data directly; useful when the image is already in memory (e.g., screenshots, generated images, or data from an API).\n\n## Overview\n\n```mermaid\nsequenceDiagram\n participant App as Your App\n participant SDK as SDK Session\n participant RT as Copilot Runtime\n participant LLM as Vision Model\n\n App->>SDK: send({ prompt, attachments: [{ type: \"file\", path }] })\n SDK->>RT: JSON-RPC with file attachment\n RT->>RT: Read file from disk\n RT->>RT: Detect image, convert to base64\n RT->>RT: Resize if needed (model-specific limits)\n RT->>LLM: image_url content block (base64)\n LLM-->>RT: Response referencing the image\n RT-->>SDK: assistant.message events\n SDK-->>App: event stream\n```\n\n| Concept | Description |\n|---------|-------------|\n| **File attachment** | An attachment with `type: \"file\"` and an absolute `path` to an image on disk |\n| **Blob attachment** | An attachment with `type: \"blob\"`, base64-encoded `data`, and a `mimeType` — no disk I/O needed |\n| **Automatic encoding** | For file attachments, the runtime reads the image and converts it to base64 automatically |\n| **Auto-resize** | The runtime automatically resizes or quality-reduces images that exceed model-specific limits |\n| **Vision capability** | The model must have `capabilities.supports.vision = true` to process images |\n\n## Quick Start — File Attachment\n\nAttach an image file to any message using the file attachment type. The path must be an absolute path to an image on disk.\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\nawait client.start();\n\nconst session = await client.createSession({\n model: \"gpt-4.1\",\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n\nawait session.send({\n prompt: \"Describe what you see in this image\",\n attachments: [\n {\n type: \"file\",\n path: \"/absolute/path/to/screenshot.png\",\n },\n ],\n});\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionRequestResult\n\nclient = CopilotClient()\nawait client.start()\n\nsession = await client.create_session(\n on_permission_request=lambda req, inv: PermissionRequestResult(kind=\"approved\"),\n model=\"gpt-4.1\",\n)\n\nawait session.send(\n \"Describe what you see in this image\",\n attachments=[\n {\n \"type\": \"file\",\n \"path\": \"/absolute/path/to/screenshot.png\",\n },\n ],\n)\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclient := copilot.NewClient(nil)\n\tclient.Start(ctx)\n\n\tsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"gpt-4.1\",\n\t\tOnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n\t\t},\n\t})\n\n\tpath := \"/absolute/path/to/screenshot.png\"\n\tsession.Send(ctx, copilot.MessageOptions{\n\t\tPrompt: \"Describe what you see in this image\",\n\t\tAttachments: []copilot.Attachment{\n\t\t\t{\n\t\t\t\tType: copilot.AttachmentTypeFile,\n\t\t\t\tPath: &path,\n\t\t\t},\n\t\t},\n\t})\n}\n```\n\n\n```go\nctx := context.Background()\nclient := copilot.NewClient(nil)\nclient.Start(ctx)\n\nsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n Model: \"gpt-4.1\",\n OnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n return copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n },\n})\n\npath := \"/absolute/path/to/screenshot.png\"\nsession.Send(ctx, copilot.MessageOptions{\n Prompt: \"Describe what you see in this image\",\n Attachments: []copilot.Attachment{\n {\n Type: copilot.AttachmentTypeFile,\n Path: &path,\n },\n },\n})\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic static class ImageInputExample\n{\n public static async Task Main()\n {\n await using var client = new CopilotClient();\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"gpt-4.1\",\n OnPermissionRequest = (req, inv) =>\n Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved }),\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Describe what you see in this image\",\n Attachments = new List\n {\n new UserMessageAttachmentFile\n {\n Path = \"/absolute/path/to/screenshot.png\",\n DisplayName = \"screenshot.png\",\n },\n },\n });\n }\n}\n```\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\nawait using var client = new CopilotClient();\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-4.1\",\n OnPermissionRequest = (req, inv) =>\n Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved }),\n});\n\nawait session.SendAsync(new MessageOptions\n{\n Prompt = \"Describe what you see in this image\",\n Attachments = new List\n {\n new UserMessageAttachmentFile\n {\n Path = \"/absolute/path/to/screenshot.png\",\n DisplayName = \"screenshot.png\",\n },\n },\n});\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\nimport java.util.List;\n\ntry (var client = new CopilotClient()) {\n client.start().get();\n\n var session = client.createSession(\n new SessionConfig()\n .setModel(\"gpt-4.1\")\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n ).get();\n\n session.send(new MessageOptions()\n .setPrompt(\"Describe what you see in this image\")\n .setAttachments(List.of(\n new Attachment(\"file\", \"/absolute/path/to/screenshot.png\", \"screenshot.png\")\n ))\n ).get();\n}\n```\n\n
\n\n## Quick Start — Blob Attachment\n\nWhen you already have image data in memory (e.g., a screenshot captured by your app, or an image fetched from an API), use a blob attachment to send it directly without writing to disk.\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\nawait client.start();\n\nconst session = await client.createSession({\n model: \"gpt-4.1\",\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n\nconst base64ImageData = \"...\"; // your base64-encoded image\nawait session.send({\n prompt: \"Describe what you see in this image\",\n attachments: [\n {\n type: \"blob\",\n data: base64ImageData,\n mimeType: \"image/png\",\n displayName: \"screenshot.png\",\n },\n ],\n});\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionRequestResult\n\nclient = CopilotClient()\nawait client.start()\n\nsession = await client.create_session(\n on_permission_request=lambda req, inv: PermissionRequestResult(kind=\"approved\"),\n model=\"gpt-4.1\",\n)\n\nbase64_image_data = \"...\" # your base64-encoded image\nawait session.send(\n \"Describe what you see in this image\",\n attachments=[\n {\n \"type\": \"blob\",\n \"data\": base64_image_data,\n \"mimeType\": \"image/png\",\n \"displayName\": \"screenshot.png\",\n },\n ],\n)\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclient := copilot.NewClient(nil)\n\tclient.Start(ctx)\n\n\tsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"gpt-4.1\",\n\t\tOnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n\t\t},\n\t})\n\n\tbase64ImageData := \"...\"\n\tmimeType := \"image/png\"\n\tdisplayName := \"screenshot.png\"\n\tsession.Send(ctx, copilot.MessageOptions{\n\t\tPrompt: \"Describe what you see in this image\",\n\t\tAttachments: []copilot.Attachment{\n\t\t\t{\n\t\t\t\tType: copilot.AttachmentTypeBlob,\n\t\t\t\tData: &base64ImageData,\n\t\t\t\tMIMEType: &mimeType,\n\t\t\t\tDisplayName: &displayName,\n\t\t\t},\n\t\t},\n\t})\n}\n```\n\n\n```go\nmimeType := \"image/png\"\ndisplayName := \"screenshot.png\"\nsession.Send(ctx, copilot.MessageOptions{\n Prompt: \"Describe what you see in this image\",\n Attachments: []copilot.Attachment{\n {\n Type: copilot.AttachmentTypeBlob,\n Data: &base64ImageData, // base64-encoded string\n MIMEType: &mimeType,\n DisplayName: &displayName,\n },\n },\n})\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic static class BlobAttachmentExample\n{\n public static async Task Main()\n {\n await using var client = new CopilotClient();\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"gpt-4.1\",\n OnPermissionRequest = (req, inv) =>\n Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved }),\n });\n\n var base64ImageData = \"...\";\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Describe what you see in this image\",\n Attachments = new List\n {\n new UserMessageAttachmentBlob\n {\n Data = base64ImageData,\n MimeType = \"image/png\",\n DisplayName = \"screenshot.png\",\n },\n },\n });\n }\n}\n```\n\n\n```csharp\nawait session.SendAsync(new MessageOptions\n{\n Prompt = \"Describe what you see in this image\",\n Attachments = new List\n {\n new UserMessageAttachmentBlob\n {\n Data = base64ImageData,\n MimeType = \"image/png\",\n DisplayName = \"screenshot.png\",\n },\n },\n});\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\nimport java.util.List;\n\ntry (var client = new CopilotClient()) {\n client.start().get();\n\n var session = client.createSession(\n new SessionConfig()\n .setModel(\"gpt-4.1\")\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n ).get();\n\n var base64ImageData = \"...\"; // your base64-encoded image\n session.send(new MessageOptions()\n .setPrompt(\"Describe what you see in this image\")\n .setAttachments(List.of(\n new BlobAttachment()\n .setData(base64ImageData)\n .setMimeType(\"image/png\")\n .setDisplayName(\"screenshot.png\")\n ))\n ).get();\n}\n```\n\n
\n\n## Supported Formats\n\nSupported image formats include JPG, PNG, GIF, and other common image types. For file attachments, the runtime reads the image from disk and converts it as needed. For blob attachments, you provide the base64 data and MIME type directly. Use PNG or JPEG for best results, as these are the most widely supported formats.\n\nThe model's `capabilities.limits.vision.supported_media_types` field lists the exact MIME types it accepts.\n\n## Automatic Processing\n\nThe runtime automatically processes images to fit within the model's constraints. No manual resizing is required.\n\n- Images that exceed the model's dimension or size limits are automatically resized (preserving aspect ratio) or quality-reduced.\n- If an image cannot be brought within limits after processing, it is skipped and not sent to the LLM.\n- The model's `capabilities.limits.vision.max_prompt_image_size` field indicates the maximum image size in bytes.\n\nYou can check these limits at runtime via the model capabilities object. For the best experience, use reasonably-sized PNG or JPEG images.\n\n## Vision Model Capabilities\n\nNot all models support vision. Check the model's capabilities before sending images.\n\n### Capability fields\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `capabilities.supports.vision` | `boolean` | Whether the model can process image inputs |\n| `capabilities.limits.vision.supported_media_types` | `string[]` | MIME types the model accepts (e.g., `[\"image/png\", \"image/jpeg\"]`) |\n| `capabilities.limits.vision.max_prompt_images` | `number` | Maximum number of images per prompt |\n| `capabilities.limits.vision.max_prompt_image_size` | `number` | Maximum image size in bytes |\n\n### Vision limits type\n\n\n```typescript\ninterface VisionCapabilities {\n vision?: {\n supported_media_types: string[];\n max_prompt_images: number;\n max_prompt_image_size: number; // bytes\n };\n}\n```\n\n```typescript\nvision?: {\n supported_media_types: string[];\n max_prompt_images: number;\n max_prompt_image_size: number; // bytes\n};\n```\n\n## Receiving Image Results\n\nWhen tools return images (e.g., screenshots or generated charts), the result contains `\"image\"` content blocks with base64-encoded data.\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `type` | `\"image\"` | Content block type discriminator |\n| `data` | `string` | Base64-encoded image data |\n| `mimeType` | `string` | MIME type (e.g., `\"image/png\"`) |\n\nThese image blocks appear in `tool.execution_complete` event results. See the [Streaming Events](./streaming-events.md) guide for the full event lifecycle.\n\n## Tips & Limitations\n\n| Tip | Details |\n|-----|---------|\n| **Use PNG or JPEG directly** | Avoids conversion overhead — these are sent to the LLM as-is |\n| **Keep images reasonably sized** | Large images may be quality-reduced, which can lose important details |\n| **Use absolute paths for file attachments** | The runtime reads files from disk; relative paths may not resolve correctly |\n| **Use blob attachments for in-memory data** | When you already have base64 data (e.g., screenshots, API responses), blob avoids unnecessary disk I/O |\n| **Check vision support first** | Sending images to a non-vision model wastes tokens without visual understanding |\n| **Multiple images are supported** | Attach several attachments in one message, up to the model's `max_prompt_images` limit |\n| **SVG is not supported** | SVG files are text-based and excluded from image processing |\n\n## See Also\n\n- [Streaming Events](./streaming-events.md) — event lifecycle including tool result content blocks\n- [Steering & Queueing](./steering-and-queueing.md) — sending follow-up messages with attachments\n" }, { "path": "docs/features/index.md", "content": "# Features\n\nThese guides cover the capabilities you can add to your Copilot SDK application. Each guide includes examples in all supported languages (TypeScript, Python, Go, .NET, and Java).\n\n> **New to the SDK?** Start with the [Getting Started tutorial](../getting-started.md) first, then come back here to add more capabilities.\n\n## Guides\n\n| Feature | Description |\n|---|---|\n| [The Agent Loop](./agent-loop.md) | How the CLI processes a prompt — the tool-use loop, turns, and completion signals |\n| [Hooks](./hooks.md) | Intercept and customize session behavior — control tool execution, transform results, handle errors |\n| [Custom Agents](./custom-agents.md) | Define specialized sub-agents with scoped tools and instructions |\n| [MCP Servers](./mcp.md) | Integrate Model Context Protocol servers for external tool access |\n| [Skills](./skills.md) | Load reusable prompt modules from directories |\n| [Image Input](./image-input.md) | Send images to sessions as attachments |\n| [Streaming Events](./streaming-events.md) | Subscribe to real-time session events (40+ event types) |\n| [Steering & Queueing](./steering-and-queueing.md) | Control message delivery — immediate steering vs. sequential queueing |\n| [Session Persistence](./session-persistence.md) | Resume sessions across restarts, manage session storage |\n\n## Related\n\n- [Hooks Reference](../hooks/index.md) — detailed API reference for each hook type\n- [Integrations](../integrations/microsoft-agent-framework.md) — use the SDK with other platforms (MAF, etc.)\n- [Troubleshooting](../troubleshooting/debugging.md) — when things don't work as expected\n- [Compatibility](../troubleshooting/compatibility.md) — SDK vs CLI feature matrix\n" }, { "path": "docs/features/mcp.md", "content": "# Using MCP Servers with the GitHub Copilot SDK\n\nThe Copilot SDK can integrate with **MCP servers** (Model Context Protocol) to extend the assistant's capabilities with external tools. MCP servers run as separate processes and expose tools (functions) that Copilot can invoke during conversations.\n\n> **Note:** This is an evolving feature. See [issue #36](https://github.com/github/copilot-sdk/issues/36) for ongoing discussion.\n\n## What is MCP?\n\n[Model Context Protocol (MCP)](https://modelcontextprotocol.io/) is an open standard for connecting AI assistants to external tools and data sources. MCP servers can:\n\n- Execute code or scripts\n- Query databases\n- Access file systems\n- Call external APIs\n- And much more\n\n## Server Types\n\nThe SDK supports two types of MCP servers:\n\n| Type | Description | Use Case |\n|------|-------------|----------|\n| **Local/Stdio** | Runs as a subprocess, communicates via stdin/stdout | Local tools, file access, custom scripts |\n| **HTTP/SSE** | Remote server accessed via HTTP | Shared services, cloud-hosted tools |\n\n## Configuration\n\n### Node.js / TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\nconst session = await client.createSession({\n model: \"gpt-5\",\n mcpServers: {\n // Local MCP server (stdio)\n \"my-local-server\": {\n type: \"local\",\n command: \"node\",\n args: [\"./mcp-server.js\"],\n env: { DEBUG: \"true\" },\n cwd: \"./servers\",\n tools: [\"*\"], // \"*\" = all tools, [] = none, or list specific tools\n timeout: 30000,\n },\n // Remote MCP server (HTTP)\n \"github\": {\n type: \"http\",\n url: \"https://api.githubcopilot.com/mcp/\",\n headers: { \"Authorization\": \"Bearer ${TOKEN}\" },\n tools: [\"*\"],\n },\n },\n});\n```\n\n### Python\n\n```python\nimport asyncio\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionHandler\n\nasync def main():\n client = CopilotClient()\n await client.start()\n\n session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model=\"gpt-5\", mcp_servers={\n # Local MCP server (stdio)\n \"my-local-server\": {\n \"type\": \"local\",\n \"command\": \"python\",\n \"args\": [\"./mcp_server.py\"],\n \"env\": {\"DEBUG\": \"true\"},\n \"cwd\": \"./servers\",\n \"tools\": [\"*\"],\n \"timeout\": 30000,\n },\n # Remote MCP server (HTTP)\n \"github\": {\n \"type\": \"http\",\n \"url\": \"https://api.githubcopilot.com/mcp/\",\n \"headers\": {\"Authorization\": \"Bearer ${TOKEN}\"},\n \"tools\": [\"*\"],\n },\n })\n\n response = await session.send_and_wait(\"List my recent GitHub notifications\")\n print(response.data.content)\n\n await client.stop()\n\nasyncio.run(main())\n```\n\n### Go\n\n```go\npackage main\n\nimport (\n \"context\"\n \"log\"\n copilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n client := copilot.NewClient(nil)\n if err := client.Start(ctx); err != nil {\n log.Fatal(err)\n }\n defer client.Stop()\n\n session, err := client.CreateSession(ctx, &copilot.SessionConfig{\n Model: \"gpt-5\",\n MCPServers: map[string]copilot.MCPServerConfig{\n \"my-local-server\": copilot.MCPStdioServerConfig{\n Command: \"node\",\n Args: []string{\"./mcp-server.js\"},\n Tools: []string{\"*\"},\n },\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n defer session.Disconnect()\n\n // Use the session...\n}\n```\n\n### .NET\n\n```csharp\nusing GitHub.Copilot.SDK;\n\nawait using var client = new CopilotClient();\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5\",\n McpServers = new Dictionary\n {\n [\"my-local-server\"] = new McpStdioServerConfig\n {\n Command = \"node\",\n Args = new List { \"./mcp-server.js\" },\n Tools = new List { \"*\" },\n },\n },\n});\n```\n\n## Tool Configuration\n\nYou can control which tools are available to an MCP server using the `tools` field.\n\n### Allow all tools\n\nUse `\"*\"` to enable all tools provided by the MCP server:\n\n```typescript\ntools: [\"*\"]\n```\n\n---\n\n### Allow specific tools\n\nProvide a list of tool names to restrict access:\n\n```typescript\ntools: [\"bash\", \"edit\"]\n```\n\nOnly the listed tools will be available to the agent.\n\n---\n\n### Disable all tools\n\nUse an empty array to disable all tools:\n\n```typescript\ntools: []\n```\n\n---\n\n### Notes\n\n- The `tools` field defines which tools are allowed.\n- There is no separate `allow` or `disallow` configuration — tool access is controlled directly through this list.\n\n## Quick Start: Filesystem MCP Server\n\nHere's a complete working example using the official [`@modelcontextprotocol/server-filesystem`](https://www.npmjs.com/package/@modelcontextprotocol/server-filesystem) MCP server:\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const client = new CopilotClient();\n\n // Create session with filesystem MCP server\n const session = await client.createSession({\n mcpServers: {\n filesystem: {\n type: \"local\",\n command: \"npx\",\n args: [\"-y\", \"@modelcontextprotocol/server-filesystem\", \"/tmp\"],\n tools: [\"*\"],\n },\n },\n });\n\n console.log(\"Session created:\", session.sessionId);\n\n // The model can now use filesystem tools\n const result = await session.sendAndWait({\n prompt: \"List the files in the allowed directory\",\n });\n\n console.log(\"Response:\", result?.data?.content);\n\n await session.disconnect();\n await client.stop();\n}\n\nmain();\n```\n\n**Output:**\n```\nSession created: 18b3482b-bcba-40ba-9f02-ad2ac949a59a\nResponse: The allowed directory is `/tmp`, which contains various files\nand subdirectories including temporary system files, log files, and\ndirectories for different applications.\n```\n\n> **Tip:** You can use any MCP server from the [MCP Servers Directory](https://github.com/modelcontextprotocol/servers). Popular options include `@modelcontextprotocol/server-github`, `@modelcontextprotocol/server-sqlite`, and `@modelcontextprotocol/server-puppeteer`.\n\n## Configuration Options\n\n### Local/Stdio Server\n\n| Property | Type | Required | Description |\n|----------|------|----------|-------------|\n| `type` | `\"local\"` or `\"stdio\"` | No | Server type (defaults to local) |\n| `command` | `string` | Yes | Command to execute |\n| `args` | `string[]` | Yes | Command arguments |\n| `env` | `object` | No | Environment variables |\n| `cwd` | `string` | No | Working directory |\n| `tools` | `string[]` | No | Tools to enable (`[\"*\"]` for all, `[]` for none) |\n| `timeout` | `number` | No | Timeout in milliseconds |\n\n### Remote Server (HTTP/SSE)\n\n| Property | Type | Required | Description |\n|----------|------|----------|-------------|\n| `type` | `\"http\"` or `\"sse\"` | Yes | Server type |\n| `url` | `string` | Yes | Server URL |\n| `headers` | `object` | No | HTTP headers (e.g., for auth) |\n| `tools` | `string[]` | No | Tools to enable |\n| `timeout` | `number` | No | Timeout in milliseconds |\n\n## Troubleshooting\n\n### Tools not showing up or not being invoked\n\n1. **Verify the MCP server starts correctly**\n - Check that the command and args are correct\n - Ensure the server process doesn't crash on startup\n - Look for error output in stderr\n\n2. **Check tool configuration**\n - Make sure `tools` is set to `[\"*\"]` or lists the specific tools you need\n - An empty array `[]` means no tools are enabled\n\n3. **Verify connectivity for remote servers**\n - Ensure the URL is accessible\n - Check that authentication headers are correct\n\n### Common issues\n\n| Issue | Solution |\n|-------|----------|\n| \"MCP server not found\" | Verify the command path is correct and executable |\n| \"Connection refused\" (HTTP) | Check the URL and ensure the server is running |\n| \"Timeout\" errors | Increase the `timeout` value or check server performance |\n| Tools work but aren't called | Ensure your prompt clearly requires the tool's functionality |\n\nFor detailed debugging guidance, see the **[MCP Debugging Guide](../troubleshooting/mcp-debugging.md)**.\n\n## Related Resources\n\n- [Model Context Protocol Specification](https://modelcontextprotocol.io/)\n- [MCP Servers Directory](https://github.com/modelcontextprotocol/servers) - Community MCP servers\n- [GitHub MCP Server](https://github.com/github/github-mcp-server) - Official GitHub MCP server\n- [Getting Started Guide](../getting-started.md) - SDK basics and custom tools\n- [General Debugging Guide](.../troubleshooting/mcp-debugging.md) - SDK-wide debugging\n\n## See Also\n\n- [MCP Debugging Guide](../troubleshooting/mcp-debugging.md) - Detailed MCP troubleshooting\n- [Issue #9](https://github.com/github/copilot-sdk/issues/9) - Original MCP tools usage question\n- [Issue #36](https://github.com/github/copilot-sdk/issues/36) - MCP documentation tracking issue\n" }, { "path": "docs/features/session-persistence.md", "content": "# Session Resume & Persistence\n\nThis guide walks you through the SDK's session persistence capabilities—how to pause work, resume it later, and manage sessions in production environments.\n\n## How Sessions Work\n\nWhen you create a session, the Copilot CLI maintains conversation history, tool state, and planning context. By default, this state lives in memory and disappears when the session ends. With persistence enabled, you can resume sessions across restarts, container migrations, or even different client instances.\n\n```mermaid\nflowchart LR\n A[🆕 Create] --> B[⚡ Active] --> C[💾 Paused] --> D[🔄 Resume]\n D --> B\n```\n\n| State | What happens |\n|-------|--------------|\n| **Create** | `session_id` assigned |\n| **Active** | Send prompts, tool calls, responses |\n| **Paused** | State saved to disk |\n| **Resume** | State loaded from disk |\n\n## Quick Start: Creating a Resumable Session\n\nThe key to resumable sessions is providing your own `session_id`. Without one, the SDK generates a random ID and the session can't be resumed later.\n\n### TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\n\n// Create a session with a meaningful ID\nconst session = await client.createSession({\n sessionId: \"user-123-task-456\",\n model: \"gpt-5.2-codex\",\n});\n\n// Do some work...\nawait session.sendAndWait({ prompt: \"Analyze my codebase\" });\n\n// Session state is automatically persisted\n// You can safely close the client\n```\n\n### Python\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionHandler\n\nclient = CopilotClient()\nawait client.start()\n\n# Create a session with a meaningful ID\nsession = await client.create_session(on_permission_request=PermissionHandler.approve_all, model=\"gpt-5.2-codex\", session_id=\"user-123-task-456\")\n\n# Do some work...\nawait session.send_and_wait(\"Analyze my codebase\")\n\n# Session state is automatically persisted\n```\n\n### Go\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclient := copilot.NewClient(nil)\n\n\tsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tSessionID: \"user-123-task-456\",\n\t\tModel: \"gpt-5.2-codex\",\n\t\tOnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n\t\t},\n\t})\n\n\tsession.SendAndWait(ctx, copilot.MessageOptions{Prompt: \"Analyze my codebase\"})\n\t_ = session\n}\n```\n\n\n```go\nctx := context.Background()\nclient := copilot.NewClient(nil)\n\n// Create a session with a meaningful ID\nsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n SessionID: \"user-123-task-456\",\n Model: \"gpt-5.2-codex\",\n})\n\n// Do some work...\nsession.SendAndWait(ctx, copilot.MessageOptions{Prompt: \"Analyze my codebase\"})\n\n// Session state is automatically persisted\n```\n\n### C# (.NET)\n\n```csharp\nusing GitHub.Copilot.SDK;\n\nvar client = new CopilotClient();\n\n// Create a session with a meaningful ID\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n SessionId = \"user-123-task-456\",\n Model = \"gpt-5.2-codex\",\n});\n\n// Do some work...\nawait session.SendAndWaitAsync(new MessageOptions { Prompt = \"Analyze my codebase\" });\n\n// Session state is automatically persisted\n```\n\n## Resuming a Session\n\nLater—minutes, hours, or even days—you can resume the session from where you left off.\n\n```mermaid\nflowchart LR\n subgraph Day1[\"Day 1\"]\n A1[Client A:
createSession] --> A2[Work...]\n end\n \n A2 --> S[(💾 Storage:
~/.copilot/session-state/)]\n S --> B1\n \n subgraph Day2[\"Day 2\"]\n B1[Client B:
resumeSession] --> B2[Continue]\n end\n```\n\n### TypeScript\n\n```typescript\n// Resume from a different client instance (or after restart)\nconst session = await client.resumeSession(\"user-123-task-456\");\n\n// Continue where you left off\nawait session.sendAndWait({ prompt: \"What did we discuss earlier?\" });\n```\n\n### Python\n\n```python\n# Resume from a different client instance (or after restart)\nsession = await client.resume_session(\"user-123-task-456\", on_permission_request=PermissionHandler.approve_all)\n\n# Continue where you left off\nawait session.send_and_wait(\"What did we discuss earlier?\")\n```\n\n### Go\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclient := copilot.NewClient(nil)\n\n\tsession, _ := client.ResumeSession(ctx, \"user-123-task-456\", nil)\n\n\tsession.SendAndWait(ctx, copilot.MessageOptions{Prompt: \"What did we discuss earlier?\"})\n\t_ = session\n}\n```\n\n\n```go\nctx := context.Background()\n\n// Resume from a different client instance (or after restart)\nsession, _ := client.ResumeSession(ctx, \"user-123-task-456\", nil)\n\n// Continue where you left off\nsession.SendAndWait(ctx, copilot.MessageOptions{Prompt: \"What did we discuss earlier?\"})\n```\n\n### C# (.NET)\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic static class ResumeSessionExample\n{\n public static async Task Main()\n {\n await using var client = new CopilotClient();\n\n var session = await client.ResumeSessionAsync(\"user-123-task-456\", new ResumeSessionConfig\n {\n OnPermissionRequest = (req, inv) =>\n Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved }),\n });\n\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"What did we discuss earlier?\" });\n }\n}\n```\n\n\n```csharp\n// Resume from a different client instance (or after restart)\nvar session = await client.ResumeSessionAsync(\"user-123-task-456\");\n\n// Continue where you left off\nawait session.SendAndWaitAsync(new MessageOptions { Prompt = \"What did we discuss earlier?\" });\n```\n\n## Resume Options\n\nWhen resuming a session, you can optionally reconfigure many settings. This is useful when you need to change the model, update tool configurations, or modify behavior.\n\n| Option | Description |\n|--------|-------------|\n| `model` | Change the model for the resumed session |\n| `systemMessage` | Override or extend the system prompt |\n| `availableTools` | Restrict which tools are available |\n| `excludedTools` | Disable specific tools |\n| `provider` | Re-provide BYOK credentials (required for BYOK sessions) |\n| `reasoningEffort` | Adjust reasoning effort level |\n| `streaming` | Enable/disable streaming responses |\n| `workingDirectory` | Change the working directory |\n| `configDir` | Override configuration directory |\n| `mcpServers` | Configure MCP servers |\n| `customAgents` | Configure custom agents |\n| `agent` | Pre-select a custom agent by name |\n| `skillDirectories` | Directories to load skills from |\n| `disabledSkills` | Skills to disable |\n| `infiniteSessions` | Configure infinite session behavior |\n\n### Example: Changing Model on Resume\n\n```typescript\n// Resume with a different model\nconst session = await client.resumeSession(\"user-123-task-456\", {\n model: \"claude-sonnet-4\", // Switch to a different model\n reasoningEffort: \"high\", // Increase reasoning effort\n});\n```\n\n## Using BYOK (Bring Your Own Key) with Resumed Sessions\n\nWhen using your own API keys, you must re-provide the provider configuration when resuming. API keys are never persisted to disk for security reasons.\n\n```typescript\n// Original session with BYOK\nconst session = await client.createSession({\n sessionId: \"user-123-task-456\",\n model: \"gpt-5.2-codex\",\n provider: {\n type: \"azure\",\n endpoint: \"https://my-resource.openai.azure.com\",\n apiKey: process.env.AZURE_OPENAI_KEY,\n deploymentId: \"my-gpt-deployment\",\n },\n});\n\n// When resuming, you MUST re-provide the provider config\nconst resumed = await client.resumeSession(\"user-123-task-456\", {\n provider: {\n type: \"azure\",\n endpoint: \"https://my-resource.openai.azure.com\",\n apiKey: process.env.AZURE_OPENAI_KEY, // Required again\n deploymentId: \"my-gpt-deployment\",\n },\n});\n```\n\n## What Gets Persisted?\n\nSession state is saved to `~/.copilot/session-state/{sessionId}/`:\n\n```\n~/.copilot/session-state/\n└── user-123-task-456/\n ├── checkpoints/ # Conversation history snapshots\n │ ├── 001.json # Initial state\n │ ├── 002.json # After first interaction\n │ └── ... # Incremental checkpoints\n ├── plan.md # Agent's planning state (if any)\n └── files/ # Session artifacts\n ├── analysis.md # Files the agent created\n └── notes.txt # Working documents\n```\n\n| Data | Persisted? | Notes |\n|------|------------|-------|\n| Conversation history | ✅ Yes | Full message thread |\n| Tool call results | ✅ Yes | Cached for context |\n| Agent planning state | ✅ Yes | `plan.md` file |\n| Session artifacts | ✅ Yes | In `files/` directory |\n| Provider/API keys | ❌ No | Security: must re-provide |\n| In-memory tool state | ❌ No | Tools should be stateless |\n\n## Session ID Best Practices\n\nChoose session IDs that encode ownership and purpose. This makes auditing and cleanup much easier.\n\n| Pattern | Example | Use Case |\n|---------|---------|----------|\n| ❌ `abc123` | Random IDs | Hard to audit, no ownership info |\n| ✅ `user-{userId}-{taskId}` | `user-alice-pr-review-42` | Multi-user apps |\n| ✅ `tenant-{tenantId}-{workflow}` | `tenant-acme-onboarding` | Multi-tenant SaaS |\n| ✅ `{userId}-{taskId}-{timestamp}` | `alice-deploy-1706932800` | Time-based cleanup |\n\n**Benefits of structured IDs:**\n- Easy to audit: \"Show all sessions for user alice\"\n- Easy to clean up: \"Delete all sessions older than X\"\n- Natural access control: Parse user ID from session ID\n\n### Example: Generating Session IDs\n\n```typescript\nfunction createSessionId(userId: string, taskType: string): string {\n const timestamp = Date.now();\n return `${userId}-${taskType}-${timestamp}`;\n}\n\nconst sessionId = createSessionId(\"alice\", \"code-review\");\n// → \"alice-code-review-1706932800000\"\n```\n\n```python\nimport time\n\ndef create_session_id(user_id: str, task_type: str) -> str:\n timestamp = int(time.time())\n return f\"{user_id}-{task_type}-{timestamp}\"\n\nsession_id = create_session_id(\"alice\", \"code-review\")\n# → \"alice-code-review-1706932800\"\n```\n\n## Managing Session Lifecycle\n\n### Listing Active Sessions\n\n```typescript\n// List all sessions\nconst sessions = await client.listSessions();\nconsole.log(`Found ${sessions.length} sessions`);\n\nfor (const session of sessions) {\n console.log(`- ${session.sessionId} (created: ${session.createdAt})`);\n}\n\n// Filter sessions by repository\nconst repoSessions = await client.listSessions({ repository: \"owner/repo\" });\n```\n\n### Cleaning Up Old Sessions\n\n```typescript\nasync function cleanupExpiredSessions(maxAgeMs: number) {\n const sessions = await client.listSessions();\n const now = Date.now();\n \n for (const session of sessions) {\n const age = now - new Date(session.createdAt).getTime();\n if (age > maxAgeMs) {\n await client.deleteSession(session.sessionId);\n console.log(`Deleted expired session: ${session.sessionId}`);\n }\n }\n}\n\n// Clean up sessions older than 24 hours\nawait cleanupExpiredSessions(24 * 60 * 60 * 1000);\n```\n\n### Disconnecting from a Session (`disconnect`)\n\nWhen a task completes, disconnect from the session explicitly rather than waiting for timeouts. This releases in-memory resources but **preserves session data on disk**, so the session can still be resumed later:\n\n```typescript\ntry {\n // Do work...\n await session.sendAndWait({ prompt: \"Complete the task\" });\n \n // Task complete — release in-memory resources (session can be resumed later)\n await session.disconnect();\n} catch (error) {\n // Clean up even on error\n await session.disconnect();\n throw error;\n}\n```\n\nEach SDK also provides idiomatic automatic cleanup patterns:\n\n| Language | Pattern | Example |\n|----------|---------|---------|\n| **TypeScript** | `Symbol.asyncDispose` | `await using session = await client.createSession(config);` |\n| **Python** | `async with` context manager | `async with await client.create_session(on_permission_request=handler) as session:` |\n| **C#** | `IAsyncDisposable` | `await using var session = await client.CreateSessionAsync(config);` |\n| **Go** | `defer` | `defer session.Disconnect()` |\n\n> **Note:** `destroy()` is deprecated in favor of `disconnect()`. Existing code using `destroy()` will continue to work but should be migrated.\n\n### Permanently Deleting a Session (`deleteSession`)\n\nTo permanently remove a session and all its data from disk (conversation history, planning state, artifacts), use `deleteSession`. This is irreversible — the session **cannot** be resumed after deletion:\n\n```typescript\n// Permanently remove session data\nawait client.deleteSession(\"user-123-task-456\");\n```\n\n> **`disconnect()` vs `deleteSession()`:** `disconnect()` releases in-memory resources but keeps session data on disk for later resumption. `deleteSession()` permanently removes everything, including files on disk.\n\n## Automatic Cleanup: Idle Timeout\n\nBy default, sessions have **no idle timeout** and live indefinitely until explicitly disconnected or deleted. You can optionally configure a server-wide idle timeout via `CopilotClientOptions.sessionIdleTimeoutSeconds`:\n\n```typescript\nconst client = new CopilotClient({\n sessionIdleTimeoutSeconds: 30 * 60, // 30 minutes\n});\n```\n\nWhen a timeout is configured, sessions without activity for that duration are automatically cleaned up. Set to `0` or omit to disable.\n\n> **Note:** This option only applies when the SDK spawns the runtime process. When connecting to an existing server via `cliUrl`, the server's own timeout configuration applies.\n\n```mermaid\nflowchart LR\n A[\"⚡ Last Activity\"] --> B[\"⏳ ~5 min before
timeout_warning\"] --> C[\"🧹 Timeout
destroyed\"]\n```\n\nSessions with active work (running commands, background agents) are always protected from idle cleanup, regardless of the timeout setting.\n\nListen for idle events to react to session inactivity:\n\n```typescript\nsession.on(\"session.idle\", (event) => {\n console.log(`Session idle for ${event.idleDurationMs}ms`);\n});\n```\n\n## Deployment Patterns\n\n### Pattern 1: One CLI Server Per User (Recommended)\n\nBest for: Strong isolation, multi-tenant environments, Azure Dynamic Sessions.\n\n```mermaid\nflowchart LR\n subgraph Users[\" \"]\n UA[User A] --> CA[CLI A]\n UB[User B] --> CB[CLI B]\n UC[User C] --> CC[CLI C]\n end\n CA --> SA[(Storage A)]\n CB --> SB[(Storage B)]\n CC --> SC[(Storage C)]\n```\n\n**Benefits:** ✅ Complete isolation | ✅ Simple security | ✅ Easy scaling\n\n### Pattern 2: Shared CLI Server (Resource Efficient)\n\nBest for: Internal tools, trusted environments, resource-constrained setups.\n\n```mermaid\nflowchart LR\n UA[User A] --> CLI\n UB[User B] --> CLI\n UC[User C] --> CLI\n CLI[🖥️ Shared CLI] --> SA[Session A]\n CLI --> SB[Session B]\n CLI --> SC[Session C]\n```\n\n**Requirements:**\n- ⚠️ Unique session IDs per user\n- ⚠️ Application-level access control\n- ⚠️ Session ID validation before operations\n\n```typescript\n// Application-level access control for shared CLI\nasync function resumeSessionWithAuth(\n client: CopilotClient,\n sessionId: string,\n currentUserId: string\n): Promise {\n // Parse user from session ID\n const [sessionUserId] = sessionId.split(\"-\");\n \n if (sessionUserId !== currentUserId) {\n throw new Error(\"Access denied: session belongs to another user\");\n }\n \n return client.resumeSession(sessionId);\n}\n```\n\n## Azure Dynamic Sessions\n\nFor serverless/container deployments where containers can restart or migrate:\n\n### Mount Persistent Storage\n\nThe session state directory must be mounted to persistent storage:\n\n```yaml\n# Azure Container Instance example\ncontainers:\n - name: copilot-agent\n image: my-agent:latest\n volumeMounts:\n - name: session-storage\n mountPath: /home/app/.copilot/session-state\n\nvolumes:\n - name: session-storage\n azureFile:\n shareName: copilot-sessions\n storageAccountName: myaccount\n```\n\n```mermaid\nflowchart LR\n subgraph Before[\"Container A\"]\n CLI1[CLI + Session X]\n end\n \n CLI1 --> |persist| Azure[(☁️ Azure File Share)]\n Azure --> |restore| CLI2\n \n subgraph After[\"Container B (restart)\"]\n CLI2[CLI + Session X]\n end\n```\n\n**Session survives container restarts!**\n\n## Infinite Sessions for Long-Running Workflows\n\nFor workflows that might exceed context limits, enable infinite sessions with automatic compaction:\n\n```typescript\nconst session = await client.createSession({\n sessionId: \"long-workflow-123\",\n infiniteSessions: {\n enabled: true,\n backgroundCompactionThreshold: 0.80, // Start compaction at 80% context\n bufferExhaustionThreshold: 0.95, // Block at 95% if needed\n },\n});\n```\n\n> **Note:** Thresholds are context utilization ratios (0.0-1.0), not absolute token counts. See the [Compatibility Guide](../troubleshooting/compatibility.md) for details.\n\n## Limitations & Considerations\n\n| Limitation | Description | Mitigation |\n|------------|-------------|------------|\n| **BYOK re-authentication** | API keys aren't persisted | Store keys in your secret manager; provide on resume |\n| **Writable storage** | `~/.copilot/session-state/` must be writable | Mount persistent volume in containers |\n| **No session locking** | Concurrent access to same session is undefined | Implement application-level locking or queue |\n| **Tool state not persisted** | In-memory tool state is lost | Design tools to be stateless or persist their own state |\n\n### Handling Concurrent Access\n\nThe SDK doesn't provide built-in session locking. If multiple clients might access the same session:\n\n```typescript\n// Option 1: Application-level locking with Redis\nimport Redis from \"ioredis\";\n\nconst redis = new Redis();\n\nasync function withSessionLock(\n sessionId: string,\n fn: () => Promise\n): Promise {\n const lockKey = `session-lock:${sessionId}`;\n const acquired = await redis.set(lockKey, \"locked\", \"NX\", \"EX\", 300);\n \n if (!acquired) {\n throw new Error(\"Session is in use by another client\");\n }\n \n try {\n return await fn();\n } finally {\n await redis.del(lockKey);\n }\n}\n\n// Usage\nawait withSessionLock(\"user-123-task-456\", async () => {\n const session = await client.resumeSession(\"user-123-task-456\");\n await session.sendAndWait({ prompt: \"Continue the task\" });\n});\n```\n\n## Summary\n\n| Feature | How to Use |\n|---------|------------|\n| **Create resumable session** | Provide your own `sessionId` |\n| **Resume session** | `client.resumeSession(sessionId)` |\n| **BYOK resume** | Re-provide `provider` config |\n| **List sessions** | `client.listSessions(filter?)` |\n| **Disconnect from active session** | `session.disconnect()` — releases in-memory resources; session data on disk is preserved for resumption |\n| **Delete session permanently** | `client.deleteSession(sessionId)` — permanently removes all session data from disk; cannot be resumed |\n| **Containerized deployment** | Mount `~/.copilot/session-state/` to persistent storage |\n\n## Next Steps\n\n- [Hooks Overview](../hooks/index.md) - Customize session behavior with hooks\n- [Compatibility Guide](../troubleshooting/compatibility.md) - SDK vs CLI feature comparison\n- [Debugging Guide](../troubleshooting/debugging.md) - Troubleshoot session issues\n" }, { "path": "docs/features/skills.md", "content": "# Custom Skills\n\nSkills are reusable prompt modules that extend Copilot's capabilities. Load skills from directories to give Copilot specialized abilities for specific domains or workflows.\n\n## Overview\n\nA skill is a named directory containing a `SKILL.md` file — a markdown document that provides instructions to Copilot. When loaded, the skill's content is injected into the session context.\n\nSkills allow you to:\n- Package domain expertise into reusable modules\n- Share specialized behaviors across projects\n- Organize complex agent configurations\n- Enable/disable capabilities per session\n\n## Loading Skills\n\nSpecify directories containing skills when creating a session:\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\nconst session = await client.createSession({\n model: \"gpt-4.1\",\n skillDirectories: [\n \"./skills/code-review\",\n \"./skills/documentation\",\n ],\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n\n// Copilot now has access to skills in those directories\nawait session.sendAndWait({ prompt: \"Review this code for security issues\" });\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionRequestResult\n\nasync def main():\n client = CopilotClient()\n await client.start()\n\n session = await client.create_session(\n on_permission_request=lambda req, inv: {\"kind\": \"approved\"},\n model=\"gpt-4.1\",\n skill_directories=[\n \"./skills/code-review\",\n \"./skills/documentation\",\n ],\n )\n\n # Copilot now has access to skills in those directories\n await session.send_and_wait(\"Review this code for security issues\")\n\n await client.stop()\n```\n\n
\n\n
\nGo\n\n```go\npackage main\n\nimport (\n \"context\"\n \"log\"\n copilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n client := copilot.NewClient(nil)\n if err := client.Start(ctx); err != nil {\n log.Fatal(err)\n }\n defer client.Stop()\n\n session, err := client.CreateSession(ctx, &copilot.SessionConfig{\n Model: \"gpt-4.1\",\n SkillDirectories: []string{\n \"./skills/code-review\",\n \"./skills/documentation\",\n },\n OnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n return copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n\n // Copilot now has access to skills in those directories\n _, err = session.SendAndWait(ctx, copilot.MessageOptions{\n Prompt: \"Review this code for security issues\",\n })\n if err != nil {\n log.Fatal(err)\n }\n}\n```\n\n
\n\n
\n.NET\n\n```csharp\nusing GitHub.Copilot.SDK;\n\nawait using var client = new CopilotClient();\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-4.1\",\n SkillDirectories = new List\n {\n \"./skills/code-review\",\n \"./skills/documentation\",\n },\n OnPermissionRequest = (req, inv) =>\n Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved }),\n});\n\n// Copilot now has access to skills in those directories\nawait session.SendAndWaitAsync(new MessageOptions\n{\n Prompt = \"Review this code for security issues\"\n});\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\nimport java.util.List;\n\ntry (var client = new CopilotClient()) {\n client.start().get();\n\n var session = client.createSession(\n new SessionConfig()\n .setModel(\"gpt-4.1\")\n .setSkillDirectories(List.of(\n \"./skills/code-review\",\n \"./skills/documentation\"\n ))\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n ).get();\n\n // Copilot now has access to skills in those directories\n session.sendAndWait(new MessageOptions()\n .setPrompt(\"Review this code for security issues\")\n ).get();\n}\n```\n\n
\n\n## Disabling Skills\n\nDisable specific skills while keeping others active:\n\n
\nNode.js / TypeScript\n\n```typescript\nconst session = await client.createSession({\n skillDirectories: [\"./skills\"],\n disabledSkills: [\"experimental-feature\", \"deprecated-tool\"],\n});\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot.session import PermissionHandler\n\nsession = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n skill_directories=[\"./skills\"],\n disabled_skills=[\"experimental-feature\", \"deprecated-tool\"],\n)\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclient := copilot.NewClient(nil)\n\n\tsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tSkillDirectories: []string{\"./skills\"},\n\t\tDisabledSkills: []string{\"experimental-feature\", \"deprecated-tool\"},\n\t\tOnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n\t\t},\n\t})\n\t_ = session\n}\n```\n\n\n```go\nsession, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{\n SkillDirectories: []string{\"./skills\"},\n DisabledSkills: []string{\"experimental-feature\", \"deprecated-tool\"},\n})\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic static class SkillsExample\n{\n public static async Task Main()\n {\n await using var client = new CopilotClient();\n\n var session = await client.CreateSessionAsync(new SessionConfig\n {\n SkillDirectories = new List { \"./skills\" },\n DisabledSkills = new List { \"experimental-feature\", \"deprecated-tool\" },\n OnPermissionRequest = (req, inv) =>\n Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved }),\n });\n }\n}\n```\n\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n SkillDirectories = new List { \"./skills\" },\n DisabledSkills = new List { \"experimental-feature\", \"deprecated-tool\" },\n});\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.json.*;\nimport java.util.List;\n\nvar session = client.createSession(\n new SessionConfig()\n .setSkillDirectories(List.of(\"./skills\"))\n .setDisabledSkills(List.of(\"experimental-feature\", \"deprecated-tool\"))\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n).get();\n```\n\n
\n\n## Skill Directory Structure\n\nEach skill is a named subdirectory containing a `SKILL.md` file:\n\n```\nskills/\n├── code-review/\n│ └── SKILL.md\n└── documentation/\n └── SKILL.md\n```\n\nThe `skillDirectories` option points to the parent directory (e.g., `./skills`). The CLI discovers all `SKILL.md` files in immediate subdirectories.\n\n### SKILL.md Format\n\nA `SKILL.md` file is a markdown document with optional YAML frontmatter:\n\n```markdown\n---\nname: code-review\ndescription: Specialized code review capabilities\n---\n\n# Code Review Guidelines\n\nWhen reviewing code, always check for:\n\n1. **Security vulnerabilities** - SQL injection, XSS, etc.\n2. **Performance issues** - N+1 queries, memory leaks\n3. **Code style** - Consistent formatting, naming conventions\n4. **Test coverage** - Are critical paths tested?\n\nProvide specific line-number references and suggested fixes.\n```\n\nThe frontmatter fields:\n- **`name`** — The skill's identifier (used with `disabledSkills` to selectively disable it). If omitted, the directory name is used.\n- **`description`** — A short description of what the skill does.\n\nThe markdown body contains the instructions that are injected into the session context when the skill is loaded.\n\n## Configuration Options\n\n### SessionConfig Skill Fields\n\n| Language | Field | Type | Description |\n|----------|-------|------|-------------|\n| Node.js | `skillDirectories` | `string[]` | Directories to load skills from |\n| Node.js | `disabledSkills` | `string[]` | Skills to disable |\n| Python | `skill_directories` | `list[str]` | Directories to load skills from |\n| Python | `disabled_skills` | `list[str]` | Skills to disable |\n| Go | `SkillDirectories` | `[]string` | Directories to load skills from |\n| Go | `DisabledSkills` | `[]string` | Skills to disable |\n| .NET | `SkillDirectories` | `List` | Directories to load skills from |\n| .NET | `DisabledSkills` | `List` | Skills to disable |\n\n## Best Practices\n\n1. **Organize by domain** - Group related skills together (e.g., `skills/security/`, `skills/testing/`)\n\n2. **Use frontmatter** - Include `name` and `description` in YAML frontmatter for clarity\n\n3. **Document dependencies** - Note any tools or MCP servers a skill requires\n\n4. **Test skills in isolation** - Verify skills work before combining them\n\n5. **Use relative paths** - Keep skills portable across environments\n\n## Combining with Other Features\n\n### Skills + Custom Agents\n\nSkills listed in an agent's `skills` field are **eagerly preloaded** — their full content is injected into the agent's context at startup, so the agent has access to the skill instructions immediately without needing to invoke a skill tool. Skill names are resolved from the session-level `skillDirectories`.\n\n```typescript\nconst session = await client.createSession({\n skillDirectories: [\"./skills/security\"],\n customAgents: [{\n name: \"security-auditor\",\n description: \"Security-focused code reviewer\",\n prompt: \"Focus on OWASP Top 10 vulnerabilities\",\n skills: [\"security-scan\", \"dependency-check\"],\n }],\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n```\n> **Note:** Skills are opt-in — when `skills` is omitted, no skill content is injected. Sub-agents do not inherit skills from the parent; you must list them explicitly per agent.\n\n### Skills + MCP Servers\n\nSkills can complement MCP server capabilities:\n\n```typescript\nconst session = await client.createSession({\n skillDirectories: [\"./skills/database\"],\n mcpServers: {\n postgres: {\n type: \"local\",\n command: \"npx\",\n args: [\"-y\", \"@modelcontextprotocol/server-postgres\"],\n tools: [\"*\"],\n },\n },\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n```\n\n## Troubleshooting\n\n### Skills Not Loading\n\n1. **Check path exists** - Verify the skill directory path is correct and contains subdirectories with `SKILL.md` files\n2. **Check permissions** - Ensure the SDK can read the directory\n3. **Check SKILL.md format** - Verify the markdown is well-formed and any YAML frontmatter uses valid syntax\n4. **Enable debug logging** - Set `logLevel: \"debug\"` to see skill loading logs\n\n### Skill Conflicts\n\nIf multiple skills provide conflicting instructions:\n- Use `disabledSkills` to exclude conflicting skills\n- Reorganize skill directories to avoid overlaps\n\n## See Also\n\n- [Custom Agents](../getting-started.md#create-custom-agents) - Define specialized AI personas\n- [Custom Tools](../getting-started.md#step-4-add-a-custom-tool) - Build your own tools\n- [MCP Servers](./mcp.md) - Connect external tool providers\n" }, { "path": "docs/features/steering-and-queueing.md", "content": "# Steering & Queueing\n\nTwo interaction patterns let users send messages while the agent is already working: **steering** redirects the agent mid-turn, and **queueing** buffers messages for sequential processing after the current turn completes.\n\n## Overview\n\nWhen a session is actively processing a turn, incoming messages can be delivered in one of two modes via the `mode` field on `MessageOptions`:\n\n| Mode | Behavior | Use case |\n|------|----------|----------|\n| `\"immediate\"` (steering) | Injected into the **current** LLM turn | \"Actually, don't create that file — use a different approach\" |\n| `\"enqueue\"` (queueing) | Queued and processed **after** the current turn finishes | \"After this, also fix the tests\" |\n\n```mermaid\nsequenceDiagram\n participant U as User\n participant S as Session\n participant LLM as Agent\n\n U->>S: send({ prompt: \"Refactor auth\" })\n S->>LLM: Turn starts\n\n Note over U,LLM: Agent is busy...\n\n U->>S: send({ prompt: \"Use JWT instead\", mode: \"immediate\" })\n S-->>LLM: Injected into current turn (steering)\n\n U->>S: send({ prompt: \"Then update the docs\", mode: \"enqueue\" })\n S-->>S: Queued for next turn\n\n LLM->>S: Turn completes (incorporates steering)\n S->>LLM: Processes queued message\n LLM->>S: Turn completes\n```\n\n## Steering (Immediate Mode)\n\nSteering sends a message that is injected directly into the agent's current turn. The agent sees the message in real time and adjusts its response accordingly — useful for course-correcting without aborting the turn.\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\nawait client.start();\n\nconst session = await client.createSession({\n model: \"gpt-4.1\",\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n\n// Start a long-running task\nconst msgId = await session.send({\n prompt: \"Refactor the authentication module to use sessions\",\n});\n\n// While the agent is working, steer it\nawait session.send({\n prompt: \"Actually, use JWT tokens instead of sessions\",\n mode: \"immediate\",\n});\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionRequestResult\n\nasync def main():\n client = CopilotClient()\n await client.start()\n\n session = await client.create_session(\n on_permission_request=lambda req, inv: PermissionRequestResult(kind=\"approved\"),\n model=\"gpt-4.1\",\n )\n\n # Start a long-running task\n msg_id = await session.send({\n \"prompt\": \"Refactor the authentication module to use sessions\",\n })\n\n # While the agent is working, steer it\n await session.send({\n \"prompt\": \"Actually, use JWT tokens instead of sessions\",\n \"mode\": \"immediate\",\n })\n\n await client.stop()\n```\n\n
\n\n
\nGo\n\n```go\npackage main\n\nimport (\n \"context\"\n \"log\"\n copilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n ctx := context.Background()\n client := copilot.NewClient(nil)\n if err := client.Start(ctx); err != nil {\n log.Fatal(err)\n }\n defer client.Stop()\n\n session, err := client.CreateSession(ctx, &copilot.SessionConfig{\n Model: \"gpt-4.1\",\n OnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n return copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n\n // Start a long-running task\n _, err = session.Send(ctx, copilot.MessageOptions{\n Prompt: \"Refactor the authentication module to use sessions\",\n })\n if err != nil {\n log.Fatal(err)\n }\n\n // While the agent is working, steer it\n _, err = session.Send(ctx, copilot.MessageOptions{\n Prompt: \"Actually, use JWT tokens instead of sessions\",\n Mode: \"immediate\",\n })\n if err != nil {\n log.Fatal(err)\n }\n}\n```\n\n
\n\n
\n.NET\n\n```csharp\nusing GitHub.Copilot.SDK;\n\nawait using var client = new CopilotClient();\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-4.1\",\n OnPermissionRequest = (req, inv) =>\n Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved }),\n});\n\n// Start a long-running task\nvar msgId = await session.SendAsync(new MessageOptions\n{\n Prompt = \"Refactor the authentication module to use sessions\"\n});\n\n// While the agent is working, steer it\nawait session.SendAsync(new MessageOptions\n{\n Prompt = \"Actually, use JWT tokens instead of sessions\",\n Mode = \"immediate\"\n});\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\n\ntry (var client = new CopilotClient()) {\n client.start().get();\n\n var session = client.createSession(\n new SessionConfig()\n .setModel(\"gpt-4.1\")\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n ).get();\n\n // Start a long-running task\n session.send(new MessageOptions()\n .setPrompt(\"Refactor the authentication module to use sessions\")\n ).get();\n\n // While the agent is working, steer it\n session.send(new MessageOptions()\n .setPrompt(\"Actually, use JWT tokens instead of sessions\")\n .setMode(\"immediate\")\n ).get();\n}\n```\n\n
\n\n### How Steering Works Internally\n\n1. The message is added to the runtime's `ImmediatePromptProcessor` queue\n2. Before the next LLM request within the current turn, the processor injects the message into the conversation\n3. The agent sees the steering message as a new user message and adjusts its response\n4. If the turn completes before the steering message is processed, it is automatically moved to the regular queue for the next turn\n\n> **Note:** Steering messages are best-effort within the current turn. If the agent has already committed to a tool call, the steering takes effect after that call completes but still within the same turn.\n\n## Queueing (Enqueue Mode)\n\nQueueing buffers messages to be processed sequentially after the current turn finishes. Each queued message starts its own full turn. This is the default mode — if you omit `mode`, the SDK uses `\"enqueue\"`.\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\nawait client.start();\n\nconst session = await client.createSession({\n model: \"gpt-4.1\",\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n\n// Send an initial task\nawait session.send({ prompt: \"Set up the project structure\" });\n\n// Queue follow-up tasks while the agent is busy\nawait session.send({\n prompt: \"Add unit tests for the auth module\",\n mode: \"enqueue\",\n});\n\nawait session.send({\n prompt: \"Update the README with setup instructions\",\n mode: \"enqueue\",\n});\n\n// Messages are processed in FIFO order after each turn completes\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionRequestResult\n\nasync def main():\n client = CopilotClient()\n await client.start()\n\n session = await client.create_session(\n on_permission_request=lambda req, inv: PermissionRequestResult(kind=\"approved\"),\n model=\"gpt-4.1\",\n )\n\n # Send an initial task\n await session.send({\"prompt\": \"Set up the project structure\"})\n\n # Queue follow-up tasks while the agent is busy\n await session.send({\n \"prompt\": \"Add unit tests for the auth module\",\n \"mode\": \"enqueue\",\n })\n\n await session.send({\n \"prompt\": \"Update the README with setup instructions\",\n \"mode\": \"enqueue\",\n })\n\n # Messages are processed in FIFO order after each turn completes\n await client.stop()\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclient := copilot.NewClient(nil)\n\tclient.Start(ctx)\n\n\tsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"gpt-4.1\",\n\t\tOnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n\t\t},\n\t})\n\n\tsession.Send(ctx, copilot.MessageOptions{\n\t\tPrompt: \"Set up the project structure\",\n\t})\n\n\tsession.Send(ctx, copilot.MessageOptions{\n\t\tPrompt: \"Add unit tests for the auth module\",\n\t\tMode: \"enqueue\",\n\t})\n\n\tsession.Send(ctx, copilot.MessageOptions{\n\t\tPrompt: \"Update the README with setup instructions\",\n\t\tMode: \"enqueue\",\n\t})\n}\n```\n\n\n```go\n// Send an initial task\nsession.Send(ctx, copilot.MessageOptions{\n Prompt: \"Set up the project structure\",\n})\n\n// Queue follow-up tasks while the agent is busy\nsession.Send(ctx, copilot.MessageOptions{\n Prompt: \"Add unit tests for the auth module\",\n Mode: \"enqueue\",\n})\n\nsession.Send(ctx, copilot.MessageOptions{\n Prompt: \"Update the README with setup instructions\",\n Mode: \"enqueue\",\n})\n\n// Messages are processed in FIFO order after each turn completes\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic static class QueueingExample\n{\n public static async Task Main()\n {\n await using var client = new CopilotClient();\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"gpt-4.1\",\n OnPermissionRequest = (req, inv) =>\n Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved }),\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Set up the project structure\"\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Add unit tests for the auth module\",\n Mode = \"enqueue\"\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Update the README with setup instructions\",\n Mode = \"enqueue\"\n });\n }\n}\n```\n\n\n```csharp\n// Send an initial task\nawait session.SendAsync(new MessageOptions\n{\n Prompt = \"Set up the project structure\"\n});\n\n// Queue follow-up tasks while the agent is busy\nawait session.SendAsync(new MessageOptions\n{\n Prompt = \"Add unit tests for the auth module\",\n Mode = \"enqueue\"\n});\n\nawait session.SendAsync(new MessageOptions\n{\n Prompt = \"Update the README with setup instructions\",\n Mode = \"enqueue\"\n});\n\n// Messages are processed in FIFO order after each turn completes\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\n\ntry (var client = new CopilotClient()) {\n client.start().get();\n\n var session = client.createSession(\n new SessionConfig()\n .setModel(\"gpt-4.1\")\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n ).get();\n\n // Send an initial task\n session.send(new MessageOptions().setPrompt(\"Set up the project structure\")).get();\n\n // Queue follow-up tasks while the agent is busy\n session.send(new MessageOptions()\n .setPrompt(\"Add unit tests for the auth module\")\n .setMode(\"enqueue\")\n ).get();\n\n session.send(new MessageOptions()\n .setPrompt(\"Update the README with setup instructions\")\n .setMode(\"enqueue\")\n ).get();\n\n // Messages are processed in FIFO order after each turn completes\n}\n```\n\n
\n\n### How Queueing Works Internally\n\n1. The message is added to the session's `itemQueue` as a `QueuedItem`\n2. When the current turn completes and the session becomes idle, `processQueuedItems()` runs\n3. Items are dequeued in FIFO order — each message triggers a full agentic turn\n4. If a steering message was pending when the turn ended, it is moved to the front of the queue\n5. Processing continues until the queue is empty, then the session emits an idle event\n\n## Combining Steering and Queueing\n\nYou can use both patterns together in a single session. Steering affects the current turn while queued messages wait for their own turns:\n\n
\nNode.js / TypeScript\n\n```typescript\nconst session = await client.createSession({\n model: \"gpt-4.1\",\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n\n// Start a task\nawait session.send({ prompt: \"Refactor the database layer\" });\n\n// Steer the current work\nawait session.send({\n prompt: \"Make sure to keep backwards compatibility with the v1 API\",\n mode: \"immediate\",\n});\n\n// Queue a follow-up for after this turn\nawait session.send({\n prompt: \"Now add migration scripts for the schema changes\",\n mode: \"enqueue\",\n});\n```\n\n
\n\n
\nPython\n\n```python\nsession = await client.create_session(\n on_permission_request=lambda req, inv: PermissionRequestResult(kind=\"approved\"),\n model=\"gpt-4.1\",\n)\n\n# Start a task\nawait session.send({\"prompt\": \"Refactor the database layer\"})\n\n# Steer the current work\nawait session.send({\n \"prompt\": \"Make sure to keep backwards compatibility with the v1 API\",\n \"mode\": \"immediate\",\n})\n\n# Queue a follow-up for after this turn\nawait session.send({\n \"prompt\": \"Now add migration scripts for the schema changes\",\n \"mode\": \"enqueue\",\n})\n```\n\n
\n\n## Choosing Between Steering and Queueing\n\n| Scenario | Pattern | Why |\n|----------|---------|-----|\n| Agent is going down the wrong path | **Steering** | Redirects the current turn without losing progress |\n| You thought of something the agent should also do | **Queueing** | Doesn't disrupt current work; runs next |\n| Agent is about to make a mistake | **Steering** | Intervenes before the mistake is committed |\n| You want to chain multiple tasks | **Queueing** | FIFO ordering ensures predictable execution |\n| You want to add context to the current task | **Steering** | Agent incorporates it into its current reasoning |\n| You want to batch unrelated requests | **Queueing** | Each gets its own full turn with clean context |\n\n## Building a UI with Steering & Queueing\n\nHere's a pattern for building an interactive UI that supports both modes:\n\n```typescript\nimport { CopilotClient, CopilotSession } from \"@github/copilot-sdk\";\n\ninterface PendingMessage {\n prompt: string;\n mode: \"immediate\" | \"enqueue\";\n sentAt: Date;\n}\n\nclass InteractiveChat {\n private session: CopilotSession;\n private isProcessing = false;\n private pendingMessages: PendingMessage[] = [];\n\n constructor(session: CopilotSession) {\n this.session = session;\n\n session.on((event) => {\n if (event.type === \"session.idle\") {\n this.isProcessing = false;\n this.onIdle();\n }\n if (event.type === \"assistant.message\") {\n this.renderMessage(event);\n }\n });\n }\n\n async sendMessage(prompt: string): Promise {\n if (!this.isProcessing) {\n this.isProcessing = true;\n await this.session.send({ prompt });\n return;\n }\n\n // Session is busy — let the user choose how to deliver\n // Your UI would present this choice (e.g., buttons, keyboard shortcuts)\n }\n\n async steer(prompt: string): Promise {\n this.pendingMessages.push({\n prompt,\n mode: \"immediate\",\n sentAt: new Date(),\n });\n await this.session.send({ prompt, mode: \"immediate\" });\n }\n\n async enqueue(prompt: string): Promise {\n this.pendingMessages.push({\n prompt,\n mode: \"enqueue\",\n sentAt: new Date(),\n });\n await this.session.send({ prompt, mode: \"enqueue\" });\n }\n\n private onIdle(): void {\n this.pendingMessages = [];\n // Update UI to show session is ready for new input\n }\n\n private renderMessage(event: unknown): void {\n // Render assistant message in your UI\n }\n}\n```\n\n## API Reference\n\n### MessageOptions\n\n| Language | Field | Type | Default | Description |\n|----------|-------|------|---------|-------------|\n| Node.js | `mode` | `\"enqueue\" \\| \"immediate\"` | `\"enqueue\"` | Message delivery mode |\n| Python | `mode` | `Literal[\"enqueue\", \"immediate\"]` | `\"enqueue\"` | Message delivery mode |\n| Go | `Mode` | `string` | `\"enqueue\"` | Message delivery mode |\n| .NET | `Mode` | `string?` | `\"enqueue\"` | Message delivery mode |\n\n### Delivery Modes\n\n| Mode | Effect | During active turn | During idle |\n|------|--------|-------------------|-------------|\n| `\"enqueue\"` | Queue for next turn | Waits in FIFO queue | Starts a new turn immediately |\n| `\"immediate\"` | Inject into current turn | Injected before next LLM call | Starts a new turn immediately |\n\n> **Note:** When the session is idle (not processing), both modes behave identically — the message starts a new turn immediately.\n\n## Best Practices\n\n1. **Default to queueing** — Use `\"enqueue\"` (or omit `mode`) for most messages. It's predictable and doesn't risk disrupting in-progress work.\n\n2. **Reserve steering for corrections** — Use `\"immediate\"` when the agent is actively doing the wrong thing and you need to redirect it before it goes further.\n\n3. **Keep steering messages concise** — The agent needs to quickly understand the course correction. Long, complex steering messages may confuse the current context.\n\n4. **Don't over-steer** — Multiple rapid steering messages can degrade turn quality. If you need to change direction significantly, consider aborting the turn and starting fresh.\n\n5. **Show queue state in your UI** — Display the number of queued messages so users know what's pending. Listen for idle events to clear the display.\n\n6. **Handle the steering-to-queue fallback** — If a steering message arrives after the turn completes, it's automatically moved to the queue. Design your UI to reflect this transition.\n\n## See Also\n\n- [Getting Started](../getting-started.md) — Set up a session and send messages\n- [Custom Agents](./custom-agents.md) — Define specialized agents with scoped tools\n- [Session Hooks](../hooks/index.md) — React to session lifecycle events\n- [Session Persistence](./session-persistence.md) — Resume sessions across restarts\n" }, { "path": "docs/features/streaming-events.md", "content": "# Streaming Session Events\n\nEvery action the Copilot agent takes — thinking, writing code, running tools — is emitted as a **session event** you can subscribe to. This guide is a field-level reference for each event type so you know exactly what data to expect without reading the SDK source.\n\n## Overview\n\nWhen `streaming: true` is set on a session, the SDK emits **ephemeral** events in real time (deltas, progress updates) alongside **persisted** events (complete messages, tool results). All events share a common envelope and carry a `data` payload whose shape depends on the event `type`.\n\n```mermaid\nsequenceDiagram\n participant App as Your App\n participant SDK as SDK Session\n participant Agent as Copilot Agent\n\n App->>SDK: send({ prompt })\n SDK->>Agent: JSON-RPC\n\n Agent-->>SDK: assistant.turn_start\n SDK-->>App: event\n\n loop Streaming response\n Agent-->>SDK: assistant.message_delta (ephemeral)\n SDK-->>App: event\n end\n\n Agent-->>SDK: assistant.message\n SDK-->>App: event\n\n loop Tool execution\n Agent-->>SDK: tool.execution_start\n SDK-->>App: event\n Agent-->>SDK: tool.execution_complete\n SDK-->>App: event\n end\n\n Agent-->>SDK: assistant.turn_end\n SDK-->>App: event\n\n Agent-->>SDK: session.idle (ephemeral)\n SDK-->>App: event\n```\n\n| Concept | Description |\n|---------|-------------|\n| **Ephemeral event** | Transient; streamed in real time but **not** persisted to the session log. Not replayed on session resume. |\n| **Persisted event** | Saved to the session event log on disk. Replayed when resuming a session. |\n| **Delta event** | An ephemeral streaming chunk (text or reasoning). Accumulate deltas to build the complete content. |\n| **`parentId` chain** | Each event's `parentId` points to the previous event, forming a linked list you can walk. |\n\n## Event Envelope\n\nEvery session event, regardless of type, includes these fields:\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `id` | `string` (UUID v4) | Unique event identifier |\n| `timestamp` | `string` (ISO 8601) | When the event was created |\n| `parentId` | `string \\| null` | ID of the previous event in the chain; `null` for the first event |\n| `ephemeral` | `boolean?` | `true` for transient events; absent or `false` for persisted events |\n| `type` | `string` | Event type discriminator (see tables below) |\n| `data` | `object` | Event-specific payload |\n\n## Subscribing to Events\n\n
\nNode.js / TypeScript\n\n```typescript\n// All events\nsession.on((event) => {\n console.log(event.type, event.data);\n});\n\n// Specific event type — data is narrowed automatically\nsession.on(\"assistant.message_delta\", (event) => {\n process.stdout.write(event.data.deltaContent);\n});\n```\n\n
\n\n
\nPython\n\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.generated.session_events import SessionEventType\n\nclient = CopilotClient()\n\nsession = None # assume session is created elsewhere\n\ndef handle(event):\n if event.type == SessionEventType.ASSISTANT_MESSAGE_DELTA:\n print(event.data.delta_content, end=\"\", flush=True)\n\n# session.on(handle)\n```\n\n\n```python\nfrom copilot.generated.session_events import SessionEventType\n\ndef handle(event):\n if event.type == SessionEventType.ASSISTANT_MESSAGE_DELTA:\n print(event.data.delta_content, end=\"\", flush=True)\n\nsession.on(handle)\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclient := copilot.NewClient(nil)\n\n\tsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"gpt-4.1\",\n\t\tStreaming: true,\n\t\tOnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n\t\t},\n\t})\n\n\tsession.On(func(event copilot.SessionEvent) {\n\t\tif d, ok := event.Data.(*copilot.AssistantMessageDeltaData); ok {\n\t\t\tfmt.Print(d.DeltaContent)\n\t\t}\n\t})\n\t_ = session\n}\n```\n\n\n```go\nsession.On(func(event copilot.SessionEvent) {\n if d, ok := event.Data.(*copilot.AssistantMessageDeltaData); ok {\n fmt.Print(d.DeltaContent)\n }\n})\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic static class StreamingEventsExample\n{\n public static async Task Example(CopilotSession session)\n {\n session.On(evt =>\n {\n if (evt is AssistantMessageDeltaEvent delta)\n {\n Console.Write(delta.Data.DeltaContent);\n }\n });\n }\n}\n```\n\n\n```csharp\nsession.On(evt =>\n{\n if (evt is AssistantMessageDeltaEvent delta)\n {\n Console.Write(delta.Data.DeltaContent);\n }\n});\n```\n\n
\n\n
\nJava\n\n```java\n// All events\nsession.on(event -> System.out.println(event.getType()));\n\n// Specific event type — data is narrowed to the matching class\nsession.on(AssistantMessageDeltaEvent.class, event ->\n System.out.print(event.getData().deltaContent())\n);\n```\n\n
\n\n> **Tip (Python / Go):** These SDKs use a single `Data` class/struct with all possible fields as optional/nullable. Only the fields listed in the tables below are populated for each event type — the rest will be `None` / `nil`.\n>\n> **Tip (.NET):** The .NET SDK uses separate, strongly-typed data classes per event (e.g., `AssistantMessageDeltaData`), so only the relevant fields exist on each type.\n>\n> **Tip (TypeScript):** The TypeScript SDK uses a discriminated union — when you match on `event.type`, the `data` payload is automatically narrowed to the correct shape.\n\n---\n\n## Assistant Events\n\nThese events track the agent's response lifecycle — from turn start through streaming chunks to the final message.\n\n### `assistant.turn_start`\n\nEmitted when the agent begins processing a turn.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `turnId` | `string` | ✅ | Turn identifier (typically a stringified turn number) |\n| `interactionId` | `string` | | CAPI interaction ID for telemetry correlation |\n\n### `assistant.intent`\n\nEphemeral. Short description of what the agent is currently doing, updated as it works.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `intent` | `string` | ✅ | Human-readable intent (e.g., \"Exploring codebase\") |\n\n### `assistant.reasoning`\n\nComplete extended thinking block from the model. Emitted after reasoning is finished.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `reasoningId` | `string` | ✅ | Unique identifier for this reasoning block |\n| `content` | `string` | ✅ | The complete extended thinking text |\n\n### `assistant.reasoning_delta`\n\nEphemeral. Incremental chunk of the model's extended thinking, streamed in real time.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `reasoningId` | `string` | ✅ | Matches the corresponding `assistant.reasoning` event |\n| `deltaContent` | `string` | ✅ | Text chunk to append to reasoning content |\n\n### `assistant.message`\n\nThe assistant's complete response for this LLM call. May include tool invocation requests.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `messageId` | `string` | ✅ | Unique identifier for this message |\n| `content` | `string` | ✅ | The assistant's text response |\n| `toolRequests` | `ToolRequest[]` | | Tool calls the assistant wants to make (see below) |\n| `reasoningOpaque` | `string` | | Encrypted extended thinking (Anthropic models); session-bound |\n| `reasoningText` | `string` | | Readable reasoning text from extended thinking |\n| `encryptedContent` | `string` | | Encrypted reasoning content (OpenAI models); session-bound |\n| `phase` | `string` | | Generation phase (e.g., `\"thinking\"` vs `\"response\"`) |\n| `outputTokens` | `number` | | Actual output token count from the API response |\n| `interactionId` | `string` | | CAPI interaction ID for telemetry |\n| `parentToolCallId` | `string` | | Set when this message originates from a sub-agent |\n\n**`ToolRequest` fields:**\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `toolCallId` | `string` | ✅ | Unique ID for this tool call |\n| `name` | `string` | ✅ | Tool name (e.g., `\"bash\"`, `\"edit\"`, `\"grep\"`) |\n| `arguments` | `object` | | Parsed arguments for the tool |\n| `type` | `\"function\" \\| \"custom\"` | | Call type; defaults to `\"function\"` when absent |\n\n### `assistant.message_delta`\n\nEphemeral. Incremental chunk of the assistant's text response, streamed in real time.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `messageId` | `string` | ✅ | Matches the corresponding `assistant.message` event |\n| `deltaContent` | `string` | ✅ | Text chunk to append to the message |\n| `parentToolCallId` | `string` | | Set when originating from a sub-agent |\n\n### `assistant.turn_end`\n\nEmitted when the agent finishes a turn (all tool executions complete, final response delivered).\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `turnId` | `string` | ✅ | Matches the corresponding `assistant.turn_start` event |\n\n### `assistant.usage`\n\nEphemeral. Token usage and cost information for an individual API call.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `model` | `string` | ✅ | Model identifier (e.g., `\"gpt-4.1\"`) |\n| `inputTokens` | `number` | | Input tokens consumed |\n| `outputTokens` | `number` | | Output tokens produced |\n| `cacheReadTokens` | `number` | | Tokens read from prompt cache |\n| `cacheWriteTokens` | `number` | | Tokens written to prompt cache |\n| `cost` | `number` | | Model multiplier cost for billing |\n| `duration` | `number` | | API call duration in milliseconds |\n| `initiator` | `string` | | What triggered this call (e.g., `\"sub-agent\"`); absent for user-initiated |\n| `apiCallId` | `string` | | Completion ID from the provider (e.g., `chatcmpl-abc123`) |\n| `providerCallId` | `string` | | GitHub request tracing ID (`x-github-request-id`) |\n| `parentToolCallId` | `string` | | Set when usage originates from a sub-agent |\n| `quotaSnapshots` | `Record` | | Per-quota resource usage, keyed by quota identifier |\n| `copilotUsage` | `CopilotUsage` | | Itemized token cost breakdown from the API |\n\n### `assistant.streaming_delta`\n\nEphemeral. Low-level network progress indicator — total bytes received from the streaming API response.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `totalResponseSizeBytes` | `number` | ✅ | Cumulative bytes received so far |\n\n---\n\n## Tool Execution Events\n\nThese events track the full lifecycle of each tool invocation — from the model requesting a tool call through execution to completion.\n\n### `tool.execution_start`\n\nEmitted when a tool begins executing.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `toolCallId` | `string` | ✅ | Unique identifier for this tool call |\n| `toolName` | `string` | ✅ | Name of the tool (e.g., `\"bash\"`, `\"edit\"`, `\"grep\"`) |\n| `arguments` | `object` | | Parsed arguments passed to the tool |\n| `mcpServerName` | `string` | | MCP server name, when the tool is provided by an MCP server |\n| `mcpToolName` | `string` | | Original tool name on the MCP server |\n| `parentToolCallId` | `string` | | Set when invoked by a sub-agent |\n\n### `tool.execution_partial_result`\n\nEphemeral. Incremental output from a running tool (e.g., streaming bash output).\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `toolCallId` | `string` | ✅ | Matches the corresponding `tool.execution_start` |\n| `partialOutput` | `string` | ✅ | Incremental output chunk |\n\n### `tool.execution_progress`\n\nEphemeral. Human-readable progress status from a running tool (e.g., MCP server progress notifications).\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `toolCallId` | `string` | ✅ | Matches the corresponding `tool.execution_start` |\n| `progressMessage` | `string` | ✅ | Progress status message |\n\n### `tool.execution_complete`\n\nEmitted when a tool finishes executing — successfully or with an error.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `toolCallId` | `string` | ✅ | Matches the corresponding `tool.execution_start` |\n| `success` | `boolean` | ✅ | Whether execution succeeded |\n| `model` | `string` | | Model that generated this tool call |\n| `interactionId` | `string` | | CAPI interaction ID |\n| `isUserRequested` | `boolean` | | `true` when the user explicitly requested this tool call |\n| `result` | `Result` | | Present on success (see below) |\n| `error` | `{ message, code? }` | | Present on failure |\n| `toolTelemetry` | `object` | | Tool-specific telemetry (e.g., CodeQL check counts) |\n| `parentToolCallId` | `string` | | Set when invoked by a sub-agent |\n\n**`Result` fields:**\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `content` | `string` | ✅ | Concise result sent to the LLM (may be truncated for token efficiency) |\n| `detailedContent` | `string` | | Full result for display, preserving complete content like diffs |\n| `contents` | `ContentBlock[]` | | Structured content blocks (text, terminal, image, audio, resource) |\n\n### `tool.user_requested`\n\nEmitted when the user explicitly requests a tool invocation (rather than the model choosing to call one).\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `toolCallId` | `string` | ✅ | Unique identifier for this tool call |\n| `toolName` | `string` | ✅ | Name of the tool the user wants to invoke |\n| `arguments` | `object` | | Arguments for the invocation |\n\n---\n\n## Session Lifecycle Events\n\n### `session.idle`\n\nEphemeral. The agent has finished all processing and is ready for the next message. This is the signal that a turn is fully complete.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `backgroundTasks` | `BackgroundTasks` | | Background agents/shells still running when the agent became idle |\n\n### `session.error`\n\nAn error occurred during session processing.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `errorType` | `string` | ✅ | Error category (e.g., `\"authentication\"`, `\"quota\"`, `\"rate_limit\"`) |\n| `message` | `string` | ✅ | Human-readable error message |\n| `stack` | `string` | | Error stack trace |\n| `statusCode` | `number` | | HTTP status code from the upstream request |\n| `providerCallId` | `string` | | GitHub request tracing ID for server-side log correlation |\n\n### `session.compaction_start`\n\nContext window compaction has begun. **Data payload is empty (`{}`)**.\n\n### `session.compaction_complete`\n\nContext window compaction finished.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `success` | `boolean` | ✅ | Whether compaction succeeded |\n| `error` | `string` | | Error message if compaction failed |\n| `preCompactionTokens` | `number` | | Tokens before compaction |\n| `postCompactionTokens` | `number` | | Tokens after compaction |\n| `preCompactionMessagesLength` | `number` | | Message count before compaction |\n| `messagesRemoved` | `number` | | Messages removed |\n| `tokensRemoved` | `number` | | Tokens removed |\n| `summaryContent` | `string` | | LLM-generated summary of compacted history |\n| `checkpointNumber` | `number` | | Checkpoint snapshot number created for recovery |\n| `checkpointPath` | `string` | | File path where the checkpoint was stored |\n| `compactionTokensUsed` | `{ input, output, cachedInput }` | | Token usage for the compaction LLM call |\n| `requestId` | `string` | | GitHub request tracing ID for the compaction call |\n\n### `session.title_changed`\n\nEphemeral. The session's auto-generated title was updated.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `title` | `string` | ✅ | New session title |\n\n### `session.context_changed`\n\nThe session's working directory or repository context changed.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `cwd` | `string` | ✅ | Current working directory |\n| `gitRoot` | `string` | | Git repository root |\n| `repository` | `string` | | Repository in `\"owner/name\"` format |\n| `branch` | `string` | | Current git branch |\n\n### `session.usage_info`\n\nEphemeral. Context window utilization snapshot.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `tokenLimit` | `number` | ✅ | Maximum tokens for the model's context window |\n| `currentTokens` | `number` | ✅ | Current tokens in the context window |\n| `messagesLength` | `number` | ✅ | Current message count in the conversation |\n\n### `session.task_complete`\n\nThe agent has completed its assigned task.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `summary` | `string` | | Summary of the completed task |\n\n### `session.shutdown`\n\nThe session has ended.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `shutdownType` | `\"routine\" \\| \"error\"` | ✅ | Normal shutdown or crash |\n| `errorReason` | `string` | | Error description when `shutdownType` is `\"error\"` |\n| `totalPremiumRequests` | `number` | ✅ | Total premium API requests used |\n| `totalApiDurationMs` | `number` | ✅ | Cumulative API call time in milliseconds |\n| `sessionStartTime` | `number` | ✅ | Unix timestamp (ms) when the session started |\n| `codeChanges` | `{ linesAdded, linesRemoved, filesModified }` | ✅ | Aggregate code change metrics |\n| `modelMetrics` | `Record` | ✅ | Per-model usage breakdown |\n| `currentModel` | `string` | | Model selected at shutdown time |\n\n---\n\n## Permission & User Input Events\n\nThese events are emitted when the agent needs approval or input from the user before continuing.\n\n### `permission.requested`\n\nEphemeral. The agent needs permission to perform an action (run a command, write a file, etc.).\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `requestId` | `string` | ✅ | Use this to respond via `session.respondToPermission()` |\n| `permissionRequest` | `PermissionRequest` | ✅ | Details of the permission being requested |\n\nThe `permissionRequest` is a discriminated union on `kind`:\n\n| `kind` | Key Fields | Description |\n|--------|------------|-------------|\n| `\"shell\"` | `fullCommandText`, `intention`, `commands[]`, `possiblePaths[]` | Execute a shell command |\n| `\"write\"` | `fileName`, `diff`, `intention`, `newFileContents?` | Write/modify a file |\n| `\"read\"` | `path`, `intention` | Read a file or directory |\n| `\"mcp\"` | `serverName`, `toolName`, `toolTitle`, `args?`, `readOnly` | Call an MCP tool |\n| `\"url\"` | `url`, `intention` | Fetch a URL |\n| `\"memory\"` | `subject`, `fact`, `citations` | Store a memory |\n| `\"custom-tool\"` | `toolName`, `toolDescription`, `args?` | Call a custom tool |\n\nAll `kind` variants also include an optional `toolCallId` linking back to the tool call that triggered the request.\n\n### `permission.completed`\n\nEphemeral. A permission request was resolved.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `requestId` | `string` | ✅ | Matches the corresponding `permission.requested` |\n| `result.kind` | `string` | ✅ | One of: `\"approved\"`, `\"denied-by-rules\"`, `\"denied-interactively-by-user\"`, `\"denied-no-approval-rule-and-could-not-request-from-user\"`, `\"denied-by-content-exclusion-policy\"` |\n\n### `user_input.requested`\n\nEphemeral. The agent is asking the user a question.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `requestId` | `string` | ✅ | Use this to respond via `session.respondToUserInput()` |\n| `question` | `string` | ✅ | The question to present to the user |\n| `choices` | `string[]` | | Predefined choices for the user |\n| `allowFreeform` | `boolean` | | Whether free-form text input is allowed |\n\n### `user_input.completed`\n\nEphemeral. A user input request was resolved.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `requestId` | `string` | ✅ | Matches the corresponding `user_input.requested` |\n\n### `elicitation.requested`\n\nEphemeral. The agent needs structured form input from the user (MCP elicitation protocol).\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `requestId` | `string` | ✅ | Use this to respond via `session.respondToElicitation()` |\n| `message` | `string` | ✅ | Description of what information is needed |\n| `mode` | `\"form\"` | | Elicitation mode (currently only `\"form\"`) |\n| `requestedSchema` | `{ type: \"object\", properties, required? }` | ✅ | JSON Schema describing the form fields |\n\n### `elicitation.completed`\n\nEphemeral. An elicitation request was resolved.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `requestId` | `string` | ✅ | Matches the corresponding `elicitation.requested` |\n\n---\n\n## Sub-Agent & Skill Events\n\n### `subagent.started`\n\nA custom agent was invoked as a sub-agent.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `toolCallId` | `string` | ✅ | Parent tool call that spawned this sub-agent |\n| `agentName` | `string` | ✅ | Internal name of the sub-agent |\n| `agentDisplayName` | `string` | ✅ | Human-readable display name |\n| `agentDescription` | `string` | ✅ | Description of what the sub-agent does |\n\n### `subagent.completed`\n\nA sub-agent finished successfully.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `toolCallId` | `string` | ✅ | Matches the corresponding `subagent.started` |\n| `agentName` | `string` | ✅ | Internal name |\n| `agentDisplayName` | `string` | ✅ | Display name |\n\n### `subagent.failed`\n\nA sub-agent encountered an error.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `toolCallId` | `string` | ✅ | Matches the corresponding `subagent.started` |\n| `agentName` | `string` | ✅ | Internal name |\n| `agentDisplayName` | `string` | ✅ | Display name |\n| `error` | `string` | ✅ | Error message |\n\n### `subagent.selected`\n\nA custom agent was selected (inferred) to handle the current request.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `agentName` | `string` | ✅ | Internal name of the selected agent |\n| `agentDisplayName` | `string` | ✅ | Display name |\n| `tools` | `string[] \\| null` | ✅ | Tool names available to this agent; `null` for all tools |\n\n### `subagent.deselected`\n\nA custom agent was deselected, returning to the default agent. **Data payload is empty (`{}`)**.\n\n### `skill.invoked`\n\nA skill was activated for the current conversation.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `name` | `string` | ✅ | Skill name |\n| `path` | `string` | ✅ | File path to the SKILL.md definition |\n| `content` | `string` | ✅ | Full skill content injected into the conversation |\n| `allowedTools` | `string[]` | | Tools auto-approved while this skill is active |\n| `pluginName` | `string` | | Plugin the skill originated from |\n| `pluginVersion` | `string` | | Plugin version |\n\n---\n\n## Other Events\n\n### `abort`\n\nThe current turn was aborted.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `reason` | `string` | ✅ | Why the turn was aborted (e.g., `\"user initiated\"`) |\n\n### `user.message`\n\nThe user sent a message. Recorded for the session timeline.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `content` | `string` | ✅ | The user's message text |\n| `transformedContent` | `string` | | Transformed version after preprocessing |\n| `attachments` | `Attachment[]` | | File, directory, selection, blob, or GitHub reference attachments |\n| `source` | `string` | | Message source identifier |\n| `agentMode` | `string` | | Agent mode: `\"interactive\"`, `\"plan\"`, `\"autopilot\"`, or `\"shell\"` |\n| `interactionId` | `string` | | CAPI interaction ID |\n\n### `system.message`\n\nA system or developer prompt was injected into the conversation.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `content` | `string` | ✅ | The prompt text |\n| `role` | `\"system\" \\| \"developer\"` | ✅ | Message role |\n| `name` | `string` | | Source identifier |\n| `metadata` | `{ promptVersion?, variables? }` | | Prompt template metadata |\n\n### `external_tool.requested`\n\nEphemeral. The agent wants to invoke an external tool (one provided by the SDK consumer).\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `requestId` | `string` | ✅ | Use this to respond via `session.respondToExternalTool()` |\n| `sessionId` | `string` | ✅ | Session this request belongs to |\n| `toolCallId` | `string` | ✅ | Tool call ID for this invocation |\n| `toolName` | `string` | ✅ | Name of the external tool |\n| `arguments` | `object` | | Arguments for the tool |\n\n### `external_tool.completed`\n\nEphemeral. An external tool request was resolved.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `requestId` | `string` | ✅ | Matches the corresponding `external_tool.requested` |\n\n### `exit_plan_mode.requested`\n\nEphemeral. The agent has created a plan and wants to exit plan mode.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `requestId` | `string` | ✅ | Use this to respond via `session.respondToExitPlanMode()` |\n| `summary` | `string` | ✅ | Summary of the plan |\n| `planContent` | `string` | ✅ | Full plan file content |\n| `actions` | `string[]` | ✅ | Available user actions (e.g., approve, edit, reject) |\n| `recommendedAction` | `string` | ✅ | Suggested action |\n\n### `exit_plan_mode.completed`\n\nEphemeral. An exit plan mode request was resolved.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `requestId` | `string` | ✅ | Matches the corresponding `exit_plan_mode.requested` |\n\n### `command.queued`\n\nEphemeral. A slash command was queued for execution.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `requestId` | `string` | ✅ | Use this to respond via `session.respondToQueuedCommand()` |\n| `command` | `string` | ✅ | The slash command text (e.g., `/help`, `/clear`) |\n\n### `command.completed`\n\nEphemeral. A queued command was resolved.\n\n| Data Field | Type | Required | Description |\n|------------|------|----------|-------------|\n| `requestId` | `string` | ✅ | Matches the corresponding `command.queued` |\n\n---\n\n## Quick Reference: Agentic Turn Flow\n\nA typical agentic turn emits events in this order:\n\n```\nassistant.turn_start → Turn begins\n├── assistant.intent → What the agent plans to do (ephemeral)\n├── assistant.reasoning_delta → Streaming thinking chunks (ephemeral, repeated)\n├── assistant.reasoning → Complete thinking block\n├── assistant.message_delta → Streaming response chunks (ephemeral, repeated)\n├── assistant.message → Complete response (may include toolRequests)\n├── assistant.usage → Token usage for this API call (ephemeral)\n│\n├── [If tools were requested:]\n│ ├── permission.requested → Needs user approval (ephemeral)\n│ ├── permission.completed → Approval result (ephemeral)\n│ ├── tool.execution_start → Tool begins\n│ ├── tool.execution_partial_result → Streaming tool output (ephemeral, repeated)\n│ ├── tool.execution_progress → Progress updates (ephemeral, repeated)\n│ ├── tool.execution_complete → Tool finished\n│ │\n│ └── [Agent loops: more reasoning → message → tool calls...]\n│\nassistant.turn_end → Turn complete\nsession.idle → Ready for next message (ephemeral)\n```\n\n## All Event Types at a Glance\n\n| Event Type | Ephemeral | Category | Key Data Fields |\n|------------|-----------|----------|-----------------|\n| `assistant.turn_start` | | Assistant | `turnId`, `interactionId?` |\n| `assistant.intent` | ✅ | Assistant | `intent` |\n| `assistant.reasoning` | | Assistant | `reasoningId`, `content` |\n| `assistant.reasoning_delta` | ✅ | Assistant | `reasoningId`, `deltaContent` |\n| `assistant.streaming_delta` | ✅ | Assistant | `totalResponseSizeBytes` |\n| `assistant.message` | | Assistant | `messageId`, `content`, `toolRequests?`, `outputTokens?`, `phase?` |\n| `assistant.message_delta` | ✅ | Assistant | `messageId`, `deltaContent`, `parentToolCallId?` |\n| `assistant.turn_end` | | Assistant | `turnId` |\n| `assistant.usage` | ✅ | Assistant | `model`, `inputTokens?`, `outputTokens?`, `cost?`, `duration?` |\n| `tool.user_requested` | | Tool | `toolCallId`, `toolName`, `arguments?` |\n| `tool.execution_start` | | Tool | `toolCallId`, `toolName`, `arguments?`, `mcpServerName?` |\n| `tool.execution_partial_result` | ✅ | Tool | `toolCallId`, `partialOutput` |\n| `tool.execution_progress` | ✅ | Tool | `toolCallId`, `progressMessage` |\n| `tool.execution_complete` | | Tool | `toolCallId`, `success`, `result?`, `error?` |\n| `session.idle` | ✅ | Session | `backgroundTasks?` |\n| `session.error` | | Session | `errorType`, `message`, `statusCode?` |\n| `session.compaction_start` | | Session | *(empty)* |\n| `session.compaction_complete` | | Session | `success`, `preCompactionTokens?`, `summaryContent?` |\n| `session.title_changed` | ✅ | Session | `title` |\n| `session.context_changed` | | Session | `cwd`, `gitRoot?`, `repository?`, `branch?` |\n| `session.usage_info` | ✅ | Session | `tokenLimit`, `currentTokens`, `messagesLength` |\n| `session.task_complete` | | Session | `summary?` |\n| `session.shutdown` | | Session | `shutdownType`, `codeChanges`, `modelMetrics` |\n| `permission.requested` | ✅ | Permission | `requestId`, `permissionRequest` |\n| `permission.completed` | ✅ | Permission | `requestId`, `result.kind` |\n| `user_input.requested` | ✅ | User Input | `requestId`, `question`, `choices?` |\n| `user_input.completed` | ✅ | User Input | `requestId` |\n| `elicitation.requested` | ✅ | User Input | `requestId`, `message`, `requestedSchema` |\n| `elicitation.completed` | ✅ | User Input | `requestId` |\n| `subagent.started` | | Sub-Agent | `toolCallId`, `agentName`, `agentDisplayName` |\n| `subagent.completed` | | Sub-Agent | `toolCallId`, `agentName`, `agentDisplayName` |\n| `subagent.failed` | | Sub-Agent | `toolCallId`, `agentName`, `error` |\n| `subagent.selected` | | Sub-Agent | `agentName`, `agentDisplayName`, `tools` |\n| `subagent.deselected` | | Sub-Agent | *(empty)* |\n| `skill.invoked` | | Skill | `name`, `path`, `content`, `allowedTools?` |\n| `abort` | | Control | `reason` |\n| `user.message` | | User | `content`, `attachments?`, `agentMode?` |\n| `system.message` | | System | `content`, `role` |\n| `external_tool.requested` | ✅ | External Tool | `requestId`, `toolName`, `arguments?` |\n| `external_tool.completed` | ✅ | External Tool | `requestId` |\n| `command.queued` | ✅ | Command | `requestId`, `command` |\n| `command.completed` | ✅ | Command | `requestId` |\n| `exit_plan_mode.requested` | ✅ | Plan Mode | `requestId`, `summary`, `planContent`, `actions` |\n| `exit_plan_mode.completed` | ✅ | Plan Mode | `requestId` |\n" }, { "path": "docs/getting-started.md", "content": "# Build Your First Copilot-Powered App\n\nIn this tutorial, you'll use the Copilot SDK to build a command-line assistant. You'll start with the basics, add streaming responses, then add custom tools - giving Copilot the ability to call your code.\n\n**What you'll build:**\n\n```\nYou: What's the weather like in Seattle?\nCopilot: Let me check the weather for Seattle...\n Currently 62°F and cloudy with a chance of rain.\n Typical Seattle weather!\n\nYou: How about Tokyo?\nCopilot: In Tokyo it's 75°F and sunny. Great day to be outside!\n```\n\n## Prerequisites\n\nBefore you begin, make sure you have:\n\n- **GitHub Copilot CLI** installed and authenticated ([Installation guide](https://docs.github.com/en/copilot/how-tos/set-up/install-copilot-cli))\n- Your preferred language runtime:\n - **Node.js** 18+ or **Python** 3.11+ or **Go** 1.21+ or **Java** 17+ or **.NET** 8.0+\n\nVerify the CLI is working:\n\n```bash\ncopilot --version\n```\n\n## Step 1: Install the SDK\n\n
\nNode.js / TypeScript\n\nFirst, create a new directory and initialize your project:\n\n```bash\nmkdir copilot-demo && cd copilot-demo\nnpm init -y --init-type module\n```\n\nThen install the SDK and TypeScript runner:\n\n```bash\nnpm install @github/copilot-sdk tsx\n```\n\n
\n\n
\nPython\n\n```bash\npip install github-copilot-sdk\n```\n\n
\n\n
\nGo\n\nFirst, create a new directory and initialize your module:\n\n```bash\nmkdir copilot-demo && cd copilot-demo\ngo mod init copilot-demo\n```\n\nThen install the SDK:\n\n```bash\ngo get github.com/github/copilot-sdk/go\n```\n\n
\n\n
\n.NET\n\nFirst, create a new console project:\n\n```bash\ndotnet new console -n CopilotDemo && cd CopilotDemo\n```\n\nThen add the SDK:\n\n```bash\ndotnet add package GitHub.Copilot.SDK\n```\n\n
\n\n
\nJava\n\nFirst, create a new directory and initialize your project.\n\n**Maven** — add to your `pom.xml`:\n\n```xml\n\n com.github\n copilot-sdk-java\n ${copilot.sdk.version}\n\n```\n\n**Gradle** — add to your `build.gradle`:\n\n```groovy\nimplementation 'com.github:copilot-sdk-java:${copilotSdkVersion}'\n```\n\n
\n\n## Step 2: Send Your First Message\n\nCreate a new file and add the following code. This is the simplest way to use the SDK—about 5 lines of code.\n\n
\nNode.js / TypeScript\n\nCreate `index.ts`:\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\nconst session = await client.createSession({ model: \"gpt-4.1\" });\n\nconst response = await session.sendAndWait({ prompt: \"What is 2 + 2?\" });\nconsole.log(response?.data.content);\n\nawait client.stop();\nprocess.exit(0);\n```\n\nRun it:\n\n```bash\nnpx tsx index.ts\n```\n\n
\n\n
\nPython\n\nCreate `main.py`:\n\n```python\nimport asyncio\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionHandler\n\nasync def main():\n client = CopilotClient()\n await client.start()\n\n session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model=\"gpt-4.1\")\n response = await session.send_and_wait(\"What is 2 + 2?\")\n print(response.data.content)\n\n await client.stop()\n\nasyncio.run(main())\n```\n\nRun it:\n\n```bash\npython main.py\n```\n\n
\n\n
\nGo\n\nCreate `main.go`:\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclient := copilot.NewClient(nil)\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{Model: \"gpt-4.1\"})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: \"What is 2 + 2?\"})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\n\t\tfmt.Println(d.Content)\n\t}\n\tos.Exit(0)\n}\n```\n\nRun it:\n\n```bash\ngo run main.go\n```\n\n
\n\n
\n.NET\n\nCreate a new console project and add this to `Program.cs`:\n\n```csharp\nusing GitHub.Copilot.SDK;\n\nawait using var client = new CopilotClient();\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-4.1\",\n OnPermissionRequest = PermissionHandler.ApproveAll\n});\n\nvar response = await session.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 2 + 2?\" });\nConsole.WriteLine(response?.Data.Content);\n```\n\nRun it:\n\n```bash\ndotnet run\n```\n\n
\n\n
\nJava\n\nCreate `HelloCopilot.java`:\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\n\npublic class HelloCopilot {\n public static void main(String[] args) throws Exception {\n try (var client = new CopilotClient()) {\n client.start().get();\n\n var session = client.createSession(\n new SessionConfig()\n .setModel(\"gpt-4.1\")\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n ).get();\n\n var response = session.sendAndWait(\n new MessageOptions().setPrompt(\"What is 2 + 2?\")\n ).get();\n\n System.out.println(response.getData().content());\n\n client.stop().get();\n }\n }\n}\n```\n\nRun it:\n\n```bash\njavac -cp copilot-sdk.jar HelloCopilot.java && java -cp .:copilot-sdk.jar HelloCopilot\n```\n\n
\n\n**You should see:**\n\n```\n4\n```\n\nCongratulations! You just built your first Copilot-powered app.\n\n## Step 3: Add Streaming Responses\n\nRight now, you wait for the complete response before seeing anything. Let's make it interactive by streaming the response as it's generated.\n\n
\nNode.js / TypeScript\n\nUpdate `index.ts`:\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\nconst session = await client.createSession({\n model: \"gpt-4.1\",\n streaming: true,\n});\n\n// Listen for response chunks\nsession.on(\"assistant.message_delta\", (event) => {\n process.stdout.write(event.data.deltaContent);\n});\nsession.on(\"session.idle\", () => {\n console.log(); // New line when done\n});\n\nawait session.sendAndWait({ prompt: \"Tell me a short joke\" });\n\nawait client.stop();\nprocess.exit(0);\n```\n\n
\n\n
\nPython\n\nUpdate `main.py`:\n\n```python\nimport asyncio\nimport sys\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionHandler\nfrom copilot.generated.session_events import SessionEventType\n\nasync def main():\n client = CopilotClient()\n await client.start()\n\n session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model=\"gpt-4.1\", streaming=True)\n\n # Listen for response chunks\n def handle_event(event):\n if event.type == SessionEventType.ASSISTANT_MESSAGE_DELTA:\n sys.stdout.write(event.data.delta_content)\n sys.stdout.flush()\n if event.type == SessionEventType.SESSION_IDLE:\n print() # New line when done\n\n session.on(handle_event)\n\n await session.send_and_wait(\"Tell me a short joke\")\n\n await client.stop()\n\nasyncio.run(main())\n```\n\n
\n\n
\nGo\n\nUpdate `main.go`:\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclient := copilot.NewClient(nil)\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"gpt-4.1\",\n\t\tStreaming: true,\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\t// Listen for response chunks\n\tsession.On(func(event copilot.SessionEvent) {\n\t\tswitch d := event.Data.(type) {\n\t\tcase *copilot.AssistantMessageDeltaData:\n\t\t\tfmt.Print(d.DeltaContent)\n\t\tcase *copilot.SessionIdleData:\n\t\t\t_ = d\n\t\t\tfmt.Println()\n\t\t}\n\t})\n\n\t_, err = session.SendAndWait(ctx, copilot.MessageOptions{Prompt: \"Tell me a short joke\"})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tos.Exit(0)\n}\n```\n\n
\n\n
\n.NET\n\nUpdate `Program.cs`:\n\n```csharp\nusing GitHub.Copilot.SDK;\n\nawait using var client = new CopilotClient();\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-4.1\",\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Streaming = true,\n});\n\n// Listen for response chunks\nsession.On(ev =>\n{\n if (ev is AssistantMessageDeltaEvent deltaEvent)\n {\n Console.Write(deltaEvent.Data.DeltaContent);\n }\n if (ev is SessionIdleEvent)\n {\n Console.WriteLine();\n }\n});\n\nawait session.SendAndWaitAsync(new MessageOptions { Prompt = \"Tell me a short joke\" });\n```\n\n
\n\n
\nJava\n\nUpdate `HelloCopilot.java`:\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\n\npublic class HelloCopilot {\n public static void main(String[] args) throws Exception {\n try (var client = new CopilotClient()) {\n client.start().get();\n\n var session = client.createSession(\n new SessionConfig()\n .setModel(\"gpt-4.1\")\n .setStreaming(true)\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n ).get();\n\n // Listen for response chunks\n session.on(AssistantMessageDeltaEvent.class, delta -> {\n System.out.print(delta.getData().deltaContent());\n });\n session.on(SessionIdleEvent.class, idle -> {\n System.out.println(); // New line when done\n });\n\n session.sendAndWait(\n new MessageOptions().setPrompt(\"Tell me a short joke\")\n ).get();\n\n client.stop().get();\n }\n }\n}\n```\n\n
\n\nRun the code again. You'll see the response appear word by word.\n\n### Event Subscription Methods\n\nThe SDK provides methods for subscribing to session events:\n\n| Method | Description |\n|--------|-------------|\n| `on(handler)` | Subscribe to all events; returns unsubscribe function |\n| `on(eventType, handler)` | Subscribe to specific event type (Node.js/TypeScript only); returns unsubscribe function |\n\n
\nNode.js / TypeScript\n\n```typescript\n// Subscribe to all events\nconst unsubscribeAll = session.on((event) => {\n console.log(\"Event:\", event.type);\n});\n\n// Subscribe to specific event type\nconst unsubscribeIdle = session.on(\"session.idle\", (event) => {\n console.log(\"Session is idle\");\n});\n\n// Later, to unsubscribe:\nunsubscribeAll();\nunsubscribeIdle();\n```\n\n
\n\n
\nPython\n\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.generated.session_events import SessionEvent, SessionEventType\nfrom copilot.session import PermissionRequestResult\n\nclient = CopilotClient()\n\nsession = await client.create_session(on_permission_request=lambda req, inv: PermissionRequestResult(kind=\"approved\"))\n\n# Subscribe to all events\nunsubscribe = session.on(lambda event: print(f\"Event: {event.type}\"))\n\n# Filter by event type in your handler\ndef handle_event(event: SessionEvent) -> None:\n if event.type == SessionEventType.SESSION_IDLE:\n print(\"Session is idle\")\n elif event.type == SessionEventType.ASSISTANT_MESSAGE:\n print(f\"Message: {event.data.content}\")\n\nunsubscribe = session.on(handle_event)\n\n# Later, to unsubscribe:\nunsubscribe()\n```\n\n\n```python\n# Subscribe to all events\nunsubscribe = session.on(lambda event: print(f\"Event: {event.type}\"))\n\n# Filter by event type in your handler\ndef handle_event(event):\n if event.type == SessionEventType.SESSION_IDLE:\n print(\"Session is idle\")\n elif event.type == SessionEventType.ASSISTANT_MESSAGE:\n print(f\"Message: {event.data.content}\")\n\nunsubscribe = session.on(handle_event)\n\n# Later, to unsubscribe:\nunsubscribe()\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tsession := &copilot.Session{}\n\n\t// Subscribe to all events\n\tunsubscribe := session.On(func(event copilot.SessionEvent) {\n\t\tfmt.Println(\"Event:\", event.Type)\n\t})\n\n\t// Filter by event type in your handler\n\tsession.On(func(event copilot.SessionEvent) {\n\t\tswitch d := event.Data.(type) {\n\t\tcase *copilot.SessionIdleData:\n\t\t\t_ = d\n\t\t\tfmt.Println(\"Session is idle\")\n\t\tcase *copilot.AssistantMessageData:\n\t\t\tfmt.Println(\"Message:\", d.Content)\n\t\t}\n\t})\n\n\t// Later, to unsubscribe:\n\tunsubscribe()\n}\n```\n\n\n```go\n// Subscribe to all events\nunsubscribe := session.On(func(event copilot.SessionEvent) {\n fmt.Println(\"Event:\", event.Type)\n})\n\n// Filter by event type in your handler\nsession.On(func(event copilot.SessionEvent) {\n switch d := event.Data.(type) {\n case *copilot.SessionIdleData:\n _ = d\n fmt.Println(\"Session is idle\")\n case *copilot.AssistantMessageData:\n fmt.Println(\"Message:\", d.Content)\n }\n})\n\n// Later, to unsubscribe:\nunsubscribe()\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic static class EventSubscriptionExample\n{\n public static void Example(CopilotSession session)\n {\n // Subscribe to all events\n var unsubscribe = session.On(ev => Console.WriteLine($\"Event: {ev.Type}\"));\n\n // Filter by event type using pattern matching\n session.On(ev =>\n {\n switch (ev)\n {\n case SessionIdleEvent:\n Console.WriteLine(\"Session is idle\");\n break;\n case AssistantMessageEvent msg:\n Console.WriteLine($\"Message: {msg.Data.Content}\");\n break;\n }\n });\n\n // Later, to unsubscribe:\n unsubscribe.Dispose();\n }\n}\n```\n\n\n```csharp\n// Subscribe to all events\nvar unsubscribe = session.On(ev => Console.WriteLine($\"Event: {ev.Type}\"));\n\n// Filter by event type using pattern matching\nsession.On(ev =>\n{\n switch (ev)\n {\n case SessionIdleEvent:\n Console.WriteLine(\"Session is idle\");\n break;\n case AssistantMessageEvent msg:\n Console.WriteLine($\"Message: {msg.Data.Content}\");\n break;\n }\n});\n\n// Later, to unsubscribe:\nunsubscribe.Dispose();\n```\n\n
\n\n
\nJava\n\n```java\n// Subscribe to all events\nvar unsubscribe = session.on(event -> {\n System.out.println(\"Event: \" + event.getType());\n});\n\n// Subscribe to a specific event type\nsession.on(AssistantMessageEvent.class, msg -> {\n System.out.println(\"Message: \" + msg.getData().content());\n});\n\nsession.on(SessionIdleEvent.class, idle -> {\n System.out.println(\"Session is idle\");\n});\n\n// Later, to unsubscribe:\nunsubscribe.close();\n```\n\n
\n\n## Step 4: Add a Custom Tool\n\nNow for the powerful part. Let's give Copilot the ability to call your code by defining a custom tool. We'll create a simple weather lookup tool.\n\n
\nNode.js / TypeScript\n\nUpdate `index.ts`:\n\n```typescript\nimport { CopilotClient, defineTool } from \"@github/copilot-sdk\";\n\n// Define a tool that Copilot can call\nconst getWeather = defineTool(\"get_weather\", {\n description: \"Get the current weather for a city\",\n parameters: {\n type: \"object\",\n properties: {\n city: { type: \"string\", description: \"The city name\" },\n },\n required: [\"city\"],\n },\n handler: async (args: { city: string }) => {\n const { city } = args;\n // In a real app, you'd call a weather API here\n const conditions = [\"sunny\", \"cloudy\", \"rainy\", \"partly cloudy\"];\n const temp = Math.floor(Math.random() * 30) + 50;\n const condition = conditions[Math.floor(Math.random() * conditions.length)];\n return { city, temperature: `${temp}°F`, condition };\n },\n});\n\nconst client = new CopilotClient();\nconst session = await client.createSession({\n model: \"gpt-4.1\",\n streaming: true,\n tools: [getWeather],\n});\n\nsession.on(\"assistant.message_delta\", (event) => {\n process.stdout.write(event.data.deltaContent);\n});\n\nsession.on(\"session.idle\", () => {\n console.log(); // New line when done\n});\n\nawait session.sendAndWait({\n prompt: \"What's the weather like in Seattle and Tokyo?\",\n});\n\nawait client.stop();\nprocess.exit(0);\n```\n\n
\n\n
\nPython\n\nUpdate `main.py`:\n\n```python\nimport asyncio\nimport random\nimport sys\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionHandler\nfrom copilot.tools import define_tool\nfrom copilot.generated.session_events import SessionEventType\nfrom pydantic import BaseModel, Field\n\n# Define the parameters for the tool using Pydantic\nclass GetWeatherParams(BaseModel):\n city: str = Field(description=\"The name of the city to get weather for\")\n\n# Define a tool that Copilot can call\n@define_tool(description=\"Get the current weather for a city\")\nasync def get_weather(params: GetWeatherParams) -> dict:\n city = params.city\n # In a real app, you'd call a weather API here\n conditions = [\"sunny\", \"cloudy\", \"rainy\", \"partly cloudy\"]\n temp = random.randint(50, 80)\n condition = random.choice(conditions)\n return {\"city\": city, \"temperature\": f\"{temp}°F\", \"condition\": condition}\n\nasync def main():\n client = CopilotClient()\n await client.start()\n\n session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model=\"gpt-4.1\", streaming=True, tools=[get_weather])\n\n def handle_event(event):\n if event.type == SessionEventType.ASSISTANT_MESSAGE_DELTA:\n sys.stdout.write(event.data.delta_content)\n sys.stdout.flush()\n if event.type == SessionEventType.SESSION_IDLE:\n print()\n\n session.on(handle_event)\n\n await session.send_and_wait(\"What's the weather like in Seattle and Tokyo?\")\n\n await client.stop()\n\nasyncio.run(main())\n```\n\n
\n\n
\nGo\n\nUpdate `main.go`:\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"math/rand\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\n// Define the parameter type\ntype WeatherParams struct {\n\tCity string `json:\"city\" jsonschema:\"The city name\"`\n}\n\n// Define the return type\ntype WeatherResult struct {\n\tCity string `json:\"city\"`\n\tTemperature string `json:\"temperature\"`\n\tCondition string `json:\"condition\"`\n}\n\nfunc main() {\n\tctx := context.Background()\n\n\t// Define a tool that Copilot can call\n\tgetWeather := copilot.DefineTool(\n\t\t\"get_weather\",\n\t\t\"Get the current weather for a city\",\n\t\tfunc(params WeatherParams, inv copilot.ToolInvocation) (WeatherResult, error) {\n\t\t\t// In a real app, you'd call a weather API here\n\t\t\tconditions := []string{\"sunny\", \"cloudy\", \"rainy\", \"partly cloudy\"}\n\t\t\ttemp := rand.Intn(30) + 50\n\t\t\tcondition := conditions[rand.Intn(len(conditions))]\n\t\t\treturn WeatherResult{\n\t\t\t\tCity: params.City,\n\t\t\t\tTemperature: fmt.Sprintf(\"%d°F\", temp),\n\t\t\t\tCondition: condition,\n\t\t\t}, nil\n\t\t},\n\t)\n\n\tclient := copilot.NewClient(nil)\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"gpt-4.1\",\n\t\tStreaming: true,\n\t\tTools: []copilot.Tool{getWeather},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tsession.On(func(event copilot.SessionEvent) {\n\t\tswitch d := event.Data.(type) {\n\t\tcase *copilot.AssistantMessageDeltaData:\n\t\t\tfmt.Print(d.DeltaContent)\n\t\tcase *copilot.SessionIdleData:\n\t\t\t_ = d\n\t\t\tfmt.Println()\n\t\t}\n\t})\n\n\t_, err = session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What's the weather like in Seattle and Tokyo?\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tos.Exit(0)\n}\n```\n\n
\n\n
\n.NET\n\nUpdate `Program.cs`:\n\n```csharp\nusing GitHub.Copilot.SDK;\nusing Microsoft.Extensions.AI;\nusing System.ComponentModel;\n\nawait using var client = new CopilotClient();\n\n// Define a tool that Copilot can call\nvar getWeather = AIFunctionFactory.Create(\n ([Description(\"The city name\")] string city) =>\n {\n // In a real app, you'd call a weather API here\n var conditions = new[] { \"sunny\", \"cloudy\", \"rainy\", \"partly cloudy\" };\n var temp = Random.Shared.Next(50, 80);\n var condition = conditions[Random.Shared.Next(conditions.Length)];\n return new { city, temperature = $\"{temp}°F\", condition };\n },\n \"get_weather\",\n \"Get the current weather for a city\"\n);\n\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-4.1\",\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Streaming = true,\n Tools = [getWeather],\n});\n\nsession.On(ev =>\n{\n if (ev is AssistantMessageDeltaEvent deltaEvent)\n {\n Console.Write(deltaEvent.Data.DeltaContent);\n }\n if (ev is SessionIdleEvent)\n {\n Console.WriteLine();\n }\n});\n\nawait session.SendAndWaitAsync(new MessageOptions\n{\n Prompt = \"What's the weather like in Seattle and Tokyo?\",\n});\n```\n\n
\n\n
\nJava\n\nUpdate `HelloCopilot.java`:\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\n\nimport java.util.List;\nimport java.util.Map;\nimport java.util.Random;\nimport java.util.concurrent.CompletableFuture;\n\npublic class HelloCopilot {\n public static void main(String[] args) throws Exception {\n var random = new Random();\n var conditions = List.of(\"sunny\", \"cloudy\", \"rainy\", \"partly cloudy\");\n\n // Define a tool that Copilot can call\n var getWeather = ToolDefinition.create(\n \"get_weather\",\n \"Get the current weather for a city\",\n Map.of(\n \"type\", \"object\",\n \"properties\", Map.of(\n \"city\", Map.of(\"type\", \"string\", \"description\", \"The city name\")\n ),\n \"required\", List.of(\"city\")\n ),\n invocation -> {\n var city = (String) invocation.getArguments().get(\"city\");\n var temp = random.nextInt(30) + 50;\n var condition = conditions.get(random.nextInt(conditions.size()));\n return CompletableFuture.completedFuture(Map.of(\n \"city\", city,\n \"temperature\", temp + \"°F\",\n \"condition\", condition\n ));\n }\n );\n\n try (var client = new CopilotClient()) {\n client.start().get();\n\n var session = client.createSession(\n new SessionConfig()\n .setModel(\"gpt-4.1\")\n .setStreaming(true)\n .setTools(List.of(getWeather))\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n ).get();\n\n session.on(AssistantMessageDeltaEvent.class, delta -> {\n System.out.print(delta.getData().deltaContent());\n });\n session.on(SessionIdleEvent.class, idle -> {\n System.out.println();\n });\n\n session.sendAndWait(\n new MessageOptions().setPrompt(\"What's the weather like in Seattle and Tokyo?\")\n ).get();\n\n client.stop().get();\n }\n }\n}\n```\n\n
\n\nRun it and you'll see Copilot call your tool to get weather data, then respond with the results!\n\n## Step 5: Build an Interactive Assistant\n\nLet's put it all together into a useful interactive assistant:\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient, defineTool } from \"@github/copilot-sdk\";\nimport * as readline from \"readline\";\n\nconst getWeather = defineTool(\"get_weather\", {\n description: \"Get the current weather for a city\",\n parameters: {\n type: \"object\",\n properties: {\n city: { type: \"string\", description: \"The city name\" },\n },\n required: [\"city\"],\n },\n handler: async ({ city }) => {\n const conditions = [\"sunny\", \"cloudy\", \"rainy\", \"partly cloudy\"];\n const temp = Math.floor(Math.random() * 30) + 50;\n const condition = conditions[Math.floor(Math.random() * conditions.length)];\n return { city, temperature: `${temp}°F`, condition };\n },\n});\n\nconst client = new CopilotClient();\nconst session = await client.createSession({\n model: \"gpt-4.1\",\n streaming: true,\n tools: [getWeather],\n});\n\nsession.on(\"assistant.message_delta\", (event) => {\n process.stdout.write(event.data.deltaContent);\n});\n\nconst rl = readline.createInterface({\n input: process.stdin,\n output: process.stdout,\n});\n\nconsole.log(\"🌤️ Weather Assistant (type 'exit' to quit)\");\nconsole.log(\" Try: 'What's the weather in Paris?'\\n\");\n\nconst prompt = () => {\n rl.question(\"You: \", async (input) => {\n if (input.toLowerCase() === \"exit\") {\n await client.stop();\n rl.close();\n return;\n }\n\n process.stdout.write(\"Assistant: \");\n await session.sendAndWait({ prompt: input });\n console.log(\"\\n\");\n prompt();\n });\n};\n\nprompt();\n```\n\nRun with:\n\n```bash\nnpx tsx weather-assistant.ts\n```\n\n
\n\n
\nPython\n\nCreate `weather_assistant.py`:\n\n```python\nimport asyncio\nimport random\nimport sys\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionHandler\nfrom copilot.tools import define_tool\nfrom copilot.generated.session_events import SessionEventType\nfrom pydantic import BaseModel, Field\n\nclass GetWeatherParams(BaseModel):\n city: str = Field(description=\"The name of the city to get weather for\")\n\n@define_tool(description=\"Get the current weather for a city\")\nasync def get_weather(params: GetWeatherParams) -> dict:\n city = params.city\n conditions = [\"sunny\", \"cloudy\", \"rainy\", \"partly cloudy\"]\n temp = random.randint(50, 80)\n condition = random.choice(conditions)\n return {\"city\": city, \"temperature\": f\"{temp}°F\", \"condition\": condition}\n\nasync def main():\n client = CopilotClient()\n await client.start()\n\n session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model=\"gpt-4.1\", streaming=True, tools=[get_weather])\n\n def handle_event(event):\n if event.type == SessionEventType.ASSISTANT_MESSAGE_DELTA:\n sys.stdout.write(event.data.delta_content)\n sys.stdout.flush()\n\n session.on(handle_event)\n\n print(\"🌤️ Weather Assistant (type 'exit' to quit)\")\n print(\" Try: 'What's the weather in Paris?' or 'Compare weather in NYC and LA'\\n\")\n\n while True:\n try:\n user_input = input(\"You: \")\n except EOFError:\n break\n\n if user_input.lower() == \"exit\":\n break\n\n sys.stdout.write(\"Assistant: \")\n await session.send_and_wait(user_input)\n print(\"\\n\")\n\n await client.stop()\n\nasyncio.run(main())\n```\n\nRun with:\n\n```bash\npython weather_assistant.py\n```\n\n
\n\n
\nGo\n\nCreate `weather-assistant.go`:\n\n```go\npackage main\n\nimport (\n\t\"bufio\"\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"math/rand\"\n\t\"os\"\n\t\"strings\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\ntype WeatherParams struct {\n\tCity string `json:\"city\" jsonschema:\"The city name\"`\n}\n\ntype WeatherResult struct {\n\tCity string `json:\"city\"`\n\tTemperature string `json:\"temperature\"`\n\tCondition string `json:\"condition\"`\n}\n\nfunc main() {\n\tctx := context.Background()\n\n\tgetWeather := copilot.DefineTool(\n\t\t\"get_weather\",\n\t\t\"Get the current weather for a city\",\n\t\tfunc(params WeatherParams, inv copilot.ToolInvocation) (WeatherResult, error) {\n\t\t\tconditions := []string{\"sunny\", \"cloudy\", \"rainy\", \"partly cloudy\"}\n\t\t\ttemp := rand.Intn(30) + 50\n\t\t\tcondition := conditions[rand.Intn(len(conditions))]\n\t\t\treturn WeatherResult{\n\t\t\t\tCity: params.City,\n\t\t\t\tTemperature: fmt.Sprintf(\"%d°F\", temp),\n\t\t\t\tCondition: condition,\n\t\t\t}, nil\n\t\t},\n\t)\n\n\tclient := copilot.NewClient(nil)\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"gpt-4.1\",\n\t\tStreaming: true,\n\t\tTools: []copilot.Tool{getWeather},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tsession.On(func(event copilot.SessionEvent) {\n\t\tswitch d := event.Data.(type) {\n\t\tcase *copilot.AssistantMessageDeltaData:\n\t\t\tfmt.Print(d.DeltaContent)\n\t\tcase *copilot.SessionIdleData:\n\t\t\t_ = d\n\t\t\tfmt.Println()\n\t\t}\n\t})\n\n\tfmt.Println(\"🌤️ Weather Assistant (type 'exit' to quit)\")\n\tfmt.Println(\" Try: 'What's the weather in Paris?' or 'Compare weather in NYC and LA'\\n\")\n\n\tscanner := bufio.NewScanner(os.Stdin)\n\tfor {\n\t\tfmt.Print(\"You: \")\n\t\tif !scanner.Scan() {\n\t\t\tbreak\n\t\t}\n\t\tinput := scanner.Text()\n\t\tif strings.ToLower(input) == \"exit\" {\n\t\t\tbreak\n\t\t}\n\n\t\tfmt.Print(\"Assistant: \")\n\t\t_, err = session.SendAndWait(ctx, copilot.MessageOptions{Prompt: input})\n\t\tif err != nil {\n\t\t\tfmt.Fprintf(os.Stderr, \"Error: %v\\n\", err)\n\t\t\tbreak\n\t\t}\n\t\tfmt.Println()\n\t}\n\tif err := scanner.Err(); err != nil {\n\t\tfmt.Fprintf(os.Stderr, \"Input error: %v\\n\", err)\n\t}\n}\n```\n\nRun with:\n\n```bash\ngo run weather-assistant.go\n```\n\n
\n\n
\n.NET\n\nCreate a new console project and update `Program.cs`:\n\n```csharp\nusing GitHub.Copilot.SDK;\nusing Microsoft.Extensions.AI;\nusing System.ComponentModel;\n\n// Define the weather tool using AIFunctionFactory\nvar getWeather = AIFunctionFactory.Create(\n ([Description(\"The city name\")] string city) =>\n {\n var conditions = new[] { \"sunny\", \"cloudy\", \"rainy\", \"partly cloudy\" };\n var temp = Random.Shared.Next(50, 80);\n var condition = conditions[Random.Shared.Next(conditions.Length)];\n return new { city, temperature = $\"{temp}°F\", condition };\n },\n \"get_weather\",\n \"Get the current weather for a city\");\n\nawait using var client = new CopilotClient();\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-4.1\",\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Streaming = true,\n Tools = [getWeather]\n});\n\n// Listen for response chunks\nsession.On(ev =>\n{\n if (ev is AssistantMessageDeltaEvent deltaEvent)\n {\n Console.Write(deltaEvent.Data.DeltaContent);\n }\n if (ev is SessionIdleEvent)\n {\n Console.WriteLine();\n }\n});\n\nConsole.WriteLine(\"🌤️ Weather Assistant (type 'exit' to quit)\");\nConsole.WriteLine(\" Try: 'What's the weather in Paris?' or 'Compare weather in NYC and LA'\\n\");\n\nwhile (true)\n{\n Console.Write(\"You: \");\n var input = Console.ReadLine();\n\n if (string.IsNullOrEmpty(input) || input.Equals(\"exit\", StringComparison.OrdinalIgnoreCase))\n {\n break;\n }\n\n Console.Write(\"Assistant: \");\n await session.SendAndWaitAsync(new MessageOptions { Prompt = input });\n Console.WriteLine(\"\\n\");\n}\n```\n\nRun with:\n\n```bash\ndotnet run\n```\n\n
\n\n
\nJava\n\nCreate `WeatherAssistant.java`:\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\n\nimport java.util.List;\nimport java.util.Map;\nimport java.util.Random;\nimport java.util.Scanner;\nimport java.util.concurrent.CompletableFuture;\n\npublic class WeatherAssistant {\n public static void main(String[] args) throws Exception {\n var random = new Random();\n var conditions = List.of(\"sunny\", \"cloudy\", \"rainy\", \"partly cloudy\");\n\n var getWeather = ToolDefinition.create(\n \"get_weather\",\n \"Get the current weather for a city\",\n Map.of(\n \"type\", \"object\",\n \"properties\", Map.of(\n \"city\", Map.of(\"type\", \"string\", \"description\", \"The city name\")\n ),\n \"required\", List.of(\"city\")\n ),\n invocation -> {\n var city = (String) invocation.getArguments().get(\"city\");\n var temp = random.nextInt(30) + 50;\n var condition = conditions.get(random.nextInt(conditions.size()));\n return CompletableFuture.completedFuture(Map.of(\n \"city\", city,\n \"temperature\", temp + \"°F\",\n \"condition\", condition\n ));\n }\n );\n\n try (var client = new CopilotClient()) {\n client.start().get();\n\n var session = client.createSession(\n new SessionConfig()\n .setModel(\"gpt-4.1\")\n .setStreaming(true)\n .setOnPermissionRequest(request ->\n CompletableFuture.completedFuture(PermissionDecision.allow())\n )\n .setTools(List.of(getWeather))\n ).get();\n\n session.on(AssistantMessageDeltaEvent.class, delta -> {\n System.out.print(delta.getData().deltaContent());\n });\n session.on(SessionIdleEvent.class, idle -> {\n System.out.println();\n });\n\n System.out.println(\"🌤️ Weather Assistant (type 'exit' to quit)\");\n System.out.println(\" Try: 'What's the weather in Paris?' or 'Compare weather in NYC and LA'\\n\");\n\n var scanner = new Scanner(System.in);\n while (true) {\n System.out.print(\"You: \");\n if (!scanner.hasNextLine()) break;\n var input = scanner.nextLine();\n if (input.equalsIgnoreCase(\"exit\")) break;\n\n System.out.print(\"Assistant: \");\n session.sendAndWait(\n new MessageOptions().setPrompt(input)\n ).get();\n System.out.println(\"\\n\");\n }\n\n client.stop().get();\n }\n }\n}\n```\n\nRun with:\n\n```bash\njavac -cp copilot-sdk.jar WeatherAssistant.java && java -cp .:copilot-sdk.jar WeatherAssistant\n```\n\n
\n\n\n**Example session:**\n\n```\n🌤️ Weather Assistant (type 'exit' to quit)\n Try: 'What's the weather in Paris?' or 'Compare weather in NYC and LA'\n\nYou: What's the weather in Seattle?\nAssistant: Let me check the weather for Seattle...\nIt's currently 62°F and cloudy in Seattle.\n\nYou: How about Tokyo and London?\nAssistant: I'll check both cities for you:\n- Tokyo: 75°F and sunny\n- London: 58°F and rainy\n\nYou: exit\n```\n\nYou've built an assistant with a custom tool that Copilot can call!\n\n---\n\n## How Tools Work\n\nWhen you define a tool, you're telling Copilot:\n1. **What the tool does** (description)\n2. **What parameters it needs** (schema)\n3. **What code to run** (handler)\n\nCopilot decides when to call your tool based on the user's question. When it does:\n1. Copilot sends a tool call request with the parameters\n2. The SDK runs your handler function\n3. The result is sent back to Copilot\n4. Copilot incorporates the result into its response\n\n---\n\n## What's Next?\n\nNow that you've got the basics, here are more powerful features to explore:\n\n### Connect to MCP Servers\n\nMCP (Model Context Protocol) servers provide pre-built tools. Connect to GitHub's MCP server to give Copilot access to repositories, issues, and pull requests:\n\n```typescript\nconst session = await client.createSession({\n mcpServers: {\n github: {\n type: \"http\",\n url: \"https://api.githubcopilot.com/mcp/\",\n },\n },\n});\n```\n\n📖 **[Full MCP documentation →](./features/mcp.md)** - Learn about local vs remote servers, all configuration options, and troubleshooting.\n\n### Create Custom Agents\n\nDefine specialized AI personas for specific tasks:\n\n```typescript\nconst session = await client.createSession({\n customAgents: [{\n name: \"pr-reviewer\",\n displayName: \"PR Reviewer\",\n description: \"Reviews pull requests for best practices\",\n prompt: \"You are an expert code reviewer. Focus on security, performance, and maintainability.\",\n }],\n});\n```\n\n> **Tip:** You can also set `agent: \"pr-reviewer\"` in the session config to pre-select this agent from the start. See the [Custom Agents guide](./features/custom-agents.md#selecting-an-agent-at-session-creation) for details.\n\n### Customize the System Message\n\nControl the AI's behavior and personality by appending instructions:\n\n```typescript\nconst session = await client.createSession({\n systemMessage: {\n content: \"You are a helpful assistant for our engineering team. Always be concise.\",\n },\n});\n```\n\nFor more fine-grained control, use `mode: \"customize\"` to override individual sections of the system prompt while preserving the rest:\n\n```typescript\nconst session = await client.createSession({\n systemMessage: {\n mode: \"customize\",\n sections: {\n tone: { action: \"replace\", content: \"Respond in a warm, professional tone. Be thorough in explanations.\" },\n code_change_rules: { action: \"remove\" },\n guidelines: { action: \"append\", content: \"\\n* Always cite data sources\" },\n },\n content: \"Focus on financial analysis and reporting.\",\n },\n});\n```\n\nAvailable section IDs: `identity`, `tone`, `tool_efficiency`, `environment_context`, `code_change_rules`, `guidelines`, `safety`, `tool_instructions`, `custom_instructions`, `last_instructions`.\n\nEach override supports four actions: `replace`, `remove`, `append`, and `prepend`. Unknown section IDs are handled gracefully — content is appended to additional instructions and a warning is emitted; `remove` on unknown sections is silently ignored.\n\nSee the language-specific SDK READMEs for examples in [TypeScript](../nodejs/README.md), [Python](../python/README.md), [Go](../go/README.md), [Java](../java/README.md), and [C#](../dotnet/README.md).\n\n---\n\n## Connecting to an External CLI Server\n\nBy default, the SDK automatically manages the Copilot CLI process lifecycle, starting and stopping the CLI as needed. However, you can also run the CLI in server mode separately and have the SDK connect to it. This can be useful for:\n\n- **Debugging**: Keep the CLI running between SDK restarts to inspect logs\n- **Resource sharing**: Multiple SDK clients can connect to the same CLI server\n- **Development**: Run the CLI with custom settings or in a different environment\n\n### Running the CLI in Server Mode\n\nStart the CLI in server mode using the `--headless` flag and optionally specify a port:\n\n```bash\ncopilot --headless --port 4321\n```\n\nIf you don't specify a port, the CLI will choose a random available port.\n\nBy default the headless server only accepts connections from loopback (`127.0.0.1`), so the SDK must run on the same machine. To accept connections from other hosts (for example when running the CLI in a container or on a separate server), bind to a non-loopback address with `--host`:\n\n```bash\n# Listen on all interfaces\ncopilot --headless --host 0.0.0.0 --port 4321\n```\n\n> **Warning:** Exposing the headless server on a non-loopback address makes it reachable by anyone who can route to that address. Pair it with network controls (firewall, private network, reverse proxy) and authentication appropriate for your environment.\n\n### Connecting the SDK to the External Server\n\nOnce the CLI is running in server mode, configure your SDK client to connect to it using the \"cli url\" option:\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient, approveAll } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient({\n cliUrl: \"localhost:4321\"\n});\n\n// Use the client normally\nconst session = await client.createSession({ onPermissionRequest: approveAll });\n// ...\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionHandler\n\nclient = CopilotClient({\n \"cli_url\": \"localhost:4321\"\n})\nawait client.start()\n\n# Use the client normally\nsession = await client.create_session(on_permission_request=PermissionHandler.approve_all)\n# ...\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\t\"log\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tCLIUrl: \"localhost:4321\",\n\t})\n\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\t// Use the client normally\n\t_, _ = client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t})\n}\n```\n\n\n```go\nimport copilot \"github.com/github/copilot-sdk/go\"\n\nclient := copilot.NewClient(&copilot.ClientOptions{\n CLIUrl: \"localhost:4321\",\n})\n\nif err := client.Start(ctx); err != nil {\n log.Fatal(err)\n}\ndefer client.Stop()\n\n// Use the client normally\nsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n OnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n})\n// ...\n```\n\n
\n\n
\n.NET\n\n```csharp\nusing GitHub.Copilot.SDK;\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliUrl = \"localhost:4321\",\n UseStdio = false\n});\n\n// Use the client normally\nawait using var session = await client.CreateSessionAsync(new()\n{\n OnPermissionRequest = PermissionHandler.ApproveAll\n});\n// ...\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.json.*;\n\nvar client = new CopilotClient(\n new CopilotClientOptions().setCliUrl(\"localhost:4321\")\n);\nclient.start().get();\n\n// Use the client normally\nvar session = client.createSession(\n new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n).get();\n// ...\n```\n\n
\n\n**Note:** When `cli_url` / `cliUrl` / `CLIUrl` is provided, the SDK will not spawn or manage a CLI process - it will only connect to the existing server at the specified URL.\n\n---\n\n## Telemetry & Observability\n\nThe Copilot SDK supports [OpenTelemetry](https://opentelemetry.io/) for distributed tracing. Provide a `telemetry` configuration to the client to enable trace export from the CLI process and automatic [W3C Trace Context](https://www.w3.org/TR/trace-context/) propagation between the SDK and CLI.\n\n### Enabling Telemetry\n\nPass a `telemetry` (or `Telemetry`) config when creating the client. This is the opt-in — no separate \"enabled\" flag is needed.\n\n
\nNode.js / TypeScript\n\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient({\n telemetry: {\n otlpEndpoint: \"http://localhost:4318\",\n },\n});\n```\n\nOptional peer dependency: `@opentelemetry/api`\n\n
\n\n
\nPython\n\n\n```python\nfrom copilot import CopilotClient, SubprocessConfig\n\nclient = CopilotClient(SubprocessConfig(\n telemetry={\n \"otlp_endpoint\": \"http://localhost:4318\",\n },\n))\n```\n\nInstall with telemetry extras: `pip install copilot-sdk[telemetry]` (provides `opentelemetry-api`)\n\n
\n\n
\nGo\n\n\n```go\nclient, err := copilot.NewClient(copilot.ClientOptions{\n Telemetry: &copilot.TelemetryConfig{\n OTLPEndpoint: \"http://localhost:4318\",\n },\n})\n```\n\nDependency: `go.opentelemetry.io/otel`\n\n
\n\n
\n.NET\n\n\n```csharp\nvar client = new CopilotClient(new CopilotClientOptions\n{\n Telemetry = new TelemetryConfig\n {\n OtlpEndpoint = \"http://localhost:4318\",\n },\n});\n```\n\nNo extra dependencies — uses built-in `System.Diagnostics.Activity`.\n\n
\n\n
\nJava\n\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.json.*;\n\nvar client = new CopilotClient(new CopilotClientOptions()\n .setTelemetry(new TelemetryConfig()\n .setOtlpEndpoint(\"http://localhost:4318\")));\n```\n\nDependency: `io.opentelemetry:opentelemetry-api`\n\n
\n\n### TelemetryConfig Options\n\n| Option | Node.js | Python | Go | Java | .NET | Description |\n|---|---|---|---|---|---|---|\n| OTLP endpoint | `otlpEndpoint` | `otlp_endpoint` | `OTLPEndpoint` | `otlpEndpoint` | `OtlpEndpoint` | OTLP HTTP endpoint URL |\n| File path | `filePath` | `file_path` | `FilePath` | `filePath` | `FilePath` | File path for JSON-lines trace output |\n| Exporter type | `exporterType` | `exporter_type` | `ExporterType` | `exporterType` | `ExporterType` | `\"otlp-http\"` or `\"file\"` |\n| Source name | `sourceName` | `source_name` | `SourceName` | `sourceName` | `SourceName` | Instrumentation scope name |\n| Capture content | `captureContent` | `capture_content` | `CaptureContent` | `captureContent` | `CaptureContent` | Whether to capture message content |\n\n### File Export\n\nTo write traces to a local file instead of an OTLP endpoint:\n\n\n```typescript\nconst client = new CopilotClient({\n telemetry: {\n filePath: \"./traces.jsonl\",\n exporterType: \"file\",\n },\n});\n```\n\n### Trace Context Propagation\n\nTrace context is propagated automatically — no manual instrumentation is needed:\n\n- **SDK → CLI**: `traceparent` and `tracestate` headers from the current span/activity are included in `session.create`, `session.resume`, and `session.send` RPC calls.\n- **CLI → SDK**: When the CLI invokes tool handlers, the trace context from the CLI's span is propagated so your tool code runs under the correct parent span.\n\n📖 **[OpenTelemetry Instrumentation Guide →](./observability/opentelemetry.md)** — TelemetryConfig options, trace context propagation, and per-language dependencies.\n\n---\n\n## Learn More\n\n- [Authentication Guide](./auth/index.md) - GitHub OAuth, environment variables, and BYOK\n- [BYOK (Bring Your Own Key)](./auth/byok.md) - Use your own API keys from Azure AI Foundry, OpenAI, etc.\n- [Node.js SDK Reference](../nodejs/README.md)\n- [Python SDK Reference](../python/README.md)\n- [Go SDK Reference](../go/README.md)\n- [.NET SDK Reference](../dotnet/README.md)\n- [Java SDK Reference](../java/README.md)\n- [Using MCP Servers](./features/mcp.md) - Integrate external tools via Model Context Protocol\n- [GitHub MCP Server Documentation](https://github.com/github/github-mcp-server)\n- [MCP Servers Directory](https://github.com/modelcontextprotocol/servers) - Explore more MCP servers\n- [OpenTelemetry Instrumentation](./observability/opentelemetry.md) - TelemetryConfig, trace context propagation, and per-language dependencies\n\n---\n\n**You did it!** You've learned the core concepts of the GitHub Copilot SDK:\n- ✅ Creating a client and session\n- ✅ Sending messages and receiving responses\n- ✅ Streaming for real-time output\n- ✅ Defining custom tools that Copilot can call\n\nNow go build something amazing! 🚀\n" }, { "path": "docs/hooks/error-handling.md", "content": "# Error Handling Hook\n\nThe `onErrorOccurred` hook is called when errors occur during session execution. Use it to:\n\n- Implement custom error logging\n- Track error patterns\n- Provide user-friendly error messages\n- Trigger alerts for critical errors\n\n## Hook Signature\n\n
\nNode.js / TypeScript\n\n\n```ts\nimport type { ErrorOccurredHookInput, HookInvocation, ErrorOccurredHookOutput } from \"@github/copilot-sdk\";\ntype ErrorOccurredHandler = (\n input: ErrorOccurredHookInput,\n invocation: HookInvocation\n) => Promise;\n```\n\n```typescript\ntype ErrorOccurredHandler = (\n input: ErrorOccurredHookInput,\n invocation: HookInvocation\n) => Promise;\n```\n\n
\n\n
\nPython\n\n\n```python\nfrom copilot.session import ErrorOccurredHookInput, ErrorOccurredHookOutput\nfrom typing import Callable, Awaitable\n\nErrorOccurredHandler = Callable[\n [ErrorOccurredHookInput, dict[str, str]],\n Awaitable[ErrorOccurredHookOutput | None]\n]\n```\n\n```python\nErrorOccurredHandler = Callable[\n [ErrorOccurredHookInput, dict[str, str]],\n Awaitable[ErrorOccurredHookOutput | None]\n]\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport copilot \"github.com/github/copilot-sdk/go\"\n\ntype ErrorOccurredHandler func(\n input copilot.ErrorOccurredHookInput,\n invocation copilot.HookInvocation,\n) (*copilot.ErrorOccurredHookOutput, error)\n\nfunc main() {}\n```\n\n```go\ntype ErrorOccurredHandler func(\n input ErrorOccurredHookInput,\n invocation HookInvocation,\n) (*ErrorOccurredHookOutput, error)\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic delegate Task ErrorOccurredHandler(\n ErrorOccurredHookInput input,\n HookInvocation invocation);\n```\n\n```csharp\npublic delegate Task ErrorOccurredHandler(\n ErrorOccurredHookInput input,\n HookInvocation invocation);\n```\n\n
\n\n
\nJava\n\n```java\n// Note: Java SDK does not have an onErrorOccurred hook.\n// Use EventErrorPolicy and EventErrorHandler instead:\n//\n// session.setEventErrorPolicy(EventErrorPolicy.SUPPRESS_AND_LOG_ERRORS);\n// session.setEventErrorHandler((event, ex) -> {\n// System.err.println(\"Error in \" + event.getType() + \": \" + ex.getMessage());\n// });\n//\n// See the \"Basic Error Logging\" example below for a complete snippet.\n```\n\n
\n\n## Input\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `timestamp` | number | Unix timestamp when the error occurred |\n| `cwd` | string | Current working directory |\n| `error` | string | Error message |\n| `errorContext` | string | Where the error occurred: `\"model_call\"`, `\"tool_execution\"`, `\"system\"`, or `\"user_input\"` |\n| `recoverable` | boolean | Whether the error can potentially be recovered from |\n\n## Output\n\nReturn `null` or `undefined` to use default error handling. Otherwise, return an object with:\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `suppressOutput` | boolean | If true, don't show error output to user |\n| `errorHandling` | string | How to handle: `\"retry\"`, `\"skip\"`, or `\"abort\"` |\n| `retryCount` | number | Number of times to retry (if errorHandling is `\"retry\"`) |\n| `userNotification` | string | Custom message to show the user |\n\n## Examples\n\n### Basic Error Logging\n\n
\nNode.js / TypeScript\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onErrorOccurred: async (input, invocation) => {\n console.error(`[${invocation.sessionId}] Error: ${input.error}`);\n console.error(` Context: ${input.errorContext}`);\n console.error(` Recoverable: ${input.recoverable}`);\n return null;\n },\n },\n});\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot.session import PermissionHandler\n\nasync def on_error_occurred(input_data, invocation):\n print(f\"[{invocation['session_id']}] Error: {input_data['error']}\")\n print(f\" Context: {input_data['errorContext']}\")\n print(f\" Recoverable: {input_data['recoverable']}\")\n return None\n\nsession = await client.create_session(on_permission_request=PermissionHandler.approve_all, hooks={\"on_error_occurred\": on_error_occurred})\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tclient := copilot.NewClient(nil)\n\tsession, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{\n\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\tHooks: &copilot.SessionHooks{\n\t\t\tOnErrorOccurred: func(input copilot.ErrorOccurredHookInput, inv copilot.HookInvocation) (*copilot.ErrorOccurredHookOutput, error) {\n\t\t\t\tfmt.Printf(\"[%s] Error: %s\\n\", inv.SessionID, input.Error)\n\t\t\t\tfmt.Printf(\" Context: %s\\n\", input.ErrorContext)\n\t\t\t\tfmt.Printf(\" Recoverable: %v\\n\", input.Recoverable)\n\t\t\t\treturn nil, nil\n\t\t\t},\n\t\t},\n\t})\n\t_ = session\n}\n```\n\n```go\nsession, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Hooks: &copilot.SessionHooks{\n OnErrorOccurred: func(input copilot.ErrorOccurredHookInput, inv copilot.HookInvocation) (*copilot.ErrorOccurredHookOutput, error) {\n fmt.Printf(\"[%s] Error: %s\\n\", inv.SessionID, input.Error)\n fmt.Printf(\" Context: %s\\n\", input.ErrorContext)\n fmt.Printf(\" Recoverable: %v\\n\", input.Recoverable)\n return nil, nil\n },\n },\n})\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic static class ErrorHandlingExample\n{\n public static async Task Main()\n {\n await using var client = new CopilotClient();\n var session = await client.CreateSessionAsync(new SessionConfig\n {\n Hooks = new SessionHooks\n {\n OnErrorOccurred = (input, invocation) =>\n {\n Console.Error.WriteLine($\"[{invocation.SessionId}] Error: {input.Error}\");\n Console.Error.WriteLine($\" Context: {input.ErrorContext}\");\n Console.Error.WriteLine($\" Recoverable: {input.Recoverable}\");\n return Task.FromResult(null);\n },\n },\n });\n }\n}\n```\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Hooks = new SessionHooks\n {\n OnErrorOccurred = (input, invocation) =>\n {\n Console.Error.WriteLine($\"[{invocation.SessionId}] Error: {input.Error}\");\n Console.Error.WriteLine($\" Context: {input.ErrorContext}\");\n Console.Error.WriteLine($\" Recoverable: {input.Recoverable}\");\n return Task.FromResult(null);\n },\n },\n});\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.*;\nimport com.github.copilot.sdk.json.*;\n\n// Note: Java SDK does not have an onErrorOccurred hook.\n// Use EventErrorPolicy and EventErrorHandler instead:\n\nvar session = client.createSession(\n new SessionConfig()\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n).get();\n\nsession.setEventErrorPolicy(EventErrorPolicy.SUPPRESS_AND_LOG_ERRORS);\nsession.setEventErrorHandler((event, ex) -> {\n System.err.println(\"[\" + session.getSessionId() + \"] Error: \" + ex.getMessage());\n System.err.println(\" Event: \" + event.getType());\n});\n```\n\n
\n\n### Send Errors to Monitoring Service\n\n```typescript\nimport { captureException } from \"@sentry/node\"; // or your monitoring service\n\nconst session = await client.createSession({\n hooks: {\n onErrorOccurred: async (input, invocation) => {\n captureException(new Error(input.error), {\n tags: {\n sessionId: invocation.sessionId,\n errorContext: input.errorContext,\n },\n extra: {\n error: input.error,\n recoverable: input.recoverable,\n cwd: input.cwd,\n },\n });\n \n return null;\n },\n },\n});\n```\n\n### User-Friendly Error Messages\n\n```typescript\nconst ERROR_MESSAGES: Record = {\n \"model_call\": \"There was an issue communicating with the AI model. Please try again.\",\n \"tool_execution\": \"A tool failed to execute. Please check your inputs and try again.\",\n \"system\": \"A system error occurred. Please try again later.\",\n \"user_input\": \"There was an issue with your input. Please check and try again.\",\n};\n\nconst session = await client.createSession({\n hooks: {\n onErrorOccurred: async (input) => {\n const friendlyMessage = ERROR_MESSAGES[input.errorContext];\n \n if (friendlyMessage) {\n return {\n userNotification: friendlyMessage,\n };\n }\n \n return null;\n },\n },\n});\n```\n\n### Suppress Non-Critical Errors\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onErrorOccurred: async (input) => {\n // Suppress tool execution errors that are recoverable\n if (input.errorContext === \"tool_execution\" && input.recoverable) {\n console.log(`Suppressed recoverable error: ${input.error}`);\n return { suppressOutput: true };\n }\n return null;\n },\n },\n});\n```\n\n### Add Recovery Context\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onErrorOccurred: async (input) => {\n if (input.errorContext === \"tool_execution\") {\n return {\n userNotification: `\nThe tool failed. Here are some recovery suggestions:\n- Check if required dependencies are installed\n- Verify file paths are correct\n- Try a simpler approach\n `.trim(),\n };\n }\n \n if (input.errorContext === \"model_call\" && input.error.includes(\"rate\")) {\n return {\n errorHandling: \"retry\",\n retryCount: 3,\n userNotification: \"Rate limit hit. Retrying...\",\n };\n }\n \n return null;\n },\n },\n});\n```\n\n### Track Error Patterns\n\n```typescript\ninterface ErrorStats {\n count: number;\n lastOccurred: number;\n contexts: string[];\n}\n\nconst errorStats = new Map();\n\nconst session = await client.createSession({\n hooks: {\n onErrorOccurred: async (input, invocation) => {\n const key = `${input.errorContext}:${input.error.substring(0, 50)}`;\n \n const existing = errorStats.get(key) || {\n count: 0,\n lastOccurred: 0,\n contexts: [],\n };\n \n existing.count++;\n existing.lastOccurred = input.timestamp;\n existing.contexts.push(invocation.sessionId);\n \n errorStats.set(key, existing);\n \n // Alert if error is recurring\n if (existing.count >= 5) {\n console.warn(`Recurring error detected: ${key} (${existing.count} times)`);\n }\n \n return null;\n },\n },\n});\n```\n\n### Alert on Critical Errors\n\n```typescript\nconst CRITICAL_CONTEXTS = [\"system\", \"model_call\"];\n\nconst session = await client.createSession({\n hooks: {\n onErrorOccurred: async (input, invocation) => {\n if (CRITICAL_CONTEXTS.includes(input.errorContext) && !input.recoverable) {\n await sendAlert({\n level: \"critical\",\n message: `Critical error in session ${invocation.sessionId}`,\n error: input.error,\n context: input.errorContext,\n timestamp: new Date(input.timestamp).toISOString(),\n });\n }\n \n return null;\n },\n },\n});\n```\n\n### Combine with Other Hooks for Context\n\n```typescript\nconst sessionContext = new Map();\n\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input, invocation) => {\n const ctx = sessionContext.get(invocation.sessionId) || {};\n ctx.lastTool = input.toolName;\n sessionContext.set(invocation.sessionId, ctx);\n return { permissionDecision: \"allow\" };\n },\n \n onUserPromptSubmitted: async (input, invocation) => {\n const ctx = sessionContext.get(invocation.sessionId) || {};\n ctx.lastPrompt = input.prompt.substring(0, 100);\n sessionContext.set(invocation.sessionId, ctx);\n return null;\n },\n \n onErrorOccurred: async (input, invocation) => {\n const ctx = sessionContext.get(invocation.sessionId);\n \n console.error(`Error in session ${invocation.sessionId}:`);\n console.error(` Error: ${input.error}`);\n console.error(` Context: ${input.errorContext}`);\n if (ctx?.lastTool) {\n console.error(` Last tool: ${ctx.lastTool}`);\n }\n if (ctx?.lastPrompt) {\n console.error(` Last prompt: ${ctx.lastPrompt}...`);\n }\n \n return null;\n },\n },\n});\n```\n\n## Best Practices\n\n1. **Always log errors** - Even if you suppress them from users, keep logs for debugging.\n\n2. **Categorize errors** - Use `errorType` to handle different errors appropriately.\n\n3. **Don't swallow critical errors** - Only suppress errors you're certain are non-critical.\n\n4. **Keep hooks fast** - Error handling shouldn't slow down recovery.\n\n5. **Provide helpful context** - When errors occur, `additionalContext` can help the model recover.\n\n6. **Monitor error patterns** - Track recurring errors to identify systemic issues.\n\n## See Also\n\n- [Hooks Overview](./index.md)\n- [Session Lifecycle Hooks](./session-lifecycle.md)\n- [Debugging Guide](../troubleshooting/debugging.md)\n" }, { "path": "docs/hooks/index.md", "content": "# Session Hooks\n\nHooks allow you to intercept and customize the behavior of Copilot sessions at key points in the conversation lifecycle. Use hooks to:\n\n- **Control tool execution** - approve, deny, or modify tool calls\n- **Transform results** - modify tool outputs before they're processed\n- **Add context** - inject additional information at session start\n- **Handle errors** - implement custom error handling\n- **Audit and log** - track all interactions for compliance\n\n## Available Hooks\n\n| Hook | Trigger | Use Case |\n|------|---------|----------|\n| [`onPreToolUse`](./pre-tool-use.md) | Before a tool executes | Permission control, argument validation |\n| [`onPostToolUse`](./post-tool-use.md) | After a tool executes | Result transformation, logging |\n| [`onUserPromptSubmitted`](./user-prompt-submitted.md) | When user sends a message | Prompt modification, filtering |\n| [`onSessionStart`](./session-lifecycle.md#session-start) | Session begins | Add context, configure session |\n| [`onSessionEnd`](./session-lifecycle.md#session-end) | Session ends | Cleanup, analytics |\n| [`onErrorOccurred`](./error-handling.md) | Error happens | Custom error handling |\n\n## Quick Start\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\n\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n console.log(`Tool called: ${input.toolName}`);\n // Allow all tools\n return { permissionDecision: \"allow\" };\n },\n onPostToolUse: async (input) => {\n console.log(`Tool result: ${JSON.stringify(input.toolResult)}`);\n return null; // No modifications\n },\n onSessionStart: async (input) => {\n return { additionalContext: \"User prefers concise answers.\" };\n },\n },\n});\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionHandler\n\nasync def main():\n client = CopilotClient()\n await client.start()\n\n async def on_pre_tool_use(input_data, invocation):\n print(f\"Tool called: {input_data['toolName']}\")\n return {\"permissionDecision\": \"allow\"}\n\n async def on_post_tool_use(input_data, invocation):\n print(f\"Tool result: {input_data['toolResult']}\")\n return None\n\n async def on_session_start(input_data, invocation):\n return {\"additionalContext\": \"User prefers concise answers.\"}\n\n session = await client.create_session(on_permission_request=PermissionHandler.approve_all, hooks={\n \"on_pre_tool_use\": on_pre_tool_use,\n \"on_post_tool_use\": on_post_tool_use,\n \"on_session_start\": on_session_start,\n })\n```\n\n
\n\n
\nGo\n\n```go\npackage main\n\nimport (\n \"context\"\n \"fmt\"\n copilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n client := copilot.NewClient(nil)\n\n session, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Hooks: &copilot.SessionHooks{\n OnPreToolUse: func(input copilot.PreToolUseHookInput, inv copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {\n fmt.Printf(\"Tool called: %s\\n\", input.ToolName)\n return &copilot.PreToolUseHookOutput{\n PermissionDecision: \"allow\",\n }, nil\n },\n OnPostToolUse: func(input copilot.PostToolUseHookInput, inv copilot.HookInvocation) (*copilot.PostToolUseHookOutput, error) {\n fmt.Printf(\"Tool result: %v\\n\", input.ToolResult)\n return nil, nil\n },\n OnSessionStart: func(input copilot.SessionStartHookInput, inv copilot.HookInvocation) (*copilot.SessionStartHookOutput, error) {\n return &copilot.SessionStartHookOutput{\n AdditionalContext: \"User prefers concise answers.\",\n }, nil\n },\n },\n })\n _ = session\n}\n```\n\n
\n\n
\n.NET\n\n```csharp\nusing GitHub.Copilot.SDK;\n\nvar client = new CopilotClient();\n\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Hooks = new SessionHooks\n {\n OnPreToolUse = (input, invocation) =>\n {\n Console.WriteLine($\"Tool called: {input.ToolName}\");\n return Task.FromResult(\n new PreToolUseHookOutput { PermissionDecision = \"allow\" }\n );\n },\n OnPostToolUse = (input, invocation) =>\n {\n Console.WriteLine($\"Tool result: {input.ToolResult}\");\n return Task.FromResult(null);\n },\n OnSessionStart = (input, invocation) =>\n {\n return Task.FromResult(\n new SessionStartHookOutput { AdditionalContext = \"User prefers concise answers.\" }\n );\n },\n },\n});\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.*;\nimport com.github.copilot.sdk.json.*;\nimport java.util.concurrent.CompletableFuture;\n\ntry (var client = new CopilotClient()) {\n client.start().get();\n\n var hooks = new SessionHooks()\n .setOnPreToolUse((input, invocation) -> {\n System.out.println(\"Tool called: \" + input.getToolName());\n return CompletableFuture.completedFuture(PreToolUseHookOutput.allow());\n })\n .setOnPostToolUse((input, invocation) -> {\n System.out.println(\"Tool result: \" + input.getToolResult());\n return CompletableFuture.completedFuture(null);\n })\n .setOnSessionStart((input, invocation) -> {\n return CompletableFuture.completedFuture(\n new SessionStartHookOutput(\"User prefers concise answers.\", null)\n );\n });\n\n var session = client.createSession(\n new SessionConfig()\n .setHooks(hooks)\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n ).get();\n}\n```\n\n
\n\n## Hook Invocation Context\n\nEvery hook receives an `invocation` parameter with context about the current session:\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `sessionId` | string | The ID of the current session |\n\nThis allows hooks to maintain state or perform session-specific logic.\n\n## Common Patterns\n\n### Logging All Tool Calls\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n console.log(`[${new Date().toISOString()}] Tool: ${input.toolName}, Args: ${JSON.stringify(input.toolArgs)}`);\n return { permissionDecision: \"allow\" };\n },\n onPostToolUse: async (input) => {\n console.log(`[${new Date().toISOString()}] Result: ${JSON.stringify(input.toolResult)}`);\n return null;\n },\n },\n});\n```\n\n### Blocking Dangerous Tools\n\n```typescript\nconst BLOCKED_TOOLS = [\"shell\", \"bash\", \"exec\"];\n\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n if (BLOCKED_TOOLS.includes(input.toolName)) {\n return {\n permissionDecision: \"deny\",\n permissionDecisionReason: \"Shell access is not permitted\",\n };\n }\n return { permissionDecision: \"allow\" };\n },\n },\n});\n```\n\n### Adding User Context\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async () => {\n const userPrefs = await loadUserPreferences();\n return {\n additionalContext: `User preferences: ${JSON.stringify(userPrefs)}`,\n };\n },\n },\n});\n```\n\n## Hook Guides\n\n- **[Pre-Tool Use Hook](./pre-tool-use.md)** - Control tool execution permissions\n- **[Post-Tool Use Hook](./post-tool-use.md)** - Transform tool results\n- **[User Prompt Submitted Hook](./user-prompt-submitted.md)** - Modify user prompts\n- **[Session Lifecycle Hooks](./session-lifecycle.md)** - Session start and end\n- **[Error Handling Hook](./error-handling.md)** - Custom error handling\n\n## See Also\n\n- [Getting Started Guide](../getting-started.md)\n- [Custom Tools](../getting-started.md#step-4-add-a-custom-tool)\n- [Debugging Guide](../troubleshooting/debugging.md)\n" }, { "path": "docs/hooks/post-tool-use.md", "content": "# Post-Tool Use Hook\n\nThe `onPostToolUse` hook is called **after** a tool executes. Use it to:\n\n- Transform or filter tool results\n- Log tool execution for auditing\n- Add context based on results\n- Suppress results from the conversation\n\n## Hook Signature\n\n
\nNode.js / TypeScript\n\n\n```ts\nimport type { PostToolUseHookInput, HookInvocation, PostToolUseHookOutput } from \"@github/copilot-sdk\";\ntype PostToolUseHandler = (\n input: PostToolUseHookInput,\n invocation: HookInvocation\n) => Promise;\n```\n\n```typescript\ntype PostToolUseHandler = (\n input: PostToolUseHookInput,\n invocation: HookInvocation\n) => Promise;\n```\n\n
\n\n
\nPython\n\n\n```python\nfrom copilot.session import PostToolUseHookInput, PostToolUseHookOutput\nfrom typing import Callable, Awaitable\n\nPostToolUseHandler = Callable[\n [PostToolUseHookInput, dict[str, str]],\n Awaitable[PostToolUseHookOutput | None]\n]\n```\n\n```python\nPostToolUseHandler = Callable[\n [PostToolUseHookInput, dict[str, str]],\n Awaitable[PostToolUseHookOutput | None]\n]\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport copilot \"github.com/github/copilot-sdk/go\"\n\ntype PostToolUseHandler func(\n input copilot.PostToolUseHookInput,\n invocation copilot.HookInvocation,\n) (*copilot.PostToolUseHookOutput, error)\n\nfunc main() {}\n```\n\n```go\ntype PostToolUseHandler func(\n input PostToolUseHookInput,\n invocation HookInvocation,\n) (*PostToolUseHookOutput, error)\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic delegate Task PostToolUseHandler(\n PostToolUseHookInput input,\n HookInvocation invocation);\n```\n\n```csharp\npublic delegate Task PostToolUseHandler(\n PostToolUseHookInput input,\n HookInvocation invocation);\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.json.*;\n\nPostToolUseHandler postToolUseHandler;\n```\n\n
\n\n## Input\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `timestamp` | number | Unix timestamp when the hook was triggered |\n| `cwd` | string | Current working directory |\n| `toolName` | string | Name of the tool that was called |\n| `toolArgs` | object | Arguments that were passed to the tool |\n| `toolResult` | object | Result returned by the tool |\n\n## Output\n\nReturn `null` or `undefined` to pass through the result unchanged. Otherwise, return an object with any of these fields:\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `modifiedResult` | object | Modified result to use instead of original |\n| `additionalContext` | string | Extra context injected into the conversation |\n| `suppressOutput` | boolean | If true, result won't appear in conversation |\n\n## Examples\n\n### Log All Tool Results\n\n
\nNode.js / TypeScript\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onPostToolUse: async (input, invocation) => {\n console.log(`[${invocation.sessionId}] Tool: ${input.toolName}`);\n console.log(` Args: ${JSON.stringify(input.toolArgs)}`);\n console.log(` Result: ${JSON.stringify(input.toolResult)}`);\n return null; // Pass through unchanged\n },\n },\n});\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot.session import PermissionHandler\n\nasync def on_post_tool_use(input_data, invocation):\n print(f\"[{invocation['session_id']}] Tool: {input_data['toolName']}\")\n print(f\" Args: {input_data['toolArgs']}\")\n print(f\" Result: {input_data['toolResult']}\")\n return None # Pass through unchanged\n\nsession = await client.create_session(on_permission_request=PermissionHandler.approve_all, hooks={\"on_post_tool_use\": on_post_tool_use})\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tclient := copilot.NewClient(nil)\n\tsession, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{\n\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\tHooks: &copilot.SessionHooks{\n\t\t\tOnPostToolUse: func(input copilot.PostToolUseHookInput, inv copilot.HookInvocation) (*copilot.PostToolUseHookOutput, error) {\n\t\t\t\tfmt.Printf(\"[%s] Tool: %s\\n\", inv.SessionID, input.ToolName)\n\t\t\t\tfmt.Printf(\" Args: %v\\n\", input.ToolArgs)\n\t\t\t\tfmt.Printf(\" Result: %v\\n\", input.ToolResult)\n\t\t\t\treturn nil, nil\n\t\t\t},\n\t\t},\n\t})\n\t_ = session\n}\n```\n\n```go\nsession, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Hooks: &copilot.SessionHooks{\n OnPostToolUse: func(input copilot.PostToolUseHookInput, inv copilot.HookInvocation) (*copilot.PostToolUseHookOutput, error) {\n fmt.Printf(\"[%s] Tool: %s\\n\", inv.SessionID, input.ToolName)\n fmt.Printf(\" Args: %v\\n\", input.ToolArgs)\n fmt.Printf(\" Result: %v\\n\", input.ToolResult)\n return nil, nil\n },\n },\n})\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic static class PostToolUseExample\n{\n public static async Task Main()\n {\n await using var client = new CopilotClient();\n var session = await client.CreateSessionAsync(new SessionConfig\n {\n Hooks = new SessionHooks\n {\n OnPostToolUse = (input, invocation) =>\n {\n Console.WriteLine($\"[{invocation.SessionId}] Tool: {input.ToolName}\");\n Console.WriteLine($\" Args: {input.ToolArgs}\");\n Console.WriteLine($\" Result: {input.ToolResult}\");\n return Task.FromResult(null);\n },\n },\n });\n }\n}\n```\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Hooks = new SessionHooks\n {\n OnPostToolUse = (input, invocation) =>\n {\n Console.WriteLine($\"[{invocation.SessionId}] Tool: {input.ToolName}\");\n Console.WriteLine($\" Args: {input.ToolArgs}\");\n Console.WriteLine($\" Result: {input.ToolResult}\");\n return Task.FromResult(null);\n },\n },\n});\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.*;\nimport com.github.copilot.sdk.json.*;\nimport java.util.concurrent.CompletableFuture;\n\nvar hooks = new SessionHooks()\n .setOnPostToolUse((input, invocation) -> {\n System.out.println(\"[\" + invocation.getSessionId() + \"] Tool: \" + input.getToolName());\n System.out.println(\" Args: \" + input.getToolArgs());\n System.out.println(\" Result: \" + input.getToolResult());\n return CompletableFuture.completedFuture(null);\n });\n\nvar session = client.createSession(\n new SessionConfig()\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n .setHooks(hooks)\n).get();\n```\n\n
\n\n### Redact Sensitive Data\n\n```typescript\nconst SENSITIVE_PATTERNS = [\n /api[_-]?key[\"\\s:=]+[\"']?[\\w-]+[\"']?/gi,\n /password[\"\\s:=]+[\"']?[\\w-]+[\"']?/gi,\n /secret[\"\\s:=]+[\"']?[\\w-]+[\"']?/gi,\n];\n\nconst session = await client.createSession({\n hooks: {\n onPostToolUse: async (input) => {\n if (typeof input.toolResult === \"string\") {\n let redacted = input.toolResult;\n for (const pattern of SENSITIVE_PATTERNS) {\n redacted = redacted.replace(pattern, \"[REDACTED]\");\n }\n \n if (redacted !== input.toolResult) {\n return { modifiedResult: redacted };\n }\n }\n return null;\n },\n },\n});\n```\n\n### Truncate Large Results\n\n```typescript\nconst MAX_RESULT_LENGTH = 10000;\n\nconst session = await client.createSession({\n hooks: {\n onPostToolUse: async (input) => {\n const resultStr = JSON.stringify(input.toolResult);\n \n if (resultStr.length > MAX_RESULT_LENGTH) {\n return {\n modifiedResult: {\n truncated: true,\n originalLength: resultStr.length,\n content: resultStr.substring(0, MAX_RESULT_LENGTH) + \"...\",\n },\n additionalContext: `Note: Result was truncated from ${resultStr.length} to ${MAX_RESULT_LENGTH} characters.`,\n };\n }\n return null;\n },\n },\n});\n```\n\n### Add Context Based on Results\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onPostToolUse: async (input) => {\n // If a file read returned an error, add helpful context\n if (input.toolName === \"read_file\" && input.toolResult?.error) {\n return {\n additionalContext: \"Tip: If the file doesn't exist, consider creating it or checking the path.\",\n };\n }\n \n // If shell command failed, add debugging hint\n if (input.toolName === \"shell\" && input.toolResult?.exitCode !== 0) {\n return {\n additionalContext: \"The command failed. Check if required dependencies are installed.\",\n };\n }\n \n return null;\n },\n },\n});\n```\n\n### Filter Error Stack Traces\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onPostToolUse: async (input) => {\n if (input.toolResult?.error && input.toolResult?.stack) {\n // Remove internal stack trace details\n return {\n modifiedResult: {\n error: input.toolResult.error,\n // Keep only first 3 lines of stack\n stack: input.toolResult.stack.split(\"\\n\").slice(0, 3).join(\"\\n\"),\n },\n };\n }\n return null;\n },\n },\n});\n```\n\n### Audit Trail for Compliance\n\n```typescript\ninterface AuditEntry {\n timestamp: number;\n sessionId: string;\n toolName: string;\n args: unknown;\n result: unknown;\n success: boolean;\n}\n\nconst auditLog: AuditEntry[] = [];\n\nconst session = await client.createSession({\n hooks: {\n onPostToolUse: async (input, invocation) => {\n auditLog.push({\n timestamp: input.timestamp,\n sessionId: invocation.sessionId,\n toolName: input.toolName,\n args: input.toolArgs,\n result: input.toolResult,\n success: !input.toolResult?.error,\n });\n \n // Optionally persist to database/file\n await saveAuditLog(auditLog);\n \n return null;\n },\n },\n});\n```\n\n### Suppress Noisy Results\n\n```typescript\nconst NOISY_TOOLS = [\"list_directory\", \"search_codebase\"];\n\nconst session = await client.createSession({\n hooks: {\n onPostToolUse: async (input) => {\n if (NOISY_TOOLS.includes(input.toolName)) {\n // Summarize instead of showing full result\n const items = Array.isArray(input.toolResult) \n ? input.toolResult \n : input.toolResult?.items || [];\n \n return {\n modifiedResult: {\n summary: `Found ${items.length} items`,\n firstFew: items.slice(0, 5),\n },\n };\n }\n return null;\n },\n },\n});\n```\n\n## Best Practices\n\n1. **Return `null` when no changes needed** - This is more efficient than returning an empty object or the same result.\n\n2. **Be careful with result modification** - Changing results can affect how the model interprets tool output. Only modify when necessary.\n\n3. **Use `additionalContext` for hints** - Instead of modifying results, add context to help the model interpret them.\n\n4. **Consider privacy when logging** - Tool results may contain sensitive data. Apply redaction before logging.\n\n5. **Keep hooks fast** - Post-tool hooks run synchronously. Heavy processing should be done asynchronously or batched.\n\n## See Also\n\n- [Hooks Overview](./index.md)\n- [Pre-Tool Use Hook](./pre-tool-use.md)\n- [Error Handling Hook](./error-handling.md)\n" }, { "path": "docs/hooks/pre-tool-use.md", "content": "# Pre-Tool Use Hook\n\nThe `onPreToolUse` hook is called **before** a tool executes. Use it to:\n\n- Approve or deny tool execution\n- Modify tool arguments\n- Add context for the tool\n- Suppress tool output from the conversation\n\n## Hook Signature\n\n
\nNode.js / TypeScript\n\n\n```ts\nimport type { PreToolUseHookInput, HookInvocation, PreToolUseHookOutput } from \"@github/copilot-sdk\";\ntype PreToolUseHandler = (\n input: PreToolUseHookInput,\n invocation: HookInvocation\n) => Promise;\n```\n\n```typescript\ntype PreToolUseHandler = (\n input: PreToolUseHookInput,\n invocation: HookInvocation\n) => Promise;\n```\n\n
\n\n
\nPython\n\n\n```python\nfrom copilot.session import PreToolUseHookInput, PreToolUseHookOutput\nfrom typing import Callable, Awaitable\n\nPreToolUseHandler = Callable[\n [PreToolUseHookInput, dict[str, str]],\n Awaitable[PreToolUseHookOutput | None]\n]\n```\n\n```python\nPreToolUseHandler = Callable[\n [PreToolUseHookInput, dict[str, str]],\n Awaitable[PreToolUseHookOutput | None]\n]\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport copilot \"github.com/github/copilot-sdk/go\"\n\ntype PreToolUseHandler func(\n input copilot.PreToolUseHookInput,\n invocation copilot.HookInvocation,\n) (*copilot.PreToolUseHookOutput, error)\n\nfunc main() {}\n```\n\n```go\ntype PreToolUseHandler func(\n input PreToolUseHookInput,\n invocation HookInvocation,\n) (*PreToolUseHookOutput, error)\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic delegate Task PreToolUseHandler(\n PreToolUseHookInput input,\n HookInvocation invocation);\n```\n\n```csharp\npublic delegate Task PreToolUseHandler(\n PreToolUseHookInput input,\n HookInvocation invocation);\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.json.*;\n\nPreToolUseHandler preToolUseHandler;\n```\n\n
\n\n## Input\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `timestamp` | number | Unix timestamp when the hook was triggered |\n| `cwd` | string | Current working directory |\n| `toolName` | string | Name of the tool being called |\n| `toolArgs` | object | Arguments passed to the tool |\n\n## Output\n\nReturn `null` or `undefined` to allow the tool to execute with no changes. Otherwise, return an object with any of these fields:\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `permissionDecision` | `\"allow\"` \\| `\"deny\"` \\| `\"ask\"` | Whether to allow the tool call |\n| `permissionDecisionReason` | string | Explanation shown to user (for deny/ask) |\n| `modifiedArgs` | object | Modified arguments to pass to the tool |\n| `additionalContext` | string | Extra context injected into the conversation |\n| `suppressOutput` | boolean | If true, tool output won't appear in conversation |\n\n### Permission Decisions\n\n| Decision | Behavior |\n|----------|----------|\n| `\"allow\"` | Tool executes normally |\n| `\"deny\"` | Tool is blocked, reason shown to user |\n| `\"ask\"` | User is prompted to approve (interactive mode) |\n\n## Examples\n\n### Allow All Tools (Logging Only)\n\n
\nNode.js / TypeScript\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input, invocation) => {\n console.log(`[${invocation.sessionId}] Calling ${input.toolName}`);\n console.log(` Args: ${JSON.stringify(input.toolArgs)}`);\n return { permissionDecision: \"allow\" };\n },\n },\n});\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot.session import PermissionHandler\n\nasync def on_pre_tool_use(input_data, invocation):\n print(f\"[{invocation['session_id']}] Calling {input_data['toolName']}\")\n print(f\" Args: {input_data['toolArgs']}\")\n return {\"permissionDecision\": \"allow\"}\n\nsession = await client.create_session(on_permission_request=PermissionHandler.approve_all, hooks={\"on_pre_tool_use\": on_pre_tool_use})\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tclient := copilot.NewClient(nil)\n\tsession, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{\n\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\tHooks: &copilot.SessionHooks{\n\t\t\tOnPreToolUse: func(input copilot.PreToolUseHookInput, inv copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {\n\t\t\t\tfmt.Printf(\"[%s] Calling %s\\n\", inv.SessionID, input.ToolName)\n\t\t\t\tfmt.Printf(\" Args: %v\\n\", input.ToolArgs)\n\t\t\t\treturn &copilot.PreToolUseHookOutput{\n\t\t\t\t\tPermissionDecision: \"allow\",\n\t\t\t\t}, nil\n\t\t\t},\n\t\t},\n\t})\n\t_ = session\n}\n```\n\n```go\nsession, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Hooks: &copilot.SessionHooks{\n OnPreToolUse: func(input copilot.PreToolUseHookInput, inv copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {\n fmt.Printf(\"[%s] Calling %s\\n\", inv.SessionID, input.ToolName)\n fmt.Printf(\" Args: %v\\n\", input.ToolArgs)\n return &copilot.PreToolUseHookOutput{\n PermissionDecision: \"allow\",\n }, nil\n },\n },\n})\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic static class PreToolUseExample\n{\n public static async Task Main()\n {\n await using var client = new CopilotClient();\n var session = await client.CreateSessionAsync(new SessionConfig\n {\n Hooks = new SessionHooks\n {\n OnPreToolUse = (input, invocation) =>\n {\n Console.WriteLine($\"[{invocation.SessionId}] Calling {input.ToolName}\");\n Console.WriteLine($\" Args: {input.ToolArgs}\");\n return Task.FromResult(\n new PreToolUseHookOutput { PermissionDecision = \"allow\" }\n );\n },\n },\n });\n }\n}\n```\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Hooks = new SessionHooks\n {\n OnPreToolUse = (input, invocation) =>\n {\n Console.WriteLine($\"[{invocation.SessionId}] Calling {input.ToolName}\");\n Console.WriteLine($\" Args: {input.ToolArgs}\");\n return Task.FromResult(\n new PreToolUseHookOutput { PermissionDecision = \"allow\" }\n );\n },\n },\n});\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.*;\nimport com.github.copilot.sdk.json.*;\nimport java.util.concurrent.CompletableFuture;\n\nvar hooks = new SessionHooks()\n .setOnPreToolUse((input, invocation) -> {\n System.out.println(\"[\" + invocation.getSessionId() + \"] Calling \" + input.getToolName());\n System.out.println(\" Args: \" + input.getToolArgs());\n return CompletableFuture.completedFuture(PreToolUseHookOutput.allow());\n });\n\nvar session = client.createSession(\n new SessionConfig()\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n .setHooks(hooks)\n).get();\n```\n\n
\n\n### Block Specific Tools\n\n```typescript\nconst BLOCKED_TOOLS = [\"shell\", \"bash\", \"write_file\", \"delete_file\"];\n\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n if (BLOCKED_TOOLS.includes(input.toolName)) {\n return {\n permissionDecision: \"deny\",\n permissionDecisionReason: `Tool '${input.toolName}' is not permitted in this environment`,\n };\n }\n return { permissionDecision: \"allow\" };\n },\n },\n});\n```\n\n### Modify Tool Arguments\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n // Add a default timeout to all shell commands\n if (input.toolName === \"shell\" && input.toolArgs) {\n const args = input.toolArgs as { command: string; timeout?: number };\n return {\n permissionDecision: \"allow\",\n modifiedArgs: {\n ...args,\n timeout: args.timeout ?? 30000, // Default 30s timeout\n },\n };\n }\n return { permissionDecision: \"allow\" };\n },\n },\n});\n```\n\n### Restrict File Access to Specific Directories\n\n```typescript\nconst ALLOWED_DIRECTORIES = [\"/home/user/projects\", \"/tmp\"];\n\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n if (input.toolName === \"read_file\" || input.toolName === \"write_file\") {\n const args = input.toolArgs as { path: string };\n const isAllowed = ALLOWED_DIRECTORIES.some(dir => \n args.path.startsWith(dir)\n );\n \n if (!isAllowed) {\n return {\n permissionDecision: \"deny\",\n permissionDecisionReason: `Access to '${args.path}' is not permitted. Allowed directories: ${ALLOWED_DIRECTORIES.join(\", \")}`,\n };\n }\n }\n return { permissionDecision: \"allow\" };\n },\n },\n});\n```\n\n### Suppress Verbose Tool Output\n\n```typescript\nconst VERBOSE_TOOLS = [\"list_directory\", \"search_files\"];\n\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n return {\n permissionDecision: \"allow\",\n suppressOutput: VERBOSE_TOOLS.includes(input.toolName),\n };\n },\n },\n});\n```\n\n### Add Context Based on Tool\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onPreToolUse: async (input) => {\n if (input.toolName === \"query_database\") {\n return {\n permissionDecision: \"allow\",\n additionalContext: \"Remember: This database uses PostgreSQL syntax. Always use parameterized queries.\",\n };\n }\n return { permissionDecision: \"allow\" };\n },\n },\n});\n```\n\n## Best Practices\n\n1. **Always return a decision** - Returning `null` allows the tool, but being explicit with `{ permissionDecision: \"allow\" }` is clearer.\n\n2. **Provide helpful denial reasons** - When denying, explain why so users understand:\n ```typescript\n return {\n permissionDecision: \"deny\",\n permissionDecisionReason: \"Shell commands require approval. Please describe what you want to accomplish.\",\n };\n ```\n\n3. **Be careful with argument modification** - Ensure modified args maintain the expected schema for the tool.\n\n4. **Consider performance** - Pre-tool hooks run synchronously before each tool call. Keep them fast.\n\n5. **Use `suppressOutput` judiciously** - Suppressing output means the model won't see the result, which may affect conversation quality.\n\n## See Also\n\n- [Hooks Overview](./index.md)\n- [Post-Tool Use Hook](./post-tool-use.md)\n- [Debugging Guide](../troubleshooting/debugging.md)\n" }, { "path": "docs/hooks/session-lifecycle.md", "content": "# Session Lifecycle Hooks\n\nSession lifecycle hooks let you respond to session start and end events. Use them to:\n\n- Initialize context when sessions begin\n- Clean up resources when sessions end\n- Track session metrics and analytics\n- Configure session behavior dynamically\n\n## Session Start Hook {#session-start}\n\nThe `onSessionStart` hook is called when a session begins (new or resumed).\n\n### Hook Signature\n\n
\nNode.js / TypeScript\n\n\n```ts\nimport type { SessionStartHookInput, HookInvocation, SessionStartHookOutput } from \"@github/copilot-sdk\";\ntype SessionStartHandler = (\n input: SessionStartHookInput,\n invocation: HookInvocation\n) => Promise;\n```\n\n```typescript\ntype SessionStartHandler = (\n input: SessionStartHookInput,\n invocation: HookInvocation\n) => Promise;\n```\n\n
\n\n
\nPython\n\n\n```python\nfrom copilot.session import SessionStartHookInput, SessionStartHookOutput\nfrom typing import Callable, Awaitable\n\nSessionStartHandler = Callable[\n [SessionStartHookInput, dict[str, str]],\n Awaitable[SessionStartHookOutput | None]\n]\n```\n\n```python\nSessionStartHandler = Callable[\n [SessionStartHookInput, dict[str, str]],\n Awaitable[SessionStartHookOutput | None]\n]\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport copilot \"github.com/github/copilot-sdk/go\"\n\ntype SessionStartHandler func(\n input copilot.SessionStartHookInput,\n invocation copilot.HookInvocation,\n) (*copilot.SessionStartHookOutput, error)\n\nfunc main() {}\n```\n\n```go\ntype SessionStartHandler func(\n input SessionStartHookInput,\n invocation HookInvocation,\n) (*SessionStartHookOutput, error)\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic delegate Task SessionStartHandler(\n SessionStartHookInput input,\n HookInvocation invocation);\n```\n\n```csharp\npublic delegate Task SessionStartHandler(\n SessionStartHookInput input,\n HookInvocation invocation);\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.json.*;\n\nSessionStartHandler sessionStartHandler;\n```\n\n
\n\n### Input\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `timestamp` | number | Unix timestamp when the hook was triggered |\n| `cwd` | string | Current working directory |\n| `source` | `\"startup\"` \\| `\"resume\"` \\| `\"new\"` | How the session was started |\n| `initialPrompt` | string \\| undefined | The initial prompt if provided |\n\n### Output\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `additionalContext` | string | Context to add at session start |\n| `modifiedConfig` | object | Override session configuration |\n\n### Examples\n\n#### Add Project Context at Start\n\n
\nNode.js / TypeScript\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async (input, invocation) => {\n console.log(`Session ${invocation.sessionId} started (${input.source})`);\n \n const projectInfo = await detectProjectType(input.cwd);\n \n return {\n additionalContext: `\nThis is a ${projectInfo.type} project.\nMain language: ${projectInfo.language}\nPackage manager: ${projectInfo.packageManager}\n `.trim(),\n };\n },\n },\n});\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot.session import PermissionHandler\n\nasync def on_session_start(input_data, invocation):\n print(f\"Session {invocation['session_id']} started ({input_data['source']})\")\n \n project_info = await detect_project_type(input_data[\"cwd\"])\n \n return {\n \"additionalContext\": f\"\"\"\nThis is a {project_info['type']} project.\nMain language: {project_info['language']}\nPackage manager: {project_info['packageManager']}\n \"\"\".strip()\n }\n\nsession = await client.create_session(on_permission_request=PermissionHandler.approve_all, hooks={\"on_session_start\": on_session_start})\n```\n\n
\n\n#### Handle Session Resume\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async (input, invocation) => {\n if (input.source === \"resume\") {\n // Load previous session state\n const previousState = await loadSessionState(invocation.sessionId);\n \n return {\n additionalContext: `\nSession resumed. Previous context:\n- Last topic: ${previousState.lastTopic}\n- Open files: ${previousState.openFiles.join(\", \")}\n `.trim(),\n };\n }\n return null;\n },\n },\n});\n```\n\n#### Load User Preferences\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async () => {\n const preferences = await loadUserPreferences();\n \n const contextParts = [];\n \n if (preferences.language) {\n contextParts.push(`Preferred language: ${preferences.language}`);\n }\n if (preferences.codeStyle) {\n contextParts.push(`Code style: ${preferences.codeStyle}`);\n }\n if (preferences.verbosity === \"concise\") {\n contextParts.push(\"Keep responses brief and to the point.\");\n }\n \n return {\n additionalContext: contextParts.join(\"\\n\"),\n };\n },\n },\n});\n```\n\n---\n\n## Session End Hook {#session-end}\n\nThe `onSessionEnd` hook is called when a session ends.\n\n### Hook Signature\n\n
\nNode.js / TypeScript\n\n```typescript\ntype SessionEndHandler = (\n input: SessionEndHookInput,\n invocation: HookInvocation\n) => Promise;\n```\n\n
\n\n
\nPython\n\n\n```python\nfrom copilot.session import SessionEndHookInput\nfrom typing import Callable, Awaitable\n\nSessionEndHandler = Callable[\n [SessionEndHookInput, dict[str, str]],\n Awaitable[None]\n]\n```\n\n```python\nSessionEndHandler = Callable[\n [SessionEndHookInput, dict[str, str]],\n Awaitable[SessionEndHookOutput | None]\n]\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport copilot \"github.com/github/copilot-sdk/go\"\n\ntype SessionEndHandler func(\n input copilot.SessionEndHookInput,\n invocation copilot.HookInvocation,\n) error\n\nfunc main() {}\n```\n\n```go\ntype SessionEndHandler func(\n input SessionEndHookInput,\n invocation HookInvocation,\n) (*SessionEndHookOutput, error)\n```\n\n
\n\n
\n.NET\n\n```csharp\npublic delegate Task SessionEndHandler(\n SessionEndHookInput input,\n HookInvocation invocation);\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.json.*;\n\nSessionEndHandler sessionEndHandler;\n```\n\n
\n\n### Input\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `timestamp` | number | Unix timestamp when the hook was triggered |\n| `cwd` | string | Current working directory |\n| `reason` | string | Why the session ended (see below) |\n| `finalMessage` | string \\| undefined | The last message from the session |\n| `error` | string \\| undefined | Error message if session ended due to error |\n\n#### End Reasons\n\n| Reason | Description |\n|--------|-------------|\n| `\"complete\"` | Session completed normally |\n| `\"error\"` | Session ended due to an error |\n| `\"abort\"` | Session was aborted by user or code |\n| `\"timeout\"` | Session timed out |\n| `\"user_exit\"` | User explicitly ended the session |\n\n### Output\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `suppressOutput` | boolean | Suppress the final session output |\n| `cleanupActions` | string[] | List of cleanup actions to perform |\n| `sessionSummary` | string | Summary of the session for logging/analytics |\n\n### Examples\n\n#### Track Session Metrics\n\n
\nNode.js / TypeScript\n\n```typescript\nconst sessionStartTimes = new Map();\n\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async (input, invocation) => {\n sessionStartTimes.set(invocation.sessionId, input.timestamp);\n return null;\n },\n onSessionEnd: async (input, invocation) => {\n const startTime = sessionStartTimes.get(invocation.sessionId);\n const duration = startTime ? input.timestamp - startTime : 0;\n \n await recordMetrics({\n sessionId: invocation.sessionId,\n duration,\n endReason: input.reason,\n });\n \n sessionStartTimes.delete(invocation.sessionId);\n return null;\n },\n },\n});\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot.session import PermissionHandler\n\nsession_start_times = {}\n\nasync def on_session_start(input_data, invocation):\n session_start_times[invocation[\"session_id\"]] = input_data[\"timestamp\"]\n return None\n\nasync def on_session_end(input_data, invocation):\n start_time = session_start_times.get(invocation[\"session_id\"])\n duration = input_data[\"timestamp\"] - start_time if start_time else 0\n \n await record_metrics({\n \"session_id\": invocation[\"session_id\"],\n \"duration\": duration,\n \"end_reason\": input_data[\"reason\"],\n })\n \n session_start_times.pop(invocation[\"session_id\"], None)\n return None\n\nsession = await client.create_session(on_permission_request=PermissionHandler.approve_all, hooks={\n \"on_session_start\": on_session_start,\n \"on_session_end\": on_session_end,\n })\n```\n\n
\n\n#### Clean Up Resources\n\n```typescript\nconst sessionResources = new Map();\n\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async (input, invocation) => {\n sessionResources.set(invocation.sessionId, { tempFiles: [] });\n return null;\n },\n onSessionEnd: async (input, invocation) => {\n const resources = sessionResources.get(invocation.sessionId);\n \n if (resources) {\n // Clean up temp files\n for (const file of resources.tempFiles) {\n await fs.unlink(file).catch(() => {});\n }\n sessionResources.delete(invocation.sessionId);\n }\n \n console.log(`Session ${invocation.sessionId} ended: ${input.reason}`);\n return null;\n },\n },\n});\n```\n\n#### Save Session State for Resume\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onSessionEnd: async (input, invocation) => {\n if (input.reason !== \"error\") {\n // Save state for potential resume\n await saveSessionState(invocation.sessionId, {\n endTime: input.timestamp,\n cwd: input.cwd,\n reason: input.reason,\n });\n }\n return null;\n },\n },\n});\n```\n\n#### Log Session Summary\n\n```typescript\nconst sessionData: Record = {};\n\nconst session = await client.createSession({\n hooks: {\n onSessionStart: async (input, invocation) => {\n sessionData[invocation.sessionId] = { \n prompts: 0, \n tools: 0, \n startTime: input.timestamp \n };\n return null;\n },\n onUserPromptSubmitted: async (_, invocation) => {\n sessionData[invocation.sessionId].prompts++;\n return null;\n },\n onPreToolUse: async (_, invocation) => {\n sessionData[invocation.sessionId].tools++;\n return { permissionDecision: \"allow\" };\n },\n onSessionEnd: async (input, invocation) => {\n const data = sessionData[invocation.sessionId];\n console.log(`\nSession Summary:\n ID: ${invocation.sessionId}\n Duration: ${(input.timestamp - data.startTime) / 1000}s\n Prompts: ${data.prompts}\n Tool calls: ${data.tools}\n End reason: ${input.reason}\n `.trim());\n \n delete sessionData[invocation.sessionId];\n return null;\n },\n },\n});\n```\n\n## Best Practices\n\n1. **Keep `onSessionStart` fast** - Users are waiting for the session to be ready.\n\n2. **Handle all end reasons** - Don't assume sessions end cleanly; handle errors and aborts.\n\n3. **Clean up resources** - Use `onSessionEnd` to free any resources allocated during the session.\n\n4. **Store minimal state** - If tracking session data, keep it lightweight.\n\n5. **Make cleanup idempotent** - `onSessionEnd` might not be called if the process crashes.\n\n## See Also\n\n- [Hooks Overview](./index.md)\n- [Error Handling Hook](./error-handling.md)\n- [Debugging Guide](../troubleshooting/debugging.md)\n" }, { "path": "docs/hooks/user-prompt-submitted.md", "content": "# User Prompt Submitted Hook\n\nThe `onUserPromptSubmitted` hook is called when a user submits a message. Use it to:\n\n- Modify or enhance user prompts\n- Add context before processing\n- Filter or validate user input\n- Implement prompt templates\n\n## Hook Signature\n\n
\nNode.js / TypeScript\n\n\n```ts\nimport type { UserPromptSubmittedHookInput, HookInvocation, UserPromptSubmittedHookOutput } from \"@github/copilot-sdk\";\ntype UserPromptSubmittedHandler = (\n input: UserPromptSubmittedHookInput,\n invocation: HookInvocation\n) => Promise;\n```\n\n```typescript\ntype UserPromptSubmittedHandler = (\n input: UserPromptSubmittedHookInput,\n invocation: HookInvocation\n) => Promise;\n```\n\n
\n\n
\nPython\n\n\n```python\nfrom copilot.session import UserPromptSubmittedHookInput, UserPromptSubmittedHookOutput\nfrom typing import Callable, Awaitable\n\nUserPromptSubmittedHandler = Callable[\n [UserPromptSubmittedHookInput, dict[str, str]],\n Awaitable[UserPromptSubmittedHookOutput | None]\n]\n```\n\n```python\nUserPromptSubmittedHandler = Callable[\n [UserPromptSubmittedHookInput, dict[str, str]],\n Awaitable[UserPromptSubmittedHookOutput | None]\n]\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport copilot \"github.com/github/copilot-sdk/go\"\n\ntype UserPromptSubmittedHandler func(\n input copilot.UserPromptSubmittedHookInput,\n invocation copilot.HookInvocation,\n) (*copilot.UserPromptSubmittedHookOutput, error)\n\nfunc main() {}\n```\n\n```go\ntype UserPromptSubmittedHandler func(\n input UserPromptSubmittedHookInput,\n invocation HookInvocation,\n) (*UserPromptSubmittedHookOutput, error)\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic delegate Task UserPromptSubmittedHandler(\n UserPromptSubmittedHookInput input,\n HookInvocation invocation);\n```\n\n```csharp\npublic delegate Task UserPromptSubmittedHandler(\n UserPromptSubmittedHookInput input,\n HookInvocation invocation);\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.json.*;\n\nUserPromptSubmittedHandler userPromptSubmittedHandler;\n```\n\n
\n\n## Input\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `timestamp` | number | Unix timestamp when the hook was triggered |\n| `cwd` | string | Current working directory |\n| `prompt` | string | The user's submitted prompt |\n\n## Output\n\nReturn `null` or `undefined` to use the prompt unchanged. Otherwise, return an object with any of these fields:\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `modifiedPrompt` | string | Modified prompt to use instead of original |\n| `additionalContext` | string | Extra context added to the conversation |\n| `suppressOutput` | boolean | If true, suppress the assistant's response output |\n\n## Examples\n\n### Log All User Prompts\n\n
\nNode.js / TypeScript\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onUserPromptSubmitted: async (input, invocation) => {\n console.log(`[${invocation.sessionId}] User: ${input.prompt}`);\n return null; // Pass through unchanged\n },\n },\n});\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot.session import PermissionHandler\n\nasync def on_user_prompt_submitted(input_data, invocation):\n print(f\"[{invocation['session_id']}] User: {input_data['prompt']}\")\n return None\n\nsession = await client.create_session(on_permission_request=PermissionHandler.approve_all, hooks={\"on_user_prompt_submitted\": on_user_prompt_submitted})\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tclient := copilot.NewClient(nil)\n\tsession, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{\n\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\tHooks: &copilot.SessionHooks{\n\t\t\tOnUserPromptSubmitted: func(input copilot.UserPromptSubmittedHookInput, inv copilot.HookInvocation) (*copilot.UserPromptSubmittedHookOutput, error) {\n\t\t\t\tfmt.Printf(\"[%s] User: %s\\n\", inv.SessionID, input.Prompt)\n\t\t\t\treturn nil, nil\n\t\t\t},\n\t\t},\n\t})\n\t_ = session\n}\n```\n\n```go\nsession, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Hooks: &copilot.SessionHooks{\n OnUserPromptSubmitted: func(input copilot.UserPromptSubmittedHookInput, inv copilot.HookInvocation) (*copilot.UserPromptSubmittedHookOutput, error) {\n fmt.Printf(\"[%s] User: %s\\n\", inv.SessionID, input.Prompt)\n return nil, nil\n },\n },\n})\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic static class UserPromptSubmittedExample\n{\n public static async Task Main()\n {\n await using var client = new CopilotClient();\n var session = await client.CreateSessionAsync(new SessionConfig\n {\n Hooks = new SessionHooks\n {\n OnUserPromptSubmitted = (input, invocation) =>\n {\n Console.WriteLine($\"[{invocation.SessionId}] User: {input.Prompt}\");\n return Task.FromResult(null);\n },\n },\n });\n }\n}\n```\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Hooks = new SessionHooks\n {\n OnUserPromptSubmitted = (input, invocation) =>\n {\n Console.WriteLine($\"[{invocation.SessionId}] User: {input.Prompt}\");\n return Task.FromResult(null);\n },\n },\n});\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.*;\nimport com.github.copilot.sdk.json.*;\nimport java.util.concurrent.CompletableFuture;\n\nvar hooks = new SessionHooks()\n .setOnUserPromptSubmitted((input, invocation) -> {\n System.out.println(\"[\" + invocation.getSessionId() + \"] User: \" + input.prompt());\n return CompletableFuture.completedFuture(null);\n });\n\nvar session = client.createSession(\n new SessionConfig()\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n .setHooks(hooks)\n).get();\n```\n\n
\n\n### Add Project Context\n\n```typescript\nconst session = await client.createSession({\n hooks: {\n onUserPromptSubmitted: async (input) => {\n const projectInfo = await getProjectInfo();\n \n return {\n additionalContext: `\nProject: ${projectInfo.name}\nLanguage: ${projectInfo.language}\nFramework: ${projectInfo.framework}\n `.trim(),\n };\n },\n },\n});\n```\n\n### Expand Shorthand Commands\n\n```typescript\nconst SHORTCUTS: Record = {\n \"/fix\": \"Please fix the errors in the code\",\n \"/explain\": \"Please explain this code in detail\",\n \"/test\": \"Please write unit tests for this code\",\n \"/refactor\": \"Please refactor this code to improve readability and maintainability\",\n};\n\nconst session = await client.createSession({\n hooks: {\n onUserPromptSubmitted: async (input) => {\n for (const [shortcut, expansion] of Object.entries(SHORTCUTS)) {\n if (input.prompt.startsWith(shortcut)) {\n const rest = input.prompt.slice(shortcut.length).trim();\n return {\n modifiedPrompt: `${expansion}${rest ? `: ${rest}` : \"\"}`,\n };\n }\n }\n return null;\n },\n },\n});\n```\n\n### Content Filtering\n\n```typescript\nconst BLOCKED_PATTERNS = [\n /password\\s*[:=]/i,\n /api[_-]?key\\s*[:=]/i,\n /secret\\s*[:=]/i,\n];\n\nconst session = await client.createSession({\n hooks: {\n onUserPromptSubmitted: async (input) => {\n for (const pattern of BLOCKED_PATTERNS) {\n if (pattern.test(input.prompt)) {\n // Replace the prompt with a warning message\n return {\n modifiedPrompt: \"[Content blocked: Please don't include sensitive credentials in your prompts. Use environment variables instead.]\",\n suppressOutput: true,\n };\n }\n }\n return null;\n },\n },\n});\n```\n\n### Enforce Prompt Length Limits\n\n```typescript\nconst MAX_PROMPT_LENGTH = 10000;\n\nconst session = await client.createSession({\n hooks: {\n onUserPromptSubmitted: async (input) => {\n if (input.prompt.length > MAX_PROMPT_LENGTH) {\n // Truncate the prompt and add context\n return {\n modifiedPrompt: input.prompt.substring(0, MAX_PROMPT_LENGTH),\n additionalContext: `Note: The original prompt was ${input.prompt.length} characters and was truncated to ${MAX_PROMPT_LENGTH} characters.`,\n };\n }\n return null;\n },\n },\n});\n```\n\n### Add User Preferences\n\n```typescript\ninterface UserPreferences {\n codeStyle: \"concise\" | \"verbose\";\n preferredLanguage: string;\n experienceLevel: \"beginner\" | \"intermediate\" | \"expert\";\n}\n\nconst session = await client.createSession({\n hooks: {\n onUserPromptSubmitted: async (input) => {\n const prefs: UserPreferences = await loadUserPreferences();\n \n const contextParts = [];\n \n if (prefs.codeStyle === \"concise\") {\n contextParts.push(\"User prefers concise code with minimal comments.\");\n } else {\n contextParts.push(\"User prefers verbose code with detailed comments.\");\n }\n \n if (prefs.experienceLevel === \"beginner\") {\n contextParts.push(\"Explain concepts in simple terms.\");\n }\n \n return {\n additionalContext: contextParts.join(\" \"),\n };\n },\n },\n});\n```\n\n### Rate Limiting\n\n```typescript\nconst promptTimestamps: number[] = [];\nconst RATE_LIMIT = 10; // prompts\nconst RATE_WINDOW = 60000; // 1 minute\n\nconst session = await client.createSession({\n hooks: {\n onUserPromptSubmitted: async (input) => {\n const now = Date.now();\n \n // Remove timestamps outside the window\n while (promptTimestamps.length > 0 && promptTimestamps[0] < now - RATE_WINDOW) {\n promptTimestamps.shift();\n }\n \n if (promptTimestamps.length >= RATE_LIMIT) {\n return {\n reject: true,\n rejectReason: `Rate limit exceeded. Please wait before sending more prompts.`,\n };\n }\n \n promptTimestamps.push(now);\n return null;\n },\n },\n});\n```\n\n### Prompt Templates\n\n```typescript\nconst TEMPLATES: Record string> = {\n \"bug:\": (desc) => `I found a bug: ${desc}\n\nPlease help me:\n1. Understand why this is happening\n2. Suggest a fix\n3. Explain how to prevent similar bugs`,\n\n \"feature:\": (desc) => `I want to implement this feature: ${desc}\n\nPlease:\n1. Outline the implementation approach\n2. Identify potential challenges\n3. Provide sample code`,\n};\n\nconst session = await client.createSession({\n hooks: {\n onUserPromptSubmitted: async (input) => {\n for (const [prefix, template] of Object.entries(TEMPLATES)) {\n if (input.prompt.toLowerCase().startsWith(prefix)) {\n const args = input.prompt.slice(prefix.length).trim();\n return {\n modifiedPrompt: template(args),\n };\n }\n }\n return null;\n },\n },\n});\n```\n\n## Best Practices\n\n1. **Preserve user intent** - When modifying prompts, ensure the core intent remains clear.\n\n2. **Be transparent about modifications** - If you significantly change a prompt, consider logging or notifying the user.\n\n3. **Use `additionalContext` over `modifiedPrompt`** - Adding context is less intrusive than rewriting the prompt.\n\n4. **Provide clear rejection reasons** - When rejecting prompts, explain why and how to fix it.\n\n5. **Keep processing fast** - This hook runs on every user message. Avoid slow operations.\n\n## See Also\n\n- [Hooks Overview](./index.md)\n- [Session Lifecycle Hooks](./session-lifecycle.md)\n- [Pre-Tool Use Hook](./pre-tool-use.md)\n" }, { "path": "docs/index.md", "content": "# GitHub Copilot SDK Documentation\n\nWelcome to the GitHub Copilot SDK docs. Whether you're building your first Copilot-powered app or deploying to production, you'll find what you need here.\n\n## Where to Start\n\n| I want to... | Go to |\n|---|---|\n| **Build my first app** | [Getting Started](./getting-started.md) — end-to-end tutorial with streaming & custom tools |\n| **Set up for production** | [Setup Guides](./setup/index.md) — architecture, deployment patterns, scaling |\n| **Configure authentication** | [Authentication](./auth/index.md) — GitHub OAuth, environment variables, BYOK |\n| **Add features to my app** | [Features](./features/index.md) — hooks, custom agents, MCP, skills, and more |\n| **Debug an issue** | [Troubleshooting](./troubleshooting/debugging.md) — common problems and solutions |\n\n## Documentation Map\n\n### [Getting Started](./getting-started.md)\n\nStep-by-step tutorial that takes you from zero to a working Copilot app with streaming responses and custom tools.\n\n### [Setup](./setup/index.md)\n\nHow to configure and deploy the SDK for your use case.\n\n- [Default Setup (Bundled CLI)](./setup/bundled-cli.md) — the SDK includes the CLI automatically\n- [Local CLI](./setup/local-cli.md) — use your own CLI binary or running instance\n- [Backend Services](./setup/backend-services.md) — server-side with headless CLI over TCP\n- [GitHub OAuth](./setup/github-oauth.md) — implement the OAuth flow\n- [Azure Managed Identity](./setup/azure-managed-identity.md) — BYOK with Azure AI Foundry\n- [Scaling & Multi-Tenancy](./setup/scaling.md) — horizontal scaling, isolation patterns\n\n### [Authentication](./auth/index.md)\n\nConfiguring how users and services authenticate with Copilot.\n\n- [Authentication Overview](./auth/index.md) — methods, priority order, and examples\n- [Bring Your Own Key (BYOK)](./auth/byok.md) — use your own API keys from OpenAI, Azure, Anthropic, and more\n\n### [Features](./features/index.md)\n\nGuides for building with the SDK's capabilities.\n\n- [Hooks](./features/hooks.md) — intercept and customize session behavior\n- [Custom Agents](./features/custom-agents.md) — define specialized sub-agents\n- [MCP Servers](./features/mcp.md) — integrate Model Context Protocol servers\n- [Skills](./features/skills.md) — load reusable prompt modules\n- [Image Input](./features/image-input.md) — send images as attachments\n- [Streaming Events](./features/streaming-events.md) — real-time event reference\n- [Steering & Queueing](./features/steering-and-queueing.md) — message delivery modes\n- [Session Persistence](./features/session-persistence.md) — resume sessions across restarts\n\n### [Hooks Reference](./hooks/index.md)\n\nDetailed API reference for each session hook.\n\n- [Pre-Tool Use](./hooks/pre-tool-use.md) — approve, deny, or modify tool calls\n- [Post-Tool Use](./hooks/post-tool-use.md) — transform tool results\n- [User Prompt Submitted](./hooks/user-prompt-submitted.md) — modify or filter user messages\n- [Session Lifecycle](./hooks/session-lifecycle.md) — session start and end\n- [Error Handling](./hooks/error-handling.md) — custom error handling\n\n### [Troubleshooting](./troubleshooting/debugging.md)\n\n- [Debugging Guide](./troubleshooting/debugging.md) — common issues and solutions\n- [MCP Debugging](./troubleshooting/mcp-debugging.md) — MCP-specific troubleshooting\n- [Compatibility](./troubleshooting/compatibility.md) — SDK vs CLI feature matrix\n\n### [Observability](./observability/opentelemetry.md)\n\n- [OpenTelemetry Instrumentation](./observability/opentelemetry.md) — built-in TelemetryConfig and trace context propagation\n\n### [Integrations](./integrations/microsoft-agent-framework.md)\n\nGuides for using the SDK with other platforms and frameworks.\n\n- [Microsoft Agent Framework](./integrations/microsoft-agent-framework.md) — MAF multi-agent workflows\n" }, { "path": "docs/integrations/microsoft-agent-framework.md", "content": "# Microsoft Agent Framework Integration\n\nUse the Copilot SDK as an agent provider inside the [Microsoft Agent Framework](https://devblogs.microsoft.com/semantic-kernel/build-ai-agents-with-github-copilot-sdk-and-microsoft-agent-framework/) (MAF) to compose multi-agent workflows alongside Azure OpenAI, Anthropic, and other providers.\n\n## Overview\n\nThe Microsoft Agent Framework is the unified successor to Semantic Kernel and AutoGen. It provides a standard interface for building, orchestrating, and deploying AI agents. Dedicated integration packages let you wrap a Copilot SDK client as a first-class MAF agent — interchangeable with any other agent provider in the framework.\n\n| Concept | Description |\n|---------|-------------|\n| **Microsoft Agent Framework** | Open-source framework for single- and multi-agent orchestration in .NET and Python |\n| **Agent provider** | A backend that powers an agent (Copilot, Azure OpenAI, Anthropic, etc.) |\n| **Orchestrator** | A MAF component that coordinates agents in sequential, concurrent, or handoff workflows |\n| **A2A protocol** | Agent-to-Agent communication standard supported by the framework |\n\n> **Note:** MAF integration packages are available for **.NET** and **Python**. For TypeScript, Go, and Java, use the Copilot SDK directly — the standard SDK APIs already provide tool calling, streaming, and custom agents.\n\n## Prerequisites\n\nBefore you begin, ensure you have:\n\n- A working [Copilot SDK setup](../getting-started.md) in your language of choice\n- A GitHub Copilot subscription (Individual, Business, or Enterprise)\n- The Copilot CLI installed or available via the SDK's bundled CLI\n\n## Installation\n\nInstall the Copilot SDK alongside the MAF integration package for your language:\n\n
\n.NET\n\n```shell\ndotnet add package GitHub.Copilot.SDK\ndotnet add package Microsoft.Agents.AI.GitHub.Copilot --prerelease\n```\n\n
\n\n
\nPython\n\n```shell\npip install copilot-sdk agent-framework-github-copilot\n```\n\n
\n\n
\nJava\n\n> **Note:** The Java SDK does not have a dedicated MAF integration package. Use the standard Copilot SDK directly — it provides tool calling, streaming, and custom agents out of the box.\n\n```xml\n\n\n\n com.github\n copilot-sdk-java\n ${copilot.sdk.version}\n\n```\n\n
\n\n## Basic Usage\n\nWrap the Copilot SDK client as a MAF agent with a single method call. The resulting agent conforms to the framework's standard interface and can be used anywhere a MAF agent is expected.\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\nusing Microsoft.Agents.AI;\n\nawait using var copilotClient = new CopilotClient();\nawait copilotClient.StartAsync();\n\n// Wrap as a MAF agent\nAIAgent agent = copilotClient.AsAIAgent();\n\n// Use the standard MAF interface\nstring response = await agent.RunAsync(\"Explain how dependency injection works in ASP.NET Core\");\nConsole.WriteLine(response);\n```\n\n
\n\n
\nPython\n\n\n```python\nfrom agent_framework.github import GitHubCopilotAgent\n\nasync def main():\n agent = GitHubCopilotAgent(\n default_options={\n \"instructions\": \"You are a helpful coding assistant.\",\n }\n )\n\n async with agent:\n result = await agent.run(\"Explain how dependency injection works in FastAPI\")\n print(result)\n```\n\n
\n\n
\nJava\n\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\n\nvar client = new CopilotClient();\nclient.start().get();\n\nvar session = client.createSession(new SessionConfig()\n .setModel(\"gpt-4.1\")\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n).get();\n\nvar response = session.sendAndWait(new MessageOptions()\n .setPrompt(\"Explain how dependency injection works in Spring Boot\")).get();\nSystem.out.println(response.getData().content());\n\nclient.stop().get();\n```\n\n
\n\n## Adding Custom Tools\n\nExtend your Copilot agent with custom function tools. Tools defined through the standard Copilot SDK are automatically available when the agent runs inside MAF.\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\nusing Microsoft.Extensions.AI;\nusing Microsoft.Agents.AI;\n\n// Define a custom tool\nAIFunction weatherTool = AIFunctionFactory.Create(\n (string location) => $\"The weather in {location} is sunny with a high of 25°C.\",\n \"GetWeather\",\n \"Get the current weather for a given location.\"\n);\n\nawait using var copilotClient = new CopilotClient();\nawait copilotClient.StartAsync();\n\n// Create agent with tools\nAIAgent agent = copilotClient.AsAIAgent(new AIAgentOptions\n{\n Tools = new[] { weatherTool },\n});\n\nstring response = await agent.RunAsync(\"What's the weather like in Seattle?\");\nConsole.WriteLine(response);\n```\n\n
\n\n
\nPython\n\n\n```python\nfrom agent_framework.github import GitHubCopilotAgent\n\ndef get_weather(location: str) -> str:\n \"\"\"Get the current weather for a given location.\"\"\"\n return f\"The weather in {location} is sunny with a high of 25°C.\"\n\nasync def main():\n agent = GitHubCopilotAgent(\n default_options={\n \"instructions\": \"You are a helpful assistant with access to weather data.\",\n },\n tools=[get_weather],\n )\n\n async with agent:\n result = await agent.run(\"What's the weather like in Seattle?\")\n print(result)\n```\n\n
\n\nYou can also use Copilot SDK's native tool definition alongside MAF tools:\n\n
\nNode.js / TypeScript (standalone SDK)\n\n```typescript\nimport { CopilotClient, DefineTool } from \"@github/copilot-sdk\";\n\nconst getWeather = DefineTool({\n name: \"GetWeather\",\n description: \"Get the current weather for a given location.\",\n parameters: { location: { type: \"string\", description: \"City name\" } },\n execute: async ({ location }) => `The weather in ${location} is sunny, 25°C.`,\n});\n\nconst client = new CopilotClient();\nconst session = await client.createSession({\n model: \"gpt-4.1\",\n tools: [getWeather],\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n\nawait session.sendAndWait({ prompt: \"What's the weather like in Seattle?\" });\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\nimport java.util.List;\nimport java.util.Map;\nimport java.util.concurrent.CompletableFuture;\n\nvar getWeather = ToolDefinition.create(\n \"GetWeather\",\n \"Get the current weather for a given location.\",\n Map.of(\n \"type\", \"object\",\n \"properties\", Map.of(\n \"location\", Map.of(\"type\", \"string\", \"description\", \"City name\")),\n \"required\", List.of(\"location\")),\n invocation -> {\n var location = (String) invocation.getArguments().get(\"location\");\n return CompletableFuture.completedFuture(\n \"The weather in \" + location + \" is sunny, 25°C.\");\n });\n\ntry (var client = new CopilotClient()) {\n client.start().get();\n\n var session = client.createSession(new SessionConfig()\n .setModel(\"gpt-4.1\")\n .setTools(List.of(getWeather))\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n ).get();\n\n session.sendAndWait(new MessageOptions()\n .setPrompt(\"What's the weather like in Seattle?\")).get();\n}\n```\n\n
\n\n## Multi-Agent Workflows\n\nThe primary benefit of MAF integration is composing Copilot alongside other agent providers in orchestrated workflows. Use the framework's built-in orchestrators to create pipelines where different agents handle different steps.\n\n### Sequential Workflow\n\nRun agents one after another, passing output from one to the next:\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\nusing Microsoft.Agents.AI;\nusing Microsoft.Agents.AI.Orchestration;\n\nawait using var copilotClient = new CopilotClient();\nawait copilotClient.StartAsync();\n\n// Copilot agent for code review\nAIAgent reviewer = copilotClient.AsAIAgent(new AIAgentOptions\n{\n Instructions = \"You review code for bugs, security issues, and best practices. Be thorough.\",\n});\n\n// Azure OpenAI agent for generating documentation\nAIAgent documentor = AIAgent.FromOpenAI(new OpenAIAgentOptions\n{\n Model = \"gpt-4.1\",\n Instructions = \"You write clear, concise documentation for code changes.\",\n});\n\n// Compose in a sequential pipeline\nvar pipeline = new SequentialOrchestrator(new[] { reviewer, documentor });\n\nstring result = await pipeline.RunAsync(\n \"Review and document this pull request: added retry logic to the HTTP client\"\n);\nConsole.WriteLine(result);\n```\n\n
\n\n
\nPython\n\n\n```python\nfrom agent_framework.github import GitHubCopilotAgent\nfrom agent_framework.openai import OpenAIAgent\nfrom agent_framework.orchestration import SequentialOrchestrator\n\nasync def main():\n # Copilot agent for code review\n reviewer = GitHubCopilotAgent(\n default_options={\n \"instructions\": \"You review code for bugs, security issues, and best practices.\",\n }\n )\n\n # OpenAI agent for documentation\n documentor = OpenAIAgent(\n model=\"gpt-4.1\",\n instructions=\"You write clear, concise documentation for code changes.\",\n )\n\n # Compose in a sequential pipeline\n pipeline = SequentialOrchestrator(agents=[reviewer, documentor])\n\n async with pipeline:\n result = await pipeline.run(\n \"Review and document this PR: added retry logic to the HTTP client\"\n )\n print(result)\n```\n\n
\n\n
\nJava\n\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\n\n// Java uses the standard SDK directly — no MAF orchestrator needed\nvar client = new CopilotClient();\nclient.start().get();\n\n// Step 1: Code review session\nvar reviewer = client.createSession(new SessionConfig()\n .setModel(\"gpt-4.1\")\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n).get();\n\nvar review = reviewer.sendAndWait(new MessageOptions()\n .setPrompt(\"Review this PR for bugs, security issues, and best practices: \"\n + \"added retry logic to the HTTP client\")).get();\n\n// Step 2: Documentation session using review output\nvar documentor = client.createSession(new SessionConfig()\n .setModel(\"gpt-4.1\")\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n).get();\n\nvar docs = documentor.sendAndWait(new MessageOptions()\n .setPrompt(\"Write documentation for these changes: \" + review.getData().content())).get();\nSystem.out.println(docs.getData().content());\n\nclient.stop().get();\n```\n\n
\n\n### Concurrent Workflow\n\nRun multiple agents in parallel and aggregate their results:\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\nusing Microsoft.Agents.AI;\nusing Microsoft.Agents.AI.Orchestration;\n\nawait using var copilotClient = new CopilotClient();\nawait copilotClient.StartAsync();\n\nAIAgent securityReviewer = copilotClient.AsAIAgent(new AIAgentOptions\n{\n Instructions = \"Focus exclusively on security vulnerabilities and risks.\",\n});\n\nAIAgent performanceReviewer = copilotClient.AsAIAgent(new AIAgentOptions\n{\n Instructions = \"Focus exclusively on performance bottlenecks and optimization opportunities.\",\n});\n\n// Run both reviews concurrently\nvar concurrent = new ConcurrentOrchestrator(new[] { securityReviewer, performanceReviewer });\n\nstring combinedResult = await concurrent.RunAsync(\n \"Analyze this database query module for issues\"\n);\nConsole.WriteLine(combinedResult);\n```\n\n
\n\n
\nJava\n\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\nimport java.util.concurrent.CompletableFuture;\n\n// Java uses CompletableFuture for concurrent execution\nvar client = new CopilotClient();\nclient.start().get();\n\nvar securitySession = client.createSession(new SessionConfig()\n .setModel(\"gpt-4.1\")\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n).get();\n\nvar perfSession = client.createSession(new SessionConfig()\n .setModel(\"gpt-4.1\")\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n).get();\n\n// Run both reviews concurrently\nvar securityFuture = securitySession.sendAndWait(new MessageOptions()\n .setPrompt(\"Focus on security vulnerabilities in this database query module\"));\nvar perfFuture = perfSession.sendAndWait(new MessageOptions()\n .setPrompt(\"Focus on performance bottlenecks in this database query module\"));\n\nCompletableFuture.allOf(securityFuture, perfFuture).get();\n\nSystem.out.println(\"Security: \" + securityFuture.get().getData().content());\nSystem.out.println(\"Performance: \" + perfFuture.get().getData().content());\n\nclient.stop().get();\n```\n\n
\n\n## Streaming Responses\n\nWhen building interactive applications, stream agent responses to show real-time output. The MAF integration preserves the Copilot SDK's streaming capabilities.\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\nusing Microsoft.Agents.AI;\n\nawait using var copilotClient = new CopilotClient();\nawait copilotClient.StartAsync();\n\nAIAgent agent = copilotClient.AsAIAgent(new AIAgentOptions\n{\n Streaming = true,\n});\n\nawait foreach (var chunk in agent.RunStreamingAsync(\"Write a quicksort implementation in C#\"))\n{\n Console.Write(chunk);\n}\nConsole.WriteLine();\n```\n\n
\n\n
\nPython\n\n\n```python\nfrom agent_framework.github import GitHubCopilotAgent\n\nasync def main():\n agent = GitHubCopilotAgent(\n default_options={\"streaming\": True}\n )\n\n async with agent:\n async for chunk in agent.run_streaming(\"Write a quicksort in Python\"):\n print(chunk, end=\"\", flush=True)\n print()\n```\n\n
\n\nYou can also stream directly through the Copilot SDK without MAF:\n\n
\nNode.js / TypeScript (standalone SDK)\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\nconst session = await client.createSession({\n model: \"gpt-4.1\",\n streaming: true,\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\n\nsession.on(\"assistant.message_delta\", (event) => {\n process.stdout.write(event.data.delta ?? \"\");\n});\n\nawait session.sendAndWait({ prompt: \"Write a quicksort implementation in TypeScript\" });\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\n\nvar client = new CopilotClient();\nclient.start().get();\n\nvar session = client.createSession(new SessionConfig()\n .setModel(\"gpt-4.1\")\n .setStreaming(true)\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n).get();\n\nsession.on(AssistantMessageDeltaEvent.class, event -> {\n System.out.print(event.getData().deltaContent());\n});\n\nsession.sendAndWait(new MessageOptions()\n .setPrompt(\"Write a quicksort implementation in Java\")).get();\nSystem.out.println();\n\nclient.stop().get();\n```\n\n
\n\n## Configuration Reference\n\n### MAF Agent Options\n\n| Property | Type | Description |\n|----------|------|-------------|\n| `Instructions` / `instructions` | `string` | System prompt for the agent |\n| `Tools` / `tools` | `AIFunction[]` / `list` | Custom function tools available to the agent |\n| `Streaming` / `streaming` | `bool` | Enable streaming responses |\n| `Model` / `model` | `string` | Override the default model |\n\n### Copilot SDK Options (Passed Through)\n\nAll standard [SessionConfig](../getting-started.md) options are still available when creating the underlying Copilot client. The MAF wrapper delegates to the SDK under the hood:\n\n| SDK Feature | MAF Support |\n|-------------|-------------|\n| Custom tools (`DefineTool` / `AIFunctionFactory`) | ✅ Merged with MAF tools |\n| MCP servers | ✅ Configured on the SDK client |\n| Custom agents / sub-agents | ✅ Available within the Copilot agent |\n| Infinite sessions | ✅ Configured on the SDK client |\n| Model selection | ✅ Overridable per agent or per call |\n| Streaming | ✅ Full delta event support |\n\n## Best Practices\n\n### Choose the right level of integration\n\nUse the MAF wrapper when you need to compose Copilot with other providers in orchestrated workflows. If your application only uses Copilot, the standalone SDK is simpler and gives you full control:\n\n```typescript\n// Standalone SDK — full control, simpler setup\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\nconst session = await client.createSession({\n model: \"gpt-4.1\",\n onPermissionRequest: async () => ({ kind: \"approved\" }),\n});\nconst response = await session.sendAndWait({ prompt: \"Explain this code\" });\n```\n\n### Keep agents focused\n\nWhen building multi-agent workflows, give each agent a specific role with clear instructions. Avoid overlapping responsibilities:\n\n```typescript\n// ❌ Too vague — overlapping roles\nconst agents = [\n { instructions: \"Help with code\" },\n { instructions: \"Assist with programming\" },\n];\n\n// ✅ Focused — clear separation of concerns\nconst agents = [\n { instructions: \"Review code for security vulnerabilities. Flag SQL injection, XSS, and auth issues.\" },\n { instructions: \"Optimize code performance. Focus on algorithmic complexity and memory usage.\" },\n];\n```\n\n### Handle errors at the orchestration level\n\nWrap agent calls in error handling, especially in multi-agent workflows where one agent's failure shouldn't block the entire pipeline:\n\n\n```csharp\ntry\n{\n string result = await pipeline.RunAsync(\"Analyze this module\");\n Console.WriteLine(result);\n}\ncatch (AgentException ex)\n{\n Console.Error.WriteLine($\"Agent {ex.AgentName} failed: {ex.Message}\");\n // Fall back to single-agent mode or retry\n}\n```\n\n## See Also\n\n- [Getting Started](../getting-started.md) — initial Copilot SDK setup\n- [Custom Agents](../features/custom-agents.md) — define specialized sub-agents within the SDK\n- [Custom Skills](../features/skills.md) — reusable prompt modules\n- [Microsoft Agent Framework documentation](https://learn.microsoft.com/en-us/agent-framework/agents/providers/github-copilot) — official MAF docs for the Copilot provider\n- [Blog: Build AI Agents with GitHub Copilot SDK and Microsoft Agent Framework](https://devblogs.microsoft.com/semantic-kernel/build-ai-agents-with-github-copilot-sdk-and-microsoft-agent-framework/)\n" }, { "path": "docs/observability/opentelemetry.md", "content": "# OpenTelemetry Instrumentation for Copilot SDK\n\nThis guide shows how to add OpenTelemetry tracing to your Copilot SDK applications.\n\n## Built-in Telemetry Support\n\nThe SDK has built-in support for configuring OpenTelemetry on the CLI process and propagating W3C Trace Context between the SDK and CLI. Provide a `TelemetryConfig` when creating the client to opt in:\n\n
\nNode.js / TypeScript\n\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient({\n telemetry: {\n otlpEndpoint: \"http://localhost:4318\",\n },\n});\n```\n\n
\n\n
\nPython\n\n\n```python\nfrom copilot import CopilotClient, SubprocessConfig\n\nclient = CopilotClient(SubprocessConfig(\n telemetry={\n \"otlp_endpoint\": \"http://localhost:4318\",\n },\n))\n```\n\n
\n\n
\nGo\n\n\n```go\nclient, err := copilot.NewClient(copilot.ClientOptions{\n Telemetry: &copilot.TelemetryConfig{\n OTLPEndpoint: \"http://localhost:4318\",\n },\n})\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nvar client = new CopilotClient(new CopilotClientOptions\n{\n Telemetry = new TelemetryConfig\n {\n OtlpEndpoint = \"http://localhost:4318\",\n },\n});\n```\n\n
\n\n
\nJava\n\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.json.*;\n\nvar client = new CopilotClient(new CopilotClientOptions()\n .setTelemetry(new TelemetryConfig()\n .setOtlpEndpoint(\"http://localhost:4318\"))\n);\n```\n\n
\n\n### TelemetryConfig Options\n\n| Option | Node.js | Python | Go | .NET | Java | Description |\n|---|---|---|---|---|---|---|\n| OTLP endpoint | `otlpEndpoint` | `otlp_endpoint` | `OTLPEndpoint` | `OtlpEndpoint` | `otlpEndpoint` | OTLP HTTP endpoint URL |\n| File path | `filePath` | `file_path` | `FilePath` | `FilePath` | `filePath` | File path for JSON-lines trace output |\n| Exporter type | `exporterType` | `exporter_type` | `ExporterType` | `ExporterType` | `exporterType` | `\"otlp-http\"` or `\"file\"` |\n| Source name | `sourceName` | `source_name` | `SourceName` | `SourceName` | `sourceName` | Instrumentation scope name |\n| Capture content | `captureContent` | `capture_content` | `CaptureContent` | `CaptureContent` | `captureContent` | Whether to capture message content |\n\n### Trace Context Propagation\n\n> **Most users don't need this.** The `TelemetryConfig` above is all you need to collect traces from the CLI. The trace context propagation described in this section is an **advanced feature** for applications that create their own OpenTelemetry spans and want them to appear in the **same distributed trace** as the CLI's spans.\n\nThe SDK can propagate W3C Trace Context (`traceparent`/`tracestate`) on JSON-RPC payloads so that your application's spans and the CLI's spans are linked in one distributed trace. This is useful when, for example, you want to see a \"handle tool call\" span in your app nested inside the CLI's \"execute tool\" span, or show the SDK call as a child of your request-handling span.\n\n#### SDK → CLI (outbound)\n\nFor **Node.js**, provide an `onGetTraceContext` callback on the client options. This is only needed if your application already uses `@opentelemetry/api` and you want to link your spans with the CLI's spans. The SDK calls this callback before `session.create`, `session.resume`, and `session.send` RPCs:\n\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\nimport { propagation, context } from \"@opentelemetry/api\";\n\nconst client = new CopilotClient({\n telemetry: { otlpEndpoint: \"http://localhost:4318\" },\n onGetTraceContext: () => {\n const carrier: Record = {};\n propagation.inject(context.active(), carrier);\n return carrier; // { traceparent: \"00-...\", tracestate: \"...\" }\n },\n});\n```\n\nFor **Python**, **Go**, and **.NET**, trace context injection is automatic when the respective OpenTelemetry/Activity API is configured — no callback is needed.\n\n#### CLI → SDK (inbound)\n\nWhen the CLI invokes a tool handler, the `traceparent` and `tracestate` from the CLI's span are available in all languages:\n\n- **Go**: The `ToolInvocation.TraceContext` field is a `context.Context` with the trace already restored — use it directly as the parent for your spans.\n- **Python**: Trace context is automatically restored around the handler via `trace_context()` — child spans are parented to the CLI's span automatically.\n- **.NET**: Trace context is automatically restored via `RestoreTraceContext()` — child `Activity` instances are parented to the CLI's span automatically.\n- **Node.js**: Since the SDK has no OpenTelemetry dependency, `traceparent` and `tracestate` are passed as raw strings on the `ToolInvocation` object. Restore the context manually if needed:\n\n\n```typescript\nimport { propagation, context, trace } from \"@opentelemetry/api\";\n\nsession.registerTool(myTool, async (args, invocation) => {\n // Restore the CLI's trace context as the active context\n const carrier = {\n traceparent: invocation.traceparent,\n tracestate: invocation.tracestate,\n };\n const parentCtx = propagation.extract(context.active(), carrier);\n\n // Create a child span under the CLI's span\n const tracer = trace.getTracer(\"my-app\");\n return context.with(parentCtx, () =>\n tracer.startActiveSpan(\"my-tool\", async (span) => {\n try {\n const result = await doWork(args);\n return result;\n } finally {\n span.end();\n }\n })\n );\n});\n```\n\n### Per-Language Dependencies\n\n| Language | Dependency | Notes |\n|---|---|---|\n| Node.js | — | No dependency; provide `onGetTraceContext` callback for outbound propagation |\n| Python | `opentelemetry-api` | Install with `pip install copilot-sdk[telemetry]` |\n| Go | `go.opentelemetry.io/otel` | Required dependency |\n| .NET | — | Uses built-in `System.Diagnostics.Activity` |\n| Java | `io.opentelemetry:opentelemetry-api` | Add this dependency for SDK-based setup; trace context injection is automatic when the OpenTelemetry Java agent or SDK is configured |\n\n## References\n\n- [OpenTelemetry GenAI Semantic Conventions](https://opentelemetry.io/docs/specs/semconv/gen-ai/)\n- [OpenTelemetry MCP Semantic Conventions](https://opentelemetry.io/docs/specs/semconv/gen-ai/mcp/)\n- [OpenTelemetry Python SDK](https://opentelemetry.io/docs/instrumentation/python/)\n- [Copilot SDK Documentation](https://github.com/github/copilot-sdk)\n" }, { "path": "docs/setup/azure-managed-identity.md", "content": "# Azure Managed Identity with BYOK\n\nThe Copilot SDK's [BYOK mode](../auth/byok.md) accepts static API keys, but Azure deployments often use **Managed Identity** (Entra ID) instead of long-lived keys. Since the SDK doesn't natively support Entra ID authentication, you can use a short-lived bearer token via the `bearer_token` provider config field.\n\nThis guide shows how to use `DefaultAzureCredential` from the [Azure Identity](https://learn.microsoft.com/python/api/azure-identity/azure.identity.defaultazurecredential) library to authenticate with Azure AI Foundry models through the Copilot SDK.\n\n## How It Works\n\nAzure AI Foundry's OpenAI-compatible endpoint accepts bearer tokens from Entra ID in place of static API keys. The pattern is:\n\n1. Use `DefaultAzureCredential` to obtain a token for the `https://cognitiveservices.azure.com/.default` scope\n2. Pass the token as the `bearer_token` in the BYOK provider config\n3. Refresh the token before it expires (tokens are typically valid for ~1 hour)\n\n```mermaid\nsequenceDiagram\n participant App as Your Application\n participant AAD as Entra ID\n participant SDK as Copilot SDK\n participant Foundry as Azure AI Foundry\n\n App->>AAD: DefaultAzureCredential.get_token()\n AAD-->>App: Bearer token (~1hr)\n App->>SDK: create_session(provider={bearer_token: token})\n SDK->>Foundry: Request with Authorization: Bearer \n Foundry-->>SDK: Model response\n SDK-->>App: Session events\n```\n\n## Python Example\n\n### Prerequisites\n\n```bash\npip install github-copilot-sdk azure-identity\n```\n\n### Basic Usage\n\n```python\nimport asyncio\nimport os\n\nfrom azure.identity import DefaultAzureCredential\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionHandler, ProviderConfig\n\nCOGNITIVE_SERVICES_SCOPE = \"https://cognitiveservices.azure.com/.default\"\n\n\nasync def main():\n # Get a token using Managed Identity, Azure CLI, or other credential chain\n credential = DefaultAzureCredential()\n token = credential.get_token(COGNITIVE_SERVICES_SCOPE).token\n\n foundry_url = os.environ[\"AZURE_AI_FOUNDRY_RESOURCE_URL\"]\n\n client = CopilotClient()\n await client.start()\n\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model=\"gpt-4.1\",\n provider=ProviderConfig(\n type=\"openai\",\n base_url=f\"{foundry_url.rstrip('/')}/openai/v1/\",\n bearer_token=token, # Short-lived bearer token\n wire_api=\"responses\",\n ),\n )\n\n response = await session.send_and_wait(\"Hello from Managed Identity!\")\n print(response.data.content)\n\n await client.stop()\n\n\nasyncio.run(main())\n```\n\n### Token Refresh for Long-Running Applications\n\nBearer tokens expire (typically after ~1 hour). For servers or long-running agents, refresh the token before creating each session:\n\n```python\nfrom azure.identity import DefaultAzureCredential\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionHandler, ProviderConfig\n\nCOGNITIVE_SERVICES_SCOPE = \"https://cognitiveservices.azure.com/.default\"\n\n\nclass ManagedIdentityCopilotAgent:\n \"\"\"Copilot agent that refreshes Entra ID tokens for Azure AI Foundry.\"\"\"\n\n def __init__(self, foundry_url: str, model: str = \"gpt-4.1\"):\n self.foundry_url = foundry_url.rstrip(\"/\")\n self.model = model\n self.credential = DefaultAzureCredential()\n self.client = CopilotClient()\n\n def _get_provider_config(self) -> ProviderConfig:\n \"\"\"Build a ProviderConfig with a fresh bearer token.\"\"\"\n token = self.credential.get_token(COGNITIVE_SERVICES_SCOPE).token\n return ProviderConfig(\n type=\"openai\",\n base_url=f\"{self.foundry_url}/openai/v1/\",\n bearer_token=token,\n wire_api=\"responses\",\n )\n\n async def chat(self, prompt: str) -> str:\n \"\"\"Send a prompt and return the response text.\"\"\"\n # Fresh token for each session\n session = await self.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model=self.model,\n provider=self._get_provider_config(),\n )\n\n response = await session.send_and_wait(prompt)\n await session.disconnect()\n\n return response.data.content if response else \"\"\n```\n\n## Node.js / TypeScript Example\n\n\n```typescript\nimport { DefaultAzureCredential } from \"@azure/identity\";\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst credential = new DefaultAzureCredential();\nconst tokenResponse = await credential.getToken(\n \"https://cognitiveservices.azure.com/.default\"\n);\n\nconst client = new CopilotClient();\n\nconst session = await client.createSession({\n model: \"gpt-4.1\",\n provider: {\n type: \"openai\",\n baseUrl: `${process.env.AZURE_AI_FOUNDRY_RESOURCE_URL}/openai/v1/`,\n bearerToken: tokenResponse.token,\n wireApi: \"responses\",\n },\n});\n\nconst response = await session.sendAndWait({ prompt: \"Hello!\" });\nconsole.log(response?.data.content);\n\nawait client.stop();\n```\n\n## .NET Example\n\n\n```csharp\nusing Azure.Identity;\nusing GitHub.Copilot;\n\nvar credential = new DefaultAzureCredential();\nvar token = await credential.GetTokenAsync(\n new Azure.Core.TokenRequestContext(\n new[] { \"https://cognitiveservices.azure.com/.default\" }));\n\nawait using var client = new CopilotClient();\nvar foundryUrl = Environment.GetEnvironmentVariable(\"AZURE_AI_FOUNDRY_RESOURCE_URL\");\n\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-4.1\",\n Provider = new ProviderConfig\n {\n Type = \"openai\",\n BaseUrl = $\"{foundryUrl!.TrimEnd('/')}/openai/v1/\",\n BearerToken = token.Token,\n WireApi = \"responses\",\n },\n});\n\nvar response = await session.SendAndWaitAsync(\n new MessageOptions { Prompt = \"Hello from Managed Identity!\" });\nConsole.WriteLine(response?.Data.Content);\n```\n\n## Environment Configuration\n\n| Variable | Description | Example |\n|----------|-------------|---------|\n| `AZURE_AI_FOUNDRY_RESOURCE_URL` | Your Azure AI Foundry resource URL | `https://myresource.openai.azure.com` |\n\nNo API key environment variable is needed — authentication is handled by `DefaultAzureCredential`, which automatically supports:\n\n- **Managed Identity** (system-assigned or user-assigned) — for Azure-hosted apps\n- **Azure CLI** (`az login`) — for local development\n- **Environment variables** (`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`) — for service principals\n- **Workload Identity** — for Kubernetes\n\nSee the [DefaultAzureCredential documentation](https://learn.microsoft.com/python/api/azure-identity/azure.identity.defaultazurecredential) for the full credential chain.\n\n## When to Use This Pattern\n\n| Scenario | Recommendation |\n|----------|----------------|\n| Azure-hosted app with Managed Identity | ✅ Use this pattern |\n| App with existing Azure AD service principal | ✅ Use this pattern |\n| Local development with `az login` | ✅ Use this pattern |\n| Non-Azure environment with static API key | Use [standard BYOK](../auth/byok.md) |\n| GitHub Copilot subscription available | Use [GitHub OAuth](./github-oauth.md) |\n\n## See Also\n\n- [BYOK Setup Guide](../auth/byok.md) — Static API key configuration\n- [Backend Services](./backend-services.md) — Server-side deployment\n- [Azure Identity documentation](https://learn.microsoft.com/python/api/overview/azure/identity-readme)\n" }, { "path": "docs/setup/backend-services.md", "content": "# Backend Services Setup\n\nRun the Copilot SDK in server-side applications — APIs, web backends, microservices, and background workers. The CLI runs as a headless server that your backend code connects to over the network.\n\n**Best for:** Web app backends, API services, internal tools, CI/CD integrations, any server-side workload.\n\n## How It Works\n\nInstead of the SDK spawning a CLI child process, you run the CLI independently in **headless server mode**. Your backend connects to it over TCP using the `cliUrl` option.\n\n```mermaid\nflowchart TB\n subgraph Backend[\"Your Backend\"]\n API[\"API Server\"]\n SDK[\"SDK Client\"]\n end\n\n subgraph CLIServer[\"Copilot CLI (Headless)\"]\n RPC[\"JSON-RPC Server
TCP :4321\"]\n Sessions[\"Session Manager\"]\n end\n\n Users[\"👥 Users\"] --> API\n API --> SDK\n SDK -- \"cliUrl: localhost:4321\" --> RPC\n RPC --> Sessions\n RPC --> Copilot[\"☁️ GitHub Copilot
or Model Provider\"]\n\n style Backend fill:#0d1117,stroke:#58a6ff,color:#c9d1d9\n style CLIServer fill:#0d1117,stroke:#3fb950,color:#c9d1d9\n```\n\n**Key characteristics:**\n- CLI runs as a persistent server process (not spawned per request)\n- SDK connects over TCP — CLI and app can run in different containers\n- Multiple SDK clients can share one CLI server\n- Works with any auth method (GitHub tokens, env vars, BYOK)\n\n## Architecture: Auto-Managed vs. External CLI\n\n```mermaid\nflowchart LR\n subgraph Auto[\"Auto-Managed (Default)\"]\n A1[\"SDK\"] -->|\"spawns\"| A2[\"CLI Process\"]\n A2 -.->|\"dies with app\"| A1\n end\n\n subgraph External[\"External Server (Backend)\"]\n B1[\"SDK\"] -->|\"cliUrl\"| B2[\"CLI Server\"]\n B2 -.->|\"independent
lifecycle\"| B1\n end\n\n style Auto fill:#161b22,stroke:#8b949e,color:#c9d1d9\n style External fill:#0d1117,stroke:#3fb950,color:#c9d1d9\n```\n\n## Step 1: Start the CLI in Headless Mode\n\nRun the CLI as a background server:\n\n```bash\n# Start with a specific port\ncopilot --headless --port 4321\n\n# Or let it pick a random port (prints the URL)\ncopilot --headless\n# Output: Listening on http://localhost:52431\n```\n\nBy default the headless server only accepts connections from loopback (`127.0.0.1`). To accept connections from other hosts — for example from another machine on your network — bind to a non-loopback address with `--host`:\n\n```bash\ncopilot --headless --host 0.0.0.0 --port 4321\n```\n\nFor production, run it as a system service or in a container:\n\n```bash\n# Docker — must bind to 0.0.0.0 so the container's published port is reachable\ndocker run -d --name copilot-cli \\\n -p 4321:4321 \\\n -e COPILOT_GITHUB_TOKEN=\"$TOKEN\" \\\n ghcr.io/github/copilot-cli:latest \\\n --headless --host 0.0.0.0 --port 4321\n\n# systemd\n[Service]\nExecStart=/usr/local/bin/copilot --headless --port 4321\nEnvironment=COPILOT_GITHUB_TOKEN=your-token\nRestart=always\n```\n\n## Step 2: Connect the SDK\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient({\n cliUrl: \"localhost:4321\",\n});\n\nconst session = await client.createSession({\n sessionId: `user-${userId}-${Date.now()}`,\n model: \"gpt-4.1\",\n});\n\nconst response = await session.sendAndWait({ prompt: req.body.message });\nres.json({ content: response?.data.content });\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot import CopilotClient, ExternalServerConfig\nfrom copilot.session import PermissionHandler\n\nclient = CopilotClient(ExternalServerConfig(url=\"localhost:4321\"))\nawait client.start()\n\nsession = await client.create_session(on_permission_request=PermissionHandler.approve_all, model=\"gpt-4.1\", session_id=f\"user-{user_id}-{int(time.time())}\")\n\nresponse = await session.send_and_wait(message)\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"time\"\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tuserID := \"user1\"\n\tmessage := \"Hello\"\n\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tCLIUrl: \"localhost:4321\",\n\t})\n\tclient.Start(ctx)\n\tdefer client.Stop()\n\n\tsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tSessionID: fmt.Sprintf(\"user-%s-%d\", userID, time.Now().Unix()),\n\t\tModel: \"gpt-4.1\",\n\t})\n\n\tresponse, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: message})\n\t_ = response\n}\n```\n\n\n```go\nclient := copilot.NewClient(&copilot.ClientOptions{\n CLIUrl:\"localhost:4321\",\n})\nclient.Start(ctx)\ndefer client.Stop()\n\nsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n SessionID: fmt.Sprintf(\"user-%s-%d\", userID, time.Now().Unix()),\n Model: \"gpt-4.1\",\n})\n\nresponse, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: message})\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\nvar userId = \"user1\";\nvar message = \"Hello\";\n\nvar client = new CopilotClient(new CopilotClientOptions\n{\n CliUrl = \"localhost:4321\",\n UseStdio = false,\n});\n\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n SessionId = $\"user-{userId}-{DateTimeOffset.UtcNow.ToUnixTimeSeconds()}\",\n Model = \"gpt-4.1\",\n});\n\nvar response = await session.SendAndWaitAsync(\n new MessageOptions { Prompt = message });\n```\n\n\n```csharp\nvar client = new CopilotClient(new CopilotClientOptions\n{\n CliUrl = \"localhost:4321\",\n UseStdio = false,\n});\n\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n SessionId = $\"user-{userId}-{DateTimeOffset.UtcNow.ToUnixTimeSeconds()}\",\n Model = \"gpt-4.1\",\n});\n\nvar response = await session.SendAndWaitAsync(\n new MessageOptions { Prompt = message });\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\n\nvar userId = \"user1\";\nvar message = \"Hello!\";\n\nvar client = new CopilotClient(new CopilotClientOptions()\n .setCliUrl(\"localhost:4321\")\n);\n\ntry {\n client.start().get();\n\n var session = client.createSession(new SessionConfig()\n .setSessionId(String.format(\"user-%s-%d\", userId, System.currentTimeMillis() / 1000))\n .setModel(\"gpt-4.1\")\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n ).get();\n\n var response = session.sendAndWait(new MessageOptions()\n .setPrompt(message)).get();\n} finally {\n client.stop().get();\n}\n```\n\n
\n\n## Authentication for Backend Services\n\n### Environment Variable Tokens\n\nThe simplest approach — set a token on the CLI server:\n\n```mermaid\nflowchart LR\n subgraph Server\n EnvVar[\"COPILOT_GITHUB_TOKEN\"]\n CLI[\"Copilot CLI\"]\n end\n\n EnvVar --> CLI\n CLI --> Copilot[\"☁️ Copilot API\"]\n\n style Server fill:#0d1117,stroke:#58a6ff,color:#c9d1d9\n```\n\n```bash\n# All requests use this token\nexport COPILOT_GITHUB_TOKEN=\"gho_service_account_token\"\ncopilot --headless --port 4321\n```\n\n### Per-User Tokens (OAuth)\n\nPass individual user tokens when creating sessions. See [GitHub OAuth](./github-oauth.md) for the full flow.\n\n```typescript\n// Your API receives user tokens from your auth layer\napp.post(\"/chat\", authMiddleware, async (req, res) => {\n const client = new CopilotClient({\n cliUrl: \"localhost:4321\",\n gitHubToken: req.user.githubToken,\n useLoggedInUser: false,\n });\n\n const session = await client.createSession({\n sessionId: `user-${req.user.id}-chat`,\n model: \"gpt-4.1\",\n });\n\n const response = await session.sendAndWait({\n prompt: req.body.message,\n });\n\n res.json({ content: response?.data.content });\n});\n```\n\n### BYOK (No GitHub Auth)\n\nUse your own API keys for the model provider. See [BYOK](../auth/byok.md) for details.\n\n```typescript\nconst client = new CopilotClient({\n cliUrl: \"localhost:4321\",\n});\n\nconst session = await client.createSession({\n model: \"gpt-4.1\",\n provider: {\n type: \"openai\",\n baseUrl: \"https://api.openai.com/v1\",\n apiKey: process.env.OPENAI_API_KEY,\n },\n});\n```\n\n## Common Backend Patterns\n\n### Web API with Express\n\n```mermaid\nflowchart TB\n Users[\"👥 Users\"] --> LB[\"Load Balancer\"]\n LB --> API1[\"API Instance 1\"]\n LB --> API2[\"API Instance 2\"]\n\n API1 --> CLI[\"Copilot CLI
(headless :4321)\"]\n API2 --> CLI\n\n CLI --> Cloud[\"☁️ Model Provider\"]\n\n style API1 fill:#0d1117,stroke:#58a6ff,color:#c9d1d9\n style API2 fill:#0d1117,stroke:#58a6ff,color:#c9d1d9\n style CLI fill:#0d1117,stroke:#3fb950,color:#c9d1d9\n```\n\n```typescript\nimport express from \"express\";\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst app = express();\napp.use(express.json());\n\n// Single shared CLI connection\nconst client = new CopilotClient({\n cliUrl: process.env.CLI_URL || \"localhost:4321\",\n});\n\napp.post(\"/api/chat\", async (req, res) => {\n const { sessionId, message } = req.body;\n\n // Create or resume session\n let session;\n try {\n session = await client.resumeSession(sessionId);\n } catch {\n session = await client.createSession({\n sessionId,\n model: \"gpt-4.1\",\n });\n }\n\n const response = await session.sendAndWait({ prompt: message });\n res.json({\n sessionId,\n content: response?.data.content,\n });\n});\n\napp.listen(3000);\n```\n\n### Background Worker\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient({\n cliUrl: process.env.CLI_URL || \"localhost:4321\",\n});\n\n// Process jobs from a queue\nasync function processJob(job: Job) {\n const session = await client.createSession({\n sessionId: `job-${job.id}`,\n model: \"gpt-4.1\",\n });\n\n const response = await session.sendAndWait({\n prompt: job.prompt,\n });\n\n await saveResult(job.id, response?.data.content);\n await session.disconnect(); // Clean up after job completes\n}\n```\n\n### Docker Compose Deployment\n\n```yaml\nversion: \"3.8\"\n\nservices:\n copilot-cli:\n image: ghcr.io/github/copilot-cli:latest\n command: [\"--headless\", \"--host\", \"0.0.0.0\", \"--port\", \"4321\"]\n environment:\n - COPILOT_GITHUB_TOKEN=${COPILOT_GITHUB_TOKEN}\n ports:\n - \"4321:4321\"\n restart: always\n volumes:\n - session-data:/root/.copilot/session-state\n\n api:\n build: .\n environment:\n - CLI_URL=copilot-cli:4321\n depends_on:\n - copilot-cli\n ports:\n - \"3000:3000\"\n\nvolumes:\n session-data:\n```\n\n```mermaid\nflowchart TB\n subgraph Docker[\"Docker Compose\"]\n API[\"api:3000\"]\n CLI[\"copilot-cli:4321\"]\n Vol[\"📁 session-data
(persistent volume)\"]\n end\n\n Users[\"👥 Users\"] --> API\n API --> CLI\n CLI --> Vol\n\n CLI --> Cloud[\"☁️ Copilot / Provider\"]\n\n style Docker fill:#0d1117,stroke:#58a6ff,color:#c9d1d9\n```\n\n## Health Checks\n\nMonitor the CLI server's health:\n\n```typescript\n// Periodic health check\nasync function checkCLIHealth(): Promise {\n try {\n const status = await client.getStatus();\n return status !== undefined;\n } catch {\n return false;\n }\n}\n```\n\n## Session Cleanup\n\nBackend services should actively clean up sessions to avoid resource leaks:\n\n```typescript\n// Clean up expired sessions periodically\nasync function cleanupSessions(maxAgeMs: number) {\n const sessions = await client.listSessions();\n const now = Date.now();\n\n for (const session of sessions) {\n const age = now - new Date(session.createdAt).getTime();\n if (age > maxAgeMs) {\n await client.deleteSession(session.sessionId);\n }\n }\n}\n\n// Run every hour\nsetInterval(() => cleanupSessions(24 * 60 * 60 * 1000), 60 * 60 * 1000);\n```\n\n## Limitations\n\n| Limitation | Details |\n|------------|---------|\n| **Single CLI server = single point of failure** | See [Scaling guide](./scaling.md) for HA patterns |\n| **No built-in auth between SDK and CLI** | Secure the network path (same host, VPC, etc.) |\n| **Session state on local disk** | Mount persistent storage for container restarts |\n| **30-minute idle timeout** | Sessions without activity are auto-cleaned |\n\n## When to Move On\n\n| Need | Next Guide |\n|------|-----------|\n| Multiple CLI servers / high availability | [Scaling & Multi-Tenancy](./scaling.md) |\n| GitHub account auth for users | [GitHub OAuth](./github-oauth.md) |\n| Your own model keys | [BYOK](../auth/byok.md) |\n\n## Next Steps\n\n- **[Scaling & Multi-Tenancy](./scaling.md)** — Handle more users, add redundancy\n- **[Session Persistence](../features/session-persistence.md)** — Resume sessions across restarts\n- **[GitHub OAuth](./github-oauth.md)** — Add user authentication\n" }, { "path": "docs/setup/bundled-cli.md", "content": "# Default Setup (Bundled CLI)\n\nThe Node.js, Python, and .NET SDKs include the Copilot CLI as a dependency — your app ships with everything it needs, with no extra installation or configuration required.\n\n**Best for:** Most applications — desktop apps, standalone tools, CLI utilities, prototypes, and more.\n\n## How It Works\n\nWhen you install the SDK, the Copilot CLI binary is included automatically. The SDK starts it as a child process and communicates over stdio. There's nothing extra to configure.\n\n```mermaid\nflowchart TB\n subgraph Bundle[\"Your Application\"]\n App[\"Application Code\"]\n SDK[\"SDK Client\"]\n CLIBin[\"Copilot CLI Binary
(included with SDK)\"]\n end\n\n App --> SDK\n SDK --> CLIBin\n CLIBin -- \"API calls\" --> Copilot[\"☁️ GitHub Copilot\"]\n\n style Bundle fill:#0d1117,stroke:#58a6ff,color:#c9d1d9\n```\n\n**Key characteristics:**\n- CLI binary is included with the SDK — no separate install needed\n- The SDK manages the CLI version to ensure compatibility\n- Users authenticate through your app (or use env vars / BYOK)\n- Sessions are managed per-user on their machine\n\n## Quick Start\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient();\n\nconst session = await client.createSession({ model: \"gpt-4.1\" });\nconst response = await session.sendAndWait({ prompt: \"Hello!\" });\nconsole.log(response?.data.content);\n\nawait client.stop();\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionHandler\n\nclient = CopilotClient()\nawait client.start()\n\nsession = await client.create_session(on_permission_request=PermissionHandler.approve_all, model=\"gpt-4.1\")\nresponse = await session.send_and_wait(\"Hello!\")\nprint(response.data.content)\n\nawait client.stop()\n```\n\n
\n\n
\nGo\n\n> **Note:** The Go SDK does not bundle the CLI. You must install the CLI separately or set `CLIPath` to point to an existing binary. See [Local CLI Setup](./local-cli.md) for details.\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\n\tclient := copilot.NewClient(nil)\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{Model: \"gpt-4.1\"})\n\tresponse, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: \"Hello!\"})\n\tif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\n\t\tfmt.Println(d.Content)\n\t}\n}\n```\n\n\n```go\nclient := copilot.NewClient(nil)\nif err := client.Start(ctx); err != nil {\n log.Fatal(err)\n}\ndefer client.Stop()\n\nsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{Model: \"gpt-4.1\"})\nresponse, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: \"Hello!\"})\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\n fmt.Println(d.Content)\n}\n```\n\n
\n\n
\n.NET\n\n```csharp\nawait using var client = new CopilotClient();\nawait using var session = await client.CreateSessionAsync(\n new SessionConfig { Model = \"gpt-4.1\" });\n\nvar response = await session.SendAndWaitAsync(\n new MessageOptions { Prompt = \"Hello!\" });\nConsole.WriteLine(response?.Data.Content);\n```\n\n
\n\n
\nJava\n\n> **Note:** The Java SDK does not bundle or embed the Copilot CLI. You must install the CLI separately and configure its path via `cliPath` or the `COPILOT_CLI_PATH` environment variable.\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\n\nvar client = new CopilotClient(new CopilotClientOptions()\n // Point to the CLI binary installed on the system\n .setCliPath(\"/path/to/vendor/copilot\")\n);\nclient.start().get();\n\nvar session = client.createSession(new SessionConfig()\n .setModel(\"gpt-4.1\")\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n).get();\n\nvar response = session.sendAndWait(new MessageOptions()\n .setPrompt(\"Hello!\")).get();\nSystem.out.println(response.getData().content());\n\nclient.stop().get();\n```\n\n
\n\n## Authentication Strategies\n\nYou need to decide how your users will authenticate. Here are the common patterns:\n\n```mermaid\nflowchart TB\n App[\"Bundled App\"]\n\n App --> A[\"User signs in to CLI
(keychain credentials)\"]\n App --> B[\"App provides token
(OAuth / env var)\"]\n App --> C[\"BYOK
(your own API keys)\"]\n\n A --> Note1[\"User runs 'copilot' once
to authenticate\"]\n B --> Note2[\"Your app handles login
and passes token\"]\n C --> Note3[\"No GitHub auth needed
Uses your model provider\"]\n\n style App fill:#0d1117,stroke:#58a6ff,color:#c9d1d9\n```\n\n### Option A: User's Signed-In Credentials (Simplest)\n\nThe user signs in to the CLI once, and your app uses those credentials. No extra code needed — this is the default behavior.\n\n```typescript\nconst client = new CopilotClient();\n// Default: uses signed-in user credentials\n```\n\n### Option B: Token via Environment Variable\n\nShip your app with instructions to set a token, or set it programmatically:\n\n```typescript\nconst client = new CopilotClient({\n env: {\n COPILOT_GITHUB_TOKEN: getUserToken(), // Your app provides the token\n },\n});\n```\n\n### Option C: BYOK (No GitHub Auth Needed)\n\nIf you manage your own model provider keys, users don't need GitHub accounts at all:\n\n```typescript\nconst client = new CopilotClient();\n\nconst session = await client.createSession({\n model: \"gpt-4.1\",\n provider: {\n type: \"openai\",\n baseUrl: \"https://api.openai.com/v1\",\n apiKey: process.env.OPENAI_API_KEY,\n },\n});\n```\n\nSee the **[BYOK guide](../auth/byok.md)** for full details.\n\n## Session Management\n\nApps typically want named sessions so users can resume conversations:\n\n```typescript\nconst client = new CopilotClient();\n\n// Create a session tied to the user's project\nconst sessionId = `project-${projectName}`;\nconst session = await client.createSession({\n sessionId,\n model: \"gpt-4.1\",\n});\n\n// User closes app...\n// Later, resume where they left off\nconst resumed = await client.resumeSession(sessionId);\n```\n\nSession state persists at `~/.copilot/session-state/{sessionId}/`.\n\n## When to Move On\n\n| Need | Next Guide |\n|------|-----------|\n| Users signing in with GitHub accounts | [GitHub OAuth](./github-oauth.md) |\n| Run on a server instead of user machines | [Backend Services](./backend-services.md) |\n| Use your own model keys | [BYOK](../auth/byok.md) |\n\n## Next Steps\n\n- **[BYOK guide](../auth/byok.md)** — Use your own model provider keys\n- **[Session Persistence](../features/session-persistence.md)** — Advanced session management\n- **[Getting Started tutorial](../getting-started.md)** — Build a complete app\n" }, { "path": "docs/setup/github-oauth.md", "content": "# GitHub OAuth Setup\n\nLet users authenticate with their GitHub accounts to use Copilot through your application. This supports individual accounts, organization memberships, and enterprise identities.\n\n**Best for:** Multi-user apps, internal tools with org access control, SaaS products, apps where users have GitHub accounts.\n\n## How It Works\n\nYou create a GitHub OAuth App (or GitHub App), users authorize it, and you pass their access token to the SDK. Copilot requests are made on behalf of each authenticated user, using their Copilot subscription.\n\n```mermaid\nsequenceDiagram\n participant User\n participant App as Your App\n participant GH as GitHub\n participant SDK as SDK Client\n participant CLI as Copilot CLI\n participant API as Copilot API\n\n User->>App: Click \"Sign in with GitHub\"\n App->>GH: Redirect to OAuth authorize\n GH->>User: \"Authorize this app?\"\n User->>GH: Approve\n GH->>App: Authorization code\n App->>GH: Exchange code for token\n GH-->>App: Access token (gho_xxx)\n\n App->>SDK: Create client with token\n SDK->>CLI: Start with gitHubToken\n CLI->>API: Request (as user)\n API-->>CLI: Response\n CLI-->>SDK: Result\n SDK-->>App: Display to user\n```\n\n**Key characteristics:**\n- Each user authenticates with their own GitHub account\n- Copilot usage is billed to each user's subscription\n- Supports GitHub organizations and enterprise accounts\n- Your app never handles model API keys — GitHub manages everything\n\n## Architecture\n\n```mermaid\nflowchart TB\n subgraph Users[\"Users\"]\n U1[\"👤 User A
(Org Member)\"]\n U2[\"👤 User B
(Enterprise)\"]\n U3[\"👤 User C
(Personal)\"]\n end\n\n subgraph App[\"Your Application\"]\n OAuth[\"OAuth Flow\"]\n TokenStore[\"Token Store\"]\n SDK[\"SDK Client(s)\"]\n end\n\n subgraph CLI[\"Copilot CLI\"]\n RPC[\"JSON-RPC\"]\n end\n\n U1 --> OAuth\n U2 --> OAuth\n U3 --> OAuth\n OAuth --> TokenStore\n TokenStore --> SDK\n SDK --> RPC\n RPC --> Copilot[\"☁️ GitHub Copilot\"]\n\n style Users fill:#161b22,stroke:#8b949e,color:#c9d1d9\n style App fill:#0d1117,stroke:#58a6ff,color:#c9d1d9\n style CLI fill:#0d1117,stroke:#3fb950,color:#c9d1d9\n```\n\n## Step 1: Create a GitHub OAuth App\n\n1. Go to **GitHub Settings → Developer Settings → OAuth Apps → New OAuth App**\n (or for organizations: **Organization Settings → Developer Settings**)\n\n2. Fill in:\n - **Application name**: Your app's name\n - **Homepage URL**: Your app's URL\n - **Authorization callback URL**: Your OAuth callback endpoint (e.g., `https://yourapp.com/auth/callback`)\n\n3. Note your **Client ID** and generate a **Client Secret**\n\n> **GitHub App vs OAuth App:** Both work. GitHub Apps offer finer-grained permissions and are recommended for new projects. OAuth Apps are simpler to set up. The token flow is the same from the SDK's perspective.\n\n## Step 2: Implement the OAuth Flow\n\nYour application handles the standard GitHub OAuth flow. Here's the server-side token exchange:\n\n```typescript\n// Server-side: Exchange authorization code for user token\nasync function handleOAuthCallback(code: string): Promise {\n const response = await fetch(\"https://github.com/login/oauth/access_token\", {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n Accept: \"application/json\",\n },\n body: JSON.stringify({\n client_id: process.env.GITHUB_CLIENT_ID,\n client_secret: process.env.GITHUB_CLIENT_SECRET,\n code,\n }),\n });\n\n const data = await response.json();\n return data.access_token; // gho_xxxx or ghu_xxxx\n}\n```\n\n## Step 3: Pass the Token to the SDK\n\nCreate a SDK client for each authenticated user, passing their token:\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\n// Create a client for an authenticated user\nfunction createClientForUser(userToken: string): CopilotClient {\n return new CopilotClient({\n gitHubToken: userToken,\n useLoggedInUser: false, // Don't fall back to CLI login\n });\n}\n\n// Usage\nconst client = createClientForUser(\"gho_user_access_token\");\nconst session = await client.createSession({\n sessionId: `user-${userId}-session`,\n model: \"gpt-4.1\",\n});\n\nconst response = await session.sendAndWait({ prompt: \"Hello!\" });\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionHandler\n\ndef create_client_for_user(user_token: str) -> CopilotClient:\n return CopilotClient({\n \"github_token\": user_token,\n \"use_logged_in_user\": False,\n })\n\n# Usage\nclient = create_client_for_user(\"gho_user_access_token\")\nawait client.start()\n\nsession = await client.create_session(on_permission_request=PermissionHandler.approve_all, model=\"gpt-4.1\", session_id=f\"user-{user_id}-session\")\n\nresponse = await session.send_and_wait(\"Hello!\")\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc createClientForUser(userToken string) *copilot.Client {\n\treturn copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: userToken,\n\t\tUseLoggedInUser: copilot.Bool(false),\n\t})\n}\n\nfunc main() {\n\tctx := context.Background()\n\tuserID := \"user1\"\n\n\tclient := createClientForUser(\"gho_user_access_token\")\n\tclient.Start(ctx)\n\tdefer client.Stop()\n\n\tsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tSessionID: fmt.Sprintf(\"user-%s-session\", userID),\n\t\tModel: \"gpt-4.1\",\n\t})\n\tresponse, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: \"Hello!\"})\n\t_ = response\n}\n```\n\n\n```go\nfunc createClientForUser(userToken string) *copilot.Client {\n return copilot.NewClient(&copilot.ClientOptions{\n GithubToken: userToken,\n UseLoggedInUser: copilot.Bool(false),\n })\n}\n\n// Usage\nclient := createClientForUser(\"gho_user_access_token\")\nclient.Start(ctx)\ndefer client.Stop()\n\nsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n SessionID: fmt.Sprintf(\"user-%s-session\", userID),\n Model: \"gpt-4.1\",\n})\nresponse, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: \"Hello!\"})\n```\n\n
\n\n
\n.NET\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\nCopilotClient CreateClientForUser(string userToken) =>\n new CopilotClient(new CopilotClientOptions\n {\n GithubToken = userToken,\n UseLoggedInUser = false,\n });\n\nvar userId = \"user1\";\n\nawait using var client = CreateClientForUser(\"gho_user_access_token\");\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n SessionId = $\"user-{userId}-session\",\n Model = \"gpt-4.1\",\n});\n\nvar response = await session.SendAndWaitAsync(\n new MessageOptions { Prompt = \"Hello!\" });\n```\n\n\n```csharp\nCopilotClient CreateClientForUser(string userToken) =>\n new CopilotClient(new CopilotClientOptions\n {\n GithubToken = userToken,\n UseLoggedInUser = false,\n });\n\n// Usage\nawait using var client = CreateClientForUser(\"gho_user_access_token\");\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n SessionId = $\"user-{userId}-session\",\n Model = \"gpt-4.1\",\n});\n\nvar response = await session.SendAndWaitAsync(\n new MessageOptions { Prompt = \"Hello!\" });\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.*;\nimport com.github.copilot.sdk.json.*;\n\nCopilotClient createClientForUser(String userToken) throws Exception {\n var client = new CopilotClient(new CopilotClientOptions()\n .setGitHubToken(userToken)\n .setUseLoggedInUser(false)\n );\n client.start().get();\n return client;\n}\n\n// Usage — use try-with-resources to ensure cleanup\nvar userId = \"user1\";\ntry (var client = createClientForUser(\"gho_user_access_token\")) {\n var session = client.createSession(new SessionConfig()\n .setSessionId(String.format(\"user-%s-session\", userId))\n .setModel(\"gpt-4.1\")\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n ).get();\n\n var response = session.sendAndWait(new MessageOptions()\n .setPrompt(\"Hello!\")).get();\n}\n```\n\n
\n\n## Enterprise & Organization Access\n\nGitHub OAuth naturally supports enterprise scenarios. When users authenticate with GitHub, their org memberships and enterprise associations come along.\n\n```mermaid\nflowchart TB\n subgraph Enterprise[\"GitHub Enterprise\"]\n Org1[\"Org: Engineering\"]\n Org2[\"Org: Data Science\"]\n end\n\n subgraph Users\n U1[\"👤 Alice
(Engineering)\"]\n U2[\"👤 Bob
(Data Science)\"]\n end\n\n U1 -.->|member| Org1\n U2 -.->|member| Org2\n\n subgraph App[\"Your Internal App\"]\n OAuth[\"OAuth + Org Check\"]\n SDK[\"SDK Client\"]\n end\n\n U1 --> OAuth\n U2 --> OAuth\n OAuth -->|\"Verify org membership\"| GH[\"GitHub API\"]\n OAuth --> SDK\n\n style Enterprise fill:#161b22,stroke:#f0883e,color:#c9d1d9\n style App fill:#0d1117,stroke:#58a6ff,color:#c9d1d9\n```\n\n### Verify Organization Membership\n\nAfter OAuth, check that the user belongs to your organization:\n\n```typescript\nasync function verifyOrgMembership(\n token: string,\n requiredOrg: string\n): Promise {\n const response = await fetch(\"https://api.github.com/user/orgs\", {\n headers: { Authorization: `Bearer ${token}` },\n });\n const orgs = await response.json();\n return orgs.some((org: any) => org.login === requiredOrg);\n}\n\n// In your auth flow\nconst token = await handleOAuthCallback(code);\nif (!await verifyOrgMembership(token, \"my-company\")) {\n throw new Error(\"User is not a member of the required organization\");\n}\nconst client = createClientForUser(token);\n```\n\n### Enterprise Managed Users (EMU)\n\nFor GitHub Enterprise Managed Users, the flow is identical — EMU users authenticate through GitHub OAuth like any other user. Their enterprise policies (IP restrictions, SAML SSO) are enforced by GitHub automatically.\n\n```typescript\n// No special SDK configuration needed for EMU\n// Enterprise policies are enforced server-side by GitHub\nconst client = new CopilotClient({\n gitHubToken: emuUserToken, // Works the same as regular tokens\n useLoggedInUser: false,\n});\n```\n\n## Supported Token Types\n\n| Token Prefix | Source | Works? |\n|-------------|--------|--------|\n| `gho_` | OAuth user access token | ✅ |\n| `ghu_` | GitHub App user access token | ✅ |\n| `github_pat_` | Fine-grained personal access token | ✅ |\n| `ghp_` | Classic personal access token | ❌ (deprecated) |\n\n## Token Lifecycle\n\n```mermaid\nflowchart LR\n A[\"User authorizes\"] --> B[\"Token issued
(gho_xxx)\"]\n B --> C{\"Token valid?\"}\n C -->|Yes| D[\"SDK uses token\"]\n C -->|No| E[\"Refresh or
re-authorize\"]\n E --> B\n D --> F{\"User revokes
or token expires?\"}\n F -->|Yes| E\n F -->|No| D\n\n style A fill:#0d1117,stroke:#3fb950,color:#c9d1d9\n style E fill:#0d1117,stroke:#f0883e,color:#c9d1d9\n```\n\n**Important:** Your application is responsible for token storage, refresh, and expiration handling. The SDK uses whatever token you provide — it doesn't manage the OAuth lifecycle.\n\n### Token Refresh Pattern\n\n```typescript\nasync function getOrRefreshToken(userId: string): Promise {\n const stored = await tokenStore.get(userId);\n\n if (stored && !isExpired(stored)) {\n return stored.accessToken;\n }\n\n if (stored?.refreshToken) {\n const refreshed = await refreshGitHubToken(stored.refreshToken);\n await tokenStore.set(userId, refreshed);\n return refreshed.accessToken;\n }\n\n throw new Error(\"User must re-authenticate\");\n}\n```\n\n## Multi-User Patterns\n\n### One Client Per User (Recommended)\n\nEach user gets their own SDK client with their own token. This provides the strongest isolation.\n\n```typescript\nconst clients = new Map();\n\nfunction getClientForUser(userId: string, token: string): CopilotClient {\n if (!clients.has(userId)) {\n clients.set(userId, new CopilotClient({\n gitHubToken: token,\n useLoggedInUser: false,\n }));\n }\n return clients.get(userId)!;\n}\n```\n\n### Shared CLI with Per-Request Tokens\n\nFor a lighter resource footprint, you can run a single external CLI server and pass tokens per session. See [Backend Services](./backend-services.md) for this pattern.\n\n## Limitations\n\n| Limitation | Details |\n|------------|---------|\n| **Copilot subscription required** | Each user needs an active Copilot subscription |\n| **Token management is your responsibility** | Store, refresh, and handle expiration |\n| **GitHub account required** | Users must have GitHub accounts |\n| **Rate limits per user** | Subject to each user's Copilot rate limits |\n\n## When to Move On\n\n| Need | Next Guide |\n|------|-----------|\n| Users without GitHub accounts | [BYOK](../auth/byok.md) |\n| Run the SDK on servers | [Backend Services](./backend-services.md) |\n| Handle many concurrent users | [Scaling & Multi-Tenancy](./scaling.md) |\n\n## Next Steps\n\n- **[Authentication docs](../auth/index.md)** — Full auth method reference\n- **[Backend Services](./backend-services.md)** — Run the SDK server-side\n- **[Scaling & Multi-Tenancy](./scaling.md)** — Handle many users at scale\n" }, { "path": "docs/setup/index.md", "content": "# Setup Guides\n\nThese guides walk you through configuring the Copilot SDK for your specific use case — from personal side projects to production platforms serving thousands of users.\n\n## Architecture at a Glance\n\nEvery Copilot SDK integration follows the same core pattern: your application talks to the SDK, which communicates with the Copilot CLI over JSON-RPC. What changes across setups is **where the CLI runs**, **how users authenticate**, and **how sessions are managed**.\n\n```mermaid\nflowchart TB\n subgraph YourApp[\"Your Application\"]\n SDK[\"SDK Client\"]\n end\n\n subgraph CLI[\"Copilot CLI\"]\n direction TB\n RPC[\"JSON-RPC Server\"]\n Auth[\"Authentication\"]\n Sessions[\"Session Manager\"]\n Models[\"Model Provider\"]\n end\n\n SDK -- \"JSON-RPC
(stdio or TCP)\" --> RPC\n RPC --> Auth\n RPC --> Sessions\n Auth --> Models\n\n style YourApp fill:#0d1117,stroke:#58a6ff,color:#c9d1d9\n style CLI fill:#161b22,stroke:#3fb950,color:#c9d1d9\n```\n\nThe setup guides below help you configure each layer for your scenario.\n\n## Who Are You?\n\n### 🧑‍💻 Hobbyist\n\nYou're building a personal assistant, side project, or experimental app. You want the simplest path to getting Copilot in your code.\n\n**Start with:**\n1. **[Default Setup](./bundled-cli.md)** — The SDK includes the CLI automatically — just install and go\n2. **[Local CLI](./local-cli.md)** — Use your own CLI binary or running instance (advanced)\n\n### 🏢 Internal App Developer\n\nYou're building tools for your team or company. Users are employees who need to authenticate with their enterprise GitHub accounts or org memberships.\n\n**Start with:**\n1. **[GitHub OAuth](./github-oauth.md)** — Let employees sign in with their GitHub accounts\n2. **[Backend Services](./backend-services.md)** — Run the SDK in your internal services\n\n**If scaling beyond a single server:**\n3. **[Scaling & Multi-Tenancy](./scaling.md)** — Handle multiple users and services\n\n### 🚀 App Developer (ISV)\n\nYou're building a product for customers. You need to handle authentication for your users — either through GitHub or by managing identity yourself.\n\n**Start with:**\n1. **[GitHub OAuth](./github-oauth.md)** — Let customers sign in with GitHub\n2. **[BYOK](../auth/byok.md)** — Manage identity yourself with your own model keys\n3. **[Backend Services](./backend-services.md)** — Power your product from server-side code\n\n**For production:**\n4. **[Scaling & Multi-Tenancy](./scaling.md)** — Serve many customers reliably\n\n### 🏗️ Platform Developer\n\nYou're embedding Copilot into a platform — APIs, developer tools, or infrastructure that other developers build on. You need fine-grained control over sessions, scaling, and multi-tenancy.\n\n**Start with:**\n1. **[Backend Services](./backend-services.md)** — Core server-side integration\n2. **[Scaling & Multi-Tenancy](./scaling.md)** — Session isolation, horizontal scaling, persistence\n\n**Depending on your auth model:**\n3. **[GitHub OAuth](./github-oauth.md)** — For GitHub-authenticated users\n4. **[BYOK](../auth/byok.md)** — For self-managed identity and model access\n\n## Decision Matrix\n\nUse this table to find the right guides based on what you need to do:\n\n| What you need | Guide |\n|---------------|-------|\n| Getting started quickly | [Default Setup (Bundled CLI)](./bundled-cli.md) |\n| Use your own CLI binary or server | [Local CLI](./local-cli.md) |\n| Users sign in with GitHub | [GitHub OAuth](./github-oauth.md) |\n| Use your own model keys (OpenAI, Azure, etc.) | [BYOK](../auth/byok.md) |\n| Azure BYOK with Managed Identity (no API keys) | [Azure Managed Identity](./azure-managed-identity.md) |\n| Run the SDK on a server | [Backend Services](./backend-services.md) |\n| Serve multiple users / scale horizontally | [Scaling & Multi-Tenancy](./scaling.md) |\n\n## Configuration Comparison\n\n```mermaid\nflowchart LR\n subgraph Auth[\"Authentication\"]\n A1[\"Signed-in CLI
(local)\"]\n A2[\"GitHub OAuth
(multi-user)\"]\n A3[\"Env Vars / Tokens
(server)\"]\n A4[\"BYOK
(your keys)\"]\n end\n\n subgraph Deploy[\"Deployment\"]\n D1[\"Local Process
(auto-managed)\"]\n D2[\"Bundled Binary
(shipped with app)\"]\n D3[\"External Server
(headless CLI)\"]\n end\n\n subgraph Scale[\"Scaling\"]\n S1[\"Single User
(one CLI)\"]\n S2[\"Multi-User
(shared CLI)\"]\n S3[\"Isolated
(CLI per user)\"]\n end\n\n A1 --> D1 --> S1\n A2 --> D3 --> S2\n A3 --> D3 --> S2\n A4 --> D2 --> S1\n A2 --> D3 --> S3\n A3 --> D3 --> S3\n\n style Auth fill:#0d1117,stroke:#58a6ff,color:#c9d1d9\n style Deploy fill:#0d1117,stroke:#3fb950,color:#c9d1d9\n style Scale fill:#0d1117,stroke:#f0883e,color:#c9d1d9\n```\n\n## Prerequisites\n\nAll guides assume you have:\n\n- **One of the SDKs** installed (Node.js, Python, and .NET SDKs include the CLI automatically):\n - Node.js: `npm install @github/copilot-sdk`\n - Python: `pip install github-copilot-sdk`\n - Go: `go get github.com/github/copilot-sdk/go` (requires separate CLI installation)\n - .NET: `dotnet add package GitHub.Copilot.SDK`\n\nIf you're brand new, start with the **[Getting Started tutorial](../getting-started.md)** first, then come back here for production configuration.\n\n## Next Steps\n\nPick the guide that matches your situation from the [decision matrix](#decision-matrix) above, or start with the persona description closest to your role.\n" }, { "path": "docs/setup/local-cli.md", "content": "# Local CLI Setup\n\nUse a specific CLI binary instead of the SDK's bundled CLI. This is an advanced option — you supply the CLI path explicitly, and you are responsible for ensuring version compatibility with the SDK.\n\n**Use when:** You need to pin a specific CLI version, or work with the Go SDK (which does not bundle a CLI).\n\n## How It Works\n\nBy default, the Node.js, Python, and .NET SDKs include their own CLI dependency (see [Default Setup](./bundled-cli.md)). If you need to override this — for example, to use a system-installed CLI — you can use the `cliPath` option.\n\n```mermaid\nflowchart LR\n subgraph YourMachine[\"Your Machine\"]\n App[\"Your App\"] --> SDK[\"SDK Client\"]\n SDK -- \"cliPath\" --> CLI[\"Copilot CLI
(your own binary)\"]\n CLI --> Keychain[\"🔐 System Keychain
(stored credentials)\"]\n end\n CLI -- \"API calls\" --> Copilot[\"☁️ GitHub Copilot\"]\n\n style YourMachine fill:#0d1117,stroke:#58a6ff,color:#c9d1d9\n```\n\n**Key characteristics:**\n- You explicitly provide the CLI binary path\n- You are responsible for CLI version compatibility with the SDK\n- Authentication uses the signed-in user's credentials from the system keychain (or env vars)\n- Communication happens over stdio\n\n## Configuration\n\n### Using a local CLI binary\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient({\n cliPath: \"/usr/local/bin/copilot\",\n});\n\nconst session = await client.createSession({ model: \"gpt-4.1\" });\nconst response = await session.sendAndWait({ prompt: \"Hello!\" });\nconsole.log(response?.data.content);\n\nawait client.stop();\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.generated.session_events import AssistantMessageData\nfrom copilot.session import PermissionHandler\n\nclient = CopilotClient({\n \"cli_path\": \"/usr/local/bin/copilot\",\n})\nawait client.start()\n\nsession = await client.create_session(on_permission_request=PermissionHandler.approve_all, model=\"gpt-4.1\")\nresponse = await session.send_and_wait(\"Hello!\")\nif response:\n match response.data:\n case AssistantMessageData() as data:\n print(data.content)\n\nawait client.stop()\n```\n\n
\n\n
\nGo\n\n> **Note:** The Go SDK does not bundle a CLI, so you must always provide `CLIPath`.\n\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tCLIPath: \"/usr/local/bin/copilot\",\n\t})\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{Model: \"gpt-4.1\"})\n\tresponse, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: \"Hello!\"})\n\tif response != nil {\n\t\tif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\n\t\t\tfmt.Println(d.Content)\n\t\t}\n\t}\n}\n```\n\n\n```go\nclient := copilot.NewClient(&copilot.ClientOptions{\n CLIPath: \"/usr/local/bin/copilot\",\n})\nif err := client.Start(ctx); err != nil {\n log.Fatal(err)\n}\ndefer client.Stop()\n\nsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{Model: \"gpt-4.1\"})\nresponse, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: \"Hello!\"})\nif response != nil {\n if d, ok := response.Data.(*copilot.AssistantMessageData); ok {\n fmt.Println(d.Content)\n }\n}\n```\n\n
\n\n
\n.NET\n\n```csharp\nvar client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = \"/usr/local/bin/copilot\",\n});\n\nawait using var session = await client.CreateSessionAsync(\n new SessionConfig { Model = \"gpt-4.1\" });\n\nvar response = await session.SendAndWaitAsync(\n new MessageOptions { Prompt = \"Hello!\" });\nConsole.WriteLine(response?.Data.Content);\n```\n\n
\n\n## Additional Options\n\n```typescript\nconst client = new CopilotClient({\n cliPath: \"/usr/local/bin/copilot\",\n\n // Set log level for debugging\n logLevel: \"debug\",\n\n // Pass extra CLI arguments\n cliArgs: [\"--log-dir=/tmp/copilot-logs\"],\n\n // Set working directory\n cwd: \"/path/to/project\",\n});\n```\n\n## Using Environment Variables\n\nInstead of the keychain, you can authenticate via environment variables. This is useful for CI or when you don't want interactive login.\n\n```bash\n# Set one of these (in priority order):\nexport COPILOT_GITHUB_TOKEN=\"gho_xxxx\" # Recommended\nexport GH_TOKEN=\"gho_xxxx\" # GitHub CLI compatible\nexport GITHUB_TOKEN=\"gho_xxxx\" # GitHub Actions compatible\n```\n\nThe SDK picks these up automatically — no code changes needed.\n\n## Managing Sessions\n\nSessions default to ephemeral. To create resumable sessions, provide your own session ID:\n\n```typescript\n// Create a named session\nconst session = await client.createSession({\n sessionId: \"my-project-analysis\",\n model: \"gpt-4.1\",\n});\n\n// Later, resume it\nconst resumed = await client.resumeSession(\"my-project-analysis\");\n```\n\nSession state is stored locally at `~/.copilot/session-state/{sessionId}/`.\n\n## Limitations\n\n| Limitation | Details |\n|------------|---------|\n| **Version compatibility** | You must ensure your CLI version is compatible with the SDK |\n| **Single user** | Credentials are tied to whoever signed in to the CLI |\n| **Local only** | The CLI runs on the same machine as your app |\n| **No multi-tenant** | Can't serve multiple users from one CLI instance |\n\n## Next Steps\n\n- **[Default Setup](./bundled-cli.md)** — Use the SDK's built-in CLI (recommended for most use cases)\n- **[Getting Started tutorial](../getting-started.md)** — Build a complete interactive app\n- **[Authentication docs](../auth/index.md)** — All auth methods in detail\n" }, { "path": "docs/setup/scaling.md", "content": "# Scaling & Multi-Tenancy\n\nDesign your Copilot SDK deployment to serve multiple users, handle concurrent sessions, and scale horizontally across infrastructure. This guide covers session isolation patterns, scaling topologies, and production best practices.\n\n**Best for:** Platform developers, SaaS builders, any deployment serving more than a handful of concurrent users.\n\n## Core Concepts\n\nBefore choosing a pattern, understand three dimensions of scaling:\n\n```mermaid\nflowchart TB\n subgraph Dimensions[\"Scaling Dimensions\"]\n direction LR\n I[\"🔒 Isolation
Who sees what?\"]\n C[\"⚡ Concurrency
How many at once?\"]\n P[\"💾 Persistence
How long do sessions live?\"]\n end\n\n I --> I1[\"Shared CLI
vs. CLI per user\"]\n C --> C1[\"Session pooling
vs. on-demand\"]\n P --> P1[\"Ephemeral
vs. persistent\"]\n\n style Dimensions fill:#0d1117,stroke:#58a6ff,color:#c9d1d9\n```\n\n## Session Isolation Patterns\n\n### Pattern 1: Isolated CLI Per User\n\nEach user gets their own CLI server instance. Strongest isolation — a user's sessions, memory, and processes are completely separated.\n\n```mermaid\nflowchart TB\n LB[\"Load Balancer\"]\n\n subgraph User_A[\"User A\"]\n SDK_A[\"SDK Client\"] --> CLI_A[\"CLI Server A
:4321\"]\n CLI_A --> SA[\"📁 Sessions A\"]\n end\n\n subgraph User_B[\"User B\"]\n SDK_B[\"SDK Client\"] --> CLI_B[\"CLI Server B
:4322\"]\n CLI_B --> SB[\"📁 Sessions B\"]\n end\n\n subgraph User_C[\"User C\"]\n SDK_C[\"SDK Client\"] --> CLI_C[\"CLI Server C
:4323\"]\n CLI_C --> SC[\"📁 Sessions C\"]\n end\n\n LB --> SDK_A\n LB --> SDK_B\n LB --> SDK_C\n\n style User_A fill:#0d1117,stroke:#3fb950,color:#c9d1d9\n style User_B fill:#0d1117,stroke:#3fb950,color:#c9d1d9\n style User_C fill:#0d1117,stroke:#3fb950,color:#c9d1d9\n```\n\n**When to use:**\n- Multi-tenant SaaS where data isolation is critical\n- Users with different auth credentials\n- Compliance requirements (SOC 2, HIPAA)\n\n```typescript\n// CLI pool manager — one CLI per user\nclass CLIPool {\n private instances = new Map();\n private nextPort = 5000;\n\n async getClientForUser(userId: string, token?: string): Promise {\n if (this.instances.has(userId)) {\n return this.instances.get(userId)!.client;\n }\n\n const port = this.nextPort++;\n\n // Spawn a dedicated CLI for this user\n await spawnCLI(port, token);\n\n const client = new CopilotClient({\n cliUrl: `localhost:${port}`,\n });\n\n this.instances.set(userId, { client, port });\n return client;\n }\n\n async releaseUser(userId: string): Promise {\n const instance = this.instances.get(userId);\n if (instance) {\n await instance.client.stop();\n this.instances.delete(userId);\n }\n }\n}\n```\n\n### Pattern 2: Shared CLI with Session Isolation\n\nMultiple users share one CLI server but have isolated sessions via unique session IDs. Lighter on resources, but weaker isolation.\n\n```mermaid\nflowchart TB\n U1[\"👤 User A\"]\n U2[\"👤 User B\"]\n U3[\"👤 User C\"]\n\n subgraph App[\"Your App\"]\n Router[\"Session Router\"]\n end\n\n subgraph CLI[\"Shared CLI Server :4321\"]\n SA[\"Session: user-a-chat\"]\n SB[\"Session: user-b-chat\"]\n SC[\"Session: user-c-chat\"]\n end\n\n U1 --> Router\n U2 --> Router\n U3 --> Router\n\n Router --> SA\n Router --> SB\n Router --> SC\n\n style App fill:#0d1117,stroke:#58a6ff,color:#c9d1d9\n style CLI fill:#0d1117,stroke:#3fb950,color:#c9d1d9\n```\n\n**When to use:**\n- Internal tools with trusted users\n- Resource-constrained environments\n- Lower isolation requirements\n\n```typescript\nconst sharedClient = new CopilotClient({\n cliUrl: \"localhost:4321\",\n});\n\n// Enforce session isolation through naming conventions\nfunction getSessionId(userId: string, purpose: string): string {\n return `${userId}-${purpose}-${Date.now()}`;\n}\n\n// Access control: ensure users can only access their own sessions\nasync function resumeSessionWithAuth(\n sessionId: string,\n currentUserId: string\n): Promise {\n const [sessionUserId] = sessionId.split(\"-\");\n if (sessionUserId !== currentUserId) {\n throw new Error(\"Access denied: session belongs to another user\");\n }\n return sharedClient.resumeSession(sessionId);\n}\n```\n\n### Pattern 3: Shared Sessions (Collaborative)\n\nMultiple users interact with the same session — like a shared chat room with Copilot.\n\n```mermaid\nflowchart TB\n U1[\"👤 Alice\"]\n U2[\"👤 Bob\"]\n U3[\"👤 Carol\"]\n\n subgraph App[\"Collaboration Layer\"]\n Queue[\"Message Queue
(serialize access)\"]\n Lock[\"Session Lock\"]\n end\n\n subgraph CLI[\"CLI Server\"]\n Session[\"Shared Session:
team-project-review\"]\n end\n\n U1 --> Queue\n U2 --> Queue\n U3 --> Queue\n\n Queue --> Lock\n Lock --> Session\n\n style App fill:#0d1117,stroke:#58a6ff,color:#c9d1d9\n style CLI fill:#0d1117,stroke:#3fb950,color:#c9d1d9\n```\n\n**When to use:**\n- Team collaboration tools\n- Shared code review sessions\n- Pair programming assistants\n\n> ⚠️ **Important:** The SDK doesn't provide built-in session locking. You **must** serialize access to prevent concurrent writes to the same session.\n\n```typescript\nimport Redis from \"ioredis\";\n\nconst redis = new Redis();\n\nasync function withSessionLock(\n sessionId: string,\n fn: () => Promise,\n timeoutSec = 300\n): Promise {\n const lockKey = `session-lock:${sessionId}`;\n const lockId = crypto.randomUUID();\n\n // Acquire lock\n const acquired = await redis.set(lockKey, lockId, \"NX\", \"EX\", timeoutSec);\n if (!acquired) {\n throw new Error(\"Session is in use by another user\");\n }\n\n try {\n return await fn();\n } finally {\n // Release lock (only if we still own it)\n const currentLock = await redis.get(lockKey);\n if (currentLock === lockId) {\n await redis.del(lockKey);\n }\n }\n}\n\n// Usage: serialize access to shared session\napp.post(\"/team-chat\", authMiddleware, async (req, res) => {\n const result = await withSessionLock(\"team-project-review\", async () => {\n const session = await client.resumeSession(\"team-project-review\");\n return session.sendAndWait({ prompt: req.body.message });\n });\n\n res.json({ content: result?.data.content });\n});\n```\n\n## Comparison of Isolation Patterns\n\n| | Isolated CLI Per User | Shared CLI + Session Isolation | Shared Sessions |\n|---|---|---|---|\n| **Isolation** | ✅ Complete | ⚠️ Logical | ❌ Shared |\n| **Resource usage** | High (CLI per user) | Low (one CLI) | Low (one CLI + session) |\n| **Complexity** | Medium | Low | High (locking) |\n| **Auth flexibility** | ✅ Per-user tokens | ⚠️ Service token | ⚠️ Service token |\n| **Best for** | Multi-tenant SaaS | Internal tools | Collaboration |\n\n## Horizontal Scaling\n\n### Multiple CLI Servers Behind a Load Balancer\n\n```mermaid\nflowchart TB\n Users[\"👥 Users\"] --> LB[\"Load Balancer\"]\n\n subgraph Pool[\"CLI Server Pool\"]\n CLI1[\"CLI Server 1
:4321\"]\n CLI2[\"CLI Server 2
:4322\"]\n CLI3[\"CLI Server 3
:4323\"]\n end\n\n subgraph Storage[\"Shared Storage\"]\n NFS[\"📁 Network File System
or Cloud Storage\"]\n end\n\n LB --> CLI1\n LB --> CLI2\n LB --> CLI3\n\n CLI1 --> NFS\n CLI2 --> NFS\n CLI3 --> NFS\n\n style Pool fill:#0d1117,stroke:#3fb950,color:#c9d1d9\n style Storage fill:#161b22,stroke:#f0883e,color:#c9d1d9\n```\n\n**Key requirement:** Session state must be on **shared storage** so any CLI server can resume any session.\n\n```typescript\n// Route sessions to CLI servers\nclass CLILoadBalancer {\n private servers: string[];\n private currentIndex = 0;\n\n constructor(servers: string[]) {\n this.servers = servers;\n }\n\n // Round-robin selection\n getNextServer(): string {\n const server = this.servers[this.currentIndex];\n this.currentIndex = (this.currentIndex + 1) % this.servers.length;\n return server;\n }\n\n // Sticky sessions: same user always hits same server\n getServerForUser(userId: string): string {\n const hash = this.hashCode(userId);\n return this.servers[hash % this.servers.length];\n }\n\n private hashCode(str: string): number {\n let hash = 0;\n for (let i = 0; i < str.length; i++) {\n hash = (hash << 5) - hash + str.charCodeAt(i);\n hash |= 0;\n }\n return Math.abs(hash);\n }\n}\n\nconst lb = new CLILoadBalancer([\n \"cli-1:4321\",\n \"cli-2:4321\",\n \"cli-3:4321\",\n]);\n\napp.post(\"/chat\", async (req, res) => {\n const server = lb.getServerForUser(req.user.id);\n const client = new CopilotClient({ cliUrl: server });\n\n const session = await client.createSession({\n sessionId: `user-${req.user.id}-chat`,\n model: \"gpt-4.1\",\n });\n\n const response = await session.sendAndWait({ prompt: req.body.message });\n res.json({ content: response?.data.content });\n});\n```\n\n### Sticky Sessions vs. Shared Storage\n\n```mermaid\nflowchart LR\n subgraph Sticky[\"Sticky Sessions\"]\n direction TB\n S1[\"User A → always CLI 1\"]\n S2[\"User B → always CLI 2\"]\n S3[\"✅ No shared storage needed\"]\n S4[\"❌ Uneven load if users vary\"]\n end\n\n subgraph Shared[\"Shared Storage\"]\n direction TB\n SH1[\"User A → any CLI\"]\n SH2[\"User B → any CLI\"]\n SH3[\"✅ Even load distribution\"]\n SH4[\"❌ Requires NFS / cloud storage\"]\n end\n\n style Sticky fill:#0d1117,stroke:#58a6ff,color:#c9d1d9\n style Shared fill:#0d1117,stroke:#3fb950,color:#c9d1d9\n```\n\n**Sticky sessions** are simpler — pin users to specific CLI servers. No shared storage needed, but load distribution is uneven.\n\n**Shared storage** enables any CLI to handle any session. Better load distribution, but requires networked storage for `~/.copilot/session-state/`.\n\n## Vertical Scaling\n\n### Tuning a Single CLI Server\n\nA single CLI server can handle many concurrent sessions. Key considerations:\n\n```mermaid\nflowchart TB\n subgraph Resources[\"Resource Dimensions\"]\n CPU[\"🔧 CPU
Model request processing\"]\n MEM[\"💾 Memory
Active session state\"]\n DISK[\"💿 Disk I/O
Session persistence\"]\n NET[\"🌐 Network
API calls to provider\"]\n end\n\n style Resources fill:#0d1117,stroke:#58a6ff,color:#c9d1d9\n```\n\n**Session lifecycle management** is key to vertical scaling:\n\n```typescript\n// Limit concurrent active sessions\nclass SessionManager {\n private activeSessions = new Map();\n private maxConcurrent: number;\n\n constructor(maxConcurrent = 50) {\n this.maxConcurrent = maxConcurrent;\n }\n\n async getSession(sessionId: string): Promise {\n // Return existing active session\n if (this.activeSessions.has(sessionId)) {\n return this.activeSessions.get(sessionId)!;\n }\n\n // Enforce concurrency limit\n if (this.activeSessions.size >= this.maxConcurrent) {\n await this.evictOldestSession();\n }\n\n // Create or resume\n const session = await client.createSession({\n sessionId,\n model: \"gpt-4.1\",\n });\n\n this.activeSessions.set(sessionId, session);\n return session;\n }\n\n private async evictOldestSession(): Promise {\n const [oldestId] = this.activeSessions.keys();\n const session = this.activeSessions.get(oldestId)!;\n // Session state is persisted automatically — safe to disconnect\n await session.disconnect();\n this.activeSessions.delete(oldestId);\n }\n}\n```\n\n## Ephemeral vs. Persistent Sessions\n\n```mermaid\nflowchart LR\n subgraph Ephemeral[\"Ephemeral Sessions\"]\n E1[\"Created per request\"]\n E2[\"Destroyed after use\"]\n E3[\"No state to manage\"]\n E4[\"Good for: one-shot tasks,
stateless APIs\"]\n end\n\n subgraph Persistent[\"Persistent Sessions\"]\n P1[\"Named session ID\"]\n P2[\"Survives restarts\"]\n P3[\"Resumable\"]\n P4[\"Good for: multi-turn chat,
long workflows\"]\n end\n\n style Ephemeral fill:#0d1117,stroke:#58a6ff,color:#c9d1d9\n style Persistent fill:#0d1117,stroke:#3fb950,color:#c9d1d9\n```\n\n### Ephemeral Sessions\n\nFor stateless API endpoints where each request is independent:\n\n```typescript\napp.post(\"/api/analyze\", async (req, res) => {\n const session = await client.createSession({\n model: \"gpt-4.1\",\n });\n\n try {\n const response = await session.sendAndWait({\n prompt: req.body.prompt,\n });\n res.json({ result: response?.data.content });\n } finally {\n await session.disconnect(); // Clean up immediately\n }\n});\n```\n\n### Persistent Sessions\n\nFor conversational interfaces or long-running workflows:\n\n```typescript\n// Create a resumable session\napp.post(\"/api/chat/start\", async (req, res) => {\n const sessionId = `user-${req.user.id}-${Date.now()}`;\n\n const session = await client.createSession({\n sessionId,\n model: \"gpt-4.1\",\n infiniteSessions: {\n enabled: true,\n backgroundCompactionThreshold: 0.80,\n },\n });\n\n res.json({ sessionId });\n});\n\n// Continue the conversation\napp.post(\"/api/chat/message\", async (req, res) => {\n const session = await client.resumeSession(req.body.sessionId);\n const response = await session.sendAndWait({ prompt: req.body.message });\n\n res.json({ content: response?.data.content });\n});\n\n// Clean up when done\napp.post(\"/api/chat/end\", async (req, res) => {\n await client.deleteSession(req.body.sessionId);\n res.json({ success: true });\n});\n```\n\n## Container Deployments\n\n### Kubernetes with Persistent Storage\n\n```yaml\napiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: copilot-cli\nspec:\n replicas: 3\n selector:\n matchLabels:\n app: copilot-cli\n template:\n metadata:\n labels:\n app: copilot-cli\n spec:\n containers:\n - name: copilot-cli\n image: ghcr.io/github/copilot-cli:latest\n args: [\"--headless\", \"--host\", \"0.0.0.0\", \"--port\", \"4321\"]\n env:\n - name: COPILOT_GITHUB_TOKEN\n valueFrom:\n secretKeyRef:\n name: copilot-secrets\n key: github-token\n ports:\n - containerPort: 4321\n volumeMounts:\n - name: session-state\n mountPath: /root/.copilot/session-state\n volumes:\n - name: session-state\n persistentVolumeClaim:\n claimName: copilot-sessions-pvc\n---\napiVersion: v1\nkind: Service\nmetadata:\n name: copilot-cli\nspec:\n selector:\n app: copilot-cli\n ports:\n - port: 4321\n targetPort: 4321\n```\n\n```mermaid\nflowchart TB\n subgraph K8s[\"Kubernetes Cluster\"]\n Svc[\"Service: copilot-cli:4321\"]\n Pod1[\"Pod 1: CLI\"]\n Pod2[\"Pod 2: CLI\"]\n Pod3[\"Pod 3: CLI\"]\n PVC[\"PersistentVolumeClaim
(shared session state)\"]\n end\n\n App[\"Your App Pods\"] --> Svc\n Svc --> Pod1\n Svc --> Pod2\n Svc --> Pod3\n\n Pod1 --> PVC\n Pod2 --> PVC\n Pod3 --> PVC\n\n style K8s fill:#0d1117,stroke:#58a6ff,color:#c9d1d9\n```\n\n### Azure Container Instances\n\n```yaml\ncontainers:\n - name: copilot-cli\n image: ghcr.io/github/copilot-cli:latest\n command: [\"copilot\", \"--headless\", \"--host\", \"0.0.0.0\", \"--port\", \"4321\"]\n volumeMounts:\n - name: session-storage\n mountPath: /root/.copilot/session-state\n\nvolumes:\n - name: session-storage\n azureFile:\n shareName: copilot-sessions\n storageAccountName: myaccount\n```\n\n## Production Checklist\n\n```mermaid\nflowchart TB\n subgraph Checklist[\"Production Readiness\"]\n direction TB\n A[\"✅ Session cleanup
cron / TTL\"]\n B[\"✅ Health checks
ping endpoint\"]\n C[\"✅ Persistent storage
for session state\"]\n D[\"✅ Secret management
for tokens/keys\"]\n E[\"✅ Monitoring
active sessions, latency\"]\n F[\"✅ Session locking
if shared sessions\"]\n G[\"✅ Graceful shutdown
drain active sessions\"]\n end\n\n style Checklist fill:#0d1117,stroke:#3fb950,color:#c9d1d9\n```\n\n| Concern | Recommendation |\n|---------|---------------|\n| **Session cleanup** | Run periodic cleanup to delete sessions older than your TTL |\n| **Health checks** | Ping the CLI server periodically; restart if unresponsive |\n| **Storage** | Mount persistent volumes for `~/.copilot/session-state/` |\n| **Secrets** | Use your platform's secret manager (Vault, K8s Secrets, etc.) |\n| **Monitoring** | Track active session count, response latency, error rates |\n| **Locking** | Use Redis or similar for shared session access |\n| **Shutdown** | Drain active sessions before stopping CLI servers |\n\n## Limitations\n\n| Limitation | Details |\n|------------|---------|\n| **No built-in session locking** | Implement application-level locking for concurrent access |\n| **No built-in load balancing** | Use external LB or service mesh |\n| **Session state is file-based** | Requires shared filesystem for multi-server setups |\n| **30-minute idle timeout** | Sessions without activity are auto-cleaned by the CLI |\n| **CLI is single-process** | Scale by adding more CLI server instances, not threads |\n\n## Next Steps\n\n- **[Session Persistence](../features/session-persistence.md)** — Deep dive on resumable sessions\n- **[Backend Services](./backend-services.md)** — Core server-side setup\n- **[GitHub OAuth](./github-oauth.md)** — Multi-user authentication\n- **[BYOK](../auth/byok.md)** — Use your own model provider\n" }, { "path": "docs/troubleshooting/compatibility.md", "content": "# SDK and CLI Compatibility\n\nThis document outlines which Copilot CLI features are available through the SDK and which are CLI-only.\n\n## Overview\n\nThe Copilot SDK communicates with the CLI via JSON-RPC protocol. Features must be explicitly exposed through this protocol to be available in the SDK. Many interactive CLI features are terminal-specific and not available programmatically.\n\n## Feature Comparison\n\n### ✅ Available in SDK\n\n| Feature | SDK Method | Notes |\n|---------|------------|-------|\n| **Session Management** | | |\n| Create session | `createSession()` | Full config support |\n| Resume session | `resumeSession()` | With infinite session workspaces |\n| Disconnect session | `disconnect()` | Release in-memory resources |\n| Destroy session *(deprecated)* | `destroy()` | Use `disconnect()` instead |\n| Delete session | `deleteSession()` | Remove from storage |\n| List sessions | `listSessions()` | All stored sessions |\n| Get last session | `getLastSessionId()` | For quick resume |\n| Get foreground session | `getForegroundSessionId()` | Multi-session coordination |\n| Set foreground session | `setForegroundSessionId()` | Multi-session coordination |\n| **Messaging** | | |\n| Send message | `send()` | With attachments |\n| Send and wait | `sendAndWait()` | Blocks until complete |\n| Steering (immediate mode) | `send({ mode: \"immediate\" })` | Inject mid-turn without aborting |\n| Queueing (enqueue mode) | `send({ mode: \"enqueue\" })` | Buffer for sequential processing (default) |\n| File attachments | `send({ attachments: [{ type: \"file\", path }] })` | Images auto-encoded and resized |\n| Directory attachments | `send({ attachments: [{ type: \"directory\", path }] })` | Attach directory context |\n| Get history | `getMessages()` | All session events |\n| Abort | `abort()` | Cancel in-flight request |\n| **Tools** | | |\n| Register custom tools | `registerTools()` | Full JSON Schema support |\n| Tool permission control | `onPreToolUse` hook | Allow/deny/ask |\n| Tool result modification | `onPostToolUse` hook | Transform results |\n| Available/excluded tools | `availableTools`, `excludedTools` config | Filter tools |\n| **Models** | | |\n| List models | `listModels()` | With capabilities, billing, policy |\n| Set model (at creation) | `model` in session config | Per-session |\n| Switch model (mid-session) | `session.setModel()` | Also via `session.rpc.model.switchTo()` |\n| Get current model | `session.rpc.model.getCurrent()` | Query active model |\n| Reasoning effort | `reasoningEffort` config | For supported models |\n| **Agent Mode** | | |\n| Get current mode | `session.rpc.mode.get()` | Returns current mode |\n| Set mode | `session.rpc.mode.set()` | Switch between modes |\n| **Plan Management** | | |\n| Read plan | `session.rpc.plan.read()` | Get plan.md content and path |\n| Update plan | `session.rpc.plan.update()` | Write plan.md content |\n| Delete plan | `session.rpc.plan.delete()` | Remove plan.md |\n| **Workspace Files** | | |\n| List workspace files | `session.rpc.workspace.listFiles()` | Files in session workspace |\n| Read workspace file | `session.rpc.workspace.readFile()` | Read file content |\n| Create workspace file | `session.rpc.workspace.createFile()` | Create file in workspace |\n| **Authentication** | | |\n| Get auth status | `getAuthStatus()` | Check login state |\n| Use token | `gitHubToken` option | Programmatic auth |\n| **Connectivity** | | |\n| Ping | `client.ping()` | Health check with server timestamp |\n| Get server status | `client.getStatus()` | Protocol version and server info |\n| **MCP Servers** | | |\n| Local/stdio servers | `mcpServers` config | Spawn processes |\n| Remote HTTP/SSE | `mcpServers` config | Connect to services |\n| **Hooks** | | |\n| Pre-tool use | `onPreToolUse` | Permission, modify args |\n| Post-tool use | `onPostToolUse` | Modify results |\n| User prompt | `onUserPromptSubmitted` | Modify prompts |\n| Session start/end | `onSessionStart`, `onSessionEnd` | Lifecycle with source/reason |\n| Error handling | `onErrorOccurred` | Custom handling |\n| **Events** | | |\n| All session events | `on()`, `once()` | 40+ event types |\n| Streaming | `streaming: true` | Delta events |\n| **Session Config** | | |\n| Custom agents | `customAgents` config | Define specialized agents |\n| System message | `systemMessage` config | Append or replace |\n| Custom provider | `provider` config | BYOK support |\n| Infinite sessions | `infiniteSessions` config | Auto-compaction |\n| Permission handler | `onPermissionRequest` | Approve/deny requests |\n| User input handler | `onUserInputRequest` | Handle ask_user |\n| Skills | `skillDirectories` config | Custom skills |\n| Disabled skills | `disabledSkills` config | Disable specific skills |\n| Config directory | `configDir` config | Override default config location |\n| Client name | `clientName` config | Identify app in User-Agent |\n| Working directory | `workingDirectory` config | Set session cwd |\n| **Experimental** | | |\n| Agent management | `session.rpc.agent.*` | List, select, deselect, get current agent |\n| Fleet mode | `session.rpc.fleet.start()` | Parallel sub-agent execution |\n| Manual compaction | `session.rpc.history.compact()` | Trigger compaction on demand |\n| History truncation | `session.rpc.history.truncate()` | Remove events from a point onward |\n| Session forking | `server.rpc.sessions.fork()` | Fork a session at a point in history |\n\n### ❌ Not Available in SDK (CLI-Only)\n\n| Feature | CLI Command/Option | Reason |\n|---------|-------------------|--------|\n| **Session Export** | | |\n| Export to file | `--share`, `/share` | Not in protocol |\n| Export to gist | `--share-gist`, `/share gist` | Not in protocol |\n| **Interactive UI** | | |\n| Slash commands | `/help`, `/clear`, `/exit`, etc. | TUI-only |\n| Agent picker dialog | `/agent` | Interactive UI |\n| Diff mode dialog | `/diff` | Interactive UI |\n| Feedback dialog | `/feedback` | Interactive UI |\n| Theme picker | `/theme` | Terminal UI |\n| Model picker | `/model` | Interactive UI (use SDK `setModel()` instead) |\n| Copy to clipboard | `/copy` | Terminal-specific |\n| Context management | `/context` | Interactive UI |\n| **Research & History** | | |\n| Deep research | `/research` | TUI workflow with web search |\n| Session history tools | `/chronicle` | Standup, tips, improve, reindex |\n| **Terminal Features** | | |\n| Color output | `--no-color` | Terminal-specific |\n| Screen reader mode | `--screen-reader` | Accessibility |\n| Rich diff rendering | `--plain-diff` | Terminal rendering |\n| Startup banner | `--banner` | Visual element |\n| Streamer mode | `/streamer-mode` | TUI display mode |\n| Alternate screen buffer | `--alt-screen`, `--no-alt-screen` | Terminal rendering |\n| Mouse support | `--mouse`, `--no-mouse` | Terminal input |\n| **Path/Permission Shortcuts** | | |\n| Allow all paths | `--allow-all-paths` | Use permission handler |\n| Allow all URLs | `--allow-all-urls` | Use permission handler |\n| Allow all permissions | `--yolo`, `--allow-all`, `/allow-all` | Use permission handler |\n| Granular tool permissions | `--allow-tool`, `--deny-tool` | Use `onPreToolUse` hook |\n| URL access control | `--allow-url`, `--deny-url` | Use permission handler |\n| Reset allowed tools | `/reset-allowed-tools` | TUI command |\n| **Directory Management** | | |\n| Add directory | `/add-dir`, `--add-dir` | Configure in session |\n| List directories | `/list-dirs` | TUI command |\n| Change directory | `/cwd` | TUI command |\n| **Plugin/MCP Management** | | |\n| Plugin commands | `/plugin` | Interactive management |\n| MCP server management | `/mcp` | Interactive UI |\n| **Account Management** | | |\n| Login flow | `/login`, `copilot auth login` | OAuth device flow |\n| Logout | `/logout`, `copilot auth logout` | Direct CLI |\n| User info | `/user` | TUI command |\n| **Session Operations** | | |\n| Clear conversation | `/clear` | TUI-only |\n| Plan view | `/plan` | TUI-only (use SDK `session.rpc.plan.*` instead) |\n| Session management | `/session`, `/resume`, `/rename` | TUI workflow |\n| Fleet mode (interactive) | `/fleet` | TUI-only (use SDK `session.rpc.fleet.start()` instead) |\n| **Skills Management** | | |\n| Manage skills | `/skills` | Interactive UI |\n| **Task Management** | | |\n| View background tasks | `/tasks` | TUI command |\n| **Usage & Stats** | | |\n| Token usage | `/usage` | Subscribe to usage events |\n| **Code Review** | | |\n| Review changes | `/review` | TUI command |\n| **Delegation** | | |\n| Delegate to PR | `/delegate` | TUI workflow |\n| **Terminal Setup** | | |\n| Shell integration | `/terminal-setup` | Shell-specific |\n| **Development** | | |\n| Toggle experimental | `/experimental`, `--experimental` | Runtime flag |\n| Custom instructions control | `--no-custom-instructions` | CLI flag |\n| Diagnose session | `/diagnose` | TUI command |\n| View/manage instructions | `/instructions` | TUI command |\n| Collect debug logs | `/collect-debug-logs` | Diagnostic tool |\n| Reindex workspace | `/reindex` | TUI command |\n| IDE integration | `/ide` | IDE-specific workflow |\n| **Non-interactive Mode** | | |\n| Prompt mode | `-p`, `--prompt` | Single-shot execution |\n| Interactive prompt | `-i`, `--interactive` | Auto-execute then interactive |\n| Silent output | `-s`, `--silent` | Script-friendly |\n| Continue session | `--continue` | Resume most recent |\n| Agent selection | `--agent ` | CLI flag |\n\n## Workarounds\n\n### Session Export\n\nThe `--share` option is not available via SDK. Workarounds:\n\n1. **Collect events manually** - Subscribe to session events and build your own export:\n ```typescript\n const events: SessionEvent[] = [];\n session.on((event) => events.push(event));\n // ... after conversation ...\n const messages = await session.getMessages();\n // Format as markdown yourself\n ```\n\n2. **Use CLI directly for export** - Run the CLI with `--share` for one-off exports.\n\n### Permission Control\n\nThe SDK uses a **deny-by-default** permission model. All permission requests (file writes, shell commands, URL fetches, etc.) are denied unless your app provides an `onPermissionRequest` handler.\n\nInstead of `--allow-all-paths` or `--yolo`, use the permission handler:\n\n```typescript\nconst session = await client.createSession({\n onPermissionRequest: approveAll,\n});\n```\n\n### Token Usage Tracking\n\nInstead of `/usage`, subscribe to usage events:\n\n```typescript\nsession.on(\"assistant.usage\", (event) => {\n console.log(\"Tokens used:\", {\n input: event.data.inputTokens,\n output: event.data.outputTokens,\n });\n});\n```\n\n### Context Compaction\n\nInstead of `/compact`, configure automatic compaction or trigger it manually:\n\n```typescript\n// Automatic compaction via config\nconst session = await client.createSession({\n infiniteSessions: {\n enabled: true,\n backgroundCompactionThreshold: 0.80, // Start background compaction at 80% context utilization\n bufferExhaustionThreshold: 0.95, // Block and compact at 95% context utilization\n },\n});\n\n// Manual compaction (experimental)\nconst result = await session.rpc.history.compact();\nconsole.log(`Removed ${result.tokensRemoved} tokens, ${result.messagesRemoved} messages`);\n```\n\n> **Note:** Thresholds are context utilization ratios (0.0-1.0), not absolute token counts.\n\n### Plan Management\n\nRead and write session plans programmatically:\n\n```typescript\n// Read the current plan\nconst plan = await session.rpc.plan.read();\nif (plan.exists) {\n console.log(plan.content);\n}\n\n// Update the plan\nawait session.rpc.plan.update({ content: \"# My Plan\\n- Step 1\\n- Step 2\" });\n\n// Delete the plan\nawait session.rpc.plan.delete();\n```\n\n### Message Steering\n\nInject a message into the current LLM turn without aborting:\n\n```typescript\n// Steer the agent mid-turn\nawait session.send({ prompt: \"Focus on error handling first\", mode: \"immediate\" });\n\n// Default: enqueue for next turn\nawait session.send({ prompt: \"Next, add tests\" });\n```\n\n## Protocol Limitations\n\nThe SDK can only access features exposed through the CLI's JSON-RPC protocol. If you need a CLI feature that's not available:\n\n1. **Check for alternatives** - Many features have SDK equivalents (see workarounds above)\n2. **Use the CLI directly** - For one-off operations, invoke the CLI\n3. **Request the feature** - Open an issue to request protocol support\n\n## Version Compatibility\n\n| SDK Protocol Range | CLI Protocol Version | Compatibility |\n|--------------------|---------------------|---------------|\n| v2–v3 | v3 | Full support |\n| v2–v3 | v2 | Supported with automatic v2 adapters |\n\nThe SDK negotiates protocol versions with the CLI at startup. The SDK supports protocol versions 2 through 3. When connecting to a v2 CLI server, the SDK automatically adapts `tool.call` and `permission.request` messages to the v3 event model — no code changes required.\n\nCheck versions at runtime:\n\n```typescript\nconst status = await client.getStatus();\nconsole.log(\"Protocol version:\", status.protocolVersion);\n```\n\n## See Also\n\n- [Getting Started Guide](../getting-started.md)\n- [Hooks Documentation](../hooks/index.md)\n- [MCP Servers Guide](../features/mcp.md)\n- [Debugging Guide](./debugging.md)\n" }, { "path": "docs/troubleshooting/debugging.md", "content": "# Debugging Guide\n\nThis guide covers common issues and debugging techniques for the Copilot SDK across all supported languages.\n\n## Table of Contents\n\n- [Enable Debug Logging](#enable-debug-logging)\n- [Common Issues](#common-issues)\n- [MCP Server Debugging](#mcp-server-debugging)\n- [Connection Issues](#connection-issues)\n- [Tool Execution Issues](#tool-execution-issues)\n- [Platform-Specific Issues](#platform-specific-issues)\n\n---\n\n## Enable Debug Logging\n\nThe first step in debugging is enabling verbose logging to see what's happening under the hood.\n\n
\nNode.js / TypeScript\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst client = new CopilotClient({\n logLevel: \"debug\", // Options: \"none\", \"error\", \"warning\", \"info\", \"debug\", \"all\"\n});\n```\n\n
\n\n
\nPython\n\n```python\nfrom copilot import CopilotClient\n\nclient = CopilotClient({\"log_level\": \"debug\"})\n```\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nimport copilot \"github.com/github/copilot-sdk/go\"\n\nfunc main() {\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tLogLevel: \"debug\",\n\t})\n\t_ = client\n}\n```\n\n\n```go\nimport copilot \"github.com/github/copilot-sdk/go\"\n\nclient := copilot.NewClient(&copilot.ClientOptions{\n LogLevel: \"debug\",\n})\n```\n\n
\n\n
\n.NET\n\n\n\n```csharp\nusing GitHub.Copilot.SDK;\nusing Microsoft.Extensions.Logging;\n\n// Using ILogger\nvar loggerFactory = LoggerFactory.Create(builder =>\n{\n builder.SetMinimumLevel(LogLevel.Debug);\n builder.AddConsole();\n});\n\nvar client = new CopilotClient(new CopilotClientOptions\n{\n LogLevel = \"debug\",\n Logger = loggerFactory.CreateLogger()\n});\n```\n\n
\n\n
\nJava\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.json.*;\n\nvar client = new CopilotClient(new CopilotClientOptions()\n .setLogLevel(\"debug\")\n);\n```\n\n
\n\n### Log Directory\n\nThe CLI writes logs to a directory. You can specify a custom location:\n\n
\nNode.js / TypeScript\n\n```typescript\nconst client = new CopilotClient({\n cliArgs: [\"--log-dir\", \"/path/to/logs\"],\n});\n```\n\n
\n\n
\nPython\n\n```python\n# The Python SDK does not currently support passing extra CLI arguments.\n# Logs are written to the default location or can be configured via\n# the CLI when running in server mode.\n```\n\n> **Note:** Python SDK logging configuration is limited. For advanced logging, run the CLI manually with `--log-dir` and connect via `cli_url`.\n\n
\n\n
\nGo\n\n\n```go\npackage main\n\nfunc main() {\n\t// The Go SDK does not currently support passing extra CLI arguments.\n\t// For custom log directories, run the CLI manually with --log-dir\n\t// and connect via CLIUrl option.\n}\n```\n\n\n```go\n// The Go SDK does not currently support passing extra CLI arguments.\n// For custom log directories, run the CLI manually with --log-dir\n// and connect via CLIUrl option.\n```\n\n
\n\n
\n.NET\n\n```csharp\nvar client = new CopilotClient(new CopilotClientOptions\n{\n CliArgs = new[] { \"--log-dir\", \"/path/to/logs\" }\n});\n```\n\n
\n\n
\nJava\n\n```java\n// The Java SDK does not currently support passing extra CLI arguments.\n// For custom log directories, run the CLI manually with --log-dir\n// and connect via cliUrl.\n```\n\n
\n\n---\n\n## Common Issues\n\n### \"CLI not found\" / \"copilot: command not found\"\n\n**Cause:** The Copilot CLI is not installed or not in PATH.\n\n**Solution:**\n\n1. Install the CLI: [Installation guide](https://docs.github.com/en/copilot/how-tos/set-up/install-copilot-cli)\n\n2. Verify installation:\n ```bash\n copilot --version\n ```\n\n3. Or specify the full path:\n\n
\n Node.js\n\n ```typescript\n const client = new CopilotClient({\n cliPath: \"/usr/local/bin/copilot\",\n });\n ```\n
\n\n
\n Python\n\n ```python\n client = CopilotClient({\"cli_path\": \"/usr/local/bin/copilot\"})\n ```\n
\n\n
\n Go\n\n ```go\n client := copilot.NewClient(&copilot.ClientOptions{\n CLIPath: \"/usr/local/bin/copilot\",\n })\n ```\n
\n\n
\n .NET\n\n ```csharp\n var client = new CopilotClient(new CopilotClientOptions\n {\n CliPath = \"/usr/local/bin/copilot\"\n });\n ```\n
\n\n
\n Java\n\n ```java\n var client = new CopilotClient(new CopilotClientOptions()\n .setCliPath(\"/usr/local/bin/copilot\")\n );\n ```\n
\n\n### \"Not authenticated\"\n\n**Cause:** The CLI is not authenticated with GitHub.\n\n**Solution:**\n\n1. Authenticate the CLI:\n ```bash\n copilot auth login\n ```\n\n2. Or provide a token programmatically:\n\n
\n Node.js\n\n ```typescript\n const client = new CopilotClient({\n gitHubToken: process.env.GITHUB_TOKEN,\n });\n ```\n
\n\n
\n Python\n\n ```python\n import os\n client = CopilotClient({\"github_token\": os.environ.get(\"GITHUB_TOKEN\")})\n ```\n
\n\n
\n Go\n\n ```go\n client := copilot.NewClient(&copilot.ClientOptions{\n GithubToken: os.Getenv(\"GITHUB_TOKEN\"),\n })\n ```\n
\n\n
\n .NET\n\n ```csharp\n var client = new CopilotClient(new CopilotClientOptions\n {\n GithubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\")\n });\n ```\n
\n\n
\n Java\n\n ```java\n var client = new CopilotClient(new CopilotClientOptions()\n .setGitHubToken(System.getenv(\"GITHUB_TOKEN\"))\n );\n ```\n
\n\n### \"Session not found\"\n\n**Cause:** Attempting to use a session that was destroyed or doesn't exist.\n\n**Solution:**\n\n1. Ensure you're not calling methods after `disconnect()`:\n ```typescript\n await session.disconnect();\n // Don't use session after this!\n ```\n\n2. For resuming sessions, verify the session ID exists:\n ```typescript\n const sessions = await client.listSessions();\n console.log(\"Available sessions:\", sessions);\n ```\n\n### \"Connection refused\" / \"ECONNREFUSED\"\n\n**Cause:** The CLI server process crashed or failed to start.\n\n**Solution:**\n\n1. Check if the CLI runs correctly standalone:\n ```bash\n copilot --server --stdio\n ```\n\n2. Check for port conflicts if using TCP mode:\n ```typescript\n const client = new CopilotClient({\n useStdio: false,\n port: 0, // Use random available port\n });\n ```\n\n---\n\n## MCP Server Debugging\n\nMCP (Model Context Protocol) servers can be tricky to debug. For comprehensive MCP debugging guidance, see the dedicated **[MCP Debugging Guide](./mcp-debugging.md)**.\n\n### Quick MCP Checklist\n\n- [ ] MCP server executable exists and runs independently\n- [ ] Command path is correct (use absolute paths)\n- [ ] Tools are enabled: `tools: [\"*\"]`\n- [ ] Server responds to `initialize` request correctly\n- [ ] Working directory (`cwd`) is set if needed\n\n### Test Your MCP Server\n\nBefore integrating with the SDK, verify your MCP server works:\n\n```bash\necho '{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"initialize\",\"params\":{\"protocolVersion\":\"2024-11-05\",\"capabilities\":{},\"clientInfo\":{\"name\":\"test\",\"version\":\"1.0\"}}}' | /path/to/your/mcp-server\n```\n\nSee [MCP Debugging Guide](./mcp-debugging.md) for detailed troubleshooting.\n\n---\n\n## Connection Issues\n\n### Stdio vs TCP Mode\n\nThe SDK supports two transport modes:\n\n| Mode | Description | Use Case |\n|------|-------------|----------|\n| **Stdio** (default) | CLI runs as subprocess, communicates via pipes | Local development, single process |\n| **TCP** | CLI runs separately, communicates via TCP socket | Multiple clients, remote CLI |\n\n**Stdio mode (default):**\n```typescript\nconst client = new CopilotClient({\n useStdio: true, // This is the default\n});\n```\n\n**TCP mode:**\n```typescript\nconst client = new CopilotClient({\n useStdio: false,\n port: 8080, // Or 0 for random port\n});\n```\n\n**Connect to existing server:**\n```typescript\nconst client = new CopilotClient({\n cliUrl: \"localhost:8080\", // Connect to running server\n});\n```\n\n### Diagnosing Connection Failures\n\n1. **Check client state:**\n ```typescript\n console.log(\"Connection state:\", client.getState());\n // Should be \"connected\" after start()\n ```\n\n2. **Listen for state changes:**\n ```typescript\n client.on(\"stateChange\", (state) => {\n console.log(\"State changed to:\", state);\n });\n ```\n\n3. **Verify CLI process is running:**\n ```bash\n # Check for copilot processes\n ps aux | grep copilot\n ```\n\n---\n\n## Tool Execution Issues\n\n### Custom Tool Not Being Called\n\n1. **Verify tool registration:**\n ```typescript\n const session = await client.createSession({\n tools: [myTool],\n });\n \n // Check registered tools\n console.log(\"Registered tools:\", session.getTools?.());\n ```\n\n2. **Check tool schema is valid JSON Schema:**\n ```typescript\n const myTool = {\n name: \"get_weather\",\n description: \"Get weather for a location\",\n parameters: {\n type: \"object\",\n properties: {\n location: { type: \"string\", description: \"City name\" },\n },\n required: [\"location\"],\n },\n handler: async (args) => {\n return { temperature: 72 };\n },\n };\n ```\n\n3. **Ensure handler returns valid result:**\n ```typescript\n handler: async (args) => {\n // Must return something JSON-serializable\n return { success: true, data: \"result\" };\n \n // Don't return undefined or non-serializable objects\n }\n ```\n\n### Tool Errors Not Surfacing\n\nSubscribe to error events:\n\n```typescript\nsession.on(\"tool.execution_error\", (event) => {\n console.error(\"Tool error:\", event.data);\n});\n\nsession.on(\"error\", (event) => {\n console.error(\"Session error:\", event.data);\n});\n```\n\n---\n\n## Platform-Specific Issues\n\n### Windows\n\n1. **Path separators:** Use raw strings or forward slashes:\n ```csharp\n CliPath = @\"C:\\Program Files\\GitHub\\copilot.exe\"\n // or\n CliPath = \"C:/Program Files/GitHub/copilot.exe\"\n ```\n\n2. **PATHEXT resolution:** The SDK handles this automatically, but if issues persist:\n ```csharp\n // Explicitly specify .exe\n Command = \"myserver.exe\" // Not just \"myserver\"\n ```\n\n3. **Console encoding:** Ensure UTF-8 for proper JSON handling:\n ```csharp\n Console.OutputEncoding = System.Text.Encoding.UTF8;\n ```\n\n### macOS\n\n1. **Gatekeeper issues:** If CLI is blocked:\n ```bash\n xattr -d com.apple.quarantine /path/to/copilot\n ```\n\n2. **PATH issues in GUI apps:** GUI applications may not inherit shell PATH:\n ```typescript\n const client = new CopilotClient({\n cliPath: \"/opt/homebrew/bin/copilot\", // Full path\n });\n ```\n\n### Linux\n\n1. **Permission issues:**\n ```bash\n chmod +x /path/to/copilot\n ```\n\n2. **Missing libraries:** Check for required shared libraries:\n ```bash\n ldd /path/to/copilot\n ```\n\n---\n\n## Getting Help\n\nIf you're still stuck:\n\n1. **Collect debug information:**\n - SDK version\n - CLI version (`copilot --version`)\n - Operating system\n - Debug logs\n - Minimal reproduction code\n\n2. **Search existing issues:** [GitHub Issues](https://github.com/github/copilot-sdk/issues)\n\n3. **Open a new issue** with the collected information\n\n## See Also\n\n- [Getting Started Guide](../getting-started.md)\n- [MCP Overview](../features/mcp.md) - MCP configuration and setup\n- [MCP Debugging Guide](./mcp-debugging.md) - Detailed MCP troubleshooting\n- [API Reference](https://github.com/github/copilot-sdk)\n" }, { "path": "docs/troubleshooting/mcp-debugging.md", "content": "# MCP Server Debugging Guide\n\nThis guide covers debugging techniques specific to MCP (Model Context Protocol) servers when using the Copilot SDK.\n\n## Table of Contents\n\n- [Quick Diagnostics](#quick-diagnostics)\n- [Testing MCP Servers Independently](#testing-mcp-servers-independently)\n- [Common Issues](#common-issues)\n- [Platform-Specific Issues](#platform-specific-issues)\n- [Advanced Debugging](#advanced-debugging)\n\n---\n\n## Quick Diagnostics\n\n### Checklist\n\nBefore diving deep, verify these basics:\n\n- [ ] MCP server executable exists and is runnable\n- [ ] Command path is correct (use absolute paths when in doubt)\n- [ ] Tools are enabled (`tools: [\"*\"]` or specific tool names)\n- [ ] Server implements MCP protocol correctly (responds to `initialize`)\n- [ ] No firewall/antivirus blocking the process (Windows)\n\n### Enable MCP Debug Logging\n\nAdd environment variables to your MCP server config:\n\n```typescript\nmcpServers: {\n \"my-server\": {\n type: \"local\",\n command: \"/path/to/server\",\n args: [],\n env: {\n MCP_DEBUG: \"1\",\n DEBUG: \"*\",\n NODE_DEBUG: \"mcp\", // For Node.js MCP servers\n },\n },\n}\n```\n\n---\n\n## Testing MCP Servers Independently\n\nAlways test your MCP server outside the SDK first.\n\n### Manual Protocol Test\n\nSend an `initialize` request via stdin:\n\n```bash\n# Unix/macOS\necho '{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"initialize\",\"params\":{\"protocolVersion\":\"2024-11-05\",\"capabilities\":{},\"clientInfo\":{\"name\":\"test\",\"version\":\"1.0\"}}}' | /path/to/your/mcp-server\n\n# Windows (PowerShell)\n'{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"initialize\",\"params\":{\"protocolVersion\":\"2024-11-05\",\"capabilities\":{},\"clientInfo\":{\"name\":\"test\",\"version\":\"1.0\"}}}' | C:\\path\\to\\your\\mcp-server.exe\n```\n\n**Expected response:**\n```json\n{\"jsonrpc\":\"2.0\",\"id\":1,\"result\":{\"protocolVersion\":\"2024-11-05\",\"capabilities\":{\"tools\":{}},\"serverInfo\":{\"name\":\"your-server\",\"version\":\"1.0\"}}}\n```\n\n### Test Tool Listing\n\nAfter initialization, request the tools list:\n\n```bash\necho '{\"jsonrpc\":\"2.0\",\"id\":2,\"method\":\"tools/list\",\"params\":{}}' | /path/to/your/mcp-server\n```\n\n**Expected response:**\n```json\n{\"jsonrpc\":\"2.0\",\"id\":2,\"result\":{\"tools\":[{\"name\":\"my_tool\",\"description\":\"Does something\",\"inputSchema\":{...}}]}}\n```\n\n### Interactive Testing Script\n\nCreate a test script to interactively debug your MCP server:\n\n```bash\n#!/bin/bash\n# test-mcp.sh\n\nSERVER=\"$1\"\n\n# Initialize\necho '{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"initialize\",\"params\":{\"protocolVersion\":\"2024-11-05\",\"capabilities\":{},\"clientInfo\":{\"name\":\"test\",\"version\":\"1.0\"}}}'\n\n# Send initialized notification\necho '{\"jsonrpc\":\"2.0\",\"method\":\"notifications/initialized\"}'\n\n# List tools\necho '{\"jsonrpc\":\"2.0\",\"id\":2,\"method\":\"tools/list\",\"params\":{}}'\n\n# Keep stdin open\ncat\n```\n\nUsage:\n```bash\n./test-mcp.sh | /path/to/mcp-server\n```\n\n---\n\n## Common Issues\n\n### Server Not Starting\n\n**Symptoms:** No tools appear, no errors in logs.\n\n**Causes & Solutions:**\n\n| Cause | Solution |\n|-------|----------|\n| Wrong command path | Use absolute path: `/usr/local/bin/server` |\n| Missing executable permission | Run `chmod +x /path/to/server` |\n| Missing dependencies | Check with `ldd` (Linux) or run manually |\n| Working directory issues | Set `cwd` in config |\n\n**Debug by running manually:**\n```bash\n# Run exactly what the SDK would run\ncd /expected/working/dir\n/path/to/command arg1 arg2\n```\n\n### Server Starts But Tools Don't Appear\n\n**Symptoms:** Server process runs but no tools are available.\n\n**Causes & Solutions:**\n\n1. **Tools not enabled in config:**\n ```typescript\n mcpServers: {\n \"server\": {\n // ...\n tools: [\"*\"], // Must be \"*\" or list of tool names\n },\n }\n ```\n\n2. **Server doesn't expose tools:**\n - Test with `tools/list` request manually\n - Check server implements `tools/list` method\n\n3. **Initialization handshake fails:**\n - Server must respond to `initialize` correctly\n - Server must handle `notifications/initialized`\n\n### Tools Listed But Never Called\n\n**Symptoms:** Tools appear in debug logs but model doesn't use them.\n\n**Causes & Solutions:**\n\n1. **Prompt doesn't clearly need the tool:**\n ```typescript\n // Too vague\n await session.sendAndWait({ prompt: \"What's the weather?\" });\n \n // Better - explicitly mentions capability\n await session.sendAndWait({ \n prompt: \"Use the weather tool to get the current temperature in Seattle\" \n });\n ```\n\n2. **Tool description unclear:**\n ```typescript\n // Bad - model doesn't know when to use it\n { name: \"do_thing\", description: \"Does a thing\" }\n \n // Good - clear purpose\n { name: \"get_weather\", description: \"Get current weather conditions for a city. Returns temperature, humidity, and conditions.\" }\n ```\n\n3. **Tool schema issues:**\n - Ensure `inputSchema` is valid JSON Schema\n - Required fields must be in `required` array\n\n### Timeout Errors\n\n**Symptoms:** `MCP tool call timed out` errors.\n\n**Solutions:**\n\n1. **Increase timeout:**\n ```typescript\n mcpServers: {\n \"slow-server\": {\n // ...\n timeout: 300000, // 5 minutes\n },\n }\n ```\n\n2. **Optimize server performance:**\n - Add progress logging to identify bottleneck\n - Consider async operations\n - Check for blocking I/O\n\n3. **For long-running tools**, consider streaming responses if supported.\n\n### JSON-RPC Errors\n\n**Symptoms:** Parse errors, invalid request errors.\n\n**Common causes:**\n\n1. **Server writes to stdout incorrectly:**\n - Debug output going to stdout instead of stderr\n - Extra newlines or whitespace\n \n ```typescript\n // Wrong - pollutes stdout\n console.log(\"Debug info\");\n \n // Correct - use stderr for debug\n console.error(\"Debug info\");\n ```\n\n2. **Encoding issues:**\n - Ensure UTF-8 encoding\n - No BOM (Byte Order Mark)\n\n3. **Message framing:**\n - Each message must be a complete JSON object\n - Newline-delimited (one message per line)\n\n---\n\n## Platform-Specific Issues\n\n### Windows\n\n#### .NET Console Apps / Tools\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic static class McpDotnetConfigExample\n{\n public static void Main()\n {\n var servers = new Dictionary\n {\n [\"my-dotnet-server\"] = new McpStdioServerConfig\n {\n Command = @\"C:\\Tools\\MyServer\\MyServer.exe\",\n Args = new List(),\n Cwd = @\"C:\\Tools\\MyServer\",\n Tools = new List { \"*\" },\n },\n [\"my-dotnet-tool\"] = new McpStdioServerConfig\n {\n Command = \"dotnet\",\n Args = new List { @\"C:\\Tools\\MyTool\\MyTool.dll\" },\n Cwd = @\"C:\\Tools\\MyTool\",\n Tools = new List { \"*\" },\n }\n };\n }\n}\n```\n\n```csharp\n// Correct configuration for .NET exe\n[\"my-dotnet-server\"] = new McpStdioServerConfig\n{\n Command = @\"C:\\Tools\\MyServer\\MyServer.exe\", // Full path with .exe\n Args = new List(),\n Cwd = @\"C:\\Tools\\MyServer\", // Set working directory\n Tools = new List { \"*\" },\n}\n\n// For dotnet tool (DLL)\n[\"my-dotnet-tool\"] = new McpStdioServerConfig\n{\n Command = \"dotnet\",\n Args = new List { @\"C:\\Tools\\MyTool\\MyTool.dll\" },\n Cwd = @\"C:\\Tools\\MyTool\",\n Tools = new List { \"*\" },\n}\n```\n\n#### NPX Commands\n\n\n```csharp\nusing GitHub.Copilot.SDK;\n\npublic static class McpNpxConfigExample\n{\n public static void Main()\n {\n var servers = new Dictionary\n {\n [\"filesystem\"] = new McpStdioServerConfig\n {\n Command = \"cmd\",\n Args = new List { \"/c\", \"npx\", \"-y\", \"@modelcontextprotocol/server-filesystem\", \"C:\\\\allowed\\\\path\" },\n Tools = new List { \"*\" },\n }\n };\n }\n}\n```\n\n```csharp\n// Windows needs cmd /c for npx\n[\"filesystem\"] = new McpStdioServerConfig\n{\n Command = \"cmd\",\n Args = new List { \"/c\", \"npx\", \"-y\", \"@modelcontextprotocol/server-filesystem\", \"C:\\\\allowed\\\\path\" },\n Tools = new List { \"*\" },\n}\n```\n\n#### Path Issues\n\n- Use raw strings (`@\"C:\\path\"`) or forward slashes (`\"C:/path\"`)\n- Avoid spaces in paths when possible\n- If spaces required, ensure proper quoting\n\n#### Antivirus/Firewall\n\nWindows Defender or other AV may block:\n- New executables\n- Processes communicating via stdin/stdout\n\n**Solution:** Add exclusions for your MCP server executable.\n\n### macOS\n\n#### Gatekeeper Blocking\n\n```bash\n# If server is blocked\nxattr -d com.apple.quarantine /path/to/mcp-server\n```\n\n#### Homebrew Paths\n\n\n```typescript\nimport { MCPStdioServerConfig } from \"@github/copilot-sdk\";\n\nconst mcpServers: Record = {\n \"my-server\": {\n command: \"/opt/homebrew/bin/node\",\n args: [\"/path/to/server.js\"],\n tools: [\"*\"],\n },\n};\n```\n\n```typescript\n// GUI apps may not have /opt/homebrew in PATH\nmcpServers: {\n \"my-server\": {\n command: \"/opt/homebrew/bin/node\", // Full path\n args: [\"/path/to/server.js\"],\n },\n}\n```\n\n### Linux\n\n#### Permission Issues\n\n```bash\nchmod +x /path/to/mcp-server\n```\n\n#### Missing Shared Libraries\n\n```bash\n# Check dependencies\nldd /path/to/mcp-server\n\n# Install missing libraries\napt install libfoo # Debian/Ubuntu\nyum install libfoo # RHEL/CentOS\n```\n\n---\n\n## Advanced Debugging\n\n### Capture All MCP Traffic\n\nCreate a wrapper script to log all communication:\n\n```bash\n#!/bin/bash\n# mcp-debug-wrapper.sh\n\nLOG=\"/tmp/mcp-debug-$(date +%s).log\"\nACTUAL_SERVER=\"$1\"\nshift\n\necho \"=== MCP Debug Session ===\" >> \"$LOG\"\necho \"Server: $ACTUAL_SERVER\" >> \"$LOG\"\necho \"Args: $@\" >> \"$LOG\"\necho \"=========================\" >> \"$LOG\"\n\n# Tee stdin/stdout to log file\ntee -a \"$LOG\" | \"$ACTUAL_SERVER\" \"$@\" 2>> \"$LOG\" | tee -a \"$LOG\"\n```\n\nUse it:\n```typescript\nmcpServers: {\n \"debug-server\": {\n command: \"/path/to/mcp-debug-wrapper.sh\",\n args: [\"/actual/server/path\", \"arg1\", \"arg2\"],\n },\n}\n```\n\n### Inspect with MCP Inspector\n\nUse the official MCP Inspector tool:\n\n```bash\nnpx @modelcontextprotocol/inspector /path/to/your/mcp-server\n```\n\nThis provides a web UI to:\n- Send test requests\n- View responses\n- Inspect tool schemas\n\n### Protocol Version Mismatches\n\nCheck your server supports the protocol version the SDK uses:\n\n```json\n// In initialize response, check protocolVersion\n{\"result\":{\"protocolVersion\":\"2024-11-05\",...}}\n```\n\nIf versions don't match, update your MCP server library.\n\n---\n\n## Debugging Checklist\n\nWhen opening an issue or asking for help, collect:\n\n- [ ] SDK language and version\n- [ ] CLI version (`copilot --version`)\n- [ ] MCP server type (Node.js, Python, .NET, Go, etc.)\n- [ ] Full MCP server configuration (redact secrets)\n- [ ] Result of manual `initialize` test\n- [ ] Result of manual `tools/list` test \n- [ ] Debug logs from SDK\n- [ ] Any error messages\n\n## See Also\n\n- [MCP Overview](../features/mcp.md) - Configuration and setup\n- [General Debugging Guide](./debugging.md) - SDK-wide debugging\n- [MCP Specification](https://modelcontextprotocol.io/) - Official protocol docs\n" }, { "path": "dotnet/.config/dotnet-tools.json", "content": "{\n \"version\": 1,\n \"isRoot\": true,\n \"tools\": {\n \"roslyn-language-server\": {\n \"version\": \"5.5.0-2.26078.4\",\n \"commands\": [\n \"roslyn-language-server\"\n ],\n \"rollForward\": true\n }\n }\n}\n\n" }, { "path": "dotnet/.gitignore", "content": "# Build results\nbin/\nobj/\n\n# Generated build props (contains CLI version)\nsrc/build/GitHub.Copilot.SDK.props\n\n# NuGet packages\n*.nupkg\n*.snupkg\n\n# User-specific files\n*.user\n*.suo\n*.userosscache\n*.sln.docstates\n\n# IDE\n.vscode/\n*.swp\n*~\n\n# Rider\n.idea/\n\n# Test results\nTestResults/\n" }, { "path": "dotnet/Directory.Build.props", "content": "\n\n \n net8.0\n 14\n enable\n enable\n 10.0-minimum\n true\n \n\n\n" }, { "path": "dotnet/Directory.Packages.props", "content": "\n\n \n true\n \n\n \n \n \n \n \n \n \n \n \n \n\n\n" }, { "path": "dotnet/GitHub.Copilot.SDK.slnx", "content": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n" }, { "path": "dotnet/README.md", "content": "# Copilot SDK\n\nSDK for programmatic control of GitHub Copilot CLI.\n\n> **Note:** This SDK is in public preview and may change in breaking ways.\n\n## Installation\n\n```bash\ndotnet add package GitHub.Copilot.SDK\n```\n\n## Run the Sample\n\nTry the interactive chat sample (from the repo root):\n\n```bash\ncd dotnet/samples\ndotnet run\n```\n\n## Quick Start\n\n```csharp\nusing GitHub.Copilot.SDK;\n\n// Create and start client\nawait using var client = new CopilotClient();\nawait client.StartAsync();\n\n// Create a session (OnPermissionRequest is required)\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5\",\n OnPermissionRequest = PermissionHandler.ApproveAll,\n});\n\n// Wait for response using session.idle event\nvar done = new TaskCompletionSource();\n\nsession.On(evt =>\n{\n if (evt is AssistantMessageEvent msg)\n {\n Console.WriteLine(msg.Data.Content);\n }\n else if (evt is SessionIdleEvent)\n {\n done.SetResult();\n }\n});\n\n// Send a message and wait for completion\nawait session.SendAsync(new MessageOptions { Prompt = \"What is 2+2?\" });\nawait done.Task;\n```\n\n## API Reference\n\n### CopilotClient\n\n#### Constructor\n\n```csharp\nnew CopilotClient(CopilotClientOptions? options = null)\n```\n\n**Options:**\n\n- `CliPath` - Path to CLI executable (default: `COPILOT_CLI_PATH` env var, or bundled CLI)\n- `CliArgs` - Extra arguments prepended before SDK-managed flags\n- `CliUrl` - URL of existing CLI server to connect to (e.g., `\"localhost:8080\"`). When provided, the client will not spawn a CLI process.\n- `Port` - Server port (default: 0 for random)\n- `UseStdio` - Use stdio transport instead of TCP (default: true)\n- `LogLevel` - Log level (default: \"info\")\n- `AutoStart` - Auto-start server (default: true)\n- `Cwd` - Working directory for the CLI process\n- `Environment` - Environment variables to pass to the CLI process\n- `Logger` - `ILogger` instance for SDK logging\n- `GitHubToken` - GitHub token for authentication. When provided, takes priority over other auth methods.\n- `UseLoggedInUser` - Whether to use logged-in user for authentication (default: true, but false when `GitHubToken` is provided). Cannot be used with `CliUrl`.\n- `Telemetry` - OpenTelemetry configuration for the CLI process. Providing this enables telemetry — no separate flag needed. See [Telemetry](#telemetry) below.\n\n#### Methods\n\n##### `StartAsync(): Task`\n\nStart the CLI server and establish connection.\n\n##### `StopAsync(): Task`\n\nStop the server and close all sessions. Throws if errors are encountered during cleanup.\n\n##### `ForceStopAsync(): Task`\n\nForce stop the CLI server without graceful cleanup. Use when `StopAsync()` takes too long.\n\n##### `CreateSessionAsync(SessionConfig? config = null): Task`\n\nCreate a new conversation session.\n\n**Config:**\n\n- `SessionId` - Custom session ID\n- `Model` - Model to use (\"gpt-5\", \"claude-sonnet-4.5\", etc.)\n- `ReasoningEffort` - Reasoning effort level for models that support it (\"low\", \"medium\", \"high\", \"xhigh\"). Use `ListModelsAsync()` to check which models support this option.\n- `Tools` - Custom tools exposed to the CLI\n- `SystemMessage` - System message customization\n- `AvailableTools` - List of tool names to allow\n- `ExcludedTools` - List of tool names to disable\n- `Provider` - Custom API provider configuration (BYOK)\n- `Streaming` - Enable streaming of response chunks (default: false)\n- `InfiniteSessions` - Configure automatic context compaction (see below)\n- `OnPermissionRequest` - **Required.** Handler called before each tool execution to approve or deny it. Use `PermissionHandler.ApproveAll` to allow everything, or provide a custom function for fine-grained control. See [Permission Handling](#permission-handling) section.\n- `OnUserInputRequest` - Handler for user input requests from the agent (enables ask_user tool). See [User Input Requests](#user-input-requests) section.\n- `Hooks` - Hook handlers for session lifecycle events. See [Session Hooks](#session-hooks) section.\n\n##### `ResumeSessionAsync(string sessionId, ResumeSessionConfig? config = null): Task`\n\nResume an existing session. Returns the session with `WorkspacePath` populated if infinite sessions were enabled.\n\n**ResumeSessionConfig:**\n\n- `OnPermissionRequest` - **Required.** Handler called before each tool execution to approve or deny it. See [Permission Handling](#permission-handling) section.\n\n##### `PingAsync(string? message = null): Task`\n\nPing the server to check connectivity.\n\n##### `State: ConnectionState`\n\nGet current connection state.\n\n##### `ListSessionsAsync(): Task>`\n\nList all available sessions.\n\n##### `DeleteSessionAsync(string sessionId): Task`\n\nDelete a session and its data from disk.\n\n##### `GetForegroundSessionIdAsync(): Task`\n\nGet the ID of the session currently displayed in the TUI. Only available when connecting to a server running in TUI+server mode (`--ui-server`).\n\n##### `SetForegroundSessionIdAsync(string sessionId): Task`\n\nRequest the TUI to switch to displaying the specified session. Only available in TUI+server mode.\n\n##### `On(Action handler): IDisposable`\n\nSubscribe to all session lifecycle events. Returns an `IDisposable` that unsubscribes when disposed.\n\n```csharp\nusing var subscription = client.On(evt =>\n{\n Console.WriteLine($\"Session {evt.SessionId}: {evt.Type}\");\n});\n```\n\n##### `On(string eventType, Action handler): IDisposable`\n\nSubscribe to a specific lifecycle event type. Use `SessionLifecycleEventTypes` constants.\n\n```csharp\nusing var subscription = client.On(SessionLifecycleEventTypes.Foreground, evt =>\n{\n Console.WriteLine($\"Session {evt.SessionId} is now in foreground\");\n});\n```\n\n**Lifecycle Event Types:**\n\n- `SessionLifecycleEventTypes.Created` - A new session was created\n- `SessionLifecycleEventTypes.Deleted` - A session was deleted\n- `SessionLifecycleEventTypes.Updated` - A session was updated\n- `SessionLifecycleEventTypes.Foreground` - A session became the foreground session in TUI\n- `SessionLifecycleEventTypes.Background` - A session is no longer the foreground session\n\n---\n\n### CopilotSession\n\nRepresents a single conversation session.\n\n#### Properties\n\n- `SessionId` - The unique identifier for this session\n- `WorkspacePath` - Path to the session workspace directory when infinite sessions are enabled. Contains `checkpoints/`, `plan.md`, and `files/` subdirectories. Null if infinite sessions are disabled.\n\n#### Methods\n\n##### `SendAsync(MessageOptions options): Task`\n\nSend a message to the session.\n\n**Options:**\n\n- `Prompt` - The message/prompt to send\n- `Attachments` - File attachments\n- `Mode` - Delivery mode (\"enqueue\" or \"immediate\")\n\nReturns the message ID.\n\n##### `On(SessionEventHandler handler): IDisposable`\n\nSubscribe to session events. Returns a disposable to unsubscribe.\n\n```csharp\nvar subscription = session.On(evt =>\n{\n Console.WriteLine($\"Event: {evt.Type}\");\n});\n\n// Later...\nsubscription.Dispose();\n```\n\n##### `AbortAsync(): Task`\n\nAbort the currently processing message in this session.\n\n##### `GetMessagesAsync(): Task>`\n\nGet all events/messages from this session.\n\n##### `DisposeAsync(): ValueTask`\n\nClose the session and release in-memory resources. Session data on disk is preserved — the conversation can be resumed later via `ResumeSessionAsync()`. To permanently delete session data, use `client.DeleteSessionAsync()`.\n\n```csharp\n// Preferred: automatic cleanup via await using\nawait using var session = await client.CreateSessionAsync(config);\n// session is automatically disposed when leaving scope\n\n// Alternative: explicit dispose\nvar session2 = await client.CreateSessionAsync(config);\nawait session2.DisposeAsync();\n```\n\n---\n\n## Event Types\n\nSessions emit various events during processing. Each event type is a class that inherits from `SessionEvent`:\n\n- `UserMessageEvent` - User message added\n- `AssistantMessageEvent` - Assistant response\n- `ToolExecutionStartEvent` - Tool execution started\n- `ToolExecutionCompleteEvent` - Tool execution completed\n- `SessionStartEvent` - Session started\n- `SessionIdleEvent` - Session is idle\n- `SessionErrorEvent` - Session error occurred\n- And more...\n\nUse pattern matching to handle specific event types:\n\n```csharp\nsession.On(evt =>\n{\n switch (evt)\n {\n case AssistantMessageEvent msg:\n Console.WriteLine(msg.Data.Content);\n break;\n case SessionErrorEvent err:\n Console.WriteLine($\"Error: {err.Data.Message}\");\n break;\n }\n});\n```\n\n## Image Support\n\nThe SDK supports image attachments via the `Attachments` parameter. You can attach images by providing their file path, or by passing base64-encoded data directly using a blob attachment:\n\n```csharp\n// File attachment — runtime reads from disk\nawait session.SendAsync(new MessageOptions\n{\n Prompt = \"What's in this image?\",\n Attachments = new List\n {\n new UserMessageDataAttachmentsItemFile\n {\n Path = \"/path/to/image.jpg\",\n DisplayName = \"image.jpg\",\n }\n }\n});\n\n// Blob attachment — provide base64 data directly\nawait session.SendAsync(new MessageOptions\n{\n Prompt = \"What's in this image?\",\n Attachments = new List\n {\n new UserMessageDataAttachmentsItemBlob\n {\n Data = base64ImageData,\n MimeType = \"image/png\",\n }\n }\n});\n```\n\nSupported image formats include JPG, PNG, GIF, and other common image types. The agent's `view` tool can also read images directly from the filesystem, so you can also ask questions like:\n\n```csharp\nawait session.SendAsync(new MessageOptions { Prompt = \"What does the most recent jpg in this directory portray?\" });\n```\n\n## Streaming\n\nEnable streaming to receive assistant response chunks as they're generated:\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5\",\n Streaming = true\n});\n\n// Use TaskCompletionSource to wait for completion\nvar done = new TaskCompletionSource();\n\nsession.On(evt =>\n{\n switch (evt)\n {\n case AssistantMessageDeltaEvent delta:\n // Streaming message chunk - print incrementally\n Console.Write(delta.Data.DeltaContent);\n break;\n case AssistantReasoningDeltaEvent reasoningDelta:\n // Streaming reasoning chunk (if model supports reasoning)\n Console.Write(reasoningDelta.Data.DeltaContent);\n break;\n case AssistantMessageEvent msg:\n // Final message - complete content\n Console.WriteLine(\"\\n--- Final message ---\");\n Console.WriteLine(msg.Data.Content);\n break;\n case AssistantReasoningEvent reasoningEvt:\n // Final reasoning content (if model supports reasoning)\n Console.WriteLine(\"--- Reasoning ---\");\n Console.WriteLine(reasoningEvt.Data.Content);\n break;\n case SessionIdleEvent:\n // Session finished processing\n done.SetResult();\n break;\n }\n});\n\nawait session.SendAsync(new MessageOptions { Prompt = \"Tell me a short story\" });\nawait done.Task; // Wait for streaming to complete\n```\n\nWhen `Streaming = true`:\n\n- `AssistantMessageDeltaEvent` events are sent with `DeltaContent` containing incremental text\n- `AssistantReasoningDeltaEvent` events are sent with `DeltaContent` for reasoning/chain-of-thought (model-dependent)\n- Accumulate `DeltaContent` values to build the full response progressively\n- The final `AssistantMessageEvent` and `AssistantReasoningEvent` events contain the complete content\n\nNote: `AssistantMessageEvent` and `AssistantReasoningEvent` (final events) are always sent regardless of streaming setting.\n\n## Infinite Sessions\n\nBy default, sessions use **infinite sessions** which automatically manage context window limits through background compaction and persist state to a workspace directory.\n\n```csharp\n// Default: infinite sessions enabled with default thresholds\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5\"\n});\n\n// Access the workspace path for checkpoints and files\nConsole.WriteLine(session.WorkspacePath);\n// => ~/.copilot/session-state/{sessionId}/\n\n// Custom thresholds\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5\",\n InfiniteSessions = new InfiniteSessionConfig\n {\n Enabled = true,\n BackgroundCompactionThreshold = 0.80, // Start compacting at 80% context usage\n BufferExhaustionThreshold = 0.95 // Block at 95% until compaction completes\n }\n});\n\n// Disable infinite sessions\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5\",\n InfiniteSessions = new InfiniteSessionConfig { Enabled = false }\n});\n```\n\nWhen enabled, sessions emit compaction events:\n\n- `SessionCompactionStartEvent` - Background compaction started\n- `SessionCompactionCompleteEvent` - Compaction finished (includes token counts)\n\n## Advanced Usage\n\n### Manual Server Control\n\n```csharp\nvar client = new CopilotClient(new CopilotClientOptions { AutoStart = false });\n\n// Start manually\nawait client.StartAsync();\n\n// Use client...\n\n// Stop manually\nawait client.StopAsync();\n```\n\n### Tools\n\nYou can let the CLI call back into your process when the model needs capabilities you own. Use `AIFunctionFactory.Create` from Microsoft.Extensions.AI for type-safe tool definitions:\n\n```csharp\nusing Microsoft.Extensions.AI;\nusing System.ComponentModel;\n\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5\",\n Tools = [\n AIFunctionFactory.Create(\n async ([Description(\"Issue identifier\")] string id) => {\n var issue = await FetchIssueAsync(id);\n return issue;\n },\n \"lookup_issue\",\n \"Fetch issue details from our tracker\"),\n ]\n});\n```\n\nWhen Copilot invokes `lookup_issue`, the client automatically runs your handler and responds to the CLI. Handlers can return any JSON-serializable value (automatically wrapped), or a `ToolResultAIContent` wrapping a `ToolResultObject` for full control over result metadata.\n\n#### Overriding Built-in Tools\n\nIf you register a tool with the same name as a built-in CLI tool (e.g. `edit_file`, `read_file`), the runtime will return an error unless you explicitly opt in by setting `is_override` in the tool's `AdditionalProperties`. This flag signals that you intend to replace the built-in tool with your custom implementation.\n\n```csharp\nvar editFile = AIFunctionFactory.Create(\n async ([Description(\"File path\")] string path, [Description(\"New content\")] string content) => {\n // your logic\n },\n \"edit_file\",\n \"Custom file editor with project-specific validation\",\n new AIFunctionFactoryOptions\n {\n AdditionalProperties = new ReadOnlyDictionary(\n new Dictionary { [\"is_override\"] = true })\n });\n\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5\",\n Tools = [editFile],\n});\n```\n\n#### Skipping Permission Prompts\n\nSet `skip_permission` in the tool's `AdditionalProperties` to allow it to execute without triggering a permission prompt:\n\n```csharp\nvar safeLookup = AIFunctionFactory.Create(\n async ([Description(\"Lookup ID\")] string id) => {\n // your logic\n },\n \"safe_lookup\",\n \"A read-only lookup that needs no confirmation\",\n new AIFunctionFactoryOptions\n {\n AdditionalProperties = new ReadOnlyDictionary(\n new Dictionary { [\"skip_permission\"] = true })\n });\n```\n\n## Commands\n\nRegister slash commands so that users of the CLI's TUI can invoke custom actions via `/commandName`. Each command has a `Name`, optional `Description`, and a `Handler` called when the user executes it.\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5\",\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Commands =\n [\n new CommandDefinition\n {\n Name = \"deploy\",\n Description = \"Deploy the app to production\",\n Handler = async (context) =>\n {\n Console.WriteLine($\"Deploying with args: {context.Args}\");\n // Do work here — any thrown error is reported back to the CLI\n },\n },\n ],\n});\n```\n\nWhen the user types `/deploy staging` in the CLI, the SDK receives a `command.execute` event, routes it to your handler, and automatically responds to the CLI. If the handler throws, the error message is forwarded.\n\nCommands are sent to the CLI on both `CreateSessionAsync` and `ResumeSessionAsync`, so you can update the command set when resuming.\n\n## UI Elicitation\n\nWhen the session has elicitation support — either from the CLI's TUI or from another client that registered an `OnElicitationRequest` handler (see [Elicitation Requests](#elicitation-requests)) — the SDK can request interactive form dialogs from the user. The `session.Ui` object provides convenience methods built on a single generic elicitation RPC.\n\n> **Capability check:** Elicitation is only available when at least one connected participant advertises support. Always check `session.Capabilities.Ui?.Elicitation` before calling UI methods — this property updates automatically as participants join and leave.\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5\",\n OnPermissionRequest = PermissionHandler.ApproveAll,\n});\n\nif (session.Capabilities.Ui?.Elicitation == true)\n{\n // Confirm dialog — returns boolean\n bool ok = await session.Ui.ConfirmAsync(\"Deploy to production?\");\n\n // Selection dialog — returns selected value or null\n string? env = await session.Ui.SelectAsync(\"Pick environment\",\n [\"production\", \"staging\", \"dev\"]);\n\n // Text input — returns string or null\n string? name = await session.Ui.InputAsync(\"Project name:\", new InputOptions\n {\n Title = \"Name\",\n MinLength = 1,\n MaxLength = 50,\n });\n\n // Generic elicitation with full schema control\n ElicitationResult result = await session.Ui.ElicitationAsync(new ElicitationParams\n {\n Message = \"Configure deployment\",\n RequestedSchema = new ElicitationSchema\n {\n Type = \"object\",\n Properties = new Dictionary\n {\n [\"region\"] = new Dictionary\n {\n [\"type\"] = \"string\",\n [\"enum\"] = new[] { \"us-east\", \"eu-west\" },\n },\n [\"dryRun\"] = new Dictionary\n {\n [\"type\"] = \"boolean\",\n [\"default\"] = true,\n },\n },\n Required = [\"region\"],\n },\n });\n // result.Action: Accept, Decline, or Cancel\n // result.Content: { \"region\": \"us-east\", \"dryRun\": true } (when accepted)\n}\n```\n\nAll UI methods throw if elicitation is not supported by the host.\n\n### System Message Customization\n\nControl the system prompt using `SystemMessage` in session config:\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5\",\n SystemMessage = new SystemMessageConfig\n {\n Mode = SystemMessageMode.Append,\n Content = @\"\n\n- Always check for security vulnerabilities\n- Suggest performance improvements when applicable\n\n\"\n }\n});\n```\n\n#### Customize Mode\n\nUse `Mode = SystemMessageMode.Customize` to selectively override individual sections of the prompt while preserving the rest:\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5\",\n SystemMessage = new SystemMessageConfig\n {\n Mode = SystemMessageMode.Customize,\n Sections = new Dictionary\n {\n [SystemPromptSections.Tone] = new() { Action = SectionOverrideAction.Replace, Content = \"Respond in a warm, professional tone. Be thorough in explanations.\" },\n [SystemPromptSections.CodeChangeRules] = new() { Action = SectionOverrideAction.Remove },\n [SystemPromptSections.Guidelines] = new() { Action = SectionOverrideAction.Append, Content = \"\\n* Always cite data sources\" },\n },\n Content = \"Focus on financial analysis and reporting.\"\n }\n});\n```\n\nAvailable section IDs are defined as constants on `SystemPromptSections`: `Identity`, `Tone`, `ToolEfficiency`, `EnvironmentContext`, `CodeChangeRules`, `Guidelines`, `Safety`, `ToolInstructions`, `CustomInstructions`, `LastInstructions`.\n\nEach section override supports four actions: `Replace`, `Remove`, `Append`, and `Prepend`. Unknown section IDs are handled gracefully: content is appended to additional instructions, and `Remove` overrides are silently ignored.\n\n#### Replace Mode\n\nFor full control (removes all guardrails), use `Mode = SystemMessageMode.Replace`:\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5\",\n SystemMessage = new SystemMessageConfig\n {\n Mode = SystemMessageMode.Replace,\n Content = \"You are a helpful assistant.\"\n }\n});\n```\n\n### Multiple Sessions\n\n```csharp\nvar session1 = await client.CreateSessionAsync(new SessionConfig { Model = \"gpt-5\" });\nvar session2 = await client.CreateSessionAsync(new SessionConfig { Model = \"claude-sonnet-4.5\" });\n\n// Both sessions are independent\nawait session1.SendAsync(new MessageOptions { Prompt = \"Hello from session 1\" });\nawait session2.SendAsync(new MessageOptions { Prompt = \"Hello from session 2\" });\n```\n\n### File Attachments\n\n```csharp\nawait session.SendAsync(new MessageOptions\n{\n Prompt = \"Analyze this file\",\n Attachments = new List\n {\n new UserMessageDataAttachmentsItem\n {\n Type = UserMessageDataAttachmentsItemType.File,\n Path = \"/path/to/file.cs\",\n DisplayName = \"My File\"\n }\n }\n});\n```\n\n### Bring Your Own Key (BYOK)\n\nUse a custom API provider:\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Provider = new ProviderConfig\n {\n Type = \"openai\",\n BaseUrl = \"https://api.openai.com/v1\",\n ApiKey = \"your-api-key\"\n }\n});\n```\n\n## Telemetry\n\nThe SDK supports OpenTelemetry for distributed tracing. Provide a `Telemetry` config to enable trace export and automatic W3C Trace Context propagation.\n\n```csharp\nvar client = new CopilotClient(new CopilotClientOptions\n{\n Telemetry = new TelemetryConfig\n {\n OtlpEndpoint = \"http://localhost:4318\",\n },\n});\n```\n\n**TelemetryConfig properties:**\n\n- `OtlpEndpoint` - OTLP HTTP endpoint URL\n- `FilePath` - File path for JSON-lines trace output\n- `ExporterType` - `\"otlp-http\"` or `\"file\"`\n- `SourceName` - Instrumentation scope name\n- `CaptureContent` - Whether to capture message content\n\nTrace context (`traceparent`/`tracestate`) is automatically propagated between the SDK and CLI on `CreateSessionAsync`, `ResumeSessionAsync`, and `SendAsync` calls, and inbound when the CLI invokes tool handlers.\n\nNo extra dependencies — uses built-in `System.Diagnostics.Activity`.\n\n## Permission Handling\n\nAn `OnPermissionRequest` handler is **required** whenever you create or resume a session. The handler is called before the agent executes each tool (file writes, shell commands, custom tools, etc.) and must return a decision.\n\n### Approve All (simplest)\n\nUse the built-in `PermissionHandler.ApproveAll` helper to allow every tool call without any checks:\n\n```csharp\nusing GitHub.Copilot.SDK;\n\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5\",\n OnPermissionRequest = PermissionHandler.ApproveAll,\n});\n```\n\n### Custom Permission Handler\n\nProvide your own `PermissionRequestHandler` delegate to inspect each request and apply custom logic:\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5\",\n OnPermissionRequest = async (request, invocation) =>\n {\n // request.Kind — string discriminator for the type of operation being requested:\n // \"shell\" — executing a shell command\n // \"write\" — writing or editing a file\n // \"read\" — reading a file\n // \"mcp\" — calling an MCP tool\n // \"custom_tool\" — calling one of your registered tools\n // \"url\" — fetching a URL\n // \"memory\" — accessing or modifying assistant memory\n // \"hook\" — invoking a registered hook\n // request.ToolCallId — the tool call that triggered this request\n // request.ToolName — name of the tool (for custom-tool / mcp)\n // request.FileName — file being written (for write)\n // request.FullCommandText — full shell command text (for shell)\n\n if (request.Kind == \"shell\")\n {\n // Deny shell commands\n return new PermissionRequestResult { Kind = PermissionRequestResultKind.DeniedInteractivelyByUser };\n }\n\n return new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved };\n }\n});\n```\n\n### Permission Result Kinds\n\n| Value | Meaning |\n| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `PermissionRequestResultKind.Approved` | Allow the tool to run |\n| `PermissionRequestResultKind.DeniedInteractivelyByUser` | User explicitly denied the request |\n| `PermissionRequestResultKind.DeniedCouldNotRequestFromUser` | No approval rule matched and user could not be asked |\n| `PermissionRequestResultKind.DeniedByRules` | Denied by a policy rule |\n| `PermissionRequestResultKind.NoResult` | Leave the permission request unanswered (the SDK returns without calling the RPC). Not allowed for protocol v2 permission requests (will be rejected). |\n\n### Resuming Sessions\n\nPass `OnPermissionRequest` when resuming a session too — it is required:\n\n```csharp\nvar session = await client.ResumeSessionAsync(\"session-id\", new ResumeSessionConfig\n{\n OnPermissionRequest = PermissionHandler.ApproveAll,\n});\n```\n\n### Per-Tool Skip Permission\n\nTo let a specific custom tool bypass the permission prompt entirely, set `skip_permission = true` in the tool's `AdditionalProperties`. See [Skipping Permission Prompts](#skipping-permission-prompts) under Tools.\n\n## User Input Requests\n\nEnable the agent to ask questions to the user using the `ask_user` tool by providing an `OnUserInputRequest` handler:\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5\",\n OnUserInputRequest = async (request, invocation) =>\n {\n // request.Question - The question to ask\n // request.Choices - Optional list of choices for multiple choice\n // request.AllowFreeform - Whether freeform input is allowed (default: true)\n\n Console.WriteLine($\"Agent asks: {request.Question}\");\n if (request.Choices?.Count > 0)\n {\n Console.WriteLine($\"Choices: {string.Join(\", \", request.Choices)}\");\n }\n\n // Return the user's response\n return new UserInputResponse\n {\n Answer = \"User's answer here\",\n WasFreeform = true // Whether the answer was freeform (not from choices)\n };\n }\n});\n```\n\n## Session Hooks\n\nHook into session lifecycle events by providing handlers in the `Hooks` configuration:\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5\",\n Hooks = new SessionHooks\n {\n // Called before each tool execution\n OnPreToolUse = async (input, invocation) =>\n {\n Console.WriteLine($\"About to run tool: {input.ToolName}\");\n // Return permission decision and optionally modify args\n return new PreToolUseHookOutput\n {\n PermissionDecision = \"allow\", // \"allow\", \"deny\", or \"ask\"\n ModifiedArgs = input.ToolArgs, // Optionally modify tool arguments\n AdditionalContext = \"Extra context for the model\"\n };\n },\n\n // Called after each tool execution\n OnPostToolUse = async (input, invocation) =>\n {\n Console.WriteLine($\"Tool {input.ToolName} completed\");\n return new PostToolUseHookOutput\n {\n AdditionalContext = \"Post-execution notes\"\n };\n },\n\n // Called when user submits a prompt\n OnUserPromptSubmitted = async (input, invocation) =>\n {\n Console.WriteLine($\"User prompt: {input.Prompt}\");\n return new UserPromptSubmittedHookOutput\n {\n ModifiedPrompt = input.Prompt // Optionally modify the prompt\n };\n },\n\n // Called when session starts\n OnSessionStart = async (input, invocation) =>\n {\n Console.WriteLine($\"Session started from: {input.Source}\"); // \"startup\", \"resume\", \"new\"\n return new SessionStartHookOutput\n {\n AdditionalContext = \"Session initialization context\"\n };\n },\n\n // Called when session ends\n OnSessionEnd = async (input, invocation) =>\n {\n Console.WriteLine($\"Session ended: {input.Reason}\");\n return null;\n },\n\n // Called when an error occurs\n OnErrorOccurred = async (input, invocation) =>\n {\n Console.WriteLine($\"Error in {input.ErrorContext}: {input.Error}\");\n return new ErrorOccurredHookOutput\n {\n ErrorHandling = \"retry\" // \"retry\", \"skip\", or \"abort\"\n };\n }\n }\n});\n```\n\n**Available hooks:**\n\n- `OnPreToolUse` - Intercept tool calls before execution. Can allow/deny or modify arguments.\n- `OnPostToolUse` - Process tool results after execution. Can modify results or add context.\n- `OnUserPromptSubmitted` - Intercept user prompts. Can modify the prompt before processing.\n- `OnSessionStart` - Run logic when a session starts or resumes.\n- `OnSessionEnd` - Cleanup or logging when session ends.\n- `OnErrorOccurred` - Handle errors with retry/skip/abort strategies.\n\n## Elicitation Requests\n\nRegister an `OnElicitationRequest` handler to let your client act as an elicitation provider — presenting form-based UI dialogs on behalf of the agent. When provided, the server notifies your client whenever a tool or MCP server needs structured user input.\n\n```csharp\nvar session = await client.CreateSessionAsync(new SessionConfig\n{\n Model = \"gpt-5\",\n OnPermissionRequest = PermissionHandler.ApproveAll,\n OnElicitationRequest = async (context) =>\n {\n // context.SessionId - Session that triggered the request\n // context.Message - Description of what information is needed\n // context.RequestedSchema - JSON Schema describing the form fields\n // context.Mode - \"form\" (structured input) or \"url\" (browser redirect)\n // context.ElicitationSource - Origin of the request (e.g. MCP server name)\n\n Console.WriteLine($\"Elicitation from {context.ElicitationSource}: {context.Message}\");\n\n // Present UI to the user and collect their response...\n return new ElicitationResult\n {\n Action = SessionUiElicitationResultAction.Accept,\n Content = new Dictionary\n {\n [\"region\"] = \"us-east\",\n [\"dryRun\"] = true,\n },\n };\n },\n});\n\n// The session now reports elicitation capability\nConsole.WriteLine(session.Capabilities.Ui?.Elicitation); // True\n```\n\nWhen `OnElicitationRequest` is provided, the SDK sends `RequestElicitation = true` during session create/resume, which enables `session.Capabilities.Ui.Elicitation` on the session.\n\nIn multi-client scenarios:\n\n- If no connected client was previously providing an elicitation capability, but a new client joins that can, all clients will receive a `capabilities.changed` event to notify them that elicitation is now possible. The SDK automatically updates `session.Capabilities` when these events arrive.\n- Similarly, if the last elicitation provider disconnects, all clients receive a `capabilities.changed` event indicating elicitation is no longer available.\n- The server fans out elicitation requests to **all** connected clients that registered a handler — the first response wins.\n\n## Error Handling\n\n```csharp\ntry\n{\n var session = await client.CreateSessionAsync();\n await session.SendAsync(new MessageOptions { Prompt = \"Hello\" });\n}\ncatch (IOException ex)\n{\n Console.Error.WriteLine($\"Communication Error: {ex.Message}\");\n}\ncatch (Exception ex)\n{\n Console.Error.WriteLine($\"Error: {ex.Message}\");\n}\n```\n\n## Requirements\n\n- .NET 8.0 or later\n- GitHub Copilot CLI installed and in PATH (or provide custom `CliPath`)\n\n## License\n\nMIT\n" }, { "path": "dotnet/global.json", "content": "{\n \"sdk\": {\n \"version\": \"10.0.100\",\n \"rollForward\": \"major\"\n }\n}\n" }, { "path": "dotnet/nuget.config", "content": "\n\n \n \n \n \n \n \n \n \n \n\n" }, { "path": "dotnet/samples/Chat.cs", "content": "using GitHub.Copilot.SDK;\n\nawait using var client = new CopilotClient();\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n OnPermissionRequest = PermissionHandler.ApproveAll\n});\n\nusing var _ = session.On(evt =>\n{\n Console.ForegroundColor = ConsoleColor.Blue;\n switch (evt)\n {\n case AssistantReasoningEvent reasoning:\n Console.WriteLine($\"[reasoning: {reasoning.Data.Content}]\");\n break;\n case ToolExecutionStartEvent tool:\n Console.WriteLine($\"[tool: {tool.Data.ToolName}]\");\n break;\n }\n Console.ResetColor();\n});\n\nConsole.WriteLine(\"Chat with Copilot (Ctrl+C to exit)\\n\");\n\nwhile (true)\n{\n Console.Write(\"You: \");\n var input = Console.ReadLine()?.Trim();\n if (string.IsNullOrEmpty(input)) continue;\n Console.WriteLine();\n\n var reply = await session.SendAndWaitAsync(new MessageOptions { Prompt = input });\n Console.WriteLine($\"\\nAssistant: {reply?.Data.Content}\\n\");\n}\n" }, { "path": "dotnet/samples/Chat.csproj", "content": "\n \n Exe\n \n \n \n \n\n" }, { "path": "dotnet/src/ActionDisposable.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nnamespace GitHub.Copilot.SDK;\n\n/// \n/// A disposable that invokes an action when disposed.\n/// \ninternal sealed class ActionDisposable(Action action) : IDisposable\n{\n private Action? _action = action;\n\n public void Dispose()\n {\n var action = Interlocked.Exchange(ref _action, null);\n action?.Invoke();\n }\n}\n" }, { "path": "dotnet/src/Client.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing Microsoft.Extensions.AI;\nusing Microsoft.Extensions.Logging;\nusing Microsoft.Extensions.Logging.Abstractions;\nusing System.Collections.Concurrent;\nusing System.Data;\nusing System.Diagnostics;\nusing System.Diagnostics.CodeAnalysis;\nusing System.Net.Sockets;\nusing System.Text;\nusing System.Text.Json;\nusing System.Text.Json.Serialization;\nusing System.Text.Json.Serialization.Metadata;\nusing System.Text.RegularExpressions;\nusing GitHub.Copilot.SDK.Rpc;\nusing System.Globalization;\n\nnamespace GitHub.Copilot.SDK;\n\n/// \n/// Provides a client for interacting with the Copilot CLI server.\n/// \n/// \n/// \n/// The manages the connection to the Copilot CLI server and provides\n/// methods to create and manage conversation sessions. It can either spawn a CLI server process\n/// or connect to an existing server.\n/// \n/// \n/// The client supports both stdio (default) and TCP transport modes for communication with the CLI server.\n/// \n/// \n/// \n/// \n/// // Create a client with default options (spawns CLI server)\n/// await using var client = new CopilotClient();\n///\n/// // Create a session\n/// await using var session = await client.CreateSessionAsync(new() { OnPermissionRequest = PermissionHandler.ApproveAll, Model = \"gpt-4\" });\n///\n/// // Handle events\n/// using var subscription = session.On(evt =>\n/// {\n/// if (evt is AssistantMessageEvent assistantMessage)\n/// Console.WriteLine(assistantMessage.Data?.Content);\n/// });\n///\n/// // Send a message\n/// await session.SendAsync(new MessageOptions { Prompt = \"Hello!\" });\n/// \n/// \npublic sealed partial class CopilotClient : IDisposable, IAsyncDisposable\n{\n internal const string NoResultPermissionV2ErrorMessage =\n \"Permission handlers cannot return 'no-result' when connected to a protocol v2 server.\";\n\n /// \n /// Minimum protocol version this SDK can communicate with.\n /// \n private const int MinProtocolVersion = 2;\n\n private readonly ConcurrentDictionary _sessions = new();\n private readonly CopilotClientOptions _options;\n private readonly ILogger _logger;\n private Task? _connectionTask;\n private volatile bool _disconnected;\n private bool _disposed;\n private readonly int? _optionsPort;\n private readonly string? _optionsHost;\n private int? _actualPort;\n private int? _negotiatedProtocolVersion;\n private List? _modelsCache;\n private readonly SemaphoreSlim _modelsCacheLock = new(1, 1);\n private readonly Func>>? _onListModels;\n private readonly List> _lifecycleHandlers = [];\n private readonly Dictionary>> _typedLifecycleHandlers = [];\n private readonly object _lifecycleHandlersLock = new();\n private ServerRpc? _serverRpc;\n\n /// \n /// Gets the typed RPC client for server-scoped methods (no session required).\n /// \n /// \n /// The client must be started before accessing this property. Use or set to true.\n /// \n /// Thrown if the client has been disposed.\n /// Thrown if the client is not started.\n public ServerRpc Rpc => _disposed\n ? throw new ObjectDisposedException(nameof(CopilotClient))\n : _serverRpc ?? throw new InvalidOperationException(\"Client is not started. Call StartAsync first.\");\n\n /// \n /// Gets the actual TCP port the CLI server is listening on, if using TCP transport.\n /// \n public int? ActualPort => _actualPort;\n\n /// \n /// Creates a new instance of .\n /// \n /// Options for creating the client. If null, default options are used.\n /// Thrown when mutually exclusive options are provided (e.g., CliUrl with UseStdio or CliPath).\n /// \n /// \n /// // Default options - spawns CLI server using stdio\n /// var client = new CopilotClient();\n ///\n /// // Connect to an existing server\n /// var client = new CopilotClient(new CopilotClientOptions { CliUrl = \"localhost:3000\", UseStdio = false });\n ///\n /// // Custom CLI path with specific log level\n /// var client = new CopilotClient(new CopilotClientOptions\n /// {\n /// CliPath = \"/usr/local/bin/copilot\",\n /// LogLevel = \"debug\"\n /// });\n /// \n /// \n public CopilotClient(CopilotClientOptions? options = null)\n {\n _options = options ?? new();\n\n // Validate mutually exclusive options\n if (!string.IsNullOrEmpty(_options.CliUrl) && _options.CliPath != null)\n {\n throw new ArgumentException(\"CliUrl is mutually exclusive with CliPath\");\n }\n\n // When CliUrl is provided, disable UseStdio (we connect to an external server, not spawn one)\n if (!string.IsNullOrEmpty(_options.CliUrl))\n {\n _options.UseStdio = false;\n }\n\n // Validate auth options with external server\n if (!string.IsNullOrEmpty(_options.CliUrl) && (!string.IsNullOrEmpty(_options.GitHubToken) || _options.UseLoggedInUser != null))\n {\n throw new ArgumentException(\"GitHubToken and UseLoggedInUser cannot be used with CliUrl (external server manages its own auth)\");\n }\n\n _logger = _options.Logger ?? NullLogger.Instance;\n _onListModels = _options.OnListModels;\n\n // Parse CliUrl if provided\n if (!string.IsNullOrEmpty(_options.CliUrl))\n {\n var uri = ParseCliUrl(_options.CliUrl!);\n _optionsHost = uri.Host;\n _optionsPort = uri.Port;\n }\n }\n\n /// \n /// Parses a CLI URL into a URI with host and port.\n /// \n /// The URL to parse. Supports formats: \"port\", \"host:port\", \"http://host:port\".\n /// A containing the parsed host and port.\n private static Uri ParseCliUrl(string url)\n {\n // If it's just a port number, treat as localhost\n if (int.TryParse(url, out var port))\n {\n return new Uri($\"http://localhost:{port}\");\n }\n\n // Add scheme if missing\n if (!url.StartsWith(\"http://\", StringComparison.OrdinalIgnoreCase) &&\n !url.StartsWith(\"https://\", StringComparison.OrdinalIgnoreCase))\n {\n url = \"https://\" + url;\n }\n\n return new Uri(url);\n }\n\n /// \n /// Starts the Copilot client and connects to the server.\n /// \n /// A that can be used to cancel the operation.\n /// A representing the asynchronous operation.\n /// \n /// \n /// If the server is not already running and the client is configured to spawn one (default), it will be started.\n /// If connecting to an external server (via CliUrl), only establishes the connection.\n /// \n /// \n /// This method is called automatically when creating a session if is true (default).\n /// \n /// \n /// \n /// \n /// var client = new CopilotClient(new CopilotClientOptions { AutoStart = false });\n /// await client.StartAsync();\n /// // Now ready to create sessions\n /// \n /// \n public Task StartAsync(CancellationToken cancellationToken = default)\n {\n return _connectionTask ??= StartCoreAsync(cancellationToken);\n\n async Task StartCoreAsync(CancellationToken ct)\n {\n _logger.LogDebug(\"Starting Copilot client\");\n _disconnected = false;\n\n Task result;\n\n if (_optionsHost is not null && _optionsPort is not null)\n {\n // External server (TCP)\n _actualPort = _optionsPort;\n result = ConnectToServerAsync(null, _optionsHost, _optionsPort, null, ct);\n }\n else\n {\n // Child process (stdio or TCP)\n var (cliProcess, portOrNull, stderrBuffer) = await StartCliServerAsync(_options, _logger, ct);\n _actualPort = portOrNull;\n result = ConnectToServerAsync(cliProcess, portOrNull is null ? null : \"localhost\", portOrNull, stderrBuffer, ct);\n }\n\n var connection = await result;\n\n // Verify protocol version compatibility\n await VerifyProtocolVersionAsync(connection, ct);\n await ConfigureSessionFsAsync(ct);\n\n _logger.LogInformation(\"Copilot client connected\");\n return connection;\n }\n }\n\n /// \n /// Disconnects from the Copilot server and closes all active sessions.\n /// \n /// A representing the asynchronous operation.\n /// \n /// \n /// This method performs graceful cleanup:\n /// \n /// Closes all active sessions (releases in-memory resources)\n /// Closes the JSON-RPC connection\n /// Terminates the CLI server process (if spawned by this client)\n /// \n /// \n /// \n /// Note: session data on disk is preserved, so sessions can be resumed later.\n /// To permanently remove session data before stopping, call\n /// for each session first.\n /// \n /// \n /// Thrown when multiple errors occur during cleanup.\n /// \n /// \n /// await client.StopAsync();\n /// \n /// \n public async Task StopAsync()\n {\n var errors = new List();\n\n foreach (var session in _sessions.Values.ToArray())\n {\n try\n {\n await session.DisposeAsync();\n }\n catch (Exception ex)\n {\n errors.Add(new Exception($\"Failed to dispose session {session.SessionId}: {ex.Message}\", ex));\n }\n }\n\n _sessions.Clear();\n await CleanupConnectionAsync(errors);\n _connectionTask = null;\n\n ThrowErrors(errors);\n }\n\n /// \n /// Forces an immediate stop of the client without graceful cleanup.\n /// \n /// A representing the asynchronous operation.\n /// \n /// Use this when fails or takes too long. This method:\n /// \n /// Clears all sessions immediately without destroying them\n /// Force closes the connection\n /// Kills the CLI process (if spawned by this client)\n /// \n /// \n /// \n /// \n /// // If normal stop hangs, force stop\n /// var stopTask = client.StopAsync();\n /// if (!stopTask.Wait(TimeSpan.FromSeconds(5)))\n /// {\n /// await client.ForceStopAsync();\n /// }\n /// \n /// \n public async Task ForceStopAsync()\n {\n var errors = new List();\n\n _sessions.Clear();\n await CleanupConnectionAsync(errors);\n _connectionTask = null;\n\n ThrowErrors(errors);\n }\n\n private static void ThrowErrors(List errors)\n {\n if (errors.Count == 1)\n {\n throw errors[0];\n }\n else if (errors.Count > 0)\n {\n throw new AggregateException(errors);\n }\n }\n\n private async Task CleanupConnectionAsync(List? errors)\n {\n if (_connectionTask is null)\n {\n return;\n }\n\n var ctx = await _connectionTask;\n _connectionTask = null;\n\n try { ctx.Rpc.Dispose(); }\n catch (Exception ex) { errors?.Add(ex); }\n\n // Clear RPC and models cache\n _serverRpc = null;\n _modelsCache = null;\n\n if (ctx.NetworkStream is not null)\n {\n try { await ctx.NetworkStream.DisposeAsync(); }\n catch (Exception ex) { errors?.Add(ex); }\n }\n\n if (ctx.CliProcess is { } childProcess)\n {\n try\n {\n if (!childProcess.HasExited) childProcess.Kill();\n childProcess.Dispose();\n }\n catch (Exception ex) { errors?.Add(ex); }\n }\n }\n\n private static (SystemMessageConfig? wireConfig, Dictionary>>? callbacks) ExtractTransformCallbacks(SystemMessageConfig? systemMessage)\n {\n if (systemMessage?.Mode != SystemMessageMode.Customize || systemMessage.Sections == null)\n {\n return (systemMessage, null);\n }\n\n var callbacks = new Dictionary>>();\n var wireSections = new Dictionary();\n\n foreach (var (sectionId, sectionOverride) in systemMessage.Sections)\n {\n if (sectionOverride.Transform != null)\n {\n callbacks[sectionId] = sectionOverride.Transform;\n wireSections[sectionId] = new SectionOverride { Action = SectionOverrideAction.Transform };\n }\n else\n {\n wireSections[sectionId] = sectionOverride;\n }\n }\n\n if (callbacks.Count == 0)\n {\n return (systemMessage, null);\n }\n\n var wireConfig = new SystemMessageConfig\n {\n Mode = systemMessage.Mode,\n Content = systemMessage.Content,\n Sections = wireSections\n };\n\n return (wireConfig, callbacks);\n }\n\n /// \n /// Creates a new Copilot session with the specified configuration.\n /// \n /// Configuration for the session, including the required handler.\n /// A that can be used to cancel the operation.\n /// A task that resolves to provide the .\n /// \n /// Sessions maintain conversation state, handle events, and manage tool execution.\n /// If the client is not connected and is enabled (default),\n /// this will automatically start the connection.\n /// \n /// \n /// \n /// // Basic session\n /// var session = await client.CreateSessionAsync(new() { OnPermissionRequest = PermissionHandler.ApproveAll });\n ///\n /// // Session with model and tools\n /// var session = await client.CreateSessionAsync(new()\n /// {\n /// OnPermissionRequest = PermissionHandler.ApproveAll,\n /// Model = \"gpt-4\",\n /// Tools = [AIFunctionFactory.Create(MyToolMethod)]\n /// });\n /// \n /// \n public async Task CreateSessionAsync(SessionConfig config, CancellationToken cancellationToken = default)\n {\n if (config.OnPermissionRequest == null)\n {\n throw new ArgumentException(\n \"An OnPermissionRequest handler is required when creating a session. \" +\n \"For example, to allow all permissions, use CreateSessionAsync(new() { OnPermissionRequest = PermissionHandler.ApproveAll });\");\n }\n\n var connection = await EnsureConnectedAsync(cancellationToken);\n\n var hasHooks = config.Hooks != null && (\n config.Hooks.OnPreToolUse != null ||\n config.Hooks.OnPostToolUse != null ||\n config.Hooks.OnUserPromptSubmitted != null ||\n config.Hooks.OnSessionStart != null ||\n config.Hooks.OnSessionEnd != null ||\n config.Hooks.OnErrorOccurred != null);\n\n var (wireSystemMessage, transformCallbacks) = ExtractTransformCallbacks(config.SystemMessage);\n\n var sessionId = config.SessionId ?? Guid.NewGuid().ToString();\n\n // Create and register the session before issuing the RPC so that\n // events emitted by the CLI (e.g. session.start) are not dropped.\n var session = new CopilotSession(sessionId, connection.Rpc, _logger);\n session.RegisterTools(config.Tools ?? []);\n session.RegisterPermissionHandler(config.OnPermissionRequest);\n session.RegisterCommands(config.Commands);\n session.RegisterElicitationHandler(config.OnElicitationRequest);\n if (config.OnUserInputRequest != null)\n {\n session.RegisterUserInputHandler(config.OnUserInputRequest);\n }\n if (config.Hooks != null)\n {\n session.RegisterHooks(config.Hooks);\n }\n if (transformCallbacks != null)\n {\n session.RegisterTransformCallbacks(transformCallbacks);\n }\n if (config.OnEvent != null)\n {\n session.On(config.OnEvent);\n }\n ConfigureSessionFsHandlers(session, config.CreateSessionFsHandler);\n _sessions[sessionId] = session;\n\n try\n {\n var (traceparent, tracestate) = TelemetryHelpers.GetTraceContext();\n\n var request = new CreateSessionRequest(\n config.Model,\n sessionId,\n config.ClientName,\n config.ReasoningEffort,\n config.Tools?.Select(ToolDefinition.FromAIFunction).ToList(),\n wireSystemMessage,\n config.AvailableTools,\n config.ExcludedTools,\n config.Provider,\n (bool?)true,\n config.OnUserInputRequest != null ? true : null,\n hasHooks ? true : null,\n config.WorkingDirectory,\n config.Streaming is true ? true : null,\n config.IncludeSubAgentStreamingEvents,\n config.McpServers,\n \"direct\",\n config.CustomAgents,\n config.DefaultAgent,\n config.Agent,\n config.ConfigDir,\n config.EnableConfigDiscovery,\n config.SkillDirectories,\n config.DisabledSkills,\n config.InfiniteSessions,\n Commands: config.Commands?.Select(c => new CommandWireDefinition(c.Name, c.Description)).ToList(),\n RequestElicitation: config.OnElicitationRequest != null,\n Traceparent: traceparent,\n Tracestate: tracestate,\n ModelCapabilities: config.ModelCapabilities,\n GitHubToken: config.GitHubToken);\n\n var response = await InvokeRpcAsync(\n connection.Rpc, \"session.create\", [request], cancellationToken);\n\n session.WorkspacePath = response.WorkspacePath;\n session.SetCapabilities(response.Capabilities);\n }\n catch\n {\n _sessions.TryRemove(sessionId, out _);\n throw;\n }\n\n return session;\n }\n\n /// \n /// Resumes an existing Copilot session with the specified configuration.\n /// \n /// The ID of the session to resume.\n /// Configuration for the resumed session, including the required handler.\n /// A that can be used to cancel the operation.\n /// A task that resolves to provide the .\n /// Thrown when is not set.\n /// Thrown when the session does not exist or the client is not connected.\n /// \n /// This allows you to continue a previous conversation, maintaining all conversation history.\n /// The session must have been previously created and not deleted.\n /// \n /// \n /// \n /// // Resume a previous session\n /// var session = await client.ResumeSessionAsync(\"session-123\", new() { OnPermissionRequest = PermissionHandler.ApproveAll });\n ///\n /// // Resume with new tools\n /// var session = await client.ResumeSessionAsync(\"session-123\", new()\n /// {\n /// OnPermissionRequest = PermissionHandler.ApproveAll,\n /// Tools = [AIFunctionFactory.Create(MyNewToolMethod)]\n /// });\n /// \n /// \n public async Task ResumeSessionAsync(string sessionId, ResumeSessionConfig config, CancellationToken cancellationToken = default)\n {\n if (config.OnPermissionRequest == null)\n {\n throw new ArgumentException(\n \"An OnPermissionRequest handler is required when resuming a session. \" +\n \"For example, to allow all permissions, use new() { OnPermissionRequest = PermissionHandler.ApproveAll }.\");\n }\n\n var connection = await EnsureConnectedAsync(cancellationToken);\n\n var hasHooks = config.Hooks != null && (\n config.Hooks.OnPreToolUse != null ||\n config.Hooks.OnPostToolUse != null ||\n config.Hooks.OnUserPromptSubmitted != null ||\n config.Hooks.OnSessionStart != null ||\n config.Hooks.OnSessionEnd != null ||\n config.Hooks.OnErrorOccurred != null);\n\n var (wireSystemMessage, transformCallbacks) = ExtractTransformCallbacks(config.SystemMessage);\n\n // Create and register the session before issuing the RPC so that\n // events emitted by the CLI (e.g. session.start) are not dropped.\n var session = new CopilotSession(sessionId, connection.Rpc, _logger);\n session.RegisterTools(config.Tools ?? []);\n session.RegisterPermissionHandler(config.OnPermissionRequest);\n session.RegisterCommands(config.Commands);\n session.RegisterElicitationHandler(config.OnElicitationRequest);\n if (config.OnUserInputRequest != null)\n {\n session.RegisterUserInputHandler(config.OnUserInputRequest);\n }\n if (config.Hooks != null)\n {\n session.RegisterHooks(config.Hooks);\n }\n if (transformCallbacks != null)\n {\n session.RegisterTransformCallbacks(transformCallbacks);\n }\n if (config.OnEvent != null)\n {\n session.On(config.OnEvent);\n }\n ConfigureSessionFsHandlers(session, config.CreateSessionFsHandler);\n _sessions[sessionId] = session;\n\n try\n {\n var (traceparent, tracestate) = TelemetryHelpers.GetTraceContext();\n\n var request = new ResumeSessionRequest(\n sessionId,\n config.ClientName,\n config.Model,\n config.ReasoningEffort,\n config.Tools?.Select(ToolDefinition.FromAIFunction).ToList(),\n wireSystemMessage,\n config.AvailableTools,\n config.ExcludedTools,\n config.Provider,\n (bool?)true,\n config.OnUserInputRequest != null ? true : null,\n hasHooks ? true : null,\n config.WorkingDirectory,\n config.ConfigDir,\n config.EnableConfigDiscovery,\n config.DisableResume is true ? true : null,\n config.Streaming is true ? true : null,\n config.IncludeSubAgentStreamingEvents,\n config.McpServers,\n \"direct\",\n config.CustomAgents,\n config.DefaultAgent,\n config.Agent,\n config.SkillDirectories,\n config.DisabledSkills,\n config.InfiniteSessions,\n Commands: config.Commands?.Select(c => new CommandWireDefinition(c.Name, c.Description)).ToList(),\n RequestElicitation: config.OnElicitationRequest != null,\n Traceparent: traceparent,\n Tracestate: tracestate,\n ModelCapabilities: config.ModelCapabilities,\n GitHubToken: config.GitHubToken,\n ContinuePendingWork: config.ContinuePendingWork);\n\n var response = await InvokeRpcAsync(\n connection.Rpc, \"session.resume\", [request], cancellationToken);\n\n session.WorkspacePath = response.WorkspacePath;\n session.SetCapabilities(response.Capabilities);\n }\n catch\n {\n _sessions.TryRemove(sessionId, out _);\n throw;\n }\n\n return session;\n }\n\n /// \n /// Gets the current connection state of the client.\n /// \n /// \n /// The current : Disconnected, Connecting, Connected, or Error.\n /// \n /// \n /// \n /// if (client.State == ConnectionState.Connected)\n /// {\n /// var session = await client.CreateSessionAsync(new() { OnPermissionRequest = PermissionHandler.ApproveAll });\n /// }\n /// \n /// \n public ConnectionState State\n {\n get\n {\n if (_connectionTask == null) return ConnectionState.Disconnected;\n if (_connectionTask.IsFaulted) return ConnectionState.Error;\n if (!_connectionTask.IsCompleted) return ConnectionState.Connecting;\n if (_disconnected) return ConnectionState.Disconnected;\n return ConnectionState.Connected;\n }\n }\n\n /// \n /// Validates the health of the connection by sending a ping request.\n /// \n /// An optional message that will be reflected back in the response.\n /// A that can be used to cancel the operation.\n /// A task that resolves with the containing the message and server timestamp.\n /// Thrown when the client is not connected.\n /// \n /// \n /// var response = await client.PingAsync(\"health check\");\n /// Console.WriteLine($\"Server responded at {response.Timestamp}\");\n /// \n /// \n public async Task PingAsync(string? message = null, CancellationToken cancellationToken = default)\n {\n var connection = await EnsureConnectedAsync(cancellationToken);\n\n return await InvokeRpcAsync(\n connection.Rpc, \"ping\", [new PingRequest { Message = message }], cancellationToken);\n }\n\n /// \n /// Gets CLI status including version and protocol information.\n /// \n /// A that can be used to cancel the operation.\n /// A task that resolves with the status response containing version and protocol version.\n /// Thrown when the client is not connected.\n public async Task GetStatusAsync(CancellationToken cancellationToken = default)\n {\n var connection = await EnsureConnectedAsync(cancellationToken);\n\n return await InvokeRpcAsync(\n connection.Rpc, \"status.get\", [], cancellationToken);\n }\n\n /// \n /// Gets current authentication status.\n /// \n /// A that can be used to cancel the operation.\n /// A task that resolves with the authentication status.\n /// Thrown when the client is not connected.\n public async Task GetAuthStatusAsync(CancellationToken cancellationToken = default)\n {\n var connection = await EnsureConnectedAsync(cancellationToken);\n\n return await InvokeRpcAsync(\n connection.Rpc, \"auth.getStatus\", [], cancellationToken);\n }\n\n /// \n /// Lists available models with their metadata.\n /// \n /// A that can be used to cancel the operation.\n /// A task that resolves with a list of available models.\n /// \n /// Results are cached after the first successful call to avoid rate limiting.\n /// The cache is cleared when the client disconnects.\n /// \n /// Thrown when the client is not connected or not authenticated.\n public async Task> ListModelsAsync(CancellationToken cancellationToken = default)\n {\n await _modelsCacheLock.WaitAsync(cancellationToken);\n try\n {\n // Check cache (already inside lock)\n if (_modelsCache is not null)\n {\n return [.. _modelsCache]; // Return a copy to prevent cache mutation\n }\n\n IList models;\n if (_onListModels is not null)\n {\n // Use custom handler instead of CLI RPC\n models = await _onListModels(cancellationToken);\n }\n else\n {\n var connection = await EnsureConnectedAsync(cancellationToken);\n\n // Cache miss - fetch from backend while holding lock\n var response = await InvokeRpcAsync(\n connection.Rpc, \"models.list\", [], cancellationToken);\n models = response.Models;\n }\n\n // Update cache before releasing lock (copy to prevent external mutation)\n _modelsCache = [.. models];\n\n return [.. models]; // Return a copy to prevent cache mutation\n }\n finally\n {\n _modelsCacheLock.Release();\n }\n }\n\n /// \n /// Gets the ID of the most recently used session.\n /// \n /// A that can be used to cancel the operation.\n /// A task that resolves with the session ID, or null if no sessions exist.\n /// Thrown when the client is not connected.\n /// \n /// \n /// var lastId = await client.GetLastSessionIdAsync();\n /// if (lastId != null)\n /// {\n /// var session = await client.ResumeSessionAsync(lastId, new() { OnPermissionRequest = PermissionHandler.ApproveAll });\n /// }\n /// \n /// \n public async Task GetLastSessionIdAsync(CancellationToken cancellationToken = default)\n {\n var connection = await EnsureConnectedAsync(cancellationToken);\n\n var response = await InvokeRpcAsync(\n connection.Rpc, \"session.getLastId\", [], cancellationToken);\n\n return response.SessionId;\n }\n\n /// \n /// Permanently deletes a session and all its data from disk, including\n /// conversation history, planning state, and artifacts.\n /// \n /// The ID of the session to delete.\n /// A that can be used to cancel the operation.\n /// A task that represents the asynchronous delete operation.\n /// Thrown when the session does not exist or deletion fails.\n /// \n /// Unlike , which only releases in-memory\n /// resources and preserves session data for later resumption, this method is\n /// irreversible. The session cannot be resumed after deletion.\n /// \n /// \n /// \n /// await client.DeleteSessionAsync(\"session-123\");\n /// \n /// \n public async Task DeleteSessionAsync(string sessionId, CancellationToken cancellationToken = default)\n {\n var connection = await EnsureConnectedAsync(cancellationToken);\n\n var response = await InvokeRpcAsync(\n connection.Rpc, \"session.delete\", [new DeleteSessionRequest(sessionId)], cancellationToken);\n\n if (!response.Success)\n {\n throw new InvalidOperationException($\"Failed to delete session {sessionId}: {response.Error}\");\n }\n\n _sessions.TryRemove(sessionId, out _);\n }\n\n /// \n /// Lists all sessions known to the Copilot server.\n /// \n /// Optional filter to narrow down the session list by cwd, git root, repository, or branch.\n /// A that can be used to cancel the operation.\n /// A task that resolves with a list of for all available sessions.\n /// Thrown when the client is not connected.\n /// \n /// \n /// var sessions = await client.ListSessionsAsync();\n /// foreach (var session in sessions)\n /// {\n /// Console.WriteLine($\"{session.SessionId}: {session.Summary}\");\n /// }\n /// \n /// \n public async Task> ListSessionsAsync(SessionListFilter? filter = null, CancellationToken cancellationToken = default)\n {\n var connection = await EnsureConnectedAsync(cancellationToken);\n\n var response = await InvokeRpcAsync(\n connection.Rpc, \"session.list\", [new ListSessionsRequest(filter)], cancellationToken);\n\n return response.Sessions;\n }\n\n /// \n /// Gets metadata for a specific session by ID.\n /// \n /// \n /// This provides an efficient O(1) lookup of a single session's metadata\n /// instead of listing all sessions.\n /// \n /// The ID of the session to look up.\n /// A that can be used to cancel the operation.\n /// A task that resolves with the , or null if the session was not found.\n /// Thrown when the client is not connected.\n /// \n /// \n /// var metadata = await client.GetSessionMetadataAsync(\"session-123\");\n /// if (metadata != null)\n /// {\n /// Console.WriteLine($\"Session started at: {metadata.StartTime}\");\n /// }\n /// \n /// \n public async Task GetSessionMetadataAsync(string sessionId, CancellationToken cancellationToken = default)\n {\n var connection = await EnsureConnectedAsync(cancellationToken);\n\n var response = await InvokeRpcAsync(\n connection.Rpc, \"session.getMetadata\", [new GetSessionMetadataRequest(sessionId)], cancellationToken);\n\n return response.Session;\n }\n\n /// \n /// Gets the ID of the session currently displayed in the TUI.\n /// \n /// \n /// This is only available when connecting to a server running in TUI+server mode\n /// (--ui-server).\n /// \n /// A token to cancel the operation.\n /// The session ID, or null if no foreground session is set.\n /// \n /// \n /// var sessionId = await client.GetForegroundSessionIdAsync();\n /// if (sessionId != null)\n /// {\n /// Console.WriteLine($\"TUI is displaying session: {sessionId}\");\n /// }\n /// \n /// \n public async Task GetForegroundSessionIdAsync(CancellationToken cancellationToken = default)\n {\n var connection = await EnsureConnectedAsync(cancellationToken);\n\n var response = await InvokeRpcAsync(\n connection.Rpc, \"session.getForeground\", [], cancellationToken);\n\n return response.SessionId;\n }\n\n /// \n /// Requests the TUI to switch to displaying the specified session.\n /// \n /// \n /// This is only available when connecting to a server running in TUI+server mode\n /// (--ui-server).\n /// \n /// The ID of the session to display in the TUI.\n /// A token to cancel the operation.\n /// Thrown if the operation fails.\n /// \n /// \n /// await client.SetForegroundSessionIdAsync(\"session-123\");\n /// \n /// \n public async Task SetForegroundSessionIdAsync(string sessionId, CancellationToken cancellationToken = default)\n {\n var connection = await EnsureConnectedAsync(cancellationToken);\n\n var response = await InvokeRpcAsync(\n connection.Rpc, \"session.setForeground\", [new SetForegroundSessionRequest(sessionId)], cancellationToken);\n\n if (!response.Success)\n {\n throw new InvalidOperationException(response.Error ?? \"Failed to set foreground session\");\n }\n }\n\n /// \n /// Subscribes to all session lifecycle events.\n /// \n /// \n /// Lifecycle events are emitted when sessions are created, deleted, updated,\n /// or change foreground/background state (in TUI+server mode).\n /// \n /// A callback function that receives lifecycle events.\n /// An IDisposable that, when disposed, unsubscribes the handler.\n /// \n /// \n /// using var subscription = client.On(evt =>\n /// {\n /// Console.WriteLine($\"Session {evt.SessionId}: {evt.Type}\");\n /// });\n /// \n /// \n public IDisposable On(Action handler)\n {\n lock (_lifecycleHandlersLock)\n {\n _lifecycleHandlers.Add(handler);\n }\n\n return new ActionDisposable(() =>\n {\n lock (_lifecycleHandlersLock)\n {\n _lifecycleHandlers.Remove(handler);\n }\n });\n }\n\n /// \n /// Subscribes to a specific session lifecycle event type.\n /// \n /// The event type to listen for (use SessionLifecycleEventTypes constants).\n /// A callback function that receives events of the specified type.\n /// An IDisposable that, when disposed, unsubscribes the handler.\n /// \n /// \n /// using var subscription = client.On(SessionLifecycleEventTypes.Foreground, evt =>\n /// {\n /// Console.WriteLine($\"Session {evt.SessionId} is now in foreground\");\n /// });\n /// \n /// \n public IDisposable On(string eventType, Action handler)\n {\n lock (_lifecycleHandlersLock)\n {\n if (!_typedLifecycleHandlers.TryGetValue(eventType, out var handlers))\n {\n handlers = [];\n _typedLifecycleHandlers[eventType] = handlers;\n }\n handlers.Add(handler);\n }\n\n return new ActionDisposable(() =>\n {\n lock (_lifecycleHandlersLock)\n {\n if (_typedLifecycleHandlers.TryGetValue(eventType, out var handlers))\n {\n handlers.Remove(handler);\n }\n }\n });\n }\n\n private void DispatchLifecycleEvent(SessionLifecycleEvent evt)\n {\n List> typedHandlers;\n List> wildcardHandlers;\n\n lock (_lifecycleHandlersLock)\n {\n typedHandlers = _typedLifecycleHandlers.TryGetValue(evt.Type, out var handlers)\n ? [.. handlers]\n : [];\n wildcardHandlers = [.. _lifecycleHandlers];\n }\n\n foreach (var handler in typedHandlers)\n {\n try { handler(evt); } catch { /* Ignore handler errors */ }\n }\n\n foreach (var handler in wildcardHandlers)\n {\n try { handler(evt); } catch { /* Ignore handler errors */ }\n }\n }\n\n internal static async Task InvokeRpcAsync(JsonRpc rpc, string method, object?[]? args, CancellationToken cancellationToken)\n {\n return await InvokeRpcAsync(rpc, method, args, null, cancellationToken);\n }\n\n internal static async Task InvokeRpcAsync(JsonRpc rpc, string method, object?[]? args, CancellationToken cancellationToken)\n {\n await InvokeRpcAsync(rpc, method, args, null, cancellationToken);\n }\n\n internal static async Task InvokeRpcAsync(JsonRpc rpc, string method, object?[]? args, StringBuilder? stderrBuffer, CancellationToken cancellationToken)\n {\n try\n {\n return await rpc.InvokeAsync(method, args, cancellationToken);\n }\n catch (ConnectionLostException ex)\n {\n string? stderrOutput = null;\n if (stderrBuffer is not null)\n {\n lock (stderrBuffer)\n {\n stderrOutput = stderrBuffer.ToString().Trim();\n }\n }\n\n if (!string.IsNullOrEmpty(stderrOutput))\n {\n throw new IOException($\"CLI process exited unexpectedly.\\nstderr: {stderrOutput}\", ex);\n }\n throw new IOException($\"Communication error with Copilot CLI: {ex.Message}\", ex);\n }\n catch (RemoteRpcException ex)\n {\n throw new IOException($\"Communication error with Copilot CLI: {ex.Message}\", ex);\n }\n }\n\n private Task EnsureConnectedAsync(CancellationToken cancellationToken)\n {\n if (_connectionTask is null && !_options.AutoStart)\n {\n throw new InvalidOperationException($\"Client not connected. Call {nameof(StartAsync)}() first.\");\n }\n\n // If already started or starting, this will return the existing task\n return (Task)StartAsync(cancellationToken);\n }\n\n private async Task ConfigureSessionFsAsync(CancellationToken cancellationToken)\n {\n if (_options.SessionFs is null)\n {\n return;\n }\n\n await Rpc.SessionFs.SetProviderAsync(\n _options.SessionFs.InitialCwd,\n _options.SessionFs.SessionStatePath,\n _options.SessionFs.Conventions,\n cancellationToken);\n }\n\n private void ConfigureSessionFsHandlers(CopilotSession session, Func? createSessionFsHandler)\n {\n if (_options.SessionFs is null)\n {\n return;\n }\n\n if (createSessionFsHandler is null)\n {\n throw new InvalidOperationException(\n \"CreateSessionFsHandler is required in the session config when CopilotClientOptions.SessionFs is configured.\");\n }\n\n session.ClientSessionApis.SessionFs = createSessionFsHandler(session)\n ?? throw new InvalidOperationException(\"CreateSessionFsHandler returned null.\");\n }\n\n private async Task VerifyProtocolVersionAsync(Connection connection, CancellationToken cancellationToken)\n {\n var maxVersion = SdkProtocolVersion.GetVersion();\n var pingResponse = await InvokeRpcAsync(\n connection.Rpc, \"ping\", [new PingRequest()], connection.StderrBuffer, cancellationToken);\n\n if (!pingResponse.ProtocolVersion.HasValue)\n {\n throw new InvalidOperationException(\n $\"SDK protocol version mismatch: SDK supports versions {MinProtocolVersion}-{maxVersion}, \" +\n $\"but server does not report a protocol version. \" +\n $\"Please update your server to ensure compatibility.\");\n }\n\n var serverVersion = pingResponse.ProtocolVersion.Value;\n if (serverVersion < MinProtocolVersion || serverVersion > maxVersion)\n {\n throw new InvalidOperationException(\n $\"SDK protocol version mismatch: SDK supports versions {MinProtocolVersion}-{maxVersion}, \" +\n $\"but server reports version {serverVersion}. \" +\n $\"Please update your SDK or server to ensure compatibility.\");\n }\n\n _negotiatedProtocolVersion = serverVersion;\n }\n\n private static async Task<(Process Process, int? DetectedLocalhostTcpPort, StringBuilder StderrBuffer)> StartCliServerAsync(CopilotClientOptions options, ILogger logger, CancellationToken cancellationToken)\n {\n // Use explicit path, COPILOT_CLI_PATH env var (from options.Environment or process env), or bundled CLI - no PATH fallback\n var envCliPath = options.Environment is not null && options.Environment.TryGetValue(\"COPILOT_CLI_PATH\", out var envValue) ? envValue\n : System.Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\");\n var cliPath = options.CliPath\n ?? envCliPath\n ?? GetBundledCliPath(out var searchedPath)\n ?? throw new InvalidOperationException($\"Copilot CLI not found at '{searchedPath}'. Ensure the SDK NuGet package was restored correctly or provide an explicit CliPath.\");\n var args = new List();\n\n if (options.CliArgs != null)\n {\n args.AddRange(options.CliArgs);\n }\n\n args.AddRange([\"--headless\", \"--no-auto-update\", \"--log-level\", options.LogLevel]);\n\n if (options.UseStdio)\n {\n args.Add(\"--stdio\");\n }\n else if (options.Port > 0)\n {\n args.AddRange([\"--port\", options.Port.ToString(CultureInfo.InvariantCulture)]);\n }\n\n // Add auth-related flags\n if (!string.IsNullOrEmpty(options.GitHubToken))\n {\n args.AddRange([\"--auth-token-env\", \"COPILOT_SDK_AUTH_TOKEN\"]);\n }\n\n // Default UseLoggedInUser to false when GitHubToken is provided\n var useLoggedInUser = options.UseLoggedInUser ?? string.IsNullOrEmpty(options.GitHubToken);\n if (!useLoggedInUser)\n {\n args.Add(\"--no-auto-login\");\n }\n\n if (options.SessionIdleTimeoutSeconds is > 0)\n {\n args.AddRange([\"--session-idle-timeout\", options.SessionIdleTimeoutSeconds.Value.ToString(CultureInfo.InvariantCulture)]);\n }\n\n var (fileName, processArgs) = ResolveCliCommand(cliPath, args);\n\n var startInfo = new ProcessStartInfo\n {\n FileName = fileName,\n Arguments = string.Join(\" \", processArgs.Select(ProcessArgumentEscaper.Escape)),\n UseShellExecute = false,\n RedirectStandardInput = options.UseStdio,\n RedirectStandardOutput = true,\n RedirectStandardError = true,\n WorkingDirectory = options.Cwd,\n CreateNoWindow = true\n };\n\n if (options.Environment != null)\n {\n startInfo.Environment.Clear();\n foreach (var (key, value) in options.Environment)\n {\n startInfo.Environment[key] = value;\n }\n }\n\n startInfo.Environment.Remove(\"NODE_DEBUG\");\n\n // Set auth token in environment if provided\n if (!string.IsNullOrEmpty(options.GitHubToken))\n {\n startInfo.Environment[\"COPILOT_SDK_AUTH_TOKEN\"] = options.GitHubToken;\n }\n\n // Set telemetry environment variables if configured\n if (options.Telemetry is { } telemetry)\n {\n startInfo.Environment[\"COPILOT_OTEL_ENABLED\"] = \"true\";\n if (telemetry.OtlpEndpoint is not null) startInfo.Environment[\"OTEL_EXPORTER_OTLP_ENDPOINT\"] = telemetry.OtlpEndpoint;\n if (telemetry.FilePath is not null) startInfo.Environment[\"COPILOT_OTEL_FILE_EXPORTER_PATH\"] = telemetry.FilePath;\n if (telemetry.ExporterType is not null) startInfo.Environment[\"COPILOT_OTEL_EXPORTER_TYPE\"] = telemetry.ExporterType;\n if (telemetry.SourceName is not null) startInfo.Environment[\"COPILOT_OTEL_SOURCE_NAME\"] = telemetry.SourceName;\n if (telemetry.CaptureContent is { } capture) startInfo.Environment[\"OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT\"] = capture ? \"true\" : \"false\";\n }\n\n var cliProcess = new Process { StartInfo = startInfo };\n cliProcess.Start();\n\n // Capture stderr for error messages and forward to logger\n var stderrBuffer = new StringBuilder();\n _ = Task.Run(async () =>\n {\n while (cliProcess != null && !cliProcess.HasExited)\n {\n var line = await cliProcess.StandardError.ReadLineAsync(cancellationToken);\n if (line != null)\n {\n lock (stderrBuffer)\n {\n stderrBuffer.AppendLine(line);\n }\n\n if (logger.IsEnabled(LogLevel.Debug))\n {\n logger.LogDebug(\"[CLI] {Line}\", line);\n }\n }\n }\n }, cancellationToken);\n\n var detectedLocalhostTcpPort = (int?)null;\n if (!options.UseStdio)\n {\n // Wait for port announcement\n using var cts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);\n cts.CancelAfter(TimeSpan.FromSeconds(30));\n\n while (!cts.Token.IsCancellationRequested)\n {\n var line = await cliProcess.StandardOutput.ReadLineAsync(cts.Token) ?? throw new IOException(\"CLI process exited unexpectedly\");\n if (ListeningOnPortRegex().Match(line) is { Success: true } match)\n {\n detectedLocalhostTcpPort = int.Parse(match.Groups[1].Value, CultureInfo.InvariantCulture);\n break;\n }\n }\n }\n\n return (cliProcess, detectedLocalhostTcpPort, stderrBuffer);\n }\n\n private static string? GetBundledCliPath(out string searchedPath)\n {\n var binaryName = OperatingSystem.IsWindows() ? \"copilot.exe\" : \"copilot\";\n // Always use portable RID (e.g., linux-x64) to match the build-time placement,\n // since distro-specific RIDs (e.g., ubuntu.24.04-x64) are normalized at build time.\n var rid = GetPortableRid()\n ?? Path.GetFileName(System.Runtime.InteropServices.RuntimeInformation.RuntimeIdentifier);\n searchedPath = Path.Combine(AppContext.BaseDirectory, \"runtimes\", rid, \"native\", binaryName);\n return File.Exists(searchedPath) ? searchedPath : null;\n }\n\n private static string? GetPortableRid()\n {\n string os;\n if (OperatingSystem.IsWindows()) os = \"win\";\n else if (OperatingSystem.IsLinux()) os = \"linux\";\n else if (OperatingSystem.IsMacOS()) os = \"osx\";\n else return null;\n\n var arch = System.Runtime.InteropServices.RuntimeInformation.OSArchitecture switch\n {\n System.Runtime.InteropServices.Architecture.X64 => \"x64\",\n System.Runtime.InteropServices.Architecture.Arm64 => \"arm64\",\n _ => null,\n };\n\n return arch != null ? $\"{os}-{arch}\" : null;\n }\n\n private static (string FileName, IEnumerable Args) ResolveCliCommand(string cliPath, IEnumerable args)\n {\n var isJsFile = cliPath.EndsWith(\".js\", StringComparison.OrdinalIgnoreCase);\n\n if (isJsFile)\n {\n return (\"node\", new[] { cliPath }.Concat(args));\n }\n\n return (cliPath, args);\n }\n\n private async Task ConnectToServerAsync(Process? cliProcess, string? tcpHost, int? tcpPort, StringBuilder? stderrBuffer, CancellationToken cancellationToken)\n {\n Stream inputStream, outputStream;\n NetworkStream? networkStream = null;\n\n if (_options.UseStdio)\n {\n if (cliProcess == null)\n {\n throw new InvalidOperationException(\"CLI process not started\");\n }\n\n inputStream = cliProcess.StandardOutput.BaseStream;\n outputStream = cliProcess.StandardInput.BaseStream;\n }\n else\n {\n if (tcpHost is null || tcpPort is null)\n {\n throw new InvalidOperationException(\"Cannot connect because TCP host or port are not available\");\n }\n\n var socket = new Socket(SocketType.Stream, ProtocolType.Tcp);\n try\n {\n await socket.ConnectAsync(tcpHost, tcpPort.Value, cancellationToken);\n }\n catch\n {\n socket.Dispose();\n throw;\n }\n\n inputStream = outputStream = networkStream = new NetworkStream(socket, ownsSocket: true);\n }\n\n var rpc = new JsonRpc(\n outputStream,\n inputStream,\n SerializerOptionsForMessageFormatter,\n _logger);\n\n var handler = new RpcHandler(this);\n rpc.SetLocalRpcMethod(\"session.event\", handler.OnSessionEvent);\n rpc.SetLocalRpcMethod(\"session.lifecycle\", handler.OnSessionLifecycle);\n // Protocol v3 servers send tool calls / permission requests as broadcast events.\n // Protocol v2 servers use the older tool.call / permission.request RPC model.\n // We always register v2 adapters because handlers are set up before version\n // negotiation; a v3 server will simply never send these requests.\n rpc.SetLocalRpcMethod(\"tool.call\", handler.OnToolCallV2);\n rpc.SetLocalRpcMethod(\"permission.request\", handler.OnPermissionRequestV2);\n rpc.SetLocalRpcMethod(\"userInput.request\", handler.OnUserInputRequest);\n rpc.SetLocalRpcMethod(\"hooks.invoke\", handler.OnHooksInvoke);\n rpc.SetLocalRpcMethod(\"systemMessage.transform\", handler.OnSystemMessageTransform);\n ClientSessionApiRegistration.RegisterClientSessionApiHandlers(rpc, sessionId =>\n {\n var session = GetSession(sessionId) ?? throw new ArgumentException($\"Unknown session {sessionId}\");\n return session.ClientSessionApis;\n });\n rpc.StartListening();\n\n // Transition state to Disconnected if the JSON-RPC connection drops\n _ = rpc.Completion.ContinueWith(_ => _disconnected = true, CancellationToken.None, TaskContinuationOptions.ExecuteSynchronously, TaskScheduler.Default);\n\n _serverRpc = new ServerRpc(rpc);\n\n return new Connection(rpc, cliProcess, networkStream, stderrBuffer);\n }\n\n private static JsonSerializerOptions SerializerOptionsForMessageFormatter { get; } = CreateSerializerOptions();\n\n private static JsonSerializerOptions CreateSerializerOptions()\n {\n var options = new JsonSerializerOptions(JsonSerializerDefaults.Web)\n {\n AllowOutOfOrderMetadataProperties = true,\n DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull\n };\n\n options.TypeInfoResolverChain.Add(ClientJsonContext.Default);\n options.TypeInfoResolverChain.Add(TypesJsonContext.Default);\n options.TypeInfoResolverChain.Add(CopilotSession.SessionJsonContext.Default);\n options.TypeInfoResolverChain.Add(SessionEventsJsonContext.Default);\n options.TypeInfoResolverChain.Add(SDK.Rpc.RpcJsonContext.Default);\n\n options.MakeReadOnly();\n\n return options;\n }\n\n internal CopilotSession? GetSession(string sessionId)\n {\n return _sessions.TryGetValue(sessionId, out var session) ? session : null;\n }\n\n /// \n /// Disposes the synchronously.\n /// \n /// \n /// Prefer using for better performance in async contexts.\n /// \n public void Dispose()\n {\n DisposeAsync().AsTask().GetAwaiter().GetResult();\n }\n\n /// \n /// Disposes the asynchronously.\n /// \n /// A representing the asynchronous dispose operation.\n /// \n /// This method calls to immediately release all resources.\n /// \n public async ValueTask DisposeAsync()\n {\n if (_disposed) return;\n _disposed = true;\n await ForceStopAsync();\n }\n\n private class RpcHandler(CopilotClient client)\n {\n public void OnSessionEvent(string sessionId, JsonElement? @event)\n {\n var session = client.GetSession(sessionId);\n if (session != null && @event != null)\n {\n var evt = SessionEvent.FromJson(@event.Value.GetRawText());\n if (evt != null)\n {\n session.DispatchEvent(evt);\n }\n }\n }\n\n public void OnSessionLifecycle(string type, string sessionId, JsonElement? metadata)\n {\n var evt = new SessionLifecycleEvent\n {\n Type = type,\n SessionId = sessionId\n };\n\n if (metadata != null)\n {\n evt.Metadata = JsonSerializer.Deserialize(\n metadata.Value.GetRawText(),\n TypesJsonContext.Default.SessionLifecycleEventMetadata);\n }\n\n client.DispatchLifecycleEvent(evt);\n }\n\n public async ValueTask OnUserInputRequest(string sessionId, string question, IList? choices = null, bool? allowFreeform = null)\n {\n var session = client.GetSession(sessionId) ?? throw new ArgumentException($\"Unknown session {sessionId}\");\n var request = new UserInputRequest\n {\n Question = question,\n Choices = choices,\n AllowFreeform = allowFreeform\n };\n\n var result = await session.HandleUserInputRequestAsync(request);\n return new UserInputRequestResponse(result.Answer, result.WasFreeform);\n }\n\n public async ValueTask OnHooksInvoke(string sessionId, string hookType, JsonElement input)\n {\n var session = client.GetSession(sessionId) ?? throw new ArgumentException($\"Unknown session {sessionId}\");\n var output = await session.HandleHooksInvokeAsync(hookType, input);\n return new HooksInvokeResponse(output);\n }\n\n public async ValueTask OnSystemMessageTransform(string sessionId, JsonElement sections)\n {\n var session = client.GetSession(sessionId) ?? throw new ArgumentException($\"Unknown session {sessionId}\");\n return await session.HandleSystemMessageTransformAsync(sections);\n }\n\n // Protocol v2 backward-compatibility adapters\n\n public async ValueTask OnToolCallV2(string sessionId,\n string toolCallId,\n string toolName,\n object? arguments,\n string? traceparent = null,\n string? tracestate = null)\n {\n using var _ = TelemetryHelpers.RestoreTraceContext(traceparent, tracestate);\n\n var session = client.GetSession(sessionId) ?? throw new ArgumentException($\"Unknown session {sessionId}\");\n if (session.GetTool(toolName) is not { } tool)\n {\n return new ToolCallResponseV2(new ToolResultObject\n {\n TextResultForLlm = $\"Tool '{toolName}' is not supported.\",\n ResultType = \"failure\",\n Error = $\"tool '{toolName}' not supported\"\n });\n }\n\n try\n {\n var invocation = new ToolInvocation\n {\n SessionId = sessionId,\n ToolCallId = toolCallId,\n ToolName = toolName,\n Arguments = arguments\n };\n\n var aiFunctionArgs = new AIFunctionArguments\n {\n Context = new Dictionary\n {\n [typeof(ToolInvocation)] = invocation\n }\n };\n\n if (arguments is not null)\n {\n if (arguments is not JsonElement incomingJsonArgs)\n {\n throw new InvalidOperationException($\"Incoming arguments must be a {nameof(JsonElement)}; received {arguments.GetType().Name}\");\n }\n\n foreach (var prop in incomingJsonArgs.EnumerateObject())\n {\n aiFunctionArgs[prop.Name] = prop.Value;\n }\n }\n\n var result = await tool.InvokeAsync(aiFunctionArgs);\n\n var toolResultObject = ToolResultObject.ConvertFromInvocationResult(result, tool.JsonSerializerOptions);\n return new ToolCallResponseV2(toolResultObject);\n }\n catch (Exception ex)\n {\n return new ToolCallResponseV2(new ToolResultObject\n {\n TextResultForLlm = \"Invoking this tool produced an error. Detailed information is not available.\",\n ResultType = \"failure\",\n Error = ex.Message\n });\n }\n }\n\n public async ValueTask OnPermissionRequestV2(string sessionId, JsonElement permissionRequest)\n {\n var session = client.GetSession(sessionId)\n ?? throw new ArgumentException($\"Unknown session {sessionId}\");\n\n try\n {\n var result = await session.HandlePermissionRequestAsync(permissionRequest);\n if (result.Kind == new PermissionRequestResultKind(\"no-result\"))\n {\n throw new InvalidOperationException(NoResultPermissionV2ErrorMessage);\n }\n return new PermissionRequestResponseV2(result);\n }\n catch (InvalidOperationException ex) when (ex.Message == NoResultPermissionV2ErrorMessage)\n {\n throw;\n }\n catch (Exception)\n {\n return new PermissionRequestResponseV2(new PermissionRequestResult\n {\n Kind = PermissionRequestResultKind.UserNotAvailable\n });\n }\n }\n }\n\n private class Connection(\n JsonRpc rpc,\n Process? cliProcess, // Set if we created the child process\n NetworkStream? networkStream, // Set if using TCP\n StringBuilder? stderrBuffer = null) // Captures stderr for error messages\n {\n public Process? CliProcess => cliProcess;\n public JsonRpc Rpc => rpc;\n public NetworkStream? NetworkStream => networkStream;\n public StringBuilder? StderrBuffer => stderrBuffer;\n }\n\n private static class ProcessArgumentEscaper\n {\n public static string Escape(string arg)\n {\n if (string.IsNullOrEmpty(arg)) return \"\\\"\\\"\";\n if (!arg.Contains(' ') && !arg.Contains('\"')) return arg;\n return \"\\\"\" + arg.Replace(\"\\\"\", \"\\\\\\\"\") + \"\\\"\";\n }\n }\n\n // Request/Response types for RPC\n internal record CreateSessionRequest(\n string? Model,\n string? SessionId,\n string? ClientName,\n string? ReasoningEffort,\n IList? Tools,\n SystemMessageConfig? SystemMessage,\n IList? AvailableTools,\n IList? ExcludedTools,\n ProviderConfig? Provider,\n bool? RequestPermission,\n bool? RequestUserInput,\n bool? Hooks,\n string? WorkingDirectory,\n bool? Streaming,\n bool? IncludeSubAgentStreamingEvents,\n IDictionary? McpServers,\n string? EnvValueMode,\n IList? CustomAgents,\n DefaultAgentConfig? DefaultAgent,\n string? Agent,\n string? ConfigDir,\n bool? EnableConfigDiscovery,\n IList? SkillDirectories,\n IList? DisabledSkills,\n InfiniteSessionConfig? InfiniteSessions,\n IList? Commands = null,\n bool? RequestElicitation = null,\n string? Traceparent = null,\n string? Tracestate = null,\n ModelCapabilitiesOverride? ModelCapabilities = null,\n string? GitHubToken = null);\n\n internal record ToolDefinition(\n string Name,\n string? Description,\n JsonElement Parameters, /* JSON schema */\n bool? OverridesBuiltInTool = null,\n bool? SkipPermission = null)\n {\n public static ToolDefinition FromAIFunction(AIFunction function)\n {\n var overrides = function.AdditionalProperties.TryGetValue(\"is_override\", out var val) && val is true;\n var skipPerm = function.AdditionalProperties.TryGetValue(\"skip_permission\", out var skipVal) && skipVal is true;\n return new ToolDefinition(function.Name, function.Description, function.JsonSchema,\n overrides ? true : null,\n skipPerm ? true : null);\n }\n }\n\n internal record CreateSessionResponse(\n string SessionId,\n string? WorkspacePath,\n SessionCapabilities? Capabilities = null);\n\n internal record ResumeSessionRequest(\n string SessionId,\n string? ClientName,\n string? Model,\n string? ReasoningEffort,\n IList? Tools,\n SystemMessageConfig? SystemMessage,\n IList? AvailableTools,\n IList? ExcludedTools,\n ProviderConfig? Provider,\n bool? RequestPermission,\n bool? RequestUserInput,\n bool? Hooks,\n string? WorkingDirectory,\n string? ConfigDir,\n bool? EnableConfigDiscovery,\n bool? DisableResume,\n bool? Streaming,\n bool? IncludeSubAgentStreamingEvents,\n IDictionary? McpServers,\n string? EnvValueMode,\n IList? CustomAgents,\n DefaultAgentConfig? DefaultAgent,\n string? Agent,\n IList? SkillDirectories,\n IList? DisabledSkills,\n InfiniteSessionConfig? InfiniteSessions,\n IList? Commands = null,\n bool? RequestElicitation = null,\n string? Traceparent = null,\n string? Tracestate = null,\n ModelCapabilitiesOverride? ModelCapabilities = null,\n string? GitHubToken = null,\n bool? ContinuePendingWork = null);\n\n internal record ResumeSessionResponse(\n string SessionId,\n string? WorkspacePath,\n SessionCapabilities? Capabilities = null);\n\n internal record CommandWireDefinition(\n string Name,\n string? Description);\n\n internal record GetLastSessionIdResponse(\n string? SessionId);\n\n internal record DeleteSessionRequest(\n string SessionId);\n\n internal record DeleteSessionResponse(\n bool Success,\n string? Error);\n\n internal record ListSessionsRequest(\n SessionListFilter? Filter);\n\n internal record ListSessionsResponse(\n List Sessions);\n\n internal record GetSessionMetadataRequest(\n string SessionId);\n\n internal record GetSessionMetadataResponse(\n SessionMetadata? Session);\n\n internal record SetForegroundSessionRequest(\n string SessionId);\n\n internal record UserInputRequestResponse(\n string Answer,\n bool WasFreeform);\n\n internal record HooksInvokeResponse(\n object? Output);\n\n // Protocol v2 backward-compatibility response types\n internal record ToolCallResponseV2(\n ToolResultObject Result);\n\n internal record PermissionRequestResponseV2(\n PermissionRequestResult Result);\n\n [JsonSourceGenerationOptions(\n JsonSerializerDefaults.Web,\n AllowOutOfOrderMetadataProperties = true,\n NumberHandling = JsonNumberHandling.AllowReadingFromString,\n DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonSerializable(typeof(CreateSessionRequest))]\n [JsonSerializable(typeof(CreateSessionResponse))]\n [JsonSerializable(typeof(CustomAgentConfig))]\n [JsonSerializable(typeof(DeleteSessionRequest))]\n [JsonSerializable(typeof(DeleteSessionResponse))]\n [JsonSerializable(typeof(GetLastSessionIdResponse))]\n [JsonSerializable(typeof(HooksInvokeResponse))]\n [JsonSerializable(typeof(ListSessionsRequest))]\n [JsonSerializable(typeof(ListSessionsResponse))]\n [JsonSerializable(typeof(GetSessionMetadataRequest))]\n [JsonSerializable(typeof(GetSessionMetadataResponse))]\n [JsonSerializable(typeof(ModelCapabilitiesOverride))]\n [JsonSerializable(typeof(PermissionRequestResult))]\n [JsonSerializable(typeof(PermissionRequestResultKind))]\n [JsonSerializable(typeof(PermissionRequestResponseV2))]\n [JsonSerializable(typeof(ProviderConfig))]\n [JsonSerializable(typeof(ResumeSessionRequest))]\n [JsonSerializable(typeof(ResumeSessionResponse))]\n [JsonSerializable(typeof(SessionCapabilities))]\n [JsonSerializable(typeof(SessionUiCapabilities))]\n [JsonSerializable(typeof(SessionMetadata))]\n [JsonSerializable(typeof(SetForegroundSessionRequest))]\n [JsonSerializable(typeof(SystemMessageConfig))]\n [JsonSerializable(typeof(SystemMessageTransformRpcResponse))]\n [JsonSerializable(typeof(CommandWireDefinition))]\n [JsonSerializable(typeof(ToolCallResponseV2))]\n [JsonSerializable(typeof(ToolDefinition))]\n [JsonSerializable(typeof(ToolResultAIContent))]\n [JsonSerializable(typeof(ToolResultObject))]\n [JsonSerializable(typeof(UserInputRequestResponse))]\n [JsonSerializable(typeof(UserInputRequest))]\n [JsonSerializable(typeof(UserInputResponse))]\n internal partial class ClientJsonContext : JsonSerializerContext;\n\n [GeneratedRegex(@\"listening on port ([0-9]+)\", RegexOptions.IgnoreCase)]\n private static partial Regex ListeningOnPortRegex();\n}\n\n/// \n/// Wraps a as to pass structured tool results\n/// back through Microsoft.Extensions.AI without JSON serialization.\n/// \n/// The tool result to wrap.\npublic class ToolResultAIContent(ToolResultObject toolResult) : AIContent\n{\n /// \n /// Gets the underlying .\n /// \n public ToolResultObject Result => toolResult;\n}\n" }, { "path": "dotnet/src/Generated/Rpc.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\n// AUTO-GENERATED FILE - DO NOT EDIT\n// Generated from: api.schema.json\n\n#pragma warning disable CS0612 // Type or member is obsolete\n#pragma warning disable CS0618 // Type or member is obsolete (with message)\n\nusing System.ComponentModel.DataAnnotations;\nusing System.Diagnostics.CodeAnalysis;\nusing System.Text.Json;\nusing System.Text.Json.Serialization;\n\nnamespace GitHub.Copilot.SDK.Rpc;\n\n/// Diagnostic IDs for the Copilot SDK.\ninternal static class Diagnostics\n{\n /// Indicates an experimental API that may change or be removed.\n internal const string Experimental = \"GHCP001\";\n}\n\n/// RPC data type for Ping operations.\npublic sealed class PingResult\n{\n /// Echoed message (or default greeting).\n [JsonPropertyName(\"message\")]\n public string Message { get; set; } = string.Empty;\n\n /// Server protocol version number.\n [JsonPropertyName(\"protocolVersion\")]\n public long ProtocolVersion { get; set; }\n\n /// Server timestamp in milliseconds.\n [JsonPropertyName(\"timestamp\")]\n public long Timestamp { get; set; }\n}\n\n/// RPC data type for Ping operations.\ninternal sealed class PingRequest\n{\n /// Optional message to echo back.\n [JsonPropertyName(\"message\")]\n public string? Message { get; set; }\n}\n\n/// Billing information.\npublic sealed class ModelBilling\n{\n /// Billing cost multiplier relative to the base rate.\n [JsonPropertyName(\"multiplier\")]\n public double Multiplier { get; set; }\n}\n\n/// Vision-specific limits.\npublic sealed class ModelCapabilitiesLimitsVision\n{\n /// Maximum image size in bytes.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"max_prompt_image_size\")]\n public long MaxPromptImageSize { get; set; }\n\n /// Maximum number of images per prompt.\n [Range((double)1, (double)long.MaxValue)]\n [JsonPropertyName(\"max_prompt_images\")]\n public long MaxPromptImages { get; set; }\n\n /// MIME types the model accepts.\n [JsonPropertyName(\"supported_media_types\")]\n public IList SupportedMediaTypes { get => field ??= []; set; }\n}\n\n/// Token limits for prompts, outputs, and context window.\npublic sealed class ModelCapabilitiesLimits\n{\n /// Maximum total context window size in tokens.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"max_context_window_tokens\")]\n public long? MaxContextWindowTokens { get; set; }\n\n /// Maximum number of output/completion tokens.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"max_output_tokens\")]\n public long? MaxOutputTokens { get; set; }\n\n /// Maximum number of prompt/input tokens.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"max_prompt_tokens\")]\n public long? MaxPromptTokens { get; set; }\n\n /// Vision-specific limits.\n [JsonPropertyName(\"vision\")]\n public ModelCapabilitiesLimitsVision? Vision { get; set; }\n}\n\n/// Feature flags indicating what the model supports.\npublic sealed class ModelCapabilitiesSupports\n{\n /// Whether this model supports reasoning effort configuration.\n [JsonPropertyName(\"reasoningEffort\")]\n public bool? ReasoningEffort { get; set; }\n\n /// Whether this model supports vision/image input.\n [JsonPropertyName(\"vision\")]\n public bool? Vision { get; set; }\n}\n\n/// Model capabilities and limits.\npublic sealed class ModelCapabilities\n{\n /// Token limits for prompts, outputs, and context window.\n [JsonPropertyName(\"limits\")]\n public ModelCapabilitiesLimits? Limits { get; set; }\n\n /// Feature flags indicating what the model supports.\n [JsonPropertyName(\"supports\")]\n public ModelCapabilitiesSupports? Supports { get; set; }\n}\n\n/// Policy state (if applicable).\npublic sealed class ModelPolicy\n{\n /// Current policy state for this model.\n [JsonPropertyName(\"state\")]\n public string State { get; set; } = string.Empty;\n\n /// Usage terms or conditions for this model.\n [JsonPropertyName(\"terms\")]\n public string? Terms { get; set; }\n}\n\n/// RPC data type for Model operations.\npublic sealed class Model\n{\n /// Billing information.\n [JsonPropertyName(\"billing\")]\n public ModelBilling? Billing { get; set; }\n\n /// Model capabilities and limits.\n [JsonPropertyName(\"capabilities\")]\n public ModelCapabilities Capabilities { get => field ??= new(); set; }\n\n /// Default reasoning effort level (only present if model supports reasoning effort).\n [JsonPropertyName(\"defaultReasoningEffort\")]\n public string? DefaultReasoningEffort { get; set; }\n\n /// Model identifier (e.g., \"claude-sonnet-4.5\").\n [JsonPropertyName(\"id\")]\n public string Id { get; set; } = string.Empty;\n\n /// Display name.\n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n\n /// Policy state (if applicable).\n [JsonPropertyName(\"policy\")]\n public ModelPolicy? Policy { get; set; }\n\n /// Supported reasoning effort levels (only present if model supports reasoning effort).\n [JsonPropertyName(\"supportedReasoningEfforts\")]\n public IList? SupportedReasoningEfforts { get; set; }\n}\n\n/// RPC data type for ModelList operations.\npublic sealed class ModelList\n{\n /// List of available models with full metadata.\n [JsonPropertyName(\"models\")]\n public IList Models { get => field ??= []; set; }\n}\n\n/// RPC data type for ModelsList operations.\ninternal sealed class ModelsListRequest\n{\n /// GitHub token for per-user model listing. When provided, resolves this token to determine the user's Copilot plan and available models instead of using the global auth.\n [JsonPropertyName(\"gitHubToken\")]\n public string? GitHubToken { get; set; }\n}\n\n/// RPC data type for Tool operations.\npublic sealed class Tool\n{\n /// Description of what the tool does.\n [JsonPropertyName(\"description\")]\n public string Description { get; set; } = string.Empty;\n\n /// Optional instructions for how to use this tool effectively.\n [JsonPropertyName(\"instructions\")]\n public string? Instructions { get; set; }\n\n /// Tool identifier (e.g., \"bash\", \"grep\", \"str_replace_editor\").\n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n\n /// Optional namespaced name for declarative filtering (e.g., \"playwright/navigate\" for MCP tools).\n [JsonPropertyName(\"namespacedName\")]\n public string? NamespacedName { get; set; }\n\n /// JSON Schema for the tool's input parameters.\n [JsonPropertyName(\"parameters\")]\n public IDictionary? Parameters { get; set; }\n}\n\n/// RPC data type for ToolList operations.\npublic sealed class ToolList\n{\n /// List of available built-in tools with metadata.\n [JsonPropertyName(\"tools\")]\n public IList Tools { get => field ??= []; set; }\n}\n\n/// RPC data type for ToolsList operations.\ninternal sealed class ToolsListRequest\n{\n /// Optional model ID — when provided, the returned tool list reflects model-specific overrides.\n [JsonPropertyName(\"model\")]\n public string? Model { get; set; }\n}\n\n/// RPC data type for AccountQuotaSnapshot operations.\npublic sealed class AccountQuotaSnapshot\n{\n /// Number of requests included in the entitlement.\n [JsonPropertyName(\"entitlementRequests\")]\n public long EntitlementRequests { get; set; }\n\n /// Whether the user has an unlimited usage entitlement.\n [JsonPropertyName(\"isUnlimitedEntitlement\")]\n public bool IsUnlimitedEntitlement { get; set; }\n\n /// Number of overage requests made this period.\n [Range(0, double.MaxValue)]\n [JsonPropertyName(\"overage\")]\n public double Overage { get; set; }\n\n /// Whether overage is allowed when quota is exhausted.\n [JsonPropertyName(\"overageAllowedWithExhaustedQuota\")]\n public bool OverageAllowedWithExhaustedQuota { get; set; }\n\n /// Percentage of entitlement remaining.\n [JsonPropertyName(\"remainingPercentage\")]\n public double RemainingPercentage { get; set; }\n\n /// Date when the quota resets (ISO 8601 string).\n [JsonPropertyName(\"resetDate\")]\n public string? ResetDate { get; set; }\n\n /// Whether usage is still permitted after quota exhaustion.\n [JsonPropertyName(\"usageAllowedWithExhaustedQuota\")]\n public bool UsageAllowedWithExhaustedQuota { get; set; }\n\n /// Number of requests used so far this period.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"usedRequests\")]\n public long UsedRequests { get; set; }\n}\n\n/// RPC data type for AccountGetQuota operations.\npublic sealed class AccountGetQuotaResult\n{\n /// Quota snapshots keyed by type (e.g., chat, completions, premium_interactions).\n [JsonPropertyName(\"quotaSnapshots\")]\n public IDictionary QuotaSnapshots { get => field ??= new Dictionary(); set; }\n}\n\n/// RPC data type for AccountGetQuota operations.\ninternal sealed class AccountGetQuotaRequest\n{\n /// GitHub token for per-user quota lookup. When provided, resolves this token to determine the user's quota instead of using the global auth.\n [JsonPropertyName(\"gitHubToken\")]\n public string? GitHubToken { get; set; }\n}\n\n/// RPC data type for DiscoveredMcpServer operations.\npublic sealed class DiscoveredMcpServer\n{\n /// Whether the server is enabled (not in the disabled list).\n [JsonPropertyName(\"enabled\")]\n public bool Enabled { get; set; }\n\n /// Server name (config key).\n [RegularExpression(\"^[^\\\\x00-\\\\x1f/\\\\x7f-\\\\x9f}]+(?:\\\\/[^\\\\x00-\\\\x1f/\\\\x7f-\\\\x9f}]+)*$\")]\n [UnconditionalSuppressMessage(\"Trimming\", \"IL2026\", Justification = \"Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members\")]\n [MinLength(1)]\n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n\n /// Configuration source.\n [JsonPropertyName(\"source\")]\n public DiscoveredMcpServerSource Source { get; set; }\n\n /// Server transport type: stdio, http, sse, or memory (local configs are normalized to stdio).\n [JsonPropertyName(\"type\")]\n public DiscoveredMcpServerType? Type { get; set; }\n}\n\n/// RPC data type for McpDiscover operations.\npublic sealed class McpDiscoverResult\n{\n /// MCP servers discovered from all sources.\n [JsonPropertyName(\"servers\")]\n public IList Servers { get => field ??= []; set; }\n}\n\n/// RPC data type for McpDiscover operations.\ninternal sealed class McpDiscoverRequest\n{\n /// Working directory used as context for discovery (e.g., plugin resolution).\n [JsonPropertyName(\"workingDirectory\")]\n public string? WorkingDirectory { get; set; }\n}\n\n/// RPC data type for McpConfigList operations.\npublic sealed class McpConfigList\n{\n /// All MCP servers from user config, keyed by name.\n [JsonPropertyName(\"servers\")]\n public IDictionary Servers { get => field ??= new Dictionary(); set; }\n}\n\n/// RPC data type for McpConfigAdd operations.\ninternal sealed class McpConfigAddRequest\n{\n /// MCP server configuration (local/stdio or remote/http).\n [JsonPropertyName(\"config\")]\n public object Config { get; set; } = null!;\n\n /// Unique name for the MCP server.\n [RegularExpression(\"^[^\\\\x00-\\\\x1f/\\\\x7f-\\\\x9f}]+(?:\\\\/[^\\\\x00-\\\\x1f/\\\\x7f-\\\\x9f}]+)*$\")]\n [UnconditionalSuppressMessage(\"Trimming\", \"IL2026\", Justification = \"Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members\")]\n [MinLength(1)]\n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n}\n\n/// RPC data type for McpConfigUpdate operations.\ninternal sealed class McpConfigUpdateRequest\n{\n /// MCP server configuration (local/stdio or remote/http).\n [JsonPropertyName(\"config\")]\n public object Config { get; set; } = null!;\n\n /// Name of the MCP server to update.\n [RegularExpression(\"^[^\\\\x00-\\\\x1f/\\\\x7f-\\\\x9f}]+(?:\\\\/[^\\\\x00-\\\\x1f/\\\\x7f-\\\\x9f}]+)*$\")]\n [UnconditionalSuppressMessage(\"Trimming\", \"IL2026\", Justification = \"Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members\")]\n [MinLength(1)]\n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n}\n\n/// RPC data type for McpConfigRemove operations.\ninternal sealed class McpConfigRemoveRequest\n{\n /// Name of the MCP server to remove.\n [RegularExpression(\"^[^\\\\x00-\\\\x1f/\\\\x7f-\\\\x9f}]+(?:\\\\/[^\\\\x00-\\\\x1f/\\\\x7f-\\\\x9f}]+)*$\")]\n [UnconditionalSuppressMessage(\"Trimming\", \"IL2026\", Justification = \"Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members\")]\n [MinLength(1)]\n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n}\n\n/// RPC data type for McpConfigEnable operations.\ninternal sealed class McpConfigEnableRequest\n{\n /// Names of MCP servers to enable. Each server is removed from the persisted disabled list so new sessions spawn it. Unknown or already-enabled names are ignored.\n [JsonPropertyName(\"names\")]\n public IList Names { get => field ??= []; set; }\n}\n\n/// RPC data type for McpConfigDisable operations.\ninternal sealed class McpConfigDisableRequest\n{\n /// Names of MCP servers to disable. Each server is added to the persisted disabled list so new sessions skip it. Already-disabled names are ignored. Active sessions keep their current connections until they end.\n [JsonPropertyName(\"names\")]\n public IList Names { get => field ??= []; set; }\n}\n\n/// RPC data type for ServerSkill operations.\npublic sealed class ServerSkill\n{\n /// Description of what the skill does.\n [JsonPropertyName(\"description\")]\n public string Description { get; set; } = string.Empty;\n\n /// Whether the skill is currently enabled (based on global config).\n [JsonPropertyName(\"enabled\")]\n public bool Enabled { get; set; }\n\n /// Unique identifier for the skill.\n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n\n /// Absolute path to the skill file.\n [JsonPropertyName(\"path\")]\n public string? Path { get; set; }\n\n /// The project path this skill belongs to (only for project/inherited skills).\n [JsonPropertyName(\"projectPath\")]\n public string? ProjectPath { get; set; }\n\n /// Source location type (e.g., project, personal-copilot, plugin, builtin).\n [JsonPropertyName(\"source\")]\n public string Source { get; set; } = string.Empty;\n\n /// Whether the skill can be invoked by the user as a slash command.\n [JsonPropertyName(\"userInvocable\")]\n public bool UserInvocable { get; set; }\n}\n\n/// RPC data type for ServerSkillList operations.\npublic sealed class ServerSkillList\n{\n /// All discovered skills across all sources.\n [JsonPropertyName(\"skills\")]\n public IList Skills { get => field ??= []; set; }\n}\n\n/// RPC data type for SkillsDiscover operations.\ninternal sealed class SkillsDiscoverRequest\n{\n /// Optional list of project directory paths to scan for project-scoped skills.\n [JsonPropertyName(\"projectPaths\")]\n public IList? ProjectPaths { get; set; }\n\n /// Optional list of additional skill directory paths to include.\n [JsonPropertyName(\"skillDirectories\")]\n public IList? SkillDirectories { get; set; }\n}\n\n/// RPC data type for SkillsConfigSetDisabledSkills operations.\ninternal sealed class SkillsConfigSetDisabledSkillsRequest\n{\n /// List of skill names to disable.\n [JsonPropertyName(\"disabledSkills\")]\n public IList DisabledSkills { get => field ??= []; set; }\n}\n\n/// RPC data type for SessionFsSetProvider operations.\npublic sealed class SessionFsSetProviderResult\n{\n /// Whether the provider was set successfully.\n [JsonPropertyName(\"success\")]\n public bool Success { get; set; }\n}\n\n/// RPC data type for SessionFsSetProvider operations.\ninternal sealed class SessionFsSetProviderRequest\n{\n /// Path conventions used by this filesystem.\n [JsonPropertyName(\"conventions\")]\n public SessionFsSetProviderConventions Conventions { get; set; }\n\n /// Initial working directory for sessions.\n [JsonPropertyName(\"initialCwd\")]\n public string InitialCwd { get; set; } = string.Empty;\n\n /// Path within each session's SessionFs where the runtime stores files for that session.\n [JsonPropertyName(\"sessionStatePath\")]\n public string SessionStatePath { get; set; } = string.Empty;\n}\n\n/// RPC data type for SessionsFork operations.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class SessionsForkResult\n{\n /// The new forked session's ID.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for SessionsFork operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class SessionsForkRequest\n{\n /// Source session ID to fork from.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n\n /// Optional event ID boundary. When provided, the fork includes only events before this ID (exclusive). When omitted, all events are included.\n [JsonPropertyName(\"toEventId\")]\n public string? ToEventId { get; set; }\n}\n\n/// RPC data type for SessionSuspend operations.\ninternal sealed class SessionSuspendRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for Log operations.\npublic sealed class LogResult\n{\n /// The unique identifier of the emitted session event.\n [JsonPropertyName(\"eventId\")]\n public Guid EventId { get; set; }\n}\n\n/// RPC data type for Log operations.\ninternal sealed class LogRequest\n{\n /// When true, the message is transient and not persisted to the session event log on disk.\n [JsonPropertyName(\"ephemeral\")]\n public bool? Ephemeral { get; set; }\n\n /// Log severity level. Determines how the message is displayed in the timeline. Defaults to \"info\".\n [JsonPropertyName(\"level\")]\n public SessionLogLevel? Level { get; set; }\n\n /// Human-readable message.\n [JsonPropertyName(\"message\")]\n public string Message { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n\n /// Optional URL the user can open in their browser for more details.\n [Url]\n [StringSyntax(StringSyntaxAttribute.Uri)]\n [JsonPropertyName(\"url\")]\n public string? Url { get; set; }\n}\n\n/// RPC data type for SessionAuthStatus operations.\npublic sealed class SessionAuthStatus\n{\n /// Authentication type.\n [JsonPropertyName(\"authType\")]\n public AuthInfoType? AuthType { get; set; }\n\n /// Copilot plan tier (e.g., individual_pro, business).\n [JsonPropertyName(\"copilotPlan\")]\n public string? CopilotPlan { get; set; }\n\n /// Authentication host URL.\n [JsonPropertyName(\"host\")]\n public string? Host { get; set; }\n\n /// Whether the session has resolved authentication.\n [JsonPropertyName(\"isAuthenticated\")]\n public bool IsAuthenticated { get; set; }\n\n /// Authenticated login/username, if available.\n [JsonPropertyName(\"login\")]\n public string? Login { get; set; }\n\n /// Human-readable authentication status description.\n [JsonPropertyName(\"statusMessage\")]\n public string? StatusMessage { get; set; }\n}\n\n/// RPC data type for SessionAuthGetStatus operations.\ninternal sealed class SessionAuthGetStatusRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for CurrentModel operations.\npublic sealed class CurrentModel\n{\n /// Currently active model identifier.\n [JsonPropertyName(\"modelId\")]\n public string? ModelId { get; set; }\n}\n\n/// RPC data type for SessionModelGetCurrent operations.\ninternal sealed class SessionModelGetCurrentRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for ModelSwitchTo operations.\npublic sealed class ModelSwitchToResult\n{\n /// Currently active model identifier after the switch.\n [JsonPropertyName(\"modelId\")]\n public string? ModelId { get; set; }\n}\n\n/// RPC data type for ModelCapabilitiesOverrideLimitsVision operations.\npublic sealed class ModelCapabilitiesOverrideLimitsVision\n{\n /// Maximum image size in bytes.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"max_prompt_image_size\")]\n public long? MaxPromptImageSize { get; set; }\n\n /// Maximum number of images per prompt.\n [Range((double)1, (double)long.MaxValue)]\n [JsonPropertyName(\"max_prompt_images\")]\n public long? MaxPromptImages { get; set; }\n\n /// MIME types the model accepts.\n [JsonPropertyName(\"supported_media_types\")]\n public IList? SupportedMediaTypes { get; set; }\n}\n\n/// Token limits for prompts, outputs, and context window.\npublic sealed class ModelCapabilitiesOverrideLimits\n{\n /// Maximum total context window size in tokens.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"max_context_window_tokens\")]\n public long? MaxContextWindowTokens { get; set; }\n\n /// Gets or sets the max_output_tokens value.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"max_output_tokens\")]\n public long? MaxOutputTokens { get; set; }\n\n /// Gets or sets the max_prompt_tokens value.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"max_prompt_tokens\")]\n public long? MaxPromptTokens { get; set; }\n\n /// Gets or sets the vision value.\n [JsonPropertyName(\"vision\")]\n public ModelCapabilitiesOverrideLimitsVision? Vision { get; set; }\n}\n\n/// Feature flags indicating what the model supports.\npublic sealed class ModelCapabilitiesOverrideSupports\n{\n /// Gets or sets the reasoningEffort value.\n [JsonPropertyName(\"reasoningEffort\")]\n public bool? ReasoningEffort { get; set; }\n\n /// Gets or sets the vision value.\n [JsonPropertyName(\"vision\")]\n public bool? Vision { get; set; }\n}\n\n/// Override individual model capabilities resolved by the runtime.\npublic sealed class ModelCapabilitiesOverride\n{\n /// Token limits for prompts, outputs, and context window.\n [JsonPropertyName(\"limits\")]\n public ModelCapabilitiesOverrideLimits? Limits { get; set; }\n\n /// Feature flags indicating what the model supports.\n [JsonPropertyName(\"supports\")]\n public ModelCapabilitiesOverrideSupports? Supports { get; set; }\n}\n\n/// RPC data type for ModelSwitchTo operations.\ninternal sealed class ModelSwitchToRequest\n{\n /// Override individual model capabilities resolved by the runtime.\n [JsonPropertyName(\"modelCapabilities\")]\n public ModelCapabilitiesOverride? ModelCapabilities { get; set; }\n\n /// Model identifier to switch to.\n [JsonPropertyName(\"modelId\")]\n public string ModelId { get; set; } = string.Empty;\n\n /// Reasoning effort level to use for the model.\n [JsonPropertyName(\"reasoningEffort\")]\n public string? ReasoningEffort { get; set; }\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for SessionModeGet operations.\ninternal sealed class SessionModeGetRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for ModeSet operations.\ninternal sealed class ModeSetRequest\n{\n /// The agent mode. Valid values: \"interactive\", \"plan\", \"autopilot\".\n [JsonPropertyName(\"mode\")]\n public SessionMode Mode { get; set; }\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for NameGet operations.\npublic sealed class NameGetResult\n{\n /// The session name (user-set or auto-generated), or null if not yet set.\n [JsonPropertyName(\"name\")]\n public string? Name { get; set; }\n}\n\n/// RPC data type for SessionNameGet operations.\ninternal sealed class SessionNameGetRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for NameSet operations.\ninternal sealed class NameSetRequest\n{\n /// New session name (1–100 characters, trimmed of leading/trailing whitespace).\n [UnconditionalSuppressMessage(\"Trimming\", \"IL2026\", Justification = \"Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members\")]\n [MinLength(1)]\n [MaxLength(100)]\n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for PlanRead operations.\npublic sealed class PlanReadResult\n{\n /// The content of the plan file, or null if it does not exist.\n [JsonPropertyName(\"content\")]\n public string? Content { get; set; }\n\n /// Whether the plan file exists in the workspace.\n [JsonPropertyName(\"exists\")]\n public bool Exists { get; set; }\n\n /// Absolute file path of the plan file, or null if workspace is not enabled.\n [JsonPropertyName(\"path\")]\n public string? Path { get; set; }\n}\n\n/// RPC data type for SessionPlanRead operations.\ninternal sealed class SessionPlanReadRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for PlanUpdate operations.\ninternal sealed class PlanUpdateRequest\n{\n /// The new content for the plan file.\n [JsonPropertyName(\"content\")]\n public string Content { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for SessionPlanDelete operations.\ninternal sealed class SessionPlanDeleteRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for WorkspacesGetWorkspaceResultWorkspace operations.\npublic sealed class WorkspacesGetWorkspaceResultWorkspace\n{\n /// Gets or sets the branch value.\n [JsonPropertyName(\"branch\")]\n public string? Branch { get; set; }\n\n /// Gets or sets the chronicle_sync_dismissed value.\n [JsonPropertyName(\"chronicle_sync_dismissed\")]\n public bool? ChronicleSyncDismissed { get; set; }\n\n /// Gets or sets the created_at value.\n [JsonPropertyName(\"created_at\")]\n public DateTimeOffset? CreatedAt { get; set; }\n\n /// Gets or sets the cwd value.\n [JsonPropertyName(\"cwd\")]\n public string? Cwd { get; set; }\n\n /// Gets or sets the git_root value.\n [JsonPropertyName(\"git_root\")]\n public string? GitRoot { get; set; }\n\n /// Gets or sets the host_type value.\n [JsonPropertyName(\"host_type\")]\n public WorkspacesGetWorkspaceResultWorkspaceHostType? HostType { get; set; }\n\n /// Gets or sets the id value.\n [JsonPropertyName(\"id\")]\n public Guid Id { get; set; }\n\n /// Gets or sets the mc_last_event_id value.\n [JsonPropertyName(\"mc_last_event_id\")]\n public string? McLastEventId { get; set; }\n\n /// Gets or sets the mc_session_id value.\n [JsonPropertyName(\"mc_session_id\")]\n public string? McSessionId { get; set; }\n\n /// Gets or sets the mc_task_id value.\n [JsonPropertyName(\"mc_task_id\")]\n public string? McTaskId { get; set; }\n\n /// Gets or sets the name value.\n [JsonPropertyName(\"name\")]\n public string? Name { get; set; }\n\n /// Gets or sets the remote_steerable value.\n [JsonPropertyName(\"remote_steerable\")]\n public bool? RemoteSteerable { get; set; }\n\n /// Gets or sets the repository value.\n [JsonPropertyName(\"repository\")]\n public string? Repository { get; set; }\n\n /// Gets or sets the session_sync_level value.\n [JsonPropertyName(\"session_sync_level\")]\n public WorkspacesGetWorkspaceResultWorkspaceSessionSyncLevel? SessionSyncLevel { get; set; }\n\n /// Gets or sets the summary value.\n [JsonPropertyName(\"summary\")]\n public string? Summary { get; set; }\n\n /// Gets or sets the summary_count value.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"summary_count\")]\n public long? SummaryCount { get; set; }\n\n /// Gets or sets the updated_at value.\n [JsonPropertyName(\"updated_at\")]\n public DateTimeOffset? UpdatedAt { get; set; }\n\n /// Gets or sets the user_named value.\n [JsonPropertyName(\"user_named\")]\n public bool? UserNamed { get; set; }\n}\n\n/// RPC data type for WorkspacesGetWorkspace operations.\npublic sealed class WorkspacesGetWorkspaceResult\n{\n /// Current workspace metadata, or null if not available.\n [JsonPropertyName(\"workspace\")]\n public WorkspacesGetWorkspaceResultWorkspace? Workspace { get; set; }\n}\n\n/// RPC data type for SessionWorkspacesGetWorkspace operations.\ninternal sealed class SessionWorkspacesGetWorkspaceRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for WorkspacesListFiles operations.\npublic sealed class WorkspacesListFilesResult\n{\n /// Relative file paths in the workspace files directory.\n [JsonPropertyName(\"files\")]\n public IList Files { get => field ??= []; set; }\n}\n\n/// RPC data type for SessionWorkspacesListFiles operations.\ninternal sealed class SessionWorkspacesListFilesRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for WorkspacesReadFile operations.\npublic sealed class WorkspacesReadFileResult\n{\n /// File content as a UTF-8 string.\n [JsonPropertyName(\"content\")]\n public string Content { get; set; } = string.Empty;\n}\n\n/// RPC data type for WorkspacesReadFile operations.\ninternal sealed class WorkspacesReadFileRequest\n{\n /// Relative path within the workspace files directory.\n [JsonPropertyName(\"path\")]\n public string Path { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for WorkspacesCreateFile operations.\ninternal sealed class WorkspacesCreateFileRequest\n{\n /// File content to write as a UTF-8 string.\n [JsonPropertyName(\"content\")]\n public string Content { get; set; } = string.Empty;\n\n /// Relative path within the workspace files directory.\n [JsonPropertyName(\"path\")]\n public string Path { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for InstructionsSources operations.\npublic sealed class InstructionsSources\n{\n /// Glob pattern from frontmatter — when set, this instruction applies only to matching files.\n [JsonPropertyName(\"applyTo\")]\n public string? ApplyTo { get; set; }\n\n /// Raw content of the instruction file.\n [JsonPropertyName(\"content\")]\n public string Content { get; set; } = string.Empty;\n\n /// Short description (body after frontmatter) for use in instruction tables.\n [JsonPropertyName(\"description\")]\n public string? Description { get; set; }\n\n /// Unique identifier for this source (used for toggling).\n [JsonPropertyName(\"id\")]\n public string Id { get; set; } = string.Empty;\n\n /// Human-readable label.\n [JsonPropertyName(\"label\")]\n public string Label { get; set; } = string.Empty;\n\n /// Where this source lives — used for UI grouping.\n [JsonPropertyName(\"location\")]\n public InstructionsSourcesLocation Location { get; set; }\n\n /// File path relative to repo or absolute for home.\n [JsonPropertyName(\"sourcePath\")]\n public string SourcePath { get; set; } = string.Empty;\n\n /// Category of instruction source — used for merge logic.\n [JsonPropertyName(\"type\")]\n public InstructionsSourcesType Type { get; set; }\n}\n\n/// RPC data type for InstructionsGetSources operations.\npublic sealed class InstructionsGetSourcesResult\n{\n /// Instruction sources for the session.\n [JsonPropertyName(\"sources\")]\n public IList Sources { get => field ??= []; set; }\n}\n\n/// RPC data type for SessionInstructionsGetSources operations.\ninternal sealed class SessionInstructionsGetSourcesRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for FleetStart operations.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class FleetStartResult\n{\n /// Whether fleet mode was successfully activated.\n [JsonPropertyName(\"started\")]\n public bool Started { get; set; }\n}\n\n/// RPC data type for FleetStart operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class FleetStartRequest\n{\n /// Optional user prompt to combine with fleet instructions.\n [JsonPropertyName(\"prompt\")]\n public string? Prompt { get; set; }\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for AgentInfo operations.\npublic sealed class AgentInfo\n{\n /// Description of the agent's purpose.\n [JsonPropertyName(\"description\")]\n public string Description { get; set; } = string.Empty;\n\n /// Human-readable display name.\n [JsonPropertyName(\"displayName\")]\n public string DisplayName { get; set; } = string.Empty;\n\n /// Unique identifier of the custom agent.\n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n\n /// Absolute local file path of the agent definition. Only set for file-based agents loaded from disk; remote agents do not have a path.\n [JsonPropertyName(\"path\")]\n public string? Path { get; set; }\n}\n\n/// RPC data type for AgentList operations.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class AgentList\n{\n /// Available custom agents.\n [JsonPropertyName(\"agents\")]\n public IList Agents { get => field ??= []; set; }\n}\n\n/// RPC data type for SessionAgentList operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class SessionAgentListRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for AgentGetCurrent operations.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class AgentGetCurrentResult\n{\n /// Currently selected custom agent, or null if using the default agent.\n [JsonPropertyName(\"agent\")]\n public AgentInfo? Agent { get; set; }\n}\n\n/// RPC data type for SessionAgentGetCurrent operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class SessionAgentGetCurrentRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for AgentSelect operations.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class AgentSelectResult\n{\n /// The newly selected custom agent.\n [JsonPropertyName(\"agent\")]\n public AgentInfo Agent { get => field ??= new(); set; }\n}\n\n/// RPC data type for AgentSelect operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class AgentSelectRequest\n{\n /// Name of the custom agent to select.\n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for SessionAgentDeselect operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class SessionAgentDeselectRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for AgentReload operations.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class AgentReloadResult\n{\n /// Reloaded custom agents.\n [JsonPropertyName(\"agents\")]\n public IList Agents { get => field ??= []; set; }\n}\n\n/// RPC data type for SessionAgentReload operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class SessionAgentReloadRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for TasksStartAgent operations.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class TasksStartAgentResult\n{\n /// Generated agent ID for the background task.\n [JsonPropertyName(\"agentId\")]\n public string AgentId { get; set; } = string.Empty;\n}\n\n/// RPC data type for TasksStartAgent operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class TasksStartAgentRequest\n{\n /// Type of agent to start (e.g., 'explore', 'task', 'general-purpose').\n [JsonPropertyName(\"agentType\")]\n public string AgentType { get; set; } = string.Empty;\n\n /// Short description of the task.\n [JsonPropertyName(\"description\")]\n public string? Description { get; set; }\n\n /// Optional model override.\n [JsonPropertyName(\"model\")]\n public string? Model { get; set; }\n\n /// Short name for the agent, used to generate a human-readable ID.\n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n\n /// Task prompt for the agent.\n [JsonPropertyName(\"prompt\")]\n public string Prompt { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// Polymorphic base type discriminated by type.\n[JsonPolymorphic(\n TypeDiscriminatorPropertyName = \"type\",\n UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)]\n[JsonDerivedType(typeof(TaskInfoAgent), \"agent\")]\n[JsonDerivedType(typeof(TaskInfoShell), \"shell\")]\npublic partial class TaskInfo\n{\n /// The type discriminator.\n [JsonPropertyName(\"type\")]\n public virtual string Type { get; set; } = string.Empty;\n}\n\n\n/// The agent variant of .\npublic partial class TaskInfoAgent : TaskInfo\n{\n /// \n [JsonIgnore]\n public override string Type => \"agent\";\n\n /// ISO 8601 timestamp when the current active period began.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"activeStartedAt\")]\n public DateTimeOffset? ActiveStartedAt { get; set; }\n\n /// Accumulated active execution time in milliseconds.\n [JsonConverter(typeof(MillisecondsTimeSpanConverter))]\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"activeTimeMs\")]\n public TimeSpan? ActiveTimeMs { get; set; }\n\n /// Type of agent running this task.\n [JsonPropertyName(\"agentType\")]\n public required string AgentType { get; set; }\n\n /// Whether the task is currently in the original sync wait and can be moved to background mode. False once it is already backgrounded, idle, finished, or no longer has a promotable sync waiter.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"canPromoteToBackground\")]\n public bool? CanPromoteToBackground { get; set; }\n\n /// ISO 8601 timestamp when the task finished.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"completedAt\")]\n public DateTimeOffset? CompletedAt { get; set; }\n\n /// Short description of the task.\n [JsonPropertyName(\"description\")]\n public required string Description { get; set; }\n\n /// Error message when the task failed.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"error\")]\n public string? Error { get; set; }\n\n /// How the agent is currently being managed by the runtime.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"executionMode\")]\n public TaskAgentInfoExecutionMode? ExecutionMode { get; set; }\n\n /// Unique task identifier.\n [JsonPropertyName(\"id\")]\n public required string Id { get; set; }\n\n /// ISO 8601 timestamp when the agent entered idle state.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"idleSince\")]\n public DateTimeOffset? IdleSince { get; set; }\n\n /// Most recent response text from the agent.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"latestResponse\")]\n public string? LatestResponse { get; set; }\n\n /// Model used for the task when specified.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"model\")]\n public string? Model { get; set; }\n\n /// Prompt passed to the agent.\n [JsonPropertyName(\"prompt\")]\n public required string Prompt { get; set; }\n\n /// Result text from the task when available.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"result\")]\n public string? Result { get; set; }\n\n /// ISO 8601 timestamp when the task was started.\n [JsonPropertyName(\"startedAt\")]\n public required DateTimeOffset StartedAt { get; set; }\n\n /// Current lifecycle status of the task.\n [JsonPropertyName(\"status\")]\n public required TaskAgentInfoStatus Status { get; set; }\n\n /// Tool call ID associated with this agent task.\n [JsonPropertyName(\"toolCallId\")]\n public required string ToolCallId { get; set; }\n}\n\n/// The shell variant of .\npublic partial class TaskInfoShell : TaskInfo\n{\n /// \n [JsonIgnore]\n public override string Type => \"shell\";\n\n /// Whether the shell runs inside a managed PTY session or as an independent background process.\n [JsonPropertyName(\"attachmentMode\")]\n public required TaskShellInfoAttachmentMode AttachmentMode { get; set; }\n\n /// Whether this shell task can be promoted to background mode.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"canPromoteToBackground\")]\n public bool? CanPromoteToBackground { get; set; }\n\n /// Command being executed.\n [JsonPropertyName(\"command\")]\n public required string Command { get; set; }\n\n /// ISO 8601 timestamp when the task finished.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"completedAt\")]\n public DateTimeOffset? CompletedAt { get; set; }\n\n /// Short description of the task.\n [JsonPropertyName(\"description\")]\n public required string Description { get; set; }\n\n /// Whether the shell command is currently sync-waited or background-managed.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"executionMode\")]\n public TaskShellInfoExecutionMode? ExecutionMode { get; set; }\n\n /// Unique task identifier.\n [JsonPropertyName(\"id\")]\n public required string Id { get; set; }\n\n /// Path to the detached shell log, when available.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"logPath\")]\n public string? LogPath { get; set; }\n\n /// Process ID when available.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"pid\")]\n public long? Pid { get; set; }\n\n /// ISO 8601 timestamp when the task was started.\n [JsonPropertyName(\"startedAt\")]\n public required DateTimeOffset StartedAt { get; set; }\n\n /// Current lifecycle status of the task.\n [JsonPropertyName(\"status\")]\n public required TaskShellInfoStatus Status { get; set; }\n}\n\n/// RPC data type for TaskList operations.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class TaskList\n{\n /// Currently tracked tasks.\n [JsonPropertyName(\"tasks\")]\n public IList Tasks { get => field ??= []; set; }\n}\n\n/// RPC data type for SessionTasksList operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class SessionTasksListRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for TasksPromoteToBackground operations.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class TasksPromoteToBackgroundResult\n{\n /// Whether the task was successfully promoted to background mode.\n [JsonPropertyName(\"promoted\")]\n public bool Promoted { get; set; }\n}\n\n/// RPC data type for TasksPromoteToBackground operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class TasksPromoteToBackgroundRequest\n{\n /// Task identifier.\n [JsonPropertyName(\"id\")]\n public string Id { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for TasksCancel operations.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class TasksCancelResult\n{\n /// Whether the task was successfully cancelled.\n [JsonPropertyName(\"cancelled\")]\n public bool Cancelled { get; set; }\n}\n\n/// RPC data type for TasksCancel operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class TasksCancelRequest\n{\n /// Task identifier.\n [JsonPropertyName(\"id\")]\n public string Id { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for TasksRemove operations.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class TasksRemoveResult\n{\n /// Whether the task was removed. Returns false if the task does not exist or is still running/idle (cancel it first).\n [JsonPropertyName(\"removed\")]\n public bool Removed { get; set; }\n}\n\n/// RPC data type for TasksRemove operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class TasksRemoveRequest\n{\n /// Task identifier.\n [JsonPropertyName(\"id\")]\n public string Id { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for Skill operations.\npublic sealed class Skill\n{\n /// Description of what the skill does.\n [JsonPropertyName(\"description\")]\n public string Description { get; set; } = string.Empty;\n\n /// Whether the skill is currently enabled.\n [JsonPropertyName(\"enabled\")]\n public bool Enabled { get; set; }\n\n /// Unique identifier for the skill.\n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n\n /// Absolute path to the skill file.\n [JsonPropertyName(\"path\")]\n public string? Path { get; set; }\n\n /// Source location type (e.g., project, personal, plugin).\n [JsonPropertyName(\"source\")]\n public string Source { get; set; } = string.Empty;\n\n /// Whether the skill can be invoked by the user as a slash command.\n [JsonPropertyName(\"userInvocable\")]\n public bool UserInvocable { get; set; }\n}\n\n/// RPC data type for SkillList operations.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class SkillList\n{\n /// Available skills.\n [JsonPropertyName(\"skills\")]\n public IList Skills { get => field ??= []; set; }\n}\n\n/// RPC data type for SessionSkillsList operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class SessionSkillsListRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for SkillsEnable operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class SkillsEnableRequest\n{\n /// Name of the skill to enable.\n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for SkillsDisable operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class SkillsDisableRequest\n{\n /// Name of the skill to disable.\n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for SessionSkillsReload operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class SessionSkillsReloadRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for McpServer operations.\npublic sealed class McpServer\n{\n /// Error message if the server failed to connect.\n [JsonPropertyName(\"error\")]\n public string? Error { get; set; }\n\n /// Server name (config key).\n [RegularExpression(\"^[^\\\\x00-\\\\x1f/\\\\x7f-\\\\x9f}]+(?:\\\\/[^\\\\x00-\\\\x1f/\\\\x7f-\\\\x9f}]+)*$\")]\n [UnconditionalSuppressMessage(\"Trimming\", \"IL2026\", Justification = \"Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members\")]\n [MinLength(1)]\n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n\n /// Configuration source: user, workspace, plugin, or builtin.\n [JsonPropertyName(\"source\")]\n public McpServerSource? Source { get; set; }\n\n /// Connection status: connected, failed, needs-auth, pending, disabled, or not_configured.\n [JsonPropertyName(\"status\")]\n public McpServerStatus Status { get; set; }\n}\n\n/// RPC data type for McpServerList operations.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class McpServerList\n{\n /// Configured MCP servers.\n [JsonPropertyName(\"servers\")]\n public IList Servers { get => field ??= []; set; }\n}\n\n/// RPC data type for SessionMcpList operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class SessionMcpListRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for McpEnable operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class McpEnableRequest\n{\n /// Name of the MCP server to enable.\n [RegularExpression(\"^[^\\\\x00-\\\\x1f/\\\\x7f-\\\\x9f}]+(?:\\\\/[^\\\\x00-\\\\x1f/\\\\x7f-\\\\x9f}]+)*$\")]\n [UnconditionalSuppressMessage(\"Trimming\", \"IL2026\", Justification = \"Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members\")]\n [MinLength(1)]\n [JsonPropertyName(\"serverName\")]\n public string ServerName { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for McpDisable operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class McpDisableRequest\n{\n /// Name of the MCP server to disable.\n [RegularExpression(\"^[^\\\\x00-\\\\x1f/\\\\x7f-\\\\x9f}]+(?:\\\\/[^\\\\x00-\\\\x1f/\\\\x7f-\\\\x9f}]+)*$\")]\n [UnconditionalSuppressMessage(\"Trimming\", \"IL2026\", Justification = \"Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members\")]\n [MinLength(1)]\n [JsonPropertyName(\"serverName\")]\n public string ServerName { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for SessionMcpReload operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class SessionMcpReloadRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for McpOauthLogin operations.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class McpOauthLoginResult\n{\n /// URL the caller should open in a browser to complete OAuth. Omitted when cached tokens were still valid and no browser interaction was needed — the server is already reconnected in that case. When present, the runtime starts the callback listener before returning and continues the flow in the background; completion is signaled via session.mcp_server_status_changed.\n [JsonPropertyName(\"authorizationUrl\")]\n public string? AuthorizationUrl { get; set; }\n}\n\n/// RPC data type for McpOauthLogin operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class McpOauthLoginRequest\n{\n /// Optional override for the body text shown on the OAuth loopback callback success page. When omitted, the runtime applies a neutral fallback; callers driving interactive auth should pass surface-specific copy telling the user where to return.\n [JsonPropertyName(\"callbackSuccessMessage\")]\n public string? CallbackSuccessMessage { get; set; }\n\n /// Optional override for the OAuth client display name shown on the consent screen. Applies to newly registered dynamic clients only — existing registrations keep the name they were created with. When omitted, the runtime applies a neutral fallback; callers driving interactive auth should pass their own surface-specific label so the consent screen matches the product the user sees.\n [JsonPropertyName(\"clientName\")]\n public string? ClientName { get; set; }\n\n /// When true, clears any cached OAuth token for the server and runs a full new authorization. Use when the user explicitly wants to switch accounts or believes their session is stuck.\n [JsonPropertyName(\"forceReauth\")]\n public bool? ForceReauth { get; set; }\n\n /// Name of the remote MCP server to authenticate.\n [RegularExpression(\"^[^\\\\x00-\\\\x1f/\\\\x7f-\\\\x9f}]+(?:\\\\/[^\\\\x00-\\\\x1f/\\\\x7f-\\\\x9f}]+)*$\")]\n [UnconditionalSuppressMessage(\"Trimming\", \"IL2026\", Justification = \"Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members\")]\n [MinLength(1)]\n [JsonPropertyName(\"serverName\")]\n public string ServerName { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for Plugin operations.\npublic sealed class Plugin\n{\n /// Whether the plugin is currently enabled.\n [JsonPropertyName(\"enabled\")]\n public bool Enabled { get; set; }\n\n /// Marketplace the plugin came from.\n [JsonPropertyName(\"marketplace\")]\n public string Marketplace { get; set; } = string.Empty;\n\n /// Plugin name.\n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n\n /// Installed version.\n [JsonPropertyName(\"version\")]\n public string? Version { get; set; }\n}\n\n/// RPC data type for PluginList operations.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class PluginList\n{\n /// Installed plugins.\n [JsonPropertyName(\"plugins\")]\n public IList Plugins { get => field ??= []; set; }\n}\n\n/// RPC data type for SessionPluginsList operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class SessionPluginsListRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for Extension operations.\npublic sealed class Extension\n{\n /// Source-qualified ID (e.g., 'project:my-ext', 'user:auth-helper').\n [JsonPropertyName(\"id\")]\n public string Id { get; set; } = string.Empty;\n\n /// Extension name (directory name).\n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n\n /// Process ID if the extension is running.\n [JsonPropertyName(\"pid\")]\n public long? Pid { get; set; }\n\n /// Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/).\n [JsonPropertyName(\"source\")]\n public ExtensionSource Source { get; set; }\n\n /// Current status: running, disabled, failed, or starting.\n [JsonPropertyName(\"status\")]\n public ExtensionStatus Status { get; set; }\n}\n\n/// RPC data type for ExtensionList operations.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class ExtensionList\n{\n /// Discovered extensions and their current status.\n [JsonPropertyName(\"extensions\")]\n public IList Extensions { get => field ??= []; set; }\n}\n\n/// RPC data type for SessionExtensionsList operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class SessionExtensionsListRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for ExtensionsEnable operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class ExtensionsEnableRequest\n{\n /// Source-qualified extension ID to enable.\n [JsonPropertyName(\"id\")]\n public string Id { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for ExtensionsDisable operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class ExtensionsDisableRequest\n{\n /// Source-qualified extension ID to disable.\n [JsonPropertyName(\"id\")]\n public string Id { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for SessionExtensionsReload operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class SessionExtensionsReloadRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for HandlePendingToolCall operations.\npublic sealed class HandlePendingToolCallResult\n{\n /// Whether the tool call result was handled successfully.\n [JsonPropertyName(\"success\")]\n public bool Success { get; set; }\n}\n\n/// RPC data type for HandlePendingToolCall operations.\ninternal sealed class HandlePendingToolCallRequest\n{\n /// Error message if the tool call failed.\n [JsonPropertyName(\"error\")]\n public string? Error { get; set; }\n\n /// Request ID of the pending tool call.\n [JsonPropertyName(\"requestId\")]\n public string RequestId { get; set; } = string.Empty;\n\n /// Tool call result (string or expanded result object).\n [JsonPropertyName(\"result\")]\n public object? Result { get; set; }\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for CommandsHandlePendingCommand operations.\npublic sealed class CommandsHandlePendingCommandResult\n{\n /// Whether the command was handled successfully.\n [JsonPropertyName(\"success\")]\n public bool Success { get; set; }\n}\n\n/// RPC data type for CommandsHandlePendingCommand operations.\ninternal sealed class CommandsHandlePendingCommandRequest\n{\n /// Error message if the command handler failed.\n [JsonPropertyName(\"error\")]\n public string? Error { get; set; }\n\n /// Request ID from the command invocation event.\n [JsonPropertyName(\"requestId\")]\n public string RequestId { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// The elicitation response (accept with form values, decline, or cancel).\npublic sealed class UIElicitationResponse\n{\n /// The user's response: accept (submitted), decline (rejected), or cancel (dismissed).\n [JsonPropertyName(\"action\")]\n public UIElicitationResponseAction Action { get; set; }\n\n /// The form values submitted by the user (present when action is 'accept').\n [JsonPropertyName(\"content\")]\n public IDictionary? Content { get; set; }\n}\n\n/// JSON Schema describing the form fields to present to the user.\npublic sealed class UIElicitationSchema\n{\n /// Form field definitions, keyed by field name.\n [JsonPropertyName(\"properties\")]\n public IDictionary Properties { get => field ??= new Dictionary(); set; }\n\n /// List of required field names.\n [JsonPropertyName(\"required\")]\n public IList? Required { get; set; }\n\n /// Schema type indicator (always 'object').\n [JsonPropertyName(\"type\")]\n public string Type { get; set; } = string.Empty;\n}\n\n/// RPC data type for UIElicitation operations.\ninternal sealed class UIElicitationRequest\n{\n /// Message describing what information is needed from the user.\n [JsonPropertyName(\"message\")]\n public string Message { get; set; } = string.Empty;\n\n /// JSON Schema describing the form fields to present to the user.\n [JsonPropertyName(\"requestedSchema\")]\n public UIElicitationSchema RequestedSchema { get => field ??= new(); set; }\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for UIElicitation operations.\npublic sealed class UIElicitationResult\n{\n /// Whether the response was accepted. False if the request was already resolved by another client.\n [JsonPropertyName(\"success\")]\n public bool Success { get; set; }\n}\n\n/// RPC data type for UIHandlePendingElicitation operations.\ninternal sealed class UIHandlePendingElicitationRequest\n{\n /// The unique request ID from the elicitation.requested event.\n [JsonPropertyName(\"requestId\")]\n public string RequestId { get; set; } = string.Empty;\n\n /// The elicitation response (accept with form values, decline, or cancel).\n [JsonPropertyName(\"result\")]\n public UIElicitationResponse Result { get => field ??= new(); set; }\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for PermissionRequest operations.\npublic sealed class PermissionRequestResult\n{\n /// Whether the permission request was handled successfully.\n [JsonPropertyName(\"success\")]\n public bool Success { get; set; }\n}\n\n/// Polymorphic base type discriminated by kind.\n[JsonPolymorphic(\n TypeDiscriminatorPropertyName = \"kind\",\n UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)]\n[JsonDerivedType(typeof(PermissionDecisionApproveOnce), \"approve-once\")]\n[JsonDerivedType(typeof(PermissionDecisionApproveForSession), \"approve-for-session\")]\n[JsonDerivedType(typeof(PermissionDecisionApproveForLocation), \"approve-for-location\")]\n[JsonDerivedType(typeof(PermissionDecisionApprovePermanently), \"approve-permanently\")]\n[JsonDerivedType(typeof(PermissionDecisionReject), \"reject\")]\n[JsonDerivedType(typeof(PermissionDecisionUserNotAvailable), \"user-not-available\")]\npublic partial class PermissionDecision\n{\n /// The type discriminator.\n [JsonPropertyName(\"kind\")]\n public virtual string Kind { get; set; } = string.Empty;\n}\n\n\n/// The approve-once variant of .\npublic partial class PermissionDecisionApproveOnce : PermissionDecision\n{\n /// \n [JsonIgnore]\n public override string Kind => \"approve-once\";\n}\n\n/// The approval to add as a session-scoped rule.\n/// Polymorphic base type discriminated by kind.\n[JsonPolymorphic(\n TypeDiscriminatorPropertyName = \"kind\",\n UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)]\n[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalCommands), \"commands\")]\n[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalRead), \"read\")]\n[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalWrite), \"write\")]\n[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalMcp), \"mcp\")]\n[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalMcpSampling), \"mcp-sampling\")]\n[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalMemory), \"memory\")]\n[JsonDerivedType(typeof(PermissionDecisionApproveForSessionApprovalCustomTool), \"custom-tool\")]\npublic partial class PermissionDecisionApproveForSessionApproval\n{\n /// The type discriminator.\n [JsonPropertyName(\"kind\")]\n public virtual string Kind { get; set; } = string.Empty;\n}\n\n\n/// The commands variant of .\npublic partial class PermissionDecisionApproveForSessionApprovalCommands : PermissionDecisionApproveForSessionApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"commands\";\n\n /// Gets or sets the commandIdentifiers value.\n [JsonPropertyName(\"commandIdentifiers\")]\n public required IList CommandIdentifiers { get; set; }\n}\n\n/// The read variant of .\npublic partial class PermissionDecisionApproveForSessionApprovalRead : PermissionDecisionApproveForSessionApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"read\";\n}\n\n/// The write variant of .\npublic partial class PermissionDecisionApproveForSessionApprovalWrite : PermissionDecisionApproveForSessionApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"write\";\n}\n\n/// The mcp variant of .\npublic partial class PermissionDecisionApproveForSessionApprovalMcp : PermissionDecisionApproveForSessionApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"mcp\";\n\n /// Gets or sets the serverName value.\n [JsonPropertyName(\"serverName\")]\n public required string ServerName { get; set; }\n\n /// Gets or sets the toolName value.\n [JsonPropertyName(\"toolName\")]\n public string? ToolName { get; set; }\n}\n\n/// The mcp-sampling variant of .\npublic partial class PermissionDecisionApproveForSessionApprovalMcpSampling : PermissionDecisionApproveForSessionApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"mcp-sampling\";\n\n /// Gets or sets the serverName value.\n [JsonPropertyName(\"serverName\")]\n public required string ServerName { get; set; }\n}\n\n/// The memory variant of .\npublic partial class PermissionDecisionApproveForSessionApprovalMemory : PermissionDecisionApproveForSessionApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"memory\";\n}\n\n/// The custom-tool variant of .\npublic partial class PermissionDecisionApproveForSessionApprovalCustomTool : PermissionDecisionApproveForSessionApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"custom-tool\";\n\n /// Gets or sets the toolName value.\n [JsonPropertyName(\"toolName\")]\n public required string ToolName { get; set; }\n}\n\n/// The approve-for-session variant of .\npublic partial class PermissionDecisionApproveForSession : PermissionDecision\n{\n /// \n [JsonIgnore]\n public override string Kind => \"approve-for-session\";\n\n /// The approval to add as a session-scoped rule.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"approval\")]\n public PermissionDecisionApproveForSessionApproval? Approval { get; set; }\n\n /// The URL domain to approve for this session.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"domain\")]\n public string? Domain { get; set; }\n}\n\n/// The approval to persist for this location.\n/// Polymorphic base type discriminated by kind.\n[JsonPolymorphic(\n TypeDiscriminatorPropertyName = \"kind\",\n UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)]\n[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalCommands), \"commands\")]\n[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalRead), \"read\")]\n[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalWrite), \"write\")]\n[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalMcp), \"mcp\")]\n[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalMcpSampling), \"mcp-sampling\")]\n[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalMemory), \"memory\")]\n[JsonDerivedType(typeof(PermissionDecisionApproveForLocationApprovalCustomTool), \"custom-tool\")]\npublic partial class PermissionDecisionApproveForLocationApproval\n{\n /// The type discriminator.\n [JsonPropertyName(\"kind\")]\n public virtual string Kind { get; set; } = string.Empty;\n}\n\n\n/// The commands variant of .\npublic partial class PermissionDecisionApproveForLocationApprovalCommands : PermissionDecisionApproveForLocationApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"commands\";\n\n /// Gets or sets the commandIdentifiers value.\n [JsonPropertyName(\"commandIdentifiers\")]\n public required IList CommandIdentifiers { get; set; }\n}\n\n/// The read variant of .\npublic partial class PermissionDecisionApproveForLocationApprovalRead : PermissionDecisionApproveForLocationApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"read\";\n}\n\n/// The write variant of .\npublic partial class PermissionDecisionApproveForLocationApprovalWrite : PermissionDecisionApproveForLocationApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"write\";\n}\n\n/// The mcp variant of .\npublic partial class PermissionDecisionApproveForLocationApprovalMcp : PermissionDecisionApproveForLocationApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"mcp\";\n\n /// Gets or sets the serverName value.\n [JsonPropertyName(\"serverName\")]\n public required string ServerName { get; set; }\n\n /// Gets or sets the toolName value.\n [JsonPropertyName(\"toolName\")]\n public string? ToolName { get; set; }\n}\n\n/// The mcp-sampling variant of .\npublic partial class PermissionDecisionApproveForLocationApprovalMcpSampling : PermissionDecisionApproveForLocationApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"mcp-sampling\";\n\n /// Gets or sets the serverName value.\n [JsonPropertyName(\"serverName\")]\n public required string ServerName { get; set; }\n}\n\n/// The memory variant of .\npublic partial class PermissionDecisionApproveForLocationApprovalMemory : PermissionDecisionApproveForLocationApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"memory\";\n}\n\n/// The custom-tool variant of .\npublic partial class PermissionDecisionApproveForLocationApprovalCustomTool : PermissionDecisionApproveForLocationApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"custom-tool\";\n\n /// Gets or sets the toolName value.\n [JsonPropertyName(\"toolName\")]\n public required string ToolName { get; set; }\n}\n\n/// The approve-for-location variant of .\npublic partial class PermissionDecisionApproveForLocation : PermissionDecision\n{\n /// \n [JsonIgnore]\n public override string Kind => \"approve-for-location\";\n\n /// The approval to persist for this location.\n [JsonPropertyName(\"approval\")]\n public required PermissionDecisionApproveForLocationApproval Approval { get; set; }\n\n /// The location key (git root or cwd) to persist the approval to.\n [JsonPropertyName(\"locationKey\")]\n public required string LocationKey { get; set; }\n}\n\n/// The approve-permanently variant of .\npublic partial class PermissionDecisionApprovePermanently : PermissionDecision\n{\n /// \n [JsonIgnore]\n public override string Kind => \"approve-permanently\";\n\n /// The URL domain to approve permanently.\n [JsonPropertyName(\"domain\")]\n public required string Domain { get; set; }\n}\n\n/// The reject variant of .\npublic partial class PermissionDecisionReject : PermissionDecision\n{\n /// \n [JsonIgnore]\n public override string Kind => \"reject\";\n\n /// Optional feedback from the user explaining the denial.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"feedback\")]\n public string? Feedback { get; set; }\n}\n\n/// The user-not-available variant of .\npublic partial class PermissionDecisionUserNotAvailable : PermissionDecision\n{\n /// \n [JsonIgnore]\n public override string Kind => \"user-not-available\";\n}\n\n/// RPC data type for PermissionDecision operations.\ninternal sealed class PermissionDecisionRequest\n{\n /// Request ID of the pending permission request.\n [JsonPropertyName(\"requestId\")]\n public string RequestId { get; set; } = string.Empty;\n\n /// Gets or sets the result value.\n [JsonPropertyName(\"result\")]\n public PermissionDecision Result { get => field ??= new(); set; }\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for PermissionsSetApproveAll operations.\npublic sealed class PermissionsSetApproveAllResult\n{\n /// Whether the operation succeeded.\n [JsonPropertyName(\"success\")]\n public bool Success { get; set; }\n}\n\n/// RPC data type for PermissionsSetApproveAll operations.\ninternal sealed class PermissionsSetApproveAllRequest\n{\n /// Whether to auto-approve all tool permission requests.\n [JsonPropertyName(\"enabled\")]\n public bool Enabled { get; set; }\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for PermissionsResetSessionApprovals operations.\npublic sealed class PermissionsResetSessionApprovalsResult\n{\n /// Whether the operation succeeded.\n [JsonPropertyName(\"success\")]\n public bool Success { get; set; }\n}\n\n/// RPC data type for PermissionsResetSessionApprovals operations.\ninternal sealed class PermissionsResetSessionApprovalsRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for ShellExec operations.\npublic sealed class ShellExecResult\n{\n /// Unique identifier for tracking streamed output.\n [JsonPropertyName(\"processId\")]\n public string ProcessId { get; set; } = string.Empty;\n}\n\n/// RPC data type for ShellExec operations.\ninternal sealed class ShellExecRequest\n{\n /// Shell command to execute.\n [JsonPropertyName(\"command\")]\n public string Command { get; set; } = string.Empty;\n\n /// Working directory (defaults to session working directory).\n [JsonPropertyName(\"cwd\")]\n public string? Cwd { get; set; }\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n\n /// Timeout in milliseconds (default: 30000).\n [Range((double)0, (double)long.MaxValue)]\n [JsonConverter(typeof(MillisecondsTimeSpanConverter))]\n [JsonPropertyName(\"timeout\")]\n public TimeSpan? Timeout { get; set; }\n}\n\n/// RPC data type for ShellKill operations.\npublic sealed class ShellKillResult\n{\n /// Whether the signal was sent successfully.\n [JsonPropertyName(\"killed\")]\n public bool Killed { get; set; }\n}\n\n/// RPC data type for ShellKill operations.\ninternal sealed class ShellKillRequest\n{\n /// Process identifier returned by shell.exec.\n [JsonPropertyName(\"processId\")]\n public string ProcessId { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n\n /// Signal to send (default: SIGTERM).\n [JsonPropertyName(\"signal\")]\n public ShellKillSignal? Signal { get; set; }\n}\n\n/// Post-compaction context window usage breakdown.\npublic sealed class HistoryCompactContextWindow\n{\n /// Token count from non-system messages (user, assistant, tool).\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"conversationTokens\")]\n public long? ConversationTokens { get; set; }\n\n /// Current total tokens in the context window (system + conversation + tool definitions).\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"currentTokens\")]\n public long CurrentTokens { get; set; }\n\n /// Current number of messages in the conversation.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"messagesLength\")]\n public long MessagesLength { get; set; }\n\n /// Token count from system message(s).\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"systemTokens\")]\n public long? SystemTokens { get; set; }\n\n /// Maximum token count for the model's context window.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"tokenLimit\")]\n public long TokenLimit { get; set; }\n\n /// Token count from tool definitions.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"toolDefinitionsTokens\")]\n public long? ToolDefinitionsTokens { get; set; }\n}\n\n/// RPC data type for HistoryCompact operations.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class HistoryCompactResult\n{\n /// Post-compaction context window usage breakdown.\n [JsonPropertyName(\"contextWindow\")]\n public HistoryCompactContextWindow? ContextWindow { get; set; }\n\n /// Number of messages removed during compaction.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"messagesRemoved\")]\n public long MessagesRemoved { get; set; }\n\n /// Whether compaction completed successfully.\n [JsonPropertyName(\"success\")]\n public bool Success { get; set; }\n\n /// Number of tokens freed by compaction.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"tokensRemoved\")]\n public long TokensRemoved { get; set; }\n}\n\n/// RPC data type for SessionHistoryCompact operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class SessionHistoryCompactRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for HistoryTruncate operations.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class HistoryTruncateResult\n{\n /// Number of events that were removed.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"eventsRemoved\")]\n public long EventsRemoved { get; set; }\n}\n\n/// RPC data type for HistoryTruncate operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class HistoryTruncateRequest\n{\n /// Event ID to truncate to. This event and all events after it are removed from the session.\n [JsonPropertyName(\"eventId\")]\n public string EventId { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// Aggregated code change metrics.\npublic sealed class UsageMetricsCodeChanges\n{\n /// Number of distinct files modified.\n [JsonPropertyName(\"filesModifiedCount\")]\n public long FilesModifiedCount { get; set; }\n\n /// Total lines of code added.\n [JsonPropertyName(\"linesAdded\")]\n public long LinesAdded { get; set; }\n\n /// Total lines of code removed.\n [JsonPropertyName(\"linesRemoved\")]\n public long LinesRemoved { get; set; }\n}\n\n/// Request count and cost metrics for this model.\npublic sealed class UsageMetricsModelMetricRequests\n{\n /// User-initiated premium request cost (with multiplier applied).\n [JsonPropertyName(\"cost\")]\n public double Cost { get; set; }\n\n /// Number of API requests made with this model.\n [JsonPropertyName(\"count\")]\n public long Count { get; set; }\n}\n\n/// RPC data type for UsageMetricsModelMetricTokenDetail operations.\npublic sealed class UsageMetricsModelMetricTokenDetail\n{\n /// Accumulated token count for this token type.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"tokenCount\")]\n public long TokenCount { get; set; }\n}\n\n/// Token usage metrics for this model.\npublic sealed class UsageMetricsModelMetricUsage\n{\n /// Total tokens read from prompt cache.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"cacheReadTokens\")]\n public long CacheReadTokens { get; set; }\n\n /// Total tokens written to prompt cache.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"cacheWriteTokens\")]\n public long CacheWriteTokens { get; set; }\n\n /// Total input tokens consumed.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"inputTokens\")]\n public long InputTokens { get; set; }\n\n /// Total output tokens produced.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"outputTokens\")]\n public long OutputTokens { get; set; }\n\n /// Total output tokens used for reasoning.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"reasoningTokens\")]\n public long? ReasoningTokens { get; set; }\n}\n\n/// RPC data type for UsageMetricsModelMetric operations.\npublic sealed class UsageMetricsModelMetric\n{\n /// Request count and cost metrics for this model.\n [JsonPropertyName(\"requests\")]\n public UsageMetricsModelMetricRequests Requests { get => field ??= new(); set; }\n\n /// Token count details per type.\n [JsonPropertyName(\"tokenDetails\")]\n public IDictionary? TokenDetails { get; set; }\n\n /// Accumulated nano-AI units cost for this model.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"totalNanoAiu\")]\n public long? TotalNanoAiu { get; set; }\n\n /// Token usage metrics for this model.\n [JsonPropertyName(\"usage\")]\n public UsageMetricsModelMetricUsage Usage { get => field ??= new(); set; }\n}\n\n/// RPC data type for UsageMetricsTokenDetail operations.\npublic sealed class UsageMetricsTokenDetail\n{\n /// Accumulated token count for this token type.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"tokenCount\")]\n public long TokenCount { get; set; }\n}\n\n/// RPC data type for UsageGetMetrics operations.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class UsageGetMetricsResult\n{\n /// Aggregated code change metrics.\n [JsonPropertyName(\"codeChanges\")]\n public UsageMetricsCodeChanges CodeChanges { get => field ??= new(); set; }\n\n /// Currently active model identifier.\n [JsonPropertyName(\"currentModel\")]\n public string? CurrentModel { get; set; }\n\n /// Input tokens from the most recent main-agent API call.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"lastCallInputTokens\")]\n public long LastCallInputTokens { get; set; }\n\n /// Output tokens from the most recent main-agent API call.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"lastCallOutputTokens\")]\n public long LastCallOutputTokens { get; set; }\n\n /// Per-model token and request metrics, keyed by model identifier.\n [JsonPropertyName(\"modelMetrics\")]\n public IDictionary ModelMetrics { get => field ??= new Dictionary(); set; }\n\n /// Session start timestamp (epoch milliseconds).\n [JsonPropertyName(\"sessionStartTime\")]\n public long SessionStartTime { get; set; }\n\n /// Session-wide per-token-type accumulated token counts.\n [JsonPropertyName(\"tokenDetails\")]\n public IDictionary? TokenDetails { get; set; }\n\n /// Total time spent in model API calls (milliseconds).\n [Range(0, double.MaxValue)]\n [JsonConverter(typeof(MillisecondsTimeSpanConverter))]\n [JsonPropertyName(\"totalApiDurationMs\")]\n public TimeSpan TotalApiDurationMs { get; set; }\n\n /// Session-wide accumulated nano-AI units cost.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"totalNanoAiu\")]\n public long? TotalNanoAiu { get; set; }\n\n /// Total user-initiated premium request cost across all models (may be fractional due to multipliers).\n [JsonPropertyName(\"totalPremiumRequestCost\")]\n public double TotalPremiumRequestCost { get; set; }\n\n /// Raw count of user-initiated API requests.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"totalUserRequests\")]\n public long TotalUserRequests { get; set; }\n}\n\n/// RPC data type for SessionUsageGetMetrics operations.\n[Experimental(Diagnostics.Experimental)]\ninternal sealed class SessionUsageGetMetricsRequest\n{\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// Describes a filesystem error.\npublic sealed class SessionFsError\n{\n /// Error classification.\n [JsonPropertyName(\"code\")]\n public SessionFsErrorCode Code { get; set; }\n\n /// Free-form detail about the error, for logging/diagnostics.\n [JsonPropertyName(\"message\")]\n public string? Message { get; set; }\n}\n\n/// RPC data type for SessionFsReadFile operations.\npublic sealed class SessionFsReadFileResult\n{\n /// File content as UTF-8 string.\n [JsonPropertyName(\"content\")]\n public string Content { get; set; } = string.Empty;\n\n /// Describes a filesystem error.\n [JsonPropertyName(\"error\")]\n public SessionFsError? Error { get; set; }\n}\n\n/// RPC data type for SessionFsReadFile operations.\npublic sealed class SessionFsReadFileRequest\n{\n /// Path using SessionFs conventions.\n [JsonPropertyName(\"path\")]\n public string Path { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for SessionFsWriteFile operations.\npublic sealed class SessionFsWriteFileRequest\n{\n /// Content to write.\n [JsonPropertyName(\"content\")]\n public string Content { get; set; } = string.Empty;\n\n /// Optional POSIX-style mode for newly created files.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"mode\")]\n public long? Mode { get; set; }\n\n /// Path using SessionFs conventions.\n [JsonPropertyName(\"path\")]\n public string Path { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for SessionFsAppendFile operations.\npublic sealed class SessionFsAppendFileRequest\n{\n /// Content to append.\n [JsonPropertyName(\"content\")]\n public string Content { get; set; } = string.Empty;\n\n /// Optional POSIX-style mode for newly created files.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"mode\")]\n public long? Mode { get; set; }\n\n /// Path using SessionFs conventions.\n [JsonPropertyName(\"path\")]\n public string Path { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for SessionFsExists operations.\npublic sealed class SessionFsExistsResult\n{\n /// Whether the path exists.\n [JsonPropertyName(\"exists\")]\n public bool Exists { get; set; }\n}\n\n/// RPC data type for SessionFsExists operations.\npublic sealed class SessionFsExistsRequest\n{\n /// Path using SessionFs conventions.\n [JsonPropertyName(\"path\")]\n public string Path { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for SessionFsStat operations.\npublic sealed class SessionFsStatResult\n{\n /// ISO 8601 timestamp of creation.\n [JsonPropertyName(\"birthtime\")]\n public DateTimeOffset Birthtime { get; set; }\n\n /// Describes a filesystem error.\n [JsonPropertyName(\"error\")]\n public SessionFsError? Error { get; set; }\n\n /// Whether the path is a directory.\n [JsonPropertyName(\"isDirectory\")]\n public bool IsDirectory { get; set; }\n\n /// Whether the path is a file.\n [JsonPropertyName(\"isFile\")]\n public bool IsFile { get; set; }\n\n /// ISO 8601 timestamp of last modification.\n [JsonPropertyName(\"mtime\")]\n public DateTimeOffset Mtime { get; set; }\n\n /// File size in bytes.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"size\")]\n public long Size { get; set; }\n}\n\n/// RPC data type for SessionFsStat operations.\npublic sealed class SessionFsStatRequest\n{\n /// Path using SessionFs conventions.\n [JsonPropertyName(\"path\")]\n public string Path { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for SessionFsMkdir operations.\npublic sealed class SessionFsMkdirRequest\n{\n /// Optional POSIX-style mode for newly created directories.\n [Range((double)0, (double)long.MaxValue)]\n [JsonPropertyName(\"mode\")]\n public long? Mode { get; set; }\n\n /// Path using SessionFs conventions.\n [JsonPropertyName(\"path\")]\n public string Path { get; set; } = string.Empty;\n\n /// Create parent directories as needed.\n [JsonPropertyName(\"recursive\")]\n public bool? Recursive { get; set; }\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for SessionFsReaddir operations.\npublic sealed class SessionFsReaddirResult\n{\n /// Entry names in the directory.\n [JsonPropertyName(\"entries\")]\n public IList Entries { get => field ??= []; set; }\n\n /// Describes a filesystem error.\n [JsonPropertyName(\"error\")]\n public SessionFsError? Error { get; set; }\n}\n\n/// RPC data type for SessionFsReaddir operations.\npublic sealed class SessionFsReaddirRequest\n{\n /// Path using SessionFs conventions.\n [JsonPropertyName(\"path\")]\n public string Path { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for SessionFsReaddirWithTypesEntry operations.\npublic sealed class SessionFsReaddirWithTypesEntry\n{\n /// Entry name.\n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n\n /// Entry type.\n [JsonPropertyName(\"type\")]\n public SessionFsReaddirWithTypesEntryType Type { get; set; }\n}\n\n/// RPC data type for SessionFsReaddirWithTypes operations.\npublic sealed class SessionFsReaddirWithTypesResult\n{\n /// Directory entries with type information.\n [JsonPropertyName(\"entries\")]\n public IList Entries { get => field ??= []; set; }\n\n /// Describes a filesystem error.\n [JsonPropertyName(\"error\")]\n public SessionFsError? Error { get; set; }\n}\n\n/// RPC data type for SessionFsReaddirWithTypes operations.\npublic sealed class SessionFsReaddirWithTypesRequest\n{\n /// Path using SessionFs conventions.\n [JsonPropertyName(\"path\")]\n public string Path { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for SessionFsRm operations.\npublic sealed class SessionFsRmRequest\n{\n /// Ignore errors if the path does not exist.\n [JsonPropertyName(\"force\")]\n public bool? Force { get; set; }\n\n /// Path using SessionFs conventions.\n [JsonPropertyName(\"path\")]\n public string Path { get; set; } = string.Empty;\n\n /// Remove directories and their contents recursively.\n [JsonPropertyName(\"recursive\")]\n public bool? Recursive { get; set; }\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n}\n\n/// RPC data type for SessionFsRename operations.\npublic sealed class SessionFsRenameRequest\n{\n /// Destination path using SessionFs conventions.\n [JsonPropertyName(\"dest\")]\n public string Dest { get; set; } = string.Empty;\n\n /// Target session identifier.\n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n\n /// Source path using SessionFs conventions.\n [JsonPropertyName(\"src\")]\n public string Src { get; set; } = string.Empty;\n}\n\n/// Configuration source.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum DiscoveredMcpServerSource\n{\n /// The user variant.\n [JsonStringEnumMemberName(\"user\")]\n User,\n /// The workspace variant.\n [JsonStringEnumMemberName(\"workspace\")]\n Workspace,\n /// The plugin variant.\n [JsonStringEnumMemberName(\"plugin\")]\n Plugin,\n /// The builtin variant.\n [JsonStringEnumMemberName(\"builtin\")]\n Builtin,\n}\n\n\n/// Server transport type: stdio, http, sse, or memory (local configs are normalized to stdio).\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum DiscoveredMcpServerType\n{\n /// The stdio variant.\n [JsonStringEnumMemberName(\"stdio\")]\n Stdio,\n /// The http variant.\n [JsonStringEnumMemberName(\"http\")]\n Http,\n /// The sse variant.\n [JsonStringEnumMemberName(\"sse\")]\n Sse,\n /// The memory variant.\n [JsonStringEnumMemberName(\"memory\")]\n Memory,\n}\n\n\n/// Path conventions used by this filesystem.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum SessionFsSetProviderConventions\n{\n /// The windows variant.\n [JsonStringEnumMemberName(\"windows\")]\n Windows,\n /// The posix variant.\n [JsonStringEnumMemberName(\"posix\")]\n Posix,\n}\n\n\n/// Log severity level. Determines how the message is displayed in the timeline. Defaults to \"info\".\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum SessionLogLevel\n{\n /// The info variant.\n [JsonStringEnumMemberName(\"info\")]\n Info,\n /// The warning variant.\n [JsonStringEnumMemberName(\"warning\")]\n Warning,\n /// The error variant.\n [JsonStringEnumMemberName(\"error\")]\n Error,\n}\n\n\n/// Authentication type.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum AuthInfoType\n{\n /// The hmac variant.\n [JsonStringEnumMemberName(\"hmac\")]\n Hmac,\n /// The env variant.\n [JsonStringEnumMemberName(\"env\")]\n Env,\n /// The user variant.\n [JsonStringEnumMemberName(\"user\")]\n User,\n /// The gh-cli variant.\n [JsonStringEnumMemberName(\"gh-cli\")]\n GhCli,\n /// The api-key variant.\n [JsonStringEnumMemberName(\"api-key\")]\n ApiKey,\n /// The token variant.\n [JsonStringEnumMemberName(\"token\")]\n Token,\n /// The copilot-api-token variant.\n [JsonStringEnumMemberName(\"copilot-api-token\")]\n CopilotApiToken,\n}\n\n\n/// The agent mode. Valid values: \"interactive\", \"plan\", \"autopilot\".\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum SessionMode\n{\n /// The interactive variant.\n [JsonStringEnumMemberName(\"interactive\")]\n Interactive,\n /// The plan variant.\n [JsonStringEnumMemberName(\"plan\")]\n Plan,\n /// The autopilot variant.\n [JsonStringEnumMemberName(\"autopilot\")]\n Autopilot,\n}\n\n\n/// Defines the allowed values.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum WorkspacesGetWorkspaceResultWorkspaceHostType\n{\n /// The github variant.\n [JsonStringEnumMemberName(\"github\")]\n Github,\n /// The ado variant.\n [JsonStringEnumMemberName(\"ado\")]\n Ado,\n}\n\n\n/// Defines the allowed values.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum WorkspacesGetWorkspaceResultWorkspaceSessionSyncLevel\n{\n /// The local variant.\n [JsonStringEnumMemberName(\"local\")]\n Local,\n /// The user variant.\n [JsonStringEnumMemberName(\"user\")]\n User,\n /// The repo_and_user variant.\n [JsonStringEnumMemberName(\"repo_and_user\")]\n RepoAndUser,\n}\n\n\n/// Where this source lives — used for UI grouping.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum InstructionsSourcesLocation\n{\n /// The user variant.\n [JsonStringEnumMemberName(\"user\")]\n User,\n /// The repository variant.\n [JsonStringEnumMemberName(\"repository\")]\n Repository,\n /// The working-directory variant.\n [JsonStringEnumMemberName(\"working-directory\")]\n WorkingDirectory,\n}\n\n\n/// Category of instruction source — used for merge logic.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum InstructionsSourcesType\n{\n /// The home variant.\n [JsonStringEnumMemberName(\"home\")]\n Home,\n /// The repo variant.\n [JsonStringEnumMemberName(\"repo\")]\n Repo,\n /// The model variant.\n [JsonStringEnumMemberName(\"model\")]\n Model,\n /// The vscode variant.\n [JsonStringEnumMemberName(\"vscode\")]\n Vscode,\n /// The nested-agents variant.\n [JsonStringEnumMemberName(\"nested-agents\")]\n NestedAgents,\n /// The child-instructions variant.\n [JsonStringEnumMemberName(\"child-instructions\")]\n ChildInstructions,\n}\n\n\n/// How the agent is currently being managed by the runtime.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum TaskAgentInfoExecutionMode\n{\n /// The sync variant.\n [JsonStringEnumMemberName(\"sync\")]\n Sync,\n /// The background variant.\n [JsonStringEnumMemberName(\"background\")]\n Background,\n}\n\n\n/// Current lifecycle status of the task.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum TaskAgentInfoStatus\n{\n /// The running variant.\n [JsonStringEnumMemberName(\"running\")]\n Running,\n /// The idle variant.\n [JsonStringEnumMemberName(\"idle\")]\n Idle,\n /// The completed variant.\n [JsonStringEnumMemberName(\"completed\")]\n Completed,\n /// The failed variant.\n [JsonStringEnumMemberName(\"failed\")]\n Failed,\n /// The cancelled variant.\n [JsonStringEnumMemberName(\"cancelled\")]\n Cancelled,\n}\n\n\n/// Whether the shell runs inside a managed PTY session or as an independent background process.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum TaskShellInfoAttachmentMode\n{\n /// The attached variant.\n [JsonStringEnumMemberName(\"attached\")]\n Attached,\n /// The detached variant.\n [JsonStringEnumMemberName(\"detached\")]\n Detached,\n}\n\n\n/// Whether the shell command is currently sync-waited or background-managed.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum TaskShellInfoExecutionMode\n{\n /// The sync variant.\n [JsonStringEnumMemberName(\"sync\")]\n Sync,\n /// The background variant.\n [JsonStringEnumMemberName(\"background\")]\n Background,\n}\n\n\n/// Current lifecycle status of the task.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum TaskShellInfoStatus\n{\n /// The running variant.\n [JsonStringEnumMemberName(\"running\")]\n Running,\n /// The idle variant.\n [JsonStringEnumMemberName(\"idle\")]\n Idle,\n /// The completed variant.\n [JsonStringEnumMemberName(\"completed\")]\n Completed,\n /// The failed variant.\n [JsonStringEnumMemberName(\"failed\")]\n Failed,\n /// The cancelled variant.\n [JsonStringEnumMemberName(\"cancelled\")]\n Cancelled,\n}\n\n\n/// Configuration source: user, workspace, plugin, or builtin.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum McpServerSource\n{\n /// The user variant.\n [JsonStringEnumMemberName(\"user\")]\n User,\n /// The workspace variant.\n [JsonStringEnumMemberName(\"workspace\")]\n Workspace,\n /// The plugin variant.\n [JsonStringEnumMemberName(\"plugin\")]\n Plugin,\n /// The builtin variant.\n [JsonStringEnumMemberName(\"builtin\")]\n Builtin,\n}\n\n\n/// Connection status: connected, failed, needs-auth, pending, disabled, or not_configured.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum McpServerStatus\n{\n /// The connected variant.\n [JsonStringEnumMemberName(\"connected\")]\n Connected,\n /// The failed variant.\n [JsonStringEnumMemberName(\"failed\")]\n Failed,\n /// The needs-auth variant.\n [JsonStringEnumMemberName(\"needs-auth\")]\n NeedsAuth,\n /// The pending variant.\n [JsonStringEnumMemberName(\"pending\")]\n Pending,\n /// The disabled variant.\n [JsonStringEnumMemberName(\"disabled\")]\n Disabled,\n /// The not_configured variant.\n [JsonStringEnumMemberName(\"not_configured\")]\n NotConfigured,\n}\n\n\n/// Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/).\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum ExtensionSource\n{\n /// The project variant.\n [JsonStringEnumMemberName(\"project\")]\n Project,\n /// The user variant.\n [JsonStringEnumMemberName(\"user\")]\n User,\n}\n\n\n/// Current status: running, disabled, failed, or starting.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum ExtensionStatus\n{\n /// The running variant.\n [JsonStringEnumMemberName(\"running\")]\n Running,\n /// The disabled variant.\n [JsonStringEnumMemberName(\"disabled\")]\n Disabled,\n /// The failed variant.\n [JsonStringEnumMemberName(\"failed\")]\n Failed,\n /// The starting variant.\n [JsonStringEnumMemberName(\"starting\")]\n Starting,\n}\n\n\n/// The user's response: accept (submitted), decline (rejected), or cancel (dismissed).\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum UIElicitationResponseAction\n{\n /// The accept variant.\n [JsonStringEnumMemberName(\"accept\")]\n Accept,\n /// The decline variant.\n [JsonStringEnumMemberName(\"decline\")]\n Decline,\n /// The cancel variant.\n [JsonStringEnumMemberName(\"cancel\")]\n Cancel,\n}\n\n\n/// Signal to send (default: SIGTERM).\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum ShellKillSignal\n{\n /// The SIGTERM variant.\n [JsonStringEnumMemberName(\"SIGTERM\")]\n SIGTERM,\n /// The SIGKILL variant.\n [JsonStringEnumMemberName(\"SIGKILL\")]\n SIGKILL,\n /// The SIGINT variant.\n [JsonStringEnumMemberName(\"SIGINT\")]\n SIGINT,\n}\n\n\n/// Error classification.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum SessionFsErrorCode\n{\n /// The ENOENT variant.\n [JsonStringEnumMemberName(\"ENOENT\")]\n ENOENT,\n /// The UNKNOWN variant.\n [JsonStringEnumMemberName(\"UNKNOWN\")]\n UNKNOWN,\n}\n\n\n/// Entry type.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum SessionFsReaddirWithTypesEntryType\n{\n /// The file variant.\n [JsonStringEnumMemberName(\"file\")]\n File,\n /// The directory variant.\n [JsonStringEnumMemberName(\"directory\")]\n Directory,\n}\n\n\n/// Provides server-scoped RPC methods (no session required).\npublic sealed class ServerRpc\n{\n private readonly JsonRpc _rpc;\n\n internal ServerRpc(JsonRpc rpc)\n {\n _rpc = rpc;\n Models = new ServerModelsApi(rpc);\n Tools = new ServerToolsApi(rpc);\n Account = new ServerAccountApi(rpc);\n Mcp = new ServerMcpApi(rpc);\n Skills = new ServerSkillsApi(rpc);\n SessionFs = new ServerSessionFsApi(rpc);\n Sessions = new ServerSessionsApi(rpc);\n }\n\n /// Calls \"ping\".\n public async Task PingAsync(string? message = null, CancellationToken cancellationToken = default)\n {\n var request = new PingRequest { Message = message };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"ping\", [request], cancellationToken);\n }\n\n /// Models APIs.\n public ServerModelsApi Models { get; }\n\n /// Tools APIs.\n public ServerToolsApi Tools { get; }\n\n /// Account APIs.\n public ServerAccountApi Account { get; }\n\n /// Mcp APIs.\n public ServerMcpApi Mcp { get; }\n\n /// Skills APIs.\n public ServerSkillsApi Skills { get; }\n\n /// SessionFs APIs.\n public ServerSessionFsApi SessionFs { get; }\n\n /// Sessions APIs.\n public ServerSessionsApi Sessions { get; }\n}\n\n/// Provides server-scoped Models APIs.\npublic sealed class ServerModelsApi\n{\n private readonly JsonRpc _rpc;\n\n internal ServerModelsApi(JsonRpc rpc)\n {\n _rpc = rpc;\n }\n\n /// Calls \"models.list\".\n public async Task ListAsync(string? gitHubToken = null, CancellationToken cancellationToken = default)\n {\n var request = new ModelsListRequest { GitHubToken = gitHubToken };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"models.list\", [request], cancellationToken);\n }\n}\n\n/// Provides server-scoped Tools APIs.\npublic sealed class ServerToolsApi\n{\n private readonly JsonRpc _rpc;\n\n internal ServerToolsApi(JsonRpc rpc)\n {\n _rpc = rpc;\n }\n\n /// Calls \"tools.list\".\n public async Task ListAsync(string? model = null, CancellationToken cancellationToken = default)\n {\n var request = new ToolsListRequest { Model = model };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"tools.list\", [request], cancellationToken);\n }\n}\n\n/// Provides server-scoped Account APIs.\npublic sealed class ServerAccountApi\n{\n private readonly JsonRpc _rpc;\n\n internal ServerAccountApi(JsonRpc rpc)\n {\n _rpc = rpc;\n }\n\n /// Calls \"account.getQuota\".\n public async Task GetQuotaAsync(string? gitHubToken = null, CancellationToken cancellationToken = default)\n {\n var request = new AccountGetQuotaRequest { GitHubToken = gitHubToken };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"account.getQuota\", [request], cancellationToken);\n }\n}\n\n/// Provides server-scoped Mcp APIs.\npublic sealed class ServerMcpApi\n{\n private readonly JsonRpc _rpc;\n\n internal ServerMcpApi(JsonRpc rpc)\n {\n _rpc = rpc;\n Config = new ServerMcpConfigApi(rpc);\n }\n\n /// Calls \"mcp.discover\".\n public async Task DiscoverAsync(string? workingDirectory = null, CancellationToken cancellationToken = default)\n {\n var request = new McpDiscoverRequest { WorkingDirectory = workingDirectory };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"mcp.discover\", [request], cancellationToken);\n }\n\n /// Config APIs.\n public ServerMcpConfigApi Config { get; }\n}\n\n/// Provides server-scoped McpConfig APIs.\npublic sealed class ServerMcpConfigApi\n{\n private readonly JsonRpc _rpc;\n\n internal ServerMcpConfigApi(JsonRpc rpc)\n {\n _rpc = rpc;\n }\n\n /// Calls \"mcp.config.list\".\n public async Task ListAsync(CancellationToken cancellationToken = default)\n {\n return await CopilotClient.InvokeRpcAsync(_rpc, \"mcp.config.list\", [], cancellationToken);\n }\n\n /// Calls \"mcp.config.add\".\n public async Task AddAsync(string name, object config, CancellationToken cancellationToken = default)\n {\n var request = new McpConfigAddRequest { Name = name, Config = config };\n await CopilotClient.InvokeRpcAsync(_rpc, \"mcp.config.add\", [request], cancellationToken);\n }\n\n /// Calls \"mcp.config.update\".\n public async Task UpdateAsync(string name, object config, CancellationToken cancellationToken = default)\n {\n var request = new McpConfigUpdateRequest { Name = name, Config = config };\n await CopilotClient.InvokeRpcAsync(_rpc, \"mcp.config.update\", [request], cancellationToken);\n }\n\n /// Calls \"mcp.config.remove\".\n public async Task RemoveAsync(string name, CancellationToken cancellationToken = default)\n {\n var request = new McpConfigRemoveRequest { Name = name };\n await CopilotClient.InvokeRpcAsync(_rpc, \"mcp.config.remove\", [request], cancellationToken);\n }\n\n /// Calls \"mcp.config.enable\".\n public async Task EnableAsync(IList names, CancellationToken cancellationToken = default)\n {\n var request = new McpConfigEnableRequest { Names = names };\n await CopilotClient.InvokeRpcAsync(_rpc, \"mcp.config.enable\", [request], cancellationToken);\n }\n\n /// Calls \"mcp.config.disable\".\n public async Task DisableAsync(IList names, CancellationToken cancellationToken = default)\n {\n var request = new McpConfigDisableRequest { Names = names };\n await CopilotClient.InvokeRpcAsync(_rpc, \"mcp.config.disable\", [request], cancellationToken);\n }\n}\n\n/// Provides server-scoped Skills APIs.\npublic sealed class ServerSkillsApi\n{\n private readonly JsonRpc _rpc;\n\n internal ServerSkillsApi(JsonRpc rpc)\n {\n _rpc = rpc;\n Config = new ServerSkillsConfigApi(rpc);\n }\n\n /// Calls \"skills.discover\".\n public async Task DiscoverAsync(IList? projectPaths = null, IList? skillDirectories = null, CancellationToken cancellationToken = default)\n {\n var request = new SkillsDiscoverRequest { ProjectPaths = projectPaths, SkillDirectories = skillDirectories };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"skills.discover\", [request], cancellationToken);\n }\n\n /// Config APIs.\n public ServerSkillsConfigApi Config { get; }\n}\n\n/// Provides server-scoped SkillsConfig APIs.\npublic sealed class ServerSkillsConfigApi\n{\n private readonly JsonRpc _rpc;\n\n internal ServerSkillsConfigApi(JsonRpc rpc)\n {\n _rpc = rpc;\n }\n\n /// Calls \"skills.config.setDisabledSkills\".\n public async Task SetDisabledSkillsAsync(IList disabledSkills, CancellationToken cancellationToken = default)\n {\n var request = new SkillsConfigSetDisabledSkillsRequest { DisabledSkills = disabledSkills };\n await CopilotClient.InvokeRpcAsync(_rpc, \"skills.config.setDisabledSkills\", [request], cancellationToken);\n }\n}\n\n/// Provides server-scoped SessionFs APIs.\npublic sealed class ServerSessionFsApi\n{\n private readonly JsonRpc _rpc;\n\n internal ServerSessionFsApi(JsonRpc rpc)\n {\n _rpc = rpc;\n }\n\n /// Calls \"sessionFs.setProvider\".\n public async Task SetProviderAsync(string initialCwd, string sessionStatePath, SessionFsSetProviderConventions conventions, CancellationToken cancellationToken = default)\n {\n var request = new SessionFsSetProviderRequest { InitialCwd = initialCwd, SessionStatePath = sessionStatePath, Conventions = conventions };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"sessionFs.setProvider\", [request], cancellationToken);\n }\n}\n\n/// Provides server-scoped Sessions APIs.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class ServerSessionsApi\n{\n private readonly JsonRpc _rpc;\n\n internal ServerSessionsApi(JsonRpc rpc)\n {\n _rpc = rpc;\n }\n\n /// Calls \"sessions.fork\".\n public async Task ForkAsync(string sessionId, string? toEventId = null, CancellationToken cancellationToken = default)\n {\n var request = new SessionsForkRequest { SessionId = sessionId, ToEventId = toEventId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"sessions.fork\", [request], cancellationToken);\n }\n}\n\n/// Provides typed session-scoped RPC methods.\npublic sealed class SessionRpc\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal SessionRpc(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n Auth = new AuthApi(rpc, sessionId);\n Model = new ModelApi(rpc, sessionId);\n Mode = new ModeApi(rpc, sessionId);\n Name = new NameApi(rpc, sessionId);\n Plan = new PlanApi(rpc, sessionId);\n Workspaces = new WorkspacesApi(rpc, sessionId);\n Instructions = new InstructionsApi(rpc, sessionId);\n Fleet = new FleetApi(rpc, sessionId);\n Agent = new AgentApi(rpc, sessionId);\n Tasks = new TasksApi(rpc, sessionId);\n Skills = new SkillsApi(rpc, sessionId);\n Mcp = new McpApi(rpc, sessionId);\n Plugins = new PluginsApi(rpc, sessionId);\n Extensions = new ExtensionsApi(rpc, sessionId);\n Tools = new ToolsApi(rpc, sessionId);\n Commands = new CommandsApi(rpc, sessionId);\n Ui = new UiApi(rpc, sessionId);\n Permissions = new PermissionsApi(rpc, sessionId);\n Shell = new ShellApi(rpc, sessionId);\n History = new HistoryApi(rpc, sessionId);\n Usage = new UsageApi(rpc, sessionId);\n }\n\n /// Auth APIs.\n public AuthApi Auth { get; }\n\n /// Model APIs.\n public ModelApi Model { get; }\n\n /// Mode APIs.\n public ModeApi Mode { get; }\n\n /// Name APIs.\n public NameApi Name { get; }\n\n /// Plan APIs.\n public PlanApi Plan { get; }\n\n /// Workspaces APIs.\n public WorkspacesApi Workspaces { get; }\n\n /// Instructions APIs.\n public InstructionsApi Instructions { get; }\n\n /// Fleet APIs.\n public FleetApi Fleet { get; }\n\n /// Agent APIs.\n public AgentApi Agent { get; }\n\n /// Tasks APIs.\n public TasksApi Tasks { get; }\n\n /// Skills APIs.\n public SkillsApi Skills { get; }\n\n /// Mcp APIs.\n public McpApi Mcp { get; }\n\n /// Plugins APIs.\n public PluginsApi Plugins { get; }\n\n /// Extensions APIs.\n public ExtensionsApi Extensions { get; }\n\n /// Tools APIs.\n public ToolsApi Tools { get; }\n\n /// Commands APIs.\n public CommandsApi Commands { get; }\n\n /// Ui APIs.\n public UiApi Ui { get; }\n\n /// Permissions APIs.\n public PermissionsApi Permissions { get; }\n\n /// Shell APIs.\n public ShellApi Shell { get; }\n\n /// History APIs.\n public HistoryApi History { get; }\n\n /// Usage APIs.\n public UsageApi Usage { get; }\n\n /// Calls \"session.suspend\".\n public async Task SuspendAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionSuspendRequest { SessionId = _sessionId };\n await CopilotClient.InvokeRpcAsync(_rpc, \"session.suspend\", [request], cancellationToken);\n }\n\n /// Calls \"session.log\".\n public async Task LogAsync(string message, SessionLogLevel? level = null, bool? ephemeral = null, string? url = null, CancellationToken cancellationToken = default)\n {\n var request = new LogRequest { SessionId = _sessionId, Message = message, Level = level, Ephemeral = ephemeral, Url = url };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.log\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Auth APIs.\npublic sealed class AuthApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal AuthApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.auth.getStatus\".\n public async Task GetStatusAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionAuthGetStatusRequest { SessionId = _sessionId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.auth.getStatus\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Model APIs.\npublic sealed class ModelApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal ModelApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.model.getCurrent\".\n public async Task GetCurrentAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionModelGetCurrentRequest { SessionId = _sessionId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.model.getCurrent\", [request], cancellationToken);\n }\n\n /// Calls \"session.model.switchTo\".\n public async Task SwitchToAsync(string modelId, string? reasoningEffort = null, ModelCapabilitiesOverride? modelCapabilities = null, CancellationToken cancellationToken = default)\n {\n var request = new ModelSwitchToRequest { SessionId = _sessionId, ModelId = modelId, ReasoningEffort = reasoningEffort, ModelCapabilities = modelCapabilities };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.model.switchTo\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Mode APIs.\npublic sealed class ModeApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal ModeApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.mode.get\".\n public async Task GetAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionModeGetRequest { SessionId = _sessionId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.mode.get\", [request], cancellationToken);\n }\n\n /// Calls \"session.mode.set\".\n public async Task SetAsync(SessionMode mode, CancellationToken cancellationToken = default)\n {\n var request = new ModeSetRequest { SessionId = _sessionId, Mode = mode };\n await CopilotClient.InvokeRpcAsync(_rpc, \"session.mode.set\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Name APIs.\npublic sealed class NameApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal NameApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.name.get\".\n public async Task GetAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionNameGetRequest { SessionId = _sessionId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.name.get\", [request], cancellationToken);\n }\n\n /// Calls \"session.name.set\".\n public async Task SetAsync(string name, CancellationToken cancellationToken = default)\n {\n var request = new NameSetRequest { SessionId = _sessionId, Name = name };\n await CopilotClient.InvokeRpcAsync(_rpc, \"session.name.set\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Plan APIs.\npublic sealed class PlanApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal PlanApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.plan.read\".\n public async Task ReadAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionPlanReadRequest { SessionId = _sessionId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.plan.read\", [request], cancellationToken);\n }\n\n /// Calls \"session.plan.update\".\n public async Task UpdateAsync(string content, CancellationToken cancellationToken = default)\n {\n var request = new PlanUpdateRequest { SessionId = _sessionId, Content = content };\n await CopilotClient.InvokeRpcAsync(_rpc, \"session.plan.update\", [request], cancellationToken);\n }\n\n /// Calls \"session.plan.delete\".\n public async Task DeleteAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionPlanDeleteRequest { SessionId = _sessionId };\n await CopilotClient.InvokeRpcAsync(_rpc, \"session.plan.delete\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Workspaces APIs.\npublic sealed class WorkspacesApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal WorkspacesApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.workspaces.getWorkspace\".\n public async Task GetWorkspaceAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionWorkspacesGetWorkspaceRequest { SessionId = _sessionId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.workspaces.getWorkspace\", [request], cancellationToken);\n }\n\n /// Calls \"session.workspaces.listFiles\".\n public async Task ListFilesAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionWorkspacesListFilesRequest { SessionId = _sessionId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.workspaces.listFiles\", [request], cancellationToken);\n }\n\n /// Calls \"session.workspaces.readFile\".\n public async Task ReadFileAsync(string path, CancellationToken cancellationToken = default)\n {\n var request = new WorkspacesReadFileRequest { SessionId = _sessionId, Path = path };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.workspaces.readFile\", [request], cancellationToken);\n }\n\n /// Calls \"session.workspaces.createFile\".\n public async Task CreateFileAsync(string path, string content, CancellationToken cancellationToken = default)\n {\n var request = new WorkspacesCreateFileRequest { SessionId = _sessionId, Path = path, Content = content };\n await CopilotClient.InvokeRpcAsync(_rpc, \"session.workspaces.createFile\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Instructions APIs.\npublic sealed class InstructionsApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal InstructionsApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.instructions.getSources\".\n public async Task GetSourcesAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionInstructionsGetSourcesRequest { SessionId = _sessionId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.instructions.getSources\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Fleet APIs.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class FleetApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal FleetApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.fleet.start\".\n public async Task StartAsync(string? prompt = null, CancellationToken cancellationToken = default)\n {\n var request = new FleetStartRequest { SessionId = _sessionId, Prompt = prompt };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.fleet.start\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Agent APIs.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class AgentApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal AgentApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.agent.list\".\n public async Task ListAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionAgentListRequest { SessionId = _sessionId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.agent.list\", [request], cancellationToken);\n }\n\n /// Calls \"session.agent.getCurrent\".\n public async Task GetCurrentAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionAgentGetCurrentRequest { SessionId = _sessionId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.agent.getCurrent\", [request], cancellationToken);\n }\n\n /// Calls \"session.agent.select\".\n public async Task SelectAsync(string name, CancellationToken cancellationToken = default)\n {\n var request = new AgentSelectRequest { SessionId = _sessionId, Name = name };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.agent.select\", [request], cancellationToken);\n }\n\n /// Calls \"session.agent.deselect\".\n public async Task DeselectAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionAgentDeselectRequest { SessionId = _sessionId };\n await CopilotClient.InvokeRpcAsync(_rpc, \"session.agent.deselect\", [request], cancellationToken);\n }\n\n /// Calls \"session.agent.reload\".\n public async Task ReloadAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionAgentReloadRequest { SessionId = _sessionId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.agent.reload\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Tasks APIs.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class TasksApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal TasksApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.tasks.startAgent\".\n public async Task StartAgentAsync(string agentType, string prompt, string name, string? description = null, string? model = null, CancellationToken cancellationToken = default)\n {\n var request = new TasksStartAgentRequest { SessionId = _sessionId, AgentType = agentType, Prompt = prompt, Name = name, Description = description, Model = model };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.tasks.startAgent\", [request], cancellationToken);\n }\n\n /// Calls \"session.tasks.list\".\n public async Task ListAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionTasksListRequest { SessionId = _sessionId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.tasks.list\", [request], cancellationToken);\n }\n\n /// Calls \"session.tasks.promoteToBackground\".\n public async Task PromoteToBackgroundAsync(string id, CancellationToken cancellationToken = default)\n {\n var request = new TasksPromoteToBackgroundRequest { SessionId = _sessionId, Id = id };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.tasks.promoteToBackground\", [request], cancellationToken);\n }\n\n /// Calls \"session.tasks.cancel\".\n public async Task CancelAsync(string id, CancellationToken cancellationToken = default)\n {\n var request = new TasksCancelRequest { SessionId = _sessionId, Id = id };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.tasks.cancel\", [request], cancellationToken);\n }\n\n /// Calls \"session.tasks.remove\".\n public async Task RemoveAsync(string id, CancellationToken cancellationToken = default)\n {\n var request = new TasksRemoveRequest { SessionId = _sessionId, Id = id };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.tasks.remove\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Skills APIs.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class SkillsApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal SkillsApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.skills.list\".\n public async Task ListAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionSkillsListRequest { SessionId = _sessionId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.skills.list\", [request], cancellationToken);\n }\n\n /// Calls \"session.skills.enable\".\n public async Task EnableAsync(string name, CancellationToken cancellationToken = default)\n {\n var request = new SkillsEnableRequest { SessionId = _sessionId, Name = name };\n await CopilotClient.InvokeRpcAsync(_rpc, \"session.skills.enable\", [request], cancellationToken);\n }\n\n /// Calls \"session.skills.disable\".\n public async Task DisableAsync(string name, CancellationToken cancellationToken = default)\n {\n var request = new SkillsDisableRequest { SessionId = _sessionId, Name = name };\n await CopilotClient.InvokeRpcAsync(_rpc, \"session.skills.disable\", [request], cancellationToken);\n }\n\n /// Calls \"session.skills.reload\".\n public async Task ReloadAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionSkillsReloadRequest { SessionId = _sessionId };\n await CopilotClient.InvokeRpcAsync(_rpc, \"session.skills.reload\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Mcp APIs.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class McpApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal McpApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n Oauth = new McpOauthApi(rpc, sessionId);\n }\n\n /// Calls \"session.mcp.list\".\n public async Task ListAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionMcpListRequest { SessionId = _sessionId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.mcp.list\", [request], cancellationToken);\n }\n\n /// Calls \"session.mcp.enable\".\n public async Task EnableAsync(string serverName, CancellationToken cancellationToken = default)\n {\n var request = new McpEnableRequest { SessionId = _sessionId, ServerName = serverName };\n await CopilotClient.InvokeRpcAsync(_rpc, \"session.mcp.enable\", [request], cancellationToken);\n }\n\n /// Calls \"session.mcp.disable\".\n public async Task DisableAsync(string serverName, CancellationToken cancellationToken = default)\n {\n var request = new McpDisableRequest { SessionId = _sessionId, ServerName = serverName };\n await CopilotClient.InvokeRpcAsync(_rpc, \"session.mcp.disable\", [request], cancellationToken);\n }\n\n /// Calls \"session.mcp.reload\".\n public async Task ReloadAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionMcpReloadRequest { SessionId = _sessionId };\n await CopilotClient.InvokeRpcAsync(_rpc, \"session.mcp.reload\", [request], cancellationToken);\n }\n\n /// Oauth APIs.\n public McpOauthApi Oauth { get; }\n}\n\n/// Provides session-scoped McpOauth APIs.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class McpOauthApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal McpOauthApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.mcp.oauth.login\".\n public async Task LoginAsync(string serverName, bool? forceReauth = null, string? clientName = null, string? callbackSuccessMessage = null, CancellationToken cancellationToken = default)\n {\n var request = new McpOauthLoginRequest { SessionId = _sessionId, ServerName = serverName, ForceReauth = forceReauth, ClientName = clientName, CallbackSuccessMessage = callbackSuccessMessage };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.mcp.oauth.login\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Plugins APIs.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class PluginsApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal PluginsApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.plugins.list\".\n public async Task ListAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionPluginsListRequest { SessionId = _sessionId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.plugins.list\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Extensions APIs.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class ExtensionsApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal ExtensionsApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.extensions.list\".\n public async Task ListAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionExtensionsListRequest { SessionId = _sessionId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.extensions.list\", [request], cancellationToken);\n }\n\n /// Calls \"session.extensions.enable\".\n public async Task EnableAsync(string id, CancellationToken cancellationToken = default)\n {\n var request = new ExtensionsEnableRequest { SessionId = _sessionId, Id = id };\n await CopilotClient.InvokeRpcAsync(_rpc, \"session.extensions.enable\", [request], cancellationToken);\n }\n\n /// Calls \"session.extensions.disable\".\n public async Task DisableAsync(string id, CancellationToken cancellationToken = default)\n {\n var request = new ExtensionsDisableRequest { SessionId = _sessionId, Id = id };\n await CopilotClient.InvokeRpcAsync(_rpc, \"session.extensions.disable\", [request], cancellationToken);\n }\n\n /// Calls \"session.extensions.reload\".\n public async Task ReloadAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionExtensionsReloadRequest { SessionId = _sessionId };\n await CopilotClient.InvokeRpcAsync(_rpc, \"session.extensions.reload\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Tools APIs.\npublic sealed class ToolsApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal ToolsApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.tools.handlePendingToolCall\".\n public async Task HandlePendingToolCallAsync(string requestId, object? result = null, string? error = null, CancellationToken cancellationToken = default)\n {\n var request = new HandlePendingToolCallRequest { SessionId = _sessionId, RequestId = requestId, Result = result, Error = error };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.tools.handlePendingToolCall\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Commands APIs.\npublic sealed class CommandsApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal CommandsApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.commands.handlePendingCommand\".\n public async Task HandlePendingCommandAsync(string requestId, string? error = null, CancellationToken cancellationToken = default)\n {\n var request = new CommandsHandlePendingCommandRequest { SessionId = _sessionId, RequestId = requestId, Error = error };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.commands.handlePendingCommand\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Ui APIs.\npublic sealed class UiApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal UiApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.ui.elicitation\".\n public async Task ElicitationAsync(string message, UIElicitationSchema requestedSchema, CancellationToken cancellationToken = default)\n {\n var request = new UIElicitationRequest { SessionId = _sessionId, Message = message, RequestedSchema = requestedSchema };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.ui.elicitation\", [request], cancellationToken);\n }\n\n /// Calls \"session.ui.handlePendingElicitation\".\n public async Task HandlePendingElicitationAsync(string requestId, UIElicitationResponse result, CancellationToken cancellationToken = default)\n {\n var request = new UIHandlePendingElicitationRequest { SessionId = _sessionId, RequestId = requestId, Result = result };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.ui.handlePendingElicitation\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Permissions APIs.\npublic sealed class PermissionsApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal PermissionsApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.permissions.handlePendingPermissionRequest\".\n public async Task HandlePendingPermissionRequestAsync(string requestId, PermissionDecision result, CancellationToken cancellationToken = default)\n {\n var request = new PermissionDecisionRequest { SessionId = _sessionId, RequestId = requestId, Result = result };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.permissions.handlePendingPermissionRequest\", [request], cancellationToken);\n }\n\n /// Calls \"session.permissions.setApproveAll\".\n public async Task SetApproveAllAsync(bool enabled, CancellationToken cancellationToken = default)\n {\n var request = new PermissionsSetApproveAllRequest { SessionId = _sessionId, Enabled = enabled };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.permissions.setApproveAll\", [request], cancellationToken);\n }\n\n /// Calls \"session.permissions.resetSessionApprovals\".\n public async Task ResetSessionApprovalsAsync(CancellationToken cancellationToken = default)\n {\n var request = new PermissionsResetSessionApprovalsRequest { SessionId = _sessionId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.permissions.resetSessionApprovals\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Shell APIs.\npublic sealed class ShellApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal ShellApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.shell.exec\".\n public async Task ExecAsync(string command, string? cwd = null, TimeSpan? timeout = null, CancellationToken cancellationToken = default)\n {\n var request = new ShellExecRequest { SessionId = _sessionId, Command = command, Cwd = cwd, Timeout = timeout };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.shell.exec\", [request], cancellationToken);\n }\n\n /// Calls \"session.shell.kill\".\n public async Task KillAsync(string processId, ShellKillSignal? signal = null, CancellationToken cancellationToken = default)\n {\n var request = new ShellKillRequest { SessionId = _sessionId, ProcessId = processId, Signal = signal };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.shell.kill\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped History APIs.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class HistoryApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal HistoryApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.history.compact\".\n public async Task CompactAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionHistoryCompactRequest { SessionId = _sessionId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.history.compact\", [request], cancellationToken);\n }\n\n /// Calls \"session.history.truncate\".\n public async Task TruncateAsync(string eventId, CancellationToken cancellationToken = default)\n {\n var request = new HistoryTruncateRequest { SessionId = _sessionId, EventId = eventId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.history.truncate\", [request], cancellationToken);\n }\n}\n\n/// Provides session-scoped Usage APIs.\n[Experimental(Diagnostics.Experimental)]\npublic sealed class UsageApi\n{\n private readonly JsonRpc _rpc;\n private readonly string _sessionId;\n\n internal UsageApi(JsonRpc rpc, string sessionId)\n {\n _rpc = rpc;\n _sessionId = sessionId;\n }\n\n /// Calls \"session.usage.getMetrics\".\n public async Task GetMetricsAsync(CancellationToken cancellationToken = default)\n {\n var request = new SessionUsageGetMetricsRequest { SessionId = _sessionId };\n return await CopilotClient.InvokeRpcAsync(_rpc, \"session.usage.getMetrics\", [request], cancellationToken);\n }\n}\n\n/// Handles `sessionFs` client session API methods.\npublic interface ISessionFsHandler\n{\n /// Handles \"sessionFs.readFile\".\n Task ReadFileAsync(SessionFsReadFileRequest request, CancellationToken cancellationToken = default);\n /// Handles \"sessionFs.writeFile\".\n Task WriteFileAsync(SessionFsWriteFileRequest request, CancellationToken cancellationToken = default);\n /// Handles \"sessionFs.appendFile\".\n Task AppendFileAsync(SessionFsAppendFileRequest request, CancellationToken cancellationToken = default);\n /// Handles \"sessionFs.exists\".\n Task ExistsAsync(SessionFsExistsRequest request, CancellationToken cancellationToken = default);\n /// Handles \"sessionFs.stat\".\n Task StatAsync(SessionFsStatRequest request, CancellationToken cancellationToken = default);\n /// Handles \"sessionFs.mkdir\".\n Task MkdirAsync(SessionFsMkdirRequest request, CancellationToken cancellationToken = default);\n /// Handles \"sessionFs.readdir\".\n Task ReaddirAsync(SessionFsReaddirRequest request, CancellationToken cancellationToken = default);\n /// Handles \"sessionFs.readdirWithTypes\".\n Task ReaddirWithTypesAsync(SessionFsReaddirWithTypesRequest request, CancellationToken cancellationToken = default);\n /// Handles \"sessionFs.rm\".\n Task RmAsync(SessionFsRmRequest request, CancellationToken cancellationToken = default);\n /// Handles \"sessionFs.rename\".\n Task RenameAsync(SessionFsRenameRequest request, CancellationToken cancellationToken = default);\n}\n\n/// Provides all client session API handler groups for a session.\npublic sealed class ClientSessionApiHandlers\n{\n /// Optional handler for SessionFs client session API methods.\n public ISessionFsHandler? SessionFs { get; set; }\n}\n\n/// Registers client session API handlers on a JSON-RPC connection.\ninternal static class ClientSessionApiRegistration\n{\n /// \n /// Registers handlers for server-to-client session API calls.\n /// Each incoming call includes a sessionId in its params object,\n /// which is used to resolve the session's handler group.\n /// \n public static void RegisterClientSessionApiHandlers(JsonRpc rpc, Func getHandlers)\n {\n rpc.SetLocalRpcMethod(\"sessionFs.readFile\", (Func>)(async (request, cancellationToken) =>\n {\n var handler = getHandlers(request.SessionId).SessionFs;\n if (handler is null) throw new InvalidOperationException($\"No sessionFs handler registered for session: {request.SessionId}\");\n return await handler.ReadFileAsync(request, cancellationToken);\n }), singleObjectParam: true);\n rpc.SetLocalRpcMethod(\"sessionFs.writeFile\", (Func>)(async (request, cancellationToken) =>\n {\n var handler = getHandlers(request.SessionId).SessionFs;\n if (handler is null) throw new InvalidOperationException($\"No sessionFs handler registered for session: {request.SessionId}\");\n return await handler.WriteFileAsync(request, cancellationToken);\n }), singleObjectParam: true);\n rpc.SetLocalRpcMethod(\"sessionFs.appendFile\", (Func>)(async (request, cancellationToken) =>\n {\n var handler = getHandlers(request.SessionId).SessionFs;\n if (handler is null) throw new InvalidOperationException($\"No sessionFs handler registered for session: {request.SessionId}\");\n return await handler.AppendFileAsync(request, cancellationToken);\n }), singleObjectParam: true);\n rpc.SetLocalRpcMethod(\"sessionFs.exists\", (Func>)(async (request, cancellationToken) =>\n {\n var handler = getHandlers(request.SessionId).SessionFs;\n if (handler is null) throw new InvalidOperationException($\"No sessionFs handler registered for session: {request.SessionId}\");\n return await handler.ExistsAsync(request, cancellationToken);\n }), singleObjectParam: true);\n rpc.SetLocalRpcMethod(\"sessionFs.stat\", (Func>)(async (request, cancellationToken) =>\n {\n var handler = getHandlers(request.SessionId).SessionFs;\n if (handler is null) throw new InvalidOperationException($\"No sessionFs handler registered for session: {request.SessionId}\");\n return await handler.StatAsync(request, cancellationToken);\n }), singleObjectParam: true);\n rpc.SetLocalRpcMethod(\"sessionFs.mkdir\", (Func>)(async (request, cancellationToken) =>\n {\n var handler = getHandlers(request.SessionId).SessionFs;\n if (handler is null) throw new InvalidOperationException($\"No sessionFs handler registered for session: {request.SessionId}\");\n return await handler.MkdirAsync(request, cancellationToken);\n }), singleObjectParam: true);\n rpc.SetLocalRpcMethod(\"sessionFs.readdir\", (Func>)(async (request, cancellationToken) =>\n {\n var handler = getHandlers(request.SessionId).SessionFs;\n if (handler is null) throw new InvalidOperationException($\"No sessionFs handler registered for session: {request.SessionId}\");\n return await handler.ReaddirAsync(request, cancellationToken);\n }), singleObjectParam: true);\n rpc.SetLocalRpcMethod(\"sessionFs.readdirWithTypes\", (Func>)(async (request, cancellationToken) =>\n {\n var handler = getHandlers(request.SessionId).SessionFs;\n if (handler is null) throw new InvalidOperationException($\"No sessionFs handler registered for session: {request.SessionId}\");\n return await handler.ReaddirWithTypesAsync(request, cancellationToken);\n }), singleObjectParam: true);\n rpc.SetLocalRpcMethod(\"sessionFs.rm\", (Func>)(async (request, cancellationToken) =>\n {\n var handler = getHandlers(request.SessionId).SessionFs;\n if (handler is null) throw new InvalidOperationException($\"No sessionFs handler registered for session: {request.SessionId}\");\n return await handler.RmAsync(request, cancellationToken);\n }), singleObjectParam: true);\n rpc.SetLocalRpcMethod(\"sessionFs.rename\", (Func>)(async (request, cancellationToken) =>\n {\n var handler = getHandlers(request.SessionId).SessionFs;\n if (handler is null) throw new InvalidOperationException($\"No sessionFs handler registered for session: {request.SessionId}\");\n return await handler.RenameAsync(request, cancellationToken);\n }), singleObjectParam: true);\n }\n}\n\n[JsonSourceGenerationOptions(\n JsonSerializerDefaults.Web,\n AllowOutOfOrderMetadataProperties = true,\n DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)]\n[JsonSerializable(typeof(bool))]\n[JsonSerializable(typeof(double))]\n[JsonSerializable(typeof(int))]\n[JsonSerializable(typeof(long))]\n[JsonSerializable(typeof(string))]\n[JsonSerializable(typeof(AccountGetQuotaRequest))]\n[JsonSerializable(typeof(AccountGetQuotaResult))]\n[JsonSerializable(typeof(AccountQuotaSnapshot))]\n[JsonSerializable(typeof(AgentGetCurrentResult))]\n[JsonSerializable(typeof(AgentInfo))]\n[JsonSerializable(typeof(AgentList))]\n[JsonSerializable(typeof(AgentReloadResult))]\n[JsonSerializable(typeof(AgentSelectRequest))]\n[JsonSerializable(typeof(AgentSelectResult))]\n[JsonSerializable(typeof(CommandsHandlePendingCommandRequest))]\n[JsonSerializable(typeof(CommandsHandlePendingCommandResult))]\n[JsonSerializable(typeof(CurrentModel))]\n[JsonSerializable(typeof(DiscoveredMcpServer))]\n[JsonSerializable(typeof(Extension))]\n[JsonSerializable(typeof(ExtensionList))]\n[JsonSerializable(typeof(ExtensionsDisableRequest))]\n[JsonSerializable(typeof(ExtensionsEnableRequest))]\n[JsonSerializable(typeof(FleetStartRequest))]\n[JsonSerializable(typeof(FleetStartResult))]\n[JsonSerializable(typeof(HandlePendingToolCallRequest))]\n[JsonSerializable(typeof(HandlePendingToolCallResult))]\n[JsonSerializable(typeof(HistoryCompactContextWindow))]\n[JsonSerializable(typeof(HistoryCompactResult))]\n[JsonSerializable(typeof(HistoryTruncateRequest))]\n[JsonSerializable(typeof(HistoryTruncateResult))]\n[JsonSerializable(typeof(InstructionsGetSourcesResult))]\n[JsonSerializable(typeof(InstructionsSources))]\n[JsonSerializable(typeof(LogRequest))]\n[JsonSerializable(typeof(LogResult))]\n[JsonSerializable(typeof(McpConfigAddRequest))]\n[JsonSerializable(typeof(McpConfigDisableRequest))]\n[JsonSerializable(typeof(McpConfigEnableRequest))]\n[JsonSerializable(typeof(McpConfigList))]\n[JsonSerializable(typeof(McpConfigRemoveRequest))]\n[JsonSerializable(typeof(McpConfigUpdateRequest))]\n[JsonSerializable(typeof(McpDisableRequest))]\n[JsonSerializable(typeof(McpDiscoverRequest))]\n[JsonSerializable(typeof(McpDiscoverResult))]\n[JsonSerializable(typeof(McpEnableRequest))]\n[JsonSerializable(typeof(McpOauthLoginRequest))]\n[JsonSerializable(typeof(McpOauthLoginResult))]\n[JsonSerializable(typeof(McpServer))]\n[JsonSerializable(typeof(McpServerList))]\n[JsonSerializable(typeof(ModeSetRequest))]\n[JsonSerializable(typeof(Model))]\n[JsonSerializable(typeof(ModelBilling))]\n[JsonSerializable(typeof(ModelCapabilities))]\n[JsonSerializable(typeof(ModelCapabilitiesLimits))]\n[JsonSerializable(typeof(ModelCapabilitiesLimitsVision))]\n[JsonSerializable(typeof(ModelCapabilitiesOverride))]\n[JsonSerializable(typeof(ModelCapabilitiesOverrideLimits))]\n[JsonSerializable(typeof(ModelCapabilitiesOverrideLimitsVision))]\n[JsonSerializable(typeof(ModelCapabilitiesOverrideSupports))]\n[JsonSerializable(typeof(ModelCapabilitiesSupports))]\n[JsonSerializable(typeof(ModelList))]\n[JsonSerializable(typeof(ModelPolicy))]\n[JsonSerializable(typeof(ModelSwitchToRequest))]\n[JsonSerializable(typeof(ModelSwitchToResult))]\n[JsonSerializable(typeof(ModelsListRequest))]\n[JsonSerializable(typeof(NameGetResult))]\n[JsonSerializable(typeof(NameSetRequest))]\n[JsonSerializable(typeof(PermissionDecision))]\n[JsonSerializable(typeof(PermissionDecisionApproveForLocationApproval))]\n[JsonSerializable(typeof(PermissionDecisionApproveForSessionApproval))]\n[JsonSerializable(typeof(PermissionDecisionRequest))]\n[JsonSerializable(typeof(PermissionRequestResult))]\n[JsonSerializable(typeof(PermissionsResetSessionApprovalsRequest))]\n[JsonSerializable(typeof(PermissionsResetSessionApprovalsResult))]\n[JsonSerializable(typeof(PermissionsSetApproveAllRequest))]\n[JsonSerializable(typeof(PermissionsSetApproveAllResult))]\n[JsonSerializable(typeof(PingRequest))]\n[JsonSerializable(typeof(PingResult))]\n[JsonSerializable(typeof(PlanReadResult))]\n[JsonSerializable(typeof(PlanUpdateRequest))]\n[JsonSerializable(typeof(Plugin))]\n[JsonSerializable(typeof(PluginList))]\n[JsonSerializable(typeof(ServerSkill))]\n[JsonSerializable(typeof(ServerSkillList))]\n[JsonSerializable(typeof(SessionAgentDeselectRequest))]\n[JsonSerializable(typeof(SessionAgentGetCurrentRequest))]\n[JsonSerializable(typeof(SessionAgentListRequest))]\n[JsonSerializable(typeof(SessionAgentReloadRequest))]\n[JsonSerializable(typeof(SessionAuthGetStatusRequest))]\n[JsonSerializable(typeof(SessionAuthStatus))]\n[JsonSerializable(typeof(SessionExtensionsListRequest))]\n[JsonSerializable(typeof(SessionExtensionsReloadRequest))]\n[JsonSerializable(typeof(SessionFsAppendFileRequest))]\n[JsonSerializable(typeof(SessionFsError))]\n[JsonSerializable(typeof(SessionFsExistsRequest))]\n[JsonSerializable(typeof(SessionFsExistsResult))]\n[JsonSerializable(typeof(SessionFsMkdirRequest))]\n[JsonSerializable(typeof(SessionFsReadFileRequest))]\n[JsonSerializable(typeof(SessionFsReadFileResult))]\n[JsonSerializable(typeof(SessionFsReaddirRequest))]\n[JsonSerializable(typeof(SessionFsReaddirResult))]\n[JsonSerializable(typeof(SessionFsReaddirWithTypesEntry))]\n[JsonSerializable(typeof(SessionFsReaddirWithTypesRequest))]\n[JsonSerializable(typeof(SessionFsReaddirWithTypesResult))]\n[JsonSerializable(typeof(SessionFsRenameRequest))]\n[JsonSerializable(typeof(SessionFsRmRequest))]\n[JsonSerializable(typeof(SessionFsSetProviderRequest))]\n[JsonSerializable(typeof(SessionFsSetProviderResult))]\n[JsonSerializable(typeof(SessionFsStatRequest))]\n[JsonSerializable(typeof(SessionFsStatResult))]\n[JsonSerializable(typeof(SessionFsWriteFileRequest))]\n[JsonSerializable(typeof(SessionHistoryCompactRequest))]\n[JsonSerializable(typeof(SessionInstructionsGetSourcesRequest))]\n[JsonSerializable(typeof(SessionMcpListRequest))]\n[JsonSerializable(typeof(SessionMcpReloadRequest))]\n[JsonSerializable(typeof(SessionMode))]\n[JsonSerializable(typeof(SessionModeGetRequest))]\n[JsonSerializable(typeof(SessionModelGetCurrentRequest))]\n[JsonSerializable(typeof(SessionNameGetRequest))]\n[JsonSerializable(typeof(SessionPlanDeleteRequest))]\n[JsonSerializable(typeof(SessionPlanReadRequest))]\n[JsonSerializable(typeof(SessionPluginsListRequest))]\n[JsonSerializable(typeof(SessionSkillsListRequest))]\n[JsonSerializable(typeof(SessionSkillsReloadRequest))]\n[JsonSerializable(typeof(SessionSuspendRequest))]\n[JsonSerializable(typeof(SessionTasksListRequest))]\n[JsonSerializable(typeof(SessionUsageGetMetricsRequest))]\n[JsonSerializable(typeof(SessionWorkspacesGetWorkspaceRequest))]\n[JsonSerializable(typeof(SessionWorkspacesListFilesRequest))]\n[JsonSerializable(typeof(SessionsForkRequest))]\n[JsonSerializable(typeof(SessionsForkResult))]\n[JsonSerializable(typeof(ShellExecRequest))]\n[JsonSerializable(typeof(ShellExecResult))]\n[JsonSerializable(typeof(ShellKillRequest))]\n[JsonSerializable(typeof(ShellKillResult))]\n[JsonSerializable(typeof(Skill))]\n[JsonSerializable(typeof(SkillList))]\n[JsonSerializable(typeof(SkillsConfigSetDisabledSkillsRequest))]\n[JsonSerializable(typeof(SkillsDisableRequest))]\n[JsonSerializable(typeof(SkillsDiscoverRequest))]\n[JsonSerializable(typeof(SkillsEnableRequest))]\n[JsonSerializable(typeof(TaskInfo))]\n[JsonSerializable(typeof(TaskList))]\n[JsonSerializable(typeof(TasksCancelRequest))]\n[JsonSerializable(typeof(TasksCancelResult))]\n[JsonSerializable(typeof(TasksPromoteToBackgroundRequest))]\n[JsonSerializable(typeof(TasksPromoteToBackgroundResult))]\n[JsonSerializable(typeof(TasksRemoveRequest))]\n[JsonSerializable(typeof(TasksRemoveResult))]\n[JsonSerializable(typeof(TasksStartAgentRequest))]\n[JsonSerializable(typeof(TasksStartAgentResult))]\n[JsonSerializable(typeof(Tool))]\n[JsonSerializable(typeof(ToolList))]\n[JsonSerializable(typeof(ToolsListRequest))]\n[JsonSerializable(typeof(UIElicitationRequest))]\n[JsonSerializable(typeof(UIElicitationResponse))]\n[JsonSerializable(typeof(UIElicitationResult))]\n[JsonSerializable(typeof(UIElicitationSchema))]\n[JsonSerializable(typeof(UIHandlePendingElicitationRequest))]\n[JsonSerializable(typeof(UsageGetMetricsResult))]\n[JsonSerializable(typeof(UsageMetricsCodeChanges))]\n[JsonSerializable(typeof(UsageMetricsModelMetric))]\n[JsonSerializable(typeof(UsageMetricsModelMetricRequests))]\n[JsonSerializable(typeof(UsageMetricsModelMetricTokenDetail))]\n[JsonSerializable(typeof(UsageMetricsModelMetricUsage))]\n[JsonSerializable(typeof(UsageMetricsTokenDetail))]\n[JsonSerializable(typeof(WorkspacesCreateFileRequest))]\n[JsonSerializable(typeof(WorkspacesGetWorkspaceResult))]\n[JsonSerializable(typeof(WorkspacesGetWorkspaceResultWorkspace))]\n[JsonSerializable(typeof(WorkspacesListFilesResult))]\n[JsonSerializable(typeof(WorkspacesReadFileRequest))]\n[JsonSerializable(typeof(WorkspacesReadFileResult))]\ninternal partial class RpcJsonContext : JsonSerializerContext;" }, { "path": "dotnet/src/Generated/SessionEvents.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\n// AUTO-GENERATED FILE - DO NOT EDIT\n// Generated from: session-events.schema.json\n\n#pragma warning disable CS0612 // Type or member is obsolete\n#pragma warning disable CS0618 // Type or member is obsolete (with message)\n\nusing System.ComponentModel.DataAnnotations;\nusing System.Diagnostics;\nusing System.Diagnostics.CodeAnalysis;\nusing System.Text.Json;\nusing System.Text.Json.Serialization;\n\nnamespace GitHub.Copilot.SDK;\n\n/// \n/// Provides the base class from which all session events derive.\n/// \n[DebuggerDisplay(\"{DebuggerDisplay,nq}\")]\n[JsonPolymorphic(\n TypeDiscriminatorPropertyName = \"type\",\n IgnoreUnrecognizedTypeDiscriminators = true)]\n[JsonDerivedType(typeof(AbortEvent), \"abort\")]\n[JsonDerivedType(typeof(AssistantIntentEvent), \"assistant.intent\")]\n[JsonDerivedType(typeof(AssistantMessageEvent), \"assistant.message\")]\n[JsonDerivedType(typeof(AssistantMessageDeltaEvent), \"assistant.message_delta\")]\n[JsonDerivedType(typeof(AssistantMessageStartEvent), \"assistant.message_start\")]\n[JsonDerivedType(typeof(AssistantReasoningEvent), \"assistant.reasoning\")]\n[JsonDerivedType(typeof(AssistantReasoningDeltaEvent), \"assistant.reasoning_delta\")]\n[JsonDerivedType(typeof(AssistantStreamingDeltaEvent), \"assistant.streaming_delta\")]\n[JsonDerivedType(typeof(AssistantTurnEndEvent), \"assistant.turn_end\")]\n[JsonDerivedType(typeof(AssistantTurnStartEvent), \"assistant.turn_start\")]\n[JsonDerivedType(typeof(AssistantUsageEvent), \"assistant.usage\")]\n[JsonDerivedType(typeof(AutoModeSwitchCompletedEvent), \"auto_mode_switch.completed\")]\n[JsonDerivedType(typeof(AutoModeSwitchRequestedEvent), \"auto_mode_switch.requested\")]\n[JsonDerivedType(typeof(CapabilitiesChangedEvent), \"capabilities.changed\")]\n[JsonDerivedType(typeof(CommandCompletedEvent), \"command.completed\")]\n[JsonDerivedType(typeof(CommandExecuteEvent), \"command.execute\")]\n[JsonDerivedType(typeof(CommandQueuedEvent), \"command.queued\")]\n[JsonDerivedType(typeof(CommandsChangedEvent), \"commands.changed\")]\n[JsonDerivedType(typeof(ElicitationCompletedEvent), \"elicitation.completed\")]\n[JsonDerivedType(typeof(ElicitationRequestedEvent), \"elicitation.requested\")]\n[JsonDerivedType(typeof(ExitPlanModeCompletedEvent), \"exit_plan_mode.completed\")]\n[JsonDerivedType(typeof(ExitPlanModeRequestedEvent), \"exit_plan_mode.requested\")]\n[JsonDerivedType(typeof(ExternalToolCompletedEvent), \"external_tool.completed\")]\n[JsonDerivedType(typeof(ExternalToolRequestedEvent), \"external_tool.requested\")]\n[JsonDerivedType(typeof(HookEndEvent), \"hook.end\")]\n[JsonDerivedType(typeof(HookStartEvent), \"hook.start\")]\n[JsonDerivedType(typeof(McpOauthCompletedEvent), \"mcp.oauth_completed\")]\n[JsonDerivedType(typeof(McpOauthRequiredEvent), \"mcp.oauth_required\")]\n[JsonDerivedType(typeof(ModelCallFailureEvent), \"model.call_failure\")]\n[JsonDerivedType(typeof(PendingMessagesModifiedEvent), \"pending_messages.modified\")]\n[JsonDerivedType(typeof(PermissionCompletedEvent), \"permission.completed\")]\n[JsonDerivedType(typeof(PermissionRequestedEvent), \"permission.requested\")]\n[JsonDerivedType(typeof(SamplingCompletedEvent), \"sampling.completed\")]\n[JsonDerivedType(typeof(SamplingRequestedEvent), \"sampling.requested\")]\n[JsonDerivedType(typeof(SessionBackgroundTasksChangedEvent), \"session.background_tasks_changed\")]\n[JsonDerivedType(typeof(SessionCompactionCompleteEvent), \"session.compaction_complete\")]\n[JsonDerivedType(typeof(SessionCompactionStartEvent), \"session.compaction_start\")]\n[JsonDerivedType(typeof(SessionContextChangedEvent), \"session.context_changed\")]\n[JsonDerivedType(typeof(SessionCustomAgentsUpdatedEvent), \"session.custom_agents_updated\")]\n[JsonDerivedType(typeof(SessionErrorEvent), \"session.error\")]\n[JsonDerivedType(typeof(SessionExtensionsLoadedEvent), \"session.extensions_loaded\")]\n[JsonDerivedType(typeof(SessionHandoffEvent), \"session.handoff\")]\n[JsonDerivedType(typeof(SessionIdleEvent), \"session.idle\")]\n[JsonDerivedType(typeof(SessionInfoEvent), \"session.info\")]\n[JsonDerivedType(typeof(SessionMcpServerStatusChangedEvent), \"session.mcp_server_status_changed\")]\n[JsonDerivedType(typeof(SessionMcpServersLoadedEvent), \"session.mcp_servers_loaded\")]\n[JsonDerivedType(typeof(SessionModeChangedEvent), \"session.mode_changed\")]\n[JsonDerivedType(typeof(SessionModelChangeEvent), \"session.model_change\")]\n[JsonDerivedType(typeof(SessionPlanChangedEvent), \"session.plan_changed\")]\n[JsonDerivedType(typeof(SessionRemoteSteerableChangedEvent), \"session.remote_steerable_changed\")]\n[JsonDerivedType(typeof(SessionResumeEvent), \"session.resume\")]\n[JsonDerivedType(typeof(SessionShutdownEvent), \"session.shutdown\")]\n[JsonDerivedType(typeof(SessionSkillsLoadedEvent), \"session.skills_loaded\")]\n[JsonDerivedType(typeof(SessionSnapshotRewindEvent), \"session.snapshot_rewind\")]\n[JsonDerivedType(typeof(SessionStartEvent), \"session.start\")]\n[JsonDerivedType(typeof(SessionTaskCompleteEvent), \"session.task_complete\")]\n[JsonDerivedType(typeof(SessionTitleChangedEvent), \"session.title_changed\")]\n[JsonDerivedType(typeof(SessionToolsUpdatedEvent), \"session.tools_updated\")]\n[JsonDerivedType(typeof(SessionTruncationEvent), \"session.truncation\")]\n[JsonDerivedType(typeof(SessionUsageInfoEvent), \"session.usage_info\")]\n[JsonDerivedType(typeof(SessionWarningEvent), \"session.warning\")]\n[JsonDerivedType(typeof(SessionWorkspaceFileChangedEvent), \"session.workspace_file_changed\")]\n[JsonDerivedType(typeof(SkillInvokedEvent), \"skill.invoked\")]\n[JsonDerivedType(typeof(SubagentCompletedEvent), \"subagent.completed\")]\n[JsonDerivedType(typeof(SubagentDeselectedEvent), \"subagent.deselected\")]\n[JsonDerivedType(typeof(SubagentFailedEvent), \"subagent.failed\")]\n[JsonDerivedType(typeof(SubagentSelectedEvent), \"subagent.selected\")]\n[JsonDerivedType(typeof(SubagentStartedEvent), \"subagent.started\")]\n[JsonDerivedType(typeof(SystemMessageEvent), \"system.message\")]\n[JsonDerivedType(typeof(SystemNotificationEvent), \"system.notification\")]\n[JsonDerivedType(typeof(ToolExecutionCompleteEvent), \"tool.execution_complete\")]\n[JsonDerivedType(typeof(ToolExecutionPartialResultEvent), \"tool.execution_partial_result\")]\n[JsonDerivedType(typeof(ToolExecutionProgressEvent), \"tool.execution_progress\")]\n[JsonDerivedType(typeof(ToolExecutionStartEvent), \"tool.execution_start\")]\n[JsonDerivedType(typeof(ToolUserRequestedEvent), \"tool.user_requested\")]\n[JsonDerivedType(typeof(UserInputCompletedEvent), \"user_input.completed\")]\n[JsonDerivedType(typeof(UserInputRequestedEvent), \"user_input.requested\")]\n[JsonDerivedType(typeof(UserMessageEvent), \"user.message\")]\npublic partial class SessionEvent\n{\n /// Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"agentId\")]\n public string? AgentId { get; set; }\n\n /// When true, the event is transient and not persisted to the session event log on disk.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"ephemeral\")]\n public bool? Ephemeral { get; set; }\n\n /// Unique event identifier (UUID v4), generated when the event is emitted.\n [JsonPropertyName(\"id\")]\n public Guid Id { get; set; }\n\n /// ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n [JsonPropertyName(\"parentId\")]\n public Guid? ParentId { get; set; }\n\n /// ISO 8601 timestamp when the event was created.\n [JsonPropertyName(\"timestamp\")]\n public DateTimeOffset Timestamp { get; set; }\n\n /// \n /// The event type discriminator.\n /// \n [JsonIgnore]\n public virtual string Type => \"unknown\";\n\n /// Deserializes a JSON string into a .\n public static SessionEvent FromJson(string json) =>\n JsonSerializer.Deserialize(json, SessionEventsJsonContext.Default.SessionEvent)!;\n\n /// Serializes this event to a JSON string.\n public string ToJson() =>\n JsonSerializer.Serialize(this, SessionEventsJsonContext.Default.SessionEvent);\n\n [DebuggerBrowsable(DebuggerBrowsableState.Never)]\n private string DebuggerDisplay => ToJson();\n}\n\n/// Session initialization metadata including context and configuration.\n/// Represents the session.start event.\npublic partial class SessionStartEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.start\";\n\n /// The session.start event payload.\n [JsonPropertyName(\"data\")]\n public required SessionStartData Data { get; set; }\n}\n\n/// Session resume metadata including current context and event count.\n/// Represents the session.resume event.\npublic partial class SessionResumeEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.resume\";\n\n /// The session.resume event payload.\n [JsonPropertyName(\"data\")]\n public required SessionResumeData Data { get; set; }\n}\n\n/// Notifies Mission Control that the session's remote steering capability has changed.\n/// Represents the session.remote_steerable_changed event.\npublic partial class SessionRemoteSteerableChangedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.remote_steerable_changed\";\n\n /// The session.remote_steerable_changed event payload.\n [JsonPropertyName(\"data\")]\n public required SessionRemoteSteerableChangedData Data { get; set; }\n}\n\n/// Error details for timeline display including message and optional diagnostic information.\n/// Represents the session.error event.\npublic partial class SessionErrorEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.error\";\n\n /// The session.error event payload.\n [JsonPropertyName(\"data\")]\n public required SessionErrorData Data { get; set; }\n}\n\n/// Payload indicating the session is idle with no background agents in flight.\n/// Represents the session.idle event.\npublic partial class SessionIdleEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.idle\";\n\n /// The session.idle event payload.\n [JsonPropertyName(\"data\")]\n public required SessionIdleData Data { get; set; }\n}\n\n/// Session title change payload containing the new display title.\n/// Represents the session.title_changed event.\npublic partial class SessionTitleChangedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.title_changed\";\n\n /// The session.title_changed event payload.\n [JsonPropertyName(\"data\")]\n public required SessionTitleChangedData Data { get; set; }\n}\n\n/// Informational message for timeline display with categorization.\n/// Represents the session.info event.\npublic partial class SessionInfoEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.info\";\n\n /// The session.info event payload.\n [JsonPropertyName(\"data\")]\n public required SessionInfoData Data { get; set; }\n}\n\n/// Warning message for timeline display with categorization.\n/// Represents the session.warning event.\npublic partial class SessionWarningEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.warning\";\n\n /// The session.warning event payload.\n [JsonPropertyName(\"data\")]\n public required SessionWarningData Data { get; set; }\n}\n\n/// Model change details including previous and new model identifiers.\n/// Represents the session.model_change event.\npublic partial class SessionModelChangeEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.model_change\";\n\n /// The session.model_change event payload.\n [JsonPropertyName(\"data\")]\n public required SessionModelChangeData Data { get; set; }\n}\n\n/// Agent mode change details including previous and new modes.\n/// Represents the session.mode_changed event.\npublic partial class SessionModeChangedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.mode_changed\";\n\n /// The session.mode_changed event payload.\n [JsonPropertyName(\"data\")]\n public required SessionModeChangedData Data { get; set; }\n}\n\n/// Plan file operation details indicating what changed.\n/// Represents the session.plan_changed event.\npublic partial class SessionPlanChangedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.plan_changed\";\n\n /// The session.plan_changed event payload.\n [JsonPropertyName(\"data\")]\n public required SessionPlanChangedData Data { get; set; }\n}\n\n/// Workspace file change details including path and operation type.\n/// Represents the session.workspace_file_changed event.\npublic partial class SessionWorkspaceFileChangedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.workspace_file_changed\";\n\n /// The session.workspace_file_changed event payload.\n [JsonPropertyName(\"data\")]\n public required SessionWorkspaceFileChangedData Data { get; set; }\n}\n\n/// Session handoff metadata including source, context, and repository information.\n/// Represents the session.handoff event.\npublic partial class SessionHandoffEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.handoff\";\n\n /// The session.handoff event payload.\n [JsonPropertyName(\"data\")]\n public required SessionHandoffData Data { get; set; }\n}\n\n/// Conversation truncation statistics including token counts and removed content metrics.\n/// Represents the session.truncation event.\npublic partial class SessionTruncationEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.truncation\";\n\n /// The session.truncation event payload.\n [JsonPropertyName(\"data\")]\n public required SessionTruncationData Data { get; set; }\n}\n\n/// Session rewind details including target event and count of removed events.\n/// Represents the session.snapshot_rewind event.\npublic partial class SessionSnapshotRewindEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.snapshot_rewind\";\n\n /// The session.snapshot_rewind event payload.\n [JsonPropertyName(\"data\")]\n public required SessionSnapshotRewindData Data { get; set; }\n}\n\n/// Session termination metrics including usage statistics, code changes, and shutdown reason.\n/// Represents the session.shutdown event.\npublic partial class SessionShutdownEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.shutdown\";\n\n /// The session.shutdown event payload.\n [JsonPropertyName(\"data\")]\n public required SessionShutdownData Data { get; set; }\n}\n\n/// Working directory and git context at session start.\n/// Represents the session.context_changed event.\npublic partial class SessionContextChangedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.context_changed\";\n\n /// The session.context_changed event payload.\n [JsonPropertyName(\"data\")]\n public required SessionContextChangedData Data { get; set; }\n}\n\n/// Current context window usage statistics including token and message counts.\n/// Represents the session.usage_info event.\npublic partial class SessionUsageInfoEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.usage_info\";\n\n /// The session.usage_info event payload.\n [JsonPropertyName(\"data\")]\n public required SessionUsageInfoData Data { get; set; }\n}\n\n/// Context window breakdown at the start of LLM-powered conversation compaction.\n/// Represents the session.compaction_start event.\npublic partial class SessionCompactionStartEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.compaction_start\";\n\n /// The session.compaction_start event payload.\n [JsonPropertyName(\"data\")]\n public required SessionCompactionStartData Data { get; set; }\n}\n\n/// Conversation compaction results including success status, metrics, and optional error details.\n/// Represents the session.compaction_complete event.\npublic partial class SessionCompactionCompleteEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.compaction_complete\";\n\n /// The session.compaction_complete event payload.\n [JsonPropertyName(\"data\")]\n public required SessionCompactionCompleteData Data { get; set; }\n}\n\n/// Task completion notification with summary from the agent.\n/// Represents the session.task_complete event.\npublic partial class SessionTaskCompleteEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.task_complete\";\n\n /// The session.task_complete event payload.\n [JsonPropertyName(\"data\")]\n public required SessionTaskCompleteData Data { get; set; }\n}\n\n/// Represents the user.message event.\npublic partial class UserMessageEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"user.message\";\n\n /// The user.message event payload.\n [JsonPropertyName(\"data\")]\n public required UserMessageData Data { get; set; }\n}\n\n/// Empty payload; the event signals that the pending message queue has changed.\n/// Represents the pending_messages.modified event.\npublic partial class PendingMessagesModifiedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"pending_messages.modified\";\n\n /// The pending_messages.modified event payload.\n [JsonPropertyName(\"data\")]\n public required PendingMessagesModifiedData Data { get; set; }\n}\n\n/// Turn initialization metadata including identifier and interaction tracking.\n/// Represents the assistant.turn_start event.\npublic partial class AssistantTurnStartEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"assistant.turn_start\";\n\n /// The assistant.turn_start event payload.\n [JsonPropertyName(\"data\")]\n public required AssistantTurnStartData Data { get; set; }\n}\n\n/// Agent intent description for current activity or plan.\n/// Represents the assistant.intent event.\npublic partial class AssistantIntentEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"assistant.intent\";\n\n /// The assistant.intent event payload.\n [JsonPropertyName(\"data\")]\n public required AssistantIntentData Data { get; set; }\n}\n\n/// Assistant reasoning content for timeline display with complete thinking text.\n/// Represents the assistant.reasoning event.\npublic partial class AssistantReasoningEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"assistant.reasoning\";\n\n /// The assistant.reasoning event payload.\n [JsonPropertyName(\"data\")]\n public required AssistantReasoningData Data { get; set; }\n}\n\n/// Streaming reasoning delta for incremental extended thinking updates.\n/// Represents the assistant.reasoning_delta event.\npublic partial class AssistantReasoningDeltaEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"assistant.reasoning_delta\";\n\n /// The assistant.reasoning_delta event payload.\n [JsonPropertyName(\"data\")]\n public required AssistantReasoningDeltaData Data { get; set; }\n}\n\n/// Streaming response progress with cumulative byte count.\n/// Represents the assistant.streaming_delta event.\npublic partial class AssistantStreamingDeltaEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"assistant.streaming_delta\";\n\n /// The assistant.streaming_delta event payload.\n [JsonPropertyName(\"data\")]\n public required AssistantStreamingDeltaData Data { get; set; }\n}\n\n/// Assistant response containing text content, optional tool requests, and interaction metadata.\n/// Represents the assistant.message event.\npublic partial class AssistantMessageEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"assistant.message\";\n\n /// The assistant.message event payload.\n [JsonPropertyName(\"data\")]\n public required AssistantMessageData Data { get; set; }\n}\n\n/// Streaming assistant message start metadata.\n/// Represents the assistant.message_start event.\npublic partial class AssistantMessageStartEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"assistant.message_start\";\n\n /// The assistant.message_start event payload.\n [JsonPropertyName(\"data\")]\n public required AssistantMessageStartData Data { get; set; }\n}\n\n/// Streaming assistant message delta for incremental response updates.\n/// Represents the assistant.message_delta event.\npublic partial class AssistantMessageDeltaEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"assistant.message_delta\";\n\n /// The assistant.message_delta event payload.\n [JsonPropertyName(\"data\")]\n public required AssistantMessageDeltaData Data { get; set; }\n}\n\n/// Turn completion metadata including the turn identifier.\n/// Represents the assistant.turn_end event.\npublic partial class AssistantTurnEndEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"assistant.turn_end\";\n\n /// The assistant.turn_end event payload.\n [JsonPropertyName(\"data\")]\n public required AssistantTurnEndData Data { get; set; }\n}\n\n/// LLM API call usage metrics including tokens, costs, quotas, and billing information.\n/// Represents the assistant.usage event.\npublic partial class AssistantUsageEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"assistant.usage\";\n\n /// The assistant.usage event payload.\n [JsonPropertyName(\"data\")]\n public required AssistantUsageData Data { get; set; }\n}\n\n/// Failed LLM API call metadata for telemetry.\n/// Represents the model.call_failure event.\npublic partial class ModelCallFailureEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"model.call_failure\";\n\n /// The model.call_failure event payload.\n [JsonPropertyName(\"data\")]\n public required ModelCallFailureData Data { get; set; }\n}\n\n/// Turn abort information including the reason for termination.\n/// Represents the abort event.\npublic partial class AbortEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"abort\";\n\n /// The abort event payload.\n [JsonPropertyName(\"data\")]\n public required AbortData Data { get; set; }\n}\n\n/// User-initiated tool invocation request with tool name and arguments.\n/// Represents the tool.user_requested event.\npublic partial class ToolUserRequestedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"tool.user_requested\";\n\n /// The tool.user_requested event payload.\n [JsonPropertyName(\"data\")]\n public required ToolUserRequestedData Data { get; set; }\n}\n\n/// Tool execution startup details including MCP server information when applicable.\n/// Represents the tool.execution_start event.\npublic partial class ToolExecutionStartEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"tool.execution_start\";\n\n /// The tool.execution_start event payload.\n [JsonPropertyName(\"data\")]\n public required ToolExecutionStartData Data { get; set; }\n}\n\n/// Streaming tool execution output for incremental result display.\n/// Represents the tool.execution_partial_result event.\npublic partial class ToolExecutionPartialResultEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"tool.execution_partial_result\";\n\n /// The tool.execution_partial_result event payload.\n [JsonPropertyName(\"data\")]\n public required ToolExecutionPartialResultData Data { get; set; }\n}\n\n/// Tool execution progress notification with status message.\n/// Represents the tool.execution_progress event.\npublic partial class ToolExecutionProgressEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"tool.execution_progress\";\n\n /// The tool.execution_progress event payload.\n [JsonPropertyName(\"data\")]\n public required ToolExecutionProgressData Data { get; set; }\n}\n\n/// Tool execution completion results including success status, detailed output, and error information.\n/// Represents the tool.execution_complete event.\npublic partial class ToolExecutionCompleteEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"tool.execution_complete\";\n\n /// The tool.execution_complete event payload.\n [JsonPropertyName(\"data\")]\n public required ToolExecutionCompleteData Data { get; set; }\n}\n\n/// Skill invocation details including content, allowed tools, and plugin metadata.\n/// Represents the skill.invoked event.\npublic partial class SkillInvokedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"skill.invoked\";\n\n /// The skill.invoked event payload.\n [JsonPropertyName(\"data\")]\n public required SkillInvokedData Data { get; set; }\n}\n\n/// Sub-agent startup details including parent tool call and agent information.\n/// Represents the subagent.started event.\npublic partial class SubagentStartedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"subagent.started\";\n\n /// The subagent.started event payload.\n [JsonPropertyName(\"data\")]\n public required SubagentStartedData Data { get; set; }\n}\n\n/// Sub-agent completion details for successful execution.\n/// Represents the subagent.completed event.\npublic partial class SubagentCompletedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"subagent.completed\";\n\n /// The subagent.completed event payload.\n [JsonPropertyName(\"data\")]\n public required SubagentCompletedData Data { get; set; }\n}\n\n/// Sub-agent failure details including error message and agent information.\n/// Represents the subagent.failed event.\npublic partial class SubagentFailedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"subagent.failed\";\n\n /// The subagent.failed event payload.\n [JsonPropertyName(\"data\")]\n public required SubagentFailedData Data { get; set; }\n}\n\n/// Custom agent selection details including name and available tools.\n/// Represents the subagent.selected event.\npublic partial class SubagentSelectedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"subagent.selected\";\n\n /// The subagent.selected event payload.\n [JsonPropertyName(\"data\")]\n public required SubagentSelectedData Data { get; set; }\n}\n\n/// Empty payload; the event signals that the custom agent was deselected, returning to the default agent.\n/// Represents the subagent.deselected event.\npublic partial class SubagentDeselectedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"subagent.deselected\";\n\n /// The subagent.deselected event payload.\n [JsonPropertyName(\"data\")]\n public required SubagentDeselectedData Data { get; set; }\n}\n\n/// Hook invocation start details including type and input data.\n/// Represents the hook.start event.\npublic partial class HookStartEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"hook.start\";\n\n /// The hook.start event payload.\n [JsonPropertyName(\"data\")]\n public required HookStartData Data { get; set; }\n}\n\n/// Hook invocation completion details including output, success status, and error information.\n/// Represents the hook.end event.\npublic partial class HookEndEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"hook.end\";\n\n /// The hook.end event payload.\n [JsonPropertyName(\"data\")]\n public required HookEndData Data { get; set; }\n}\n\n/// System/developer instruction content with role and optional template metadata.\n/// Represents the system.message event.\npublic partial class SystemMessageEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"system.message\";\n\n /// The system.message event payload.\n [JsonPropertyName(\"data\")]\n public required SystemMessageData Data { get; set; }\n}\n\n/// System-generated notification for runtime events like background task completion.\n/// Represents the system.notification event.\npublic partial class SystemNotificationEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"system.notification\";\n\n /// The system.notification event payload.\n [JsonPropertyName(\"data\")]\n public required SystemNotificationData Data { get; set; }\n}\n\n/// Permission request notification requiring client approval with request details.\n/// Represents the permission.requested event.\npublic partial class PermissionRequestedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"permission.requested\";\n\n /// The permission.requested event payload.\n [JsonPropertyName(\"data\")]\n public required PermissionRequestedData Data { get; set; }\n}\n\n/// Permission request completion notification signaling UI dismissal.\n/// Represents the permission.completed event.\npublic partial class PermissionCompletedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"permission.completed\";\n\n /// The permission.completed event payload.\n [JsonPropertyName(\"data\")]\n public required PermissionCompletedData Data { get; set; }\n}\n\n/// User input request notification with question and optional predefined choices.\n/// Represents the user_input.requested event.\npublic partial class UserInputRequestedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"user_input.requested\";\n\n /// The user_input.requested event payload.\n [JsonPropertyName(\"data\")]\n public required UserInputRequestedData Data { get; set; }\n}\n\n/// User input request completion with the user's response.\n/// Represents the user_input.completed event.\npublic partial class UserInputCompletedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"user_input.completed\";\n\n /// The user_input.completed event payload.\n [JsonPropertyName(\"data\")]\n public required UserInputCompletedData Data { get; set; }\n}\n\n/// Elicitation request; may be form-based (structured input) or URL-based (browser redirect).\n/// Represents the elicitation.requested event.\npublic partial class ElicitationRequestedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"elicitation.requested\";\n\n /// The elicitation.requested event payload.\n [JsonPropertyName(\"data\")]\n public required ElicitationRequestedData Data { get; set; }\n}\n\n/// Elicitation request completion with the user's response.\n/// Represents the elicitation.completed event.\npublic partial class ElicitationCompletedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"elicitation.completed\";\n\n /// The elicitation.completed event payload.\n [JsonPropertyName(\"data\")]\n public required ElicitationCompletedData Data { get; set; }\n}\n\n/// Sampling request from an MCP server; contains the server name and a requestId for correlation.\n/// Represents the sampling.requested event.\npublic partial class SamplingRequestedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"sampling.requested\";\n\n /// The sampling.requested event payload.\n [JsonPropertyName(\"data\")]\n public required SamplingRequestedData Data { get; set; }\n}\n\n/// Sampling request completion notification signaling UI dismissal.\n/// Represents the sampling.completed event.\npublic partial class SamplingCompletedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"sampling.completed\";\n\n /// The sampling.completed event payload.\n [JsonPropertyName(\"data\")]\n public required SamplingCompletedData Data { get; set; }\n}\n\n/// OAuth authentication request for an MCP server.\n/// Represents the mcp.oauth_required event.\npublic partial class McpOauthRequiredEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"mcp.oauth_required\";\n\n /// The mcp.oauth_required event payload.\n [JsonPropertyName(\"data\")]\n public required McpOauthRequiredData Data { get; set; }\n}\n\n/// MCP OAuth request completion notification.\n/// Represents the mcp.oauth_completed event.\npublic partial class McpOauthCompletedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"mcp.oauth_completed\";\n\n /// The mcp.oauth_completed event payload.\n [JsonPropertyName(\"data\")]\n public required McpOauthCompletedData Data { get; set; }\n}\n\n/// External tool invocation request for client-side tool execution.\n/// Represents the external_tool.requested event.\npublic partial class ExternalToolRequestedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"external_tool.requested\";\n\n /// The external_tool.requested event payload.\n [JsonPropertyName(\"data\")]\n public required ExternalToolRequestedData Data { get; set; }\n}\n\n/// External tool completion notification signaling UI dismissal.\n/// Represents the external_tool.completed event.\npublic partial class ExternalToolCompletedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"external_tool.completed\";\n\n /// The external_tool.completed event payload.\n [JsonPropertyName(\"data\")]\n public required ExternalToolCompletedData Data { get; set; }\n}\n\n/// Queued slash command dispatch request for client execution.\n/// Represents the command.queued event.\npublic partial class CommandQueuedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"command.queued\";\n\n /// The command.queued event payload.\n [JsonPropertyName(\"data\")]\n public required CommandQueuedData Data { get; set; }\n}\n\n/// Registered command dispatch request routed to the owning client.\n/// Represents the command.execute event.\npublic partial class CommandExecuteEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"command.execute\";\n\n /// The command.execute event payload.\n [JsonPropertyName(\"data\")]\n public required CommandExecuteData Data { get; set; }\n}\n\n/// Queued command completion notification signaling UI dismissal.\n/// Represents the command.completed event.\npublic partial class CommandCompletedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"command.completed\";\n\n /// The command.completed event payload.\n [JsonPropertyName(\"data\")]\n public required CommandCompletedData Data { get; set; }\n}\n\n/// Auto mode switch request notification requiring user approval.\n/// Represents the auto_mode_switch.requested event.\npublic partial class AutoModeSwitchRequestedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"auto_mode_switch.requested\";\n\n /// The auto_mode_switch.requested event payload.\n [JsonPropertyName(\"data\")]\n public required AutoModeSwitchRequestedData Data { get; set; }\n}\n\n/// Auto mode switch completion notification.\n/// Represents the auto_mode_switch.completed event.\npublic partial class AutoModeSwitchCompletedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"auto_mode_switch.completed\";\n\n /// The auto_mode_switch.completed event payload.\n [JsonPropertyName(\"data\")]\n public required AutoModeSwitchCompletedData Data { get; set; }\n}\n\n/// SDK command registration change notification.\n/// Represents the commands.changed event.\npublic partial class CommandsChangedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"commands.changed\";\n\n /// The commands.changed event payload.\n [JsonPropertyName(\"data\")]\n public required CommandsChangedData Data { get; set; }\n}\n\n/// Session capability change notification.\n/// Represents the capabilities.changed event.\npublic partial class CapabilitiesChangedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"capabilities.changed\";\n\n /// The capabilities.changed event payload.\n [JsonPropertyName(\"data\")]\n public required CapabilitiesChangedData Data { get; set; }\n}\n\n/// Plan approval request with plan content and available user actions.\n/// Represents the exit_plan_mode.requested event.\npublic partial class ExitPlanModeRequestedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"exit_plan_mode.requested\";\n\n /// The exit_plan_mode.requested event payload.\n [JsonPropertyName(\"data\")]\n public required ExitPlanModeRequestedData Data { get; set; }\n}\n\n/// Plan mode exit completion with the user's approval decision and optional feedback.\n/// Represents the exit_plan_mode.completed event.\npublic partial class ExitPlanModeCompletedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"exit_plan_mode.completed\";\n\n /// The exit_plan_mode.completed event payload.\n [JsonPropertyName(\"data\")]\n public required ExitPlanModeCompletedData Data { get; set; }\n}\n\n/// Represents the session.tools_updated event.\npublic partial class SessionToolsUpdatedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.tools_updated\";\n\n /// The session.tools_updated event payload.\n [JsonPropertyName(\"data\")]\n public required SessionToolsUpdatedData Data { get; set; }\n}\n\n/// Represents the session.background_tasks_changed event.\npublic partial class SessionBackgroundTasksChangedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.background_tasks_changed\";\n\n /// The session.background_tasks_changed event payload.\n [JsonPropertyName(\"data\")]\n public required SessionBackgroundTasksChangedData Data { get; set; }\n}\n\n/// Represents the session.skills_loaded event.\npublic partial class SessionSkillsLoadedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.skills_loaded\";\n\n /// The session.skills_loaded event payload.\n [JsonPropertyName(\"data\")]\n public required SessionSkillsLoadedData Data { get; set; }\n}\n\n/// Represents the session.custom_agents_updated event.\npublic partial class SessionCustomAgentsUpdatedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.custom_agents_updated\";\n\n /// The session.custom_agents_updated event payload.\n [JsonPropertyName(\"data\")]\n public required SessionCustomAgentsUpdatedData Data { get; set; }\n}\n\n/// Represents the session.mcp_servers_loaded event.\npublic partial class SessionMcpServersLoadedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.mcp_servers_loaded\";\n\n /// The session.mcp_servers_loaded event payload.\n [JsonPropertyName(\"data\")]\n public required SessionMcpServersLoadedData Data { get; set; }\n}\n\n/// Represents the session.mcp_server_status_changed event.\npublic partial class SessionMcpServerStatusChangedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.mcp_server_status_changed\";\n\n /// The session.mcp_server_status_changed event payload.\n [JsonPropertyName(\"data\")]\n public required SessionMcpServerStatusChangedData Data { get; set; }\n}\n\n/// Represents the session.extensions_loaded event.\npublic partial class SessionExtensionsLoadedEvent : SessionEvent\n{\n /// \n [JsonIgnore]\n public override string Type => \"session.extensions_loaded\";\n\n /// The session.extensions_loaded event payload.\n [JsonPropertyName(\"data\")]\n public required SessionExtensionsLoadedData Data { get; set; }\n}\n\n/// Session initialization metadata including context and configuration.\npublic partial class SessionStartData\n{\n /// Whether the session was already in use by another client at start time.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"alreadyInUse\")]\n public bool? AlreadyInUse { get; set; }\n\n /// Working directory and git context at session start.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"context\")]\n public WorkingDirectoryContext? Context { get; set; }\n\n /// Version string of the Copilot application.\n [JsonPropertyName(\"copilotVersion\")]\n public required string CopilotVersion { get; set; }\n\n /// Identifier of the software producing the events (e.g., \"copilot-agent\").\n [JsonPropertyName(\"producer\")]\n public required string Producer { get; set; }\n\n /// Reasoning effort level used for model calls, if applicable (e.g. \"low\", \"medium\", \"high\", \"xhigh\").\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"reasoningEffort\")]\n public string? ReasoningEffort { get; set; }\n\n /// Whether this session supports remote steering via Mission Control.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"remoteSteerable\")]\n public bool? RemoteSteerable { get; set; }\n\n /// Model selected at session creation time, if any.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"selectedModel\")]\n public string? SelectedModel { get; set; }\n\n /// Unique identifier for the session.\n [JsonPropertyName(\"sessionId\")]\n public required string SessionId { get; set; }\n\n /// ISO 8601 timestamp when the session was created.\n [JsonPropertyName(\"startTime\")]\n public required DateTimeOffset StartTime { get; set; }\n\n /// Schema version number for the session event format.\n [JsonPropertyName(\"version\")]\n public required double Version { get; set; }\n}\n\n/// Session resume metadata including current context and event count.\npublic partial class SessionResumeData\n{\n /// Whether the session was already in use by another client at resume time.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"alreadyInUse\")]\n public bool? AlreadyInUse { get; set; }\n\n /// Updated working directory and git context at resume time.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"context\")]\n public WorkingDirectoryContext? Context { get; set; }\n\n /// When true, tool calls and permission requests left in flight by the previous session lifetime remain pending after resume and the agentic loop awaits their results. User sends are queued behind the pending work until all such requests reach a terminal state. When false (the default), any such tool calls and permission requests are immediately marked as interrupted on resume.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"continuePendingWork\")]\n public bool? ContinuePendingWork { get; set; }\n\n /// Total number of persisted events in the session at the time of resume.\n [JsonPropertyName(\"eventCount\")]\n public required double EventCount { get; set; }\n\n /// Reasoning effort level used for model calls, if applicable (e.g. \"low\", \"medium\", \"high\", \"xhigh\").\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"reasoningEffort\")]\n public string? ReasoningEffort { get; set; }\n\n /// Whether this session supports remote steering via Mission Control.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"remoteSteerable\")]\n public bool? RemoteSteerable { get; set; }\n\n /// ISO 8601 timestamp when the session was resumed.\n [JsonPropertyName(\"resumeTime\")]\n public required DateTimeOffset ResumeTime { get; set; }\n\n /// Model currently selected at resume time.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"selectedModel\")]\n public string? SelectedModel { get; set; }\n\n /// True when this resume attached to a session that the runtime already had running in-memory (for example, an extension joining a session another client was actively driving). False (or omitted) for cold resumes — the runtime had to reconstitute the session from its persisted event log.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"sessionWasActive\")]\n public bool? SessionWasActive { get; set; }\n}\n\n/// Notifies Mission Control that the session's remote steering capability has changed.\npublic partial class SessionRemoteSteerableChangedData\n{\n /// Whether this session now supports remote steering via Mission Control.\n [JsonPropertyName(\"remoteSteerable\")]\n public required bool RemoteSteerable { get; set; }\n}\n\n/// Error details for timeline display including message and optional diagnostic information.\npublic partial class SessionErrorData\n{\n /// Only set on `errorType: \"rate_limit\"`. When `true`, the runtime will follow this error with an `auto_mode_switch.requested` event (or silently switch if `continueOnAutoMode` is enabled). UI clients can use this flag to suppress duplicate rendering of the rate-limit error when they show their own auto-mode-switch prompt.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"eligibleForAutoSwitch\")]\n public bool? EligibleForAutoSwitch { get; set; }\n\n /// Fine-grained error code from the upstream provider, when available. For `errorType: \"rate_limit\"`, this is one of the `RateLimitErrorCode` values (e.g., `\"user_weekly_rate_limited\"`, `\"user_global_rate_limited\"`, `\"rate_limited\"`, `\"user_model_rate_limited\"`, `\"integration_rate_limited\"`).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"errorCode\")]\n public string? ErrorCode { get; set; }\n\n /// Category of error (e.g., \"authentication\", \"authorization\", \"quota\", \"rate_limit\", \"context_limit\", \"query\").\n [JsonPropertyName(\"errorType\")]\n public required string ErrorType { get; set; }\n\n /// Human-readable error message.\n [JsonPropertyName(\"message\")]\n public required string Message { get; set; }\n\n /// GitHub request tracing ID (x-github-request-id header) for correlating with server-side logs.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"providerCallId\")]\n public string? ProviderCallId { get; set; }\n\n /// Error stack trace, when available.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"stack\")]\n public string? Stack { get; set; }\n\n /// HTTP status code from the upstream request, if applicable.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"statusCode\")]\n public long? StatusCode { get; set; }\n\n /// Optional URL associated with this error that the user can open in a browser.\n [Url]\n [StringSyntax(StringSyntaxAttribute.Uri)]\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"url\")]\n public string? Url { get; set; }\n}\n\n/// Payload indicating the session is idle with no background agents in flight.\npublic partial class SessionIdleData\n{\n /// True when the preceding agentic loop was cancelled via abort signal.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"aborted\")]\n public bool? Aborted { get; set; }\n}\n\n/// Session title change payload containing the new display title.\npublic partial class SessionTitleChangedData\n{\n /// The new display title for the session.\n [JsonPropertyName(\"title\")]\n public required string Title { get; set; }\n}\n\n/// Informational message for timeline display with categorization.\npublic partial class SessionInfoData\n{\n /// Category of informational message (e.g., \"notification\", \"timing\", \"context_window\", \"mcp\", \"snapshot\", \"configuration\", \"authentication\", \"model\").\n [JsonPropertyName(\"infoType\")]\n public required string InfoType { get; set; }\n\n /// Human-readable informational message for display in the timeline.\n [JsonPropertyName(\"message\")]\n public required string Message { get; set; }\n\n /// Optional actionable tip displayed with this message.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"tip\")]\n public string? Tip { get; set; }\n\n /// Optional URL associated with this message that the user can open in a browser.\n [Url]\n [StringSyntax(StringSyntaxAttribute.Uri)]\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"url\")]\n public string? Url { get; set; }\n}\n\n/// Warning message for timeline display with categorization.\npublic partial class SessionWarningData\n{\n /// Human-readable warning message for display in the timeline.\n [JsonPropertyName(\"message\")]\n public required string Message { get; set; }\n\n /// Optional URL associated with this warning that the user can open in a browser.\n [Url]\n [StringSyntax(StringSyntaxAttribute.Uri)]\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"url\")]\n public string? Url { get; set; }\n\n /// Category of warning (e.g., \"subscription\", \"policy\", \"mcp\").\n [JsonPropertyName(\"warningType\")]\n public required string WarningType { get; set; }\n}\n\n/// Model change details including previous and new model identifiers.\npublic partial class SessionModelChangeData\n{\n /// Reason the change happened, when not user-initiated. Currently `\"rate_limit_auto_switch\"` for changes triggered by the auto-mode-switch rate-limit recovery path. UI clients can use this to render contextual copy.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"cause\")]\n public string? Cause { get; set; }\n\n /// Newly selected model identifier.\n [JsonPropertyName(\"newModel\")]\n public required string NewModel { get; set; }\n\n /// Model that was previously selected, if any.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"previousModel\")]\n public string? PreviousModel { get; set; }\n\n /// Reasoning effort level before the model change, if applicable.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"previousReasoningEffort\")]\n public string? PreviousReasoningEffort { get; set; }\n\n /// Reasoning effort level after the model change, if applicable.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"reasoningEffort\")]\n public string? ReasoningEffort { get; set; }\n}\n\n/// Agent mode change details including previous and new modes.\npublic partial class SessionModeChangedData\n{\n /// Agent mode after the change (e.g., \"interactive\", \"plan\", \"autopilot\").\n [JsonPropertyName(\"newMode\")]\n public required string NewMode { get; set; }\n\n /// Agent mode before the change (e.g., \"interactive\", \"plan\", \"autopilot\").\n [JsonPropertyName(\"previousMode\")]\n public required string PreviousMode { get; set; }\n}\n\n/// Plan file operation details indicating what changed.\npublic partial class SessionPlanChangedData\n{\n /// The type of operation performed on the plan file.\n [JsonPropertyName(\"operation\")]\n public required PlanChangedOperation Operation { get; set; }\n}\n\n/// Workspace file change details including path and operation type.\npublic partial class SessionWorkspaceFileChangedData\n{\n /// Whether the file was newly created or updated.\n [JsonPropertyName(\"operation\")]\n public required WorkspaceFileChangedOperation Operation { get; set; }\n\n /// Relative path within the session workspace files directory.\n [JsonPropertyName(\"path\")]\n public required string Path { get; set; }\n}\n\n/// Session handoff metadata including source, context, and repository information.\npublic partial class SessionHandoffData\n{\n /// Additional context information for the handoff.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"context\")]\n public string? Context { get; set; }\n\n /// ISO 8601 timestamp when the handoff occurred.\n [JsonPropertyName(\"handoffTime\")]\n public required DateTimeOffset HandoffTime { get; set; }\n\n /// GitHub host URL for the source session (e.g., https://github.com or https://tenant.ghe.com).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"host\")]\n public string? Host { get; set; }\n\n /// Session ID of the remote session being handed off.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"remoteSessionId\")]\n public string? RemoteSessionId { get; set; }\n\n /// Repository context for the handed-off session.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"repository\")]\n public HandoffRepository? Repository { get; set; }\n\n /// Origin type of the session being handed off.\n [JsonPropertyName(\"sourceType\")]\n public required HandoffSourceType SourceType { get; set; }\n\n /// Summary of the work done in the source session.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"summary\")]\n public string? Summary { get; set; }\n}\n\n/// Conversation truncation statistics including token counts and removed content metrics.\npublic partial class SessionTruncationData\n{\n /// Number of messages removed by truncation.\n [JsonPropertyName(\"messagesRemovedDuringTruncation\")]\n public required double MessagesRemovedDuringTruncation { get; set; }\n\n /// Identifier of the component that performed truncation (e.g., \"BasicTruncator\").\n [JsonPropertyName(\"performedBy\")]\n public required string PerformedBy { get; set; }\n\n /// Number of conversation messages after truncation.\n [JsonPropertyName(\"postTruncationMessagesLength\")]\n public required double PostTruncationMessagesLength { get; set; }\n\n /// Total tokens in conversation messages after truncation.\n [JsonPropertyName(\"postTruncationTokensInMessages\")]\n public required double PostTruncationTokensInMessages { get; set; }\n\n /// Number of conversation messages before truncation.\n [JsonPropertyName(\"preTruncationMessagesLength\")]\n public required double PreTruncationMessagesLength { get; set; }\n\n /// Total tokens in conversation messages before truncation.\n [JsonPropertyName(\"preTruncationTokensInMessages\")]\n public required double PreTruncationTokensInMessages { get; set; }\n\n /// Maximum token count for the model's context window.\n [JsonPropertyName(\"tokenLimit\")]\n public required double TokenLimit { get; set; }\n\n /// Number of tokens removed by truncation.\n [JsonPropertyName(\"tokensRemovedDuringTruncation\")]\n public required double TokensRemovedDuringTruncation { get; set; }\n}\n\n/// Session rewind details including target event and count of removed events.\npublic partial class SessionSnapshotRewindData\n{\n /// Number of events that were removed by the rewind.\n [JsonPropertyName(\"eventsRemoved\")]\n public required double EventsRemoved { get; set; }\n\n /// Event ID that was rewound to; this event and all after it were removed.\n [JsonPropertyName(\"upToEventId\")]\n public required string UpToEventId { get; set; }\n}\n\n/// Session termination metrics including usage statistics, code changes, and shutdown reason.\npublic partial class SessionShutdownData\n{\n /// Aggregate code change metrics for the session.\n [JsonPropertyName(\"codeChanges\")]\n public required ShutdownCodeChanges CodeChanges { get; set; }\n\n /// Non-system message token count at shutdown.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"conversationTokens\")]\n public double? ConversationTokens { get; set; }\n\n /// Model that was selected at the time of shutdown.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"currentModel\")]\n public string? CurrentModel { get; set; }\n\n /// Total tokens in context window at shutdown.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"currentTokens\")]\n public double? CurrentTokens { get; set; }\n\n /// Error description when shutdownType is \"error\".\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"errorReason\")]\n public string? ErrorReason { get; set; }\n\n /// Per-model usage breakdown, keyed by model identifier.\n [JsonPropertyName(\"modelMetrics\")]\n public required IDictionary ModelMetrics { get; set; }\n\n /// Unix timestamp (milliseconds) when the session started.\n [JsonPropertyName(\"sessionStartTime\")]\n public required double SessionStartTime { get; set; }\n\n /// Whether the session ended normally (\"routine\") or due to a crash/fatal error (\"error\").\n [JsonPropertyName(\"shutdownType\")]\n public required ShutdownType ShutdownType { get; set; }\n\n /// System message token count at shutdown.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"systemTokens\")]\n public double? SystemTokens { get; set; }\n\n /// Session-wide per-token-type accumulated token counts.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"tokenDetails\")]\n public IDictionary? TokenDetails { get; set; }\n\n /// Tool definitions token count at shutdown.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolDefinitionsTokens\")]\n public double? ToolDefinitionsTokens { get; set; }\n\n /// Cumulative time spent in API calls during the session, in milliseconds.\n [JsonPropertyName(\"totalApiDurationMs\")]\n public required double TotalApiDurationMs { get; set; }\n\n /// Session-wide accumulated nano-AI units cost.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"totalNanoAiu\")]\n public double? TotalNanoAiu { get; set; }\n\n /// Total number of premium API requests used during the session.\n [JsonPropertyName(\"totalPremiumRequests\")]\n public required double TotalPremiumRequests { get; set; }\n}\n\n/// Working directory and git context at session start.\npublic partial class SessionContextChangedData\n{\n /// Base commit of current git branch at session start time.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"baseCommit\")]\n public string? BaseCommit { get; set; }\n\n /// Current git branch name.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"branch\")]\n public string? Branch { get; set; }\n\n /// Current working directory path.\n [JsonPropertyName(\"cwd\")]\n public required string Cwd { get; set; }\n\n /// Root directory of the git repository, resolved via git rev-parse.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"gitRoot\")]\n public string? GitRoot { get; set; }\n\n /// Head commit of current git branch at session start time.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"headCommit\")]\n public string? HeadCommit { get; set; }\n\n /// Hosting platform type of the repository (github or ado).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"hostType\")]\n public WorkingDirectoryContextHostType? HostType { get; set; }\n\n /// Repository identifier derived from the git remote URL (\"owner/name\" for GitHub, \"org/project/repo\" for Azure DevOps).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"repository\")]\n public string? Repository { get; set; }\n\n /// Raw host string from the git remote URL (e.g. \"github.com\", \"mycompany.ghe.com\", \"dev.azure.com\").\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"repositoryHost\")]\n public string? RepositoryHost { get; set; }\n}\n\n/// Current context window usage statistics including token and message counts.\npublic partial class SessionUsageInfoData\n{\n /// Token count from non-system messages (user, assistant, tool).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"conversationTokens\")]\n public double? ConversationTokens { get; set; }\n\n /// Current number of tokens in the context window.\n [JsonPropertyName(\"currentTokens\")]\n public required double CurrentTokens { get; set; }\n\n /// Whether this is the first usage_info event emitted in this session.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"isInitial\")]\n public bool? IsInitial { get; set; }\n\n /// Current number of messages in the conversation.\n [JsonPropertyName(\"messagesLength\")]\n public required double MessagesLength { get; set; }\n\n /// Token count from system message(s).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"systemTokens\")]\n public double? SystemTokens { get; set; }\n\n /// Maximum token count for the model's context window.\n [JsonPropertyName(\"tokenLimit\")]\n public required double TokenLimit { get; set; }\n\n /// Token count from tool definitions.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolDefinitionsTokens\")]\n public double? ToolDefinitionsTokens { get; set; }\n}\n\n/// Context window breakdown at the start of LLM-powered conversation compaction.\npublic partial class SessionCompactionStartData\n{\n /// Token count from non-system messages (user, assistant, tool) at compaction start.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"conversationTokens\")]\n public double? ConversationTokens { get; set; }\n\n /// Token count from system message(s) at compaction start.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"systemTokens\")]\n public double? SystemTokens { get; set; }\n\n /// Token count from tool definitions at compaction start.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolDefinitionsTokens\")]\n public double? ToolDefinitionsTokens { get; set; }\n}\n\n/// Conversation compaction results including success status, metrics, and optional error details.\npublic partial class SessionCompactionCompleteData\n{\n /// Checkpoint snapshot number created for recovery.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"checkpointNumber\")]\n public double? CheckpointNumber { get; set; }\n\n /// File path where the checkpoint was stored.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"checkpointPath\")]\n public string? CheckpointPath { get; set; }\n\n /// Token usage breakdown for the compaction LLM call (aligned with assistant.usage format).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"compactionTokensUsed\")]\n public CompactionCompleteCompactionTokensUsed? CompactionTokensUsed { get; set; }\n\n /// Token count from non-system messages (user, assistant, tool) after compaction.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"conversationTokens\")]\n public double? ConversationTokens { get; set; }\n\n /// Error message if compaction failed.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"error\")]\n public string? Error { get; set; }\n\n /// Number of messages removed during compaction.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"messagesRemoved\")]\n public double? MessagesRemoved { get; set; }\n\n /// Total tokens in conversation after compaction.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"postCompactionTokens\")]\n public double? PostCompactionTokens { get; set; }\n\n /// Number of messages before compaction.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"preCompactionMessagesLength\")]\n public double? PreCompactionMessagesLength { get; set; }\n\n /// Total tokens in conversation before compaction.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"preCompactionTokens\")]\n public double? PreCompactionTokens { get; set; }\n\n /// GitHub request tracing ID (x-github-request-id header) for the compaction LLM call.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"requestId\")]\n public string? RequestId { get; set; }\n\n /// Whether compaction completed successfully.\n [JsonPropertyName(\"success\")]\n public required bool Success { get; set; }\n\n /// LLM-generated summary of the compacted conversation history.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"summaryContent\")]\n public string? SummaryContent { get; set; }\n\n /// Token count from system message(s) after compaction.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"systemTokens\")]\n public double? SystemTokens { get; set; }\n\n /// Number of tokens removed during compaction.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"tokensRemoved\")]\n public double? TokensRemoved { get; set; }\n\n /// Token count from tool definitions after compaction.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolDefinitionsTokens\")]\n public double? ToolDefinitionsTokens { get; set; }\n}\n\n/// Task completion notification with summary from the agent.\npublic partial class SessionTaskCompleteData\n{\n /// Whether the tool call succeeded. False when validation failed (e.g., invalid arguments).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"success\")]\n public bool? Success { get; set; }\n\n /// Summary of the completed task, provided by the agent.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"summary\")]\n public string? Summary { get; set; }\n}\n\n/// Event payload for .\npublic partial class UserMessageData\n{\n /// The agent mode that was active when this message was sent.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"agentMode\")]\n public UserMessageAgentMode? AgentMode { get; set; }\n\n /// Files, selections, or GitHub references attached to the message.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"attachments\")]\n public UserMessageAttachment[]? Attachments { get; set; }\n\n /// The user's message text as displayed in the timeline.\n [JsonPropertyName(\"content\")]\n public required string Content { get; set; }\n\n /// CAPI interaction ID for correlating this user message with its turn.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"interactionId\")]\n public string? InteractionId { get; set; }\n\n /// Path-backed native document attachments that stayed on the tagged_files path flow because native upload would exceed the request size limit.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"nativeDocumentPathFallbackPaths\")]\n public string[]? NativeDocumentPathFallbackPaths { get; set; }\n\n /// Parent agent task ID for background telemetry correlated to this user turn.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"parentAgentTaskId\")]\n public string? ParentAgentTaskId { get; set; }\n\n /// Origin of this message, used for timeline filtering (e.g., \"skill-pdf\" for skill-injected messages that should be hidden from the user).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"source\")]\n public string? Source { get; set; }\n\n /// Normalized document MIME types that were sent natively instead of through tagged_files XML.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"supportedNativeDocumentMimeTypes\")]\n public string[]? SupportedNativeDocumentMimeTypes { get; set; }\n\n /// Transformed version of the message sent to the model, with XML wrapping, timestamps, and other augmentations for prompt caching.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"transformedContent\")]\n public string? TransformedContent { get; set; }\n}\n\n/// Empty payload; the event signals that the pending message queue has changed.\npublic partial class PendingMessagesModifiedData\n{\n}\n\n/// Turn initialization metadata including identifier and interaction tracking.\npublic partial class AssistantTurnStartData\n{\n /// CAPI interaction ID for correlating this turn with upstream telemetry.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"interactionId\")]\n public string? InteractionId { get; set; }\n\n /// Identifier for this turn within the agentic loop, typically a stringified turn number.\n [JsonPropertyName(\"turnId\")]\n public required string TurnId { get; set; }\n}\n\n/// Agent intent description for current activity or plan.\npublic partial class AssistantIntentData\n{\n /// Short description of what the agent is currently doing or planning to do.\n [JsonPropertyName(\"intent\")]\n public required string Intent { get; set; }\n}\n\n/// Assistant reasoning content for timeline display with complete thinking text.\npublic partial class AssistantReasoningData\n{\n /// The complete extended thinking text from the model.\n [JsonPropertyName(\"content\")]\n public required string Content { get; set; }\n\n /// Unique identifier for this reasoning block.\n [JsonPropertyName(\"reasoningId\")]\n public required string ReasoningId { get; set; }\n}\n\n/// Streaming reasoning delta for incremental extended thinking updates.\npublic partial class AssistantReasoningDeltaData\n{\n /// Incremental text chunk to append to the reasoning content.\n [JsonPropertyName(\"deltaContent\")]\n public required string DeltaContent { get; set; }\n\n /// Reasoning block ID this delta belongs to, matching the corresponding assistant.reasoning event.\n [JsonPropertyName(\"reasoningId\")]\n public required string ReasoningId { get; set; }\n}\n\n/// Streaming response progress with cumulative byte count.\npublic partial class AssistantStreamingDeltaData\n{\n /// Cumulative total bytes received from the streaming response so far.\n [JsonPropertyName(\"totalResponseSizeBytes\")]\n public required double TotalResponseSizeBytes { get; set; }\n}\n\n/// Assistant response containing text content, optional tool requests, and interaction metadata.\npublic partial class AssistantMessageData\n{\n /// The assistant's text response content.\n [JsonPropertyName(\"content\")]\n public required string Content { get; set; }\n\n /// Encrypted reasoning content from OpenAI models. Session-bound and stripped on resume.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"encryptedContent\")]\n public string? EncryptedContent { get; set; }\n\n /// CAPI interaction ID for correlating this message with upstream telemetry.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"interactionId\")]\n public string? InteractionId { get; set; }\n\n /// Unique identifier for this assistant message.\n [JsonPropertyName(\"messageId\")]\n public required string MessageId { get; set; }\n\n /// Actual output token count from the API response (completion_tokens), used for accurate token accounting.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"outputTokens\")]\n public double? OutputTokens { get; set; }\n\n /// Tool call ID of the parent tool invocation when this event originates from a sub-agent.\n [Obsolete(\"This member is deprecated and will be removed in a future version.\")]\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"parentToolCallId\")]\n public string? ParentToolCallId { get; set; }\n\n /// Generation phase for phased-output models (e.g., thinking vs. response phases).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"phase\")]\n public string? Phase { get; set; }\n\n /// Opaque/encrypted extended thinking data from Anthropic models. Session-bound and stripped on resume.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"reasoningOpaque\")]\n public string? ReasoningOpaque { get; set; }\n\n /// Readable reasoning text from the model's extended thinking.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"reasoningText\")]\n public string? ReasoningText { get; set; }\n\n /// GitHub request tracing ID (x-github-request-id header) for correlating with server-side logs.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"requestId\")]\n public string? RequestId { get; set; }\n\n /// Tool invocations requested by the assistant in this message.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolRequests\")]\n public AssistantMessageToolRequest[]? ToolRequests { get; set; }\n\n /// Identifier for the agent loop turn that produced this message, matching the corresponding assistant.turn_start event.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"turnId\")]\n public string? TurnId { get; set; }\n}\n\n/// Streaming assistant message start metadata.\npublic partial class AssistantMessageStartData\n{\n /// Message ID this start event belongs to, matching subsequent deltas and assistant.message.\n [JsonPropertyName(\"messageId\")]\n public required string MessageId { get; set; }\n\n /// Generation phase this message belongs to for phased-output models.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"phase\")]\n public string? Phase { get; set; }\n}\n\n/// Streaming assistant message delta for incremental response updates.\npublic partial class AssistantMessageDeltaData\n{\n /// Incremental text chunk to append to the message content.\n [JsonPropertyName(\"deltaContent\")]\n public required string DeltaContent { get; set; }\n\n /// Message ID this delta belongs to, matching the corresponding assistant.message event.\n [JsonPropertyName(\"messageId\")]\n public required string MessageId { get; set; }\n\n /// Tool call ID of the parent tool invocation when this event originates from a sub-agent.\n [Obsolete(\"This member is deprecated and will be removed in a future version.\")]\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"parentToolCallId\")]\n public string? ParentToolCallId { get; set; }\n}\n\n/// Turn completion metadata including the turn identifier.\npublic partial class AssistantTurnEndData\n{\n /// Identifier of the turn that has ended, matching the corresponding assistant.turn_start event.\n [JsonPropertyName(\"turnId\")]\n public required string TurnId { get; set; }\n}\n\n/// LLM API call usage metrics including tokens, costs, quotas, and billing information.\npublic partial class AssistantUsageData\n{\n /// Completion ID from the model provider (e.g., chatcmpl-abc123).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"apiCallId\")]\n public string? ApiCallId { get; set; }\n\n /// Number of tokens read from prompt cache.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"cacheReadTokens\")]\n public double? CacheReadTokens { get; set; }\n\n /// Number of tokens written to prompt cache.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"cacheWriteTokens\")]\n public double? CacheWriteTokens { get; set; }\n\n /// Per-request cost and usage data from the CAPI copilot_usage response field.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"copilotUsage\")]\n public AssistantUsageCopilotUsage? CopilotUsage { get; set; }\n\n /// Model multiplier cost for billing purposes.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"cost\")]\n public double? Cost { get; set; }\n\n /// Duration of the API call in milliseconds.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"duration\")]\n public double? Duration { get; set; }\n\n /// What initiated this API call (e.g., \"sub-agent\", \"mcp-sampling\"); absent for user-initiated calls.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"initiator\")]\n public string? Initiator { get; set; }\n\n /// Number of input tokens consumed.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"inputTokens\")]\n public double? InputTokens { get; set; }\n\n /// Average inter-token latency in milliseconds. Only available for streaming requests.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"interTokenLatencyMs\")]\n public double? InterTokenLatencyMs { get; set; }\n\n /// Model identifier used for this API call.\n [JsonPropertyName(\"model\")]\n public required string Model { get; set; }\n\n /// Number of output tokens produced.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"outputTokens\")]\n public double? OutputTokens { get; set; }\n\n /// Parent tool call ID when this usage originates from a sub-agent.\n [Obsolete(\"This member is deprecated and will be removed in a future version.\")]\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"parentToolCallId\")]\n public string? ParentToolCallId { get; set; }\n\n /// GitHub request tracing ID (x-github-request-id header) for server-side log correlation.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"providerCallId\")]\n public string? ProviderCallId { get; set; }\n\n /// Per-quota resource usage snapshots, keyed by quota identifier.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"quotaSnapshots\")]\n public IDictionary? QuotaSnapshots { get; set; }\n\n /// Reasoning effort level used for model calls, if applicable (e.g. \"low\", \"medium\", \"high\", \"xhigh\").\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"reasoningEffort\")]\n public string? ReasoningEffort { get; set; }\n\n /// Number of output tokens used for reasoning (e.g., chain-of-thought).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"reasoningTokens\")]\n public double? ReasoningTokens { get; set; }\n\n /// Time to first token in milliseconds. Only available for streaming requests.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"ttftMs\")]\n public double? TtftMs { get; set; }\n}\n\n/// Failed LLM API call metadata for telemetry.\npublic partial class ModelCallFailureData\n{\n /// Completion ID from the model provider (e.g., chatcmpl-abc123).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"apiCallId\")]\n public string? ApiCallId { get; set; }\n\n /// Duration of the failed API call in milliseconds.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"durationMs\")]\n public double? DurationMs { get; set; }\n\n /// Raw provider/runtime error message for restricted telemetry.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"errorMessage\")]\n public string? ErrorMessage { get; set; }\n\n /// What initiated this API call (e.g., \"sub-agent\", \"mcp-sampling\"); absent for user-initiated calls.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"initiator\")]\n public string? Initiator { get; set; }\n\n /// Model identifier used for the failed API call.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"model\")]\n public string? Model { get; set; }\n\n /// GitHub request tracing ID (x-github-request-id header) for server-side log correlation.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"providerCallId\")]\n public string? ProviderCallId { get; set; }\n\n /// Where the failed model call originated.\n [JsonPropertyName(\"source\")]\n public required ModelCallFailureSource Source { get; set; }\n\n /// HTTP status code from the failed request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"statusCode\")]\n public long? StatusCode { get; set; }\n}\n\n/// Turn abort information including the reason for termination.\npublic partial class AbortData\n{\n /// Reason the current turn was aborted (e.g., \"user initiated\").\n [JsonPropertyName(\"reason\")]\n public required string Reason { get; set; }\n}\n\n/// User-initiated tool invocation request with tool name and arguments.\npublic partial class ToolUserRequestedData\n{\n /// Arguments for the tool invocation.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"arguments\")]\n public object? Arguments { get; set; }\n\n /// Unique identifier for this tool call.\n [JsonPropertyName(\"toolCallId\")]\n public required string ToolCallId { get; set; }\n\n /// Name of the tool the user wants to invoke.\n [JsonPropertyName(\"toolName\")]\n public required string ToolName { get; set; }\n}\n\n/// Tool execution startup details including MCP server information when applicable.\npublic partial class ToolExecutionStartData\n{\n /// Arguments passed to the tool.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"arguments\")]\n public object? Arguments { get; set; }\n\n /// Name of the MCP server hosting this tool, when the tool is an MCP tool.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"mcpServerName\")]\n public string? McpServerName { get; set; }\n\n /// Original tool name on the MCP server, when the tool is an MCP tool.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"mcpToolName\")]\n public string? McpToolName { get; set; }\n\n /// Tool call ID of the parent tool invocation when this event originates from a sub-agent.\n [Obsolete(\"This member is deprecated and will be removed in a future version.\")]\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"parentToolCallId\")]\n public string? ParentToolCallId { get; set; }\n\n /// Unique identifier for this tool call.\n [JsonPropertyName(\"toolCallId\")]\n public required string ToolCallId { get; set; }\n\n /// Name of the tool being executed.\n [JsonPropertyName(\"toolName\")]\n public required string ToolName { get; set; }\n\n /// Identifier for the agent loop turn this tool was invoked in, matching the corresponding assistant.turn_start event.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"turnId\")]\n public string? TurnId { get; set; }\n}\n\n/// Streaming tool execution output for incremental result display.\npublic partial class ToolExecutionPartialResultData\n{\n /// Incremental output chunk from the running tool.\n [JsonPropertyName(\"partialOutput\")]\n public required string PartialOutput { get; set; }\n\n /// Tool call ID this partial result belongs to.\n [JsonPropertyName(\"toolCallId\")]\n public required string ToolCallId { get; set; }\n}\n\n/// Tool execution progress notification with status message.\npublic partial class ToolExecutionProgressData\n{\n /// Human-readable progress status message (e.g., from an MCP server).\n [JsonPropertyName(\"progressMessage\")]\n public required string ProgressMessage { get; set; }\n\n /// Tool call ID this progress notification belongs to.\n [JsonPropertyName(\"toolCallId\")]\n public required string ToolCallId { get; set; }\n}\n\n/// Tool execution completion results including success status, detailed output, and error information.\npublic partial class ToolExecutionCompleteData\n{\n /// Error details when the tool execution failed.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"error\")]\n public ToolExecutionCompleteError? Error { get; set; }\n\n /// CAPI interaction ID for correlating this tool execution with upstream telemetry.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"interactionId\")]\n public string? InteractionId { get; set; }\n\n /// Whether this tool call was explicitly requested by the user rather than the assistant.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"isUserRequested\")]\n public bool? IsUserRequested { get; set; }\n\n /// Model identifier that generated this tool call.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"model\")]\n public string? Model { get; set; }\n\n /// Tool call ID of the parent tool invocation when this event originates from a sub-agent.\n [Obsolete(\"This member is deprecated and will be removed in a future version.\")]\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"parentToolCallId\")]\n public string? ParentToolCallId { get; set; }\n\n /// Tool execution result on success.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"result\")]\n public ToolExecutionCompleteResult? Result { get; set; }\n\n /// Whether the tool execution completed successfully.\n [JsonPropertyName(\"success\")]\n public required bool Success { get; set; }\n\n /// Unique identifier for the completed tool call.\n [JsonPropertyName(\"toolCallId\")]\n public required string ToolCallId { get; set; }\n\n /// Tool-specific telemetry data (e.g., CodeQL check counts, grep match counts).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolTelemetry\")]\n public IDictionary? ToolTelemetry { get; set; }\n\n /// Identifier for the agent loop turn this tool was invoked in, matching the corresponding assistant.turn_start event.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"turnId\")]\n public string? TurnId { get; set; }\n}\n\n/// Skill invocation details including content, allowed tools, and plugin metadata.\npublic partial class SkillInvokedData\n{\n /// Tool names that should be auto-approved when this skill is active.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"allowedTools\")]\n public string[]? AllowedTools { get; set; }\n\n /// Full content of the skill file, injected into the conversation for the model.\n [JsonPropertyName(\"content\")]\n public required string Content { get; set; }\n\n /// Description of the skill from its SKILL.md frontmatter.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"description\")]\n public string? Description { get; set; }\n\n /// Name of the invoked skill.\n [JsonPropertyName(\"name\")]\n public required string Name { get; set; }\n\n /// File path to the SKILL.md definition.\n [JsonPropertyName(\"path\")]\n public required string Path { get; set; }\n\n /// Name of the plugin this skill originated from, when applicable.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"pluginName\")]\n public string? PluginName { get; set; }\n\n /// Version of the plugin this skill originated from, when applicable.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"pluginVersion\")]\n public string? PluginVersion { get; set; }\n}\n\n/// Sub-agent startup details including parent tool call and agent information.\npublic partial class SubagentStartedData\n{\n /// Description of what the sub-agent does.\n [JsonPropertyName(\"agentDescription\")]\n public required string AgentDescription { get; set; }\n\n /// Human-readable display name of the sub-agent.\n [JsonPropertyName(\"agentDisplayName\")]\n public required string AgentDisplayName { get; set; }\n\n /// Internal name of the sub-agent.\n [JsonPropertyName(\"agentName\")]\n public required string AgentName { get; set; }\n\n /// Tool call ID of the parent tool invocation that spawned this sub-agent.\n [JsonPropertyName(\"toolCallId\")]\n public required string ToolCallId { get; set; }\n}\n\n/// Sub-agent completion details for successful execution.\npublic partial class SubagentCompletedData\n{\n /// Human-readable display name of the sub-agent.\n [JsonPropertyName(\"agentDisplayName\")]\n public required string AgentDisplayName { get; set; }\n\n /// Internal name of the sub-agent.\n [JsonPropertyName(\"agentName\")]\n public required string AgentName { get; set; }\n\n /// Wall-clock duration of the sub-agent execution in milliseconds.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"durationMs\")]\n public double? DurationMs { get; set; }\n\n /// Model used by the sub-agent.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"model\")]\n public string? Model { get; set; }\n\n /// Tool call ID of the parent tool invocation that spawned this sub-agent.\n [JsonPropertyName(\"toolCallId\")]\n public required string ToolCallId { get; set; }\n\n /// Total tokens (input + output) consumed by the sub-agent.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"totalTokens\")]\n public double? TotalTokens { get; set; }\n\n /// Total number of tool calls made by the sub-agent.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"totalToolCalls\")]\n public double? TotalToolCalls { get; set; }\n}\n\n/// Sub-agent failure details including error message and agent information.\npublic partial class SubagentFailedData\n{\n /// Human-readable display name of the sub-agent.\n [JsonPropertyName(\"agentDisplayName\")]\n public required string AgentDisplayName { get; set; }\n\n /// Internal name of the sub-agent.\n [JsonPropertyName(\"agentName\")]\n public required string AgentName { get; set; }\n\n /// Wall-clock duration of the sub-agent execution in milliseconds.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"durationMs\")]\n public double? DurationMs { get; set; }\n\n /// Error message describing why the sub-agent failed.\n [JsonPropertyName(\"error\")]\n public required string Error { get; set; }\n\n /// Model used by the sub-agent (if any model calls succeeded before failure).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"model\")]\n public string? Model { get; set; }\n\n /// Tool call ID of the parent tool invocation that spawned this sub-agent.\n [JsonPropertyName(\"toolCallId\")]\n public required string ToolCallId { get; set; }\n\n /// Total tokens (input + output) consumed before the sub-agent failed.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"totalTokens\")]\n public double? TotalTokens { get; set; }\n\n /// Total number of tool calls made before the sub-agent failed.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"totalToolCalls\")]\n public double? TotalToolCalls { get; set; }\n}\n\n/// Custom agent selection details including name and available tools.\npublic partial class SubagentSelectedData\n{\n /// Human-readable display name of the selected custom agent.\n [JsonPropertyName(\"agentDisplayName\")]\n public required string AgentDisplayName { get; set; }\n\n /// Internal name of the selected custom agent.\n [JsonPropertyName(\"agentName\")]\n public required string AgentName { get; set; }\n\n /// List of tool names available to this agent, or null for all tools.\n [JsonPropertyName(\"tools\")]\n public string[]? Tools { get; set; }\n}\n\n/// Empty payload; the event signals that the custom agent was deselected, returning to the default agent.\npublic partial class SubagentDeselectedData\n{\n}\n\n/// Hook invocation start details including type and input data.\npublic partial class HookStartData\n{\n /// Unique identifier for this hook invocation.\n [JsonPropertyName(\"hookInvocationId\")]\n public required string HookInvocationId { get; set; }\n\n /// Type of hook being invoked (e.g., \"preToolUse\", \"postToolUse\", \"sessionStart\").\n [JsonPropertyName(\"hookType\")]\n public required string HookType { get; set; }\n\n /// Input data passed to the hook.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"input\")]\n public object? Input { get; set; }\n}\n\n/// Hook invocation completion details including output, success status, and error information.\npublic partial class HookEndData\n{\n /// Error details when the hook failed.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"error\")]\n public HookEndError? Error { get; set; }\n\n /// Identifier matching the corresponding hook.start event.\n [JsonPropertyName(\"hookInvocationId\")]\n public required string HookInvocationId { get; set; }\n\n /// Type of hook that was invoked (e.g., \"preToolUse\", \"postToolUse\", \"sessionStart\").\n [JsonPropertyName(\"hookType\")]\n public required string HookType { get; set; }\n\n /// Output data produced by the hook.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"output\")]\n public object? Output { get; set; }\n\n /// Whether the hook completed successfully.\n [JsonPropertyName(\"success\")]\n public required bool Success { get; set; }\n}\n\n/// System/developer instruction content with role and optional template metadata.\npublic partial class SystemMessageData\n{\n /// The system or developer prompt text sent as model input.\n [JsonPropertyName(\"content\")]\n public required string Content { get; set; }\n\n /// Metadata about the prompt template and its construction.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"metadata\")]\n public SystemMessageMetadata? Metadata { get; set; }\n\n /// Optional name identifier for the message source.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"name\")]\n public string? Name { get; set; }\n\n /// Message role: \"system\" for system prompts, \"developer\" for developer-injected instructions.\n [JsonPropertyName(\"role\")]\n public required SystemMessageRole Role { get; set; }\n}\n\n/// System-generated notification for runtime events like background task completion.\npublic partial class SystemNotificationData\n{\n /// The notification text, typically wrapped in <system_notification> XML tags.\n [JsonPropertyName(\"content\")]\n public required string Content { get; set; }\n\n /// Structured metadata identifying what triggered this notification.\n [JsonPropertyName(\"kind\")]\n public required SystemNotification Kind { get; set; }\n}\n\n/// Permission request notification requiring client approval with request details.\npublic partial class PermissionRequestedData\n{\n /// Details of the permission being requested.\n [JsonPropertyName(\"permissionRequest\")]\n public required PermissionRequest PermissionRequest { get; set; }\n\n /// Derived user-facing permission prompt details for UI consumers.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"promptRequest\")]\n public PermissionPromptRequest? PromptRequest { get; set; }\n\n /// Unique identifier for this permission request; used to respond via session.respondToPermission().\n [JsonPropertyName(\"requestId\")]\n public required string RequestId { get; set; }\n\n /// When true, this permission was already resolved by a permissionRequest hook and requires no client action.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"resolvedByHook\")]\n public bool? ResolvedByHook { get; set; }\n}\n\n/// Permission request completion notification signaling UI dismissal.\npublic partial class PermissionCompletedData\n{\n /// Request ID of the resolved permission request; clients should dismiss any UI for this request.\n [JsonPropertyName(\"requestId\")]\n public required string RequestId { get; set; }\n\n /// The result of the permission request.\n [JsonPropertyName(\"result\")]\n public required PermissionResult Result { get; set; }\n\n /// Optional tool call ID associated with this permission prompt; clients may use it to correlate UI created from tool-scoped prompts.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n}\n\n/// User input request notification with question and optional predefined choices.\npublic partial class UserInputRequestedData\n{\n /// Whether the user can provide a free-form text response in addition to predefined choices.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"allowFreeform\")]\n public bool? AllowFreeform { get; set; }\n\n /// Predefined choices for the user to select from, if applicable.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"choices\")]\n public string[]? Choices { get; set; }\n\n /// The question or prompt to present to the user.\n [JsonPropertyName(\"question\")]\n public required string Question { get; set; }\n\n /// Unique identifier for this input request; used to respond via session.respondToUserInput().\n [JsonPropertyName(\"requestId\")]\n public required string RequestId { get; set; }\n\n /// The LLM-assigned tool call ID that triggered this request; used by remote UIs to correlate responses.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n}\n\n/// User input request completion with the user's response.\npublic partial class UserInputCompletedData\n{\n /// The user's answer to the input request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"answer\")]\n public string? Answer { get; set; }\n\n /// Request ID of the resolved user input request; clients should dismiss any UI for this request.\n [JsonPropertyName(\"requestId\")]\n public required string RequestId { get; set; }\n\n /// Whether the answer was typed as free-form text rather than selected from choices.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"wasFreeform\")]\n public bool? WasFreeform { get; set; }\n}\n\n/// Elicitation request; may be form-based (structured input) or URL-based (browser redirect).\npublic partial class ElicitationRequestedData\n{\n /// The source that initiated the request (MCP server name, or absent for agent-initiated).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"elicitationSource\")]\n public string? ElicitationSource { get; set; }\n\n /// Message describing what information is needed from the user.\n [JsonPropertyName(\"message\")]\n public required string Message { get; set; }\n\n /// Elicitation mode; \"form\" for structured input, \"url\" for browser-based. Defaults to \"form\" when absent.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"mode\")]\n public ElicitationRequestedMode? Mode { get; set; }\n\n /// JSON Schema describing the form fields to present to the user (form mode only).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"requestedSchema\")]\n public ElicitationRequestedSchema? RequestedSchema { get; set; }\n\n /// Unique identifier for this elicitation request; used to respond via session.respondToElicitation().\n [JsonPropertyName(\"requestId\")]\n public required string RequestId { get; set; }\n\n /// Tool call ID from the LLM completion; used to correlate with CompletionChunk.toolCall.id for remote UIs.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n\n /// URL to open in the user's browser (url mode only).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"url\")]\n public string? Url { get; set; }\n}\n\n/// Elicitation request completion with the user's response.\npublic partial class ElicitationCompletedData\n{\n /// The user action: \"accept\" (submitted form), \"decline\" (explicitly refused), or \"cancel\" (dismissed).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"action\")]\n public ElicitationCompletedAction? Action { get; set; }\n\n /// The submitted form data when action is 'accept'; keys match the requested schema fields.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"content\")]\n public IDictionary? Content { get; set; }\n\n /// Request ID of the resolved elicitation request; clients should dismiss any UI for this request.\n [JsonPropertyName(\"requestId\")]\n public required string RequestId { get; set; }\n}\n\n/// Sampling request from an MCP server; contains the server name and a requestId for correlation.\npublic partial class SamplingRequestedData\n{\n /// The JSON-RPC request ID from the MCP protocol.\n [JsonPropertyName(\"mcpRequestId\")]\n public required object McpRequestId { get; set; }\n\n /// Unique identifier for this sampling request; used to respond via session.respondToSampling().\n [JsonPropertyName(\"requestId\")]\n public required string RequestId { get; set; }\n\n /// Name of the MCP server that initiated the sampling request.\n [JsonPropertyName(\"serverName\")]\n public required string ServerName { get; set; }\n}\n\n/// Sampling request completion notification signaling UI dismissal.\npublic partial class SamplingCompletedData\n{\n /// Request ID of the resolved sampling request; clients should dismiss any UI for this request.\n [JsonPropertyName(\"requestId\")]\n public required string RequestId { get; set; }\n}\n\n/// OAuth authentication request for an MCP server.\npublic partial class McpOauthRequiredData\n{\n /// Unique identifier for this OAuth request; used to respond via session.respondToMcpOAuth().\n [JsonPropertyName(\"requestId\")]\n public required string RequestId { get; set; }\n\n /// Display name of the MCP server that requires OAuth.\n [JsonPropertyName(\"serverName\")]\n public required string ServerName { get; set; }\n\n /// URL of the MCP server that requires OAuth.\n [JsonPropertyName(\"serverUrl\")]\n public required string ServerUrl { get; set; }\n\n /// Static OAuth client configuration, if the server specifies one.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"staticClientConfig\")]\n public McpOauthRequiredStaticClientConfig? StaticClientConfig { get; set; }\n}\n\n/// MCP OAuth request completion notification.\npublic partial class McpOauthCompletedData\n{\n /// Request ID of the resolved OAuth request.\n [JsonPropertyName(\"requestId\")]\n public required string RequestId { get; set; }\n}\n\n/// External tool invocation request for client-side tool execution.\npublic partial class ExternalToolRequestedData\n{\n /// Arguments to pass to the external tool.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"arguments\")]\n public object? Arguments { get; set; }\n\n /// Unique identifier for this request; used to respond via session.respondToExternalTool().\n [JsonPropertyName(\"requestId\")]\n public required string RequestId { get; set; }\n\n /// Session ID that this external tool request belongs to.\n [JsonPropertyName(\"sessionId\")]\n public required string SessionId { get; set; }\n\n /// Tool call ID assigned to this external tool invocation.\n [JsonPropertyName(\"toolCallId\")]\n public required string ToolCallId { get; set; }\n\n /// Name of the external tool to invoke.\n [JsonPropertyName(\"toolName\")]\n public required string ToolName { get; set; }\n\n /// W3C Trace Context traceparent header for the execute_tool span.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"traceparent\")]\n public string? Traceparent { get; set; }\n\n /// W3C Trace Context tracestate header for the execute_tool span.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"tracestate\")]\n public string? Tracestate { get; set; }\n}\n\n/// External tool completion notification signaling UI dismissal.\npublic partial class ExternalToolCompletedData\n{\n /// Request ID of the resolved external tool request; clients should dismiss any UI for this request.\n [JsonPropertyName(\"requestId\")]\n public required string RequestId { get; set; }\n}\n\n/// Queued slash command dispatch request for client execution.\npublic partial class CommandQueuedData\n{\n /// The slash command text to be executed (e.g., /help, /clear).\n [JsonPropertyName(\"command\")]\n public required string Command { get; set; }\n\n /// Unique identifier for this request; used to respond via session.respondToQueuedCommand().\n [JsonPropertyName(\"requestId\")]\n public required string RequestId { get; set; }\n}\n\n/// Registered command dispatch request routed to the owning client.\npublic partial class CommandExecuteData\n{\n /// Raw argument string after the command name.\n [JsonPropertyName(\"args\")]\n public required string Args { get; set; }\n\n /// The full command text (e.g., /deploy production).\n [JsonPropertyName(\"command\")]\n public required string Command { get; set; }\n\n /// Command name without leading /.\n [JsonPropertyName(\"commandName\")]\n public required string CommandName { get; set; }\n\n /// Unique identifier; used to respond via session.commands.handlePendingCommand().\n [JsonPropertyName(\"requestId\")]\n public required string RequestId { get; set; }\n}\n\n/// Queued command completion notification signaling UI dismissal.\npublic partial class CommandCompletedData\n{\n /// Request ID of the resolved command request; clients should dismiss any UI for this request.\n [JsonPropertyName(\"requestId\")]\n public required string RequestId { get; set; }\n}\n\n/// Auto mode switch request notification requiring user approval.\npublic partial class AutoModeSwitchRequestedData\n{\n /// The rate limit error code that triggered this request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"errorCode\")]\n public string? ErrorCode { get; set; }\n\n /// Unique identifier for this request; used to respond via session.respondToAutoModeSwitch().\n [JsonPropertyName(\"requestId\")]\n public required string RequestId { get; set; }\n\n /// Seconds until the rate limit resets, when known. Lets clients render a humanized reset time alongside the prompt.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"retryAfterSeconds\")]\n public double? RetryAfterSeconds { get; set; }\n}\n\n/// Auto mode switch completion notification.\npublic partial class AutoModeSwitchCompletedData\n{\n /// Request ID of the resolved request; clients should dismiss any UI for this request.\n [JsonPropertyName(\"requestId\")]\n public required string RequestId { get; set; }\n\n /// The user's choice: 'yes', 'yes_always', or 'no'.\n [JsonPropertyName(\"response\")]\n public required string Response { get; set; }\n}\n\n/// SDK command registration change notification.\npublic partial class CommandsChangedData\n{\n /// Current list of registered SDK commands.\n [JsonPropertyName(\"commands\")]\n public required CommandsChangedCommand[] Commands { get; set; }\n}\n\n/// Session capability change notification.\npublic partial class CapabilitiesChangedData\n{\n /// UI capability changes.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"ui\")]\n public CapabilitiesChangedUI? Ui { get; set; }\n}\n\n/// Plan approval request with plan content and available user actions.\npublic partial class ExitPlanModeRequestedData\n{\n /// Available actions the user can take (e.g., approve, edit, reject).\n [JsonPropertyName(\"actions\")]\n public required string[] Actions { get; set; }\n\n /// Full content of the plan file.\n [JsonPropertyName(\"planContent\")]\n public required string PlanContent { get; set; }\n\n /// The recommended action for the user to take.\n [JsonPropertyName(\"recommendedAction\")]\n public required string RecommendedAction { get; set; }\n\n /// Unique identifier for this request; used to respond via session.respondToExitPlanMode().\n [JsonPropertyName(\"requestId\")]\n public required string RequestId { get; set; }\n\n /// Summary of the plan that was created.\n [JsonPropertyName(\"summary\")]\n public required string Summary { get; set; }\n}\n\n/// Plan mode exit completion with the user's approval decision and optional feedback.\npublic partial class ExitPlanModeCompletedData\n{\n /// Whether the plan was approved by the user.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"approved\")]\n public bool? Approved { get; set; }\n\n /// Whether edits should be auto-approved without confirmation.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"autoApproveEdits\")]\n public bool? AutoApproveEdits { get; set; }\n\n /// Free-form feedback from the user if they requested changes to the plan.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"feedback\")]\n public string? Feedback { get; set; }\n\n /// Request ID of the resolved exit plan mode request; clients should dismiss any UI for this request.\n [JsonPropertyName(\"requestId\")]\n public required string RequestId { get; set; }\n\n /// Which action the user selected (e.g. 'autopilot', 'interactive', 'exit_only').\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"selectedAction\")]\n public string? SelectedAction { get; set; }\n}\n\n/// Event payload for .\npublic partial class SessionToolsUpdatedData\n{\n /// Gets or sets the model value.\n [JsonPropertyName(\"model\")]\n public required string Model { get; set; }\n}\n\n/// Event payload for .\npublic partial class SessionBackgroundTasksChangedData\n{\n}\n\n/// Event payload for .\npublic partial class SessionSkillsLoadedData\n{\n /// Array of resolved skill metadata.\n [JsonPropertyName(\"skills\")]\n public required SkillsLoadedSkill[] Skills { get; set; }\n}\n\n/// Event payload for .\npublic partial class SessionCustomAgentsUpdatedData\n{\n /// Array of loaded custom agent metadata.\n [JsonPropertyName(\"agents\")]\n public required CustomAgentsUpdatedAgent[] Agents { get; set; }\n\n /// Fatal errors from agent loading.\n [JsonPropertyName(\"errors\")]\n public required string[] Errors { get; set; }\n\n /// Non-fatal warnings from agent loading.\n [JsonPropertyName(\"warnings\")]\n public required string[] Warnings { get; set; }\n}\n\n/// Event payload for .\npublic partial class SessionMcpServersLoadedData\n{\n /// Array of MCP server status summaries.\n [JsonPropertyName(\"servers\")]\n public required McpServersLoadedServer[] Servers { get; set; }\n}\n\n/// Event payload for .\npublic partial class SessionMcpServerStatusChangedData\n{\n /// Name of the MCP server whose status changed.\n [JsonPropertyName(\"serverName\")]\n public required string ServerName { get; set; }\n\n /// New connection status: connected, failed, needs-auth, pending, disabled, or not_configured.\n [JsonPropertyName(\"status\")]\n public required McpServerStatusChangedStatus Status { get; set; }\n}\n\n/// Event payload for .\npublic partial class SessionExtensionsLoadedData\n{\n /// Array of discovered extensions and their status.\n [JsonPropertyName(\"extensions\")]\n public required ExtensionsLoadedExtension[] Extensions { get; set; }\n}\n\n/// Working directory and git context at session start.\n/// Nested data type for WorkingDirectoryContext.\npublic partial class WorkingDirectoryContext\n{\n /// Base commit of current git branch at session start time.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"baseCommit\")]\n public string? BaseCommit { get; set; }\n\n /// Current git branch name.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"branch\")]\n public string? Branch { get; set; }\n\n /// Current working directory path.\n [JsonPropertyName(\"cwd\")]\n public required string Cwd { get; set; }\n\n /// Root directory of the git repository, resolved via git rev-parse.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"gitRoot\")]\n public string? GitRoot { get; set; }\n\n /// Head commit of current git branch at session start time.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"headCommit\")]\n public string? HeadCommit { get; set; }\n\n /// Hosting platform type of the repository (github or ado).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"hostType\")]\n public WorkingDirectoryContextHostType? HostType { get; set; }\n\n /// Repository identifier derived from the git remote URL (\"owner/name\" for GitHub, \"org/project/repo\" for Azure DevOps).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"repository\")]\n public string? Repository { get; set; }\n\n /// Raw host string from the git remote URL (e.g. \"github.com\", \"mycompany.ghe.com\", \"dev.azure.com\").\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"repositoryHost\")]\n public string? RepositoryHost { get; set; }\n}\n\n/// Repository context for the handed-off session.\n/// Nested data type for HandoffRepository.\npublic partial class HandoffRepository\n{\n /// Git branch name, if applicable.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"branch\")]\n public string? Branch { get; set; }\n\n /// Repository name.\n [JsonPropertyName(\"name\")]\n public required string Name { get; set; }\n\n /// Repository owner (user or organization).\n [JsonPropertyName(\"owner\")]\n public required string Owner { get; set; }\n}\n\n/// Aggregate code change metrics for the session.\n/// Nested data type for ShutdownCodeChanges.\npublic partial class ShutdownCodeChanges\n{\n /// List of file paths that were modified during the session.\n [JsonPropertyName(\"filesModified\")]\n public required string[] FilesModified { get; set; }\n\n /// Total number of lines added during the session.\n [JsonPropertyName(\"linesAdded\")]\n public required double LinesAdded { get; set; }\n\n /// Total number of lines removed during the session.\n [JsonPropertyName(\"linesRemoved\")]\n public required double LinesRemoved { get; set; }\n}\n\n/// Request count and cost metrics.\n/// Nested data type for ShutdownModelMetricRequests.\npublic partial class ShutdownModelMetricRequests\n{\n /// Cumulative cost multiplier for requests to this model.\n [JsonPropertyName(\"cost\")]\n public required double Cost { get; set; }\n\n /// Total number of API requests made to this model.\n [JsonPropertyName(\"count\")]\n public required double Count { get; set; }\n}\n\n/// Nested data type for ShutdownModelMetricTokenDetail.\npublic partial class ShutdownModelMetricTokenDetail\n{\n /// Accumulated token count for this token type.\n [JsonPropertyName(\"tokenCount\")]\n public required double TokenCount { get; set; }\n}\n\n/// Token usage breakdown.\n/// Nested data type for ShutdownModelMetricUsage.\npublic partial class ShutdownModelMetricUsage\n{\n /// Total tokens read from prompt cache across all requests.\n [JsonPropertyName(\"cacheReadTokens\")]\n public required double CacheReadTokens { get; set; }\n\n /// Total tokens written to prompt cache across all requests.\n [JsonPropertyName(\"cacheWriteTokens\")]\n public required double CacheWriteTokens { get; set; }\n\n /// Total input tokens consumed across all requests to this model.\n [JsonPropertyName(\"inputTokens\")]\n public required double InputTokens { get; set; }\n\n /// Total output tokens produced across all requests to this model.\n [JsonPropertyName(\"outputTokens\")]\n public required double OutputTokens { get; set; }\n\n /// Total reasoning tokens produced across all requests to this model.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"reasoningTokens\")]\n public double? ReasoningTokens { get; set; }\n}\n\n/// Nested data type for ShutdownModelMetric.\npublic partial class ShutdownModelMetric\n{\n /// Request count and cost metrics.\n [JsonPropertyName(\"requests\")]\n public required ShutdownModelMetricRequests Requests { get; set; }\n\n /// Token count details per type.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"tokenDetails\")]\n public IDictionary? TokenDetails { get; set; }\n\n /// Accumulated nano-AI units cost for this model.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"totalNanoAiu\")]\n public double? TotalNanoAiu { get; set; }\n\n /// Token usage breakdown.\n [JsonPropertyName(\"usage\")]\n public required ShutdownModelMetricUsage Usage { get; set; }\n}\n\n/// Nested data type for ShutdownTokenDetail.\npublic partial class ShutdownTokenDetail\n{\n /// Accumulated token count for this token type.\n [JsonPropertyName(\"tokenCount\")]\n public required double TokenCount { get; set; }\n}\n\n/// Token usage detail for a single billing category.\n/// Nested data type for CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail.\npublic partial class CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail\n{\n /// Number of tokens in this billing batch.\n [JsonPropertyName(\"batchSize\")]\n public required double BatchSize { get; set; }\n\n /// Cost per batch of tokens.\n [JsonPropertyName(\"costPerBatch\")]\n public required double CostPerBatch { get; set; }\n\n /// Total token count for this entry.\n [JsonPropertyName(\"tokenCount\")]\n public required double TokenCount { get; set; }\n\n /// Token category (e.g., \"input\", \"output\").\n [JsonPropertyName(\"tokenType\")]\n public required string TokenType { get; set; }\n}\n\n/// Per-request cost and usage data from the CAPI copilot_usage response field.\n/// Nested data type for CompactionCompleteCompactionTokensUsedCopilotUsage.\npublic partial class CompactionCompleteCompactionTokensUsedCopilotUsage\n{\n /// Itemized token usage breakdown.\n [JsonPropertyName(\"tokenDetails\")]\n public required CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail[] TokenDetails { get; set; }\n\n /// Total cost in nano-AI units for this request.\n [JsonPropertyName(\"totalNanoAiu\")]\n public required double TotalNanoAiu { get; set; }\n}\n\n/// Token usage breakdown for the compaction LLM call (aligned with assistant.usage format).\n/// Nested data type for CompactionCompleteCompactionTokensUsed.\npublic partial class CompactionCompleteCompactionTokensUsed\n{\n /// Cached input tokens reused in the compaction LLM call.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"cacheReadTokens\")]\n public double? CacheReadTokens { get; set; }\n\n /// Tokens written to prompt cache in the compaction LLM call.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"cacheWriteTokens\")]\n public double? CacheWriteTokens { get; set; }\n\n /// Per-request cost and usage data from the CAPI copilot_usage response field.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"copilotUsage\")]\n public CompactionCompleteCompactionTokensUsedCopilotUsage? CopilotUsage { get; set; }\n\n /// Duration of the compaction LLM call in milliseconds.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"duration\")]\n public double? Duration { get; set; }\n\n /// Input tokens consumed by the compaction LLM call.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"inputTokens\")]\n public double? InputTokens { get; set; }\n\n /// Model identifier used for the compaction LLM call.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"model\")]\n public string? Model { get; set; }\n\n /// Output tokens produced by the compaction LLM call.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"outputTokens\")]\n public double? OutputTokens { get; set; }\n}\n\n/// Optional line range to scope the attachment to a specific section of the file.\n/// Nested data type for UserMessageAttachmentFileLineRange.\npublic partial class UserMessageAttachmentFileLineRange\n{\n /// End line number (1-based, inclusive).\n [JsonPropertyName(\"end\")]\n public required double End { get; set; }\n\n /// Start line number (1-based).\n [JsonPropertyName(\"start\")]\n public required double Start { get; set; }\n}\n\n/// File attachment.\n/// The file variant of .\npublic partial class UserMessageAttachmentFile : UserMessageAttachment\n{\n /// \n [JsonIgnore]\n public override string Type => \"file\";\n\n /// User-facing display name for the attachment.\n [JsonPropertyName(\"displayName\")]\n public required string DisplayName { get; set; }\n\n /// Optional line range to scope the attachment to a specific section of the file.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"lineRange\")]\n public UserMessageAttachmentFileLineRange? LineRange { get; set; }\n\n /// Absolute file path.\n [JsonPropertyName(\"path\")]\n public required string Path { get; set; }\n}\n\n/// Directory attachment.\n/// The directory variant of .\npublic partial class UserMessageAttachmentDirectory : UserMessageAttachment\n{\n /// \n [JsonIgnore]\n public override string Type => \"directory\";\n\n /// User-facing display name for the attachment.\n [JsonPropertyName(\"displayName\")]\n public required string DisplayName { get; set; }\n\n /// Absolute directory path.\n [JsonPropertyName(\"path\")]\n public required string Path { get; set; }\n}\n\n/// End position of the selection.\n/// Nested data type for UserMessageAttachmentSelectionDetailsEnd.\npublic partial class UserMessageAttachmentSelectionDetailsEnd\n{\n /// End character offset within the line (0-based).\n [JsonPropertyName(\"character\")]\n public required double Character { get; set; }\n\n /// End line number (0-based).\n [JsonPropertyName(\"line\")]\n public required double Line { get; set; }\n}\n\n/// Start position of the selection.\n/// Nested data type for UserMessageAttachmentSelectionDetailsStart.\npublic partial class UserMessageAttachmentSelectionDetailsStart\n{\n /// Start character offset within the line (0-based).\n [JsonPropertyName(\"character\")]\n public required double Character { get; set; }\n\n /// Start line number (0-based).\n [JsonPropertyName(\"line\")]\n public required double Line { get; set; }\n}\n\n/// Position range of the selection within the file.\n/// Nested data type for UserMessageAttachmentSelectionDetails.\npublic partial class UserMessageAttachmentSelectionDetails\n{\n /// End position of the selection.\n [JsonPropertyName(\"end\")]\n public required UserMessageAttachmentSelectionDetailsEnd End { get; set; }\n\n /// Start position of the selection.\n [JsonPropertyName(\"start\")]\n public required UserMessageAttachmentSelectionDetailsStart Start { get; set; }\n}\n\n/// Code selection attachment from an editor.\n/// The selection variant of .\npublic partial class UserMessageAttachmentSelection : UserMessageAttachment\n{\n /// \n [JsonIgnore]\n public override string Type => \"selection\";\n\n /// User-facing display name for the selection.\n [JsonPropertyName(\"displayName\")]\n public required string DisplayName { get; set; }\n\n /// Absolute path to the file containing the selection.\n [JsonPropertyName(\"filePath\")]\n public required string FilePath { get; set; }\n\n /// Position range of the selection within the file.\n [JsonPropertyName(\"selection\")]\n public required UserMessageAttachmentSelectionDetails Selection { get; set; }\n\n /// The selected text content.\n [JsonPropertyName(\"text\")]\n public required string Text { get; set; }\n}\n\n/// GitHub issue, pull request, or discussion reference.\n/// The github_reference variant of .\npublic partial class UserMessageAttachmentGithubReference : UserMessageAttachment\n{\n /// \n [JsonIgnore]\n public override string Type => \"github_reference\";\n\n /// Issue, pull request, or discussion number.\n [JsonPropertyName(\"number\")]\n public required double Number { get; set; }\n\n /// Type of GitHub reference.\n [JsonPropertyName(\"referenceType\")]\n public required UserMessageAttachmentGithubReferenceType ReferenceType { get; set; }\n\n /// Current state of the referenced item (e.g., open, closed, merged).\n [JsonPropertyName(\"state\")]\n public required string State { get; set; }\n\n /// Title of the referenced item.\n [JsonPropertyName(\"title\")]\n public required string Title { get; set; }\n\n /// URL to the referenced item on GitHub.\n [JsonPropertyName(\"url\")]\n public required string Url { get; set; }\n}\n\n/// Blob attachment with inline base64-encoded data.\n/// The blob variant of .\npublic partial class UserMessageAttachmentBlob : UserMessageAttachment\n{\n /// \n [JsonIgnore]\n public override string Type => \"blob\";\n\n /// Base64-encoded content.\n [Base64String]\n [JsonPropertyName(\"data\")]\n public required string Data { get; set; }\n\n /// User-facing display name for the attachment.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"displayName\")]\n public string? DisplayName { get; set; }\n\n /// MIME type of the inline data.\n [JsonPropertyName(\"mimeType\")]\n public required string MimeType { get; set; }\n}\n\n/// A user message attachment — a file, directory, code selection, blob, or GitHub reference.\n/// Polymorphic base type discriminated by type.\n[JsonPolymorphic(\n TypeDiscriminatorPropertyName = \"type\",\n UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)]\n[JsonDerivedType(typeof(UserMessageAttachmentFile), \"file\")]\n[JsonDerivedType(typeof(UserMessageAttachmentDirectory), \"directory\")]\n[JsonDerivedType(typeof(UserMessageAttachmentSelection), \"selection\")]\n[JsonDerivedType(typeof(UserMessageAttachmentGithubReference), \"github_reference\")]\n[JsonDerivedType(typeof(UserMessageAttachmentBlob), \"blob\")]\npublic partial class UserMessageAttachment\n{\n /// The type discriminator.\n [JsonPropertyName(\"type\")]\n public virtual string Type { get; set; } = string.Empty;\n}\n\n\n/// A tool invocation request from the assistant.\n/// Nested data type for AssistantMessageToolRequest.\npublic partial class AssistantMessageToolRequest\n{\n /// Arguments to pass to the tool, format depends on the tool.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"arguments\")]\n public object? Arguments { get; set; }\n\n /// Resolved intention summary describing what this specific call does.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"intentionSummary\")]\n public string? IntentionSummary { get; set; }\n\n /// Name of the MCP server hosting this tool, when the tool is an MCP tool.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"mcpServerName\")]\n public string? McpServerName { get; set; }\n\n /// Name of the tool being invoked.\n [JsonPropertyName(\"name\")]\n public required string Name { get; set; }\n\n /// Unique identifier for this tool call.\n [JsonPropertyName(\"toolCallId\")]\n public required string ToolCallId { get; set; }\n\n /// Human-readable display title for the tool.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolTitle\")]\n public string? ToolTitle { get; set; }\n\n /// Tool call type: \"function\" for standard tool calls, \"custom\" for grammar-based tool calls. Defaults to \"function\" when absent.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"type\")]\n public AssistantMessageToolRequestType? Type { get; set; }\n}\n\n/// Token usage detail for a single billing category.\n/// Nested data type for AssistantUsageCopilotUsageTokenDetail.\npublic partial class AssistantUsageCopilotUsageTokenDetail\n{\n /// Number of tokens in this billing batch.\n [JsonPropertyName(\"batchSize\")]\n public required double BatchSize { get; set; }\n\n /// Cost per batch of tokens.\n [JsonPropertyName(\"costPerBatch\")]\n public required double CostPerBatch { get; set; }\n\n /// Total token count for this entry.\n [JsonPropertyName(\"tokenCount\")]\n public required double TokenCount { get; set; }\n\n /// Token category (e.g., \"input\", \"output\").\n [JsonPropertyName(\"tokenType\")]\n public required string TokenType { get; set; }\n}\n\n/// Per-request cost and usage data from the CAPI copilot_usage response field.\n/// Nested data type for AssistantUsageCopilotUsage.\npublic partial class AssistantUsageCopilotUsage\n{\n /// Itemized token usage breakdown.\n [JsonPropertyName(\"tokenDetails\")]\n public required AssistantUsageCopilotUsageTokenDetail[] TokenDetails { get; set; }\n\n /// Total cost in nano-AI units for this request.\n [JsonPropertyName(\"totalNanoAiu\")]\n public required double TotalNanoAiu { get; set; }\n}\n\n/// Nested data type for AssistantUsageQuotaSnapshot.\npublic partial class AssistantUsageQuotaSnapshot\n{\n /// Total requests allowed by the entitlement.\n [JsonPropertyName(\"entitlementRequests\")]\n public required double EntitlementRequests { get; set; }\n\n /// Whether the user has an unlimited usage entitlement.\n [JsonPropertyName(\"isUnlimitedEntitlement\")]\n public required bool IsUnlimitedEntitlement { get; set; }\n\n /// Number of requests over the entitlement limit.\n [JsonPropertyName(\"overage\")]\n public required double Overage { get; set; }\n\n /// Whether overage is allowed when quota is exhausted.\n [JsonPropertyName(\"overageAllowedWithExhaustedQuota\")]\n public required bool OverageAllowedWithExhaustedQuota { get; set; }\n\n /// Percentage of quota remaining (0.0 to 1.0).\n [JsonPropertyName(\"remainingPercentage\")]\n public required double RemainingPercentage { get; set; }\n\n /// Date when the quota resets.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"resetDate\")]\n public DateTimeOffset? ResetDate { get; set; }\n\n /// Whether usage is still permitted after quota exhaustion.\n [JsonPropertyName(\"usageAllowedWithExhaustedQuota\")]\n public required bool UsageAllowedWithExhaustedQuota { get; set; }\n\n /// Number of requests already consumed.\n [JsonPropertyName(\"usedRequests\")]\n public required double UsedRequests { get; set; }\n}\n\n/// Error details when the tool execution failed.\n/// Nested data type for ToolExecutionCompleteError.\npublic partial class ToolExecutionCompleteError\n{\n /// Machine-readable error code.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"code\")]\n public string? Code { get; set; }\n\n /// Human-readable error message.\n [JsonPropertyName(\"message\")]\n public required string Message { get; set; }\n}\n\n/// Plain text content block.\n/// The text variant of .\npublic partial class ToolExecutionCompleteContentText : ToolExecutionCompleteContent\n{\n /// \n [JsonIgnore]\n public override string Type => \"text\";\n\n /// The text content.\n [JsonPropertyName(\"text\")]\n public required string Text { get; set; }\n}\n\n/// Terminal/shell output content block with optional exit code and working directory.\n/// The terminal variant of .\npublic partial class ToolExecutionCompleteContentTerminal : ToolExecutionCompleteContent\n{\n /// \n [JsonIgnore]\n public override string Type => \"terminal\";\n\n /// Working directory where the command was executed.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"cwd\")]\n public string? Cwd { get; set; }\n\n /// Process exit code, if the command has completed.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"exitCode\")]\n public double? ExitCode { get; set; }\n\n /// Terminal/shell output text.\n [JsonPropertyName(\"text\")]\n public required string Text { get; set; }\n}\n\n/// Image content block with base64-encoded data.\n/// The image variant of .\npublic partial class ToolExecutionCompleteContentImage : ToolExecutionCompleteContent\n{\n /// \n [JsonIgnore]\n public override string Type => \"image\";\n\n /// Base64-encoded image data.\n [Base64String]\n [JsonPropertyName(\"data\")]\n public required string Data { get; set; }\n\n /// MIME type of the image (e.g., image/png, image/jpeg).\n [JsonPropertyName(\"mimeType\")]\n public required string MimeType { get; set; }\n}\n\n/// Audio content block with base64-encoded data.\n/// The audio variant of .\npublic partial class ToolExecutionCompleteContentAudio : ToolExecutionCompleteContent\n{\n /// \n [JsonIgnore]\n public override string Type => \"audio\";\n\n /// Base64-encoded audio data.\n [Base64String]\n [JsonPropertyName(\"data\")]\n public required string Data { get; set; }\n\n /// MIME type of the audio (e.g., audio/wav, audio/mpeg).\n [JsonPropertyName(\"mimeType\")]\n public required string MimeType { get; set; }\n}\n\n/// Icon image for a resource.\n/// Nested data type for ToolExecutionCompleteContentResourceLinkIcon.\npublic partial class ToolExecutionCompleteContentResourceLinkIcon\n{\n /// MIME type of the icon image.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"mimeType\")]\n public string? MimeType { get; set; }\n\n /// Available icon sizes (e.g., ['16x16', '32x32']).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"sizes\")]\n public string[]? Sizes { get; set; }\n\n /// URL or path to the icon image.\n [JsonPropertyName(\"src\")]\n public required string Src { get; set; }\n\n /// Theme variant this icon is intended for.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"theme\")]\n public ToolExecutionCompleteContentResourceLinkIconTheme? Theme { get; set; }\n}\n\n/// Resource link content block referencing an external resource.\n/// The resource_link variant of .\npublic partial class ToolExecutionCompleteContentResourceLink : ToolExecutionCompleteContent\n{\n /// \n [JsonIgnore]\n public override string Type => \"resource_link\";\n\n /// Human-readable description of the resource.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"description\")]\n public string? Description { get; set; }\n\n /// Icons associated with this resource.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"icons\")]\n public ToolExecutionCompleteContentResourceLinkIcon[]? Icons { get; set; }\n\n /// MIME type of the resource content.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"mimeType\")]\n public string? MimeType { get; set; }\n\n /// Resource name identifier.\n [JsonPropertyName(\"name\")]\n public required string Name { get; set; }\n\n /// Size of the resource in bytes.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"size\")]\n public double? Size { get; set; }\n\n /// Human-readable display title for the resource.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"title\")]\n public string? Title { get; set; }\n\n /// URI identifying the resource.\n [JsonPropertyName(\"uri\")]\n public required string Uri { get; set; }\n}\n\n/// Embedded resource content block with inline text or binary data.\n/// The resource variant of .\npublic partial class ToolExecutionCompleteContentResource : ToolExecutionCompleteContent\n{\n /// \n [JsonIgnore]\n public override string Type => \"resource\";\n\n /// The embedded resource contents, either text or base64-encoded binary.\n [JsonPropertyName(\"resource\")]\n public required object Resource { get; set; }\n}\n\n/// A content block within a tool result, which may be text, terminal output, image, audio, or a resource.\n/// Polymorphic base type discriminated by type.\n[JsonPolymorphic(\n TypeDiscriminatorPropertyName = \"type\",\n UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)]\n[JsonDerivedType(typeof(ToolExecutionCompleteContentText), \"text\")]\n[JsonDerivedType(typeof(ToolExecutionCompleteContentTerminal), \"terminal\")]\n[JsonDerivedType(typeof(ToolExecutionCompleteContentImage), \"image\")]\n[JsonDerivedType(typeof(ToolExecutionCompleteContentAudio), \"audio\")]\n[JsonDerivedType(typeof(ToolExecutionCompleteContentResourceLink), \"resource_link\")]\n[JsonDerivedType(typeof(ToolExecutionCompleteContentResource), \"resource\")]\npublic partial class ToolExecutionCompleteContent\n{\n /// The type discriminator.\n [JsonPropertyName(\"type\")]\n public virtual string Type { get; set; } = string.Empty;\n}\n\n\n/// Tool execution result on success.\n/// Nested data type for ToolExecutionCompleteResult.\npublic partial class ToolExecutionCompleteResult\n{\n /// Concise tool result text sent to the LLM for chat completion, potentially truncated for token efficiency.\n [JsonPropertyName(\"content\")]\n public required string Content { get; set; }\n\n /// Structured content blocks (text, images, audio, resources) returned by the tool in their native format.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"contents\")]\n public ToolExecutionCompleteContent[]? Contents { get; set; }\n\n /// Full detailed tool result for UI/timeline display, preserving complete content such as diffs. Falls back to content when absent.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"detailedContent\")]\n public string? DetailedContent { get; set; }\n}\n\n/// Error details when the hook failed.\n/// Nested data type for HookEndError.\npublic partial class HookEndError\n{\n /// Human-readable error message.\n [JsonPropertyName(\"message\")]\n public required string Message { get; set; }\n\n /// Error stack trace, when available.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"stack\")]\n public string? Stack { get; set; }\n}\n\n/// Metadata about the prompt template and its construction.\n/// Nested data type for SystemMessageMetadata.\npublic partial class SystemMessageMetadata\n{\n /// Version identifier of the prompt template used.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"promptVersion\")]\n public string? PromptVersion { get; set; }\n\n /// Template variables used when constructing the prompt.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"variables\")]\n public IDictionary? Variables { get; set; }\n}\n\n/// The agent_completed variant of .\npublic partial class SystemNotificationAgentCompleted : SystemNotification\n{\n /// \n [JsonIgnore]\n public override string Type => \"agent_completed\";\n\n /// Unique identifier of the background agent.\n [JsonPropertyName(\"agentId\")]\n public required string AgentId { get; set; }\n\n /// Type of the agent (e.g., explore, task, general-purpose).\n [JsonPropertyName(\"agentType\")]\n public required string AgentType { get; set; }\n\n /// Human-readable description of the agent task.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"description\")]\n public string? Description { get; set; }\n\n /// The full prompt given to the background agent.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"prompt\")]\n public string? Prompt { get; set; }\n\n /// Whether the agent completed successfully or failed.\n [JsonPropertyName(\"status\")]\n public required SystemNotificationAgentCompletedStatus Status { get; set; }\n}\n\n/// The agent_idle variant of .\npublic partial class SystemNotificationAgentIdle : SystemNotification\n{\n /// \n [JsonIgnore]\n public override string Type => \"agent_idle\";\n\n /// Unique identifier of the background agent.\n [JsonPropertyName(\"agentId\")]\n public required string AgentId { get; set; }\n\n /// Type of the agent (e.g., explore, task, general-purpose).\n [JsonPropertyName(\"agentType\")]\n public required string AgentType { get; set; }\n\n /// Human-readable description of the agent task.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"description\")]\n public string? Description { get; set; }\n}\n\n/// The new_inbox_message variant of .\npublic partial class SystemNotificationNewInboxMessage : SystemNotification\n{\n /// \n [JsonIgnore]\n public override string Type => \"new_inbox_message\";\n\n /// Unique identifier of the inbox entry.\n [JsonPropertyName(\"entryId\")]\n public required string EntryId { get; set; }\n\n /// Human-readable name of the sender.\n [JsonPropertyName(\"senderName\")]\n public required string SenderName { get; set; }\n\n /// Category of the sender (e.g., sidekick-agent, plugin, hook).\n [JsonPropertyName(\"senderType\")]\n public required string SenderType { get; set; }\n\n /// Short summary shown before the agent decides whether to read the inbox.\n [JsonPropertyName(\"summary\")]\n public required string Summary { get; set; }\n}\n\n/// The shell_completed variant of .\npublic partial class SystemNotificationShellCompleted : SystemNotification\n{\n /// \n [JsonIgnore]\n public override string Type => \"shell_completed\";\n\n /// Human-readable description of the command.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"description\")]\n public string? Description { get; set; }\n\n /// Exit code of the shell command, if available.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"exitCode\")]\n public double? ExitCode { get; set; }\n\n /// Unique identifier of the shell session.\n [JsonPropertyName(\"shellId\")]\n public required string ShellId { get; set; }\n}\n\n/// The shell_detached_completed variant of .\npublic partial class SystemNotificationShellDetachedCompleted : SystemNotification\n{\n /// \n [JsonIgnore]\n public override string Type => \"shell_detached_completed\";\n\n /// Human-readable description of the command.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"description\")]\n public string? Description { get; set; }\n\n /// Unique identifier of the detached shell session.\n [JsonPropertyName(\"shellId\")]\n public required string ShellId { get; set; }\n}\n\n/// The instruction_discovered variant of .\npublic partial class SystemNotificationInstructionDiscovered : SystemNotification\n{\n /// \n [JsonIgnore]\n public override string Type => \"instruction_discovered\";\n\n /// Human-readable label for the timeline (e.g., 'AGENTS.md from packages/billing/').\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"description\")]\n public string? Description { get; set; }\n\n /// Relative path to the discovered instruction file.\n [JsonPropertyName(\"sourcePath\")]\n public required string SourcePath { get; set; }\n\n /// Path of the file access that triggered discovery.\n [JsonPropertyName(\"triggerFile\")]\n public required string TriggerFile { get; set; }\n\n /// Tool command that triggered discovery (currently always 'view').\n [JsonPropertyName(\"triggerTool\")]\n public required string TriggerTool { get; set; }\n}\n\n/// Structured metadata identifying what triggered this notification.\n/// Polymorphic base type discriminated by type.\n[JsonPolymorphic(\n TypeDiscriminatorPropertyName = \"type\",\n UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)]\n[JsonDerivedType(typeof(SystemNotificationAgentCompleted), \"agent_completed\")]\n[JsonDerivedType(typeof(SystemNotificationAgentIdle), \"agent_idle\")]\n[JsonDerivedType(typeof(SystemNotificationNewInboxMessage), \"new_inbox_message\")]\n[JsonDerivedType(typeof(SystemNotificationShellCompleted), \"shell_completed\")]\n[JsonDerivedType(typeof(SystemNotificationShellDetachedCompleted), \"shell_detached_completed\")]\n[JsonDerivedType(typeof(SystemNotificationInstructionDiscovered), \"instruction_discovered\")]\npublic partial class SystemNotification\n{\n /// The type discriminator.\n [JsonPropertyName(\"type\")]\n public virtual string Type { get; set; } = string.Empty;\n}\n\n\n/// Nested data type for PermissionRequestShellCommand.\npublic partial class PermissionRequestShellCommand\n{\n /// Command identifier (e.g., executable name).\n [JsonPropertyName(\"identifier\")]\n public required string Identifier { get; set; }\n\n /// Whether this command is read-only (no side effects).\n [JsonPropertyName(\"readOnly\")]\n public required bool ReadOnly { get; set; }\n}\n\n/// Nested data type for PermissionRequestShellPossibleUrl.\npublic partial class PermissionRequestShellPossibleUrl\n{\n /// URL that may be accessed by the command.\n [JsonPropertyName(\"url\")]\n public required string Url { get; set; }\n}\n\n/// Shell command permission request.\n/// The shell variant of .\npublic partial class PermissionRequestShell : PermissionRequest\n{\n /// \n [JsonIgnore]\n public override string Kind => \"shell\";\n\n /// Whether the UI can offer session-wide approval for this command pattern.\n [JsonPropertyName(\"canOfferSessionApproval\")]\n public required bool CanOfferSessionApproval { get; set; }\n\n /// Parsed command identifiers found in the command text.\n [JsonPropertyName(\"commands\")]\n public required PermissionRequestShellCommand[] Commands { get; set; }\n\n /// The complete shell command text to be executed.\n [JsonPropertyName(\"fullCommandText\")]\n public required string FullCommandText { get; set; }\n\n /// Whether the command includes a file write redirection (e.g., > or >>).\n [JsonPropertyName(\"hasWriteFileRedirection\")]\n public required bool HasWriteFileRedirection { get; set; }\n\n /// Human-readable description of what the command intends to do.\n [JsonPropertyName(\"intention\")]\n public required string Intention { get; set; }\n\n /// File paths that may be read or written by the command.\n [JsonPropertyName(\"possiblePaths\")]\n public required string[] PossiblePaths { get; set; }\n\n /// URLs that may be accessed by the command.\n [JsonPropertyName(\"possibleUrls\")]\n public required PermissionRequestShellPossibleUrl[] PossibleUrls { get; set; }\n\n /// Tool call ID that triggered this permission request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n\n /// Optional warning message about risks of running this command.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"warning\")]\n public string? Warning { get; set; }\n}\n\n/// File write permission request.\n/// The write variant of .\npublic partial class PermissionRequestWrite : PermissionRequest\n{\n /// \n [JsonIgnore]\n public override string Kind => \"write\";\n\n /// Whether the UI can offer session-wide approval for file write operations.\n [JsonPropertyName(\"canOfferSessionApproval\")]\n public required bool CanOfferSessionApproval { get; set; }\n\n /// Unified diff showing the proposed changes.\n [JsonPropertyName(\"diff\")]\n public required string Diff { get; set; }\n\n /// Path of the file being written to.\n [JsonPropertyName(\"fileName\")]\n public required string FileName { get; set; }\n\n /// Human-readable description of the intended file change.\n [JsonPropertyName(\"intention\")]\n public required string Intention { get; set; }\n\n /// Complete new file contents for newly created files.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"newFileContents\")]\n public string? NewFileContents { get; set; }\n\n /// Tool call ID that triggered this permission request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n}\n\n/// File or directory read permission request.\n/// The read variant of .\npublic partial class PermissionRequestRead : PermissionRequest\n{\n /// \n [JsonIgnore]\n public override string Kind => \"read\";\n\n /// Human-readable description of why the file is being read.\n [JsonPropertyName(\"intention\")]\n public required string Intention { get; set; }\n\n /// Path of the file or directory being read.\n [JsonPropertyName(\"path\")]\n public required string Path { get; set; }\n\n /// Tool call ID that triggered this permission request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n}\n\n/// MCP tool invocation permission request.\n/// The mcp variant of .\npublic partial class PermissionRequestMcp : PermissionRequest\n{\n /// \n [JsonIgnore]\n public override string Kind => \"mcp\";\n\n /// Arguments to pass to the MCP tool.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"args\")]\n public object? Args { get; set; }\n\n /// Whether this MCP tool is read-only (no side effects).\n [JsonPropertyName(\"readOnly\")]\n public required bool ReadOnly { get; set; }\n\n /// Name of the MCP server providing the tool.\n [JsonPropertyName(\"serverName\")]\n public required string ServerName { get; set; }\n\n /// Tool call ID that triggered this permission request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n\n /// Internal name of the MCP tool.\n [JsonPropertyName(\"toolName\")]\n public required string ToolName { get; set; }\n\n /// Human-readable title of the MCP tool.\n [JsonPropertyName(\"toolTitle\")]\n public required string ToolTitle { get; set; }\n}\n\n/// URL access permission request.\n/// The url variant of .\npublic partial class PermissionRequestUrl : PermissionRequest\n{\n /// \n [JsonIgnore]\n public override string Kind => \"url\";\n\n /// Human-readable description of why the URL is being accessed.\n [JsonPropertyName(\"intention\")]\n public required string Intention { get; set; }\n\n /// Tool call ID that triggered this permission request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n\n /// URL to be fetched.\n [JsonPropertyName(\"url\")]\n public required string Url { get; set; }\n}\n\n/// Memory operation permission request.\n/// The memory variant of .\npublic partial class PermissionRequestMemory : PermissionRequest\n{\n /// \n [JsonIgnore]\n public override string Kind => \"memory\";\n\n /// Whether this is a store or vote memory operation.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"action\")]\n public PermissionRequestMemoryAction? Action { get; set; }\n\n /// Source references for the stored fact (store only).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"citations\")]\n public string? Citations { get; set; }\n\n /// Vote direction (vote only).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"direction\")]\n public PermissionRequestMemoryDirection? Direction { get; set; }\n\n /// The fact being stored or voted on.\n [JsonPropertyName(\"fact\")]\n public required string Fact { get; set; }\n\n /// Reason for the vote (vote only).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"reason\")]\n public string? Reason { get; set; }\n\n /// Topic or subject of the memory (store only).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"subject\")]\n public string? Subject { get; set; }\n\n /// Tool call ID that triggered this permission request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n}\n\n/// Custom tool invocation permission request.\n/// The custom-tool variant of .\npublic partial class PermissionRequestCustomTool : PermissionRequest\n{\n /// \n [JsonIgnore]\n public override string Kind => \"custom-tool\";\n\n /// Arguments to pass to the custom tool.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"args\")]\n public object? Args { get; set; }\n\n /// Tool call ID that triggered this permission request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n\n /// Description of what the custom tool does.\n [JsonPropertyName(\"toolDescription\")]\n public required string ToolDescription { get; set; }\n\n /// Name of the custom tool.\n [JsonPropertyName(\"toolName\")]\n public required string ToolName { get; set; }\n}\n\n/// Hook confirmation permission request.\n/// The hook variant of .\npublic partial class PermissionRequestHook : PermissionRequest\n{\n /// \n [JsonIgnore]\n public override string Kind => \"hook\";\n\n /// Optional message from the hook explaining why confirmation is needed.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"hookMessage\")]\n public string? HookMessage { get; set; }\n\n /// Arguments of the tool call being gated.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolArgs\")]\n public object? ToolArgs { get; set; }\n\n /// Tool call ID that triggered this permission request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n\n /// Name of the tool the hook is gating.\n [JsonPropertyName(\"toolName\")]\n public required string ToolName { get; set; }\n}\n\n/// Details of the permission being requested.\n/// Polymorphic base type discriminated by kind.\n[JsonPolymorphic(\n TypeDiscriminatorPropertyName = \"kind\",\n UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)]\n[JsonDerivedType(typeof(PermissionRequestShell), \"shell\")]\n[JsonDerivedType(typeof(PermissionRequestWrite), \"write\")]\n[JsonDerivedType(typeof(PermissionRequestRead), \"read\")]\n[JsonDerivedType(typeof(PermissionRequestMcp), \"mcp\")]\n[JsonDerivedType(typeof(PermissionRequestUrl), \"url\")]\n[JsonDerivedType(typeof(PermissionRequestMemory), \"memory\")]\n[JsonDerivedType(typeof(PermissionRequestCustomTool), \"custom-tool\")]\n[JsonDerivedType(typeof(PermissionRequestHook), \"hook\")]\npublic partial class PermissionRequest\n{\n /// The type discriminator.\n [JsonPropertyName(\"kind\")]\n public virtual string Kind { get; set; } = string.Empty;\n}\n\n\n/// Shell command permission prompt.\n/// The commands variant of .\npublic partial class PermissionPromptRequestCommands : PermissionPromptRequest\n{\n /// \n [JsonIgnore]\n public override string Kind => \"commands\";\n\n /// Whether the UI can offer session-wide approval for this command pattern.\n [JsonPropertyName(\"canOfferSessionApproval\")]\n public required bool CanOfferSessionApproval { get; set; }\n\n /// Command identifiers covered by this approval prompt.\n [JsonPropertyName(\"commandIdentifiers\")]\n public required string[] CommandIdentifiers { get; set; }\n\n /// The complete shell command text to be executed.\n [JsonPropertyName(\"fullCommandText\")]\n public required string FullCommandText { get; set; }\n\n /// Human-readable description of what the command intends to do.\n [JsonPropertyName(\"intention\")]\n public required string Intention { get; set; }\n\n /// Tool call ID that triggered this permission request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n\n /// Optional warning message about risks of running this command.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"warning\")]\n public string? Warning { get; set; }\n}\n\n/// File write permission prompt.\n/// The write variant of .\npublic partial class PermissionPromptRequestWrite : PermissionPromptRequest\n{\n /// \n [JsonIgnore]\n public override string Kind => \"write\";\n\n /// Whether the UI can offer session-wide approval for file write operations.\n [JsonPropertyName(\"canOfferSessionApproval\")]\n public required bool CanOfferSessionApproval { get; set; }\n\n /// Unified diff showing the proposed changes.\n [JsonPropertyName(\"diff\")]\n public required string Diff { get; set; }\n\n /// Path of the file being written to.\n [JsonPropertyName(\"fileName\")]\n public required string FileName { get; set; }\n\n /// Human-readable description of the intended file change.\n [JsonPropertyName(\"intention\")]\n public required string Intention { get; set; }\n\n /// Complete new file contents for newly created files.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"newFileContents\")]\n public string? NewFileContents { get; set; }\n\n /// Tool call ID that triggered this permission request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n}\n\n/// File read permission prompt.\n/// The read variant of .\npublic partial class PermissionPromptRequestRead : PermissionPromptRequest\n{\n /// \n [JsonIgnore]\n public override string Kind => \"read\";\n\n /// Human-readable description of why the file is being read.\n [JsonPropertyName(\"intention\")]\n public required string Intention { get; set; }\n\n /// Path of the file or directory being read.\n [JsonPropertyName(\"path\")]\n public required string Path { get; set; }\n\n /// Tool call ID that triggered this permission request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n}\n\n/// MCP tool invocation permission prompt.\n/// The mcp variant of .\npublic partial class PermissionPromptRequestMcp : PermissionPromptRequest\n{\n /// \n [JsonIgnore]\n public override string Kind => \"mcp\";\n\n /// Arguments to pass to the MCP tool.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"args\")]\n public object? Args { get; set; }\n\n /// Name of the MCP server providing the tool.\n [JsonPropertyName(\"serverName\")]\n public required string ServerName { get; set; }\n\n /// Tool call ID that triggered this permission request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n\n /// Internal name of the MCP tool.\n [JsonPropertyName(\"toolName\")]\n public required string ToolName { get; set; }\n\n /// Human-readable title of the MCP tool.\n [JsonPropertyName(\"toolTitle\")]\n public required string ToolTitle { get; set; }\n}\n\n/// URL access permission prompt.\n/// The url variant of .\npublic partial class PermissionPromptRequestUrl : PermissionPromptRequest\n{\n /// \n [JsonIgnore]\n public override string Kind => \"url\";\n\n /// Human-readable description of why the URL is being accessed.\n [JsonPropertyName(\"intention\")]\n public required string Intention { get; set; }\n\n /// Tool call ID that triggered this permission request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n\n /// URL to be fetched.\n [JsonPropertyName(\"url\")]\n public required string Url { get; set; }\n}\n\n/// Memory operation permission prompt.\n/// The memory variant of .\npublic partial class PermissionPromptRequestMemory : PermissionPromptRequest\n{\n /// \n [JsonIgnore]\n public override string Kind => \"memory\";\n\n /// Whether this is a store or vote memory operation.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"action\")]\n public PermissionPromptRequestMemoryAction? Action { get; set; }\n\n /// Source references for the stored fact (store only).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"citations\")]\n public string? Citations { get; set; }\n\n /// Vote direction (vote only).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"direction\")]\n public PermissionPromptRequestMemoryDirection? Direction { get; set; }\n\n /// The fact being stored or voted on.\n [JsonPropertyName(\"fact\")]\n public required string Fact { get; set; }\n\n /// Reason for the vote (vote only).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"reason\")]\n public string? Reason { get; set; }\n\n /// Topic or subject of the memory (store only).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"subject\")]\n public string? Subject { get; set; }\n\n /// Tool call ID that triggered this permission request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n}\n\n/// Custom tool invocation permission prompt.\n/// The custom-tool variant of .\npublic partial class PermissionPromptRequestCustomTool : PermissionPromptRequest\n{\n /// \n [JsonIgnore]\n public override string Kind => \"custom-tool\";\n\n /// Arguments to pass to the custom tool.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"args\")]\n public object? Args { get; set; }\n\n /// Tool call ID that triggered this permission request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n\n /// Description of what the custom tool does.\n [JsonPropertyName(\"toolDescription\")]\n public required string ToolDescription { get; set; }\n\n /// Name of the custom tool.\n [JsonPropertyName(\"toolName\")]\n public required string ToolName { get; set; }\n}\n\n/// Path access permission prompt.\n/// The path variant of .\npublic partial class PermissionPromptRequestPath : PermissionPromptRequest\n{\n /// \n [JsonIgnore]\n public override string Kind => \"path\";\n\n /// Underlying permission kind that needs path approval.\n [JsonPropertyName(\"accessKind\")]\n public required PermissionPromptRequestPathAccessKind AccessKind { get; set; }\n\n /// File paths that require explicit approval.\n [JsonPropertyName(\"paths\")]\n public required string[] Paths { get; set; }\n\n /// Tool call ID that triggered this permission request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n}\n\n/// Hook confirmation permission prompt.\n/// The hook variant of .\npublic partial class PermissionPromptRequestHook : PermissionPromptRequest\n{\n /// \n [JsonIgnore]\n public override string Kind => \"hook\";\n\n /// Optional message from the hook explaining why confirmation is needed.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"hookMessage\")]\n public string? HookMessage { get; set; }\n\n /// Arguments of the tool call being gated.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolArgs\")]\n public object? ToolArgs { get; set; }\n\n /// Tool call ID that triggered this permission request.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"toolCallId\")]\n public string? ToolCallId { get; set; }\n\n /// Name of the tool the hook is gating.\n [JsonPropertyName(\"toolName\")]\n public required string ToolName { get; set; }\n}\n\n/// Derived user-facing permission prompt details for UI consumers.\n/// Polymorphic base type discriminated by kind.\n[JsonPolymorphic(\n TypeDiscriminatorPropertyName = \"kind\",\n UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)]\n[JsonDerivedType(typeof(PermissionPromptRequestCommands), \"commands\")]\n[JsonDerivedType(typeof(PermissionPromptRequestWrite), \"write\")]\n[JsonDerivedType(typeof(PermissionPromptRequestRead), \"read\")]\n[JsonDerivedType(typeof(PermissionPromptRequestMcp), \"mcp\")]\n[JsonDerivedType(typeof(PermissionPromptRequestUrl), \"url\")]\n[JsonDerivedType(typeof(PermissionPromptRequestMemory), \"memory\")]\n[JsonDerivedType(typeof(PermissionPromptRequestCustomTool), \"custom-tool\")]\n[JsonDerivedType(typeof(PermissionPromptRequestPath), \"path\")]\n[JsonDerivedType(typeof(PermissionPromptRequestHook), \"hook\")]\npublic partial class PermissionPromptRequest\n{\n /// The type discriminator.\n [JsonPropertyName(\"kind\")]\n public virtual string Kind { get; set; } = string.Empty;\n}\n\n\n/// The approved variant of .\npublic partial class PermissionResultApproved : PermissionResult\n{\n /// \n [JsonIgnore]\n public override string Kind => \"approved\";\n}\n\n/// The commands variant of .\npublic partial class UserToolSessionApprovalCommands : UserToolSessionApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"commands\";\n\n /// Command identifiers approved by the user.\n [JsonPropertyName(\"commandIdentifiers\")]\n public required string[] CommandIdentifiers { get; set; }\n}\n\n/// The read variant of .\npublic partial class UserToolSessionApprovalRead : UserToolSessionApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"read\";\n}\n\n/// The write variant of .\npublic partial class UserToolSessionApprovalWrite : UserToolSessionApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"write\";\n}\n\n/// The mcp variant of .\npublic partial class UserToolSessionApprovalMcp : UserToolSessionApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"mcp\";\n\n /// MCP server name.\n [JsonPropertyName(\"serverName\")]\n public required string ServerName { get; set; }\n\n /// Optional MCP tool name, or null for all tools on the server.\n [JsonPropertyName(\"toolName\")]\n public string? ToolName { get; set; }\n}\n\n/// The memory variant of .\npublic partial class UserToolSessionApprovalMemory : UserToolSessionApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"memory\";\n}\n\n/// The custom-tool variant of .\npublic partial class UserToolSessionApprovalCustomTool : UserToolSessionApproval\n{\n /// \n [JsonIgnore]\n public override string Kind => \"custom-tool\";\n\n /// Custom tool name.\n [JsonPropertyName(\"toolName\")]\n public required string ToolName { get; set; }\n}\n\n/// The approval to add as a session-scoped rule.\n/// Polymorphic base type discriminated by kind.\n[JsonPolymorphic(\n TypeDiscriminatorPropertyName = \"kind\",\n UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)]\n[JsonDerivedType(typeof(UserToolSessionApprovalCommands), \"commands\")]\n[JsonDerivedType(typeof(UserToolSessionApprovalRead), \"read\")]\n[JsonDerivedType(typeof(UserToolSessionApprovalWrite), \"write\")]\n[JsonDerivedType(typeof(UserToolSessionApprovalMcp), \"mcp\")]\n[JsonDerivedType(typeof(UserToolSessionApprovalMemory), \"memory\")]\n[JsonDerivedType(typeof(UserToolSessionApprovalCustomTool), \"custom-tool\")]\npublic partial class UserToolSessionApproval\n{\n /// The type discriminator.\n [JsonPropertyName(\"kind\")]\n public virtual string Kind { get; set; } = string.Empty;\n}\n\n\n/// The approved-for-session variant of .\npublic partial class PermissionResultApprovedForSession : PermissionResult\n{\n /// \n [JsonIgnore]\n public override string Kind => \"approved-for-session\";\n\n /// The approval to add as a session-scoped rule.\n [JsonPropertyName(\"approval\")]\n public required UserToolSessionApproval Approval { get; set; }\n}\n\n/// The approved-for-location variant of .\npublic partial class PermissionResultApprovedForLocation : PermissionResult\n{\n /// \n [JsonIgnore]\n public override string Kind => \"approved-for-location\";\n\n /// The approval to persist for this location.\n [JsonPropertyName(\"approval\")]\n public required UserToolSessionApproval Approval { get; set; }\n\n /// The location key (git root or cwd) to persist the approval to.\n [JsonPropertyName(\"locationKey\")]\n public required string LocationKey { get; set; }\n}\n\n/// The cancelled variant of .\npublic partial class PermissionResultCancelled : PermissionResult\n{\n /// \n [JsonIgnore]\n public override string Kind => \"cancelled\";\n\n /// Optional explanation of why the request was cancelled.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"reason\")]\n public string? Reason { get; set; }\n}\n\n/// Nested data type for PermissionRule.\npublic partial class PermissionRule\n{\n /// Optional rule argument matched against the request.\n [JsonPropertyName(\"argument\")]\n public string? Argument { get; set; }\n\n /// The rule kind, such as Shell or GitHubMCP.\n [JsonPropertyName(\"kind\")]\n public required string Kind { get; set; }\n}\n\n/// The denied-by-rules variant of .\npublic partial class PermissionResultDeniedByRules : PermissionResult\n{\n /// \n [JsonIgnore]\n public override string Kind => \"denied-by-rules\";\n\n /// Rules that denied the request.\n [JsonPropertyName(\"rules\")]\n public required PermissionRule[] Rules { get; set; }\n}\n\n/// The denied-no-approval-rule-and-could-not-request-from-user variant of .\npublic partial class PermissionResultDeniedNoApprovalRuleAndCouldNotRequestFromUser : PermissionResult\n{\n /// \n [JsonIgnore]\n public override string Kind => \"denied-no-approval-rule-and-could-not-request-from-user\";\n}\n\n/// The denied-interactively-by-user variant of .\npublic partial class PermissionResultDeniedInteractivelyByUser : PermissionResult\n{\n /// \n [JsonIgnore]\n public override string Kind => \"denied-interactively-by-user\";\n\n /// Optional feedback from the user explaining the denial.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"feedback\")]\n public string? Feedback { get; set; }\n\n /// Whether to force-reject the current agent turn.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"forceReject\")]\n public bool? ForceReject { get; set; }\n}\n\n/// The denied-by-content-exclusion-policy variant of .\npublic partial class PermissionResultDeniedByContentExclusionPolicy : PermissionResult\n{\n /// \n [JsonIgnore]\n public override string Kind => \"denied-by-content-exclusion-policy\";\n\n /// Human-readable explanation of why the path was excluded.\n [JsonPropertyName(\"message\")]\n public required string Message { get; set; }\n\n /// File path that triggered the exclusion.\n [JsonPropertyName(\"path\")]\n public required string Path { get; set; }\n}\n\n/// The denied-by-permission-request-hook variant of .\npublic partial class PermissionResultDeniedByPermissionRequestHook : PermissionResult\n{\n /// \n [JsonIgnore]\n public override string Kind => \"denied-by-permission-request-hook\";\n\n /// Whether to interrupt the current agent turn.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"interrupt\")]\n public bool? Interrupt { get; set; }\n\n /// Optional message from the hook explaining the denial.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"message\")]\n public string? Message { get; set; }\n}\n\n/// The result of the permission request.\n/// Polymorphic base type discriminated by kind.\n[JsonPolymorphic(\n TypeDiscriminatorPropertyName = \"kind\",\n UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)]\n[JsonDerivedType(typeof(PermissionResultApproved), \"approved\")]\n[JsonDerivedType(typeof(PermissionResultApprovedForSession), \"approved-for-session\")]\n[JsonDerivedType(typeof(PermissionResultApprovedForLocation), \"approved-for-location\")]\n[JsonDerivedType(typeof(PermissionResultCancelled), \"cancelled\")]\n[JsonDerivedType(typeof(PermissionResultDeniedByRules), \"denied-by-rules\")]\n[JsonDerivedType(typeof(PermissionResultDeniedNoApprovalRuleAndCouldNotRequestFromUser), \"denied-no-approval-rule-and-could-not-request-from-user\")]\n[JsonDerivedType(typeof(PermissionResultDeniedInteractivelyByUser), \"denied-interactively-by-user\")]\n[JsonDerivedType(typeof(PermissionResultDeniedByContentExclusionPolicy), \"denied-by-content-exclusion-policy\")]\n[JsonDerivedType(typeof(PermissionResultDeniedByPermissionRequestHook), \"denied-by-permission-request-hook\")]\npublic partial class PermissionResult\n{\n /// The type discriminator.\n [JsonPropertyName(\"kind\")]\n public virtual string Kind { get; set; } = string.Empty;\n}\n\n\n/// JSON Schema describing the form fields to present to the user (form mode only).\n/// Nested data type for ElicitationRequestedSchema.\npublic partial class ElicitationRequestedSchema\n{\n /// Form field definitions, keyed by field name.\n [JsonPropertyName(\"properties\")]\n public required IDictionary Properties { get; set; }\n\n /// List of required field names.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"required\")]\n public string[]? Required { get; set; }\n\n /// Schema type indicator (always 'object').\n [JsonPropertyName(\"type\")]\n public required string Type { get; set; }\n}\n\n/// Static OAuth client configuration, if the server specifies one.\n/// Nested data type for McpOauthRequiredStaticClientConfig.\npublic partial class McpOauthRequiredStaticClientConfig\n{\n /// OAuth client ID for the server.\n [JsonPropertyName(\"clientId\")]\n public required string ClientId { get; set; }\n\n /// Optional non-default OAuth grant type. When set to 'client_credentials', the OAuth flow runs headlessly using the client_id + keychain-stored secret (no browser, no callback server).\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"grantType\")]\n public string? GrantType { get; set; }\n\n /// Whether this is a public OAuth client.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"publicClient\")]\n public bool? PublicClient { get; set; }\n}\n\n/// Nested data type for CommandsChangedCommand.\npublic partial class CommandsChangedCommand\n{\n /// Gets or sets the description value.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"description\")]\n public string? Description { get; set; }\n\n /// Gets or sets the name value.\n [JsonPropertyName(\"name\")]\n public required string Name { get; set; }\n}\n\n/// UI capability changes.\n/// Nested data type for CapabilitiesChangedUI.\npublic partial class CapabilitiesChangedUI\n{\n /// Whether elicitation is now supported.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"elicitation\")]\n public bool? Elicitation { get; set; }\n}\n\n/// Nested data type for SkillsLoadedSkill.\npublic partial class SkillsLoadedSkill\n{\n /// Description of what the skill does.\n [JsonPropertyName(\"description\")]\n public required string Description { get; set; }\n\n /// Whether the skill is currently enabled.\n [JsonPropertyName(\"enabled\")]\n public required bool Enabled { get; set; }\n\n /// Unique identifier for the skill.\n [JsonPropertyName(\"name\")]\n public required string Name { get; set; }\n\n /// Absolute path to the skill file, if available.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"path\")]\n public string? Path { get; set; }\n\n /// Source location type of the skill (e.g., project, personal, plugin).\n [JsonPropertyName(\"source\")]\n public required string Source { get; set; }\n\n /// Whether the skill can be invoked by the user as a slash command.\n [JsonPropertyName(\"userInvocable\")]\n public required bool UserInvocable { get; set; }\n}\n\n/// Nested data type for CustomAgentsUpdatedAgent.\npublic partial class CustomAgentsUpdatedAgent\n{\n /// Description of what the agent does.\n [JsonPropertyName(\"description\")]\n public required string Description { get; set; }\n\n /// Human-readable display name.\n [JsonPropertyName(\"displayName\")]\n public required string DisplayName { get; set; }\n\n /// Unique identifier for the agent.\n [JsonPropertyName(\"id\")]\n public required string Id { get; set; }\n\n /// Model override for this agent, if set.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"model\")]\n public string? Model { get; set; }\n\n /// Internal name of the agent.\n [JsonPropertyName(\"name\")]\n public required string Name { get; set; }\n\n /// Source location: user, project, inherited, remote, or plugin.\n [JsonPropertyName(\"source\")]\n public required string Source { get; set; }\n\n /// List of tool names available to this agent.\n [JsonPropertyName(\"tools\")]\n public required string[] Tools { get; set; }\n\n /// Whether the agent can be selected by the user.\n [JsonPropertyName(\"userInvocable\")]\n public required bool UserInvocable { get; set; }\n}\n\n/// Nested data type for McpServersLoadedServer.\npublic partial class McpServersLoadedServer\n{\n /// Error message if the server failed to connect.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"error\")]\n public string? Error { get; set; }\n\n /// Server name (config key).\n [JsonPropertyName(\"name\")]\n public required string Name { get; set; }\n\n /// Configuration source: user, workspace, plugin, or builtin.\n [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonPropertyName(\"source\")]\n public string? Source { get; set; }\n\n /// Connection status: connected, failed, needs-auth, pending, disabled, or not_configured.\n [JsonPropertyName(\"status\")]\n public required McpServersLoadedServerStatus Status { get; set; }\n}\n\n/// Nested data type for ExtensionsLoadedExtension.\npublic partial class ExtensionsLoadedExtension\n{\n /// Source-qualified extension ID (e.g., 'project:my-ext', 'user:auth-helper').\n [JsonPropertyName(\"id\")]\n public required string Id { get; set; }\n\n /// Extension name (directory name).\n [JsonPropertyName(\"name\")]\n public required string Name { get; set; }\n\n /// Discovery source.\n [JsonPropertyName(\"source\")]\n public required ExtensionsLoadedExtensionSource Source { get; set; }\n\n /// Current status: running, disabled, failed, or starting.\n [JsonPropertyName(\"status\")]\n public required ExtensionsLoadedExtensionStatus Status { get; set; }\n}\n\n/// Hosting platform type of the repository (github or ado).\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum WorkingDirectoryContextHostType\n{\n /// The github variant.\n [JsonStringEnumMemberName(\"github\")]\n Github,\n /// The ado variant.\n [JsonStringEnumMemberName(\"ado\")]\n Ado,\n}\n\n/// The type of operation performed on the plan file.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum PlanChangedOperation\n{\n /// The create variant.\n [JsonStringEnumMemberName(\"create\")]\n Create,\n /// The update variant.\n [JsonStringEnumMemberName(\"update\")]\n Update,\n /// The delete variant.\n [JsonStringEnumMemberName(\"delete\")]\n Delete,\n}\n\n/// Whether the file was newly created or updated.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum WorkspaceFileChangedOperation\n{\n /// The create variant.\n [JsonStringEnumMemberName(\"create\")]\n Create,\n /// The update variant.\n [JsonStringEnumMemberName(\"update\")]\n Update,\n}\n\n/// Origin type of the session being handed off.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum HandoffSourceType\n{\n /// The remote variant.\n [JsonStringEnumMemberName(\"remote\")]\n Remote,\n /// The local variant.\n [JsonStringEnumMemberName(\"local\")]\n Local,\n}\n\n/// Whether the session ended normally (\"routine\") or due to a crash/fatal error (\"error\").\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum ShutdownType\n{\n /// The routine variant.\n [JsonStringEnumMemberName(\"routine\")]\n Routine,\n /// The error variant.\n [JsonStringEnumMemberName(\"error\")]\n Error,\n}\n\n/// The agent mode that was active when this message was sent.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum UserMessageAgentMode\n{\n /// The interactive variant.\n [JsonStringEnumMemberName(\"interactive\")]\n Interactive,\n /// The plan variant.\n [JsonStringEnumMemberName(\"plan\")]\n Plan,\n /// The autopilot variant.\n [JsonStringEnumMemberName(\"autopilot\")]\n Autopilot,\n /// The shell variant.\n [JsonStringEnumMemberName(\"shell\")]\n Shell,\n}\n\n/// Type of GitHub reference.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum UserMessageAttachmentGithubReferenceType\n{\n /// The issue variant.\n [JsonStringEnumMemberName(\"issue\")]\n Issue,\n /// The pr variant.\n [JsonStringEnumMemberName(\"pr\")]\n Pr,\n /// The discussion variant.\n [JsonStringEnumMemberName(\"discussion\")]\n Discussion,\n}\n\n/// Tool call type: \"function\" for standard tool calls, \"custom\" for grammar-based tool calls. Defaults to \"function\" when absent.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum AssistantMessageToolRequestType\n{\n /// The function variant.\n [JsonStringEnumMemberName(\"function\")]\n Function,\n /// The custom variant.\n [JsonStringEnumMemberName(\"custom\")]\n Custom,\n}\n\n/// Where the failed model call originated.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum ModelCallFailureSource\n{\n /// The top_level variant.\n [JsonStringEnumMemberName(\"top_level\")]\n TopLevel,\n /// The subagent variant.\n [JsonStringEnumMemberName(\"subagent\")]\n Subagent,\n /// The mcp_sampling variant.\n [JsonStringEnumMemberName(\"mcp_sampling\")]\n McpSampling,\n}\n\n/// Theme variant this icon is intended for.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum ToolExecutionCompleteContentResourceLinkIconTheme\n{\n /// The light variant.\n [JsonStringEnumMemberName(\"light\")]\n Light,\n /// The dark variant.\n [JsonStringEnumMemberName(\"dark\")]\n Dark,\n}\n\n/// Message role: \"system\" for system prompts, \"developer\" for developer-injected instructions.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum SystemMessageRole\n{\n /// The system variant.\n [JsonStringEnumMemberName(\"system\")]\n System,\n /// The developer variant.\n [JsonStringEnumMemberName(\"developer\")]\n Developer,\n}\n\n/// Whether the agent completed successfully or failed.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum SystemNotificationAgentCompletedStatus\n{\n /// The completed variant.\n [JsonStringEnumMemberName(\"completed\")]\n Completed,\n /// The failed variant.\n [JsonStringEnumMemberName(\"failed\")]\n Failed,\n}\n\n/// Whether this is a store or vote memory operation.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum PermissionRequestMemoryAction\n{\n /// The store variant.\n [JsonStringEnumMemberName(\"store\")]\n Store,\n /// The vote variant.\n [JsonStringEnumMemberName(\"vote\")]\n Vote,\n}\n\n/// Vote direction (vote only).\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum PermissionRequestMemoryDirection\n{\n /// The upvote variant.\n [JsonStringEnumMemberName(\"upvote\")]\n Upvote,\n /// The downvote variant.\n [JsonStringEnumMemberName(\"downvote\")]\n Downvote,\n}\n\n/// Whether this is a store or vote memory operation.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum PermissionPromptRequestMemoryAction\n{\n /// The store variant.\n [JsonStringEnumMemberName(\"store\")]\n Store,\n /// The vote variant.\n [JsonStringEnumMemberName(\"vote\")]\n Vote,\n}\n\n/// Vote direction (vote only).\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum PermissionPromptRequestMemoryDirection\n{\n /// The upvote variant.\n [JsonStringEnumMemberName(\"upvote\")]\n Upvote,\n /// The downvote variant.\n [JsonStringEnumMemberName(\"downvote\")]\n Downvote,\n}\n\n/// Underlying permission kind that needs path approval.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum PermissionPromptRequestPathAccessKind\n{\n /// The read variant.\n [JsonStringEnumMemberName(\"read\")]\n Read,\n /// The shell variant.\n [JsonStringEnumMemberName(\"shell\")]\n Shell,\n /// The write variant.\n [JsonStringEnumMemberName(\"write\")]\n Write,\n}\n\n/// Elicitation mode; \"form\" for structured input, \"url\" for browser-based. Defaults to \"form\" when absent.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum ElicitationRequestedMode\n{\n /// The form variant.\n [JsonStringEnumMemberName(\"form\")]\n Form,\n /// The url variant.\n [JsonStringEnumMemberName(\"url\")]\n Url,\n}\n\n/// The user action: \"accept\" (submitted form), \"decline\" (explicitly refused), or \"cancel\" (dismissed).\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum ElicitationCompletedAction\n{\n /// The accept variant.\n [JsonStringEnumMemberName(\"accept\")]\n Accept,\n /// The decline variant.\n [JsonStringEnumMemberName(\"decline\")]\n Decline,\n /// The cancel variant.\n [JsonStringEnumMemberName(\"cancel\")]\n Cancel,\n}\n\n/// Connection status: connected, failed, needs-auth, pending, disabled, or not_configured.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum McpServersLoadedServerStatus\n{\n /// The connected variant.\n [JsonStringEnumMemberName(\"connected\")]\n Connected,\n /// The failed variant.\n [JsonStringEnumMemberName(\"failed\")]\n Failed,\n /// The needs-auth variant.\n [JsonStringEnumMemberName(\"needs-auth\")]\n NeedsAuth,\n /// The pending variant.\n [JsonStringEnumMemberName(\"pending\")]\n Pending,\n /// The disabled variant.\n [JsonStringEnumMemberName(\"disabled\")]\n Disabled,\n /// The not_configured variant.\n [JsonStringEnumMemberName(\"not_configured\")]\n NotConfigured,\n}\n\n/// New connection status: connected, failed, needs-auth, pending, disabled, or not_configured.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum McpServerStatusChangedStatus\n{\n /// The connected variant.\n [JsonStringEnumMemberName(\"connected\")]\n Connected,\n /// The failed variant.\n [JsonStringEnumMemberName(\"failed\")]\n Failed,\n /// The needs-auth variant.\n [JsonStringEnumMemberName(\"needs-auth\")]\n NeedsAuth,\n /// The pending variant.\n [JsonStringEnumMemberName(\"pending\")]\n Pending,\n /// The disabled variant.\n [JsonStringEnumMemberName(\"disabled\")]\n Disabled,\n /// The not_configured variant.\n [JsonStringEnumMemberName(\"not_configured\")]\n NotConfigured,\n}\n\n/// Discovery source.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum ExtensionsLoadedExtensionSource\n{\n /// The project variant.\n [JsonStringEnumMemberName(\"project\")]\n Project,\n /// The user variant.\n [JsonStringEnumMemberName(\"user\")]\n User,\n}\n\n/// Current status: running, disabled, failed, or starting.\n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum ExtensionsLoadedExtensionStatus\n{\n /// The running variant.\n [JsonStringEnumMemberName(\"running\")]\n Running,\n /// The disabled variant.\n [JsonStringEnumMemberName(\"disabled\")]\n Disabled,\n /// The failed variant.\n [JsonStringEnumMemberName(\"failed\")]\n Failed,\n /// The starting variant.\n [JsonStringEnumMemberName(\"starting\")]\n Starting,\n}\n\n[JsonSourceGenerationOptions(\n JsonSerializerDefaults.Web,\n AllowOutOfOrderMetadataProperties = true,\n NumberHandling = JsonNumberHandling.AllowReadingFromString,\n DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)]\n[JsonSerializable(typeof(AbortData))]\n[JsonSerializable(typeof(AbortEvent))]\n[JsonSerializable(typeof(AssistantIntentData))]\n[JsonSerializable(typeof(AssistantIntentEvent))]\n[JsonSerializable(typeof(AssistantMessageData))]\n[JsonSerializable(typeof(AssistantMessageDeltaData))]\n[JsonSerializable(typeof(AssistantMessageDeltaEvent))]\n[JsonSerializable(typeof(AssistantMessageEvent))]\n[JsonSerializable(typeof(AssistantMessageStartData))]\n[JsonSerializable(typeof(AssistantMessageStartEvent))]\n[JsonSerializable(typeof(AssistantMessageToolRequest))]\n[JsonSerializable(typeof(AssistantReasoningData))]\n[JsonSerializable(typeof(AssistantReasoningDeltaData))]\n[JsonSerializable(typeof(AssistantReasoningDeltaEvent))]\n[JsonSerializable(typeof(AssistantReasoningEvent))]\n[JsonSerializable(typeof(AssistantStreamingDeltaData))]\n[JsonSerializable(typeof(AssistantStreamingDeltaEvent))]\n[JsonSerializable(typeof(AssistantTurnEndData))]\n[JsonSerializable(typeof(AssistantTurnEndEvent))]\n[JsonSerializable(typeof(AssistantTurnStartData))]\n[JsonSerializable(typeof(AssistantTurnStartEvent))]\n[JsonSerializable(typeof(AssistantUsageCopilotUsage))]\n[JsonSerializable(typeof(AssistantUsageCopilotUsageTokenDetail))]\n[JsonSerializable(typeof(AssistantUsageData))]\n[JsonSerializable(typeof(AssistantUsageEvent))]\n[JsonSerializable(typeof(AssistantUsageQuotaSnapshot))]\n[JsonSerializable(typeof(AutoModeSwitchCompletedData))]\n[JsonSerializable(typeof(AutoModeSwitchCompletedEvent))]\n[JsonSerializable(typeof(AutoModeSwitchRequestedData))]\n[JsonSerializable(typeof(AutoModeSwitchRequestedEvent))]\n[JsonSerializable(typeof(CapabilitiesChangedData))]\n[JsonSerializable(typeof(CapabilitiesChangedEvent))]\n[JsonSerializable(typeof(CapabilitiesChangedUI))]\n[JsonSerializable(typeof(CommandCompletedData))]\n[JsonSerializable(typeof(CommandCompletedEvent))]\n[JsonSerializable(typeof(CommandExecuteData))]\n[JsonSerializable(typeof(CommandExecuteEvent))]\n[JsonSerializable(typeof(CommandQueuedData))]\n[JsonSerializable(typeof(CommandQueuedEvent))]\n[JsonSerializable(typeof(CommandsChangedCommand))]\n[JsonSerializable(typeof(CommandsChangedData))]\n[JsonSerializable(typeof(CommandsChangedEvent))]\n[JsonSerializable(typeof(CompactionCompleteCompactionTokensUsed))]\n[JsonSerializable(typeof(CompactionCompleteCompactionTokensUsedCopilotUsage))]\n[JsonSerializable(typeof(CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail))]\n[JsonSerializable(typeof(CustomAgentsUpdatedAgent))]\n[JsonSerializable(typeof(ElicitationCompletedData))]\n[JsonSerializable(typeof(ElicitationCompletedEvent))]\n[JsonSerializable(typeof(ElicitationRequestedData))]\n[JsonSerializable(typeof(ElicitationRequestedEvent))]\n[JsonSerializable(typeof(ElicitationRequestedSchema))]\n[JsonSerializable(typeof(ExitPlanModeCompletedData))]\n[JsonSerializable(typeof(ExitPlanModeCompletedEvent))]\n[JsonSerializable(typeof(ExitPlanModeRequestedData))]\n[JsonSerializable(typeof(ExitPlanModeRequestedEvent))]\n[JsonSerializable(typeof(ExtensionsLoadedExtension))]\n[JsonSerializable(typeof(ExternalToolCompletedData))]\n[JsonSerializable(typeof(ExternalToolCompletedEvent))]\n[JsonSerializable(typeof(ExternalToolRequestedData))]\n[JsonSerializable(typeof(ExternalToolRequestedEvent))]\n[JsonSerializable(typeof(HandoffRepository))]\n[JsonSerializable(typeof(HookEndData))]\n[JsonSerializable(typeof(HookEndError))]\n[JsonSerializable(typeof(HookEndEvent))]\n[JsonSerializable(typeof(HookStartData))]\n[JsonSerializable(typeof(HookStartEvent))]\n[JsonSerializable(typeof(McpOauthCompletedData))]\n[JsonSerializable(typeof(McpOauthCompletedEvent))]\n[JsonSerializable(typeof(McpOauthRequiredData))]\n[JsonSerializable(typeof(McpOauthRequiredEvent))]\n[JsonSerializable(typeof(McpOauthRequiredStaticClientConfig))]\n[JsonSerializable(typeof(McpServersLoadedServer))]\n[JsonSerializable(typeof(ModelCallFailureData))]\n[JsonSerializable(typeof(ModelCallFailureEvent))]\n[JsonSerializable(typeof(PendingMessagesModifiedData))]\n[JsonSerializable(typeof(PendingMessagesModifiedEvent))]\n[JsonSerializable(typeof(PermissionCompletedData))]\n[JsonSerializable(typeof(PermissionCompletedEvent))]\n[JsonSerializable(typeof(PermissionPromptRequest))]\n[JsonSerializable(typeof(PermissionPromptRequestCommands))]\n[JsonSerializable(typeof(PermissionPromptRequestCustomTool))]\n[JsonSerializable(typeof(PermissionPromptRequestHook))]\n[JsonSerializable(typeof(PermissionPromptRequestMcp))]\n[JsonSerializable(typeof(PermissionPromptRequestMemory))]\n[JsonSerializable(typeof(PermissionPromptRequestPath))]\n[JsonSerializable(typeof(PermissionPromptRequestRead))]\n[JsonSerializable(typeof(PermissionPromptRequestUrl))]\n[JsonSerializable(typeof(PermissionPromptRequestWrite))]\n[JsonSerializable(typeof(PermissionRequest))]\n[JsonSerializable(typeof(PermissionRequestCustomTool))]\n[JsonSerializable(typeof(PermissionRequestHook))]\n[JsonSerializable(typeof(PermissionRequestMcp))]\n[JsonSerializable(typeof(PermissionRequestMemory))]\n[JsonSerializable(typeof(PermissionRequestRead))]\n[JsonSerializable(typeof(PermissionRequestShell))]\n[JsonSerializable(typeof(PermissionRequestShellCommand))]\n[JsonSerializable(typeof(PermissionRequestShellPossibleUrl))]\n[JsonSerializable(typeof(PermissionRequestUrl))]\n[JsonSerializable(typeof(PermissionRequestWrite))]\n[JsonSerializable(typeof(PermissionRequestedData))]\n[JsonSerializable(typeof(PermissionRequestedEvent))]\n[JsonSerializable(typeof(PermissionResult))]\n[JsonSerializable(typeof(PermissionResultApproved))]\n[JsonSerializable(typeof(PermissionResultApprovedForLocation))]\n[JsonSerializable(typeof(PermissionResultApprovedForSession))]\n[JsonSerializable(typeof(PermissionResultCancelled))]\n[JsonSerializable(typeof(PermissionResultDeniedByContentExclusionPolicy))]\n[JsonSerializable(typeof(PermissionResultDeniedByPermissionRequestHook))]\n[JsonSerializable(typeof(PermissionResultDeniedByRules))]\n[JsonSerializable(typeof(PermissionResultDeniedInteractivelyByUser))]\n[JsonSerializable(typeof(PermissionResultDeniedNoApprovalRuleAndCouldNotRequestFromUser))]\n[JsonSerializable(typeof(PermissionRule))]\n[JsonSerializable(typeof(SamplingCompletedData))]\n[JsonSerializable(typeof(SamplingCompletedEvent))]\n[JsonSerializable(typeof(SamplingRequestedData))]\n[JsonSerializable(typeof(SamplingRequestedEvent))]\n[JsonSerializable(typeof(SessionBackgroundTasksChangedData))]\n[JsonSerializable(typeof(SessionBackgroundTasksChangedEvent))]\n[JsonSerializable(typeof(SessionCompactionCompleteData))]\n[JsonSerializable(typeof(SessionCompactionCompleteEvent))]\n[JsonSerializable(typeof(SessionCompactionStartData))]\n[JsonSerializable(typeof(SessionCompactionStartEvent))]\n[JsonSerializable(typeof(SessionContextChangedData))]\n[JsonSerializable(typeof(SessionContextChangedEvent))]\n[JsonSerializable(typeof(SessionCustomAgentsUpdatedData))]\n[JsonSerializable(typeof(SessionCustomAgentsUpdatedEvent))]\n[JsonSerializable(typeof(SessionErrorData))]\n[JsonSerializable(typeof(SessionErrorEvent))]\n[JsonSerializable(typeof(SessionEvent))]\n[JsonSerializable(typeof(SessionExtensionsLoadedData))]\n[JsonSerializable(typeof(SessionExtensionsLoadedEvent))]\n[JsonSerializable(typeof(SessionHandoffData))]\n[JsonSerializable(typeof(SessionHandoffEvent))]\n[JsonSerializable(typeof(SessionIdleData))]\n[JsonSerializable(typeof(SessionIdleEvent))]\n[JsonSerializable(typeof(SessionInfoData))]\n[JsonSerializable(typeof(SessionInfoEvent))]\n[JsonSerializable(typeof(SessionMcpServerStatusChangedData))]\n[JsonSerializable(typeof(SessionMcpServerStatusChangedEvent))]\n[JsonSerializable(typeof(SessionMcpServersLoadedData))]\n[JsonSerializable(typeof(SessionMcpServersLoadedEvent))]\n[JsonSerializable(typeof(SessionModeChangedData))]\n[JsonSerializable(typeof(SessionModeChangedEvent))]\n[JsonSerializable(typeof(SessionModelChangeData))]\n[JsonSerializable(typeof(SessionModelChangeEvent))]\n[JsonSerializable(typeof(SessionPlanChangedData))]\n[JsonSerializable(typeof(SessionPlanChangedEvent))]\n[JsonSerializable(typeof(SessionRemoteSteerableChangedData))]\n[JsonSerializable(typeof(SessionRemoteSteerableChangedEvent))]\n[JsonSerializable(typeof(SessionResumeData))]\n[JsonSerializable(typeof(SessionResumeEvent))]\n[JsonSerializable(typeof(SessionShutdownData))]\n[JsonSerializable(typeof(SessionShutdownEvent))]\n[JsonSerializable(typeof(SessionSkillsLoadedData))]\n[JsonSerializable(typeof(SessionSkillsLoadedEvent))]\n[JsonSerializable(typeof(SessionSnapshotRewindData))]\n[JsonSerializable(typeof(SessionSnapshotRewindEvent))]\n[JsonSerializable(typeof(SessionStartData))]\n[JsonSerializable(typeof(SessionStartEvent))]\n[JsonSerializable(typeof(SessionTaskCompleteData))]\n[JsonSerializable(typeof(SessionTaskCompleteEvent))]\n[JsonSerializable(typeof(SessionTitleChangedData))]\n[JsonSerializable(typeof(SessionTitleChangedEvent))]\n[JsonSerializable(typeof(SessionToolsUpdatedData))]\n[JsonSerializable(typeof(SessionToolsUpdatedEvent))]\n[JsonSerializable(typeof(SessionTruncationData))]\n[JsonSerializable(typeof(SessionTruncationEvent))]\n[JsonSerializable(typeof(SessionUsageInfoData))]\n[JsonSerializable(typeof(SessionUsageInfoEvent))]\n[JsonSerializable(typeof(SessionWarningData))]\n[JsonSerializable(typeof(SessionWarningEvent))]\n[JsonSerializable(typeof(SessionWorkspaceFileChangedData))]\n[JsonSerializable(typeof(SessionWorkspaceFileChangedEvent))]\n[JsonSerializable(typeof(ShutdownCodeChanges))]\n[JsonSerializable(typeof(ShutdownModelMetric))]\n[JsonSerializable(typeof(ShutdownModelMetricRequests))]\n[JsonSerializable(typeof(ShutdownModelMetricTokenDetail))]\n[JsonSerializable(typeof(ShutdownModelMetricUsage))]\n[JsonSerializable(typeof(ShutdownTokenDetail))]\n[JsonSerializable(typeof(SkillInvokedData))]\n[JsonSerializable(typeof(SkillInvokedEvent))]\n[JsonSerializable(typeof(SkillsLoadedSkill))]\n[JsonSerializable(typeof(SubagentCompletedData))]\n[JsonSerializable(typeof(SubagentCompletedEvent))]\n[JsonSerializable(typeof(SubagentDeselectedData))]\n[JsonSerializable(typeof(SubagentDeselectedEvent))]\n[JsonSerializable(typeof(SubagentFailedData))]\n[JsonSerializable(typeof(SubagentFailedEvent))]\n[JsonSerializable(typeof(SubagentSelectedData))]\n[JsonSerializable(typeof(SubagentSelectedEvent))]\n[JsonSerializable(typeof(SubagentStartedData))]\n[JsonSerializable(typeof(SubagentStartedEvent))]\n[JsonSerializable(typeof(SystemMessageData))]\n[JsonSerializable(typeof(SystemMessageEvent))]\n[JsonSerializable(typeof(SystemMessageMetadata))]\n[JsonSerializable(typeof(SystemNotification))]\n[JsonSerializable(typeof(SystemNotificationAgentCompleted))]\n[JsonSerializable(typeof(SystemNotificationAgentIdle))]\n[JsonSerializable(typeof(SystemNotificationData))]\n[JsonSerializable(typeof(SystemNotificationEvent))]\n[JsonSerializable(typeof(SystemNotificationInstructionDiscovered))]\n[JsonSerializable(typeof(SystemNotificationNewInboxMessage))]\n[JsonSerializable(typeof(SystemNotificationShellCompleted))]\n[JsonSerializable(typeof(SystemNotificationShellDetachedCompleted))]\n[JsonSerializable(typeof(ToolExecutionCompleteContent))]\n[JsonSerializable(typeof(ToolExecutionCompleteContentAudio))]\n[JsonSerializable(typeof(ToolExecutionCompleteContentImage))]\n[JsonSerializable(typeof(ToolExecutionCompleteContentResource))]\n[JsonSerializable(typeof(ToolExecutionCompleteContentResourceLink))]\n[JsonSerializable(typeof(ToolExecutionCompleteContentResourceLinkIcon))]\n[JsonSerializable(typeof(ToolExecutionCompleteContentTerminal))]\n[JsonSerializable(typeof(ToolExecutionCompleteContentText))]\n[JsonSerializable(typeof(ToolExecutionCompleteData))]\n[JsonSerializable(typeof(ToolExecutionCompleteError))]\n[JsonSerializable(typeof(ToolExecutionCompleteEvent))]\n[JsonSerializable(typeof(ToolExecutionCompleteResult))]\n[JsonSerializable(typeof(ToolExecutionPartialResultData))]\n[JsonSerializable(typeof(ToolExecutionPartialResultEvent))]\n[JsonSerializable(typeof(ToolExecutionProgressData))]\n[JsonSerializable(typeof(ToolExecutionProgressEvent))]\n[JsonSerializable(typeof(ToolExecutionStartData))]\n[JsonSerializable(typeof(ToolExecutionStartEvent))]\n[JsonSerializable(typeof(ToolUserRequestedData))]\n[JsonSerializable(typeof(ToolUserRequestedEvent))]\n[JsonSerializable(typeof(UserInputCompletedData))]\n[JsonSerializable(typeof(UserInputCompletedEvent))]\n[JsonSerializable(typeof(UserInputRequestedData))]\n[JsonSerializable(typeof(UserInputRequestedEvent))]\n[JsonSerializable(typeof(UserMessageAttachment))]\n[JsonSerializable(typeof(UserMessageAttachmentBlob))]\n[JsonSerializable(typeof(UserMessageAttachmentDirectory))]\n[JsonSerializable(typeof(UserMessageAttachmentFile))]\n[JsonSerializable(typeof(UserMessageAttachmentFileLineRange))]\n[JsonSerializable(typeof(UserMessageAttachmentGithubReference))]\n[JsonSerializable(typeof(UserMessageAttachmentSelection))]\n[JsonSerializable(typeof(UserMessageAttachmentSelectionDetails))]\n[JsonSerializable(typeof(UserMessageAttachmentSelectionDetailsEnd))]\n[JsonSerializable(typeof(UserMessageAttachmentSelectionDetailsStart))]\n[JsonSerializable(typeof(UserMessageData))]\n[JsonSerializable(typeof(UserMessageEvent))]\n[JsonSerializable(typeof(UserToolSessionApproval))]\n[JsonSerializable(typeof(UserToolSessionApprovalCommands))]\n[JsonSerializable(typeof(UserToolSessionApprovalCustomTool))]\n[JsonSerializable(typeof(UserToolSessionApprovalMcp))]\n[JsonSerializable(typeof(UserToolSessionApprovalMemory))]\n[JsonSerializable(typeof(UserToolSessionApprovalRead))]\n[JsonSerializable(typeof(UserToolSessionApprovalWrite))]\n[JsonSerializable(typeof(WorkingDirectoryContext))]\n[JsonSerializable(typeof(JsonElement))]\ninternal partial class SessionEventsJsonContext : JsonSerializerContext;" }, { "path": "dotnet/src/GitHub.Copilot.SDK.csproj", "content": "\n\n \n true\n 0.1.0\n SDK for programmatic control of GitHub Copilot CLI\n GitHub\n GitHub\n Copyright (c) Microsoft Corporation. All rights reserved.\n MIT\n https://github.com/github/copilot-sdk\n README.md\n https://github.com/github/copilot-sdk\n copilot.png\n github;copilot;sdk;jsonrpc;agent\n true\n true\n snupkg\n true\n true\n \n\n \n $(NoWarn);GHCP001\n \n\n \n true\n \n\n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n \n <_VersionPropsContent>\n \n \n $(CopilotCliVersion)\n \n]]>\n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n\n" }, { "path": "dotnet/src/JsonRpc.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.Buffers;\nusing System.Collections.Concurrent;\nusing System.Diagnostics;\nusing System.Diagnostics.CodeAnalysis;\nusing System.Globalization;\nusing System.Reflection;\nusing System.Text;\nusing System.Text.Json;\nusing System.Text.Json.Serialization;\nusing System.Text.Json.Serialization.Metadata;\nusing System.Text.Unicode;\nusing Microsoft.Extensions.Logging;\nusing Microsoft.Extensions.Logging.Abstractions;\n\nnamespace GitHub.Copilot.SDK;\n\n/// \n/// A lightweight JSON-RPC 2.0 implementation covering only the features used\n/// by this SDK to talk to the Copilot CLI. Messages are framed using the\n/// LSP-style header convention (Content-Length: N\\r\\n\\r\\n followed by\n/// N bytes of JSON body) — the same wire format used by the Language Server\n/// Protocol and the Copilot CLI's other language SDKs (Go, Node, Python).\n/// This is not a general-purpose JSON-RPC stack: it is narrowly scoped to the\n/// methods, transports, and framing the CLI uses.\n/// \ninternal sealed partial class JsonRpc : IDisposable\n{\n private const int ErrorCodeMethodNotFound = -32601;\n private const int ErrorCodeInternalError = -32603;\n\n private readonly Stream _sendStream;\n private readonly Stream _receiveStream;\n private readonly JsonSerializerOptions _serializerOptions;\n private readonly ILogger _logger;\n private readonly ConcurrentDictionary _pendingRequests = new();\n private readonly ConcurrentDictionary _methods = new();\n private readonly TaskCompletionSource _completionSource = new(TaskCreationOptions.RunContinuationsAsynchronously);\n private readonly SemaphoreSlim _writeLock = new(1, 1);\n private readonly CancellationTokenSource _disposeCts = new();\n private long _nextId;\n private bool _disposed;\n\n /// \n /// Initializes a new .\n /// \n /// The stream to write outgoing messages to.\n /// The stream to read incoming messages from.\n /// JSON serializer options (should include all needed source-gen contexts).\n /// Optional logger for diagnostics.\n public JsonRpc(Stream sendStream, Stream receiveStream, JsonSerializerOptions serializerOptions, ILogger? logger = null)\n {\n _sendStream = sendStream;\n _receiveStream = receiveStream;\n _serializerOptions = serializerOptions;\n _logger = logger ?? NullLogger.Instance;\n }\n\n /// \n /// A that completes when the connection is closed or faulted.\n /// \n public Task Completion => _completionSource.Task;\n\n /// \n /// Begins reading messages from the receive stream. Call once after registering all method handlers.\n /// \n public void StartListening()\n {\n _ = ReadLoopAsync(_disposeCts.Token);\n }\n\n /// \n /// Sends a JSON-RPC request and waits for the response.\n /// \n public async Task InvokeAsync(string method, object?[]? args, CancellationToken cancellationToken)\n {\n var id = Interlocked.Increment(ref _nextId);\n var pending = new PendingRequest();\n _pendingRequests[id] = pending;\n\n CancellationTokenRegistration cancelRegistration = default;\n try\n {\n if (cancellationToken.CanBeCanceled)\n {\n cancelRegistration = cancellationToken.Register(static state =>\n {\n var (self, reqId, ct) = ((JsonRpc, long, CancellationToken))state!;\n if (self._pendingRequests.TryRemove(reqId, out var p))\n {\n p.TrySetCanceled(ct);\n }\n\n // Best-effort cancel notification\n _ = self.SendCancelNotificationAsync(reqId);\n }, (this, id, cancellationToken));\n }\n\n // Send request message\n await SendMessageAsync(new JsonRpcRequest\n {\n Id = id,\n Method = method,\n Params = SerializeArgs(args),\n }, JsonRpcWireContext.Default.JsonRpcRequest, cancellationToken).ConfigureAwait(false);\n\n var responseElement = await pending.Task.ConfigureAwait(false);\n\n if (responseElement.ValueKind == JsonValueKind.Null || responseElement.ValueKind == JsonValueKind.Undefined)\n {\n return default!;\n }\n\n return (T)responseElement.Deserialize(_serializerOptions.GetTypeInfo(typeof(T)))!;\n }\n finally\n {\n _pendingRequests.TryRemove(id, out _);\n await cancelRegistration.DisposeAsync().ConfigureAwait(false);\n }\n }\n\n /// \n /// Registers a method handler that receives positional parameters.\n /// If singleObjectParam is false (the default), parameter names and types are inferred from the delegate's signature.\n /// If singleObjectParam is true, the entire params object is deserialized as the handler's first parameter.\n /// \n public void SetLocalRpcMethod(string methodName, Delegate handler, bool singleObjectParam = false)\n {\n _methods[methodName] = new MethodRegistration(handler, singleObjectParam);\n }\n\n /// \n public void Dispose()\n {\n if (_disposed)\n {\n return;\n }\n\n _disposed = true;\n _disposeCts.Cancel();\n\n // Fail all pending requests\n foreach (var kvp in _pendingRequests)\n {\n if (_pendingRequests.TryRemove(kvp.Key, out var pending))\n {\n pending.TrySetException(new ObjectDisposedException(nameof(JsonRpc)));\n }\n }\n\n _completionSource.TrySetResult();\n _writeLock.Dispose();\n }\n\n private async Task SendMessageAsync(T message, JsonTypeInfo typeInfo, CancellationToken cancellationToken)\n {\n // \"Content-Length: \" (16) + max int digits (10) + \"\\r\\n\\r\\n\" (4)\n const int MaxHeaderLength = 30;\n\n var json = JsonSerializer.SerializeToUtf8Bytes(message, typeInfo);\n\n var headerBuf = ArrayPool.Shared.Rent(MaxHeaderLength);\n bool wrote = Utf8.TryWrite(headerBuf, $\"Content-Length: {json.Length}\\r\\n\\r\\n\", out int headerLen);\n Debug.Assert(wrote && headerLen > 0);\n\n // Cancellation only applies to *waiting* for the write lock. Once we hold the lock\n // and start writing a framed message, we must finish it — cancelling between the\n // header and the body (or mid-body) would leave the peer waiting for N body bytes\n // that never arrive, desynchronizing the LSP-style stream for every subsequent\n // message on this connection.\n await _writeLock.WaitAsync(cancellationToken).ConfigureAwait(false);\n try\n {\n await _sendStream.WriteAsync(headerBuf.AsMemory(0, headerLen), CancellationToken.None).ConfigureAwait(false);\n await _sendStream.WriteAsync(json, CancellationToken.None).ConfigureAwait(false);\n await _sendStream.FlushAsync(CancellationToken.None).ConfigureAwait(false);\n }\n finally\n {\n _writeLock.Release();\n ArrayPool.Shared.Return(headerBuf);\n }\n }\n\n private async Task ReadLoopAsync(CancellationToken cancellationToken)\n {\n var buffer = new byte[256];\n int carried = 0; // bytes in buffer carried over from previous read\n try\n {\n while (!cancellationToken.IsCancellationRequested)\n {\n // Read headers and body\n var (contentLength, buf, newCarried) = await ReadMessageAsync(buffer, carried, cancellationToken).ConfigureAwait(false);\n if (contentLength < 0)\n {\n break; // Stream ended\n }\n\n // Keep the (possibly grown) buffer and carry-over count for next iteration\n buffer = buf;\n carried = newCarried;\n\n // Parse the raw JSON. Body is at buffer[0..contentLength], carried bytes\n // for the next message are at buffer[contentLength..contentLength+carried].\n JsonElement? message = null;\n try\n {\n using var doc = JsonDocument.Parse(buffer.AsMemory(0, contentLength));\n message = doc.RootElement.Clone();\n }\n catch (JsonException ex)\n {\n _logger.LogWarning(ex, \"Failed to parse incoming JSON-RPC message\");\n }\n\n // Always move carried bytes to the front, even on parse failure — otherwise\n // the next ReadMessageAsync call would scan stale body bytes as headers.\n // This must happen AFTER parsing because the carried region overlaps where\n // the body lived.\n if (carried > 0)\n {\n Buffer.BlockCopy(buffer, contentLength, buffer, 0, carried);\n }\n\n if (message is not { } parsed)\n {\n continue;\n }\n\n // Route the message\n if (parsed.TryGetProperty(\"id\", out var idProp) && !parsed.TryGetProperty(\"method\", out _))\n {\n // It's a response to one of our requests\n HandleResponse(parsed, idProp);\n }\n else if (parsed.TryGetProperty(\"method\", out var methodProp) && methodProp.GetString() is string methodName)\n {\n _ = HandleIncomingMethodAsync(methodName, parsed, cancellationToken);\n }\n }\n }\n catch (OperationCanceledException) when (cancellationToken.IsCancellationRequested)\n {\n // Normal shutdown\n }\n catch (Exception ex)\n {\n _logger.LogDebug(ex, \"JSON-RPC read loop ended\");\n }\n finally\n {\n // Fail all pending requests\n foreach (var kvp in _pendingRequests)\n {\n if (_pendingRequests.TryRemove(kvp.Key, out var pending))\n {\n pending.TrySetException(new ConnectionLostException());\n }\n }\n\n _completionSource.TrySetResult();\n }\n }\n\n /// \n /// Reads headers and body in one pass.\n /// On return, body is at buffer[0..ContentLength], and any overflow bytes\n /// from the next message are at buffer[ContentLength..ContentLength+Carried].\n /// The caller must move the carried bytes to the front before the next call.\n /// \n /// Shared buffer (may be grown).\n /// Bytes already in buffer[0..carried] from a previous read.\n /// Cancellation token.\n private async ValueTask<(int ContentLength, byte[] Buffer, int Carried)> ReadMessageAsync(byte[] buffer, int carried, CancellationToken cancellationToken)\n {\n // Read until we find the \\r\\n\\r\\n header terminator.\n // carried bytes are already at buffer[0..carried].\n int filled = carried;\n int headerEnd = -1; // index of first byte after \\r\\n\\r\\n\n\n // Check carried bytes first for a header terminator\n {\n int pos = buffer.AsSpan(0, filled).IndexOf(\"\\r\\n\\r\\n\"u8);\n if (pos >= 0)\n {\n headerEnd = pos + 4;\n }\n }\n\n while (headerEnd < 0)\n {\n if (filled == buffer.Length)\n {\n Array.Resize(ref buffer, buffer.Length * 2);\n }\n\n int bytesRead = await _receiveStream.ReadAsync(buffer.AsMemory(filled, buffer.Length - filled), cancellationToken).ConfigureAwait(false);\n if (bytesRead == 0)\n {\n // Clean EOF only if we haven't started a frame; otherwise the peer truncated mid-header.\n if (filled == 0)\n {\n return (-1, buffer, 0);\n }\n\n throw new EndOfStreamException(\"Stream ended while reading JSON-RPC headers.\");\n }\n\n filled += bytesRead;\n\n // Scan for \\r\\n\\r\\n starting from where a match could begin\n int scanStart = Math.Max(filled - bytesRead - 3, 0);\n int pos = buffer.AsSpan(scanStart, filled - scanStart).IndexOf(\"\\r\\n\\r\\n\"u8);\n if (pos >= 0)\n {\n headerEnd = scanStart + pos + 4;\n }\n }\n\n // Parse Content-Length. LSP framing puts each header on its own \\r\\n-terminated\n // line; we walk the lines and require an exact \"Content-Length: \" prefix at the\n // start of one of them. A substring match anywhere in the header block would\n // false-positive on values like \"X-Trace: Content-Length: 5\" and desync the stream.\n // A missing or unparseable Content-Length means the framing is broken — there's\n // no safe way to resync, so throw and let the read loop terminate the connection.\n int contentLength = -1;\n ReadOnlySpan prefix = \"Content-Length: \"u8;\n // headerEnd points just past the \\r\\n\\r\\n terminator. Drop only the trailing\n // empty line's \\r\\n; each remaining header line is still \\r\\n-terminated and\n // gets split out by the IndexOf below.\n var headerLines = buffer.AsSpan(0, headerEnd - 2);\n while (!headerLines.IsEmpty)\n {\n int lineEnd = headerLines.IndexOf(\"\\r\\n\"u8);\n ReadOnlySpan line = lineEnd >= 0 ? headerLines.Slice(0, lineEnd) : headerLines;\n\n if (line.StartsWith(prefix) &&\n (contentLength >= 0 ||\n !int.TryParse(line.Slice(prefix.Length), NumberStyles.None, CultureInfo.InvariantCulture, out contentLength) ||\n contentLength < 0))\n {\n throw new InvalidDataException(\"JSON-RPC frame has a missing, duplicate, or invalid Content-Length header.\");\n }\n\n headerLines = lineEnd >= 0 ? headerLines.Slice(lineEnd + 2) : default;\n }\n\n if (contentLength < 0)\n {\n throw new InvalidDataException(\"JSON-RPC frame is missing the Content-Length header.\");\n }\n\n // Bytes after the header that we already have\n int extraBytes = filled - headerEnd;\n\n // Ensure buffer is large enough for the body and any overflow already read.\n int needed = Math.Max(contentLength, extraBytes);\n if (needed > buffer.Length)\n {\n var newBuffer = new byte[needed];\n Buffer.BlockCopy(buffer, headerEnd, newBuffer, 0, extraBytes);\n buffer = newBuffer;\n }\n else if (extraBytes > 0)\n {\n Buffer.BlockCopy(buffer, headerEnd, buffer, 0, extraBytes);\n }\n\n // Read remaining body bytes if we don't have enough\n if (extraBytes < contentLength)\n {\n await _receiveStream.ReadExactlyAsync(buffer.AsMemory(extraBytes, contentLength - extraBytes), cancellationToken).ConfigureAwait(false);\n return (contentLength, buffer, 0);\n }\n\n // We read more than the body — overflow belongs to the next message\n int overflow = extraBytes - contentLength;\n return (contentLength, buffer, overflow);\n }\n\n private void HandleResponse(JsonElement message, JsonElement idProp)\n {\n if (!idProp.TryGetInt64(out long id))\n {\n return;\n }\n\n if (!_pendingRequests.TryRemove(id, out var pending))\n {\n return;\n }\n\n if (message.TryGetProperty(\"error\", out var errorProp))\n {\n var errorMessage = errorProp.TryGetProperty(\"message\", out var msgProp)\n ? msgProp.GetString() ?? \"Unknown error\"\n : \"Unknown error\";\n var errorCode = errorProp.TryGetProperty(\"code\", out var codeProp) && codeProp.ValueKind == JsonValueKind.Number\n ? codeProp.GetInt32()\n : 0;\n pending.TrySetException(new RemoteRpcException(errorMessage, errorCode));\n }\n else if (message.TryGetProperty(\"result\", out var resultProp))\n {\n pending.TrySetResult(resultProp.Clone());\n }\n else\n {\n // Per JSON-RPC 2.0, a response must have either \"result\" or \"error\".\n // Treat missing result as null result.\n pending.TrySetResult(default);\n }\n }\n\n private async Task HandleIncomingMethodAsync(string methodName, JsonElement message, CancellationToken cancellationToken)\n {\n try\n {\n JsonElement? requestId = null;\n if (message.TryGetProperty(\"id\", out var idProp))\n {\n requestId = idProp;\n }\n\n if (!_methods.TryGetValue(methodName, out var registration))\n {\n if (requestId.HasValue)\n {\n await SendErrorResponseAsync(requestId.Value, ErrorCodeMethodNotFound, $\"Method not found: {methodName}\", cancellationToken).ConfigureAwait(false);\n }\n return;\n }\n\n message.TryGetProperty(\"params\", out var paramsProp);\n\n try\n {\n var result = await InvokeHandlerAsync(registration, paramsProp, cancellationToken).ConfigureAwait(false);\n\n if (requestId.HasValue)\n {\n await SendResultResponseAsync(requestId.Value, result, cancellationToken).ConfigureAwait(false);\n }\n }\n catch (Exception ex) when (ex is not OperationCanceledException)\n {\n if (_logger.IsEnabled(LogLevel.Debug))\n {\n _logger.LogDebug(\"Error handling JSON-RPC method {Method}: {Error}\", methodName, ex.Message);\n }\n if (requestId.HasValue)\n {\n await SendErrorResponseAsync(requestId.Value, ErrorCodeInternalError, ex.Message, cancellationToken).ConfigureAwait(false);\n }\n }\n }\n catch (OperationCanceledException) when (cancellationToken.IsCancellationRequested)\n {\n // Normal shutdown — cancellation propagated from the read loop.\n }\n catch (Exception ex)\n {\n // Belt-and-braces: this method is fire-and-forget from the read loop, so any\n // exception escaping here would become an unobserved task exception. The most\n // likely sources are IOException/ObjectDisposedException from sending the error\n // response after the underlying transport is gone.\n if (_logger.IsEnabled(LogLevel.Debug))\n {\n _logger.LogDebug(ex, \"Unobserved error in JSON-RPC method dispatch for {Method}\", methodName);\n }\n }\n }\n\n private async ValueTask InvokeHandlerAsync(MethodRegistration registration, JsonElement paramsProp, CancellationToken cancellationToken)\n {\n var parameters = registration.Parameters;\n\n // Build argument list\n var invokeArgs = new object?[parameters.Length];\n\n if (registration.SingleObjectParam)\n {\n // Single-object deserialization: entire `params` → first parameter.\n // Every singleObjectParam handler has shape (TRequest, CancellationToken),\n // so `params` must be a JSON object.\n if (paramsProp.ValueKind != JsonValueKind.Object)\n {\n throw new InvalidOperationException(\n $\"Expected JSON object for `params` of single-object-param handler; got '{paramsProp.ValueKind}'.\");\n }\n\n for (int i = 0; i < parameters.Length; i++)\n {\n if (parameters[i].ParameterType == typeof(CancellationToken))\n {\n invokeArgs[i] = cancellationToken;\n }\n else if (i == 0)\n {\n invokeArgs[i] = paramsProp.Deserialize(_serializerOptions.GetTypeInfo(parameters[i].ParameterType));\n }\n }\n }\n else if (paramsProp.ValueKind == JsonValueKind.Array)\n {\n // Positional parameters. Optional params (with defaults) are filled when absent.\n int jsonIndex = 0;\n int arrayLength = paramsProp.GetArrayLength();\n for (int i = 0; i < parameters.Length; i++)\n {\n if (parameters[i].ParameterType == typeof(CancellationToken))\n {\n invokeArgs[i] = cancellationToken;\n }\n else if (jsonIndex < arrayLength)\n {\n invokeArgs[i] = paramsProp[jsonIndex].Deserialize(_serializerOptions.GetTypeInfo(parameters[i].ParameterType));\n jsonIndex++;\n }\n else\n {\n invokeArgs[i] = parameters[i].HasDefaultValue ? parameters[i].DefaultValue : null;\n }\n }\n }\n else if (paramsProp.ValueKind == JsonValueKind.Object)\n {\n // Named parameters. The CLI sends notifications/requests as a JSON object whose\n // property names match the handler's parameter names (camelCased per web defaults).\n // Look up each parameter by name; missing optional parameters fall back to defaults.\n for (int i = 0; i < parameters.Length; i++)\n {\n if (parameters[i].ParameterType == typeof(CancellationToken))\n {\n invokeArgs[i] = cancellationToken;\n }\n else if (parameters[i].Name is { } paramName &&\n TryGetPropertyCaseInsensitive(paramsProp, paramName, out var valueProp))\n {\n invokeArgs[i] = valueProp.Deserialize(_serializerOptions.GetTypeInfo(parameters[i].ParameterType));\n }\n else\n {\n invokeArgs[i] = parameters[i].HasDefaultValue ? parameters[i].DefaultValue : null;\n }\n }\n }\n else\n {\n // Missing/null `params` for a handler with required positional parameters is a\n // protocol violation. Surface it as an error rather than silently filling defaults.\n throw new InvalidOperationException(\n $\"Unsupported JSON-RPC params shape '{paramsProp.ValueKind}' for handler with positional parameters.\");\n }\n\n // Invoke\n var result = registration.Handler.DynamicInvoke(invokeArgs);\n\n // Handlers return one of: a synchronous value, Task (void async), or ValueTask.\n if (result is Task task)\n {\n // Task handlers are not supported — use ValueTask for results.\n Debug.Assert(!task.GetType().IsGenericType, \"Task handlers are not supported; use ValueTask.\");\n await task.ConfigureAwait(false);\n return null;\n }\n\n if (result is not null && registration.ReturnsValueTaskOfT)\n {\n var resultType = result.GetType();\n var asTask = (Task)resultType.GetMethod(\"AsTask\")!.Invoke(result, null)!;\n await asTask.ConfigureAwait(false);\n return asTask.GetType().GetProperty(\"Result\")!.GetValue(asTask);\n }\n\n return result;\n }\n\n private static bool TryGetPropertyCaseInsensitive(JsonElement obj, string name, out JsonElement value)\n {\n // Fast path: exact match. The CLI uses camelCase property names that match the\n // C# parameter names exactly, so this should hit in the common case.\n if (obj.TryGetProperty(name, out value))\n {\n return true;\n }\n\n foreach (var prop in obj.EnumerateObject())\n {\n if (string.Equals(prop.Name, name, StringComparison.OrdinalIgnoreCase))\n {\n value = prop.Value;\n return true;\n }\n }\n\n value = default;\n return false;\n }\n\n private JsonElement? SerializeArgs(object?[]? args)\n {\n if (args is null || args.Length == 0)\n {\n return null;\n }\n\n // The Copilot CLI uses vscode-jsonrpc-style request handlers, which expect\n // `params` to be the single request object (not wrapped in a positional array).\n // The other SDKs (Node, Python, Go) all send single-object params, and every\n // generated call site here passes exactly one request object. For the rare\n // multi-arg case, fall back to a positional array.\n if (args.Length == 1)\n {\n var arg = args[0];\n if (arg is null)\n {\n return null;\n }\n\n var typeInfo = _serializerOptions.GetTypeInfo(arg.GetType());\n return JsonSerializer.SerializeToElement(arg, typeInfo);\n }\n\n // Source-generated JsonSerializerOptions do not provide metadata for object[],\n // so build the JSON array manually, serializing each element with a TypeInfo\n // looked up by its runtime type from the merged resolver.\n var buffer = new ArrayBufferWriter();\n using (var writer = new Utf8JsonWriter(buffer))\n {\n writer.WriteStartArray();\n foreach (var arg in args)\n {\n if (arg is null)\n {\n writer.WriteNullValue();\n }\n else\n {\n var typeInfo = _serializerOptions.GetTypeInfo(arg.GetType());\n JsonSerializer.Serialize(writer, arg, typeInfo);\n }\n }\n\n writer.WriteEndArray();\n }\n\n using var doc = JsonDocument.Parse(buffer.WrittenMemory);\n return doc.RootElement.Clone();\n }\n\n private async Task SendResultResponseAsync(JsonElement id, object? result, CancellationToken cancellationToken)\n {\n try\n {\n // Convert the result to a JsonElement using the runtime type, looked up via\n // the merged resolver. Source-gen serialization of an `object`-typed property\n // would otherwise have no way to find metadata for the actual response type\n // (e.g. SystemMessageTransformRpcResponse, SessionFsReadFileResult, ...).\n JsonElement? resultElement = null;\n if (result is not null)\n {\n var typeInfo = _serializerOptions.GetTypeInfo(result.GetType());\n resultElement = JsonSerializer.SerializeToElement(result, typeInfo);\n }\n\n await SendMessageAsync(new JsonRpcResponse\n {\n Id = id,\n Result = resultElement,\n }, JsonRpcWireContext.Default.JsonRpcResponse, cancellationToken).ConfigureAwait(false);\n }\n catch (Exception ex) when (ex is IOException or ObjectDisposedException or OperationCanceledException)\n {\n // Connection lost during response — nothing we can do\n }\n }\n\n private async Task SendErrorResponseAsync(JsonElement id, int code, string message, CancellationToken cancellationToken)\n {\n try\n {\n await SendMessageAsync(new JsonRpcErrorResponse\n {\n Id = id,\n Error = new JsonRpcError { Code = code, Message = message },\n }, JsonRpcWireContext.Default.JsonRpcErrorResponse, cancellationToken).ConfigureAwait(false);\n }\n catch (Exception ex) when (ex is IOException or ObjectDisposedException or OperationCanceledException)\n {\n // Connection lost during error response — nothing we can do\n }\n }\n\n private async Task SendCancelNotificationAsync(long requestId)\n {\n try\n {\n await SendMessageAsync(new JsonRpcNotification\n {\n Method = \"$/cancelRequest\",\n Params = JsonSerializer.SerializeToElement(\n new CancelRequestParams { Id = requestId },\n CancelRequestParamsContext.Default.CancelRequestParams),\n }, JsonRpcWireContext.Default.JsonRpcNotification, CancellationToken.None).ConfigureAwait(false);\n }\n catch (Exception ex) when (ex is IOException or ObjectDisposedException or OperationCanceledException)\n {\n // Best effort — connection may already be gone\n }\n }\n\n private sealed class PendingRequest() : TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n\n private sealed class MethodRegistration\n {\n public MethodRegistration(Delegate handler, bool singleObjectParam)\n {\n Handler = handler;\n SingleObjectParam = singleObjectParam;\n Parameters = handler.Method.GetParameters();\n ReturnsValueTaskOfT =\n handler.Method.ReturnType.IsGenericType &&\n handler.Method.ReturnType.GetGenericTypeDefinition() == typeof(ValueTask<>);\n }\n\n public Delegate Handler { get; }\n public bool SingleObjectParam { get; }\n public ParameterInfo[] Parameters { get; }\n public bool ReturnsValueTaskOfT { get; }\n }\n\n [JsonSourceGenerationOptions(\n JsonSerializerDefaults.Web,\n DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonSerializable(typeof(JsonRpcRequest))]\n [JsonSerializable(typeof(JsonRpcResponse))]\n [JsonSerializable(typeof(JsonRpcErrorResponse))]\n [JsonSerializable(typeof(JsonRpcNotification))]\n private partial class JsonRpcWireContext : JsonSerializerContext;\n\n private sealed class JsonRpcRequest\n {\n [JsonPropertyName(\"jsonrpc\")]\n public string Jsonrpc { get; } = \"2.0\";\n\n [JsonPropertyName(\"id\")]\n public long Id { get; set; }\n\n [JsonPropertyName(\"method\")]\n public string Method { get; set; } = string.Empty;\n\n [JsonPropertyName(\"params\")]\n public JsonElement? Params { get; set; }\n }\n\n private sealed class JsonRpcResponse\n {\n [JsonPropertyName(\"jsonrpc\")]\n public string Jsonrpc { get; } = \"2.0\";\n\n [JsonPropertyName(\"id\")]\n public JsonElement Id { get; set; }\n\n // JSON-RPC 2.0 requires every response to carry either `result` or `error`.\n // vscode-jsonrpc (used by the CLI) rejects responses that have neither with\n // \"The received response has neither a result nor an error property\", so we\n // must emit `result: null` for void-returning handlers — overriding the\n // context-level WhenWritingNull policy.\n [JsonPropertyName(\"result\")]\n [JsonIgnore(Condition = JsonIgnoreCondition.Never)]\n public JsonElement? Result { get; set; }\n }\n\n private sealed class JsonRpcErrorResponse\n {\n [JsonPropertyName(\"jsonrpc\")]\n public string Jsonrpc { get; } = \"2.0\";\n\n [JsonPropertyName(\"id\")]\n public JsonElement Id { get; set; }\n\n [JsonPropertyName(\"error\")]\n public JsonRpcError? Error { get; set; }\n }\n\n private sealed class JsonRpcError\n {\n [JsonPropertyName(\"code\")]\n public int Code { get; set; }\n\n [JsonPropertyName(\"message\")]\n public string Message { get; set; } = string.Empty;\n }\n\n private sealed class JsonRpcNotification\n {\n [JsonPropertyName(\"jsonrpc\")]\n public string Jsonrpc { get; } = \"2.0\";\n\n [JsonPropertyName(\"method\")]\n public string Method { get; set; } = string.Empty;\n\n [JsonPropertyName(\"params\")]\n public JsonElement? Params { get; set; }\n }\n\n private sealed class CancelRequestParams\n {\n [JsonPropertyName(\"id\")]\n public long Id { get; set; }\n }\n\n [JsonSerializable(typeof(CancelRequestParams))]\n private partial class CancelRequestParamsContext : JsonSerializerContext;\n}\n\n/// \n/// Thrown when the JSON-RPC connection is lost unexpectedly.\n/// \ninternal sealed class ConnectionLostException() : IOException(\"The JSON-RPC connection was lost.\");\n\n/// \n/// Thrown when the remote side returns a JSON-RPC error response.\n/// \ninternal sealed class RemoteRpcException(string message, int errorCode, Exception? innerException = null) : Exception(message, innerException)\n{\n public int ErrorCode { get; } = errorCode;\n}\n" }, { "path": "dotnet/src/MillisecondsTimeSpanConverter.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.ComponentModel;\nusing System.Text.Json;\nusing System.Text.Json.Serialization;\n\nnamespace GitHub.Copilot.SDK;\n\n/// Converts between JSON numeric milliseconds and .\n[EditorBrowsable(EditorBrowsableState.Never)]\npublic sealed class MillisecondsTimeSpanConverter : JsonConverter\n{\n /// \n public override TimeSpan Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) =>\n TimeSpan.FromMilliseconds(reader.GetDouble());\n\n /// \n public override void Write(Utf8JsonWriter writer, TimeSpan value, JsonSerializerOptions options) =>\n writer.WriteNumberValue(value.TotalMilliseconds);\n}\n" }, { "path": "dotnet/src/PermissionHandlers.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nnamespace GitHub.Copilot.SDK;\n\n/// Provides pre-built implementations.\npublic static class PermissionHandler\n{\n /// A that approves all permission requests.\n public static PermissionRequestHandler ApproveAll { get; } =\n (_, _) => Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved });\n}\n" }, { "path": "dotnet/src/SdkProtocolVersion.cs", "content": "// Code generated by update-protocol-version.ts. DO NOT EDIT.\n\nnamespace GitHub.Copilot.SDK;\n\n/// \n/// Provides the SDK protocol version.\n/// This must match the version expected by the copilot-agent-runtime server.\n/// \ninternal static class SdkProtocolVersion\n{\n /// \n /// The SDK protocol version.\n /// \n private const int Version = 3;\n\n /// \n /// Gets the SDK protocol version.\n /// \n public static int GetVersion() => Version;\n}\n" }, { "path": "dotnet/src/Session.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Rpc;\nusing Microsoft.Extensions.AI;\nusing Microsoft.Extensions.Logging;\nusing System.Collections.Immutable;\nusing System.Text.Json;\nusing System.Text.Json.Nodes;\nusing System.Text.Json.Serialization;\nusing System.Threading.Channels;\n\nnamespace GitHub.Copilot.SDK;\n\n/// \n/// Represents a single conversation session with the Copilot CLI.\n/// \n/// \n/// \n/// A session maintains conversation state, handles events, and manages tool execution.\n/// Sessions are created via or resumed via\n/// .\n/// \n/// \n/// The session provides methods to send messages, subscribe to events, retrieve\n/// conversation history, and manage the session lifecycle.\n/// \n/// \n/// implements . Use the\n/// await using pattern for automatic cleanup, or call \n/// explicitly. Disposing a session releases in-memory resources but preserves session data\n/// on disk — the conversation can be resumed later via\n/// . To permanently delete session data,\n/// use .\n/// \n/// \n/// \n/// \n/// await using var session = await client.CreateSessionAsync(new() { OnPermissionRequest = PermissionHandler.ApproveAll, Model = \"gpt-4\" });\n///\n/// // Subscribe to events\n/// using var subscription = session.On(evt =>\n/// {\n/// if (evt is AssistantMessageEvent assistantMessage)\n/// {\n/// Console.WriteLine($\"Assistant: {assistantMessage.Data?.Content}\");\n/// }\n/// });\n///\n/// // Send a message and wait for completion\n/// await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Hello, world!\" });\n/// \n/// \npublic sealed partial class CopilotSession : IAsyncDisposable\n{\n private readonly Dictionary _toolHandlers = [];\n private readonly Dictionary _commandHandlers = [];\n private readonly JsonRpc _rpc;\n private readonly ILogger _logger;\n\n private volatile PermissionRequestHandler? _permissionHandler;\n private volatile UserInputHandler? _userInputHandler;\n private volatile ElicitationHandler? _elicitationHandler;\n private ImmutableArray _eventHandlers = ImmutableArray.Empty;\n\n private SessionHooks? _hooks;\n private readonly SemaphoreSlim _hooksLock = new(1, 1);\n private Dictionary>>? _transformCallbacks;\n private readonly SemaphoreSlim _transformCallbacksLock = new(1, 1);\n private SessionRpc? _sessionRpc;\n private int _isDisposed;\n\n /// \n /// Channel that serializes event dispatch. enqueues;\n /// a single background consumer () dequeues and\n /// invokes handlers one at a time, preserving arrival order.\n /// \n private readonly Channel _eventChannel = Channel.CreateUnbounded(\n new() { SingleReader = true });\n\n /// \n /// Gets the unique identifier for this session.\n /// \n /// A string that uniquely identifies this session.\n public string SessionId { get; }\n\n /// \n /// Gets the typed RPC client for session-scoped methods.\n /// \n public SessionRpc Rpc => _sessionRpc ??= new SessionRpc(_rpc, SessionId);\n\n /// \n /// Gets the path to the session workspace directory when infinite sessions are enabled.\n /// \n /// \n /// The path to the workspace containing checkpoints/, plan.md, and files/ subdirectories,\n /// or null if infinite sessions are disabled.\n /// \n public string? WorkspacePath { get; internal set; }\n\n /// \n /// Gets the capabilities reported by the host for this session.\n /// \n /// \n /// A object describing what the host supports.\n /// Capabilities are populated from the session create/resume response and updated\n /// in real time via capabilities.changed events.\n /// \n public SessionCapabilities Capabilities { get; private set; } = new();\n\n /// \n /// Gets the UI API for eliciting information from the user during this session.\n /// \n /// \n /// An implementation with convenience methods for\n /// confirm, select, input, and custom elicitation dialogs.\n /// \n /// \n /// All methods on this property throw \n /// if the host does not report elicitation support via .\n /// Check session.Capabilities.Ui?.Elicitation == true before calling.\n /// \n public ISessionUiApi Ui { get; }\n\n internal ClientSessionApiHandlers ClientSessionApis { get; } = new();\n\n /// \n /// Initializes a new instance of the class.\n /// \n /// The unique identifier for this session.\n /// The JSON-RPC connection to the Copilot CLI.\n /// Logger for diagnostics.\n /// The workspace path if infinite sessions are enabled.\n /// \n /// This constructor is internal. Use to create sessions.\n /// \n internal CopilotSession(string sessionId, JsonRpc rpc, ILogger logger, string? workspacePath = null)\n {\n SessionId = sessionId;\n _rpc = rpc;\n _logger = logger;\n WorkspacePath = workspacePath;\n Ui = new SessionUiApiImpl(this);\n\n // Start the asynchronous processing loop.\n _ = ProcessEventsAsync();\n }\n\n private Task InvokeRpcAsync(string method, object?[]? args, CancellationToken cancellationToken)\n {\n return CopilotClient.InvokeRpcAsync(_rpc, method, args, cancellationToken);\n }\n\n /// \n /// Sends a message to the Copilot session and waits for the response.\n /// \n /// Options for the message to be sent, including the prompt and optional attachments.\n /// A that can be used to cancel the operation.\n /// A task that resolves with the ID of the response message, which can be used to correlate events.\n /// Thrown if the session has been disposed.\n /// \n /// \n /// This method returns immediately after the message is queued. Use \n /// if you need to wait for the assistant to finish processing.\n /// \n /// \n /// Subscribe to events via to receive streaming responses and other session events.\n /// \n /// \n /// \n /// \n /// var messageId = await session.SendAsync(new MessageOptions\n /// {\n /// Prompt = \"Explain this code\",\n /// Attachments = new List<Attachment>\n /// {\n /// new() { Type = \"file\", Path = \"./Program.cs\" }\n /// }\n /// });\n /// \n /// \n public async Task SendAsync(MessageOptions options, CancellationToken cancellationToken = default)\n {\n var (traceparent, tracestate) = TelemetryHelpers.GetTraceContext();\n\n var request = new SendMessageRequest\n {\n SessionId = SessionId,\n Prompt = options.Prompt,\n Attachments = options.Attachments,\n Mode = options.Mode,\n Traceparent = traceparent,\n Tracestate = tracestate,\n RequestHeaders = options.RequestHeaders,\n };\n\n var response = await InvokeRpcAsync(\n \"session.send\", [request], cancellationToken);\n\n return response.MessageId;\n }\n\n /// \n /// Sends a message to the Copilot session and waits until the session becomes idle.\n /// \n /// Options for the message to be sent, including the prompt and optional attachments.\n /// Timeout duration (default: 60 seconds). Controls how long to wait; does not abort in-flight agent work.\n /// A that can be used to cancel the operation.\n /// A task that resolves with the final assistant message event, or null if none was received.\n /// Thrown if the timeout is reached before the session becomes idle.\n /// Thrown if the is cancelled.\n /// Thrown if the session has been disposed.\n /// \n /// \n /// This is a convenience method that combines with waiting for\n /// the session.idle event. Use this when you want to block until the assistant\n /// has finished processing the message.\n /// \n /// \n /// Events are still delivered to handlers registered via while waiting.\n /// \n /// \n /// \n /// \n /// // Send and wait for completion with default 60s timeout\n /// var response = await session.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 2+2?\" });\n /// Console.WriteLine(response?.Data?.Content); // \"4\"\n /// \n /// \n public async Task SendAndWaitAsync(\n MessageOptions options,\n TimeSpan? timeout = null,\n CancellationToken cancellationToken = default)\n {\n var effectiveTimeout = timeout ?? TimeSpan.FromSeconds(60);\n var tcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n AssistantMessageEvent? lastAssistantMessage = null;\n\n void Handler(SessionEvent evt)\n {\n switch (evt)\n {\n case AssistantMessageEvent assistantMessage:\n lastAssistantMessage = assistantMessage;\n break;\n\n case SessionIdleEvent:\n tcs.TrySetResult(lastAssistantMessage);\n break;\n\n case SessionErrorEvent errorEvent:\n var message = errorEvent.Data?.Message ?? \"session error\";\n tcs.TrySetException(new InvalidOperationException($\"Session error: {message}\"));\n break;\n }\n }\n\n using var subscription = On(Handler);\n\n await SendAsync(options, cancellationToken);\n\n using var cts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);\n cts.CancelAfter(effectiveTimeout);\n\n using var registration = cts.Token.Register(() =>\n {\n if (cancellationToken.IsCancellationRequested)\n tcs.TrySetCanceled(cancellationToken);\n else\n tcs.TrySetException(new TimeoutException($\"SendAndWaitAsync timed out after {effectiveTimeout}\"));\n });\n return await tcs.Task;\n }\n\n /// \n /// Registers a callback for session events.\n /// \n /// A callback to be invoked when a session event occurs.\n /// An that, when disposed, unsubscribes the handler.\n /// \n /// \n /// Events include assistant messages, tool executions, errors, and session state changes.\n /// Multiple handlers can be registered and will all receive events.\n /// \n /// \n /// Handlers are invoked serially in event-arrival order on a background thread.\n /// A handler will never be called concurrently with itself or with other handlers\n /// on the same session.\n /// \n /// \n /// \n /// \n /// using var subscription = session.On(evt =>\n /// {\n /// switch (evt)\n /// {\n /// case AssistantMessageEvent:\n /// Console.WriteLine($\"Assistant: {evt.Data?.Content}\");\n /// break;\n /// case SessionErrorEvent:\n /// Console.WriteLine($\"Error: {evt.Data?.Message}\");\n /// break;\n /// }\n /// });\n ///\n /// // The handler is automatically unsubscribed when the subscription is disposed.\n /// \n /// \n public IDisposable On(SessionEventHandler handler)\n {\n ImmutableInterlocked.Update(ref _eventHandlers, array => array.Add(handler));\n return new ActionDisposable(() => ImmutableInterlocked.Update(ref _eventHandlers, array => array.Remove(handler)));\n }\n\n /// \n /// Enqueues an event for serial dispatch to all registered handlers.\n /// \n /// The session event to dispatch.\n /// \n /// This method is non-blocking. Broadcast request events (external_tool.requested,\n /// permission.requested) are fired concurrently so that a stalled handler does not\n /// block event delivery. The event is then placed into an in-memory channel and\n /// processed by a single background consumer (),\n /// which guarantees user handlers see events one at a time, in order.\n /// \n internal void DispatchEvent(SessionEvent sessionEvent)\n {\n // Fire broadcast work concurrently (fire-and-forget with error logging).\n // This is done outside the channel so broadcast handlers don't block the\n // consumer loop — important when a secondary client's handler intentionally\n // never completes (multi-client permission scenario).\n _ = HandleBroadcastEventAsync(sessionEvent);\n\n // Queue the event for serial processing by user handlers.\n _eventChannel.Writer.TryWrite(sessionEvent);\n }\n\n /// \n /// Single-reader consumer loop that processes events from the channel.\n /// Ensures user event handlers are invoked serially and in FIFO order.\n /// \n private async Task ProcessEventsAsync()\n {\n await foreach (var sessionEvent in _eventChannel.Reader.ReadAllAsync())\n {\n foreach (var handler in _eventHandlers)\n {\n try\n {\n handler(sessionEvent);\n }\n catch (Exception ex)\n {\n LogEventHandlerError(ex);\n }\n }\n }\n }\n\n /// \n /// Registers custom tool handlers for this session.\n /// \n /// A collection of AI functions that can be invoked by the assistant.\n /// \n /// Tools allow the assistant to execute custom functions. When the assistant invokes a tool,\n /// the corresponding handler is called with the tool arguments.\n /// \n internal void RegisterTools(ICollection tools)\n {\n _toolHandlers.Clear();\n foreach (var tool in tools)\n {\n _toolHandlers.Add(tool.Name, tool);\n }\n }\n\n /// \n /// Retrieves a registered tool by name.\n /// \n /// The name of the tool to retrieve.\n /// The tool if found; otherwise, null.\n internal AIFunction? GetTool(string name)\n {\n return _toolHandlers.TryGetValue(name, out var tool) ? tool : null;\n }\n\n /// \n /// Registers a handler for permission requests.\n /// \n /// The permission handler function.\n /// \n /// When the assistant needs permission to perform certain actions (e.g., file operations),\n /// this handler is called to approve or deny the request.\n /// \n internal void RegisterPermissionHandler(PermissionRequestHandler handler)\n {\n _permissionHandler = handler;\n }\n\n /// \n /// Handles a permission request from the Copilot CLI.\n /// \n /// The permission request data from the CLI.\n /// A task that resolves with the permission decision.\n internal async Task HandlePermissionRequestAsync(JsonElement permissionRequestData)\n {\n var handler = _permissionHandler;\n\n if (handler == null)\n {\n return new PermissionRequestResult\n {\n Kind = PermissionRequestResultKind.UserNotAvailable\n };\n }\n\n var request = JsonSerializer.Deserialize(permissionRequestData.GetRawText(), SessionEventsJsonContext.Default.PermissionRequest)\n ?? throw new InvalidOperationException(\"Failed to deserialize permission request\");\n\n var invocation = new PermissionInvocation\n {\n SessionId = SessionId\n };\n\n return await handler(request, invocation);\n }\n\n /// \n /// Handles broadcast request events by executing local handlers and responding via RPC.\n /// Implements the protocol v3 broadcast model where tool calls and permission requests\n /// are broadcast as session events to all clients.\n /// \n private async Task HandleBroadcastEventAsync(SessionEvent sessionEvent)\n {\n try\n {\n switch (sessionEvent)\n {\n case ExternalToolRequestedEvent toolEvent:\n {\n var data = toolEvent.Data;\n if (string.IsNullOrEmpty(data.RequestId) || string.IsNullOrEmpty(data.ToolName))\n return;\n\n var tool = GetTool(data.ToolName);\n if (tool is null)\n return; // This client doesn't handle this tool; another client will.\n\n using (TelemetryHelpers.RestoreTraceContext(data.Traceparent, data.Tracestate))\n await ExecuteToolAndRespondAsync(data.RequestId, data.ToolName, data.ToolCallId, data.Arguments, tool);\n break;\n }\n\n case PermissionRequestedEvent permEvent:\n {\n var data = permEvent.Data;\n if (string.IsNullOrEmpty(data.RequestId) || data.PermissionRequest is null)\n return;\n\n if (data.ResolvedByHook == true)\n return; // Already resolved by a permissionRequest hook; no client action needed.\n\n var handler = _permissionHandler;\n if (handler is null)\n return; // This client doesn't handle permissions; another client will.\n\n await ExecutePermissionAndRespondAsync(data.RequestId, data.PermissionRequest, handler);\n break;\n }\n\n case CommandExecuteEvent cmdEvent:\n {\n var data = cmdEvent.Data;\n if (string.IsNullOrEmpty(data.RequestId))\n return;\n\n await ExecuteCommandAndRespondAsync(data.RequestId, data.CommandName, data.Command, data.Args);\n break;\n }\n\n case ElicitationRequestedEvent elicitEvent:\n {\n var data = elicitEvent.Data;\n if (string.IsNullOrEmpty(data.RequestId))\n return;\n\n if (_elicitationHandler is not null)\n {\n var schema = data.RequestedSchema is not null\n ? new ElicitationSchema\n {\n Type = data.RequestedSchema.Type,\n Properties = data.RequestedSchema.Properties,\n Required = data.RequestedSchema.Required?.ToList()\n }\n : null;\n\n await HandleElicitationRequestAsync(\n new ElicitationContext\n {\n SessionId = SessionId,\n Message = data.Message,\n RequestedSchema = schema,\n Mode = data.Mode,\n ElicitationSource = data.ElicitationSource,\n Url = data.Url\n },\n data.RequestId);\n }\n break;\n }\n\n case CapabilitiesChangedEvent capEvent:\n {\n var data = capEvent.Data;\n Capabilities = new SessionCapabilities\n {\n Ui = data.Ui is not null\n ? new SessionUiCapabilities { Elicitation = data.Ui.Elicitation }\n : Capabilities.Ui\n };\n break;\n }\n }\n }\n catch (Exception ex) when (ex is not OperationCanceledException)\n {\n LogBroadcastHandlerError(ex);\n }\n }\n\n /// \n /// Executes a tool handler and sends the result back via the HandlePendingToolCall RPC.\n /// \n private async Task ExecuteToolAndRespondAsync(string requestId, string toolName, string toolCallId, object? arguments, AIFunction tool)\n {\n try\n {\n var invocation = new ToolInvocation\n {\n SessionId = SessionId,\n ToolCallId = toolCallId,\n ToolName = toolName,\n Arguments = arguments\n };\n\n var aiFunctionArgs = new AIFunctionArguments\n {\n Context = new Dictionary\n {\n [typeof(ToolInvocation)] = invocation\n }\n };\n\n if (arguments is not null)\n {\n if (arguments is not JsonElement incomingJsonArgs)\n {\n throw new InvalidOperationException($\"Incoming arguments must be a {nameof(JsonElement)}; received {arguments.GetType().Name}\");\n }\n\n foreach (var prop in incomingJsonArgs.EnumerateObject())\n {\n aiFunctionArgs[prop.Name] = prop.Value;\n }\n }\n\n var result = await tool.InvokeAsync(aiFunctionArgs);\n\n var toolResultObject = ToolResultObject.ConvertFromInvocationResult(result, tool.JsonSerializerOptions);\n\n await Rpc.Tools.HandlePendingToolCallAsync(requestId, toolResultObject, error: null);\n }\n catch (Exception ex)\n {\n try\n {\n await Rpc.Tools.HandlePendingToolCallAsync(requestId, result: null, error: ex.Message);\n }\n catch (IOException)\n {\n // Connection lost or RPC error — nothing we can do\n }\n catch (ObjectDisposedException)\n {\n // Connection already disposed — nothing we can do\n }\n }\n }\n\n /// \n /// Executes a permission handler and sends the result back via the HandlePendingPermissionRequest RPC.\n /// \n private async Task ExecutePermissionAndRespondAsync(string requestId, PermissionRequest permissionRequest, PermissionRequestHandler handler)\n {\n try\n {\n var invocation = new PermissionInvocation\n {\n SessionId = SessionId\n };\n\n var result = await handler(permissionRequest, invocation);\n if (result.Kind == new PermissionRequestResultKind(\"no-result\"))\n {\n return;\n }\n await Rpc.Permissions.HandlePendingPermissionRequestAsync(requestId, new PermissionDecision { Kind = result.Kind.Value });\n }\n catch (Exception)\n {\n try\n {\n await Rpc.Permissions.HandlePendingPermissionRequestAsync(requestId, new PermissionDecision\n {\n Kind = PermissionRequestResultKind.UserNotAvailable.Value\n });\n }\n catch (IOException)\n {\n // Connection lost or RPC error — nothing we can do\n }\n catch (ObjectDisposedException)\n {\n // Connection already disposed — nothing we can do\n }\n }\n }\n\n /// \n /// Registers a handler for user input requests from the agent.\n /// \n /// The handler to invoke when user input is requested.\n internal void RegisterUserInputHandler(UserInputHandler handler)\n {\n _userInputHandler = handler;\n }\n\n /// \n /// Registers command handlers for this session.\n /// \n /// The command definitions to register.\n internal void RegisterCommands(IEnumerable? commands)\n {\n _commandHandlers.Clear();\n if (commands is null) return;\n foreach (var cmd in commands)\n {\n _commandHandlers[cmd.Name] = cmd.Handler;\n }\n }\n\n /// \n /// Registers an elicitation handler for this session.\n /// \n /// The handler to invoke when an elicitation request is received.\n internal void RegisterElicitationHandler(ElicitationHandler? handler)\n {\n _elicitationHandler = handler;\n }\n\n /// \n /// Sets the capabilities reported by the host for this session.\n /// \n /// The capabilities to set.\n internal void SetCapabilities(SessionCapabilities? capabilities)\n {\n Capabilities = capabilities ?? new SessionCapabilities();\n }\n\n /// \n /// Dispatches a command.execute event to the registered handler and\n /// responds via the commands.handlePendingCommand RPC.\n /// \n private async Task ExecuteCommandAndRespondAsync(string requestId, string commandName, string command, string args)\n {\n if (!_commandHandlers.TryGetValue(commandName, out var handler))\n {\n try\n {\n await Rpc.Commands.HandlePendingCommandAsync(requestId, error: $\"Unknown command: {commandName}\");\n }\n catch (Exception ex) when (ex is IOException or ObjectDisposedException)\n {\n // Connection lost — nothing we can do\n }\n return;\n }\n\n try\n {\n await handler(new CommandContext\n {\n SessionId = SessionId,\n Command = command,\n CommandName = commandName,\n Args = args\n });\n await Rpc.Commands.HandlePendingCommandAsync(requestId);\n }\n catch (Exception error) when (error is not OperationCanceledException)\n {\n // User handler can throw any exception — report the error back to the server\n // so the pending command doesn't hang.\n var message = error.Message;\n try\n {\n await Rpc.Commands.HandlePendingCommandAsync(requestId, error: message);\n }\n catch (Exception ex) when (ex is IOException or ObjectDisposedException)\n {\n // Connection lost — nothing we can do\n }\n }\n }\n\n /// \n /// Dispatches an elicitation.requested event to the registered handler and\n /// responds via the ui.handlePendingElicitation RPC. Auto-cancels on handler errors.\n /// \n private async Task HandleElicitationRequestAsync(ElicitationContext context, string requestId)\n {\n var handler = _elicitationHandler;\n if (handler is null) return;\n\n try\n {\n var result = await handler(context);\n await Rpc.Ui.HandlePendingElicitationAsync(requestId, new UIElicitationResponse\n {\n Action = result.Action,\n Content = result.Content\n });\n }\n catch (Exception ex) when (ex is not OperationCanceledException)\n {\n // User handler can throw any exception — attempt to cancel so the request doesn't hang.\n try\n {\n await Rpc.Ui.HandlePendingElicitationAsync(requestId, new UIElicitationResponse\n {\n Action = UIElicitationResponseAction.Cancel\n });\n }\n catch (Exception innerEx) when (innerEx is IOException or ObjectDisposedException)\n {\n // Connection lost — nothing we can do\n }\n }\n }\n\n /// \n /// Throws if the host does not support elicitation.\n /// \n private void AssertElicitation()\n {\n if (Capabilities.Ui?.Elicitation != true)\n {\n throw new InvalidOperationException(\n \"Elicitation is not supported by the host. \" +\n \"Check session.Capabilities.Ui?.Elicitation before calling UI methods.\");\n }\n }\n\n /// \n /// Implements backed by the session's RPC connection.\n /// \n private sealed class SessionUiApiImpl(CopilotSession session) : ISessionUiApi\n {\n public async Task ElicitationAsync(ElicitationParams elicitationParams, CancellationToken cancellationToken)\n {\n session.AssertElicitation();\n var schema = new UIElicitationSchema\n {\n Type = elicitationParams.RequestedSchema.Type,\n Properties = elicitationParams.RequestedSchema.Properties,\n Required = elicitationParams.RequestedSchema.Required\n };\n var result = await session.Rpc.Ui.ElicitationAsync(elicitationParams.Message, schema, cancellationToken);\n return new ElicitationResult { Action = result.Action, Content = result.Content };\n }\n\n public async Task ConfirmAsync(string message, CancellationToken cancellationToken)\n {\n session.AssertElicitation();\n var schema = new UIElicitationSchema\n {\n Type = \"object\",\n Properties = new Dictionary\n {\n [\"confirmed\"] = new Dictionary { [\"type\"] = \"boolean\", [\"default\"] = true }\n },\n Required = [\"confirmed\"]\n };\n var result = await session.Rpc.Ui.ElicitationAsync(message, schema, cancellationToken);\n if (result.Action == UIElicitationResponseAction.Accept\n && result.Content != null\n && result.Content.TryGetValue(\"confirmed\", out var val))\n {\n return val switch\n {\n bool b => b,\n JsonElement { ValueKind: JsonValueKind.True } => true,\n JsonElement { ValueKind: JsonValueKind.False } => false,\n _ => false\n };\n }\n return false;\n }\n\n public async Task SelectAsync(string message, string[] options, CancellationToken cancellationToken)\n {\n session.AssertElicitation();\n var schema = new UIElicitationSchema\n {\n Type = \"object\",\n Properties = new Dictionary\n {\n [\"selection\"] = new Dictionary { [\"type\"] = \"string\", [\"enum\"] = options }\n },\n Required = [\"selection\"]\n };\n var result = await session.Rpc.Ui.ElicitationAsync(message, schema, cancellationToken);\n if (result.Action == UIElicitationResponseAction.Accept\n && result.Content != null\n && result.Content.TryGetValue(\"selection\", out var val))\n {\n return val switch\n {\n string s => s,\n JsonElement { ValueKind: JsonValueKind.String } je => je.GetString(),\n _ => val.ToString()\n };\n }\n return null;\n }\n\n public async Task InputAsync(string message, InputOptions? options, CancellationToken cancellationToken)\n {\n session.AssertElicitation();\n var field = new Dictionary { [\"type\"] = \"string\" };\n if (options?.Title != null) field[\"title\"] = options.Title;\n if (options?.Description != null) field[\"description\"] = options.Description;\n if (options?.MinLength != null) field[\"minLength\"] = options.MinLength;\n if (options?.MaxLength != null) field[\"maxLength\"] = options.MaxLength;\n if (options?.Format != null) field[\"format\"] = options.Format;\n if (options?.Default != null) field[\"default\"] = options.Default;\n\n var schema = new UIElicitationSchema\n {\n Type = \"object\",\n Properties = new Dictionary { [\"value\"] = field },\n Required = [\"value\"]\n };\n var result = await session.Rpc.Ui.ElicitationAsync(message, schema, cancellationToken);\n if (result.Action == UIElicitationResponseAction.Accept\n && result.Content != null\n && result.Content.TryGetValue(\"value\", out var val))\n {\n return val switch\n {\n string s => s,\n JsonElement { ValueKind: JsonValueKind.String } je => je.GetString(),\n _ => val.ToString()\n };\n }\n return null;\n }\n }\n\n /// \n /// Handles a user input request from the Copilot CLI.\n /// \n /// The user input request from the CLI.\n /// A task that resolves with the user's response.\n internal async Task HandleUserInputRequestAsync(UserInputRequest request)\n {\n var handler = _userInputHandler ?? throw new InvalidOperationException(\"No user input handler registered\");\n var invocation = new UserInputInvocation\n {\n SessionId = SessionId\n };\n\n return await handler(request, invocation);\n }\n\n /// \n /// Registers hook handlers for this session.\n /// \n /// The hooks configuration.\n internal void RegisterHooks(SessionHooks hooks)\n {\n _hooksLock.Wait();\n try\n {\n _hooks = hooks;\n }\n finally\n {\n _hooksLock.Release();\n }\n }\n\n /// \n /// Handles a hook invocation from the Copilot CLI.\n /// \n /// The type of hook to invoke.\n /// The hook input data.\n /// A task that resolves with the hook output.\n internal async Task HandleHooksInvokeAsync(string hookType, JsonElement input)\n {\n await _hooksLock.WaitAsync();\n SessionHooks? hooks;\n try\n {\n hooks = _hooks;\n }\n finally\n {\n _hooksLock.Release();\n }\n\n if (hooks == null)\n {\n return null;\n }\n\n var invocation = new HookInvocation\n {\n SessionId = SessionId\n };\n\n return hookType switch\n {\n \"preToolUse\" => hooks.OnPreToolUse != null\n ? await hooks.OnPreToolUse(\n JsonSerializer.Deserialize(input.GetRawText(), SessionJsonContext.Default.PreToolUseHookInput)!,\n invocation)\n : null,\n \"postToolUse\" => hooks.OnPostToolUse != null\n ? await hooks.OnPostToolUse(\n JsonSerializer.Deserialize(input.GetRawText(), SessionJsonContext.Default.PostToolUseHookInput)!,\n invocation)\n : null,\n \"userPromptSubmitted\" => hooks.OnUserPromptSubmitted != null\n ? await hooks.OnUserPromptSubmitted(\n JsonSerializer.Deserialize(input.GetRawText(), SessionJsonContext.Default.UserPromptSubmittedHookInput)!,\n invocation)\n : null,\n \"sessionStart\" => hooks.OnSessionStart != null\n ? await hooks.OnSessionStart(\n JsonSerializer.Deserialize(input.GetRawText(), SessionJsonContext.Default.SessionStartHookInput)!,\n invocation)\n : null,\n \"sessionEnd\" => hooks.OnSessionEnd != null\n ? await hooks.OnSessionEnd(\n JsonSerializer.Deserialize(input.GetRawText(), SessionJsonContext.Default.SessionEndHookInput)!,\n invocation)\n : null,\n \"errorOccurred\" => hooks.OnErrorOccurred != null\n ? await hooks.OnErrorOccurred(\n JsonSerializer.Deserialize(input.GetRawText(), SessionJsonContext.Default.ErrorOccurredHookInput)!,\n invocation)\n : null,\n _ => null\n };\n }\n\n /// \n /// Registers transform callbacks for system message sections.\n /// \n /// The transform callbacks keyed by section identifier.\n internal void RegisterTransformCallbacks(Dictionary>>? callbacks)\n {\n _transformCallbacksLock.Wait();\n try\n {\n _transformCallbacks = callbacks;\n }\n finally\n {\n _transformCallbacksLock.Release();\n }\n }\n\n /// \n /// Handles a systemMessage.transform RPC call from the Copilot CLI.\n /// \n /// The raw JSON element containing sections to transform.\n /// A task that resolves with the transformed sections.\n internal async Task HandleSystemMessageTransformAsync(JsonElement sections)\n {\n Dictionary>>? callbacks;\n await _transformCallbacksLock.WaitAsync();\n try\n {\n callbacks = _transformCallbacks;\n }\n finally\n {\n _transformCallbacksLock.Release();\n }\n\n var parsed = JsonSerializer.Deserialize(\n sections.GetRawText(),\n SessionJsonContext.Default.DictionaryStringSystemMessageTransformSection) ?? new();\n\n var result = new Dictionary();\n foreach (var (sectionId, data) in parsed)\n {\n Func>? callback = null;\n callbacks?.TryGetValue(sectionId, out callback);\n\n if (callback != null)\n {\n try\n {\n var transformed = await callback(data.Content ?? \"\");\n result[sectionId] = new SystemMessageTransformSection { Content = transformed };\n }\n catch\n {\n result[sectionId] = new SystemMessageTransformSection { Content = data.Content ?? \"\" };\n }\n }\n else\n {\n result[sectionId] = new SystemMessageTransformSection { Content = data.Content ?? \"\" };\n }\n }\n\n return new SystemMessageTransformRpcResponse { Sections = result };\n }\n\n /// \n /// Gets the complete list of messages and events in the session.\n /// \n /// A that can be used to cancel the operation.\n /// A task that, when resolved, gives the list of all session events in chronological order.\n /// Thrown if the session has been disposed.\n /// \n /// This returns the complete conversation history including user messages, assistant responses,\n /// tool executions, and other session events.\n /// \n /// \n /// \n /// var events = await session.GetMessagesAsync();\n /// foreach (var evt in events)\n /// {\n /// if (evt is AssistantMessageEvent)\n /// {\n /// Console.WriteLine($\"Assistant: {evt.Data?.Content}\");\n /// }\n /// }\n /// \n /// \n public async Task> GetMessagesAsync(CancellationToken cancellationToken = default)\n {\n var response = await InvokeRpcAsync(\n \"session.getMessages\", [new GetMessagesRequest { SessionId = SessionId }], cancellationToken);\n\n return response.Events\n .Select(e => SessionEvent.FromJson(e.ToJsonString()))\n .OfType()\n .ToList();\n }\n\n /// \n /// Aborts the currently processing message in this session.\n /// \n /// A that can be used to cancel the operation.\n /// A task representing the abort operation.\n /// Thrown if the session has been disposed.\n /// \n /// Use this to cancel a long-running request. The session remains valid and can continue\n /// to be used for new messages.\n /// \n /// \n /// \n /// // Start a long-running request\n /// var messageTask = session.SendAsync(new MessageOptions\n /// {\n /// Prompt = \"Write a very long story...\"\n /// });\n ///\n /// // Abort after 5 seconds\n /// await Task.Delay(TimeSpan.FromSeconds(5));\n /// await session.AbortAsync();\n /// \n /// \n public async Task AbortAsync(CancellationToken cancellationToken = default)\n {\n await InvokeRpcAsync(\n \"session.abort\", [new SessionAbortRequest { SessionId = SessionId }], cancellationToken);\n }\n\n /// \n /// Changes the model for this session.\n /// The new model takes effect for the next message. Conversation history is preserved.\n /// \n /// Model ID to switch to (e.g., \"gpt-4.1\").\n /// Reasoning effort level (e.g., \"low\", \"medium\", \"high\", \"xhigh\").\n /// Per-property overrides for model capabilities, deep-merged over runtime defaults.\n /// Optional cancellation token.\n /// \n /// \n /// await session.SetModelAsync(\"gpt-4.1\");\n /// await session.SetModelAsync(\"claude-sonnet-4.6\", \"high\");\n /// \n /// \n public async Task SetModelAsync(string model, string? reasoningEffort, ModelCapabilitiesOverride? modelCapabilities = null, CancellationToken cancellationToken = default)\n {\n await Rpc.Model.SwitchToAsync(model, reasoningEffort, modelCapabilities, cancellationToken);\n }\n\n /// \n /// Changes the model for this session.\n /// \n public Task SetModelAsync(string model, CancellationToken cancellationToken = default)\n {\n return SetModelAsync(model, reasoningEffort: null, modelCapabilities: null, cancellationToken);\n }\n\n /// \n /// Log a message to the session timeline.\n /// The message appears in the session event stream and is visible to SDK consumers\n /// and (for non-ephemeral messages) persisted to the session event log on disk.\n /// \n /// The message to log.\n /// Log level (default: info).\n /// When true, the message is not persisted to disk.\n /// Optional URL to associate with the log entry.\n /// Optional cancellation token.\n /// \n /// \n /// await session.LogAsync(\"Build completed successfully\");\n /// await session.LogAsync(\"Disk space low\", level: SessionLogLevel.Warning);\n /// await session.LogAsync(\"Connection failed\", level: SessionLogLevel.Error);\n /// await session.LogAsync(\"Temporary status\", ephemeral: true);\n /// \n /// \n public async Task LogAsync(string message, SessionLogLevel? level = null, bool? ephemeral = null, string? url = null, CancellationToken cancellationToken = default)\n {\n await Rpc.LogAsync(message, level, ephemeral, url, cancellationToken);\n }\n\n /// \n /// Closes this session and releases all in-memory resources (event handlers,\n /// tool handlers, permission handlers).\n /// \n /// A task representing the dispose operation.\n /// \n /// \n /// The caller should ensure the session is idle (e.g., \n /// has returned) before disposing. If the session is not idle, in-flight event handlers\n /// or tool handlers may observe failures.\n /// \n /// \n /// Session state on disk (conversation history, planning state, artifacts) is\n /// preserved, so the conversation can be resumed later by calling\n /// with the session ID. To\n /// permanently remove all session data including files on disk, use\n /// instead.\n /// \n /// \n /// After calling this method, the session object can no longer be used.\n /// \n /// \n /// \n /// \n /// // Using 'await using' for automatic disposal — session can still be resumed later\n /// await using var session = await client.CreateSessionAsync(new() { OnPermissionRequest = PermissionHandler.ApproveAll });\n ///\n /// // Or manually dispose\n /// var session2 = await client.CreateSessionAsync(new() { OnPermissionRequest = PermissionHandler.ApproveAll });\n /// // ... use the session ...\n /// await session2.DisposeAsync();\n /// \n /// \n public async ValueTask DisposeAsync()\n {\n if (Interlocked.Exchange(ref _isDisposed, 1) == 1)\n {\n return;\n }\n\n _eventChannel.Writer.TryComplete();\n\n try\n {\n await InvokeRpcAsync(\n \"session.destroy\", [new SessionDestroyRequest() { SessionId = SessionId }], CancellationToken.None);\n }\n catch (ObjectDisposedException)\n {\n // Connection was already disposed (e.g., client.StopAsync() was called first)\n }\n catch (IOException)\n {\n // Connection is broken or closed\n }\n\n _eventHandlers = ImmutableInterlocked.InterlockedExchange(ref _eventHandlers, ImmutableArray.Empty);\n _toolHandlers.Clear();\n _commandHandlers.Clear();\n\n _permissionHandler = null;\n _elicitationHandler = null;\n }\n\n [LoggerMessage(Level = LogLevel.Error, Message = \"Unhandled exception in broadcast event handler\")]\n private partial void LogBroadcastHandlerError(Exception exception);\n\n [LoggerMessage(Level = LogLevel.Error, Message = \"Unhandled exception in session event handler\")]\n private partial void LogEventHandlerError(Exception exception);\n\n internal record SendMessageRequest\n {\n public string SessionId { get; init; } = string.Empty;\n public string Prompt { get; init; } = string.Empty;\n public IList? Attachments { get; init; }\n public string? Mode { get; init; }\n public string? Traceparent { get; init; }\n public string? Tracestate { get; init; }\n public IDictionary? RequestHeaders { get; init; }\n }\n\n internal record SendMessageResponse\n {\n public string MessageId { get; init; } = string.Empty;\n }\n\n internal record GetMessagesRequest\n {\n public string SessionId { get; init; } = string.Empty;\n }\n\n internal record GetMessagesResponse\n {\n public IList Events { get => field ??= []; init; }\n }\n\n internal record SessionAbortRequest\n {\n public string SessionId { get; init; } = string.Empty;\n }\n\n internal record SessionDestroyRequest\n {\n public string SessionId { get; init; } = string.Empty;\n }\n\n [JsonSourceGenerationOptions(\n JsonSerializerDefaults.Web,\n AllowOutOfOrderMetadataProperties = true,\n NumberHandling = JsonNumberHandling.AllowReadingFromString,\n DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)]\n [JsonSerializable(typeof(GetMessagesRequest))]\n [JsonSerializable(typeof(GetMessagesResponse))]\n [JsonSerializable(typeof(SendMessageRequest))]\n [JsonSerializable(typeof(SendMessageResponse))]\n [JsonSerializable(typeof(SessionAbortRequest))]\n [JsonSerializable(typeof(SessionDestroyRequest))]\n [JsonSerializable(typeof(UserMessageAttachment))]\n [JsonSerializable(typeof(PreToolUseHookInput))]\n [JsonSerializable(typeof(PreToolUseHookOutput))]\n [JsonSerializable(typeof(PostToolUseHookInput))]\n [JsonSerializable(typeof(PostToolUseHookOutput))]\n [JsonSerializable(typeof(UserPromptSubmittedHookInput))]\n [JsonSerializable(typeof(UserPromptSubmittedHookOutput))]\n [JsonSerializable(typeof(SessionStartHookInput))]\n [JsonSerializable(typeof(SessionStartHookOutput))]\n [JsonSerializable(typeof(SessionEndHookInput))]\n [JsonSerializable(typeof(SessionEndHookOutput))]\n [JsonSerializable(typeof(ErrorOccurredHookInput))]\n [JsonSerializable(typeof(ErrorOccurredHookOutput))]\n [JsonSerializable(typeof(SystemMessageTransformSection))]\n [JsonSerializable(typeof(SystemMessageTransformRpcResponse))]\n [JsonSerializable(typeof(Dictionary))]\n internal partial class SessionJsonContext : JsonSerializerContext;\n}\n" }, { "path": "dotnet/src/SessionFsProvider.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Rpc;\n\nnamespace GitHub.Copilot.SDK;\n\n/// \n/// Base class for session filesystem providers. Subclasses override the\n/// virtual methods and use normal C# patterns (return values, throw exceptions).\n/// The base class catches exceptions and converts them to \n/// results expected by the runtime.\n/// \npublic abstract class SessionFsProvider : ISessionFsHandler\n{\n /// Reads the full content of a file. Throw if the file does not exist.\n /// SessionFs-relative path.\n /// Cancellation token.\n /// The file content as a UTF-8 string.\n protected abstract Task ReadFileAsync(string path, CancellationToken cancellationToken);\n\n /// Writes content to a file, creating it (and parent directories) if needed.\n /// SessionFs-relative path.\n /// Content to write.\n /// Optional POSIX-style permission mode. Null means use OS default.\n /// Cancellation token.\n protected abstract Task WriteFileAsync(string path, string content, int? mode, CancellationToken cancellationToken);\n\n /// Appends content to a file, creating it (and parent directories) if needed.\n /// SessionFs-relative path.\n /// Content to append.\n /// Optional POSIX-style permission mode. Null means use OS default.\n /// Cancellation token.\n protected abstract Task AppendFileAsync(string path, string content, int? mode, CancellationToken cancellationToken);\n\n /// Checks whether a path exists.\n /// SessionFs-relative path.\n /// Cancellation token.\n /// true if the path exists, false otherwise.\n protected abstract Task ExistsAsync(string path, CancellationToken cancellationToken);\n\n /// Gets metadata about a file or directory. Throw if the path does not exist.\n /// SessionFs-relative path.\n /// Cancellation token.\n protected abstract Task StatAsync(string path, CancellationToken cancellationToken);\n\n /// Creates a directory (and optionally parents). Does not fail if it already exists.\n /// SessionFs-relative path.\n /// Whether to create parent directories.\n /// Optional POSIX-style permission mode (e.g., 0x1FF for 0777). Null means use OS default.\n /// Cancellation token.\n protected abstract Task MkdirAsync(string path, bool recursive, int? mode, CancellationToken cancellationToken);\n\n /// Lists entry names in a directory. Throw if the directory does not exist.\n /// SessionFs-relative path.\n /// Cancellation token.\n protected abstract Task> ReaddirAsync(string path, CancellationToken cancellationToken);\n\n /// Lists entries with type info in a directory. Throw if the directory does not exist.\n /// SessionFs-relative path.\n /// Cancellation token.\n protected abstract Task> ReaddirWithTypesAsync(string path, CancellationToken cancellationToken);\n\n /// Removes a file or directory. Throw if the path does not exist (unless is true).\n /// SessionFs-relative path.\n /// Whether to remove directory contents recursively.\n /// If true, do not throw when the path does not exist.\n /// Cancellation token.\n protected abstract Task RmAsync(string path, bool recursive, bool force, CancellationToken cancellationToken);\n\n /// Renames/moves a file or directory.\n /// Source path.\n /// Destination path.\n /// Cancellation token.\n protected abstract Task RenameAsync(string src, string dest, CancellationToken cancellationToken);\n\n // ---- ISessionFsHandler implementation (private, handles error mapping) ----\n\n async Task ISessionFsHandler.ReadFileAsync(SessionFsReadFileRequest request, CancellationToken cancellationToken)\n {\n try\n {\n var content = await ReadFileAsync(request.Path, cancellationToken).ConfigureAwait(false);\n return new SessionFsReadFileResult { Content = content };\n }\n catch (Exception ex)\n {\n return new SessionFsReadFileResult { Error = ToSessionFsError(ex) };\n }\n }\n\n async Task ISessionFsHandler.WriteFileAsync(SessionFsWriteFileRequest request, CancellationToken cancellationToken)\n {\n try\n {\n await WriteFileAsync(request.Path, request.Content, (int?)request.Mode, cancellationToken).ConfigureAwait(false);\n return null;\n }\n catch (Exception ex)\n {\n return ToSessionFsError(ex);\n }\n }\n\n async Task ISessionFsHandler.AppendFileAsync(SessionFsAppendFileRequest request, CancellationToken cancellationToken)\n {\n try\n {\n await AppendFileAsync(request.Path, request.Content, (int?)request.Mode, cancellationToken).ConfigureAwait(false);\n return null;\n }\n catch (Exception ex)\n {\n return ToSessionFsError(ex);\n }\n }\n\n async Task ISessionFsHandler.ExistsAsync(SessionFsExistsRequest request, CancellationToken cancellationToken)\n {\n try\n {\n var exists = await ExistsAsync(request.Path, cancellationToken).ConfigureAwait(false);\n return new SessionFsExistsResult { Exists = exists };\n }\n catch\n {\n return new SessionFsExistsResult { Exists = false };\n }\n }\n\n async Task ISessionFsHandler.StatAsync(SessionFsStatRequest request, CancellationToken cancellationToken)\n {\n try\n {\n return await StatAsync(request.Path, cancellationToken).ConfigureAwait(false);\n }\n catch (Exception ex)\n {\n return new SessionFsStatResult { Error = ToSessionFsError(ex) };\n }\n }\n\n async Task ISessionFsHandler.MkdirAsync(SessionFsMkdirRequest request, CancellationToken cancellationToken)\n {\n try\n {\n await MkdirAsync(request.Path, request.Recursive ?? false, (int?)request.Mode, cancellationToken).ConfigureAwait(false);\n return null;\n }\n catch (Exception ex)\n {\n return ToSessionFsError(ex);\n }\n }\n\n async Task ISessionFsHandler.ReaddirAsync(SessionFsReaddirRequest request, CancellationToken cancellationToken)\n {\n try\n {\n var entries = await ReaddirAsync(request.Path, cancellationToken).ConfigureAwait(false);\n return new SessionFsReaddirResult { Entries = entries };\n }\n catch (Exception ex)\n {\n return new SessionFsReaddirResult { Error = ToSessionFsError(ex) };\n }\n }\n\n async Task ISessionFsHandler.ReaddirWithTypesAsync(SessionFsReaddirWithTypesRequest request, CancellationToken cancellationToken)\n {\n try\n {\n var entries = await ReaddirWithTypesAsync(request.Path, cancellationToken).ConfigureAwait(false);\n return new SessionFsReaddirWithTypesResult { Entries = entries };\n }\n catch (Exception ex)\n {\n return new SessionFsReaddirWithTypesResult { Error = ToSessionFsError(ex) };\n }\n }\n\n async Task ISessionFsHandler.RmAsync(SessionFsRmRequest request, CancellationToken cancellationToken)\n {\n try\n {\n await RmAsync(request.Path, request.Recursive ?? false, request.Force ?? false, cancellationToken).ConfigureAwait(false);\n return null;\n }\n catch (Exception ex)\n {\n return ToSessionFsError(ex);\n }\n }\n\n async Task ISessionFsHandler.RenameAsync(SessionFsRenameRequest request, CancellationToken cancellationToken)\n {\n try\n {\n await RenameAsync(request.Src, request.Dest, cancellationToken).ConfigureAwait(false);\n return null;\n }\n catch (Exception ex)\n {\n return ToSessionFsError(ex);\n }\n }\n\n private static SessionFsError ToSessionFsError(Exception ex)\n {\n var code = ex is FileNotFoundException or DirectoryNotFoundException\n ? SessionFsErrorCode.ENOENT\n : SessionFsErrorCode.UNKNOWN;\n return new SessionFsError { Code = code, Message = ex.Message };\n }\n}\n" }, { "path": "dotnet/src/Telemetry.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.Diagnostics;\n\nnamespace GitHub.Copilot.SDK;\n\ninternal static class TelemetryHelpers\n{\n internal static (string? Traceparent, string? Tracestate) GetTraceContext()\n {\n return Activity.Current is { } activity\n ? (activity.Id, activity.TraceStateString)\n : (null, null);\n }\n\n /// \n /// Sets to reflect the trace context from the given\n /// W3C / headers.\n /// The runtime already owns the execute_tool span; this just ensures\n /// user code runs under the correct parent so any child activities are properly parented.\n /// Dispose the returned to restore the previous .\n /// \n /// \n /// Because this Activity is not created via an , it will not\n /// be sampled or exported by any standard OpenTelemetry exporter — it is invisible in\n /// trace backends. It exists only to carry the remote parent context through\n /// so that child activities created by user tool\n /// handlers are parented to the CLI's span.\n /// \n internal static Activity? RestoreTraceContext(string? traceparent, string? tracestate)\n {\n if (traceparent is not null &&\n ActivityContext.TryParse(traceparent, tracestate, out ActivityContext parent))\n {\n Activity activity = new(\"copilot.tool_handler\");\n activity.SetParentId(parent.TraceId, parent.SpanId, parent.TraceFlags);\n if (tracestate is not null)\n {\n activity.TraceStateString = tracestate;\n }\n\n activity.Start();\n\n return activity;\n }\n\n return null;\n }\n}\n" }, { "path": "dotnet/src/Types.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.ComponentModel;\nusing System.Diagnostics;\nusing System.Diagnostics.CodeAnalysis;\nusing System.Text.Json;\nusing System.Text.Json.Serialization;\nusing GitHub.Copilot.SDK.Rpc;\nusing Microsoft.Extensions.AI;\nusing Microsoft.Extensions.Logging;\n\nnamespace GitHub.Copilot.SDK;\n\n/// \n/// Represents the connection state of the Copilot client.\n/// \n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum ConnectionState\n{\n /// The client is not connected to the server.\n [JsonStringEnumMemberName(\"disconnected\")]\n Disconnected,\n /// The client is establishing a connection to the server.\n [JsonStringEnumMemberName(\"connecting\")]\n Connecting,\n /// The client is connected and ready to communicate.\n [JsonStringEnumMemberName(\"connected\")]\n Connected,\n /// The connection is in an error state.\n [JsonStringEnumMemberName(\"error\")]\n Error\n}\n\n/// \n/// Configuration options for creating a instance.\n/// \npublic class CopilotClientOptions\n{\n /// \n /// Initializes a new instance of the class.\n /// \n public CopilotClientOptions() { }\n\n /// \n /// Initializes a new instance of the class\n /// by copying the properties of the specified instance.\n /// \n protected CopilotClientOptions(CopilotClientOptions? other)\n {\n if (other is null) return;\n\n AutoStart = other.AutoStart;\n#pragma warning disable CS0618 // Obsolete member\n AutoRestart = other.AutoRestart;\n#pragma warning restore CS0618\n CliArgs = (string[]?)other.CliArgs?.Clone();\n CliPath = other.CliPath;\n CliUrl = other.CliUrl;\n Cwd = other.Cwd;\n Environment = other.Environment;\n GitHubToken = other.GitHubToken;\n Logger = other.Logger;\n LogLevel = other.LogLevel;\n Port = other.Port;\n Telemetry = other.Telemetry;\n UseLoggedInUser = other.UseLoggedInUser;\n UseStdio = other.UseStdio;\n OnListModels = other.OnListModels;\n SessionFs = other.SessionFs;\n SessionIdleTimeoutSeconds = other.SessionIdleTimeoutSeconds;\n }\n\n /// \n /// Path to the Copilot CLI executable. If not specified, uses the bundled CLI from the SDK.\n /// \n public string? CliPath { get; set; }\n /// \n /// Additional command-line arguments to pass to the CLI process.\n /// \n public string[]? CliArgs { get; set; }\n /// \n /// Working directory for the CLI process.\n /// \n public string? Cwd { get; set; }\n /// \n /// Port number for the CLI server when not using stdio transport.\n /// \n public int Port { get; set; }\n /// \n /// Whether to use stdio transport for communication with the CLI server.\n /// \n public bool UseStdio { get; set; } = true;\n /// \n /// URL of an existing CLI server to connect to instead of starting a new one.\n /// \n public string? CliUrl { get; set; }\n /// \n /// Log level for the CLI server (e.g., \"info\", \"debug\", \"warn\", \"error\").\n /// \n public string LogLevel { get; set; } = \"info\";\n /// \n /// Whether to automatically start the CLI server if it is not already running.\n /// \n public bool AutoStart { get; set; } = true;\n /// \n /// Obsolete. This option has no effect.\n /// \n [Obsolete(\"AutoRestart has no effect and will be removed in a future release.\")]\n public bool AutoRestart { get; set; }\n /// \n /// Environment variables to pass to the CLI process.\n /// \n public IReadOnlyDictionary? Environment { get; set; }\n /// \n /// Logger instance for SDK diagnostic output.\n /// \n public ILogger? Logger { get; set; }\n\n /// \n /// GitHub token to use for authentication.\n /// When provided, the token is passed to the CLI server via environment variable.\n /// This takes priority over other authentication methods.\n /// \n public string? GitHubToken { get; set; }\n\n /// \n /// Obsolete. Use instead.\n /// \n [EditorBrowsable(EditorBrowsableState.Never)]\n [Obsolete(\"Use GitHubToken instead.\", error: false)]\n public string? GithubToken\n {\n get => GitHubToken;\n set => GitHubToken = value;\n }\n\n /// \n /// Whether to use the logged-in user for authentication.\n /// When true, the CLI server will attempt to use stored OAuth tokens or gh CLI auth.\n /// When false, only explicit tokens (GitHubToken or environment variables) are used.\n /// Default: true (but defaults to false when GitHubToken is provided).\n /// \n public bool? UseLoggedInUser { get; set; }\n\n /// \n /// Custom handler for listing available models.\n /// When provided, ListModelsAsync() calls this handler instead of\n /// querying the CLI server. Useful in BYOK mode to return models\n /// available from your custom provider.\n /// \n public Func>>? OnListModels { get; set; }\n\n /// \n /// Custom session filesystem provider configuration.\n /// When set, the client registers as the session filesystem provider on connect,\n /// routing session-scoped file I/O through per-session handlers created via\n /// or .\n /// \n public SessionFsConfig? SessionFs { get; set; }\n\n /// \n /// OpenTelemetry configuration for the CLI server.\n /// When set to a non- instance, the CLI server is started with OpenTelemetry instrumentation enabled.\n /// \n public TelemetryConfig? Telemetry { get; set; }\n\n /// \n /// Server-wide idle timeout for sessions in seconds.\n /// Sessions without activity for this duration are automatically cleaned up.\n /// Set to 0 or leave as to disable (sessions live indefinitely).\n /// This option is only used when the SDK spawns the CLI process; it is ignored\n /// when connecting to an external server via .\n /// \n public int? SessionIdleTimeoutSeconds { get; set; }\n\n /// \n /// Creates a shallow clone of this instance.\n /// \n /// \n /// Mutable collection properties are copied into new collection instances so that modifications\n /// to those collections on the clone do not affect the original.\n /// Other reference-type properties (for example delegates and the logger) are not\n /// deep-cloned; the original and the clone will share those objects.\n /// \n public virtual CopilotClientOptions Clone()\n {\n return new(this);\n }\n}\n\n/// \n/// OpenTelemetry configuration for the Copilot CLI server.\n/// \npublic sealed class TelemetryConfig\n{\n /// \n /// OTLP exporter endpoint URL.\n /// \n /// \n /// Maps to the OTEL_EXPORTER_OTLP_ENDPOINT environment variable.\n /// \n public string? OtlpEndpoint { get; set; }\n\n /// \n /// File path for the file exporter.\n /// \n /// \n /// Maps to the COPILOT_OTEL_FILE_EXPORTER_PATH environment variable.\n /// \n public string? FilePath { get; set; }\n\n /// \n /// Exporter type (\"otlp-http\" or \"file\").\n /// \n /// \n /// Maps to the COPILOT_OTEL_EXPORTER_TYPE environment variable.\n /// \n public string? ExporterType { get; set; }\n\n /// \n /// Source name for telemetry spans.\n /// \n /// \n /// Maps to the COPILOT_OTEL_SOURCE_NAME environment variable.\n /// \n public string? SourceName { get; set; }\n\n /// \n /// Whether to capture message content as part of telemetry.\n /// \n /// \n /// Maps to the OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT environment variable.\n /// \n public bool? CaptureContent { get; set; }\n}\n\n/// \n/// Configuration for a custom session filesystem provider.\n/// \npublic sealed class SessionFsConfig\n{\n /// \n /// Initial working directory for sessions (user's project directory).\n /// \n public required string InitialCwd { get; init; }\n\n /// \n /// Path within each session's SessionFs where the runtime stores\n /// session-scoped files (events, workspace, checkpoints, and temp files).\n /// \n public required string SessionStatePath { get; init; }\n\n /// \n /// Path conventions used by this filesystem provider.\n /// \n public required SessionFsSetProviderConventions Conventions { get; init; }\n}\n\n/// \n/// Represents a binary result returned by a tool invocation.\n/// \npublic class ToolBinaryResult\n{\n /// \n /// Base64-encoded binary data.\n /// \n [JsonPropertyName(\"data\")]\n public string Data { get; set; } = string.Empty;\n\n /// \n /// MIME type of the binary data (e.g., \"image/png\").\n /// \n [JsonPropertyName(\"mimeType\")]\n public string MimeType { get; set; } = string.Empty;\n\n /// \n /// Type identifier for the binary result.\n /// \n [JsonPropertyName(\"type\")]\n public string Type { get; set; } = string.Empty;\n\n /// \n /// Optional human-readable description of the binary result.\n /// \n [JsonPropertyName(\"description\")]\n public string? Description { get; set; }\n}\n\n/// \n/// Represents the structured result of a tool execution.\n/// \npublic class ToolResultObject\n{\n /// \n /// Text result to be consumed by the language model.\n /// \n [JsonPropertyName(\"textResultForLlm\")]\n public string TextResultForLlm { get; set; } = string.Empty;\n\n /// \n /// Binary results (e.g., images) to be consumed by the language model.\n /// \n [JsonPropertyName(\"binaryResultsForLlm\")]\n public IList? BinaryResultsForLlm { get; set; }\n\n /// \n /// Result type indicator.\n /// \n /// \"success\" — the tool executed successfully.\n /// \"failure\" — the tool encountered an error.\n /// \"rejected\" — the tool invocation was rejected.\n /// \"denied\" — the tool invocation was denied by a permission check.\n /// \n /// \n [JsonPropertyName(\"resultType\")]\n public string ResultType { get; set; } = \"success\";\n\n /// \n /// Error message if the tool execution failed.\n /// \n [JsonPropertyName(\"error\")]\n public string? Error { get; set; }\n\n /// \n /// Log entry for the session history.\n /// \n [JsonPropertyName(\"sessionLog\")]\n public string? SessionLog { get; set; }\n\n /// \n /// Custom telemetry data associated with the tool execution.\n /// \n [JsonPropertyName(\"toolTelemetry\")]\n public IDictionary? ToolTelemetry { get; set; }\n\n /// \n /// Converts the result of an invocation into a\n /// . Handles ,\n /// , and falls back to JSON serialization.\n /// \n internal static ToolResultObject ConvertFromInvocationResult(object? result, JsonSerializerOptions jsonOptions)\n {\n if (result is ToolResultAIContent trac)\n {\n return trac.Result;\n }\n\n if (TryConvertFromAIContent(result) is { } aiConverted)\n {\n return aiConverted;\n }\n\n return new ToolResultObject\n {\n ResultType = \"success\",\n TextResultForLlm = result is JsonElement { ValueKind: JsonValueKind.String } je\n ? je.GetString()!\n : JsonSerializer.Serialize(result, jsonOptions.GetTypeInfo(typeof(object))),\n };\n }\n\n /// \n /// Attempts to convert a result from an invocation into a\n /// . Handles ,\n /// , and collections of .\n /// Returns if the value is not a recognized type.\n /// \n internal static ToolResultObject? TryConvertFromAIContent(object? result)\n {\n if (result is AIContent singleContent)\n {\n return ConvertAIContents([singleContent]);\n }\n\n if (result is IEnumerable contentList)\n {\n return ConvertAIContents(contentList);\n }\n\n return null;\n }\n\n private static ToolResultObject ConvertAIContents(IEnumerable contents)\n {\n List? textParts = null;\n List? binaryResults = null;\n\n foreach (var content in contents)\n {\n switch (content)\n {\n case TextContent textContent:\n if (textContent.Text is { } text)\n {\n (textParts ??= []).Add(text);\n }\n break;\n\n case DataContent dataContent:\n (binaryResults ??= []).Add(new ToolBinaryResult\n {\n Data = dataContent.Base64Data.ToString(),\n MimeType = dataContent.MediaType ?? \"application/octet-stream\",\n Type = dataContent.HasTopLevelMediaType(\"image\") ? \"image\" : \"resource\",\n });\n break;\n\n default:\n (textParts ??= []).Add(SerializeAIContent(content));\n break;\n }\n }\n\n return new ToolResultObject\n {\n TextResultForLlm = textParts is not null ? string.Join(\"\\n\", textParts) : \"\",\n ResultType = \"success\",\n BinaryResultsForLlm = binaryResults,\n };\n }\n\n private static string SerializeAIContent(AIContent content) =>\n JsonSerializer.Serialize(content, AIJsonUtilities.DefaultOptions.GetTypeInfo(typeof(AIContent)));\n}\n\n/// \n/// Contains context for a tool invocation callback.\n/// \npublic class ToolInvocation\n{\n /// \n /// Identifier of the session that triggered the tool call.\n /// \n public string SessionId { get; set; } = string.Empty;\n /// \n /// Unique identifier of this specific tool call.\n /// \n public string ToolCallId { get; set; } = string.Empty;\n /// \n /// Name of the tool being invoked.\n /// \n public string ToolName { get; set; } = string.Empty;\n /// \n /// Arguments passed to the tool by the language model.\n /// \n public object? Arguments { get; set; }\n}\n\n/// \n/// Delegate for handling tool invocations and returning a result.\n/// \npublic delegate Task ToolHandler(ToolInvocation invocation);\n\n/// Describes the kind of a permission request result.\n[JsonConverter(typeof(PermissionRequestResultKind.Converter))]\n[DebuggerDisplay(\"{Value,nq}\")]\npublic readonly struct PermissionRequestResultKind : IEquatable\n{\n /// Gets the kind indicating the permission was approved for this one instance.\n public static PermissionRequestResultKind Approved { get; } = new(\"approve-once\");\n\n /// Gets the kind indicating the permission was denied interactively by the user.\n public static PermissionRequestResultKind Rejected { get; } = new(\"reject\");\n\n /// Gets the kind indicating the permission was denied because user confirmation was unavailable.\n public static PermissionRequestResultKind UserNotAvailable { get; } = new(\"user-not-available\");\n\n /// Gets the kind indicating no permission decision was made.\n public static PermissionRequestResultKind NoResult { get; } = new(\"no-result\");\n\n /// Deprecated. Use instead.\n [Obsolete(\"Use Rejected instead.\")]\n public static PermissionRequestResultKind DeniedInteractivelyByUser => Rejected;\n\n /// Deprecated. Use instead.\n [Obsolete(\"Use UserNotAvailable instead.\")]\n public static PermissionRequestResultKind DeniedCouldNotRequestFromUser => UserNotAvailable;\n\n /// Deprecated. Use instead.\n [Obsolete(\"Use UserNotAvailable instead.\")]\n public static PermissionRequestResultKind DeniedByRules => UserNotAvailable;\n\n /// Gets the underlying string value of this .\n public string Value => _value ?? string.Empty;\n\n private readonly string? _value;\n\n /// Initializes a new instance of the struct.\n /// The string value for this kind.\n [JsonConstructor]\n public PermissionRequestResultKind(string value) => _value = value;\n\n /// \n public static bool operator ==(PermissionRequestResultKind left, PermissionRequestResultKind right) => left.Equals(right);\n\n /// \n public static bool operator !=(PermissionRequestResultKind left, PermissionRequestResultKind right) => !left.Equals(right);\n\n /// \n public override bool Equals([NotNullWhen(true)] object? obj) => obj is PermissionRequestResultKind other && Equals(other);\n\n /// \n public bool Equals(PermissionRequestResultKind other) => string.Equals(Value, other.Value, StringComparison.OrdinalIgnoreCase);\n\n /// \n public override int GetHashCode() => StringComparer.OrdinalIgnoreCase.GetHashCode(Value);\n\n /// \n public override string ToString() => Value;\n\n /// Provides a for serializing instances.\n [EditorBrowsable(EditorBrowsableState.Never)]\n public sealed class Converter : JsonConverter\n {\n /// \n public override PermissionRequestResultKind Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)\n {\n if (reader.TokenType != JsonTokenType.String)\n {\n throw new JsonException(\"Expected string for PermissionRequestResultKind.\");\n }\n\n var value = reader.GetString();\n if (value is null)\n {\n throw new JsonException(\"PermissionRequestResultKind value cannot be null.\");\n }\n\n return new PermissionRequestResultKind(value);\n }\n\n /// \n public override void Write(Utf8JsonWriter writer, PermissionRequestResultKind value, JsonSerializerOptions options) =>\n writer.WriteStringValue(value.Value);\n }\n}\n\n/// \n/// Result of a permission request evaluation.\n/// \npublic class PermissionRequestResult\n{\n /// \n /// Permission decision kind.\n /// \n /// \"approved\" — the operation is allowed.\n /// \"denied-by-rules\" — denied by configured permission rules.\n /// \"denied-interactively-by-user\" — the user explicitly denied the request.\n /// \"denied-no-approval-rule-and-could-not-request-from-user\" — no rule matched and user approval was unavailable.\n /// \"no-result\" — leave the pending permission request unanswered.\n /// \n /// \n [JsonPropertyName(\"kind\")]\n public PermissionRequestResultKind Kind { get; set; }\n\n /// \n /// Permission rules to apply for the decision.\n /// \n [JsonPropertyName(\"rules\")]\n public IList? Rules { get; set; }\n}\n\n/// \n/// Contains context for a permission request callback.\n/// \npublic class PermissionInvocation\n{\n /// \n /// Identifier of the session that triggered the permission request.\n /// \n public string SessionId { get; set; } = string.Empty;\n}\n\n/// \n/// Delegate for handling permission requests and returning a decision.\n/// \npublic delegate Task PermissionRequestHandler(PermissionRequest request, PermissionInvocation invocation);\n\n// ============================================================================\n// User Input Handler Types\n// ============================================================================\n\n/// \n/// Request for user input from the agent.\n/// \npublic class UserInputRequest\n{\n /// \n /// The question to ask the user.\n /// \n [JsonPropertyName(\"question\")]\n public string Question { get; set; } = string.Empty;\n\n /// \n /// Optional choices for multiple choice questions.\n /// \n [JsonPropertyName(\"choices\")]\n public IList? Choices { get; set; }\n\n /// \n /// Whether freeform text input is allowed.\n /// \n [JsonPropertyName(\"allowFreeform\")]\n public bool? AllowFreeform { get; set; }\n}\n\n/// \n/// Response to a user input request.\n/// \npublic class UserInputResponse\n{\n /// \n /// The user's answer.\n /// \n [JsonPropertyName(\"answer\")]\n public string Answer { get; set; } = string.Empty;\n\n /// \n /// Whether the answer was freeform (not from the provided choices).\n /// \n [JsonPropertyName(\"wasFreeform\")]\n public bool WasFreeform { get; set; }\n}\n\n/// \n/// Context for a user input request invocation.\n/// \npublic class UserInputInvocation\n{\n /// \n /// Identifier of the session that triggered the user input request.\n /// \n public string SessionId { get; set; } = string.Empty;\n}\n\n/// \n/// Handler for user input requests from the agent.\n/// \npublic delegate Task UserInputHandler(UserInputRequest request, UserInputInvocation invocation);\n\n// ============================================================================\n// Command Handler Types\n// ============================================================================\n\n/// \n/// Defines a slash-command that users can invoke from the CLI TUI.\n/// \npublic class CommandDefinition\n{\n /// \n /// Command name (without leading /). For example, \"deploy\".\n /// \n public required string Name { get; set; }\n\n /// \n /// Human-readable description shown in the command completion UI.\n /// \n public string? Description { get; set; }\n\n /// \n /// Handler invoked when the command is executed.\n /// \n public required CommandHandler Handler { get; set; }\n}\n\n/// \n/// Context passed to a when a command is executed.\n/// \npublic class CommandContext\n{\n /// \n /// Session ID where the command was invoked.\n /// \n public string SessionId { get; set; } = string.Empty;\n\n /// \n /// The full command text (e.g., /deploy production).\n /// \n public string Command { get; set; } = string.Empty;\n\n /// \n /// Command name without leading /.\n /// \n public string CommandName { get; set; } = string.Empty;\n\n /// \n /// Raw argument string after the command name.\n /// \n public string Args { get; set; } = string.Empty;\n}\n\n/// \n/// Delegate for handling slash-command executions.\n/// \npublic delegate Task CommandHandler(CommandContext context);\n\n// ============================================================================\n// Elicitation Types (UI — client → server)\n// ============================================================================\n\n/// \n/// JSON Schema describing the form fields to present for an elicitation dialog.\n/// \npublic class ElicitationSchema\n{\n /// \n /// Schema type indicator (always \"object\").\n /// \n [JsonPropertyName(\"type\")]\n public string Type { get; set; } = \"object\";\n\n /// \n /// Form field definitions, keyed by field name.\n /// \n [JsonPropertyName(\"properties\")]\n public IDictionary Properties { get => field ??= new Dictionary(); set; }\n\n /// \n /// List of required field names.\n /// \n [JsonPropertyName(\"required\")]\n public IList? Required { get; set; }\n}\n\n/// \n/// Parameters for an elicitation request sent from the SDK to the server.\n/// \npublic class ElicitationParams\n{\n /// \n /// Message describing what information is needed from the user.\n /// \n public required string Message { get; set; }\n\n /// \n /// JSON Schema describing the form fields to present.\n /// \n public required ElicitationSchema RequestedSchema { get; set; }\n}\n\n/// \n/// Result returned from an elicitation dialog.\n/// \npublic class ElicitationResult\n{\n /// \n /// User action: \"accept\" (submitted), \"decline\" (rejected), or \"cancel\" (dismissed).\n /// \n public UIElicitationResponseAction Action { get; set; }\n\n /// \n /// Form values submitted by the user (present when is Accept).\n /// \n public IDictionary? Content { get; set; }\n}\n\n/// \n/// Options for the convenience method.\n/// \npublic class InputOptions\n{\n /// Title label for the input field.\n public string? Title { get; set; }\n\n /// Descriptive text shown below the field.\n public string? Description { get; set; }\n\n /// Minimum character length.\n public int? MinLength { get; set; }\n\n /// Maximum character length.\n public int? MaxLength { get; set; }\n\n /// Semantic format hint (e.g., \"email\", \"uri\", \"date\", \"date-time\").\n public string? Format { get; set; }\n\n /// Default value pre-populated in the field.\n public string? Default { get; set; }\n}\n\n/// \n/// Provides UI methods for eliciting information from the user during a session.\n/// \npublic interface ISessionUiApi\n{\n /// \n /// Shows a generic elicitation dialog with a custom schema.\n /// \n /// The elicitation parameters including message and schema.\n /// Optional cancellation token.\n /// The with the user's response.\n /// Thrown if the host does not support elicitation.\n Task ElicitationAsync(ElicitationParams elicitationParams, CancellationToken cancellationToken = default);\n\n /// \n /// Shows a confirmation dialog and returns the user's boolean answer.\n /// Returns false if the user declines or cancels.\n /// \n /// The message to display.\n /// Optional cancellation token.\n /// true if the user confirmed; otherwise false.\n /// Thrown if the host does not support elicitation.\n Task ConfirmAsync(string message, CancellationToken cancellationToken = default);\n\n /// \n /// Shows a selection dialog with the given options.\n /// Returns the selected value, or null if the user declines/cancels.\n /// \n /// The message to display.\n /// The options to present.\n /// Optional cancellation token.\n /// The selected string, or null if the user declined/cancelled.\n /// Thrown if the host does not support elicitation.\n Task SelectAsync(string message, string[] options, CancellationToken cancellationToken = default);\n\n /// \n /// Shows a text input dialog.\n /// Returns the entered text, or null if the user declines/cancels.\n /// \n /// The message to display.\n /// Optional input field options.\n /// Optional cancellation token.\n /// The entered string, or null if the user declined/cancelled.\n /// Thrown if the host does not support elicitation.\n Task InputAsync(string message, InputOptions? options = null, CancellationToken cancellationToken = default);\n}\n\n// ============================================================================\n// Elicitation Types (server → client callback)\n// ============================================================================\n\n/// \n/// Context for an elicitation handler invocation, combining the request data\n/// with session context. Mirrors the single-argument pattern of .\n/// \npublic class ElicitationContext\n{\n /// Identifier of the session that triggered the elicitation request.\n public string SessionId { get; set; } = string.Empty;\n\n /// Message describing what information is needed from the user.\n public string Message { get; set; } = string.Empty;\n\n /// JSON Schema describing the form fields to present.\n public ElicitationSchema? RequestedSchema { get; set; }\n\n /// Elicitation mode: \"form\" for structured input, \"url\" for browser redirect.\n public ElicitationRequestedMode? Mode { get; set; }\n\n /// The source that initiated the request (e.g., MCP server name).\n public string? ElicitationSource { get; set; }\n\n /// URL to open in the user's browser (url mode only).\n public string? Url { get; set; }\n}\n\n/// \n/// Delegate for handling elicitation requests from the server.\n/// \npublic delegate Task ElicitationHandler(ElicitationContext context);\n\n// ============================================================================\n// Session Capabilities\n// ============================================================================\n\n/// \n/// Represents the capabilities reported by the host for a session.\n/// \npublic class SessionCapabilities\n{\n /// \n /// UI-related capabilities.\n /// \n public SessionUiCapabilities? Ui { get; set; }\n}\n\n/// \n/// UI-specific capability flags for a session.\n/// \npublic class SessionUiCapabilities\n{\n /// \n /// Whether the host supports interactive elicitation dialogs.\n /// \n public bool? Elicitation { get; set; }\n}\n\n// ============================================================================\n// Hook Handler Types\n// ============================================================================\n\n/// \n/// Context for a hook invocation.\n/// \npublic class HookInvocation\n{\n /// \n /// Identifier of the session that triggered the hook.\n /// \n public string SessionId { get; set; } = string.Empty;\n}\n\n/// \n/// Input for a pre-tool-use hook.\n/// \npublic class PreToolUseHookInput\n{\n /// \n /// Unix timestamp in milliseconds when the tool use was initiated.\n /// \n [JsonPropertyName(\"timestamp\")]\n public long Timestamp { get; set; }\n\n /// \n /// Current working directory of the session.\n /// \n [JsonPropertyName(\"cwd\")]\n public string Cwd { get; set; } = string.Empty;\n\n /// \n /// Name of the tool about to be executed.\n /// \n [JsonPropertyName(\"toolName\")]\n public string ToolName { get; set; } = string.Empty;\n\n /// \n /// Arguments that will be passed to the tool.\n /// \n [JsonPropertyName(\"toolArgs\")]\n public object? ToolArgs { get; set; }\n}\n\n/// \n/// Output for a pre-tool-use hook.\n/// \npublic class PreToolUseHookOutput\n{\n /// \n /// Permission decision for the pending tool call.\n /// \n /// \"allow\" — permit the tool to execute.\n /// \"deny\" — block the tool from executing.\n /// \"ask\" — fall through to the normal permission prompt.\n /// \n /// \n [JsonPropertyName(\"permissionDecision\")]\n public string? PermissionDecision { get; set; }\n\n /// \n /// Human-readable reason for the permission decision.\n /// \n [JsonPropertyName(\"permissionDecisionReason\")]\n public string? PermissionDecisionReason { get; set; }\n\n /// \n /// Modified arguments to pass to the tool instead of the original ones.\n /// \n [JsonPropertyName(\"modifiedArgs\")]\n public object? ModifiedArgs { get; set; }\n\n /// \n /// Additional context to inject into the conversation for the language model.\n /// \n [JsonPropertyName(\"additionalContext\")]\n public string? AdditionalContext { get; set; }\n\n /// \n /// Whether to suppress the tool's output from the conversation.\n /// \n [JsonPropertyName(\"suppressOutput\")]\n public bool? SuppressOutput { get; set; }\n}\n\n/// \n/// Delegate invoked before a tool is executed, allowing modification or denial of the call.\n/// \npublic delegate Task PreToolUseHandler(PreToolUseHookInput input, HookInvocation invocation);\n\n/// \n/// Input for a post-tool-use hook.\n/// \npublic class PostToolUseHookInput\n{\n /// \n /// Unix timestamp in milliseconds when the tool execution completed.\n /// \n [JsonPropertyName(\"timestamp\")]\n public long Timestamp { get; set; }\n\n /// \n /// Current working directory of the session.\n /// \n [JsonPropertyName(\"cwd\")]\n public string Cwd { get; set; } = string.Empty;\n\n /// \n /// Name of the tool that was executed.\n /// \n [JsonPropertyName(\"toolName\")]\n public string ToolName { get; set; } = string.Empty;\n\n /// \n /// Arguments that were passed to the tool.\n /// \n [JsonPropertyName(\"toolArgs\")]\n public object? ToolArgs { get; set; }\n\n /// \n /// Result returned by the tool execution.\n /// \n [JsonPropertyName(\"toolResult\")]\n public object? ToolResult { get; set; }\n}\n\n/// \n/// Output for a post-tool-use hook.\n/// \npublic class PostToolUseHookOutput\n{\n /// \n /// Modified result to replace the original tool result.\n /// \n [JsonPropertyName(\"modifiedResult\")]\n public object? ModifiedResult { get; set; }\n\n /// \n /// Additional context to inject into the conversation for the language model.\n /// \n [JsonPropertyName(\"additionalContext\")]\n public string? AdditionalContext { get; set; }\n\n /// \n /// Whether to suppress the tool's output from the conversation.\n /// \n [JsonPropertyName(\"suppressOutput\")]\n public bool? SuppressOutput { get; set; }\n}\n\n/// \n/// Delegate invoked after a tool has been executed, allowing modification of the result.\n/// \npublic delegate Task PostToolUseHandler(PostToolUseHookInput input, HookInvocation invocation);\n\n/// \n/// Input for a user-prompt-submitted hook.\n/// \npublic class UserPromptSubmittedHookInput\n{\n /// \n /// Unix timestamp in milliseconds when the prompt was submitted.\n /// \n [JsonPropertyName(\"timestamp\")]\n public long Timestamp { get; set; }\n\n /// \n /// Current working directory of the session.\n /// \n [JsonPropertyName(\"cwd\")]\n public string Cwd { get; set; } = string.Empty;\n\n /// \n /// The user's prompt text.\n /// \n [JsonPropertyName(\"prompt\")]\n public string Prompt { get; set; } = string.Empty;\n}\n\n/// \n/// Output for a user-prompt-submitted hook.\n/// \npublic class UserPromptSubmittedHookOutput\n{\n /// \n /// Modified prompt to use instead of the original user prompt.\n /// \n [JsonPropertyName(\"modifiedPrompt\")]\n public string? ModifiedPrompt { get; set; }\n\n /// \n /// Additional context to inject into the conversation for the language model.\n /// \n [JsonPropertyName(\"additionalContext\")]\n public string? AdditionalContext { get; set; }\n\n /// \n /// Whether to suppress the prompt's output from the conversation.\n /// \n [JsonPropertyName(\"suppressOutput\")]\n public bool? SuppressOutput { get; set; }\n}\n\n/// \n/// Delegate invoked when the user submits a prompt, allowing modification of the prompt.\n/// \npublic delegate Task UserPromptSubmittedHandler(UserPromptSubmittedHookInput input, HookInvocation invocation);\n\n/// \n/// Input for a session-start hook.\n/// \npublic class SessionStartHookInput\n{\n /// \n /// Unix timestamp in milliseconds when the session started.\n /// \n [JsonPropertyName(\"timestamp\")]\n public long Timestamp { get; set; }\n\n /// \n /// Current working directory of the session.\n /// \n [JsonPropertyName(\"cwd\")]\n public string Cwd { get; set; } = string.Empty;\n\n /// \n /// Source of the session start.\n /// \n /// \"startup\" — initial application startup.\n /// \"resume\" — resuming a previous session.\n /// \"new\" — starting a brand new session.\n /// \n /// \n [JsonPropertyName(\"source\")]\n public string Source { get; set; } = string.Empty;\n\n /// \n /// Initial prompt provided when the session was started.\n /// \n [JsonPropertyName(\"initialPrompt\")]\n public string? InitialPrompt { get; set; }\n}\n\n/// \n/// Output for a session-start hook.\n/// \npublic class SessionStartHookOutput\n{\n /// \n /// Additional context to inject into the session for the language model.\n /// \n [JsonPropertyName(\"additionalContext\")]\n public string? AdditionalContext { get; set; }\n\n /// \n /// Modified session configuration to apply at startup.\n /// \n [JsonPropertyName(\"modifiedConfig\")]\n public IDictionary? ModifiedConfig { get; set; }\n}\n\n/// \n/// Delegate invoked when a session starts, allowing injection of context or config changes.\n/// \npublic delegate Task SessionStartHandler(SessionStartHookInput input, HookInvocation invocation);\n\n/// \n/// Input for a session-end hook.\n/// \npublic class SessionEndHookInput\n{\n /// \n /// Unix timestamp in milliseconds when the session ended.\n /// \n [JsonPropertyName(\"timestamp\")]\n public long Timestamp { get; set; }\n\n /// \n /// Current working directory of the session.\n /// \n [JsonPropertyName(\"cwd\")]\n public string Cwd { get; set; } = string.Empty;\n\n /// \n /// Reason for session end.\n /// \n /// \"complete\" — the session finished normally.\n /// \"error\" — the session ended due to an error.\n /// \"abort\" — the session was aborted.\n /// \"timeout\" — the session timed out.\n /// \"user_exit\" — the user exited the session.\n /// \n /// \n [JsonPropertyName(\"reason\")]\n public string Reason { get; set; } = string.Empty;\n\n /// \n /// Final message from the assistant before the session ended.\n /// \n [JsonPropertyName(\"finalMessage\")]\n public string? FinalMessage { get; set; }\n\n /// \n /// Error message if the session ended due to an error.\n /// \n [JsonPropertyName(\"error\")]\n public string? Error { get; set; }\n}\n\n/// \n/// Output for a session-end hook.\n/// \npublic class SessionEndHookOutput\n{\n /// \n /// Whether to suppress the session end output from the conversation.\n /// \n [JsonPropertyName(\"suppressOutput\")]\n public bool? SuppressOutput { get; set; }\n\n /// \n /// List of cleanup action identifiers to execute after the session ends.\n /// \n [JsonPropertyName(\"cleanupActions\")]\n public IList? CleanupActions { get; set; }\n\n /// \n /// Summary of the session to persist for future reference.\n /// \n [JsonPropertyName(\"sessionSummary\")]\n public string? SessionSummary { get; set; }\n}\n\n/// \n/// Delegate invoked when a session ends, allowing cleanup actions or summary generation.\n/// \npublic delegate Task SessionEndHandler(SessionEndHookInput input, HookInvocation invocation);\n\n/// \n/// Input for an error-occurred hook.\n/// \npublic class ErrorOccurredHookInput\n{\n /// \n /// Unix timestamp in milliseconds when the error occurred.\n /// \n [JsonPropertyName(\"timestamp\")]\n public long Timestamp { get; set; }\n\n /// \n /// Current working directory of the session.\n /// \n [JsonPropertyName(\"cwd\")]\n public string Cwd { get; set; } = string.Empty;\n\n /// \n /// Error message describing what went wrong.\n /// \n [JsonPropertyName(\"error\")]\n public string Error { get; set; } = string.Empty;\n\n /// \n /// Context of the error.\n /// \n /// \"model_call\" — error during a model API call.\n /// \"tool_execution\" — error during tool execution.\n /// \"system\" — internal system error.\n /// \"user_input\" — error processing user input.\n /// \n /// \n [JsonPropertyName(\"errorContext\")]\n public string ErrorContext { get; set; } = string.Empty;\n\n /// \n /// Whether the error is recoverable and the session can continue.\n /// \n [JsonPropertyName(\"recoverable\")]\n public bool Recoverable { get; set; }\n}\n\n/// \n/// Output for an error-occurred hook.\n/// \npublic class ErrorOccurredHookOutput\n{\n /// \n /// Whether to suppress the error output from the conversation.\n /// \n [JsonPropertyName(\"suppressOutput\")]\n public bool? SuppressOutput { get; set; }\n\n /// \n /// Error handling strategy.\n /// \n /// \"retry\" — retry the failed operation.\n /// \"skip\" — skip the failed operation and continue.\n /// \"abort\" — abort the session.\n /// \n /// \n [JsonPropertyName(\"errorHandling\")]\n public string? ErrorHandling { get; set; }\n\n /// \n /// Number of times to retry the failed operation.\n /// \n [JsonPropertyName(\"retryCount\")]\n public int? RetryCount { get; set; }\n\n /// \n /// Message to display to the user about the error.\n /// \n [JsonPropertyName(\"userNotification\")]\n public string? UserNotification { get; set; }\n}\n\n/// \n/// Delegate invoked when an error occurs, allowing custom error handling strategies.\n/// \npublic delegate Task ErrorOccurredHandler(ErrorOccurredHookInput input, HookInvocation invocation);\n\n/// \n/// Hook handlers configuration for a session.\n/// \npublic class SessionHooks\n{\n /// \n /// Handler called before a tool is executed.\n /// \n public PreToolUseHandler? OnPreToolUse { get; set; }\n\n /// \n /// Handler called after a tool has been executed.\n /// \n public PostToolUseHandler? OnPostToolUse { get; set; }\n\n /// \n /// Handler called when the user submits a prompt.\n /// \n public UserPromptSubmittedHandler? OnUserPromptSubmitted { get; set; }\n\n /// \n /// Handler called when a session starts.\n /// \n public SessionStartHandler? OnSessionStart { get; set; }\n\n /// \n /// Handler called when a session ends.\n /// \n public SessionEndHandler? OnSessionEnd { get; set; }\n\n /// \n /// Handler called when an error occurs.\n /// \n public ErrorOccurredHandler? OnErrorOccurred { get; set; }\n}\n\n/// \n/// Specifies how a custom system message is applied to the session.\n/// \n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum SystemMessageMode\n{\n /// Append the custom system message to the default system message.\n [JsonStringEnumMemberName(\"append\")]\n Append,\n /// Replace the default system message entirely.\n [JsonStringEnumMemberName(\"replace\")]\n Replace,\n /// Override individual sections of the system prompt.\n [JsonStringEnumMemberName(\"customize\")]\n Customize\n}\n\n/// \n/// Specifies the operation to perform on a system prompt section.\n/// \n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum SectionOverrideAction\n{\n /// Replace the section content entirely.\n [JsonStringEnumMemberName(\"replace\")]\n Replace,\n /// Remove the section from the prompt.\n [JsonStringEnumMemberName(\"remove\")]\n Remove,\n /// Append content after the existing section.\n [JsonStringEnumMemberName(\"append\")]\n Append,\n /// Prepend content before the existing section.\n [JsonStringEnumMemberName(\"prepend\")]\n Prepend,\n /// Transform the section content via a callback.\n [JsonStringEnumMemberName(\"transform\")]\n Transform\n}\n\n/// \n/// Override operation for a single system prompt section.\n/// \npublic class SectionOverride\n{\n /// \n /// The operation to perform on this section. Ignored when Transform is set.\n /// \n [JsonPropertyName(\"action\")]\n public SectionOverrideAction? Action { get; set; }\n\n /// \n /// Content for the override. Optional for all actions. Ignored for remove.\n /// \n [JsonPropertyName(\"content\")]\n public string? Content { get; set; }\n\n /// \n /// Transform callback. When set, takes precedence over Action.\n /// Receives current section content, returns transformed content.\n /// Not serialized — the SDK handles this locally.\n /// \n [JsonIgnore]\n public Func>? Transform { get; set; }\n}\n\n/// \n/// Known system prompt section identifiers for the \"customize\" mode.\n/// \npublic static class SystemPromptSections\n{\n /// Agent identity preamble and mode statement.\n public const string Identity = \"identity\";\n /// Response style, conciseness rules, output formatting preferences.\n public const string Tone = \"tone\";\n /// Tool usage patterns, parallel calling, batching guidelines.\n public const string ToolEfficiency = \"tool_efficiency\";\n /// CWD, OS, git root, directory listing, available tools.\n public const string EnvironmentContext = \"environment_context\";\n /// Coding rules, linting/testing, ecosystem tools, style.\n public const string CodeChangeRules = \"code_change_rules\";\n /// Tips, behavioral best practices, behavioral guidelines.\n public const string Guidelines = \"guidelines\";\n /// Environment limitations, prohibited actions, security policies.\n public const string Safety = \"safety\";\n /// Per-tool usage instructions.\n public const string ToolInstructions = \"tool_instructions\";\n /// Repository and organization custom instructions.\n public const string CustomInstructions = \"custom_instructions\";\n /// End-of-prompt instructions: parallel tool calling, persistence, task completion.\n public const string LastInstructions = \"last_instructions\";\n}\n\n/// \n/// Configuration for the system message used in a session.\n/// \npublic class SystemMessageConfig\n{\n /// \n /// How the system message is applied (append, replace, or customize).\n /// \n public SystemMessageMode? Mode { get; set; }\n\n /// \n /// Content of the system message. Used by append and replace modes.\n /// In customize mode, additional content appended after all sections.\n /// \n public string? Content { get; set; }\n\n /// \n /// Section-level overrides for customize mode.\n /// Keys are section identifiers (see ).\n /// \n public IDictionary? Sections { get; set; }\n}\n\n/// \n/// Configuration for a custom model provider.\n/// \npublic class ProviderConfig\n{\n /// \n /// Provider type identifier (e.g., \"openai\", \"azure\").\n /// \n [JsonPropertyName(\"type\")]\n public string? Type { get; set; }\n\n /// \n /// Wire API format to use (e.g., \"chat-completions\").\n /// \n [JsonPropertyName(\"wireApi\")]\n public string? WireApi { get; set; }\n\n /// \n /// Base URL of the provider's API endpoint.\n /// \n [JsonPropertyName(\"baseUrl\")]\n public string BaseUrl { get; set; } = string.Empty;\n\n /// \n /// API key for authenticating with the provider.\n /// \n [JsonPropertyName(\"apiKey\")]\n public string? ApiKey { get; set; }\n\n /// \n /// Bearer token for authentication. Sets the Authorization header directly.\n /// Use this for services requiring bearer token auth instead of API key.\n /// Takes precedence over ApiKey when both are set.\n /// \n [JsonPropertyName(\"bearerToken\")]\n public string? BearerToken { get; set; }\n\n /// \n /// Azure-specific configuration options.\n /// \n [JsonPropertyName(\"azure\")]\n public AzureOptions? Azure { get; set; }\n\n /// \n /// Custom HTTP headers to include in outbound provider requests.\n /// \n [JsonPropertyName(\"headers\")]\n public IDictionary? Headers { get; set; }\n}\n\n/// \n/// Azure OpenAI-specific provider options.\n/// \npublic class AzureOptions\n{\n /// \n /// Azure OpenAI API version to use (e.g., \"2024-02-01\").\n /// \n [JsonPropertyName(\"apiVersion\")]\n public string? ApiVersion { get; set; }\n}\n\n// ============================================================================\n// MCP Server Configuration Types\n// ============================================================================\n\n/// \n/// OAuth grant type for a remote MCP server.\n/// \n[JsonConverter(typeof(JsonStringEnumConverter))]\npublic enum McpHttpServerConfigOauthGrantType\n{\n /// Use the authorization code OAuth flow.\n [JsonStringEnumMemberName(\"authorization_code\")]\n AuthorizationCode,\n\n /// Use the client credentials OAuth flow.\n [JsonStringEnumMemberName(\"client_credentials\")]\n ClientCredentials\n}\n\n/// \n/// Abstract base class for MCP server configurations.\n/// \n[JsonPolymorphic(\n TypeDiscriminatorPropertyName = \"type\",\n IgnoreUnrecognizedTypeDiscriminators = true)]\n[JsonDerivedType(typeof(McpStdioServerConfig), \"stdio\")]\n[JsonDerivedType(typeof(McpHttpServerConfig), \"http\")]\npublic abstract class McpServerConfig\n{\n private protected McpServerConfig() { }\n\n /// \n /// List of tools to include from this server. Empty list means none. Use \"*\" for all.\n /// \n [JsonPropertyName(\"tools\")]\n public IList Tools { get => field ??= []; set; }\n\n /// \n /// The server type discriminator.\n /// \n [JsonIgnore]\n public virtual string Type => \"unknown\";\n\n /// \n /// Optional timeout in milliseconds for tool calls to this server.\n /// \n [JsonPropertyName(\"timeout\")]\n public int? Timeout { get; set; }\n}\n\n/// \n/// Configuration for a local/stdio MCP server.\n/// \npublic sealed class McpStdioServerConfig : McpServerConfig\n{\n /// \n [JsonIgnore]\n public override string Type => \"stdio\";\n\n /// \n /// Command to run the MCP server.\n /// \n [JsonPropertyName(\"command\")]\n public string Command { get; set; } = string.Empty;\n\n /// \n /// Arguments to pass to the command.\n /// \n [JsonPropertyName(\"args\")]\n public IList Args { get => field ??= []; set; }\n\n /// \n /// Environment variables to pass to the server.\n /// \n [JsonPropertyName(\"env\")]\n public IDictionary? Env { get; set; }\n\n /// \n /// Working directory for the server process.\n /// \n [JsonPropertyName(\"cwd\")]\n public string? Cwd { get; set; }\n}\n\n/// \n/// Configuration for a remote MCP server (HTTP or SSE).\n/// \npublic sealed class McpHttpServerConfig : McpServerConfig\n{\n /// \n [JsonIgnore]\n public override string Type => \"http\";\n\n /// \n /// URL of the remote server.\n /// \n [JsonPropertyName(\"url\")]\n public string Url { get; set; } = string.Empty;\n\n /// \n /// Optional HTTP headers to include in requests.\n /// \n [JsonPropertyName(\"headers\")]\n public IDictionary? Headers { get; set; }\n\n /// \n /// Optional OAuth client ID for the remote server.\n /// \n [JsonPropertyName(\"oauthClientId\")]\n public string? OauthClientId { get; set; }\n\n /// \n /// Whether this is a public OAuth client.\n /// \n [JsonPropertyName(\"oauthPublicClient\")]\n public bool? OauthPublicClient { get; set; }\n\n /// \n /// Optional OAuth grant type for the remote server.\n /// \n [JsonPropertyName(\"oauthGrantType\")]\n public McpHttpServerConfigOauthGrantType? OauthGrantType { get; set; }\n}\n\n// ============================================================================\n// Custom Agent Configuration Types\n// ============================================================================\n\n/// \n/// Configuration for a custom agent.\n/// \npublic class CustomAgentConfig\n{\n /// \n /// Unique name of the custom agent.\n /// \n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n\n /// \n /// Display name for UI purposes.\n /// \n [JsonPropertyName(\"displayName\")]\n public string? DisplayName { get; set; }\n\n /// \n /// Description of what the agent does.\n /// \n [JsonPropertyName(\"description\")]\n public string? Description { get; set; }\n\n /// \n /// List of tool names the agent can use. Null for all tools.\n /// \n [JsonPropertyName(\"tools\")]\n public IList? Tools { get; set; }\n\n /// \n /// The prompt content for the agent.\n /// \n [JsonPropertyName(\"prompt\")]\n public string Prompt { get; set; } = string.Empty;\n\n /// \n /// MCP servers specific to this agent.\n /// \n [JsonPropertyName(\"mcpServers\")]\n public IDictionary? McpServers { get; set; }\n\n /// \n /// Whether the agent should be available for model inference.\n /// \n [JsonPropertyName(\"infer\")]\n public bool? Infer { get; set; }\n\n /// \n /// List of skill names to preload into this agent's context.\n /// When set, the full content of each listed skill is eagerly injected into\n /// the agent's context at startup. Skills are resolved by name from the\n /// session's configured skill directories ().\n /// When omitted, no skills are injected (opt-in model).\n /// \n [JsonPropertyName(\"skills\")]\n public IList? Skills { get; set; }\n}\n\n/// \n/// Configuration for the default agent (the built-in agent that handles turns when no custom agent is selected).\n/// Use to hide specific tools from the default agent\n/// while keeping them available to custom sub-agents.\n/// \npublic class DefaultAgentConfig\n{\n /// \n /// List of tool names to exclude from the default agent.\n /// These tools remain available to custom sub-agents that reference them\n /// in their list.\n /// \n public IList? ExcludedTools { get; set; }\n}\n\n/// \n/// Configuration for infinite sessions with automatic context compaction and workspace persistence.\n/// When enabled, sessions automatically manage context window limits through background compaction\n/// and persist state to a workspace directory.\n/// \npublic class InfiniteSessionConfig\n{\n /// \n /// Whether infinite sessions are enabled. Default: true\n /// \n [JsonPropertyName(\"enabled\")]\n public bool? Enabled { get; set; }\n\n /// \n /// Context utilization threshold (0.0-1.0) at which background compaction starts.\n /// Compaction runs asynchronously, allowing the session to continue processing.\n /// Default: 0.80\n /// \n [JsonPropertyName(\"backgroundCompactionThreshold\")]\n public double? BackgroundCompactionThreshold { get; set; }\n\n /// \n /// Context utilization threshold (0.0-1.0) at which the session blocks until compaction completes.\n /// This prevents context overflow when compaction hasn't finished in time.\n /// Default: 0.95\n /// \n [JsonPropertyName(\"bufferExhaustionThreshold\")]\n public double? BufferExhaustionThreshold { get; set; }\n}\n\n/// \n/// Configuration options for creating a new Copilot session.\n/// \npublic class SessionConfig\n{\n /// \n /// Initializes a new instance of the class.\n /// \n public SessionConfig() { }\n\n /// \n /// Initializes a new instance of the class\n /// by copying the properties of the specified instance.\n /// \n protected SessionConfig(SessionConfig? other)\n {\n if (other is null) return;\n\n AvailableTools = other.AvailableTools is not null ? [.. other.AvailableTools] : null;\n ClientName = other.ClientName;\n Commands = other.Commands is not null ? [.. other.Commands] : null;\n ConfigDir = other.ConfigDir;\n CustomAgents = other.CustomAgents is not null ? [.. other.CustomAgents] : null;\n DefaultAgent = other.DefaultAgent;\n Agent = other.Agent;\n DisabledSkills = other.DisabledSkills is not null ? [.. other.DisabledSkills] : null;\n EnableConfigDiscovery = other.EnableConfigDiscovery;\n ExcludedTools = other.ExcludedTools is not null ? [.. other.ExcludedTools] : null;\n Hooks = other.Hooks;\n InfiniteSessions = other.InfiniteSessions;\n McpServers = other.McpServers is not null\n ? (other.McpServers is Dictionary dict\n ? new Dictionary(dict, dict.Comparer)\n : new Dictionary(other.McpServers))\n : null;\n Model = other.Model;\n ModelCapabilities = other.ModelCapabilities;\n OnElicitationRequest = other.OnElicitationRequest;\n OnEvent = other.OnEvent;\n OnPermissionRequest = other.OnPermissionRequest;\n OnUserInputRequest = other.OnUserInputRequest;\n Provider = other.Provider;\n ReasoningEffort = other.ReasoningEffort;\n CreateSessionFsHandler = other.CreateSessionFsHandler;\n GitHubToken = other.GitHubToken;\n SessionId = other.SessionId;\n SkillDirectories = other.SkillDirectories is not null ? [.. other.SkillDirectories] : null;\n Streaming = other.Streaming;\n IncludeSubAgentStreamingEvents = other.IncludeSubAgentStreamingEvents;\n SystemMessage = other.SystemMessage;\n Tools = other.Tools is not null ? [.. other.Tools] : null;\n WorkingDirectory = other.WorkingDirectory;\n }\n\n /// \n /// Optional session identifier; a new ID is generated if not provided.\n /// \n public string? SessionId { get; set; }\n\n /// \n /// Client name to identify the application using the SDK.\n /// Included in the User-Agent header for API requests.\n /// \n public string? ClientName { get; set; }\n\n /// \n /// Model identifier to use for this session (e.g., \"gpt-4o\").\n /// \n public string? Model { get; set; }\n\n /// \n /// Reasoning effort level for models that support it.\n /// Valid values: \"low\", \"medium\", \"high\", \"xhigh\".\n /// Only applies to models where capabilities.supports.reasoningEffort is true.\n /// \n public string? ReasoningEffort { get; set; }\n\n /// \n /// Per-property overrides for model capabilities, deep-merged over runtime defaults.\n /// \n public ModelCapabilitiesOverride? ModelCapabilities { get; set; }\n\n /// \n /// Override the default configuration directory location.\n /// When specified, the session will use this directory for storing config and state.\n /// \n public string? ConfigDir { get; set; }\n\n /// \n /// When , automatically discovers MCP server configurations\n /// (e.g. .mcp.json, .vscode/mcp.json) and skill directories from\n /// the working directory and merges them with any explicitly provided\n /// and , with explicit\n /// values taking precedence on name collision.\n /// \n /// Custom instruction files (.github/copilot-instructions.md, AGENTS.md, etc.)\n /// are always loaded from the working directory regardless of this setting.\n /// \n /// \n public bool? EnableConfigDiscovery { get; set; }\n\n /// \n /// Custom tool functions available to the language model during the session.\n /// \n public ICollection? Tools { get; set; }\n /// \n /// System message configuration for the session.\n /// \n public SystemMessageConfig? SystemMessage { get; set; }\n /// \n /// List of tool names to allow; only these tools will be available when specified.\n /// \n public IList? AvailableTools { get; set; }\n /// \n /// List of tool names to exclude from the session.\n /// \n public IList? ExcludedTools { get; set; }\n /// \n /// Custom model provider configuration for the session.\n /// \n public ProviderConfig? Provider { get; set; }\n\n /// \n /// Handler for permission requests from the server.\n /// When provided, the server will call this handler to request permission for operations.\n /// \n public PermissionRequestHandler? OnPermissionRequest { get; set; }\n\n /// \n /// Handler for user input requests from the agent.\n /// When provided, enables the ask_user tool for the agent to request user input.\n /// \n public UserInputHandler? OnUserInputRequest { get; set; }\n\n /// \n /// Slash commands registered for this session.\n /// When the CLI has a TUI, each command appears as /name for the user to invoke.\n /// The handler is called when the user executes the command.\n /// \n public IList? Commands { get; set; }\n\n /// \n /// Handler for elicitation requests from the server or MCP tools.\n /// When provided, the server will route elicitation requests to this handler\n /// and report elicitation as a supported capability.\n /// \n public ElicitationHandler? OnElicitationRequest { get; set; }\n\n /// \n /// Hook handlers for session lifecycle events.\n /// \n public SessionHooks? Hooks { get; set; }\n\n /// \n /// Working directory for the session.\n /// \n public string? WorkingDirectory { get; set; }\n\n /// \n /// Enable streaming of assistant message and reasoning chunks.\n /// When true, assistant.message_delta and assistant.reasoning_delta events\n /// with deltaContent are sent as the response is generated.\n /// \n public bool Streaming { get; set; }\n\n /// \n /// Include sub-agent streaming events in the event stream. When true, streaming\n /// delta events from sub-agents (e.g., assistant.message_delta,\n /// assistant.reasoning_delta, assistant.streaming_delta with\n /// agentId set) are forwarded to this connection. When false, only\n /// non-streaming sub-agent events and subagent.* lifecycle events are\n /// forwarded; streaming deltas from sub-agents are suppressed.\n /// Default: true.\n /// \n public bool IncludeSubAgentStreamingEvents { get; set; } = true;\n\n /// \n /// MCP server configurations for the session.\n /// Keys are server names, values are server configurations ( or ).\n /// \n public IDictionary? McpServers { get; set; }\n\n /// \n /// Custom agent configurations for the session.\n /// \n public IList? CustomAgents { get; set; }\n\n /// \n /// Configuration for the default agent (the built-in agent that handles turns when no custom agent is selected).\n /// Use to hide specific tools from the default agent\n /// while keeping them available to custom sub-agents.\n /// \n public DefaultAgentConfig? DefaultAgent { get; set; }\n\n /// \n /// Name of the custom agent to activate when the session starts.\n /// Must match the of one of the agents in .\n /// \n public string? Agent { get; set; }\n\n /// \n /// Directories to load skills from.\n /// \n public IList? SkillDirectories { get; set; }\n\n /// \n /// List of skill names to disable.\n /// \n public IList? DisabledSkills { get; set; }\n\n /// \n /// Infinite session configuration for persistent workspaces and automatic compaction.\n /// When enabled (default), sessions automatically manage context limits and persist state.\n /// \n public InfiniteSessionConfig? InfiniteSessions { get; set; }\n\n /// \n /// Optional event handler that is registered on the session before the\n /// session.create RPC is issued.\n /// \n /// \n /// Equivalent to calling immediately\n /// after creation, but executes earlier in the lifecycle so no events are missed.\n /// Using this property rather than guarantees that early events emitted \n /// by the CLI during session creation (e.g. session.start) are delivered to the handler.\n /// \n public SessionEventHandler? OnEvent { get; set; }\n\n /// \n /// Supplies a handler for session filesystem operations.\n /// This is used only when is configured.\n /// \n public Func? CreateSessionFsHandler { get; set; }\n\n /// \n /// GitHub token for per-session authentication.\n /// When provided, the runtime resolves this token into a full GitHub identity\n /// and stores it on the session for content exclusion, model routing, and quota checks.\n /// \n public string? GitHubToken { get; set; }\n\n /// \n /// Creates a shallow clone of this instance.\n /// \n /// \n /// Mutable collection properties are copied into new collection instances so that modifications\n /// to those collections on the clone do not affect the original.\n /// Other reference-type properties (for example provider configuration, system messages,\n /// hooks, infinite session configuration, and delegates) are not deep-cloned; the original\n /// and the clone will share those nested objects, and changes to them may affect both.\n /// \n public virtual SessionConfig Clone()\n {\n return new(this);\n }\n}\n\n/// \n/// Configuration options for resuming an existing Copilot session.\n/// \npublic class ResumeSessionConfig\n{\n /// \n /// Initializes a new instance of the class.\n /// \n public ResumeSessionConfig() { }\n\n /// \n /// Initializes a new instance of the class\n /// by copying the properties of the specified instance.\n /// \n protected ResumeSessionConfig(ResumeSessionConfig? other)\n {\n if (other is null) return;\n\n AvailableTools = other.AvailableTools is not null ? [.. other.AvailableTools] : null;\n ClientName = other.ClientName;\n Commands = other.Commands is not null ? [.. other.Commands] : null;\n ConfigDir = other.ConfigDir;\n CustomAgents = other.CustomAgents is not null ? [.. other.CustomAgents] : null;\n DefaultAgent = other.DefaultAgent;\n Agent = other.Agent;\n DisabledSkills = other.DisabledSkills is not null ? [.. other.DisabledSkills] : null;\n DisableResume = other.DisableResume;\n EnableConfigDiscovery = other.EnableConfigDiscovery;\n ContinuePendingWork = other.ContinuePendingWork;\n ExcludedTools = other.ExcludedTools is not null ? [.. other.ExcludedTools] : null;\n Hooks = other.Hooks;\n InfiniteSessions = other.InfiniteSessions;\n McpServers = other.McpServers is not null\n ? (other.McpServers is Dictionary dict\n ? new Dictionary(dict, dict.Comparer)\n : new Dictionary(other.McpServers))\n : null;\n Model = other.Model;\n ModelCapabilities = other.ModelCapabilities;\n OnElicitationRequest = other.OnElicitationRequest;\n OnEvent = other.OnEvent;\n OnPermissionRequest = other.OnPermissionRequest;\n OnUserInputRequest = other.OnUserInputRequest;\n Provider = other.Provider;\n ReasoningEffort = other.ReasoningEffort;\n CreateSessionFsHandler = other.CreateSessionFsHandler;\n GitHubToken = other.GitHubToken;\n SkillDirectories = other.SkillDirectories is not null ? [.. other.SkillDirectories] : null;\n Streaming = other.Streaming;\n IncludeSubAgentStreamingEvents = other.IncludeSubAgentStreamingEvents;\n SystemMessage = other.SystemMessage;\n Tools = other.Tools is not null ? [.. other.Tools] : null;\n WorkingDirectory = other.WorkingDirectory;\n }\n\n /// \n /// Client name to identify the application using the SDK.\n /// Included in the User-Agent header for API requests.\n /// \n public string? ClientName { get; set; }\n\n /// \n /// Model to use for this session. Can change the model when resuming.\n /// \n public string? Model { get; set; }\n\n /// \n /// Custom tool functions available to the language model during the resumed session.\n /// \n public ICollection? Tools { get; set; }\n\n /// \n /// System message configuration.\n /// \n public SystemMessageConfig? SystemMessage { get; set; }\n\n /// \n /// List of tool names to allow. When specified, only these tools will be available.\n /// Takes precedence over ExcludedTools.\n /// \n public IList? AvailableTools { get; set; }\n\n /// \n /// List of tool names to disable. All other tools remain available.\n /// Ignored if AvailableTools is specified.\n /// \n public IList? ExcludedTools { get; set; }\n\n /// \n /// Custom model provider configuration for the resumed session.\n /// \n public ProviderConfig? Provider { get; set; }\n\n /// \n /// Reasoning effort level for models that support it.\n /// Valid values: \"low\", \"medium\", \"high\", \"xhigh\".\n /// \n public string? ReasoningEffort { get; set; }\n\n /// \n /// Per-property overrides for model capabilities, deep-merged over runtime defaults.\n /// \n public ModelCapabilitiesOverride? ModelCapabilities { get; set; }\n\n /// \n /// Handler for permission requests from the server.\n /// When provided, the server will call this handler to request permission for operations.\n /// \n public PermissionRequestHandler? OnPermissionRequest { get; set; }\n\n /// \n /// Handler for user input requests from the agent.\n /// When provided, enables the ask_user tool for the agent to request user input.\n /// \n public UserInputHandler? OnUserInputRequest { get; set; }\n\n /// \n /// Slash commands registered for this session.\n /// When the CLI has a TUI, each command appears as /name for the user to invoke.\n /// The handler is called when the user executes the command.\n /// \n public IList? Commands { get; set; }\n\n /// \n /// Handler for elicitation requests from the server or MCP tools.\n /// When provided, the server will route elicitation requests to this handler\n /// and report elicitation as a supported capability.\n /// \n public ElicitationHandler? OnElicitationRequest { get; set; }\n\n /// \n /// Hook handlers for session lifecycle events.\n /// \n public SessionHooks? Hooks { get; set; }\n\n /// \n /// Working directory for the session.\n /// \n public string? WorkingDirectory { get; set; }\n\n /// \n /// Override the default configuration directory location.\n /// \n public string? ConfigDir { get; set; }\n\n /// \n /// When , automatically discovers MCP server configurations\n /// (e.g. .mcp.json, .vscode/mcp.json) and skill directories from\n /// the working directory and merges them with any explicitly provided\n /// and , with explicit\n /// values taking precedence on name collision.\n /// \n /// Custom instruction files (.github/copilot-instructions.md, AGENTS.md, etc.)\n /// are always loaded from the working directory regardless of this setting.\n /// \n /// \n public bool? EnableConfigDiscovery { get; set; }\n\n /// \n /// When true, the session.resume event is not emitted.\n /// Default: false (resume event is emitted).\n /// \n public bool DisableResume { get; set; }\n\n /// \n /// When , instructs the runtime to continue any tool calls\n /// or permission prompts that were still pending when the session was last suspended.\n /// When (the default), the runtime treats pending work as\n /// interrupted on resume.\n /// \n /// For permission requests, the runtime re-emits permission.requested so the\n /// registered handler can re-prompt; for external\n /// tool calls, the consumer is expected to supply the result via the corresponding\n /// low-level RPC method.\n /// \n /// \n public bool? ContinuePendingWork { get; set; }\n\n /// \n /// Enable streaming of assistant message and reasoning chunks.\n /// When true, assistant.message_delta and assistant.reasoning_delta events\n /// with deltaContent are sent as the response is generated.\n /// \n public bool Streaming { get; set; }\n\n /// \n /// Include sub-agent streaming events in the event stream. When true, streaming\n /// delta events from sub-agents (e.g., assistant.message_delta,\n /// assistant.reasoning_delta, assistant.streaming_delta with\n /// agentId set) are forwarded to this connection. When false, only\n /// non-streaming sub-agent events and subagent.* lifecycle events are\n /// forwarded; streaming deltas from sub-agents are suppressed.\n /// Default: true.\n /// \n public bool IncludeSubAgentStreamingEvents { get; set; } = true;\n\n /// \n /// MCP server configurations for the session.\n /// Keys are server names, values are server configurations ( or ).\n /// \n public IDictionary? McpServers { get; set; }\n\n /// \n /// Custom agent configurations for the session.\n /// \n public IList? CustomAgents { get; set; }\n\n /// \n /// Configuration for the default agent (the built-in agent that handles turns when no custom agent is selected).\n /// Use to hide specific tools from the default agent\n /// while keeping them available to custom sub-agents.\n /// \n public DefaultAgentConfig? DefaultAgent { get; set; }\n\n /// \n /// Name of the custom agent to activate when the session starts.\n /// Must match the of one of the agents in .\n /// \n public string? Agent { get; set; }\n\n /// \n /// Directories to load skills from.\n /// \n public IList? SkillDirectories { get; set; }\n\n /// \n /// List of skill names to disable.\n /// \n public IList? DisabledSkills { get; set; }\n\n /// \n /// Infinite session configuration for persistent workspaces and automatic compaction.\n /// \n public InfiniteSessionConfig? InfiniteSessions { get; set; }\n\n /// \n /// Optional event handler registered before the session.resume RPC is issued,\n /// ensuring early events are delivered. See .\n /// \n public SessionEventHandler? OnEvent { get; set; }\n\n /// \n /// Supplies a handler for session filesystem operations.\n /// This is used only when is configured.\n /// \n public Func? CreateSessionFsHandler { get; set; }\n\n /// \n /// GitHub token for per-session authentication.\n /// When provided, the runtime resolves this token into a full GitHub identity\n /// and stores it on the session for content exclusion, model routing, and quota checks.\n /// \n public string? GitHubToken { get; set; }\n\n /// \n /// Creates a shallow clone of this instance.\n /// \n /// \n /// Mutable collection properties are copied into new collection instances so that modifications\n /// to those collections on the clone do not affect the original.\n /// Other reference-type properties (for example provider configuration, system messages,\n /// hooks, infinite session configuration, and delegates) are not deep-cloned; the original\n /// and the clone will share those nested objects, and changes to them may affect both.\n /// \n public virtual ResumeSessionConfig Clone()\n {\n return new(this);\n }\n}\n\n/// \n/// Options for sending a message in a Copilot session.\n/// \npublic class MessageOptions\n{\n /// \n /// Initializes a new instance of the class.\n /// \n public MessageOptions() { }\n\n /// \n /// Initializes a new instance of the class\n /// by copying the properties of the specified instance.\n /// \n protected MessageOptions(MessageOptions? other)\n {\n if (other is null) return;\n\n Attachments = other.Attachments is not null ? [.. other.Attachments] : null;\n Mode = other.Mode;\n Prompt = other.Prompt;\n RequestHeaders = other.RequestHeaders is not null\n ? new Dictionary(other.RequestHeaders)\n : null;\n }\n\n /// \n /// The prompt text to send to the assistant.\n /// \n public string Prompt { get; set; } = string.Empty;\n /// \n /// File or data attachments to include with the message.\n /// \n public IList? Attachments { get; set; }\n /// \n /// Interaction mode for the message (e.g., \"plan\", \"edit\").\n /// \n public string? Mode { get; set; }\n /// \n /// Custom per-turn HTTP headers for outbound model requests.\n /// \n public IDictionary? RequestHeaders { get; set; }\n\n /// \n /// Creates a shallow clone of this instance.\n /// \n /// \n /// Mutable collection properties are copied into new collection instances so that modifications\n /// to those collections on the clone do not affect the original.\n /// Other reference-type properties (for example attachment items) are not deep-cloned;\n /// the original and the clone will share those nested objects.\n /// \n public virtual MessageOptions Clone()\n {\n return new(this);\n }\n}\n\n/// \n/// Delegate for handling session events emitted during a Copilot session.\n/// \npublic delegate void SessionEventHandler(SessionEvent sessionEvent);\n\n/// \n/// Working directory context for a session.\n/// \npublic class SessionContext\n{\n /// Working directory where the session was created.\n public string Cwd { get; set; } = string.Empty;\n /// Git repository root (if in a git repo).\n public string? GitRoot { get; set; }\n /// GitHub repository in \"owner/repo\" format.\n public string? Repository { get; set; }\n /// Current git branch.\n public string? Branch { get; set; }\n}\n\n/// \n/// Filter options for listing sessions.\n/// \npublic class SessionListFilter\n{\n /// Filter by exact cwd match.\n public string? Cwd { get; set; }\n /// Filter by git root.\n public string? GitRoot { get; set; }\n /// Filter by repository (owner/repo format).\n public string? Repository { get; set; }\n /// Filter by branch.\n public string? Branch { get; set; }\n}\n\n/// \n/// Metadata describing a Copilot session.\n/// \npublic class SessionMetadata\n{\n /// \n /// Unique identifier of the session.\n /// \n public string SessionId { get; set; } = string.Empty;\n /// \n /// Time when the session was created.\n /// \n public DateTime StartTime { get; set; }\n /// \n /// Time when the session was last modified.\n /// \n public DateTime ModifiedTime { get; set; }\n /// \n /// Human-readable summary of the session.\n /// \n public string? Summary { get; set; }\n /// \n /// Whether the session is running on a remote server.\n /// \n public bool IsRemote { get; set; }\n /// Working directory context (cwd, git info) from session creation.\n public SessionContext? Context { get; set; }\n}\n\ninternal class PingRequest\n{\n public string? Message { get; set; }\n}\n\n/// \n/// Response from a server ping request.\n/// \npublic class PingResponse\n{\n /// \n /// Echo of the ping message.\n /// \n public string Message { get; set; } = string.Empty;\n /// \n /// Server timestamp when the ping was processed.\n /// \n public long Timestamp { get; set; }\n /// \n /// Protocol version supported by the server.\n /// \n public int? ProtocolVersion { get; set; }\n}\n\n/// \n/// Response from status.get\n/// \npublic class GetStatusResponse\n{\n /// Package version (e.g., \"1.0.0\")\n [JsonPropertyName(\"version\")]\n public string Version { get; set; } = string.Empty;\n\n /// Protocol version for SDK compatibility\n [JsonPropertyName(\"protocolVersion\")]\n public int ProtocolVersion { get; set; }\n}\n\n/// \n/// Response from auth.getStatus\n/// \npublic class GetAuthStatusResponse\n{\n /// Whether the user is authenticated\n [JsonPropertyName(\"isAuthenticated\")]\n public bool IsAuthenticated { get; set; }\n\n /// \n /// Authentication type.\n /// \n /// \"user\" — authenticated via user login.\n /// \"env\" — authenticated via environment variable.\n /// \"gh-cli\" — authenticated via the GitHub CLI.\n /// \"hmac\" — authenticated via HMAC signature.\n /// \"api-key\" — authenticated via API key.\n /// \"token\" — authenticated via explicit token.\n /// \n /// \n [JsonPropertyName(\"authType\")]\n public string? AuthType { get; set; }\n\n /// GitHub host URL\n [JsonPropertyName(\"host\")]\n public string? Host { get; set; }\n\n /// User login name\n [JsonPropertyName(\"login\")]\n public string? Login { get; set; }\n\n /// Human-readable status message\n [JsonPropertyName(\"statusMessage\")]\n public string? StatusMessage { get; set; }\n}\n\n/// \n/// Model vision-specific limits\n/// \npublic class ModelVisionLimits\n{\n /// \n /// List of supported image MIME types (e.g., \"image/png\", \"image/jpeg\").\n /// \n [JsonPropertyName(\"supported_media_types\")]\n public IList SupportedMediaTypes { get => field ??= []; set; }\n\n /// \n /// Maximum number of images allowed in a single prompt.\n /// \n [JsonPropertyName(\"max_prompt_images\")]\n public int MaxPromptImages { get; set; }\n\n /// \n /// Maximum size in bytes for a single prompt image.\n /// \n [JsonPropertyName(\"max_prompt_image_size\")]\n public int MaxPromptImageSize { get; set; }\n}\n\n/// \n/// Model limits\n/// \npublic class ModelLimits\n{\n /// \n /// Maximum number of tokens allowed in the prompt.\n /// \n [JsonPropertyName(\"max_prompt_tokens\")]\n public int? MaxPromptTokens { get; set; }\n\n /// \n /// Maximum total tokens in the context window.\n /// \n [JsonPropertyName(\"max_context_window_tokens\")]\n public int MaxContextWindowTokens { get; set; }\n\n /// \n /// Vision-specific limits for the model.\n /// \n [JsonPropertyName(\"vision\")]\n public ModelVisionLimits? Vision { get; set; }\n}\n\n/// \n/// Model support flags\n/// \npublic class ModelSupports\n{\n /// \n /// Whether this model supports image/vision inputs.\n /// \n [JsonPropertyName(\"vision\")]\n public bool Vision { get; set; }\n\n /// \n /// Whether this model supports reasoning effort configuration.\n /// \n [JsonPropertyName(\"reasoningEffort\")]\n public bool ReasoningEffort { get; set; }\n}\n\n/// \n/// Model capabilities and limits\n/// \npublic class ModelCapabilities\n{\n /// \n /// Feature support flags for the model.\n /// \n [JsonPropertyName(\"supports\")]\n public ModelSupports Supports { get; set; } = new();\n\n /// \n /// Token and resource limits for the model.\n /// \n [JsonPropertyName(\"limits\")]\n public ModelLimits Limits { get; set; } = new();\n}\n\n/// \n/// Model policy state\n/// \npublic class ModelPolicy\n{\n /// \n /// Policy state of the model (e.g., \"enabled\", \"disabled\").\n /// \n [JsonPropertyName(\"state\")]\n public string State { get; set; } = string.Empty;\n\n /// \n /// Terms or conditions associated with using the model.\n /// \n [JsonPropertyName(\"terms\")]\n public string Terms { get; set; } = string.Empty;\n}\n\n/// \n/// Model billing information\n/// \npublic class ModelBilling\n{\n /// \n /// Billing cost multiplier relative to the base model rate.\n /// \n [JsonPropertyName(\"multiplier\")]\n public double Multiplier { get; set; }\n}\n\n/// \n/// Information about an available model\n/// \npublic class ModelInfo\n{\n /// Model identifier (e.g., \"claude-sonnet-4.5\")\n [JsonPropertyName(\"id\")]\n public string Id { get; set; } = string.Empty;\n\n /// Display name\n [JsonPropertyName(\"name\")]\n public string Name { get; set; } = string.Empty;\n\n /// Model capabilities and limits\n [JsonPropertyName(\"capabilities\")]\n public ModelCapabilities Capabilities { get; set; } = new();\n\n /// Policy state\n [JsonPropertyName(\"policy\")]\n public ModelPolicy? Policy { get; set; }\n\n /// Billing information\n [JsonPropertyName(\"billing\")]\n public ModelBilling? Billing { get; set; }\n\n /// Supported reasoning effort levels (only present if model supports reasoning effort)\n [JsonPropertyName(\"supportedReasoningEfforts\")]\n public IList? SupportedReasoningEfforts { get; set; }\n\n /// Default reasoning effort level (only present if model supports reasoning effort)\n [JsonPropertyName(\"defaultReasoningEffort\")]\n public string? DefaultReasoningEffort { get; set; }\n}\n\n/// \n/// Response from models.list\n/// \npublic class GetModelsResponse\n{\n /// \n /// List of available models.\n /// \n [JsonPropertyName(\"models\")]\n public IList Models { get => field ??= []; set; }\n}\n\n// ============================================================================\n// Session Lifecycle Types (for TUI+server mode)\n// ============================================================================\n\n/// \n/// Types of session lifecycle events\n/// \npublic static class SessionLifecycleEventTypes\n{\n /// A new session was created.\n public const string Created = \"session.created\";\n /// A session was deleted.\n public const string Deleted = \"session.deleted\";\n /// A session was updated.\n public const string Updated = \"session.updated\";\n /// A session was brought to the foreground.\n public const string Foreground = \"session.foreground\";\n /// A session was moved to the background.\n public const string Background = \"session.background\";\n}\n\n/// \n/// Metadata for session lifecycle events\n/// \npublic class SessionLifecycleEventMetadata\n{\n /// \n /// ISO 8601 timestamp when the session was created.\n /// \n [JsonPropertyName(\"startTime\")]\n public string StartTime { get; set; } = string.Empty;\n\n /// \n /// ISO 8601 timestamp when the session was last modified.\n /// \n [JsonPropertyName(\"modifiedTime\")]\n public string ModifiedTime { get; set; } = string.Empty;\n\n /// \n /// Human-readable summary of the session.\n /// \n [JsonPropertyName(\"summary\")]\n public string? Summary { get; set; }\n}\n\n/// \n/// Session lifecycle event notification\n/// \npublic class SessionLifecycleEvent\n{\n /// \n /// Type of lifecycle event (see ).\n /// \n [JsonPropertyName(\"type\")]\n public string Type { get; set; } = string.Empty;\n\n /// \n /// Identifier of the session this event pertains to.\n /// \n [JsonPropertyName(\"sessionId\")]\n public string SessionId { get; set; } = string.Empty;\n\n /// \n /// Metadata associated with the session lifecycle event.\n /// \n [JsonPropertyName(\"metadata\")]\n public SessionLifecycleEventMetadata? Metadata { get; set; }\n}\n\n/// \n/// Response from session.getForeground\n/// \npublic class GetForegroundSessionResponse\n{\n /// \n /// Identifier of the current foreground session, or null if none.\n /// \n [JsonPropertyName(\"sessionId\")]\n public string? SessionId { get; set; }\n\n /// \n /// Workspace path associated with the foreground session.\n /// \n [JsonPropertyName(\"workspacePath\")]\n public string? WorkspacePath { get; set; }\n}\n\n/// \n/// Response from session.setForeground\n/// \npublic class SetForegroundSessionResponse\n{\n /// \n /// Whether the foreground session was set successfully.\n /// \n [JsonPropertyName(\"success\")]\n public bool Success { get; set; }\n\n /// \n /// Error message if the operation failed.\n /// \n [JsonPropertyName(\"error\")]\n public string? Error { get; set; }\n}\n\n/// \n/// Content data for a single system prompt section in a transform RPC call.\n/// \npublic class SystemMessageTransformSection\n{\n /// \n /// The content of the section.\n /// \n [JsonPropertyName(\"content\")]\n public string? Content { get; set; }\n}\n\n/// \n/// Response to a systemMessage.transform RPC call.\n/// \npublic class SystemMessageTransformRpcResponse\n{\n /// \n /// The transformed sections keyed by section identifier.\n /// \n [JsonPropertyName(\"sections\")]\n public IDictionary? Sections { get; set; }\n}\n\n[JsonSourceGenerationOptions(\n JsonSerializerDefaults.Web,\n AllowOutOfOrderMetadataProperties = true,\n NumberHandling = JsonNumberHandling.AllowReadingFromString,\n DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)]\n[JsonSerializable(typeof(AzureOptions))]\n[JsonSerializable(typeof(CustomAgentConfig))]\n[JsonSerializable(typeof(GetAuthStatusResponse))]\n[JsonSerializable(typeof(GetForegroundSessionResponse))]\n[JsonSerializable(typeof(GetModelsResponse))]\n[JsonSerializable(typeof(GetStatusResponse))]\n[JsonSerializable(typeof(McpServerConfig))]\n[JsonSerializable(typeof(MessageOptions))]\n[JsonSerializable(typeof(ModelBilling))]\n[JsonSerializable(typeof(ModelCapabilities))]\n[JsonSerializable(typeof(ModelCapabilitiesOverride))]\n[JsonSerializable(typeof(ModelInfo))]\n[JsonSerializable(typeof(ModelLimits))]\n[JsonSerializable(typeof(ModelPolicy))]\n[JsonSerializable(typeof(ModelSupports))]\n[JsonSerializable(typeof(ModelVisionLimits))]\n[JsonSerializable(typeof(PermissionRequestResult))]\n[JsonSerializable(typeof(PermissionRequestResultKind))]\n[JsonSerializable(typeof(PingRequest))]\n[JsonSerializable(typeof(PingResponse))]\n[JsonSerializable(typeof(ProviderConfig))]\n[JsonSerializable(typeof(SessionContext))]\n[JsonSerializable(typeof(SessionLifecycleEvent))]\n[JsonSerializable(typeof(SessionLifecycleEventMetadata))]\n[JsonSerializable(typeof(SessionListFilter))]\n[JsonSerializable(typeof(SectionOverride))]\n[JsonSerializable(typeof(SessionMetadata))]\n[JsonSerializable(typeof(SetForegroundSessionResponse))]\n[JsonSerializable(typeof(SystemMessageConfig))]\n[JsonSerializable(typeof(ToolBinaryResult))]\n[JsonSerializable(typeof(ToolInvocation))]\n[JsonSerializable(typeof(ToolResultObject))]\n[JsonSerializable(typeof(JsonElement))]\n[JsonSerializable(typeof(JsonElement?))]\ninternal partial class TypesJsonContext : JsonSerializerContext;\n" }, { "path": "dotnet/src/build/GitHub.Copilot.SDK.targets", "content": "\n \n \n \n\n \n \n \n <_CopilotOs Condition=\"'$(RuntimeIdentifier)' != '' And $(RuntimeIdentifier.StartsWith('win'))\">win\n <_CopilotOs Condition=\"'$(_CopilotOs)' == '' And '$(RuntimeIdentifier)' != '' And $(RuntimeIdentifier.StartsWith('osx'))\">osx\n <_CopilotOs Condition=\"'$(_CopilotOs)' == '' And '$(RuntimeIdentifier)' != '' And $(RuntimeIdentifier.StartsWith('maccatalyst'))\">osx\n <_CopilotOs Condition=\"'$(_CopilotOs)' == '' And '$(RuntimeIdentifier)' != ''\">linux\n\n \n <_CopilotArch Condition=\"'$(RuntimeIdentifier)' != '' And $(RuntimeIdentifier.EndsWith('-x64'))\">x64\n <_CopilotArch Condition=\"'$(_CopilotArch)' == '' And '$(RuntimeIdentifier)' != '' And $(RuntimeIdentifier.EndsWith('-arm64'))\">arm64\n\n \n <_CopilotRid Condition=\"'$(_CopilotOs)' != '' And '$(_CopilotArch)' != ''\">$(_CopilotOs)-$(_CopilotArch)\n <_CopilotRid Condition=\"'$(_CopilotRid)' == '' And '$(RuntimeIdentifier)' == ''\">$(NETCoreSdkPortableRuntimeIdentifier)\n \n\n \n \n \n \n\n \n \n <_CopilotPlatform Condition=\"'$(_CopilotRid)' == 'win-x64'\">win32-x64\n <_CopilotPlatform Condition=\"'$(_CopilotRid)' == 'win-arm64'\">win32-arm64\n <_CopilotPlatform Condition=\"'$(_CopilotRid)' == 'linux-x64'\">linux-x64\n <_CopilotPlatform Condition=\"'$(_CopilotRid)' == 'linux-arm64'\">linux-arm64\n <_CopilotPlatform Condition=\"'$(_CopilotRid)' == 'osx-x64'\">darwin-x64\n <_CopilotPlatform Condition=\"'$(_CopilotRid)' == 'osx-arm64'\">darwin-arm64\n <_CopilotBinary Condition=\"$(_CopilotRid.StartsWith('win-'))\">copilot.exe\n <_CopilotBinary Condition=\"'$(_CopilotBinary)' == ''\">copilot\n \n\n \n \n https://registry.npmjs.org\n \n\n \n \n 600\n \n\n \n \n \n\n \n \n <_CopilotCacheDir>$(IntermediateOutputPath)copilot-cli\\$(CopilotCliVersion)\\$(_CopilotPlatform)\n <_CopilotCliBinaryPath>$(_CopilotCacheDir)\\$(_CopilotBinary)\n <_CopilotArchivePath>$(_CopilotCacheDir)\\copilot.tgz\n <_CopilotNormalizedRegistryUrl>$([System.String]::Copy('$(CopilotNpmRegistryUrl)').TrimEnd('/'))\n <_CopilotDownloadUrl>$(_CopilotNormalizedRegistryUrl)/@github/copilot-$(_CopilotPlatform)/-/copilot-$(_CopilotPlatform)-$(CopilotCliVersion).tgz\n \n <_CopilotCliDownloadTimeoutMs>$([System.Convert]::ToInt32($([MSBuild]::Multiply($(CopilotCliDownloadTimeout), 1000))))\n \n\n \n \n\n \n \n \n \n\n \n \n <_TarCommand Condition=\"$([MSBuild]::IsOSPlatform('Windows'))\">$(SystemRoot)\\System32\\tar.exe\n <_TarCommand Condition=\"'$(_TarCommand)' == ''\">tar\n \n \n\n \n \n\n \n \n \n <_CopilotCacheDir>$(IntermediateOutputPath)copilot-cli\\$(CopilotCliVersion)\\$(_CopilotPlatform)\n <_CopilotCliBinaryPath>$(_CopilotCacheDir)\\$(_CopilotBinary)\n <_CopilotOutputDir>$(OutDir)runtimes\\$(_CopilotRid)\\native\n \n \n \n \n\n \n \n \n <_CopilotCacheDir>$(IntermediateOutputPath)copilot-cli\\$(CopilotCliVersion)\\$(_CopilotPlatform)\n <_CopilotCliBinaryPath>$(_CopilotCacheDir)\\$(_CopilotBinary)\n \n \n \n \n \n\n" }, { "path": "dotnet/test/AssemblyInfo.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing Xunit;\n\n// Each E2E test class fixture spins up its own Copilot CLI subprocess plus a CapiProxy\n// (replaying HTTP proxy) Node.js subprocess. With ~25 test classes, running them in parallel\n// would launch ~50 long-lived Node.js processes simultaneously and exhaust both file\n// descriptors and memory on developer machines and CI runners (especially Windows). Tests\n// within a class already run serially via xUnit's IClassFixture contract; this attribute\n// extends that to cross-class execution. Re-enable parallelization only after either\n// (a) sharing a single CLI subprocess across classes, or (b) gating concurrency with a\n// semaphore that limits concurrent fixtures to a small number (e.g. 2-3).\n[assembly: CollectionBehavior(DisableTestParallelization = true)]\n" }, { "path": "dotnet/test/E2E/AskUserE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class AskUserE2ETests(E2ETestFixture fixture, ITestOutputHelper output) : E2ETestBase(fixture, \"ask_user\", output)\n{\n [Fact]\n public async Task Should_Invoke_User_Input_Handler_When_Model_Uses_Ask_User_Tool()\n {\n var userInputRequests = new List();\n CopilotSession? session = null;\n session = await CreateSessionAsync(new SessionConfig\n {\n OnUserInputRequest = (request, invocation) =>\n {\n userInputRequests.Add(request);\n Assert.Equal(session!.SessionId, invocation.SessionId);\n\n // Return the first choice if available, otherwise a freeform answer\n var answer = request.Choices?.FirstOrDefault() ?? \"freeform answer\";\n var wasFreeform = request.Choices == null || request.Choices.Count == 0;\n\n return Task.FromResult(new UserInputResponse { Answer = answer, WasFreeform = wasFreeform });\n }\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Ask me to choose between 'Option A' and 'Option B' using the ask_user tool. Wait for my response before continuing.\"\n });\n\n await TestHelper.GetFinalAssistantMessageAsync(session);\n\n // Should have received at least one user input request\n Assert.NotEmpty(userInputRequests);\n\n // The request should have a question\n Assert.Contains(userInputRequests, r => !string.IsNullOrEmpty(r.Question));\n }\n\n [Fact]\n public async Task Should_Receive_Choices_In_User_Input_Request()\n {\n var userInputRequests = new List();\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnUserInputRequest = (request, invocation) =>\n {\n userInputRequests.Add(request);\n\n // Pick the first choice\n var answer = request.Choices?.FirstOrDefault() ?? \"default\";\n\n return Task.FromResult(new UserInputResponse { Answer = answer, WasFreeform = false });\n }\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Use the ask_user tool to ask me to pick between exactly two options: 'Red' and 'Blue'. These should be provided as choices. Wait for my answer.\"\n });\n\n await TestHelper.GetFinalAssistantMessageAsync(session);\n\n // Should have received a request\n Assert.NotEmpty(userInputRequests);\n\n // At least one request should have choices\n Assert.Contains(userInputRequests, r => r.Choices != null && r.Choices.Count > 0);\n }\n\n [Fact]\n public async Task Should_Handle_Freeform_User_Input_Response()\n {\n var userInputRequests = new List();\n var freeformAnswer = \"This is my custom freeform answer that was not in the choices\";\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnUserInputRequest = (request, invocation) =>\n {\n userInputRequests.Add(request);\n\n // Return a freeform answer (not from choices)\n return Task.FromResult(new UserInputResponse { Answer = freeformAnswer, WasFreeform = true });\n }\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Ask me a question using ask_user and then include my answer in your response. The question should be 'What is your favorite color?'\"\n });\n\n var response = await TestHelper.GetFinalAssistantMessageAsync(session);\n\n // Should have received a request\n Assert.NotEmpty(userInputRequests);\n\n // The model's response should be defined\n Assert.NotNull(response);\n }\n}\n" }, { "path": "dotnet/test/E2E/BuiltinToolsE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\n/// \n/// Smoke coverage for the Copilot CLI built-in tools (bash, view, edit, create_file,\n/// grep, glob). Each test asks the model to use one tool and then verifies the model's\n/// final response reflects the tool's result. Mirrors\n/// nodejs/test/e2e/builtin_tools.e2e.test.ts.\n/// \npublic class BuiltinToolsE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"builtin_tools\", output)\n{\n [Fact]\n public async Task Should_Capture_Exit_Code_In_Output()\n {\n var session = await CreateSessionAsync();\n var msg = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Run 'echo hello && echo world'. Tell me the exact output.\",\n });\n var content = msg?.Data.Content ?? string.Empty;\n Assert.Contains(\"hello\", content);\n Assert.Contains(\"world\", content);\n }\n\n [Fact]\n public async Task Should_Capture_Stderr_Output()\n {\n // The Copilot CLI runs commands through a shell tool that resolves to bash on\n // Linux/macOS and PowerShell on Windows. The TS prompt only works on bash, so\n // skip this test on Windows to mirror the TS `it.skipIf(process.platform === \"win32\")`.\n if (OperatingSystem.IsWindows())\n {\n return;\n }\n\n var session = await CreateSessionAsync();\n var msg = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Run 'echo error_msg >&2; echo ok' and tell me what stderr said. Reply with just the stderr content.\",\n });\n Assert.Contains(\"error_msg\", msg?.Data.Content ?? string.Empty);\n }\n\n [Fact]\n public async Task Should_Read_File_With_Line_Range()\n {\n await File.WriteAllTextAsync(Path.Join(Ctx.WorkDir, \"lines.txt\"), \"line1\\nline2\\nline3\\nline4\\nline5\\n\");\n var session = await CreateSessionAsync();\n var msg = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Read lines 2 through 4 of the file 'lines.txt' in this directory. Tell me what those lines contain.\",\n });\n var content = msg?.Data.Content ?? string.Empty;\n Assert.Contains(\"line2\", content);\n Assert.Contains(\"line4\", content);\n }\n\n [Fact]\n public async Task Should_Handle_Nonexistent_File_Gracefully()\n {\n var session = await CreateSessionAsync();\n var msg = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Try to read the file 'does_not_exist.txt'. If it doesn't exist, say 'FILE_NOT_FOUND'.\",\n });\n var content = (msg?.Data.Content ?? string.Empty).ToUpperInvariant();\n // Match any of the common phrasings for a missing-file response.\n Assert.True(\n content.Contains(\"NOT FOUND\")\n || content.Contains(\"NOT EXIST\")\n || content.Contains(\"NO SUCH\")\n || content.Contains(\"FILE_NOT_FOUND\")\n || content.Contains(\"DOES NOT EXIST\")\n || content.Contains(\"ERROR\"),\n $\"Expected a 'not found'-style response, got: {msg?.Data.Content}\");\n }\n\n [Fact]\n public async Task Should_Edit_A_File_Successfully()\n {\n await File.WriteAllTextAsync(Path.Join(Ctx.WorkDir, \"edit_me.txt\"), \"Hello World\\nGoodbye World\\n\");\n var session = await CreateSessionAsync();\n var msg = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Edit the file 'edit_me.txt': replace 'Hello World' with 'Hi Universe'. Then read it back and tell me its contents.\",\n });\n Assert.Contains(\"Hi Universe\", msg?.Data.Content ?? string.Empty);\n }\n\n [Fact]\n public async Task Should_Create_A_New_File()\n {\n var session = await CreateSessionAsync();\n var msg = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Create a file called 'new_file.txt' with the content 'Created by test'. Then read it back to confirm.\",\n });\n Assert.Contains(\"Created by test\", msg?.Data.Content ?? string.Empty);\n }\n\n [Fact]\n public async Task Should_Search_For_Patterns_In_Files()\n {\n await File.WriteAllTextAsync(Path.Join(Ctx.WorkDir, \"data.txt\"), \"apple\\nbanana\\napricot\\ncherry\\n\");\n var session = await CreateSessionAsync();\n var msg = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Search for lines starting with 'ap' in the file 'data.txt'. Tell me which lines matched.\",\n });\n var content = msg?.Data.Content ?? string.Empty;\n Assert.Contains(\"apple\", content);\n Assert.Contains(\"apricot\", content);\n }\n\n [Fact]\n public async Task Should_Find_Files_By_Pattern()\n {\n Directory.CreateDirectory(Path.Join(Ctx.WorkDir, \"src\"));\n await File.WriteAllTextAsync(Path.Join(Ctx.WorkDir, \"src\", \"index.ts\"), \"export const index = 1;\");\n await File.WriteAllTextAsync(Path.Join(Ctx.WorkDir, \"README.md\"), \"# Readme\");\n\n var session = await CreateSessionAsync();\n var msg = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Find all .ts files in this directory (recursively). List the filenames you found.\",\n });\n Assert.Contains(\"index.ts\", msg?.Data.Content ?? string.Empty);\n }\n}\n" }, { "path": "dotnet/test/E2E/ClientE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing Xunit;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\n// These tests bypass E2ETestBase because they are about how the CLI subprocess is started\n// Other test classes should instead inherit from E2ETestBase\npublic class ClientE2ETests\n{\n [Fact]\n public async Task Should_Start_And_Connect_To_Server_Using_Stdio()\n {\n using var client = new CopilotClient(new CopilotClientOptions { UseStdio = true });\n\n try\n {\n await client.StartAsync();\n Assert.Equal(ConnectionState.Connected, client.State);\n\n var pong = await client.PingAsync(\"test message\");\n Assert.Equal(\"pong: test message\", pong.Message);\n Assert.True(pong.Timestamp >= 0);\n\n await client.StopAsync();\n Assert.Equal(ConnectionState.Disconnected, client.State);\n }\n finally\n {\n await client.ForceStopAsync();\n }\n }\n\n [Fact]\n public async Task Should_Start_And_Connect_To_Server_Using_Tcp()\n {\n using var client = new CopilotClient(new CopilotClientOptions { UseStdio = false });\n\n try\n {\n await client.StartAsync();\n Assert.Equal(ConnectionState.Connected, client.State);\n\n var pong = await client.PingAsync(\"test message\");\n Assert.Equal(\"pong: test message\", pong.Message);\n\n await client.StopAsync();\n }\n finally\n {\n await client.ForceStopAsync();\n }\n }\n\n [Fact]\n public async Task Should_Force_Stop_Without_Cleanup()\n {\n using var client = new CopilotClient(new CopilotClientOptions());\n\n await client.CreateSessionAsync(new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll });\n await client.ForceStopAsync();\n\n Assert.Equal(ConnectionState.Disconnected, client.State);\n }\n\n [Fact]\n public async Task Should_Get_Status_With_Version_And_Protocol_Info()\n {\n using var client = new CopilotClient(new CopilotClientOptions { UseStdio = true });\n\n try\n {\n await client.StartAsync();\n\n var status = await client.GetStatusAsync();\n Assert.NotNull(status.Version);\n Assert.NotEmpty(status.Version);\n Assert.True(status.ProtocolVersion >= 1);\n\n await client.StopAsync();\n }\n finally\n {\n await client.ForceStopAsync();\n }\n }\n\n [Fact]\n public async Task Should_Get_Auth_Status()\n {\n using var client = new CopilotClient(new CopilotClientOptions { UseStdio = true });\n\n try\n {\n await client.StartAsync();\n\n var authStatus = await client.GetAuthStatusAsync();\n // isAuthenticated is a bool, just verify we got a response\n if (authStatus.IsAuthenticated)\n {\n Assert.NotNull(authStatus.AuthType);\n Assert.NotNull(authStatus.StatusMessage);\n }\n\n await client.StopAsync();\n }\n finally\n {\n await client.ForceStopAsync();\n }\n }\n\n [Fact]\n public async Task Should_List_Models_When_Authenticated()\n {\n using var client = new CopilotClient(new CopilotClientOptions { UseStdio = true });\n\n try\n {\n await client.StartAsync();\n\n var authStatus = await client.GetAuthStatusAsync();\n if (!authStatus.IsAuthenticated)\n {\n // Skip if not authenticated - models.list requires auth\n await client.StopAsync();\n return;\n }\n\n var models = await client.ListModelsAsync();\n Assert.NotNull(models);\n if (models.Count > 0)\n {\n var model = models[0];\n Assert.NotNull(model.Id);\n Assert.NotEmpty(model.Id);\n Assert.NotNull(model.Name);\n Assert.NotNull(model.Capabilities);\n }\n\n await client.StopAsync();\n }\n finally\n {\n await client.ForceStopAsync();\n }\n }\n\n [Fact]\n public async Task Should_Not_Throw_When_Disposing_Session_After_Stopping_Client()\n {\n await using var client = new CopilotClient(new CopilotClientOptions());\n await using var session = await client.CreateSessionAsync(new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll });\n\n await client.StopAsync();\n }\n\n [Fact]\n public async Task Should_Report_Error_With_Stderr_When_CLI_Fails_To_Start()\n {\n var client = new CopilotClient(new CopilotClientOptions\n {\n CliArgs = [\"--nonexistent-flag-for-testing\"],\n UseStdio = true\n });\n\n var ex = await Assert.ThrowsAsync(() => client.StartAsync());\n\n var errorMessage = ex.Message;\n // Verify we get the stderr output in the error message\n Assert.Contains(\"stderr\", errorMessage, StringComparison.OrdinalIgnoreCase);\n Assert.Contains(\"nonexistent\", errorMessage, StringComparison.OrdinalIgnoreCase);\n\n // Verify subsequent calls also fail (don't hang)\n var ex2 = await Assert.ThrowsAnyAsync(async () =>\n {\n var session = await client.CreateSessionAsync(new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll });\n await session.SendAsync(new MessageOptions { Prompt = \"test\" });\n });\n Assert.Contains(\"exited\", ex2.Message, StringComparison.OrdinalIgnoreCase);\n\n // Cleanup - ForceStop should handle the disconnected state gracefully\n try { await client.ForceStopAsync(); } catch (Exception) { /* Expected */ }\n }\n\n [Fact]\n public async Task Should_Throw_When_CreateSession_Called_Without_PermissionHandler()\n {\n using var client = new CopilotClient(new CopilotClientOptions());\n\n var ex = await Assert.ThrowsAsync(() => client.CreateSessionAsync(new SessionConfig()));\n\n Assert.Contains(\"OnPermissionRequest\", ex.Message);\n Assert.Contains(\"is required\", ex.Message);\n }\n\n [Fact]\n public async Task Should_Throw_When_ResumeSession_Called_Without_PermissionHandler()\n {\n using var client = new CopilotClient(new CopilotClientOptions());\n\n var ex = await Assert.ThrowsAsync(() => client.ResumeSessionAsync(\"some-session-id\", new()));\n\n Assert.Contains(\"OnPermissionRequest\", ex.Message);\n Assert.Contains(\"is required\", ex.Message);\n }\n\n [Fact]\n public async Task ListModels_WithCustomHandler_CallsHandler()\n {\n IList customModels = new List\n {\n new()\n {\n Id = \"my-custom-model\",\n Name = \"My Custom Model\",\n Capabilities = new ModelCapabilities\n {\n Supports = new ModelSupports { Vision = false, ReasoningEffort = false },\n Limits = new ModelLimits { MaxContextWindowTokens = 128000 }\n }\n }\n };\n\n var callCount = 0;\n await using var client = new CopilotClient(new CopilotClientOptions\n {\n OnListModels = (ct) =>\n {\n callCount++;\n return Task.FromResult(customModels);\n }\n });\n await client.StartAsync();\n\n var models = await client.ListModelsAsync();\n Assert.Equal(1, callCount);\n Assert.Single(models);\n Assert.Equal(\"my-custom-model\", models[0].Id);\n }\n\n [Fact]\n public async Task ListModels_WithCustomHandler_CachesResults()\n {\n IList customModels = new List\n {\n new()\n {\n Id = \"cached-model\",\n Name = \"Cached Model\",\n Capabilities = new ModelCapabilities\n {\n Supports = new ModelSupports { Vision = false, ReasoningEffort = false },\n Limits = new ModelLimits { MaxContextWindowTokens = 128000 }\n }\n }\n };\n\n var callCount = 0;\n await using var client = new CopilotClient(new CopilotClientOptions\n {\n OnListModels = (ct) =>\n {\n callCount++;\n return Task.FromResult(customModels);\n }\n });\n await client.StartAsync();\n\n await client.ListModelsAsync();\n await client.ListModelsAsync();\n Assert.Equal(1, callCount); // Only called once due to caching\n }\n\n [Fact]\n public async Task ListModels_WithCustomHandler_WorksWithoutStart()\n {\n IList customModels = new List\n {\n new()\n {\n Id = \"no-start-model\",\n Name = \"No Start Model\",\n Capabilities = new ModelCapabilities\n {\n Supports = new ModelSupports { Vision = false, ReasoningEffort = false },\n Limits = new ModelLimits { MaxContextWindowTokens = 128000 }\n }\n }\n };\n\n var callCount = 0;\n await using var client = new CopilotClient(new CopilotClientOptions\n {\n OnListModels = (ct) =>\n {\n callCount++;\n return Task.FromResult(customModels);\n }\n });\n\n var models = await client.ListModelsAsync();\n Assert.Equal(1, callCount);\n Assert.Single(models);\n Assert.Equal(\"no-start-model\", models[0].Id);\n }\n}\n" }, { "path": "dotnet/test/E2E/ClientLifecycleE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class ClientLifecycleE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"client_lifecycle\", output)\n{\n [Fact]\n public async Task Should_Receive_Session_Created_Lifecycle_Event()\n {\n var created = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n using var subscription = Client.On(evt =>\n {\n if (evt.Type == SessionLifecycleEventTypes.Created)\n {\n created.TrySetResult(evt);\n }\n });\n\n var session = await CreateSessionAsync();\n var evt = await created.Task.WaitAsync(TimeSpan.FromSeconds(10));\n\n Assert.Equal(SessionLifecycleEventTypes.Created, evt.Type);\n Assert.Equal(session.SessionId, evt.SessionId);\n }\n\n [Fact]\n public async Task Should_Filter_Session_Lifecycle_Events_By_Type()\n {\n var created = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n using var subscription = Client.On(SessionLifecycleEventTypes.Created, evt => created.TrySetResult(evt));\n\n var session = await CreateSessionAsync();\n var evt = await created.Task.WaitAsync(TimeSpan.FromSeconds(10));\n\n Assert.Equal(SessionLifecycleEventTypes.Created, evt.Type);\n Assert.Equal(session.SessionId, evt.SessionId);\n }\n\n [Fact]\n public async Task Disposing_Lifecycle_Subscription_Stops_Receiving_Events()\n {\n var count = 0;\n var created = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n var subscription = Client.On(_ => Interlocked.Increment(ref count));\n subscription.Dispose();\n using var activeSubscription = Client.On(SessionLifecycleEventTypes.Created, evt => created.TrySetResult(evt));\n\n var session = await CreateSessionAsync();\n var evt = await created.Task.WaitAsync(TimeSpan.FromSeconds(10));\n\n Assert.Equal(session.SessionId, evt.SessionId);\n Assert.Equal(0, Interlocked.CompareExchange(ref count, 0, 0));\n }\n\n [Theory]\n [InlineData(true)] // async dispose path (DisposeAsync)\n [InlineData(false)] // sync dispose path (Dispose)\n public async Task Dispose_Disconnects_Client_And_Disposes_Rpc_Surface(bool useAsyncDispose)\n {\n var client = Ctx.CreateClient();\n await client.StartAsync();\n\n Assert.Equal(ConnectionState.Connected, client.State);\n\n if (useAsyncDispose)\n {\n await client.DisposeAsync();\n }\n else\n {\n client.Dispose();\n }\n\n Assert.Equal(ConnectionState.Disconnected, client.State);\n Assert.Throws(() => client.Rpc);\n }\n}\n" }, { "path": "dotnet/test/E2E/ClientOptionsE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.Net;\nusing System.Net.Sockets;\nusing System.Text.Json;\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class ClientOptionsE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"client_options\", output)\n{\n [Fact]\n public async Task AutoStart_False_Requires_Explicit_Start()\n {\n await using var client = Ctx.CreateClient(options: new CopilotClientOptions\n {\n AutoStart = false,\n });\n\n Assert.Equal(ConnectionState.Disconnected, client.State);\n\n var ex = await Assert.ThrowsAsync(() =>\n client.CreateSessionAsync(new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll }));\n Assert.Contains(\"StartAsync\", ex.Message, StringComparison.Ordinal);\n\n await client.StartAsync();\n Assert.Equal(ConnectionState.Connected, client.State);\n\n var session = await client.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n Assert.Matches(@\"^[a-f0-9-]+$\", session.SessionId);\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Listen_On_Configured_Tcp_Port()\n {\n var port = GetAvailableTcpPort();\n await using var client = Ctx.CreateClient(\n useStdio: false,\n options: new CopilotClientOptions\n {\n Port = port,\n });\n\n await client.StartAsync();\n\n Assert.Equal(ConnectionState.Connected, client.State);\n Assert.Equal(port, client.ActualPort);\n\n var response = await client.PingAsync(\"fixed-port\");\n Assert.Equal(\"pong: fixed-port\", response.Message);\n }\n\n [Fact]\n public async Task Should_Use_Client_Cwd_For_Default_WorkingDirectory()\n {\n var clientCwd = Path.Join(Ctx.WorkDir, \"client-cwd\");\n Directory.CreateDirectory(clientCwd);\n await File.WriteAllTextAsync(Path.Join(clientCwd, \"marker.txt\"), \"I am in the client cwd\");\n\n await using var client = Ctx.CreateClient(options: new CopilotClientOptions\n {\n Cwd = clientCwd,\n });\n\n var session = await client.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n var message = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Read the file marker.txt and tell me what it says\",\n });\n\n Assert.Contains(\"client cwd\", message?.Data.Content ?? string.Empty);\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Propagate_Process_Options_To_Spawned_Cli()\n {\n var cliPath = Path.Join(Ctx.WorkDir, $\"fake-cli-{Guid.NewGuid():N}.js\");\n var capturePath = Path.Join(Ctx.WorkDir, $\"fake-cli-capture-{Guid.NewGuid():N}.json\");\n var telemetryPath = Path.Join(Ctx.WorkDir, \"telemetry.jsonl\");\n await File.WriteAllTextAsync(cliPath, FakeStdioCliScript);\n\n await using var client = Ctx.CreateClient(options: new CopilotClientOptions\n {\n AutoStart = false,\n CliPath = cliPath,\n CliArgs = [\"--capture-file\", capturePath],\n GitHubToken = \"process-option-token\",\n LogLevel = \"debug\",\n SessionIdleTimeoutSeconds = 17,\n Telemetry = new TelemetryConfig\n {\n OtlpEndpoint = \"http://127.0.0.1:4318\",\n FilePath = telemetryPath,\n ExporterType = \"file\",\n SourceName = \"dotnet-sdk-e2e\",\n CaptureContent = true,\n },\n UseLoggedInUser = false,\n });\n\n await client.StartAsync();\n\n using var capture = JsonDocument.Parse(await File.ReadAllTextAsync(capturePath));\n var root = capture.RootElement;\n var args = root.GetProperty(\"args\").EnumerateArray().Select(e => e.GetString()).ToArray();\n var env = root.GetProperty(\"env\");\n\n AssertArgumentValue(args, \"--log-level\", \"debug\");\n Assert.Contains(\"--stdio\", args);\n AssertArgumentValue(args, \"--auth-token-env\", \"COPILOT_SDK_AUTH_TOKEN\");\n Assert.Contains(\"--no-auto-login\", args);\n AssertArgumentValue(args, \"--session-idle-timeout\", \"17\");\n Assert.Equal(Path.GetFullPath(Ctx.WorkDir), root.GetProperty(\"cwd\").GetString());\n\n Assert.Equal(\"process-option-token\", env.GetProperty(\"COPILOT_SDK_AUTH_TOKEN\").GetString());\n Assert.Equal(\"true\", env.GetProperty(\"COPILOT_OTEL_ENABLED\").GetString());\n Assert.Equal(\"http://127.0.0.1:4318\", env.GetProperty(\"OTEL_EXPORTER_OTLP_ENDPOINT\").GetString());\n Assert.Equal(telemetryPath, env.GetProperty(\"COPILOT_OTEL_FILE_EXPORTER_PATH\").GetString());\n Assert.Equal(\"file\", env.GetProperty(\"COPILOT_OTEL_EXPORTER_TYPE\").GetString());\n Assert.Equal(\"dotnet-sdk-e2e\", env.GetProperty(\"COPILOT_OTEL_SOURCE_NAME\").GetString());\n Assert.Equal(\"true\", env.GetProperty(\"OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT\").GetString());\n\n var session = await client.CreateSessionAsync(new SessionConfig\n {\n EnableConfigDiscovery = true,\n IncludeSubAgentStreamingEvents = false,\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n using var updatedCapture = JsonDocument.Parse(await File.ReadAllTextAsync(capturePath));\n var createRequest = updatedCapture.RootElement\n .GetProperty(\"requests\")\n .EnumerateArray()\n .Single(request => request.GetProperty(\"method\").GetString() == \"session.create\")\n .GetProperty(\"params\");\n Assert.True(createRequest.GetProperty(\"enableConfigDiscovery\").GetBoolean());\n Assert.False(createRequest.GetProperty(\"includeSubAgentStreamingEvents\").GetBoolean());\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public void Should_Accept_GitHubToken_Option()\n {\n var options = new CopilotClientOptions\n {\n GitHubToken = \"gho_test_token\"\n };\n\n Assert.Equal(\"gho_test_token\", options.GitHubToken);\n }\n\n [Fact]\n public void Should_Default_UseLoggedInUser_To_Null()\n {\n var options = new CopilotClientOptions();\n\n Assert.Null(options.UseLoggedInUser);\n }\n\n [Fact]\n public void Should_Allow_Explicit_UseLoggedInUser_False()\n {\n var options = new CopilotClientOptions\n {\n UseLoggedInUser = false\n };\n\n Assert.False(options.UseLoggedInUser);\n }\n\n [Fact]\n public void Should_Allow_Explicit_UseLoggedInUser_True_With_GitHubToken()\n {\n var options = new CopilotClientOptions\n {\n GitHubToken = \"gho_test_token\",\n UseLoggedInUser = true\n };\n\n Assert.True(options.UseLoggedInUser);\n }\n\n [Fact]\n public void Should_Throw_When_GitHubToken_Used_With_CliUrl()\n {\n Assert.Throws(() =>\n {\n _ = new CopilotClient(new CopilotClientOptions\n {\n CliUrl = \"localhost:8080\",\n GitHubToken = \"gho_test_token\"\n });\n });\n }\n\n [Fact]\n public void Should_Throw_When_UseLoggedInUser_Used_With_CliUrl()\n {\n Assert.Throws(() =>\n {\n _ = new CopilotClient(new CopilotClientOptions\n {\n CliUrl = \"localhost:8080\",\n UseLoggedInUser = false\n });\n });\n }\n\n [Fact]\n public void Should_Default_SessionIdleTimeoutSeconds_To_Null()\n {\n var options = new CopilotClientOptions();\n\n Assert.Null(options.SessionIdleTimeoutSeconds);\n }\n\n [Fact]\n public void Should_Accept_SessionIdleTimeoutSeconds_Option()\n {\n var options = new CopilotClientOptions\n {\n SessionIdleTimeoutSeconds = 600\n };\n\n Assert.Equal(600, options.SessionIdleTimeoutSeconds);\n }\n\n private static int GetAvailableTcpPort()\n {\n using var listener = new TcpListener(IPAddress.Loopback, 0);\n listener.Start();\n try\n {\n return ((IPEndPoint)listener.LocalEndpoint).Port;\n }\n finally\n {\n listener.Stop();\n }\n }\n\n private static void AssertArgumentValue(string?[] args, string name, string expectedValue)\n {\n var index = Array.IndexOf(args, name);\n Assert.True(index >= 0, $\"Expected argument '{name}' was not present. Args: {string.Join(\" \", args)}\");\n Assert.True(index + 1 < args.Length, $\"Expected argument '{name}' to have a value.\");\n Assert.Equal(expectedValue, args[index + 1]);\n }\n\n private const string FakeStdioCliScript = \"\"\"\n const fs = require(\"fs\");\n\n const captureIndex = process.argv.indexOf(\"--capture-file\");\n const captureFile = captureIndex >= 0 ? process.argv[captureIndex + 1] : undefined;\n const requests = [];\n\n function saveCapture() {\n if (!captureFile) {\n return;\n }\n\n fs.writeFileSync(captureFile, JSON.stringify({\n args: process.argv.slice(2),\n cwd: process.cwd(),\n requests,\n env: {\n COPILOT_SDK_AUTH_TOKEN: process.env.COPILOT_SDK_AUTH_TOKEN,\n COPILOT_OTEL_ENABLED: process.env.COPILOT_OTEL_ENABLED,\n OTEL_EXPORTER_OTLP_ENDPOINT: process.env.OTEL_EXPORTER_OTLP_ENDPOINT,\n COPILOT_OTEL_FILE_EXPORTER_PATH: process.env.COPILOT_OTEL_FILE_EXPORTER_PATH,\n COPILOT_OTEL_EXPORTER_TYPE: process.env.COPILOT_OTEL_EXPORTER_TYPE,\n COPILOT_OTEL_SOURCE_NAME: process.env.COPILOT_OTEL_SOURCE_NAME,\n OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT: process.env.OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT\n }\n }));\n }\n\n saveCapture();\n\n let buffer = Buffer.alloc(0);\n\n process.stdin.on(\"data\", chunk => {\n buffer = Buffer.concat([buffer, chunk]);\n processBuffer();\n });\n\n process.stdin.resume();\n\n function processBuffer() {\n while (true) {\n const headerEnd = buffer.indexOf(\"\\r\\n\\r\\n\");\n if (headerEnd < 0) {\n return;\n }\n\n const header = buffer.subarray(0, headerEnd).toString(\"utf8\");\n const match = /Content-Length:\\s*(\\d+)/i.exec(header);\n if (!match) {\n throw new Error(\"Missing Content-Length header\");\n }\n\n const length = Number(match[1]);\n const bodyStart = headerEnd + 4;\n const bodyEnd = bodyStart + length;\n if (buffer.length < bodyEnd) {\n return;\n }\n\n const body = buffer.subarray(bodyStart, bodyEnd).toString(\"utf8\");\n buffer = buffer.subarray(bodyEnd);\n handleMessage(JSON.parse(body));\n }\n }\n\n function handleMessage(message) {\n if (!Object.prototype.hasOwnProperty.call(message, \"id\")) {\n return;\n }\n\n requests.push({ method: message.method, params: message.params });\n saveCapture();\n\n if (message.method === \"ping\") {\n writeResponse(message.id, { message: \"pong\", protocolVersion: 3 });\n return;\n }\n\n if (message.method === \"session.create\") {\n const sessionId = message.params?.sessionId ?? message.params?.[0]?.sessionId ?? \"fake-session\";\n writeResponse(message.id, { sessionId, workspacePath: null, capabilities: null });\n return;\n }\n\n writeResponse(message.id, {});\n }\n\n function writeResponse(id, result) {\n const body = JSON.stringify({ jsonrpc: \"2.0\", id, result });\n process.stdout.write(`Content-Length: ${Buffer.byteLength(body, \"utf8\")}\\r\\n\\r\\n${body}`);\n }\n \"\"\";\n}\n" }, { "path": "dotnet/test/E2E/ClientSessionManagementE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class ClientSessionManagementE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"client_api\", output)\n{\n private static async Task AssertFailureAsync(Func action, string expectedMessage)\n {\n var ex = await Assert.ThrowsAnyAsync(action);\n Assert.Contains(expectedMessage, ex.ToString(), StringComparison.OrdinalIgnoreCase);\n return ex;\n }\n\n [Fact]\n public async Task Should_Delete_Session_By_Id()\n {\n var session = await CreateSessionAsync();\n var sessionId = session.SessionId;\n\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Say OK.\" });\n await session.DisposeAsync();\n await Client.DeleteSessionAsync(sessionId);\n\n var metadata = await Client.GetSessionMetadataAsync(sessionId);\n Assert.Null(metadata);\n }\n\n [Fact]\n public async Task Should_Report_Error_When_Deleting_Unknown_Session_Id()\n {\n await Client.StartAsync();\n\n await AssertFailureAsync(\n () => Client.DeleteSessionAsync(\"00000000-0000-0000-0000-000000000000\"),\n \"Session file not found\");\n }\n\n [Fact]\n public async Task Should_Get_Null_Last_Session_Id_Before_Any_Sessions_Exist()\n {\n await Client.StartAsync();\n\n var result = await Client.GetLastSessionIdAsync();\n\n Assert.Null(result);\n }\n\n [Fact]\n public async Task Should_Track_Last_Session_Id_After_Session_Created()\n {\n var session = await CreateSessionAsync();\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Say OK.\" });\n var sessionId = session.SessionId;\n await session.DisposeAsync();\n\n var lastId = await Client.GetLastSessionIdAsync();\n\n Assert.Equal(sessionId, lastId);\n }\n\n [Fact]\n public async Task Should_Get_Null_Foreground_Session_Id_In_Headless_Mode()\n {\n await Client.StartAsync();\n\n var sessionId = await Client.GetForegroundSessionIdAsync();\n\n Assert.Null(sessionId);\n }\n\n [Fact]\n public async Task Should_Report_Error_When_Setting_Foreground_Session_In_Headless_Mode()\n {\n var session = await CreateSessionAsync();\n\n await AssertFailureAsync(\n () => Client.SetForegroundSessionIdAsync(session.SessionId),\n \"Not running in TUI+server mode\");\n }\n}\n" }, { "path": "dotnet/test/E2E/CommandsE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class CommandsE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"commands\", output)\n{\n [Fact]\n public async Task Session_With_Commands_Creates_Successfully()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Commands =\n [\n new CommandDefinition { Name = \"deploy\", Description = \"Deploy the app\", Handler = _ => Task.CompletedTask },\n new CommandDefinition { Name = \"rollback\", Handler = _ => Task.CompletedTask },\n ],\n });\n\n // Session should be created successfully with commands\n Assert.NotNull(session);\n Assert.NotNull(session.SessionId);\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Session_With_Commands_Resumes_Successfully()\n {\n var session1 = await CreateSessionAsync();\n var sessionId = session1.SessionId;\n\n var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Commands =\n [\n new CommandDefinition { Name = \"deploy\", Description = \"Deploy\", Handler = _ => Task.CompletedTask },\n ],\n });\n\n Assert.NotNull(session2);\n Assert.Equal(sessionId, session2.SessionId);\n await session2.DisposeAsync();\n }\n\n [Fact]\n public void CommandDefinition_Has_Required_Properties()\n {\n var cmd = new CommandDefinition\n {\n Name = \"deploy\",\n Description = \"Deploy the app\",\n Handler = _ => Task.CompletedTask,\n };\n\n Assert.Equal(\"deploy\", cmd.Name);\n Assert.Equal(\"Deploy the app\", cmd.Description);\n Assert.NotNull(cmd.Handler);\n }\n\n [Fact]\n public void CommandContext_Has_All_Properties()\n {\n var ctx = new CommandContext\n {\n SessionId = \"session-1\",\n Command = \"/deploy production\",\n CommandName = \"deploy\",\n Args = \"production\",\n };\n\n Assert.Equal(\"session-1\", ctx.SessionId);\n Assert.Equal(\"/deploy production\", ctx.Command);\n Assert.Equal(\"deploy\", ctx.CommandName);\n Assert.Equal(\"production\", ctx.Args);\n }\n\n [Fact]\n public async Task Session_With_No_Commands_Creates_Successfully()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n Assert.NotNull(session);\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Session_Config_Commands_Are_Cloned()\n {\n var config = new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Commands =\n [\n new CommandDefinition { Name = \"deploy\", Handler = _ => Task.CompletedTask },\n ],\n };\n\n var clone = config.Clone();\n\n Assert.NotNull(clone.Commands);\n Assert.Single(clone.Commands!);\n Assert.Equal(\"deploy\", clone.Commands![0].Name);\n\n // Verify collections are independent\n clone.Commands!.Add(new CommandDefinition { Name = \"rollback\", Handler = _ => Task.CompletedTask });\n Assert.Single(config.Commands!);\n }\n\n [Fact]\n public void Resume_Config_Commands_Are_Cloned()\n {\n var config = new ResumeSessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Commands =\n [\n new CommandDefinition { Name = \"deploy\", Handler = _ => Task.CompletedTask },\n ],\n };\n\n var clone = config.Clone();\n\n Assert.NotNull(clone.Commands);\n Assert.Single(clone.Commands!);\n Assert.Equal(\"deploy\", clone.Commands![0].Name);\n }\n}\n" }, { "path": "dotnet/test/E2E/CompactionE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.Runtime.InteropServices;\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class CompactionE2ETests(E2ETestFixture fixture, ITestOutputHelper output) : E2ETestBase(fixture, \"compaction\", output)\n{\n [Fact(Skip = \"Compaction tests are skipped due to flakiness — re-enable once stabilized\")]\n public async Task Should_Trigger_Compaction_With_Low_Threshold_And_Emit_Events()\n {\n // Create session with very low compaction thresholds to trigger compaction quickly\n var session = await CreateSessionAsync(new SessionConfig\n {\n InfiniteSessions = new InfiniteSessionConfig\n {\n Enabled = true,\n // Trigger background compaction at 0.5% context usage (~1000 tokens)\n BackgroundCompactionThreshold = 0.005,\n // Block at 1% to ensure compaction runs\n BufferExhaustionThreshold = 0.01\n }\n });\n\n var compactionStartEvents = new List();\n var compactionCompleteEvents = new List();\n\n session.On(evt =>\n {\n if (evt is SessionCompactionStartEvent startEvt)\n {\n compactionStartEvents.Add(startEvt);\n }\n if (evt is SessionCompactionCompleteEvent completeEvt)\n {\n compactionCompleteEvents.Add(completeEvt);\n }\n });\n\n // Send multiple messages to fill up the context window\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Tell me a story about a dragon. Be detailed.\"\n });\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Continue the story with more details about the dragon's castle.\"\n });\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Now describe the dragon's treasure in great detail.\"\n });\n\n // Should have triggered compaction at least once\n Assert.True(compactionStartEvents.Count >= 1, \"Expected at least 1 compaction_start event\");\n Assert.True(compactionCompleteEvents.Count >= 1, \"Expected at least 1 compaction_complete event\");\n\n // Compaction should have succeeded\n var lastComplete = compactionCompleteEvents[^1];\n Assert.True(lastComplete.Data.Success, \"Expected compaction to succeed\");\n\n // Should have removed some tokens\n if (lastComplete.Data.TokensRemoved.HasValue)\n {\n Assert.True(lastComplete.Data.TokensRemoved > 0, \"Expected tokensRemoved > 0\");\n }\n\n // Verify the session still works after compaction\n var answer = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What was the story about?\"\n });\n Assert.NotNull(answer);\n Assert.NotNull(answer!.Data.Content);\n // Should remember it was about a dragon (context preserved via summary)\n Assert.Contains(\"dragon\", answer.Data.Content.ToLower());\n }\n\n [Fact(Skip = \"Compaction tests are skipped due to flakiness — re-enable once stabilized\")]\n public async Task Should_Not_Emit_Compaction_Events_When_Infinite_Sessions_Disabled()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n InfiniteSessions = new InfiniteSessionConfig\n {\n Enabled = false\n }\n });\n\n var compactionEvents = new List();\n\n session.On(evt =>\n {\n if (evt is SessionCompactionStartEvent or SessionCompactionCompleteEvent)\n {\n compactionEvents.Add(evt);\n }\n });\n\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 2+2?\" });\n\n // Should not have any compaction events when disabled\n Assert.Empty(compactionEvents);\n }\n}\n" }, { "path": "dotnet/test/E2E/ElicitationE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Rpc;\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class ElicitationE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"elicitation\", output)\n{\n [Fact]\n public async Task Defaults_Capabilities_When_Not_Provided()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n // Default capabilities should exist (even if empty)\n Assert.NotNull(session.Capabilities);\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Elicitation_Throws_When_Capability_Is_Missing()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n // Capabilities.Ui?.Elicitation should not be true by default (headless mode)\n Assert.True(session.Capabilities.Ui?.Elicitation != true);\n\n // Calling any UI method should throw\n var ex = await Assert.ThrowsAsync(async () =>\n {\n await session.Ui.ConfirmAsync(\"test\");\n });\n Assert.Contains(\"not supported\", ex.Message, StringComparison.OrdinalIgnoreCase);\n\n ex = await Assert.ThrowsAsync(async () =>\n {\n await session.Ui.SelectAsync(\"test\", [\"a\", \"b\"]);\n });\n Assert.Contains(\"not supported\", ex.Message, StringComparison.OrdinalIgnoreCase);\n\n ex = await Assert.ThrowsAsync(async () =>\n {\n await session.Ui.InputAsync(\"test\");\n });\n Assert.Contains(\"not supported\", ex.Message, StringComparison.OrdinalIgnoreCase);\n\n ex = await Assert.ThrowsAsync(async () =>\n {\n await session.Ui.ElicitationAsync(new ElicitationParams\n {\n Message = \"Enter name\",\n RequestedSchema = new ElicitationSchema\n {\n Properties = new Dictionary() { [\"name\"] = new Dictionary { [\"type\"] = \"string\" } },\n Required = [\"name\"],\n },\n });\n });\n Assert.Contains(\"not supported\", ex.Message, StringComparison.OrdinalIgnoreCase);\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Sends_RequestElicitation_When_Handler_Provided()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n OnElicitationRequest = _ => Task.FromResult(new ElicitationResult\n {\n Action = UIElicitationResponseAction.Accept,\n Content = new Dictionary(),\n }),\n });\n\n // Session should be created successfully with requestElicitation=true\n Assert.NotNull(session);\n Assert.NotNull(session.SessionId);\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Session_With_ElicitationHandler_Reports_Elicitation_Capability()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n OnElicitationRequest = _ => Task.FromResult(new ElicitationResult\n {\n Action = UIElicitationResponseAction.Accept,\n Content = new Dictionary(),\n }),\n });\n\n Assert.True(session.Capabilities.Ui?.Elicitation == true,\n \"Session with onElicitationRequest should report elicitation capability\");\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Session_Without_ElicitationHandler_Reports_No_Capability()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n Assert.True(session.Capabilities.Ui?.Elicitation != true,\n \"Session without onElicitationRequest should not report elicitation capability\");\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Session_Without_ElicitationHandler_Creates_Successfully()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n // requestElicitation was false (no handler)\n Assert.NotNull(session);\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task ConfirmAsync_Returns_True_When_Handler_Accepts()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnElicitationRequest = context =>\n {\n Assert.Equal(\"Confirm?\", context.Message);\n Assert.Contains(\"confirmed\", context.RequestedSchema!.Properties.Keys);\n return Task.FromResult(new ElicitationResult\n {\n Action = UIElicitationResponseAction.Accept,\n Content = new Dictionary { [\"confirmed\"] = true },\n });\n },\n });\n\n Assert.True(session.Capabilities.Ui?.Elicitation);\n Assert.True(await session.Ui.ConfirmAsync(\"Confirm?\"));\n }\n\n [Fact]\n public async Task ConfirmAsync_Returns_False_When_Handler_Declines()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnElicitationRequest = _ => Task.FromResult(new ElicitationResult\n {\n Action = UIElicitationResponseAction.Decline,\n }),\n });\n\n Assert.False(await session.Ui.ConfirmAsync(\"Confirm?\"));\n }\n\n [Fact]\n public async Task SelectAsync_Returns_Selected_Option()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnElicitationRequest = context =>\n {\n Assert.Equal(\"Choose\", context.Message);\n Assert.Contains(\"selection\", context.RequestedSchema!.Properties.Keys);\n return Task.FromResult(new ElicitationResult\n {\n Action = UIElicitationResponseAction.Accept,\n Content = new Dictionary { [\"selection\"] = \"beta\" },\n });\n },\n });\n\n Assert.Equal(\"beta\", await session.Ui.SelectAsync(\"Choose\", [\"alpha\", \"beta\"]));\n }\n\n [Fact]\n public async Task InputAsync_Returns_Freeform_Value()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnElicitationRequest = context =>\n {\n Assert.Equal(\"Enter value\", context.Message);\n Assert.Contains(\"value\", context.RequestedSchema!.Properties.Keys);\n return Task.FromResult(new ElicitationResult\n {\n Action = UIElicitationResponseAction.Accept,\n Content = new Dictionary { [\"value\"] = \"typed value\" },\n });\n },\n });\n\n var result = await session.Ui.InputAsync(\"Enter value\", new InputOptions\n {\n Title = \"Value\",\n Description = \"A value to test\",\n MinLength = 1,\n MaxLength = 20,\n Default = \"default\",\n });\n\n Assert.Equal(\"typed value\", result);\n }\n\n [Fact]\n public async Task ElicitationAsync_Returns_All_Action_Shapes()\n {\n var responses = new Queue([\n new ElicitationResult\n {\n Action = UIElicitationResponseAction.Accept,\n Content = new Dictionary { [\"name\"] = \"Mona\" },\n },\n new ElicitationResult { Action = UIElicitationResponseAction.Decline },\n new ElicitationResult { Action = UIElicitationResponseAction.Cancel },\n ]);\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnElicitationRequest = context =>\n {\n Assert.Equal(\"Name?\", context.Message);\n return Task.FromResult(responses.Dequeue());\n },\n });\n\n var parameters = new ElicitationParams\n {\n Message = \"Name?\",\n RequestedSchema = new ElicitationSchema\n {\n Properties = new Dictionary\n {\n [\"name\"] = new Dictionary { [\"type\"] = \"string\" },\n },\n Required = [\"name\"],\n },\n };\n\n var accept = await session.Ui.ElicitationAsync(parameters);\n var decline = await session.Ui.ElicitationAsync(parameters);\n var cancel = await session.Ui.ElicitationAsync(parameters);\n\n Assert.Equal(UIElicitationResponseAction.Accept, accept.Action);\n Assert.Equal(\"Mona\", accept.Content![\"name\"].ToString());\n Assert.Equal(UIElicitationResponseAction.Decline, decline.Action);\n Assert.Equal(UIElicitationResponseAction.Cancel, cancel.Action);\n }\n\n [Fact]\n public void SessionCapabilities_Types_Are_Properly_Structured()\n {\n var capabilities = new SessionCapabilities\n {\n Ui = new SessionUiCapabilities { Elicitation = true }\n };\n\n Assert.NotNull(capabilities.Ui);\n Assert.True(capabilities.Ui.Elicitation);\n\n // Test with null UI\n var emptyCapabilities = new SessionCapabilities();\n Assert.Null(emptyCapabilities.Ui);\n }\n\n [Fact]\n public void ElicitationSchema_Types_Are_Properly_Structured()\n {\n var schema = new ElicitationSchema\n {\n Type = \"object\",\n Properties = new Dictionary\n {\n [\"name\"] = new Dictionary { [\"type\"] = \"string\", [\"minLength\"] = 1 },\n [\"confirmed\"] = new Dictionary { [\"type\"] = \"boolean\", [\"default\"] = true },\n },\n Required = [\"name\"],\n };\n\n Assert.Equal(\"object\", schema.Type);\n Assert.Equal(2, schema.Properties.Count);\n Assert.Single(schema.Required!);\n }\n\n [Fact]\n public void ElicitationParams_Types_Are_Properly_Structured()\n {\n var ep = new ElicitationParams\n {\n Message = \"Enter your name\",\n RequestedSchema = new ElicitationSchema\n {\n Properties = new Dictionary\n {\n [\"name\"] = new Dictionary { [\"type\"] = \"string\" },\n },\n },\n };\n\n Assert.Equal(\"Enter your name\", ep.Message);\n Assert.NotNull(ep.RequestedSchema);\n }\n\n [Fact]\n public void ElicitationResult_Types_Are_Properly_Structured()\n {\n var result = new ElicitationResult\n {\n Action = UIElicitationResponseAction.Accept,\n Content = new Dictionary { [\"name\"] = \"Alice\" },\n };\n\n Assert.Equal(UIElicitationResponseAction.Accept, result.Action);\n Assert.NotNull(result.Content);\n Assert.Equal(\"Alice\", result.Content![\"name\"]);\n\n var declined = new ElicitationResult\n {\n Action = UIElicitationResponseAction.Decline,\n };\n Assert.Null(declined.Content);\n }\n\n [Fact]\n public void InputOptions_Has_All_Properties()\n {\n var options = new InputOptions\n {\n Title = \"Email Address\",\n Description = \"Enter your email\",\n MinLength = 5,\n MaxLength = 100,\n Format = \"email\",\n Default = \"user@example.com\",\n };\n\n Assert.Equal(\"Email Address\", options.Title);\n Assert.Equal(\"Enter your email\", options.Description);\n Assert.Equal(5, options.MinLength);\n Assert.Equal(100, options.MaxLength);\n Assert.Equal(\"email\", options.Format);\n Assert.Equal(\"user@example.com\", options.Default);\n }\n\n [Fact]\n public void ElicitationContext_Has_All_Properties()\n {\n var context = new ElicitationContext\n {\n SessionId = \"session-42\",\n Message = \"Pick a color\",\n RequestedSchema = new ElicitationSchema\n {\n Properties = new Dictionary\n {\n [\"color\"] = new Dictionary { [\"type\"] = \"string\", [\"enum\"] = new[] { \"red\", \"blue\" } },\n },\n },\n Mode = ElicitationRequestedMode.Form,\n ElicitationSource = \"mcp-server\",\n Url = null,\n };\n\n Assert.Equal(\"session-42\", context.SessionId);\n Assert.Equal(\"Pick a color\", context.Message);\n Assert.NotNull(context.RequestedSchema);\n Assert.Equal(ElicitationRequestedMode.Form, context.Mode);\n Assert.Equal(\"mcp-server\", context.ElicitationSource);\n Assert.Null(context.Url);\n }\n\n [Fact]\n public async Task Session_Config_OnElicitationRequest_Is_Cloned()\n {\n ElicitationHandler handler = _ => Task.FromResult(new ElicitationResult\n {\n Action = UIElicitationResponseAction.Cancel,\n });\n\n var config = new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n OnElicitationRequest = handler,\n };\n\n var clone = config.Clone();\n\n Assert.Same(handler, clone.OnElicitationRequest);\n }\n\n [Fact]\n public void Resume_Config_OnElicitationRequest_Is_Cloned()\n {\n ElicitationHandler handler = _ => Task.FromResult(new ElicitationResult\n {\n Action = UIElicitationResponseAction.Cancel,\n });\n\n var config = new ResumeSessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n OnElicitationRequest = handler,\n };\n\n var clone = config.Clone();\n\n Assert.Same(handler, clone.OnElicitationRequest);\n }\n}\n\n" }, { "path": "dotnet/test/E2E/ErrorResilienceE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\n/// \n/// Verifies the SDK's behavior at the edges of the session lifecycle: sending or\n/// reading messages from a disposed session, idempotent abort, and resuming a\n/// session that no longer exists. Mirrors\n/// nodejs/test/e2e/error_resilience.e2e.test.ts.\n/// \npublic class ErrorResilienceE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"error_resilience\", output)\n{\n [Fact]\n public async Task Should_Throw_When_Sending_To_Disconnected_Session()\n {\n var session = await CreateSessionAsync();\n await session.DisposeAsync();\n\n await Assert.ThrowsAnyAsync(() =>\n session.SendAndWaitAsync(new MessageOptions { Prompt = \"Hello\" }));\n }\n\n [Fact]\n public async Task Should_Throw_When_Getting_Messages_From_Disconnected_Session()\n {\n var session = await CreateSessionAsync();\n await session.DisposeAsync();\n\n await Assert.ThrowsAnyAsync(() => session.GetMessagesAsync());\n }\n\n [Fact]\n public async Task Should_Handle_Double_Abort_Without_Error()\n {\n var session = await CreateSessionAsync();\n\n // First abort should be fine\n await session.AbortAsync();\n // Second abort should not throw\n await session.AbortAsync();\n\n // Session should still be disposable\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Throw_When_Resuming_Non_Existent_Session()\n {\n await Assert.ThrowsAnyAsync(() =>\n ResumeSessionAsync(\"non-existent-session-id-12345\"));\n }\n}\n" }, { "path": "dotnet/test/E2E/EventFidelityE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\n/// \n/// Verifies the shape and ordering of s emitted from the\n/// runtime: every event has an id and timestamp, user/assistant messages carry\n/// content, tool execution events carry a toolCallId, and\n/// session.idle is the last event of a turn. Mirrors\n/// nodejs/test/e2e/event_fidelity.e2e.test.ts.\n/// \npublic class EventFidelityE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"event_fidelity\", output)\n{\n [Fact]\n public async Task Should_Emit_Events_In_Correct_Order_For_Tool_Using_Conversation()\n {\n await File.WriteAllTextAsync(Path.Join(Ctx.WorkDir, \"hello.txt\"), \"Hello World\");\n\n var session = await CreateSessionAsync();\n var events = new List();\n session.On(evt => { lock (events) { events.Add(evt); } });\n\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Read the file 'hello.txt' and tell me its contents.\",\n });\n\n List types;\n lock (events) { types = events.Select(e => e.Type).ToList(); }\n\n Assert.Contains(\"user.message\", types);\n Assert.Contains(\"assistant.message\", types);\n\n // user.message should come before the last assistant.message\n var userIdx = types.IndexOf(\"user.message\");\n var assistantIdx = types.LastIndexOf(\"assistant.message\");\n Assert.True(userIdx < assistantIdx, $\"Expected user.message ({userIdx}) before last assistant.message ({assistantIdx})\");\n\n // session.idle should be the last event we observed\n var idleIdx = types.LastIndexOf(\"session.idle\");\n Assert.Equal(types.Count - 1, idleIdx);\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Include_Valid_Fields_On_All_Events()\n {\n var session = await CreateSessionAsync();\n var events = new List();\n session.On(evt => { lock (events) { events.Add(evt); } });\n\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is 5+5? Reply with just the number.\",\n });\n\n List snapshot;\n lock (events) { snapshot = [.. events]; }\n\n // All events must have an id and a timestamp\n foreach (var evt in snapshot)\n {\n Assert.NotEqual(Guid.Empty, evt.Id);\n Assert.NotEqual(default, evt.Timestamp);\n }\n\n // user.message should have content\n var userEvent = snapshot.OfType().FirstOrDefault();\n Assert.NotNull(userEvent);\n Assert.NotNull(userEvent!.Data.Content);\n\n // assistant.message should have messageId and content\n var assistantEvent = snapshot.OfType().FirstOrDefault();\n Assert.NotNull(assistantEvent);\n Assert.False(string.IsNullOrEmpty(assistantEvent!.Data.MessageId));\n Assert.NotNull(assistantEvent.Data.Content);\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Emit_Tool_Execution_Events_With_Correct_Fields()\n {\n await File.WriteAllTextAsync(Path.Join(Ctx.WorkDir, \"data.txt\"), \"test data\");\n\n var session = await CreateSessionAsync();\n var events = new List();\n session.On(evt => { lock (events) { events.Add(evt); } });\n\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Read the file 'data.txt'.\",\n });\n\n List snapshot;\n lock (events) { snapshot = [.. events]; }\n\n var toolStarts = snapshot.OfType().ToList();\n var toolCompletes = snapshot.OfType().ToList();\n\n Assert.NotEmpty(toolStarts);\n Assert.NotEmpty(toolCompletes);\n\n var firstStart = toolStarts[0];\n Assert.False(string.IsNullOrEmpty(firstStart.Data.ToolCallId));\n Assert.False(string.IsNullOrEmpty(firstStart.Data.ToolName));\n\n var firstComplete = toolCompletes[0];\n Assert.False(string.IsNullOrEmpty(firstComplete.Data.ToolCallId));\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Emit_Assistant_Message_With_MessageId()\n {\n var session = await CreateSessionAsync();\n var events = new List();\n session.On(evt => { lock (events) { events.Add(evt); } });\n\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Say 'pong'.\",\n });\n\n List assistantEvents;\n lock (events) { assistantEvents = events.OfType().ToList(); }\n\n Assert.NotEmpty(assistantEvents);\n\n var msg = assistantEvents[0];\n Assert.False(string.IsNullOrEmpty(msg.Data.MessageId));\n Assert.Contains(\"pong\", msg.Data.Content);\n\n await session.DisposeAsync();\n }\n}\n" }, { "path": "dotnet/test/E2E/HookLifecycleAndOutputE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Microsoft.Extensions.AI;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\n/// \n/// E2E coverage for every handler exposed on :\n/// OnPreToolUse, OnPostToolUse, OnUserPromptSubmitted, OnSessionStart, OnSessionEnd,\n/// OnErrorOccurred. Output-shape behavior (modifiedPrompt / additionalContext /\n/// errorHandling / modifiedArgs / modifiedResult / sessionSummary) is asserted alongside\n/// hook invocation. If a new handler is added to SessionHooks, add a corresponding\n/// test here.\n/// \npublic class HookLifecycleAndOutputE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"hooks_extended\", output)\n{\n private static readonly string[] ValidErrorContexts = [\"model_call\", \"tool_execution\", \"system\", \"user_input\"];\n\n [Fact]\n public async Task Should_Invoke_OnSessionStart_Hook_On_New_Session()\n {\n var sessionStartInputs = new List();\n CopilotSession? session = null;\n session = await CreateSessionAsync(new SessionConfig\n {\n Hooks = new SessionHooks\n {\n OnSessionStart = (input, invocation) =>\n {\n sessionStartInputs.Add(input);\n Assert.Equal(session!.SessionId, invocation.SessionId);\n return Task.FromResult(null);\n },\n },\n });\n\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Say hi\" });\n\n Assert.NotEmpty(sessionStartInputs);\n Assert.Equal(\"new\", sessionStartInputs[0].Source);\n Assert.True(sessionStartInputs[0].Timestamp > 0);\n Assert.False(string.IsNullOrEmpty(sessionStartInputs[0].Cwd));\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Invoke_OnUserPromptSubmitted_Hook_When_Sending_A_Message()\n {\n var userPromptInputs = new List();\n CopilotSession? session = null;\n session = await CreateSessionAsync(new SessionConfig\n {\n Hooks = new SessionHooks\n {\n OnUserPromptSubmitted = (input, invocation) =>\n {\n userPromptInputs.Add(input);\n Assert.Equal(session!.SessionId, invocation.SessionId);\n return Task.FromResult(null);\n },\n },\n });\n\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Say hello\" });\n\n Assert.NotEmpty(userPromptInputs);\n Assert.Contains(\"Say hello\", userPromptInputs[0].Prompt);\n Assert.True(userPromptInputs[0].Timestamp > 0);\n Assert.False(string.IsNullOrEmpty(userPromptInputs[0].Cwd));\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Invoke_OnSessionEnd_Hook_When_Session_Is_Disconnected()\n {\n var sessionEndInputs = new List();\n CopilotSession? session = null;\n session = await CreateSessionAsync(new SessionConfig\n {\n Hooks = new SessionHooks\n {\n OnSessionEnd = (input, invocation) =>\n {\n sessionEndInputs.Add(input);\n Assert.Equal(session!.SessionId, invocation.SessionId);\n return Task.FromResult(null);\n },\n },\n });\n\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Say hi\" });\n\n await session.DisposeAsync();\n\n // Wait briefly for the async hook to fire\n await Task.Delay(200);\n\n Assert.NotEmpty(sessionEndInputs);\n }\n\n [Fact]\n public async Task Should_Invoke_OnErrorOccurred_Hook_When_Error_Occurs()\n {\n CopilotSession? session = null;\n session = await CreateSessionAsync(new SessionConfig\n {\n Hooks = new SessionHooks\n {\n OnErrorOccurred = (input, invocation) =>\n {\n Assert.Equal(session!.SessionId, invocation.SessionId);\n Assert.True(input.Timestamp > 0);\n Assert.False(string.IsNullOrEmpty(input.Cwd));\n Assert.False(string.IsNullOrEmpty(input.Error));\n Assert.Contains(input.ErrorContext, ValidErrorContexts);\n return Task.FromResult(null);\n },\n },\n });\n\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Say hi\" });\n\n // OnErrorOccurred is dispatched by the runtime for actual errors. In a normal\n // session it may not fire — this test verifies the hook is properly wired and\n // that the session works correctly with it registered. If the hook *did* fire,\n // the assertions above would have run.\n Assert.False(string.IsNullOrEmpty(session.SessionId));\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Invoke_UserPromptSubmitted_Hook_And_Modify_Prompt()\n {\n var inputs = new List();\n var session = await CreateSessionAsync(new SessionConfig\n {\n Hooks = new SessionHooks\n {\n OnUserPromptSubmitted = (input, invocation) =>\n {\n inputs.Add(input);\n Assert.False(string.IsNullOrWhiteSpace(invocation.SessionId));\n return Task.FromResult(new UserPromptSubmittedHookOutput\n {\n ModifiedPrompt = \"Reply with exactly: HOOKED_PROMPT\",\n });\n },\n },\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Say something else\" });\n\n Assert.NotEmpty(inputs);\n Assert.Contains(\"Say something else\", inputs[0].Prompt);\n Assert.Contains(\"HOOKED_PROMPT\", response?.Data.Content ?? string.Empty);\n }\n\n [Fact]\n public async Task Should_Invoke_SessionStart_Hook()\n {\n var inputs = new List();\n var session = await CreateSessionAsync(new SessionConfig\n {\n Hooks = new SessionHooks\n {\n OnSessionStart = (input, invocation) =>\n {\n inputs.Add(input);\n Assert.False(string.IsNullOrWhiteSpace(invocation.SessionId));\n return Task.FromResult(new SessionStartHookOutput\n {\n AdditionalContext = \"Session start hook context.\",\n });\n },\n },\n });\n\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Say hi\" });\n\n Assert.NotEmpty(inputs);\n Assert.Equal(\"new\", inputs[0].Source);\n Assert.False(string.IsNullOrEmpty(inputs[0].Cwd));\n }\n\n [Fact]\n public async Task Should_Invoke_SessionEnd_Hook()\n {\n var inputs = new List();\n var hookInvoked = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n var session = await CreateSessionAsync(new SessionConfig\n {\n Hooks = new SessionHooks\n {\n OnSessionEnd = (input, invocation) =>\n {\n inputs.Add(input);\n hookInvoked.TrySetResult(input);\n Assert.False(string.IsNullOrWhiteSpace(invocation.SessionId));\n return Task.FromResult(new SessionEndHookOutput\n {\n SessionSummary = \"session ended\",\n });\n },\n },\n });\n\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Say bye\" });\n await session.DisposeAsync();\n await hookInvoked.Task.WaitAsync(TimeSpan.FromSeconds(10));\n\n Assert.NotEmpty(inputs);\n }\n\n [Fact]\n public async Task Should_Register_ErrorOccurred_Hook()\n {\n var inputs = new List();\n var session = await CreateSessionAsync(new SessionConfig\n {\n Hooks = new SessionHooks\n {\n OnErrorOccurred = (input, invocation) =>\n {\n inputs.Add(input);\n Assert.False(string.IsNullOrWhiteSpace(invocation.SessionId));\n return Task.FromResult(new ErrorOccurredHookOutput\n {\n ErrorHandling = \"skip\",\n });\n },\n },\n });\n\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Say hi\",\n });\n\n // OnErrorOccurred is dispatched only by genuine runtime errors (e.g. provider\n // failures, internal exceptions). A normal turn cannot deterministically trigger\n // one, so this test is **registration-only**: it verifies the SDK accepts the hook,\n // wires it through to the runtime via session.create, and that the lambda above is\n // not invoked inappropriately during a healthy turn. End-to-end coverage of an\n // actually-fired ErrorOccurred event would require a fault injection point that\n // does not exist in the public surface today.\n Assert.Empty(inputs);\n Assert.NotNull(session.SessionId);\n }\n\n [Fact]\n public async Task Should_Allow_PreToolUse_To_Return_ModifiedArgs_And_SuppressOutput()\n {\n var inputs = new List();\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Tools =\n [\n AIFunctionFactory.Create(\n (string value) => value,\n \"echo_value\",\n \"Echoes the supplied value\")\n ],\n Hooks = new SessionHooks\n {\n OnPreToolUse = (input, invocation) =>\n {\n inputs.Add(input);\n if (input.ToolName != \"echo_value\")\n {\n return Task.FromResult(new PreToolUseHookOutput\n {\n PermissionDecision = \"allow\",\n });\n }\n\n return Task.FromResult(new PreToolUseHookOutput\n {\n PermissionDecision = \"allow\",\n ModifiedArgs = new Dictionary { [\"value\"] = \"modified by hook\" },\n SuppressOutput = false,\n });\n },\n },\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Call echo_value with value 'original', then reply with the result.\",\n });\n\n Assert.NotEmpty(inputs);\n Assert.Contains(inputs, input => input.ToolName == \"echo_value\");\n Assert.Contains(\"modified by hook\", response?.Data.Content ?? string.Empty);\n }\n\n [Fact]\n public async Task Should_Allow_PostToolUse_To_Return_ModifiedResult()\n {\n var inputs = new List();\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n AvailableTools = [\"report_intent\"],\n Hooks = new SessionHooks\n {\n OnPostToolUse = (input, invocation) =>\n {\n inputs.Add(input);\n if (input.ToolName != \"report_intent\")\n {\n return Task.FromResult(null);\n }\n\n return Task.FromResult(new PostToolUseHookOutput\n {\n ModifiedResult = \"modified by post hook\",\n SuppressOutput = false,\n });\n },\n },\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Call the report_intent tool with intent 'Testing post hook', then reply done.\",\n });\n\n Assert.Contains(inputs, input => input.ToolName == \"report_intent\");\n Assert.Equal(\"Done.\", response?.Data.Content);\n }\n}\n" }, { "path": "dotnet/test/E2E/HooksE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class HooksE2ETests(E2ETestFixture fixture, ITestOutputHelper output) : E2ETestBase(fixture, \"hooks\", output)\n{\n [Fact]\n public async Task Should_Invoke_PreToolUse_Hook_When_Model_Runs_A_Tool()\n {\n var preToolUseInputs = new List();\n CopilotSession? session = null;\n session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Hooks = new SessionHooks\n {\n OnPreToolUse = (input, invocation) =>\n {\n preToolUseInputs.Add(input);\n Assert.Equal(session!.SessionId, invocation.SessionId);\n return Task.FromResult(new PreToolUseHookOutput { PermissionDecision = \"allow\" });\n }\n }\n });\n\n // Create a file for the model to read\n await File.WriteAllTextAsync(Path.Combine(Ctx.WorkDir, \"hello.txt\"), \"Hello from the test!\");\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Read the contents of hello.txt and tell me what it says\"\n });\n\n await TestHelper.GetFinalAssistantMessageAsync(session);\n\n // Should have received at least one preToolUse hook call\n Assert.NotEmpty(preToolUseInputs);\n\n // Should have received the tool name\n Assert.Contains(preToolUseInputs, i => !string.IsNullOrEmpty(i.ToolName));\n }\n\n [Fact]\n public async Task Should_Invoke_PostToolUse_Hook_After_Model_Runs_A_Tool()\n {\n var postToolUseInputs = new List();\n CopilotSession? session = null;\n session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Hooks = new SessionHooks\n {\n OnPostToolUse = (input, invocation) =>\n {\n postToolUseInputs.Add(input);\n Assert.Equal(session!.SessionId, invocation.SessionId);\n return Task.FromResult(null);\n }\n }\n });\n\n // Create a file for the model to read\n await File.WriteAllTextAsync(Path.Combine(Ctx.WorkDir, \"world.txt\"), \"World from the test!\");\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Read the contents of world.txt and tell me what it says\"\n });\n\n await TestHelper.GetFinalAssistantMessageAsync(session);\n\n // Should have received at least one postToolUse hook call\n Assert.NotEmpty(postToolUseInputs);\n\n // Should have received the tool name and result\n Assert.Contains(postToolUseInputs, i => !string.IsNullOrEmpty(i.ToolName));\n Assert.Contains(postToolUseInputs, i => i.ToolResult != null);\n }\n\n [Fact]\n public async Task Should_Invoke_Both_PreToolUse_And_PostToolUse_Hooks_For_Single_Tool_Call()\n {\n var preToolUseInputs = new List();\n var postToolUseInputs = new List();\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Hooks = new SessionHooks\n {\n OnPreToolUse = (input, invocation) =>\n {\n preToolUseInputs.Add(input);\n return Task.FromResult(new PreToolUseHookOutput { PermissionDecision = \"allow\" });\n },\n OnPostToolUse = (input, invocation) =>\n {\n postToolUseInputs.Add(input);\n return Task.FromResult(null);\n }\n }\n });\n\n await File.WriteAllTextAsync(Path.Combine(Ctx.WorkDir, \"both.txt\"), \"Testing both hooks!\");\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Read the contents of both.txt\"\n });\n\n await TestHelper.GetFinalAssistantMessageAsync(session);\n\n // Both hooks should have been called\n Assert.NotEmpty(preToolUseInputs);\n Assert.NotEmpty(postToolUseInputs);\n\n // The same tool should appear in both\n var preToolNames = preToolUseInputs.Select(i => i.ToolName).Where(n => !string.IsNullOrEmpty(n)).ToHashSet();\n var postToolNames = postToolUseInputs.Select(i => i.ToolName).Where(n => !string.IsNullOrEmpty(n)).ToHashSet();\n Assert.True(preToolNames.Overlaps(postToolNames), \"Expected the same tool to appear in both pre and post hooks\");\n }\n\n [Fact]\n public async Task Should_Deny_Tool_Execution_When_PreToolUse_Returns_Deny()\n {\n var preToolUseInputs = new List();\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Hooks = new SessionHooks\n {\n OnPreToolUse = (input, invocation) =>\n {\n preToolUseInputs.Add(input);\n // Deny all tool calls\n return Task.FromResult(new PreToolUseHookOutput { PermissionDecision = \"deny\" });\n }\n }\n });\n\n // Create a file\n var originalContent = \"Original content that should not be modified\";\n await File.WriteAllTextAsync(Path.Combine(Ctx.WorkDir, \"protected.txt\"), originalContent);\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Edit protected.txt and replace 'Original' with 'Modified'\"\n });\n\n var response = await TestHelper.GetFinalAssistantMessageAsync(session);\n\n // The hook should have been called\n Assert.NotEmpty(preToolUseInputs);\n\n // The response should be defined\n Assert.NotNull(response);\n\n // Strengthen: verify the actual deny behavior — the protected file was NOT\n // modified by the runtime even though the LLM tried to edit it. The pre-tool-use\n // hook denial blocks tool execution before it can mutate state.\n var actualContent = await File.ReadAllTextAsync(Path.Join(Ctx.WorkDir, \"protected.txt\"));\n Assert.Equal(originalContent, actualContent);\n }\n}\n" }, { "path": "dotnet/test/E2E/MultiClientCommandsElicitationE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.Reflection;\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\n/// \n/// Custom fixture for multi-client commands/elicitation tests.\n/// Uses TCP mode so a second (and third) client can connect to the same CLI process.\n/// \npublic class MultiClientCommandsElicitationFixture : IAsyncLifetime\n{\n public E2ETestContext Ctx { get; private set; } = null!;\n public CopilotClient Client1 { get; private set; } = null!;\n\n public async Task InitializeAsync()\n {\n Ctx = await E2ETestContext.CreateAsync();\n Client1 = Ctx.CreateClient(useStdio: false);\n }\n\n public async Task DisposeAsync()\n {\n if (Client1 is not null)\n {\n await Client1.ForceStopAsync();\n }\n\n await Ctx.DisposeAsync();\n }\n}\n\npublic class MultiClientCommandsElicitationE2ETests\n : IClassFixture, IAsyncLifetime\n{\n private readonly MultiClientCommandsElicitationFixture _fixture;\n private readonly string _testName;\n private CopilotClient? _client2;\n private CopilotClient? _client3;\n\n private E2ETestContext Ctx => _fixture.Ctx;\n private CopilotClient Client1 => _fixture.Client1;\n\n public MultiClientCommandsElicitationE2ETests(\n MultiClientCommandsElicitationFixture fixture,\n ITestOutputHelper output)\n {\n _fixture = fixture;\n _testName = GetTestName(output);\n }\n\n private static string GetTestName(ITestOutputHelper output)\n {\n var type = output.GetType();\n var testField = type.GetField(\"test\", BindingFlags.Instance | BindingFlags.NonPublic);\n var test = (ITest?)testField?.GetValue(output);\n return test?.TestCase.TestMethod.Method.Name\n ?? throw new InvalidOperationException(\"Couldn't find test name\");\n }\n\n public async Task InitializeAsync()\n {\n await Ctx.ConfigureForTestAsync(\"multi_client\", _testName);\n\n // Trigger connection so we can read the port\n var initSession = await Client1.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n await initSession.DisposeAsync();\n\n var port = Client1.ActualPort\n ?? throw new InvalidOperationException(\"Client1 is not using TCP mode; ActualPort is null\");\n\n _client2 = new CopilotClient(new CopilotClientOptions\n {\n CliUrl = $\"localhost:{port}\",\n });\n }\n\n public async Task DisposeAsync()\n {\n if (_client3 is not null)\n {\n await _client3.ForceStopAsync();\n _client3 = null;\n }\n\n if (_client2 is not null)\n {\n await _client2.ForceStopAsync();\n _client2 = null;\n }\n }\n\n private CopilotClient Client2 => _client2\n ?? throw new InvalidOperationException(\"Client2 not initialized\");\n\n [Fact]\n public async Task Client_Receives_Commands_Changed_When_Another_Client_Joins_With_Commands()\n {\n var session1 = await Client1.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n // Wait for the commands.changed event deterministically\n var commandsChangedTcs = new TaskCompletionSource(\n TaskCreationOptions.RunContinuationsAsynchronously);\n\n using var sub = session1.On(evt =>\n {\n if (evt is CommandsChangedEvent changed)\n {\n commandsChangedTcs.TrySetResult(changed);\n }\n });\n\n // Client2 joins with commands\n var session2 = await Client2.ResumeSessionAsync(session1.SessionId, new ResumeSessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Commands =\n [\n new CommandDefinition\n {\n Name = \"deploy\",\n Description = \"Deploy the app\",\n Handler = _ => Task.CompletedTask,\n },\n ],\n DisableResume = true,\n });\n\n var commandsChanged = await commandsChangedTcs.Task.WaitAsync(TimeSpan.FromSeconds(15));\n\n Assert.NotNull(commandsChanged.Data.Commands);\n Assert.Contains(commandsChanged.Data.Commands, c =>\n c.Name == \"deploy\" && c.Description == \"Deploy the app\");\n\n await session2.DisposeAsync();\n }\n\n [Fact]\n public async Task Capabilities_Changed_Fires_When_Second_Client_Joins_With_Elicitation_Handler()\n {\n // Client1 creates session without elicitation\n var session1 = await Client1.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n Assert.True(session1.Capabilities.Ui?.Elicitation != true,\n \"Session without elicitation handler should not have elicitation capability\");\n\n // Listen for capabilities.changed event\n var capChangedTcs = new TaskCompletionSource(\n TaskCreationOptions.RunContinuationsAsynchronously);\n\n using var sub = session1.On(evt =>\n {\n if (evt is CapabilitiesChangedEvent capEvt)\n {\n capChangedTcs.TrySetResult(capEvt);\n }\n });\n\n // Client2 joins WITH elicitation handler — triggers capabilities.changed\n var session2 = await Client2.ResumeSessionAsync(session1.SessionId, new ResumeSessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n OnElicitationRequest = _ => Task.FromResult(new ElicitationResult\n {\n Action = Rpc.UIElicitationResponseAction.Accept,\n Content = new Dictionary(),\n }),\n DisableResume = true,\n });\n\n var capEvent = await capChangedTcs.Task.WaitAsync(TimeSpan.FromSeconds(15));\n\n Assert.NotNull(capEvent.Data.Ui);\n Assert.True(capEvent.Data.Ui!.Elicitation);\n\n // Client1's capabilities should have been auto-updated\n Assert.True(session1.Capabilities.Ui?.Elicitation == true);\n\n await session2.DisposeAsync();\n }\n\n [Fact]\n public async Task Capabilities_Changed_Fires_When_Elicitation_Provider_Disconnects()\n {\n // Client1 creates session without elicitation\n var session1 = await Client1.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n Assert.True(session1.Capabilities.Ui?.Elicitation != true,\n \"Session without elicitation handler should not have elicitation capability\");\n\n // Wait for elicitation to become available\n var capEnabledTcs = new TaskCompletionSource(\n TaskCreationOptions.RunContinuationsAsynchronously);\n\n using var subEnabled = session1.On(evt =>\n {\n if (evt is CapabilitiesChangedEvent { Data.Ui.Elicitation: true })\n {\n capEnabledTcs.TrySetResult(true);\n }\n });\n\n // Use a dedicated client (client3) so we can stop it without affecting client2\n var port = Client1.ActualPort\n ?? throw new InvalidOperationException(\"Client1 ActualPort is null\");\n _client3 = new CopilotClient(new CopilotClientOptions\n {\n CliUrl = $\"localhost:{port}\",\n });\n\n // Client3 joins WITH elicitation handler\n await _client3.ResumeSessionAsync(session1.SessionId, new ResumeSessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n OnElicitationRequest = _ => Task.FromResult(new ElicitationResult\n {\n Action = Rpc.UIElicitationResponseAction.Accept,\n Content = new Dictionary(),\n }),\n DisableResume = true,\n });\n\n await capEnabledTcs.Task.WaitAsync(TimeSpan.FromSeconds(15));\n Assert.True(session1.Capabilities.Ui?.Elicitation == true);\n\n // Now listen for the capability being removed\n var capDisabledTcs = new TaskCompletionSource(\n TaskCreationOptions.RunContinuationsAsynchronously);\n\n using var subDisabled = session1.On(evt =>\n {\n if (evt is CapabilitiesChangedEvent { Data.Ui.Elicitation: false })\n {\n capDisabledTcs.TrySetResult(true);\n }\n });\n\n // Force-stop client3 — destroys the socket, triggering server-side cleanup\n await _client3.ForceStopAsync();\n _client3 = null;\n\n // Network teardown + server-side cleanup + capabilities recompute can take time on\n // slow CI runners. 30s is a defensive upper bound.\n await capDisabledTcs.Task.WaitAsync(TimeSpan.FromSeconds(30));\n Assert.True(session1.Capabilities.Ui?.Elicitation != true,\n \"After elicitation provider disconnects, capability should be removed\");\n }\n}\n\n" }, { "path": "dotnet/test/E2E/MultiClientE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.Collections.Concurrent;\nusing System.ComponentModel;\nusing System.Reflection;\nusing System.Text.RegularExpressions;\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Microsoft.Extensions.AI;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\n/// \n/// Custom fixture for multi-client tests that uses TCP mode so a second client can connect.\n/// \npublic class MultiClientTestFixture : IAsyncLifetime\n{\n public E2ETestContext Ctx { get; private set; } = null!;\n public CopilotClient Client1 { get; private set; } = null!;\n\n public async Task InitializeAsync()\n {\n Ctx = await E2ETestContext.CreateAsync();\n Client1 = Ctx.CreateClient(useStdio: false);\n }\n\n public async Task DisposeAsync()\n {\n if (Client1 is not null)\n {\n await Client1.ForceStopAsync();\n }\n\n await Ctx.DisposeAsync();\n }\n}\n\npublic class MultiClientE2ETests : IClassFixture, IAsyncLifetime\n{\n private readonly MultiClientTestFixture _fixture;\n private readonly string _testName;\n private CopilotClient? _client2;\n\n private E2ETestContext Ctx => _fixture.Ctx;\n private CopilotClient Client1 => _fixture.Client1;\n\n public MultiClientE2ETests(MultiClientTestFixture fixture, ITestOutputHelper output)\n {\n _fixture = fixture;\n _testName = GetTestName(output);\n }\n\n private static string GetTestName(ITestOutputHelper output)\n {\n var type = output.GetType();\n var testField = type.GetField(\"test\", BindingFlags.Instance | BindingFlags.NonPublic);\n var test = (ITest?)testField?.GetValue(output);\n return test?.TestCase.TestMethod.Method.Name ?? throw new InvalidOperationException(\"Couldn't find test name\");\n }\n\n public async Task InitializeAsync()\n {\n await Ctx.ConfigureForTestAsync(\"multi_client\", _testName);\n\n // Trigger connection so we can read the port\n var initSession = await Client1.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n await initSession.DisposeAsync();\n\n var port = Client1.ActualPort\n ?? throw new InvalidOperationException(\"Client1 is not using TCP mode; ActualPort is null\");\n\n _client2 = new CopilotClient(new CopilotClientOptions\n {\n CliUrl = $\"localhost:{port}\",\n });\n }\n\n public async Task DisposeAsync()\n {\n if (_client2 is not null)\n {\n await _client2.ForceStopAsync();\n _client2 = null;\n }\n }\n\n private CopilotClient Client2 => _client2 ?? throw new InvalidOperationException(\"Client2 not initialized\");\n\n [Fact]\n public async Task Both_Clients_See_Tool_Request_And_Completion_Events()\n {\n var tool = AIFunctionFactory.Create(MagicNumber, \"magic_number\");\n\n var session1 = await Client1.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Tools = [tool],\n });\n\n var session2 = await Client2.ResumeSessionAsync(session1.SessionId, new ResumeSessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n // Set up event waiters BEFORE sending the prompt to avoid race conditions\n var client1Requested = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n var client2Requested = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n var client1Completed = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n var client2Completed = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n\n using var sub1 = session1.On(evt =>\n {\n if (evt is ExternalToolRequestedEvent) client1Requested.TrySetResult(true);\n if (evt is ExternalToolCompletedEvent) client1Completed.TrySetResult(true);\n });\n using var sub2 = session2.On(evt =>\n {\n if (evt is ExternalToolRequestedEvent) client2Requested.TrySetResult(true);\n if (evt is ExternalToolCompletedEvent) client2Completed.TrySetResult(true);\n });\n\n var response = await session1.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Use the magic_number tool with seed 'hello' and tell me the result\",\n });\n\n Assert.NotNull(response);\n Assert.Contains(\"MAGIC_hello_42\", response!.Data.Content ?? string.Empty);\n\n // Wait for all broadcast events to arrive on both clients\n await Task.WhenAll(\n client1Requested.Task, client2Requested.Task,\n client1Completed.Task, client2Completed.Task).WaitAsync(TimeSpan.FromSeconds(10));\n\n await session2.DisposeAsync();\n\n [Description(\"Returns a magic number\")]\n static string MagicNumber([Description(\"A seed value\")] string seed) => $\"MAGIC_{seed}_42\";\n }\n\n [Fact]\n public async Task One_Client_Approves_Permission_And_Both_See_The_Result()\n {\n var client1PermissionRequests = new List();\n\n var session1 = await Client1.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = (request, _) =>\n {\n client1PermissionRequests.Add(request);\n return Task.FromResult(new PermissionRequestResult\n {\n Kind = PermissionRequestResultKind.Approved,\n });\n },\n });\n\n // Client 2 resumes — its handler never completes, so only client 1's approval takes effect\n var session2 = await Client2.ResumeSessionAsync(session1.SessionId, new ResumeSessionConfig\n {\n OnPermissionRequest = (_, _) => new TaskCompletionSource().Task,\n });\n\n var client1Events = new ConcurrentBag();\n var client2Events = new ConcurrentBag();\n\n // Wait for PermissionCompletedEvent on both clients.\n var client1PermissionCompleted = TestHelper.GetNextEventOfTypeAsync(session1);\n var client2PermissionCompleted = TestHelper.GetNextEventOfTypeAsync(session2);\n\n using var sub1 = session1.On(evt => client1Events.Add(evt));\n using var sub2 = session2.On(evt => client2Events.Add(evt));\n\n await session1.SendAsync(new MessageOptions\n {\n Prompt = \"Create a file called hello.txt containing the text 'hello world'\",\n });\n\n await Task.WhenAll(client1PermissionCompleted, client2PermissionCompleted).WaitAsync(TimeSpan.FromSeconds(30));\n await session1.AbortAsync();\n\n Assert.NotEmpty(client1PermissionRequests);\n\n Assert.Contains(client1Events, e => e is PermissionRequestedEvent);\n Assert.Contains(client2Events, e => e is PermissionRequestedEvent);\n Assert.Contains(client1Events, e => e is PermissionCompletedEvent);\n Assert.Contains(client2Events, e => e is PermissionCompletedEvent);\n\n foreach (var evt in client1Events.OfType()\n .Concat(client2Events.OfType()))\n {\n Assert.IsType(evt.Data.Result);\n }\n\n await session2.DisposeAsync();\n }\n\n [Fact]\n public async Task One_Client_Rejects_Permission_And_Both_See_The_Result()\n {\n var session1 = await Client1.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = (_, _) => Task.FromResult(new PermissionRequestResult\n {\n Kind = PermissionRequestResultKind.Rejected,\n }),\n });\n\n // Client 2 resumes — its handler never completes\n var session2 = await Client2.ResumeSessionAsync(session1.SessionId, new ResumeSessionConfig\n {\n OnPermissionRequest = (_, _) => new TaskCompletionSource().Task,\n });\n\n var client1Events = new ConcurrentBag();\n var client2Events = new ConcurrentBag();\n\n // Wait for PermissionCompletedEvent on client2 which may arrive slightly after session1 goes idle\n var client2PermissionCompleted = TestHelper.GetNextEventOfTypeAsync(session2);\n\n using var sub1 = session1.On(evt => client1Events.Add(evt));\n using var sub2 = session2.On(evt => client2Events.Add(evt));\n\n // Write a file so the agent has something to edit\n await File.WriteAllTextAsync(Path.Combine(Ctx.WorkDir, \"protected.txt\"), \"protected content\");\n\n await session1.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Edit protected.txt and replace 'protected' with 'hacked'.\",\n });\n\n // Verify the file was NOT modified\n var content = await File.ReadAllTextAsync(Path.Combine(Ctx.WorkDir, \"protected.txt\"));\n Assert.Equal(\"protected content\", content);\n\n await client2PermissionCompleted;\n\n Assert.Contains(client1Events, e => e is PermissionRequestedEvent);\n Assert.Contains(client2Events, e => e is PermissionRequestedEvent);\n\n foreach (var evt in client1Events.OfType()\n .Concat(client2Events.OfType()))\n {\n Assert.IsType(evt.Data.Result);\n }\n\n await session2.DisposeAsync();\n }\n\n [Fact]\n public async Task Two_Clients_Register_Different_Tools_And_Agent_Uses_Both()\n {\n var toolA = AIFunctionFactory.Create(CityLookup, \"city_lookup\");\n var toolB = AIFunctionFactory.Create(CurrencyLookup, \"currency_lookup\");\n\n var session1 = await Client1.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Tools = [toolA],\n });\n\n var session2 = await Client2.ResumeSessionAsync(session1.SessionId, new ResumeSessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Tools = [toolB],\n });\n\n // Send prompts sequentially to avoid nondeterministic tool_call ordering\n var response1 = await session1.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Use the city_lookup tool with countryCode 'US' and tell me the result.\",\n });\n Assert.NotNull(response1);\n Assert.Contains(\"CITY_FOR_US\", response1!.Data.Content ?? string.Empty);\n\n var response2 = await session1.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Now use the currency_lookup tool with countryCode 'US' and tell me the result.\",\n });\n Assert.NotNull(response2);\n Assert.Contains(\"CURRENCY_FOR_US\", response2!.Data.Content ?? string.Empty);\n\n await session2.DisposeAsync();\n\n [Description(\"Returns a city name for a given country code\")]\n static string CityLookup([Description(\"A two-letter country code\")] string countryCode) => $\"CITY_FOR_{countryCode}\";\n\n [Description(\"Returns a currency for a given country code\")]\n static string CurrencyLookup([Description(\"A two-letter country code\")] string countryCode) => $\"CURRENCY_FOR_{countryCode}\";\n }\n\n [Fact]\n public async Task Disconnecting_Client_Removes_Its_Tools()\n {\n var toolA = AIFunctionFactory.Create(StableTool, \"stable_tool\");\n var toolB = AIFunctionFactory.Create(EphemeralTool, \"ephemeral_tool\");\n\n var session1 = await Client1.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Tools = [toolA],\n });\n\n await Client2.ResumeSessionAsync(session1.SessionId, new ResumeSessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Tools = [toolB],\n });\n\n // Verify both tools work before disconnect (sequential to avoid nondeterministic tool_call ordering)\n var stableResponse = await session1.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Use the stable_tool with input 'test1' and tell me the result.\",\n });\n Assert.NotNull(stableResponse);\n Assert.Contains(\"STABLE_test1\", stableResponse!.Data.Content ?? string.Empty);\n\n var ephemeralResponse = await session1.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Use the ephemeral_tool with input 'test2' and tell me the result.\",\n });\n Assert.NotNull(ephemeralResponse);\n Assert.Contains(\"EPHEMERAL_test2\", ephemeralResponse!.Data.Content ?? string.Empty);\n\n // Disconnect client 2\n await Client2.ForceStopAsync();\n\n // Recreate client2 for cleanup\n var port = Client1.ActualPort!.Value;\n _client2 = new CopilotClient(new CopilotClientOptions\n {\n CliUrl = $\"localhost:{port}\",\n });\n\n // Now only stable_tool should be available\n var afterResponse = await session1.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Use the stable_tool with input 'still_here'. Also try using ephemeral_tool if it is available.\",\n });\n Assert.NotNull(afterResponse);\n Assert.Contains(\"STABLE_still_here\", afterResponse!.Data.Content ?? string.Empty);\n Assert.DoesNotContain(\"EPHEMERAL_\", afterResponse!.Data.Content ?? string.Empty);\n\n [Description(\"A tool that persists across disconnects\")]\n static string StableTool([Description(\"Input value\")] string input) => $\"STABLE_{input}\";\n\n [Description(\"A tool that will disappear when its client disconnects\")]\n static string EphemeralTool([Description(\"Input value\")] string input) => $\"EPHEMERAL_{input}\";\n }\n}\n" }, { "path": "dotnet/test/E2E/MultiTurnE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\n/// \n/// Verifies that information produced in one turn (e.g., the contents of a file\n/// just read or written) is available to subsequent turns in the same session.\n/// Mirrors nodejs/test/e2e/multi_turn.e2e.test.ts.\n/// \npublic class MultiTurnE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"multi_turn\", output)\n{\n [Fact]\n public async Task Should_Use_Tool_Results_From_Previous_Turns()\n {\n // Write a file, then ask the model to read it and reason about its content\n await File.WriteAllTextAsync(Path.Join(Ctx.WorkDir, \"secret.txt\"), \"The magic number is 42.\");\n var session = await CreateSessionAsync();\n\n var msg1 = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Read the file 'secret.txt' and tell me what the magic number is.\",\n });\n Assert.Contains(\"42\", msg1?.Data.Content ?? string.Empty);\n\n // Follow-up that requires context from the previous turn\n var msg2 = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is that magic number multiplied by 2?\",\n });\n Assert.Contains(\"84\", msg2?.Data.Content ?? string.Empty);\n }\n\n [Fact]\n public async Task Should_Handle_File_Creation_Then_Reading_Across_Turns()\n {\n var session = await CreateSessionAsync();\n\n // First turn: create a file\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Create a file called 'greeting.txt' with the content 'Hello from multi-turn test'.\",\n });\n\n // Second turn: read the file\n var msg = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Read the file 'greeting.txt' and tell me its exact contents.\",\n });\n Assert.Contains(\"Hello from multi-turn test\", msg?.Data.Content ?? string.Empty);\n }\n}\n" }, { "path": "dotnet/test/E2E/PendingWorkResumeE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.ComponentModel;\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Microsoft.Extensions.AI;\nusing Xunit;\nusing Xunit.Abstractions;\nusing RpcPermissionDecisionApproveOnce = GitHub.Copilot.SDK.Rpc.PermissionDecisionApproveOnce;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class PendingWorkResumeE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"pending_work_resume\", output)\n{\n private static readonly TimeSpan PendingWorkTimeout = TimeSpan.FromSeconds(60);\n\n [Fact]\n public async Task Should_Continue_Pending_Permission_Request_After_Resume()\n {\n var originalPermissionRequest = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n var releaseOriginalPermission = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n var resumedToolInvoked = false;\n\n await using var server = Ctx.CreateClient(useStdio: false);\n await server.StartAsync();\n var cliUrl = GetCliUrl(server);\n\n using var suspendedClient = Ctx.CreateClient(options: new CopilotClientOptions { CliUrl = cliUrl });\n var session1 = await suspendedClient.CreateSessionAsync(new SessionConfig\n {\n Tools = [AIFunctionFactory.Create(ResumePermissionTool, \"resume_permission_tool\")],\n OnPermissionRequest = (request, _) =>\n {\n originalPermissionRequest.TrySetResult(request);\n return releaseOriginalPermission.Task;\n },\n });\n var sessionId = session1.SessionId;\n\n try\n {\n var permissionRequested = TestHelper.GetNextEventOfTypeAsync(session1, PendingWorkTimeout);\n\n await session1.SendAsync(new MessageOptions\n {\n Prompt = \"Use resume_permission_tool with value 'alpha', then reply with the result.\",\n });\n\n var initialRequest = await originalPermissionRequest.Task.WaitAsync(PendingWorkTimeout);\n var permissionEvent = await permissionRequested;\n Assert.IsType(initialRequest);\n\n await suspendedClient.ForceStopAsync();\n\n await using var resumedTcpClient = Ctx.CreateClient(options: new CopilotClientOptions { CliUrl = cliUrl });\n var session2 = await resumedTcpClient.ResumeSessionAsync(sessionId, new ResumeSessionConfig\n {\n ContinuePendingWork = true,\n OnPermissionRequest = (_, _) => Task.FromResult(new PermissionRequestResult\n {\n Kind = PermissionRequestResultKind.NoResult\n }),\n Tools =\n [\n AIFunctionFactory.Create(\n ([Description(\"Value to transform\")] string value) =>\n {\n resumedToolInvoked = true;\n return $\"PERMISSION_RESUMED_{value.ToUpperInvariant()}\";\n },\n \"resume_permission_tool\")\n ],\n });\n\n var permissionResult = await session2.Rpc.Permissions.HandlePendingPermissionRequestAsync(\n permissionEvent.Data.RequestId,\n new RpcPermissionDecisionApproveOnce());\n Assert.True(permissionResult.Success);\n\n var answer = await TestHelper.GetFinalAssistantMessageAsync(session2, PendingWorkTimeout);\n\n Assert.True(resumedToolInvoked);\n Assert.Contains(\"PERMISSION_RESUMED_ALPHA\", answer?.Data.Content ?? string.Empty);\n\n await session2.DisposeAsync();\n await resumedTcpClient.ForceStopAsync();\n }\n finally\n {\n releaseOriginalPermission.TrySetResult(new PermissionRequestResult\n {\n Kind = PermissionRequestResultKind.UserNotAvailable,\n });\n }\n\n [Description(\"Transforms a value after permission is granted\")]\n static string ResumePermissionTool([Description(\"Value to transform\")] string value) =>\n $\"ORIGINAL_SHOULD_NOT_RUN_{value}\";\n }\n\n [Fact]\n public async Task Should_Continue_Pending_External_Tool_Request_After_Resume()\n {\n var originalToolStarted = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n var releaseOriginalTool = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n\n await using var server = Ctx.CreateClient(useStdio: false);\n await server.StartAsync();\n var cliUrl = GetCliUrl(server);\n\n using var suspendedClient = Ctx.CreateClient(options: new CopilotClientOptions { CliUrl = cliUrl });\n var session1 = await suspendedClient.CreateSessionAsync(new SessionConfig\n {\n Tools = [AIFunctionFactory.Create(BlockingExternalTool, \"resume_external_tool\")],\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n var sessionId = session1.SessionId;\n\n try\n {\n var toolRequested = WaitForExternalToolRequestAsync(session1, \"resume_external_tool\");\n\n await session1.SendAsync(new MessageOptions\n {\n Prompt = \"Use resume_external_tool with value 'beta', then reply with the result.\",\n });\n\n var toolEvent = await toolRequested;\n Assert.Equal(\"beta\", await originalToolStarted.Task.WaitAsync(PendingWorkTimeout));\n await suspendedClient.ForceStopAsync();\n\n await using var resumedClient = Ctx.CreateClient(options: new CopilotClientOptions { CliUrl = cliUrl });\n var session2 = await resumedClient.ResumeSessionAsync(sessionId, new ResumeSessionConfig\n {\n ContinuePendingWork = true,\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n var toolResult = await session2.Rpc.Tools.HandlePendingToolCallAsync(\n toolEvent.Data.RequestId,\n result: \"EXTERNAL_RESUMED_BETA\");\n Assert.True(toolResult.Success);\n\n var answer = await TestHelper.GetFinalAssistantMessageAsync(session2, PendingWorkTimeout);\n\n Assert.Contains(\"EXTERNAL_RESUMED_BETA\", answer?.Data.Content ?? string.Empty);\n\n await session2.DisposeAsync();\n await resumedClient.ForceStopAsync();\n }\n finally\n {\n releaseOriginalTool.TrySetResult(\"ORIGINAL_SHOULD_NOT_WIN\");\n }\n\n [Description(\"Looks up a value after resumption\")]\n async Task BlockingExternalTool([Description(\"Value to look up\")] string value)\n {\n originalToolStarted.TrySetResult(value);\n return await releaseOriginalTool.Task;\n }\n }\n\n [Fact]\n public async Task Should_Continue_Parallel_Pending_External_Tool_Requests_After_Resume()\n {\n var originalToolAStarted = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n var originalToolBStarted = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n var releaseOriginalToolA = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n var releaseOriginalToolB = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n\n await using var server = Ctx.CreateClient(useStdio: false);\n await server.StartAsync();\n var cliUrl = GetCliUrl(server);\n\n using var suspendedClient = Ctx.CreateClient(options: new CopilotClientOptions { CliUrl = cliUrl });\n var session1 = await suspendedClient.CreateSessionAsync(new SessionConfig\n {\n Tools =\n [\n AIFunctionFactory.Create(BlockingToolA, \"pending_lookup_a\"),\n AIFunctionFactory.Create(BlockingToolB, \"pending_lookup_b\"),\n ],\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n var sessionId = session1.SessionId;\n\n try\n {\n var toolRequests = WaitForExternalToolRequestsAsync(session1, [\"pending_lookup_a\", \"pending_lookup_b\"]);\n\n await session1.SendAsync(new MessageOptions\n {\n Prompt = \"Call pending_lookup_a with value 'alpha' and pending_lookup_b with value 'beta', then reply with both results.\",\n });\n\n var toolEvents = await toolRequests;\n await Task.WhenAll(\n originalToolAStarted.Task,\n originalToolBStarted.Task).WaitAsync(PendingWorkTimeout);\n Assert.Equal(\"alpha\", await originalToolAStarted.Task);\n Assert.Equal(\"beta\", await originalToolBStarted.Task);\n\n await suspendedClient.ForceStopAsync();\n\n await using var resumedClient = Ctx.CreateClient(options: new CopilotClientOptions { CliUrl = cliUrl });\n var session2 = await resumedClient.ResumeSessionAsync(sessionId, new ResumeSessionConfig\n {\n ContinuePendingWork = true,\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n var toolA = toolEvents[\"pending_lookup_a\"];\n var toolB = toolEvents[\"pending_lookup_b\"];\n var resultB = await session2.Rpc.Tools.HandlePendingToolCallAsync(\n toolB.Data.RequestId,\n result: \"PARALLEL_B_BETA\");\n Assert.True(resultB.Success);\n var resultA = await session2.Rpc.Tools.HandlePendingToolCallAsync(\n toolA.Data.RequestId,\n result: \"PARALLEL_A_ALPHA\");\n Assert.True(resultA.Success);\n\n var answer = await TestHelper.GetFinalAssistantMessageAsync(session2, PendingWorkTimeout);\n\n var content = answer?.Data.Content ?? string.Empty;\n Assert.Contains(\"PARALLEL_A_ALPHA\", content);\n Assert.Contains(\"PARALLEL_B_BETA\", content);\n\n await session2.DisposeAsync();\n await resumedClient.ForceStopAsync();\n }\n finally\n {\n releaseOriginalToolA.TrySetResult(\"ORIGINAL_A_SHOULD_NOT_WIN\");\n releaseOriginalToolB.TrySetResult(\"ORIGINAL_B_SHOULD_NOT_WIN\");\n }\n\n [Description(\"Looks up the first value after resumption\")]\n async Task BlockingToolA([Description(\"Value to look up\")] string value)\n {\n originalToolAStarted.TrySetResult(value);\n return await releaseOriginalToolA.Task;\n }\n\n [Description(\"Looks up the second value after resumption\")]\n async Task BlockingToolB([Description(\"Value to look up\")] string value)\n {\n originalToolBStarted.TrySetResult(value);\n return await releaseOriginalToolB.Task;\n }\n }\n\n [Fact]\n public async Task Should_Resume_Successfully_When_No_Pending_Work_Exists()\n {\n await using var server = Ctx.CreateClient(useStdio: false);\n await server.StartAsync();\n var cliUrl = GetCliUrl(server);\n\n string sessionId;\n await using (var firstClient = Ctx.CreateClient(options: new CopilotClientOptions { CliUrl = cliUrl }))\n {\n var firstSession = await firstClient.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n sessionId = firstSession.SessionId;\n\n var firstAnswer = await firstSession.SendAndWaitAsync(new MessageOptions { Prompt = \"Reply with exactly: NO_PENDING_TURN_ONE\" });\n Assert.Contains(\"NO_PENDING_TURN_ONE\", firstAnswer?.Data.Content ?? string.Empty);\n\n await firstSession.DisposeAsync();\n }\n\n await using var resumedClient = Ctx.CreateClient(options: new CopilotClientOptions { CliUrl = cliUrl });\n var resumedSession = await resumedClient.ResumeSessionAsync(sessionId, new ResumeSessionConfig\n {\n ContinuePendingWork = true,\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n // Resuming with ContinuePendingWork=true on a session whose previous turn already\n // completed must be a no-op for pending work and must leave the session usable.\n var followUp = await resumedSession.SendAndWaitAsync(new MessageOptions { Prompt = \"Reply with exactly: NO_PENDING_TURN_TWO\" });\n\n Assert.Contains(\"NO_PENDING_TURN_TWO\", followUp?.Data.Content ?? string.Empty);\n\n await resumedSession.DisposeAsync();\n }\n\n private static async Task WaitForExternalToolRequestAsync(\n CopilotSession session,\n string toolName)\n {\n var requests = await WaitForExternalToolRequestsAsync(session, [toolName]);\n return requests[toolName];\n }\n\n private static async Task> WaitForExternalToolRequestsAsync(\n CopilotSession session,\n IReadOnlyCollection toolNames)\n {\n var expected = toolNames.ToHashSet(StringComparer.Ordinal);\n var seen = new Dictionary(StringComparer.Ordinal);\n var tcs = new TaskCompletionSource>(\n TaskCreationOptions.RunContinuationsAsynchronously);\n using var cts = new CancellationTokenSource(PendingWorkTimeout);\n\n using var subscription = session.On(evt =>\n {\n if (evt is ExternalToolRequestedEvent toolEvent && expected.Contains(toolEvent.Data.ToolName))\n {\n seen[toolEvent.Data.ToolName] = toolEvent;\n if (seen.Count == expected.Count)\n {\n tcs.TrySetResult(new Dictionary(seen, StringComparer.Ordinal));\n }\n }\n else if (evt is SessionErrorEvent error)\n {\n tcs.TrySetException(new Exception(error.Data.Message ?? \"session error\"));\n }\n });\n\n using var registration = cts.Token.Register(() => tcs.TrySetException(\n new TimeoutException($\"Timeout waiting for external tool request(s): {string.Join(\", \", expected)}\")));\n\n return await tcs.Task;\n }\n\n private static string GetCliUrl(CopilotClient client)\n {\n var port = client.ActualPort\n ?? throw new InvalidOperationException(\"Expected the test server to be listening on a TCP port.\");\n return $\"localhost:{port}\";\n }\n}\n" }, { "path": "dotnet/test/E2E/PerSessionAuthE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class PerSessionAuthE2ETests(E2ETestFixture fixture, ITestOutputHelper output) : E2ETestBase(fixture, \"per-session-auth\", output)\n{\n /// \n /// Creates a client with COPILOT_DEBUG_GITHUB_API_URL redirected to the proxy\n /// so per-session auth token resolution (fetchCopilotUser) is intercepted.\n /// \n private CopilotClient CreateAuthTestClient()\n {\n var env = new Dictionary(Ctx.GetEnvironment())\n {\n [\"COPILOT_DEBUG_GITHUB_API_URL\"] = Ctx.ProxyUrl,\n };\n // Disable the harness's auto-injected fake GITHUB_TOKEN so the per-session\n // auth tests can validate session-scoped tokens (including the no-token case).\n return Ctx.CreateClient(options: new CopilotClientOptions { Environment = env }, autoInjectGitHubToken: false);\n }\n\n private async Task SetupCopilotUsersAsync()\n {\n await Ctx.SetCopilotUserByTokenAsync(\"token-alice\", new CopilotUserConfig(\n Login: \"alice\",\n CopilotPlan: \"individual_pro\",\n Endpoints: new CopilotUserEndpoints(Api: Ctx.ProxyUrl, Telemetry: \"https://localhost:1/telemetry\"),\n AnalyticsTrackingId: \"alice-tracking-id\"\n ));\n\n await Ctx.SetCopilotUserByTokenAsync(\"token-bob\", new CopilotUserConfig(\n Login: \"bob\",\n CopilotPlan: \"business\",\n Endpoints: new CopilotUserEndpoints(Api: Ctx.ProxyUrl, Telemetry: \"https://localhost:1/telemetry\"),\n AnalyticsTrackingId: \"bob-tracking-id\"\n ));\n }\n\n private CopilotClient? _authClient;\n\n private CopilotClient AuthClient => _authClient ??= CreateAuthTestClient();\n\n [Fact]\n public async Task ShouldAuthenticateWithGitHubToken()\n {\n await SetupCopilotUsersAsync();\n\n await using var session = await AuthClient.CreateSessionAsync(new SessionConfig\n {\n GitHubToken = \"token-alice\",\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n var status = await session.Rpc.Auth.GetStatusAsync();\n Assert.True(status.IsAuthenticated);\n Assert.Equal(\"alice\", status.Login);\n }\n\n [Fact]\n public async Task ShouldIsolateAuthBetweenSessions()\n {\n await SetupCopilotUsersAsync();\n\n await using var sessionA = await AuthClient.CreateSessionAsync(new SessionConfig\n {\n GitHubToken = \"token-alice\",\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n await using var sessionB = await AuthClient.CreateSessionAsync(new SessionConfig\n {\n GitHubToken = \"token-bob\",\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n var statusA = await sessionA.Rpc.Auth.GetStatusAsync();\n Assert.True(statusA.IsAuthenticated);\n Assert.Equal(\"alice\", statusA.Login);\n\n var statusB = await sessionB.Rpc.Auth.GetStatusAsync();\n Assert.True(statusB.IsAuthenticated);\n Assert.Equal(\"bob\", statusB.Login);\n }\n\n [Fact]\n public async Task ShouldBeUnauthenticatedWithoutToken()\n {\n await using var session = await AuthClient.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n var status = await session.Rpc.Auth.GetStatusAsync();\n // Without a per-session GitHub token, there is no per-session identity.\n // In CI the process-level fake token may still authenticate globally,\n // so we check Login rather than IsAuthenticated.\n Assert.True(string.IsNullOrEmpty(status.Login), $\"Expected no per-session login without token, got {status.Login}\");\n }\n\n [Fact]\n public async Task ShouldFailWithInvalidToken()\n {\n await SetupCopilotUsersAsync();\n\n var ex = await Assert.ThrowsAnyAsync(() => AuthClient.CreateSessionAsync(new SessionConfig\n {\n GitHubToken = \"invalid-token\",\n OnPermissionRequest = PermissionHandler.ApproveAll,\n }));\n Assert.Contains(\"401 Unauthorized\", ex.ToString(), StringComparison.OrdinalIgnoreCase);\n }\n}\n" }, { "path": "dotnet/test/E2E/PermissionE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class PermissionE2ETests(E2ETestFixture fixture, ITestOutputHelper output) : E2ETestBase(fixture, \"permissions\", output)\n{\n [Fact]\n public async Task Should_Invoke_Permission_Handler_For_Write_Operations()\n {\n var permissionRequests = new List();\n var permissionRequestReceived = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n CopilotSession? session = null;\n session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = (request, invocation) =>\n {\n permissionRequests.Add(request);\n Assert.Equal(session!.SessionId, invocation.SessionId);\n permissionRequestReceived.TrySetResult(request);\n return Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved });\n }\n });\n\n await File.WriteAllTextAsync(Path.Combine(Ctx.WorkDir, \"test.txt\"), \"original content\");\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Edit test.txt and replace 'original' with 'modified'\"\n });\n\n await permissionRequestReceived.Task.WaitAsync(TimeSpan.FromSeconds(30));\n await session.AbortAsync();\n\n // Should have received at least one permission request\n Assert.NotEmpty(permissionRequests);\n }\n\n [Fact]\n public async Task Should_Deny_Permission_When_Handler_Returns_Denied()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = (request, invocation) =>\n {\n return Task.FromResult(new PermissionRequestResult\n {\n Kind = PermissionRequestResultKind.Rejected\n });\n }\n });\n\n var testFilePath = Path.Combine(Ctx.WorkDir, \"protected.txt\");\n await File.WriteAllTextAsync(testFilePath, \"protected content\");\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Edit protected.txt and replace 'protected' with 'hacked'.\"\n });\n\n await TestHelper.GetFinalAssistantMessageAsync(session);\n\n // Verify the file was NOT modified\n var content = await File.ReadAllTextAsync(testFilePath);\n Assert.Equal(\"protected content\", content);\n }\n\n [Fact]\n public async Task Should_Deny_Tool_Operations_When_Handler_Explicitly_Denies()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = (_, _) =>\n Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.UserNotAvailable })\n });\n var permissionDenied = false;\n\n session.On(evt =>\n {\n if (evt is ToolExecutionCompleteEvent toolEvt &&\n !toolEvt.Data.Success &&\n toolEvt.Data.Error?.Message.Contains(\"Permission denied\") == true)\n {\n permissionDenied = true;\n }\n });\n\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Run 'node --version'\"\n });\n\n Assert.True(permissionDenied, \"Expected a tool.execution_complete event with Permission denied result\");\n }\n\n [Fact]\n public async Task Should_Work_With_Approve_All_Permission_Handler()\n {\n var session = await CreateSessionAsync(new SessionConfig());\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"What is 2+2?\"\n });\n\n var message = await TestHelper.GetFinalAssistantMessageAsync(session);\n Assert.Contains(\"4\", message?.Data.Content ?? string.Empty);\n }\n\n [Fact]\n public async Task Should_Handle_Async_Permission_Handler()\n {\n var permissionRequestReceived = false;\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = async (request, invocation) =>\n {\n permissionRequestReceived = true;\n await Task.Yield();\n return new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved };\n }\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Run 'echo test' and tell me what happens\"\n });\n\n await TestHelper.GetFinalAssistantMessageAsync(session);\n\n Assert.True(permissionRequestReceived, \"Permission request should have been received\");\n }\n\n [Fact]\n public async Task Should_Resume_Session_With_Permission_Handler()\n {\n var permissionRequestReceived = false;\n\n // Create session without permission handler\n var session1 = await CreateSessionAsync();\n var sessionId = session1.SessionId;\n await session1.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 1+1?\" });\n\n // Resume with permission handler\n var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig\n {\n OnPermissionRequest = (request, invocation) =>\n {\n permissionRequestReceived = true;\n return Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved });\n }\n });\n\n await session2.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Run 'echo resumed' for me\"\n });\n\n Assert.True(permissionRequestReceived, \"Permission request should have been received\");\n }\n\n [Fact]\n public async Task Should_Handle_Permission_Handler_Errors_Gracefully()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = (request, invocation) =>\n {\n // Simulate an error in the handler\n throw new InvalidOperationException(\"Handler error\");\n }\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Run 'echo test'. If you can't, say 'failed'.\"\n });\n\n var message = await TestHelper.GetFinalAssistantMessageAsync(session);\n\n // Should handle the error and deny permission\n Assert.Matches(\"fail|cannot|unable|permission\", message?.Data.Content?.ToLowerInvariant() ?? string.Empty);\n }\n\n [Fact]\n public async Task Should_Deny_Tool_Operations_When_Handler_Explicitly_Denies_After_Resume()\n {\n var session1 = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll\n });\n var sessionId = session1.SessionId;\n await session1.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 1+1?\" });\n\n var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig\n {\n OnPermissionRequest = (_, _) =>\n Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.UserNotAvailable })\n });\n var permissionDenied = false;\n\n session2.On(evt =>\n {\n if (evt is ToolExecutionCompleteEvent toolEvt &&\n !toolEvt.Data.Success &&\n toolEvt.Data.Error?.Message.Contains(\"Permission denied\") == true)\n {\n permissionDenied = true;\n }\n });\n\n await session2.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Run 'node --version'\"\n });\n\n Assert.True(permissionDenied, \"Expected a tool.execution_complete event with Permission denied result\");\n }\n\n [Fact]\n public async Task Should_Receive_ToolCallId_In_Permission_Requests()\n {\n var receivedToolCallId = false;\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = (request, invocation) =>\n {\n if (request is PermissionRequestShell shell && !string.IsNullOrEmpty(shell.ToolCallId))\n {\n receivedToolCallId = true;\n }\n return Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved });\n }\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Run 'echo test'\"\n });\n\n await TestHelper.GetFinalAssistantMessageAsync(session);\n\n Assert.True(receivedToolCallId, \"Should have received toolCallId in permission request\");\n }\n}\n" }, { "path": "dotnet/test/E2E/RpcAgentE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class RpcAgentE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"rpc_agents\", output)\n{\n [Fact]\n public async Task Should_List_Available_Custom_Agents()\n {\n var session = await CreateSessionAsync(new SessionConfig { CustomAgents = CreateCustomAgents() });\n\n var result = await session.Rpc.Agent.ListAsync();\n\n Assert.Equal(2, result.Agents.Count);\n Assert.Equal(\"test-agent\", result.Agents[0].Name);\n Assert.Equal(\"Test Agent\", result.Agents[0].DisplayName);\n Assert.Equal(\"A test agent\", result.Agents[0].Description);\n Assert.Equal(\"another-agent\", result.Agents[1].Name);\n }\n\n [Fact]\n public async Task Should_Return_Null_When_No_Agent_Is_Selected()\n {\n var session = await CreateSessionAsync(new SessionConfig { CustomAgents = [CreateCustomAgents()[0]] });\n\n var result = await session.Rpc.Agent.GetCurrentAsync();\n\n Assert.Null(result.Agent);\n }\n\n [Fact]\n public async Task Should_Select_And_Get_Current_Agent()\n {\n var session = await CreateSessionAsync(new SessionConfig { CustomAgents = [CreateCustomAgents()[0]] });\n\n var selectResult = await session.Rpc.Agent.SelectAsync(\"test-agent\");\n Assert.NotNull(selectResult.Agent);\n Assert.Equal(\"test-agent\", selectResult.Agent.Name);\n Assert.Equal(\"Test Agent\", selectResult.Agent.DisplayName);\n\n var currentResult = await session.Rpc.Agent.GetCurrentAsync();\n Assert.NotNull(currentResult.Agent);\n Assert.Equal(\"test-agent\", currentResult.Agent.Name);\n }\n\n [Fact]\n public async Task Should_Deselect_Current_Agent()\n {\n var session = await CreateSessionAsync(new SessionConfig { CustomAgents = [CreateCustomAgents()[0]] });\n\n await session.Rpc.Agent.SelectAsync(\"test-agent\");\n await session.Rpc.Agent.DeselectAsync();\n\n var currentResult = await session.Rpc.Agent.GetCurrentAsync();\n Assert.Null(currentResult.Agent);\n }\n\n [Fact]\n public async Task Should_Return_Empty_List_When_No_Custom_Agents_Configured()\n {\n var session = await CreateSessionAsync();\n\n var result = await session.Rpc.Agent.ListAsync();\n\n Assert.Empty(result.Agents);\n }\n\n [Fact]\n public async Task Should_Call_Agent_Reload()\n {\n var session = await CreateSessionAsync(new SessionConfig { CustomAgents = [CreateReloadAgent()] });\n\n var before = await session.Rpc.Agent.ListAsync();\n Assert.Single(before.Agents, agent => string.Equals(agent.Name, \"reload-test-agent\", StringComparison.Ordinal));\n\n var result = await session.Rpc.Agent.ReloadAsync();\n Assert.NotNull(result.Agents);\n\n // Lock in current runtime behavior so a fix becomes a test failure rather than a\n // silent regression: the runtime currently drops session-configured CustomAgents\n // on reload (it reloads only on-disk agents). Once the runtime preserves session\n // CustomAgents across reload, flip this to `Assert.Single(result.Agents,\n // a => a.Name == \"reload-test-agent\")` and update the comment.\n Assert.DoesNotContain(result.Agents, a => string.Equals(a.Name, \"reload-test-agent\", StringComparison.Ordinal));\n }\n\n private static List CreateCustomAgents() =>\n [\n new()\n {\n Name = \"test-agent\",\n DisplayName = \"Test Agent\",\n Description = \"A test agent\",\n Prompt = \"You are a test agent.\"\n },\n new()\n {\n Name = \"another-agent\",\n DisplayName = \"Another Agent\",\n Description = \"Another test agent\",\n Prompt = \"You are another agent.\"\n }\n ];\n\n private static CustomAgentConfig CreateReloadAgent() =>\n new()\n {\n Name = \"reload-test-agent\",\n DisplayName = \"Reload Test Agent\",\n Description = \"Used by the agent reload RPC test.\",\n Prompt = \"You are a reload test agent.\",\n };\n}\n" }, { "path": "dotnet/test/E2E/RpcMcpAndSkillsE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing Xunit;\nusing Xunit.Abstractions;\nusing RpcSkill = GitHub.Copilot.SDK.Rpc.Skill;\nusing RpcSkillList = GitHub.Copilot.SDK.Rpc.SkillList;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class RpcMcpAndSkillsE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"rpc_mcp_and_skills\", output)\n{\n private static async Task AssertFailureAsync(Func action, string expectedMessage)\n {\n var ex = await Assert.ThrowsAnyAsync(action);\n Assert.Contains(expectedMessage, ex.ToString(), StringComparison.OrdinalIgnoreCase);\n return ex;\n }\n\n [Fact]\n public async Task Should_List_And_Toggle_Session_Skills()\n {\n var skillName = $\"session-rpc-skill-{Guid.NewGuid():N}\";\n var skillsDir = CreateSkillDirectory(skillName, \"Session skill controlled by RPC.\");\n var session = await CreateSessionAsync(new SessionConfig\n {\n SkillDirectories = [skillsDir],\n DisabledSkills = [skillName],\n });\n\n var disabled = await session.Rpc.Skills.ListAsync();\n AssertSkill(disabled, skillName, enabled: false);\n\n await session.Rpc.Skills.EnableAsync(skillName);\n var enabled = await session.Rpc.Skills.ListAsync();\n AssertSkill(enabled, skillName, enabled: true);\n\n await session.Rpc.Skills.DisableAsync(skillName);\n var disabledAgain = await session.Rpc.Skills.ListAsync();\n AssertSkill(disabledAgain, skillName, enabled: false);\n }\n\n [Fact]\n public async Task Should_Reload_Session_Skills()\n {\n var skillsDir = Path.Join(Ctx.WorkDir, \"reloadable-rpc-skills\", Guid.NewGuid().ToString(\"N\"));\n Directory.CreateDirectory(skillsDir);\n var skillName = $\"reload-rpc-skill-{Guid.NewGuid():N}\";\n\n var session = await CreateSessionAsync(new SessionConfig { SkillDirectories = [skillsDir] });\n var before = await session.Rpc.Skills.ListAsync();\n Assert.DoesNotContain(before.Skills, skill => string.Equals(skill.Name, skillName, StringComparison.Ordinal));\n\n CreateSkill(skillsDir, skillName, \"Skill added after session creation.\");\n await session.Rpc.Skills.ReloadAsync();\n\n var after = await session.Rpc.Skills.ListAsync();\n var reloadedSkill = AssertSkill(after, skillName, enabled: true);\n Assert.Equal(\"Skill added after session creation.\", reloadedSkill.Description);\n }\n\n [Fact]\n public async Task Should_List_Mcp_Servers_With_Configured_Server()\n {\n const string serverName = \"rpc-list-mcp-server\";\n var session = await CreateSessionAsync(new SessionConfig\n {\n McpServers = new Dictionary\n {\n [serverName] = new McpStdioServerConfig\n {\n Command = \"echo\",\n Args = [\"rpc-list-mcp-server\"],\n Tools = [\"*\"],\n },\n },\n });\n\n var result = await session.Rpc.Mcp.ListAsync();\n\n var server = Assert.Single(result.Servers, server => string.Equals(server.Name, serverName, StringComparison.Ordinal));\n Assert.True(Enum.IsDefined(server.Status));\n }\n\n [Fact]\n public async Task Should_List_Plugins()\n {\n var session = await CreateSessionAsync();\n\n var result = await session.Rpc.Plugins.ListAsync();\n\n Assert.NotNull(result.Plugins);\n Assert.All(result.Plugins, plugin => Assert.False(string.IsNullOrWhiteSpace(plugin.Name)));\n }\n\n [Fact]\n public async Task Should_List_Extensions()\n {\n var session = await CreateSessionAsync();\n\n var result = await session.Rpc.Extensions.ListAsync();\n\n Assert.NotNull(result.Extensions);\n Assert.All(result.Extensions, extension =>\n {\n Assert.False(string.IsNullOrWhiteSpace(extension.Id));\n Assert.False(string.IsNullOrWhiteSpace(extension.Name));\n });\n }\n\n [Fact]\n public async Task Should_Report_Error_When_Mcp_Host_Is_Not_Initialized()\n {\n var session = await CreateSessionAsync();\n\n await AssertFailureAsync(\n () => session.Rpc.Mcp.EnableAsync(\"missing-server\"),\n \"No MCP host initialized\");\n await AssertFailureAsync(\n () => session.Rpc.Mcp.DisableAsync(\"missing-server\"),\n \"No MCP host initialized\");\n await AssertFailureAsync(\n () => session.Rpc.Mcp.ReloadAsync(),\n \"MCP config reload not available\");\n }\n\n [Fact]\n public async Task Should_Report_Error_When_Extensions_Are_Not_Available()\n {\n var session = await CreateSessionAsync();\n\n await AssertFailureAsync(\n () => session.Rpc.Extensions.EnableAsync(\"missing-extension\"),\n \"Extensions not available\");\n await AssertFailureAsync(\n () => session.Rpc.Extensions.DisableAsync(\"missing-extension\"),\n \"Extensions not available\");\n await AssertFailureAsync(\n () => session.Rpc.Extensions.ReloadAsync(),\n \"Extensions not available\");\n }\n\n private string CreateSkillDirectory(string skillName, string description)\n {\n var skillsDir = Path.Join(Ctx.WorkDir, \"session-rpc-skills\", Guid.NewGuid().ToString(\"N\"));\n Directory.CreateDirectory(skillsDir);\n CreateSkill(skillsDir, skillName, description);\n return skillsDir;\n }\n\n private static void CreateSkill(string skillsDir, string skillName, string description)\n {\n var skillSubdir = Path.Join(skillsDir, skillName);\n Directory.CreateDirectory(skillSubdir);\n\n var skillContent = $\"\"\"\n ---\n name: {skillName}\n description: {description}\n ---\n\n # {skillName}\n\n This skill is used by RPC E2E tests.\n \"\"\".ReplaceLineEndings(\"\\n\");\n File.WriteAllText(Path.Join(skillSubdir, \"SKILL.md\"), skillContent);\n }\n\n private static RpcSkill AssertSkill(RpcSkillList list, string skillName, bool enabled)\n {\n var skill = Assert.Single(list.Skills, skill => string.Equals(skill.Name, skillName, StringComparison.Ordinal));\n Assert.Equal(enabled, skill.Enabled);\n Assert.EndsWith(Path.Join(skillName, \"SKILL.md\"), skill.Path);\n return skill;\n }\n}\n" }, { "path": "dotnet/test/E2E/RpcMcpConfigE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.Text.Json;\nusing GitHub.Copilot.SDK.Rpc;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class RpcMcpConfigE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"rpc_mcp_config\", output)\n{\n [Fact]\n public async Task Should_Call_Server_Mcp_Config_Rpcs()\n {\n await Client.StartAsync();\n\n var serverName = $\"sdk-test-{Guid.NewGuid():N}\";\n var config = new Dictionary\n {\n [\"command\"] = \"node\",\n [\"args\"] = Array.Empty(),\n };\n var updatedConfig = new Dictionary\n {\n [\"command\"] = \"node\",\n [\"args\"] = new[] { \"--version\" },\n };\n\n var initial = await Client.Rpc.Mcp.Config.ListAsync();\n Assert.DoesNotContain(serverName, initial.Servers.Keys);\n\n try\n {\n await Client.Rpc.Mcp.Config.AddAsync(serverName, config);\n var afterAdd = await Client.Rpc.Mcp.Config.ListAsync();\n Assert.Contains(serverName, afterAdd.Servers.Keys);\n\n await Client.Rpc.Mcp.Config.UpdateAsync(serverName, updatedConfig);\n var afterUpdate = await Client.Rpc.Mcp.Config.ListAsync();\n var updated = GetServerConfig(afterUpdate, serverName);\n Assert.Equal(\"node\", updated.GetProperty(\"command\").GetString());\n Assert.Equal(\"--version\", updated.GetProperty(\"args\")[0].GetString());\n\n await Client.Rpc.Mcp.Config.DisableAsync([serverName]);\n await Client.Rpc.Mcp.Config.EnableAsync([serverName]);\n }\n finally\n {\n await Client.Rpc.Mcp.Config.RemoveAsync(serverName);\n }\n\n var afterRemove = await Client.Rpc.Mcp.Config.ListAsync();\n Assert.DoesNotContain(serverName, afterRemove.Servers.Keys);\n }\n\n [Fact]\n public async Task Should_RoundTrip_Http_Mcp_Oauth_Config_Rpc()\n {\n await Client.StartAsync();\n\n var serverName = $\"sdk-http-oauth-{Guid.NewGuid():N}\";\n var config = new McpHttpServerConfig\n {\n Url = \"https://example.com/mcp\",\n Headers = new Dictionary { [\"Authorization\"] = \"Bearer token\" },\n OauthClientId = \"client-id\",\n OauthPublicClient = false,\n OauthGrantType = McpHttpServerConfigOauthGrantType.ClientCredentials,\n Tools = [\"*\"],\n Timeout = 3000,\n };\n var updatedConfig = new McpHttpServerConfig\n {\n Url = \"https://example.com/updated-mcp\",\n OauthClientId = \"updated-client-id\",\n OauthPublicClient = true,\n OauthGrantType = McpHttpServerConfigOauthGrantType.AuthorizationCode,\n Tools = [\"updated-tool\"],\n Timeout = 4000,\n };\n\n try\n {\n await Client.Rpc.Mcp.Config.AddAsync(serverName, config);\n var afterAdd = await Client.Rpc.Mcp.Config.ListAsync();\n var added = GetServerConfig(afterAdd, serverName);\n Assert.Equal(\"http\", added.GetProperty(\"type\").GetString());\n Assert.Equal(\"https://example.com/mcp\", added.GetProperty(\"url\").GetString());\n Assert.Equal(\"Bearer token\", added.GetProperty(\"headers\").GetProperty(\"Authorization\").GetString());\n Assert.Equal(\"client-id\", added.GetProperty(\"oauthClientId\").GetString());\n Assert.False(added.GetProperty(\"oauthPublicClient\").GetBoolean());\n Assert.Equal(\"client_credentials\", added.GetProperty(\"oauthGrantType\").GetString());\n\n await Client.Rpc.Mcp.Config.UpdateAsync(serverName, updatedConfig);\n var afterUpdate = await Client.Rpc.Mcp.Config.ListAsync();\n var updated = GetServerConfig(afterUpdate, serverName);\n Assert.Equal(\"https://example.com/updated-mcp\", updated.GetProperty(\"url\").GetString());\n Assert.Equal(\"updated-client-id\", updated.GetProperty(\"oauthClientId\").GetString());\n Assert.True(updated.GetProperty(\"oauthPublicClient\").GetBoolean());\n Assert.Equal(\"authorization_code\", updated.GetProperty(\"oauthGrantType\").GetString());\n Assert.Equal(\"updated-tool\", updated.GetProperty(\"tools\")[0].GetString());\n Assert.Equal(4000, updated.GetProperty(\"timeout\").GetInt32());\n }\n finally\n {\n await Client.Rpc.Mcp.Config.RemoveAsync(serverName);\n }\n\n var afterRemove = await Client.Rpc.Mcp.Config.ListAsync();\n Assert.DoesNotContain(serverName, afterRemove.Servers.Keys);\n }\n\n private static JsonElement GetServerConfig(McpConfigList list, string serverName)\n {\n Assert.True(\n list.Servers.TryGetValue(serverName, out var rawConfig),\n $\"Expected MCP server '{serverName}' to be present.\");\n return Assert.IsType(rawConfig);\n }\n}\n" }, { "path": "dotnet/test/E2E/RpcServerE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Rpc;\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class RpcServerE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"rpc_server\", output)\n{\n private CopilotClient CreateAuthenticatedClient(string token)\n {\n var env = new Dictionary(Ctx.GetEnvironment())\n {\n [\"COPILOT_DEBUG_GITHUB_API_URL\"] = Ctx.ProxyUrl,\n };\n\n return Ctx.CreateClient(options: new CopilotClientOptions\n {\n Environment = env,\n GitHubToken = token,\n });\n }\n\n private async Task ConfigureAuthenticatedUserAsync(\n string token,\n IReadOnlyDictionary? quotaSnapshots = null)\n {\n await Ctx.SetCopilotUserByTokenAsync(token, new CopilotUserConfig(\n Login: \"rpc-user\",\n CopilotPlan: \"individual_pro\",\n Endpoints: new CopilotUserEndpoints(Api: Ctx.ProxyUrl, Telemetry: \"https://localhost:1/telemetry\"),\n AnalyticsTrackingId: \"rpc-user-tracking-id\",\n QuotaSnapshots: quotaSnapshots));\n }\n\n [Fact]\n public async Task Should_Call_Rpc_Ping_With_Typed_Params_And_Result()\n {\n await Client.StartAsync();\n\n var result = await Client.Rpc.PingAsync(message: \"typed rpc test\");\n\n Assert.Equal(\"pong: typed rpc test\", result.Message);\n Assert.True(result.Timestamp >= 0);\n }\n\n [Fact]\n public async Task Should_Call_Rpc_Models_List_With_Typed_Result()\n {\n const string token = \"rpc-models-token\";\n await ConfigureAuthenticatedUserAsync(token);\n await using var client = CreateAuthenticatedClient(token);\n await client.StartAsync();\n\n var result = await client.Rpc.Models.ListAsync();\n\n Assert.NotNull(result.Models);\n Assert.Contains(result.Models, model => model.Id == \"claude-sonnet-4.5\");\n Assert.All(result.Models, model => Assert.False(string.IsNullOrWhiteSpace(model.Name)));\n }\n\n [Fact]\n public async Task Should_Call_Rpc_Account_GetQuota_When_Authenticated()\n {\n const string token = \"rpc-quota-token\";\n await ConfigureAuthenticatedUserAsync(\n token,\n new Dictionary\n {\n [\"chat\"] = new(\n Entitlement: 100,\n OverageCount: 2,\n OveragePermitted: true,\n PercentRemaining: 75,\n TimestampUtc: \"2026-04-30T00:00:00Z\"),\n });\n await using var client = CreateAuthenticatedClient(token);\n await client.StartAsync();\n\n var result = await client.Rpc.Account.GetQuotaAsync(gitHubToken: token);\n\n var chatQuota = Assert.Contains(\"chat\", result.QuotaSnapshots);\n Assert.Equal(100, chatQuota.EntitlementRequests);\n Assert.Equal(25, chatQuota.UsedRequests);\n Assert.Equal(75, chatQuota.RemainingPercentage);\n Assert.Equal(2, chatQuota.Overage);\n Assert.True(chatQuota.UsageAllowedWithExhaustedQuota);\n Assert.True(chatQuota.OverageAllowedWithExhaustedQuota);\n Assert.Equal(\"2026-04-30T00:00:00Z\", chatQuota.ResetDate);\n }\n\n [Fact]\n public async Task Should_Call_Rpc_Tools_List_With_Typed_Result()\n {\n await Client.StartAsync();\n\n var result = await Client.Rpc.Tools.ListAsync();\n\n Assert.NotNull(result.Tools);\n Assert.NotEmpty(result.Tools);\n Assert.All(result.Tools, tool => Assert.False(string.IsNullOrWhiteSpace(tool.Name)));\n }\n\n [Fact]\n public async Task Should_Discover_Server_Mcp_And_Skills()\n {\n await Client.StartAsync();\n\n var skillName = $\"server-rpc-skill-{Guid.NewGuid():N}\";\n var skillDirectory = CreateSkillDirectory(skillName, \"Skill discovered by server-scoped RPC tests.\");\n\n var mcp = await Client.Rpc.Mcp.DiscoverAsync(workingDirectory: Ctx.WorkDir);\n Assert.NotNull(mcp.Servers);\n\n var skills = await Client.Rpc.Skills.DiscoverAsync(skillDirectories: [skillDirectory]);\n var discoveredSkill = Assert.Single(skills.Skills, skill => string.Equals(skill.Name, skillName, StringComparison.Ordinal));\n Assert.Equal(\"Skill discovered by server-scoped RPC tests.\", discoveredSkill.Description);\n Assert.True(discoveredSkill.Enabled);\n Assert.EndsWith(Path.Join(skillName, \"SKILL.md\"), discoveredSkill.Path);\n\n try\n {\n await Client.Rpc.Skills.Config.SetDisabledSkillsAsync([skillName]);\n var disabledSkills = await Client.Rpc.Skills.DiscoverAsync(skillDirectories: [skillDirectory]);\n var disabledSkill = Assert.Single(disabledSkills.Skills, skill => string.Equals(skill.Name, skillName, StringComparison.Ordinal));\n Assert.False(disabledSkill.Enabled);\n }\n finally\n {\n await Client.Rpc.Skills.Config.SetDisabledSkillsAsync([]);\n }\n }\n\n private string CreateSkillDirectory(string skillName, string description)\n {\n var skillsDir = Path.Join(Ctx.WorkDir, \"server-rpc-skills\", Guid.NewGuid().ToString(\"N\"));\n var skillSubdir = Path.Join(skillsDir, skillName);\n Directory.CreateDirectory(skillSubdir);\n\n var skillContent = $\"\"\"\n ---\n name: {skillName}\n description: {description}\n ---\n\n # {skillName}\n\n This skill is used by RPC E2E tests.\n \"\"\".ReplaceLineEndings(\"\\n\");\n File.WriteAllText(Path.Join(skillSubdir, \"SKILL.md\"), skillContent);\n\n return skillsDir;\n }\n}\n" }, { "path": "dotnet/test/E2E/RpcSessionStateE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing GitHub.Copilot.SDK.Rpc;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class RpcSessionStateE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"rpc_session_state\", output)\n{\n private static async Task AssertImplementedFailureAsync(Func action, string method)\n {\n var ex = await Assert.ThrowsAnyAsync(action);\n Assert.DoesNotContain($\"Unhandled method {method}\", ex.ToString(), StringComparison.OrdinalIgnoreCase);\n return ex;\n }\n\n [Fact]\n public async Task Should_Call_Session_Rpc_Model_GetCurrent()\n {\n var session = await CreateSessionAsync(new SessionConfig { Model = \"claude-sonnet-4.5\" });\n\n var result = await session.Rpc.Model.GetCurrentAsync();\n\n Assert.NotNull(result.ModelId);\n Assert.NotEmpty(result.ModelId);\n // Strengthen: verify the configured model is actually in effect, not just any model\n Assert.Equal(\"claude-sonnet-4.5\", result.ModelId);\n }\n\n [Fact]\n public async Task Should_Call_Session_Rpc_Model_SwitchTo()\n {\n var session = await CreateSessionAsync(new SessionConfig { Model = \"claude-sonnet-4.5\" });\n\n var before = await session.Rpc.Model.GetCurrentAsync();\n Assert.NotNull(before.ModelId);\n\n var result = await session.Rpc.Model.SwitchToAsync(modelId: \"gpt-4.1\", reasoningEffort: \"high\");\n var after = await session.Rpc.Model.GetCurrentAsync();\n\n Assert.Equal(\"gpt-4.1\", result.ModelId);\n Assert.Equal(before.ModelId, after.ModelId);\n }\n\n [Fact]\n public async Task Should_Get_And_Set_Session_Mode()\n {\n var session = await CreateSessionAsync();\n\n var initial = await session.Rpc.Mode.GetAsync();\n Assert.Equal(SessionMode.Interactive, initial);\n\n await session.Rpc.Mode.SetAsync(SessionMode.Plan);\n Assert.Equal(SessionMode.Plan, await session.Rpc.Mode.GetAsync());\n\n await session.Rpc.Mode.SetAsync(SessionMode.Interactive);\n Assert.Equal(SessionMode.Interactive, await session.Rpc.Mode.GetAsync());\n }\n\n [Fact]\n public async Task Should_Read_Update_And_Delete_Plan()\n {\n var session = await CreateSessionAsync();\n\n var initial = await session.Rpc.Plan.ReadAsync();\n Assert.False(initial.Exists);\n Assert.Null(initial.Content);\n\n var planContent = \"# Test Plan\\n\\n- Step 1\\n- Step 2\";\n await session.Rpc.Plan.UpdateAsync(planContent);\n\n var afterUpdate = await session.Rpc.Plan.ReadAsync();\n Assert.True(afterUpdate.Exists);\n Assert.Equal(planContent, afterUpdate.Content);\n\n await session.Rpc.Plan.DeleteAsync();\n\n var afterDelete = await session.Rpc.Plan.ReadAsync();\n Assert.False(afterDelete.Exists);\n Assert.Null(afterDelete.Content);\n }\n\n [Fact]\n public async Task Should_Call_Workspace_File_Rpc_Methods()\n {\n var session = await CreateSessionAsync();\n\n var initial = await session.Rpc.Workspaces.ListFilesAsync();\n Assert.NotNull(initial.Files);\n\n await session.Rpc.Workspaces.CreateFileAsync(\"test.txt\", \"Hello, workspace!\");\n\n var afterCreate = await session.Rpc.Workspaces.ListFilesAsync();\n Assert.Contains(\"test.txt\", afterCreate.Files);\n\n var file = await session.Rpc.Workspaces.ReadFileAsync(\"test.txt\");\n Assert.Equal(\"Hello, workspace!\", file.Content);\n\n var workspace = await session.Rpc.Workspaces.GetWorkspaceAsync();\n Assert.NotNull(workspace.Workspace);\n Assert.NotEqual(Guid.Empty, workspace.Workspace.Id);\n }\n\n [Fact]\n public async Task Should_Get_And_Set_Session_Metadata()\n {\n var session = await CreateSessionAsync();\n\n await session.Rpc.Name.SetAsync(\"SDK test session\");\n var name = await session.Rpc.Name.GetAsync();\n Assert.Equal(\"SDK test session\", name.Name);\n\n var sources = await session.Rpc.Instructions.GetSourcesAsync();\n Assert.NotNull(sources.Sources);\n }\n\n [Fact]\n public async Task Should_Fork_Session_With_Persisted_Messages()\n {\n const string sourcePrompt = \"Say FORK_SOURCE_ALPHA exactly.\";\n const string forkPrompt = \"Now say FORK_CHILD_BETA exactly.\";\n\n var session = await CreateSessionAsync();\n\n var initialAnswer = await session.SendAndWaitAsync(new MessageOptions { Prompt = sourcePrompt });\n Assert.Contains(\"FORK_SOURCE_ALPHA\", initialAnswer?.Data.Content ?? string.Empty);\n\n var sourceConversation = GetConversationMessages(await session.GetMessagesAsync());\n Assert.Contains(sourceConversation, message => message.Role == \"user\" && message.Content == sourcePrompt);\n Assert.Contains(sourceConversation, message => message.Role == \"assistant\" && message.Content.Contains(\"FORK_SOURCE_ALPHA\", StringComparison.Ordinal));\n\n var fork = await Client.Rpc.Sessions.ForkAsync(session.SessionId);\n Assert.False(string.IsNullOrWhiteSpace(fork.SessionId));\n Assert.NotEqual(session.SessionId, fork.SessionId);\n\n var forkedSession = await ResumeSessionAsync(fork.SessionId);\n var forkedConversation = GetConversationMessages(await forkedSession.GetMessagesAsync());\n Assert.Equal(sourceConversation, forkedConversation.Take(sourceConversation.Count));\n\n var forkAnswer = await forkedSession.SendAndWaitAsync(new MessageOptions { Prompt = forkPrompt });\n Assert.Contains(\"FORK_CHILD_BETA\", forkAnswer?.Data.Content ?? string.Empty);\n\n var sourceAfterFork = GetConversationMessages(await session.GetMessagesAsync());\n Assert.DoesNotContain(sourceAfterFork, message => message.Content == forkPrompt);\n\n var forkAfterPrompt = GetConversationMessages(await forkedSession.GetMessagesAsync());\n Assert.Contains(forkAfterPrompt, message => message.Role == \"user\" && message.Content == forkPrompt);\n Assert.Contains(forkAfterPrompt, message => message.Role == \"assistant\" && message.Content.Contains(\"FORK_CHILD_BETA\", StringComparison.Ordinal));\n\n await forkedSession.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Report_Error_When_Forking_Session_Without_Persisted_Events()\n {\n var session = await CreateSessionAsync();\n\n var ex = await Assert.ThrowsAnyAsync(() => Client.Rpc.Sessions.ForkAsync(session.SessionId));\n\n Assert.Contains(\"not found or has no persisted events\", ex.ToString(), StringComparison.OrdinalIgnoreCase);\n Assert.DoesNotContain(\"Unhandled method sessions.fork\", ex.ToString(), StringComparison.OrdinalIgnoreCase);\n }\n\n [Fact]\n public async Task Should_Call_Session_Usage_And_Permission_Rpcs()\n {\n var session = await CreateSessionAsync();\n\n var metrics = await session.Rpc.Usage.GetMetricsAsync();\n Assert.True(metrics.SessionStartTime > 0);\n Assert.True(metrics.TotalNanoAiu is null or >= 0);\n if (metrics.TokenDetails is not null)\n {\n Assert.All(metrics.TokenDetails.Values, detail => Assert.True(detail.TokenCount >= 0));\n }\n\n Assert.All(\n metrics.ModelMetrics.Values,\n modelMetric =>\n {\n Assert.True(modelMetric.TotalNanoAiu is null or >= 0);\n if (modelMetric.TokenDetails is not null)\n {\n Assert.All(modelMetric.TokenDetails.Values, detail => Assert.True(detail.TokenCount >= 0));\n }\n });\n\n try\n {\n var approveAll = await session.Rpc.Permissions.SetApproveAllAsync(true);\n Assert.True(approveAll.Success);\n\n var reset = await session.Rpc.Permissions.ResetSessionApprovalsAsync();\n Assert.True(reset.Success);\n }\n finally\n {\n await session.Rpc.Permissions.SetApproveAllAsync(false);\n }\n }\n\n [Fact]\n public async Task Should_Report_Implemented_Errors_For_Unsupported_Session_Rpc_Paths()\n {\n var session = await CreateSessionAsync();\n\n await AssertImplementedFailureAsync(\n () => session.Rpc.History.TruncateAsync(\"missing-event\"),\n \"session.history.truncate\");\n\n await AssertImplementedFailureAsync(\n () => session.Rpc.Mcp.Oauth.LoginAsync(\"missing-server\"),\n \"session.mcp.oauth.login\");\n }\n\n [Fact]\n public async Task Should_Compact_Session_History_After_Messages()\n {\n var session = await CreateSessionAsync();\n\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 2+2?\" });\n\n var result = await session.Rpc.History.CompactAsync();\n\n Assert.NotNull(result);\n }\n\n private static List<(string Role, string Content)> GetConversationMessages(IEnumerable events)\n {\n var messages = new List<(string Role, string Content)>();\n foreach (var evt in events)\n {\n switch (evt)\n {\n case UserMessageEvent user:\n messages.Add((\"user\", user.Data.Content));\n break;\n case AssistantMessageEvent assistant:\n messages.Add((\"assistant\", assistant.Data.Content));\n break;\n }\n }\n\n return messages;\n }\n}\n" }, { "path": "dotnet/test/E2E/RpcShellAndFleetE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Rpc;\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Microsoft.Extensions.AI;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class RpcShellAndFleetE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"rpc_shell_and_fleet\", output)\n{\n [Fact]\n public async Task Should_Execute_Shell_Command()\n {\n var session = await CreateSessionAsync();\n var markerPath = Path.Join(Ctx.WorkDir, $\"shell-rpc-{Guid.NewGuid():N}.txt\");\n const string marker = \"copilot-sdk-shell-rpc\";\n\n var result = await session.Rpc.Shell.ExecAsync(CreateWriteFileCommand(markerPath, marker), cwd: Ctx.WorkDir);\n\n Assert.False(string.IsNullOrWhiteSpace(result.ProcessId));\n await WaitForFileTextAsync(markerPath, marker);\n }\n\n [Fact]\n public async Task Should_Kill_Shell_Process()\n {\n var session = await CreateSessionAsync();\n var command = OperatingSystem.IsWindows()\n ? \"powershell -NoLogo -NoProfile -Command \\\"Start-Sleep -Seconds 30\\\"\"\n : \"sleep 30\";\n\n var execResult = await session.Rpc.Shell.ExecAsync(command);\n Assert.False(string.IsNullOrWhiteSpace(execResult.ProcessId));\n\n var killResult = await session.Rpc.Shell.KillAsync(execResult.ProcessId);\n\n Assert.True(killResult.Killed);\n }\n\n [Fact]\n public async Task Should_Start_Fleet_And_Complete_Custom_Tool_Task()\n {\n var markerPath = Path.Join(Ctx.WorkDir, $\"fleet-rpc-{Guid.NewGuid():N}.txt\");\n const string marker = \"copilot-sdk-fleet-rpc\";\n const string toolName = \"record_fleet_completion\";\n var session = await CreateSessionAsync(new SessionConfig\n {\n Tools = [AIFunctionFactory.Create(RecordFleetCompletion, toolName, \"Records completion of the fleet validation task.\")],\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n var prompt = $\"Use the {toolName} tool with content '{marker}', then report that the fleet task is complete.\";\n\n var result = await session.Rpc.Fleet.StartAsync(prompt);\n\n Assert.True(result.Started);\n await WaitForFileTextAsync(markerPath, marker);\n\n var messages = await WaitForMessagesAsync(\n session,\n messages => messages.OfType().Any(m =>\n (m.Data.Content ?? string.Empty).Contains(\"fleet task\", StringComparison.OrdinalIgnoreCase)));\n\n Assert.Contains(messages.OfType(), message => message.Data.Content.Contains(prompt, StringComparison.Ordinal));\n Assert.Contains(messages.OfType(), message => message.Data.ToolName == toolName);\n Assert.Contains(\n messages.OfType(),\n message => message.Data.Success &&\n (message.Data.Result?.Content?.Contains(marker, StringComparison.Ordinal) ?? false));\n Assert.Contains(\n messages.OfType(),\n message => (message.Data.Content ?? string.Empty).Contains(\"fleet task\", StringComparison.OrdinalIgnoreCase));\n\n string RecordFleetCompletion(string content)\n {\n File.WriteAllText(markerPath, content);\n return content;\n }\n }\n\n private static string CreateWriteFileCommand(string markerPath, string marker)\n {\n if (OperatingSystem.IsWindows())\n {\n return $\"powershell -NoLogo -NoProfile -Command \\\"Set-Content -LiteralPath '{markerPath}' -Value '{marker}'\\\"\";\n }\n\n return $\"sh -c \\\"printf '%s' '{marker}' > '{markerPath}'\\\"\";\n }\n\n private static async Task WaitForFileTextAsync(string path, string expected)\n {\n using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(30));\n while (!cts.IsCancellationRequested)\n {\n if (File.Exists(path) && (await File.ReadAllTextAsync(path)).Contains(expected, StringComparison.Ordinal))\n {\n return;\n }\n\n try\n {\n await Task.Delay(TimeSpan.FromMilliseconds(100), cts.Token);\n }\n catch (OperationCanceledException)\n {\n break;\n }\n }\n\n throw new TimeoutException($\"Timed out waiting for shell command to write '{expected}' to '{path}'.\");\n }\n\n private static async Task> WaitForMessagesAsync(\n CopilotSession session,\n Func, bool> predicate)\n {\n // Fleet-mode tasks do not emit SessionIdleEvent on completion, so polling the\n // session message list is the simplest way to wait for the assistant's final\n // reply text without depending on idle-event semantics.\n using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(120));\n while (!cts.IsCancellationRequested)\n {\n var messages = (await session.GetMessagesAsync()).ToList();\n if (predicate(messages))\n {\n return messages;\n }\n\n try\n {\n await Task.Delay(TimeSpan.FromMilliseconds(250), cts.Token);\n }\n catch (OperationCanceledException)\n {\n break;\n }\n }\n\n throw new TimeoutException(\"Timed out waiting for fleet-mode assistant reply to satisfy predicate.\");\n }\n}\n" }, { "path": "dotnet/test/E2E/RpcTasksAndHandlersE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Rpc;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class RpcTasksAndHandlersE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"rpc_tasks_and_handlers\", output)\n{\n private static async Task AssertImplementedFailureAsync(Func action, string method)\n {\n var ex = await Assert.ThrowsAnyAsync(action);\n Assert.DoesNotContain($\"Unhandled method {method}\", ex.ToString(), StringComparison.OrdinalIgnoreCase);\n }\n\n [Fact]\n public async Task Should_List_Task_State_And_Return_False_For_Missing_Task_Operations()\n {\n var session = await CreateSessionAsync();\n\n var tasks = await session.Rpc.Tasks.ListAsync();\n Assert.NotNull(tasks.Tasks);\n Assert.Empty(tasks.Tasks);\n\n var promote = await session.Rpc.Tasks.PromoteToBackgroundAsync(\"missing-task\");\n Assert.False(promote.Promoted);\n\n var cancel = await session.Rpc.Tasks.CancelAsync(\"missing-task\");\n Assert.False(cancel.Cancelled);\n\n var remove = await session.Rpc.Tasks.RemoveAsync(\"missing-task\");\n Assert.False(remove.Removed);\n }\n\n [Fact]\n public async Task Should_Report_Implemented_Error_For_Missing_Task_Agent_Type()\n {\n var session = await CreateSessionAsync();\n\n await AssertImplementedFailureAsync(\n () => session.Rpc.Tasks.StartAgentAsync(\n agentType: \"missing-agent-type\",\n prompt: \"Say hi\",\n name: \"sdk-test-task\"),\n \"session.tasks.startAgent\");\n }\n\n [Fact]\n public async Task Should_Return_Expected_Results_For_Missing_Pending_Handler_RequestIds()\n {\n var session = await CreateSessionAsync();\n\n var tool = await session.Rpc.Tools.HandlePendingToolCallAsync(\n requestId: \"missing-tool-request\",\n result: \"tool result\");\n Assert.False(tool.Success);\n\n var command = await session.Rpc.Commands.HandlePendingCommandAsync(\n requestId: \"missing-command-request\",\n error: \"command error\");\n Assert.True(command.Success);\n\n var elicitation = await session.Rpc.Ui.HandlePendingElicitationAsync(\n requestId: \"missing-elicitation-request\",\n result: new UIElicitationResponse { Action = UIElicitationResponseAction.Cancel });\n Assert.False(elicitation.Success);\n\n var permission = await session.Rpc.Permissions.HandlePendingPermissionRequestAsync(\n requestId: \"missing-permission-request\",\n result: new PermissionDecisionReject { Feedback = \"not approved\" });\n Assert.False(permission.Success);\n\n var permanentPermission = await session.Rpc.Permissions.HandlePendingPermissionRequestAsync(\n requestId: \"missing-permanent-permission-request\",\n result: new PermissionDecisionApprovePermanently { Domain = \"example.com\" });\n Assert.False(permanentPermission.Success);\n }\n}\n" }, { "path": "dotnet/test/E2E/SessionConfigE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.Linq;\nusing System.Text.Json;\nusing GitHub.Copilot.SDK.Rpc;\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class SessionConfigE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"session_config\", output)\n{\n private const string ViewImagePrompt = \"Use the view tool to look at the file test.png and describe what you see\";\n private const string ProviderHeaderName = \"x-copilot-sdk-provider-header\";\n private const string ClientName = \"csharp-public-surface-client\";\n\n private static readonly byte[] Png1X1 = Convert.FromBase64String(\n \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\");\n\n [Fact]\n public async Task Vision_Disabled_Then_Enabled_Via_SetModel()\n {\n await File.WriteAllBytesAsync(Path.Join(Ctx.WorkDir, \"test.png\"), Png1X1);\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-sonnet-4.5\",\n ModelCapabilities = new ModelCapabilitiesOverride\n {\n Supports = new ModelCapabilitiesOverrideSupports { Vision = false },\n },\n });\n\n // Turn 1: vision off — no image_url expected\n await session.SendAndWaitAsync(new MessageOptions { Prompt = ViewImagePrompt });\n var trafficAfterT1 = await Ctx.GetExchangesAsync();\n var t1Messages = trafficAfterT1.SelectMany(e => e.Request.Messages).ToList();\n Assert.False(HasImageUrlContent(t1Messages), \"Expected no image_url content when vision is disabled\");\n\n // Switch vision on\n await session.SetModelAsync(\n \"claude-sonnet-4.5\",\n reasoningEffort: null,\n modelCapabilities: new ModelCapabilitiesOverride\n {\n Supports = new ModelCapabilitiesOverrideSupports { Vision = true },\n });\n\n // Turn 2: vision on — image_url expected\n await session.SendAndWaitAsync(new MessageOptions { Prompt = ViewImagePrompt });\n var trafficAfterT2 = await Ctx.GetExchangesAsync();\n var newExchanges = trafficAfterT2.Skip(trafficAfterT1.Count).ToList();\n Assert.NotEmpty(newExchanges);\n var t2Messages = newExchanges.SelectMany(e => e.Request.Messages).ToList();\n Assert.True(HasImageUrlContent(t2Messages), \"Expected image_url content when vision is enabled\");\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Vision_Enabled_Then_Disabled_Via_SetModel()\n {\n await File.WriteAllBytesAsync(Path.Join(Ctx.WorkDir, \"test.png\"), Png1X1);\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-sonnet-4.5\",\n ModelCapabilities = new ModelCapabilitiesOverride\n {\n Supports = new ModelCapabilitiesOverrideSupports { Vision = true },\n },\n });\n\n // Turn 1: vision on — image_url expected\n await session.SendAndWaitAsync(new MessageOptions { Prompt = ViewImagePrompt });\n var trafficAfterT1 = await Ctx.GetExchangesAsync();\n var t1Messages = trafficAfterT1.SelectMany(e => e.Request.Messages).ToList();\n Assert.True(HasImageUrlContent(t1Messages), \"Expected image_url content when vision is enabled\");\n\n // Switch vision off\n await session.SetModelAsync(\n \"claude-sonnet-4.5\",\n reasoningEffort: null,\n modelCapabilities: new ModelCapabilitiesOverride\n {\n Supports = new ModelCapabilitiesOverrideSupports { Vision = false },\n });\n\n // Turn 2: vision off — no image_url expected in new exchanges\n await session.SendAndWaitAsync(new MessageOptions { Prompt = ViewImagePrompt });\n var trafficAfterT2 = await Ctx.GetExchangesAsync();\n var newExchanges = trafficAfterT2.Skip(trafficAfterT1.Count).ToList();\n Assert.NotEmpty(newExchanges);\n var t2Messages = newExchanges.SelectMany(e => e.Request.Messages).ToList();\n Assert.False(HasImageUrlContent(t2Messages), \"Expected no image_url content when vision is disabled\");\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Use_Custom_SessionId()\n {\n var requestedSessionId = Guid.NewGuid().ToString();\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n SessionId = requestedSessionId,\n });\n\n Assert.Equal(requestedSessionId, session.SessionId);\n\n var messages = await session.GetMessagesAsync();\n var startEvent = Assert.IsType(messages[0]);\n Assert.Equal(requestedSessionId, startEvent.Data.SessionId);\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Forward_ClientName_In_UserAgent()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n ClientName = ClientName,\n });\n\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 1+1?\" });\n\n var exchange = Assert.Single(await Ctx.GetExchangesAsync());\n AssertHeaderContains(exchange.RequestHeaders, \"user-agent\", ClientName);\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Forward_Custom_Provider_Headers_On_Create()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-sonnet-4.5\",\n Provider = CreateProxyProvider(\"create-provider-header\"),\n });\n\n var message = await session.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 1+1?\" });\n Assert.Contains(\"2\", message?.Data.Content ?? string.Empty);\n\n var exchange = Assert.Single(await Ctx.GetExchangesAsync());\n AssertHeaderContains(exchange.RequestHeaders, \"authorization\", \"Bearer test-provider-key\");\n AssertHeaderContains(exchange.RequestHeaders, ProviderHeaderName, \"create-provider-header\");\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Forward_Custom_Provider_Headers_On_Resume()\n {\n var session1 = await CreateSessionAsync();\n var sessionId = session1.SessionId;\n\n var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig\n {\n Model = \"claude-sonnet-4.5\",\n Provider = CreateProxyProvider(\"resume-provider-header\"),\n });\n\n var message = await session2.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 2+2?\" });\n Assert.Contains(\"4\", message?.Data.Content ?? string.Empty);\n\n var exchange = Assert.Single(await Ctx.GetExchangesAsync());\n AssertHeaderContains(exchange.RequestHeaders, \"authorization\", \"Bearer test-provider-key\");\n AssertHeaderContains(exchange.RequestHeaders, ProviderHeaderName, \"resume-provider-header\");\n\n await session2.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Use_WorkingDirectory_For_Tool_Execution()\n {\n var subDir = Path.Join(Ctx.WorkDir, \"subproject\");\n Directory.CreateDirectory(subDir);\n await File.WriteAllTextAsync(Path.Join(subDir, \"marker.txt\"), \"I am in the subdirectory\");\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n WorkingDirectory = subDir,\n });\n\n var message = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Read the file marker.txt and tell me what it says\",\n });\n\n Assert.Contains(\"subdirectory\", message?.Data.Content ?? string.Empty);\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Apply_WorkingDirectory_On_Session_Resume()\n {\n var subDir = Path.Join(Ctx.WorkDir, \"resume-subproject\");\n Directory.CreateDirectory(subDir);\n await File.WriteAllTextAsync(Path.Join(subDir, \"resume-marker.txt\"), \"I am in the resume working directory\");\n\n var session1 = await CreateSessionAsync();\n var sessionId = session1.SessionId;\n\n var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig\n {\n WorkingDirectory = subDir,\n });\n\n var message = await session2.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Read the file resume-marker.txt and tell me what it says\",\n });\n\n Assert.Contains(\"resume working directory\", message?.Data.Content ?? string.Empty);\n\n await session2.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Apply_SystemMessage_On_Session_Resume()\n {\n var session1 = await CreateSessionAsync();\n var sessionId = session1.SessionId;\n\n var resumeInstruction = \"End the response with RESUME_SYSTEM_MESSAGE_SENTINEL.\";\n var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig\n {\n SystemMessage = new SystemMessageConfig\n {\n Mode = SystemMessageMode.Append,\n Content = resumeInstruction,\n },\n });\n\n var message = await session2.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 1+1?\" });\n Assert.Contains(\"RESUME_SYSTEM_MESSAGE_SENTINEL\", message?.Data.Content ?? string.Empty);\n\n var exchange = Assert.Single(await Ctx.GetExchangesAsync());\n Assert.Contains(resumeInstruction, GetSystemMessage(exchange));\n\n await session2.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Apply_AvailableTools_On_Session_Resume()\n {\n var session1 = await CreateSessionAsync();\n var sessionId = session1.SessionId;\n\n var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig\n {\n AvailableTools = [\"view\"],\n });\n\n await session2.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 1+1?\" });\n\n var exchange = Assert.Single(await Ctx.GetExchangesAsync());\n Assert.Equal([\"view\"], GetToolNames(exchange));\n\n await session2.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Create_Session_With_Custom_Provider_Config()\n {\n // Per the TS test (session_config.e2e.test.ts), this only verifies that a\n // session can be created with a custom provider config and that disconnect\n // is allowed to fail since the fake provider URL won't be reachable.\n var session = await CreateSessionAsync(new SessionConfig\n {\n Provider = new ProviderConfig\n {\n BaseUrl = \"https://api.example.com/v1\",\n ApiKey = \"test-key\",\n },\n });\n\n Assert.Matches(@\"^[a-f0-9-]+$\", session.SessionId);\n\n try\n {\n await session.DisposeAsync();\n }\n catch (Exception)\n {\n // disconnect may fail since the provider is fake\n }\n }\n\n [Fact]\n public async Task Should_Accept_Blob_Attachments()\n {\n // Write the image to disk so the model can view it if it tries\n const string pngBase64 =\n \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\";\n await File.WriteAllBytesAsync(\n Path.Join(Ctx.WorkDir, \"pixel.png\"),\n Convert.FromBase64String(pngBase64));\n\n var session = await CreateSessionAsync();\n\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What color is this pixel? Reply in one word.\",\n Attachments =\n [\n new UserMessageAttachmentBlob\n {\n Data = pngBase64,\n MimeType = \"image/png\",\n DisplayName = \"pixel.png\",\n },\n ],\n });\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Accept_Message_Attachments()\n {\n var attachedPath = Path.Join(Ctx.WorkDir, \"attached.txt\");\n await File.WriteAllTextAsync(attachedPath, \"This file is attached\");\n\n var session = await CreateSessionAsync();\n\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Summarize the attached file\",\n Attachments =\n [\n new UserMessageAttachmentFile\n {\n Path = attachedPath,\n DisplayName = \"attached.txt\",\n },\n ],\n });\n\n await session.DisposeAsync();\n }\n\n /// \n /// Checks whether any user message contains an image_url content part.\n /// Content can be a string (no images) or a JSON array of content parts.\n /// \n private static bool HasImageUrlContent(List messages)\n {\n return messages\n .Where(m => m.Role == \"user\" && m.Content is { ValueKind: JsonValueKind.Array })\n .Any(m => m.Content!.Value.EnumerateArray().Any(part =>\n part.TryGetProperty(\"type\", out var typeProp) &&\n typeProp.ValueKind == JsonValueKind.String &&\n typeProp.GetString() == \"image_url\"));\n }\n\n private ProviderConfig CreateProxyProvider(string headerValue)\n {\n return new ProviderConfig\n {\n Type = \"openai\",\n BaseUrl = Ctx.ProxyUrl,\n ApiKey = \"test-provider-key\",\n Headers = new Dictionary\n {\n [ProviderHeaderName] = headerValue,\n },\n };\n }\n\n private static void AssertHeaderContains(\n Dictionary? headers,\n string expectedName,\n string expectedValue)\n {\n Assert.NotNull(headers);\n var header = headers.FirstOrDefault(\n pair => string.Equals(pair.Key, expectedName, StringComparison.OrdinalIgnoreCase));\n\n var actualHeaders = string.Join(\", \", headers.Select(pair => $\"{pair.Key}={HeaderValueAsString(pair.Value)}\"));\n Assert.False(\n string.IsNullOrEmpty(header.Key),\n $\"Expected header '{expectedName}' to be present. Actual headers: {actualHeaders}\");\n Assert.Contains(expectedValue, HeaderValueAsString(header.Value), StringComparison.Ordinal);\n }\n\n private static string HeaderValueAsString(JsonElement value)\n {\n return value.ValueKind switch\n {\n JsonValueKind.String => value.GetString() ?? string.Empty,\n JsonValueKind.Array => string.Join(\",\", value.EnumerateArray().Select(HeaderValueAsString)),\n _ => value.ToString(),\n };\n }\n}\n" }, { "path": "dotnet/test/E2E/SessionE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing GitHub.Copilot.SDK.Rpc;\nusing Microsoft.Extensions.AI;\nusing System.ComponentModel;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class SessionE2ETests(E2ETestFixture fixture, ITestOutputHelper output) : E2ETestBase(fixture, \"session\", output)\n{\n [Fact]\n public async Task ShouldCreateAndDisconnectSessions()\n {\n var session = await CreateSessionAsync(new SessionConfig { Model = \"claude-sonnet-4.5\" });\n\n Assert.Matches(@\"^[a-f0-9-]+$\", session.SessionId);\n\n var messages = await session.GetMessagesAsync();\n Assert.NotEmpty(messages);\n var startEvent = Assert.IsType(messages[0]);\n Assert.Equal(session.SessionId, startEvent.Data.SessionId);\n\n await session.DisposeAsync();\n\n var ex = await Assert.ThrowsAsync(() => session.GetMessagesAsync());\n Assert.Contains(\"not found\", ex.Message, StringComparison.OrdinalIgnoreCase);\n }\n\n [Fact]\n public async Task Should_Have_Stateful_Conversation()\n {\n var session = await CreateSessionAsync();\n\n var assistantMessage = await session.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 1+1?\" });\n Assert.NotNull(assistantMessage);\n Assert.Contains(\"2\", assistantMessage!.Data.Content);\n\n var secondMessage = await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Now if you double that, what do you get?\" });\n Assert.NotNull(secondMessage);\n Assert.Contains(\"4\", secondMessage!.Data.Content);\n }\n\n [Fact]\n public async Task Should_Create_A_Session_With_Appended_SystemMessage_Config()\n {\n var systemMessageSuffix = \"End each response with the phrase 'Have a nice day!'\";\n var session = await CreateSessionAsync(new SessionConfig\n {\n SystemMessage = new SystemMessageConfig { Mode = SystemMessageMode.Append, Content = systemMessageSuffix }\n });\n\n await session.SendAsync(new MessageOptions { Prompt = \"What is your full name?\" });\n var assistantMessage = await TestHelper.GetFinalAssistantMessageAsync(session);\n Assert.NotNull(assistantMessage);\n\n var content = assistantMessage!.Data.Content ?? string.Empty;\n Assert.Contains(\"GitHub\", content);\n Assert.Contains(\"Have a nice day!\", content);\n\n var traffic = await Ctx.GetExchangesAsync();\n Assert.NotEmpty(traffic);\n var systemMessage = GetSystemMessage(traffic[0]);\n Assert.Contains(\"GitHub\", systemMessage);\n Assert.Contains(systemMessageSuffix, systemMessage);\n }\n\n [Fact]\n public async Task Should_Create_A_Session_With_Replaced_SystemMessage_Config()\n {\n var testSystemMessage = \"You are an assistant called Testy McTestface. Reply succinctly.\";\n var session = await CreateSessionAsync(new SessionConfig\n {\n SystemMessage = new SystemMessageConfig { Mode = SystemMessageMode.Replace, Content = testSystemMessage }\n });\n\n await session.SendAsync(new MessageOptions { Prompt = \"What is your full name?\" });\n var assistantMessage = await TestHelper.GetFinalAssistantMessageAsync(session);\n Assert.NotNull(assistantMessage);\n\n var content = assistantMessage!.Data.Content ?? string.Empty;\n Assert.DoesNotContain(\"GitHub\", content);\n Assert.Contains(\"Testy\", content);\n\n var traffic = await Ctx.GetExchangesAsync();\n Assert.NotEmpty(traffic);\n Assert.Equal(testSystemMessage, GetSystemMessage(traffic[0]));\n }\n\n [Fact]\n public async Task Should_Create_A_Session_With_Customized_SystemMessage_Config()\n {\n var customTone = \"Respond in a warm, professional tone. Be thorough in explanations.\";\n var appendedContent = \"Always mention quarterly earnings.\";\n var session = await CreateSessionAsync(new SessionConfig\n {\n SystemMessage = new SystemMessageConfig\n {\n Mode = SystemMessageMode.Customize,\n Sections = new Dictionary\n {\n [SystemPromptSections.Tone] = new() { Action = SectionOverrideAction.Replace, Content = customTone },\n [SystemPromptSections.CodeChangeRules] = new() { Action = SectionOverrideAction.Remove },\n },\n Content = appendedContent\n }\n });\n\n await session.SendAsync(new MessageOptions { Prompt = \"Who are you?\" });\n var assistantMessage = await TestHelper.GetFinalAssistantMessageAsync(session);\n Assert.NotNull(assistantMessage);\n\n var traffic = await Ctx.GetExchangesAsync();\n Assert.NotEmpty(traffic);\n var systemMessage = GetSystemMessage(traffic[0]);\n Assert.Contains(customTone, systemMessage);\n Assert.Contains(appendedContent, systemMessage);\n Assert.DoesNotContain(\"\", systemMessage);\n }\n\n [Fact]\n public async Task Should_Create_A_Session_With_AvailableTools()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n AvailableTools = [\"view\", \"edit\"]\n });\n\n await session.SendAsync(new MessageOptions { Prompt = \"What is 1+1?\" });\n await TestHelper.GetFinalAssistantMessageAsync(session);\n\n var traffic = await Ctx.GetExchangesAsync();\n Assert.NotEmpty(traffic);\n\n var toolNames = GetToolNames(traffic[0]);\n Assert.Equal(2, toolNames.Count);\n Assert.Contains(\"view\", toolNames);\n Assert.Contains(\"edit\", toolNames);\n }\n\n [Fact]\n public async Task Should_Create_A_Session_With_ExcludedTools()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n ExcludedTools = [\"view\"]\n });\n\n await session.SendAsync(new MessageOptions { Prompt = \"What is 1+1?\" });\n await TestHelper.GetFinalAssistantMessageAsync(session);\n\n var traffic = await Ctx.GetExchangesAsync();\n Assert.NotEmpty(traffic);\n\n var toolNames = GetToolNames(traffic[0]);\n Assert.DoesNotContain(\"view\", toolNames);\n Assert.Contains(\"edit\", toolNames);\n Assert.Contains(\"grep\", toolNames);\n }\n\n [Fact]\n public async Task Should_Create_A_Session_With_DefaultAgent_ExcludedTools()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n Tools =\n [\n AIFunctionFactory.Create(\n (string input) => \"SECRET\",\n \"secret_tool\",\n \"A secret tool hidden from the default agent\"),\n ],\n DefaultAgent = new DefaultAgentConfig\n {\n ExcludedTools = [\"secret_tool\"],\n },\n });\n\n await session.SendAsync(new MessageOptions { Prompt = \"What is 1+1?\" });\n await TestHelper.GetFinalAssistantMessageAsync(session);\n\n var traffic = await Ctx.GetExchangesAsync();\n Assert.NotEmpty(traffic);\n\n var toolNames = GetToolNames(traffic[0]);\n Assert.DoesNotContain(\"secret_tool\", toolNames);\n }\n\n [Fact]\n public async Task Should_Create_Session_With_Custom_Tool()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n Tools =\n [\n AIFunctionFactory.Create(async ([Description(\"Key\")] string key) => {\n await Task.Yield();\n return key == \"ALPHA\" ? 54321 : 0;\n }, \"get_secret_number\", \"Gets the secret number\"),\n ]\n });\n\n await session.SendAsync(new MessageOptions { Prompt = \"What is the secret number for key ALPHA?\" });\n var assistantMessage = await TestHelper.GetFinalAssistantMessageAsync(session);\n Assert.NotNull(assistantMessage);\n Assert.Contains(\"54321\", assistantMessage!.Data.Content ?? string.Empty);\n }\n\n [Fact]\n public async Task Should_Resume_A_Session_Using_The_Same_Client()\n {\n var session1 = await CreateSessionAsync();\n var sessionId = session1.SessionId;\n\n await session1.SendAsync(new MessageOptions { Prompt = \"What is 1+1?\" });\n var answer = await TestHelper.GetFinalAssistantMessageAsync(session1);\n Assert.NotNull(answer);\n Assert.Contains(\"2\", answer!.Data.Content ?? string.Empty);\n\n var session2 = await ResumeSessionAsync(sessionId);\n Assert.Equal(sessionId, session2.SessionId);\n\n var answer2 = await TestHelper.GetFinalAssistantMessageAsync(session2, alreadyIdle: true);\n Assert.NotNull(answer2);\n Assert.Contains(\"2\", answer2!.Data.Content ?? string.Empty);\n\n // Can continue the conversation statefully\n var answer3 = await session2.SendAndWaitAsync(new MessageOptions { Prompt = \"Now if you double that, what do you get?\" });\n Assert.NotNull(answer3);\n Assert.Contains(\"4\", answer3!.Data.Content ?? string.Empty);\n }\n\n [Fact]\n public async Task Should_Resume_A_Session_Using_A_New_Client()\n {\n var session1 = await CreateSessionAsync();\n var sessionId = session1.SessionId;\n\n await session1.SendAsync(new MessageOptions { Prompt = \"What is 1+1?\" });\n var answer = await TestHelper.GetFinalAssistantMessageAsync(session1);\n Assert.NotNull(answer);\n Assert.Contains(\"2\", answer!.Data.Content ?? string.Empty);\n\n using var newClient = Ctx.CreateClient();\n var session2 = await newClient.ResumeSessionAsync(sessionId, new ResumeSessionConfig\n {\n ContinuePendingWork = true,\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n Assert.Equal(sessionId, session2.SessionId);\n\n var messages = await session2.GetMessagesAsync();\n Assert.Contains(messages, m => m is UserMessageEvent);\n var resumeEvent = Assert.Single(messages.OfType());\n Assert.True(resumeEvent.Data.ContinuePendingWork);\n\n // Can continue the conversation statefully\n var answer2 = await session2.SendAndWaitAsync(new MessageOptions { Prompt = \"Now if you double that, what do you get?\" });\n Assert.NotNull(answer2);\n Assert.Contains(\"4\", answer2!.Data.Content ?? string.Empty);\n }\n\n [Fact]\n public async Task Should_Throw_Error_When_Resuming_Non_Existent_Session()\n {\n await Assert.ThrowsAsync(() =>\n ResumeSessionAsync(\"non-existent-session-id\"));\n }\n\n [Fact]\n public async Task Should_Abort_A_Session()\n {\n var session = await CreateSessionAsync();\n\n // Set up wait for tool execution to start BEFORE sending\n var toolStartTask = TestHelper.GetNextEventOfTypeAsync(session);\n var sessionIdleTask = TestHelper.GetNextEventOfTypeAsync(session);\n\n // Send a message that will take some time to process\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"run the shell command 'sleep 100' (note this works on both bash and PowerShell)\"\n });\n\n // Wait for tool execution to start\n await toolStartTask;\n\n // Abort the session\n await session.AbortAsync();\n await sessionIdleTask;\n\n // The session should still be alive and usable after abort\n var messages = await session.GetMessagesAsync();\n Assert.NotEmpty(messages);\n\n // Verify an abort event exists in messages\n Assert.Contains(messages, m => m is AbortEvent);\n\n // We should be able to send another message\n var answer = await session.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 2+2?\" });\n Assert.NotNull(answer);\n Assert.Contains(\"4\", answer!.Data.Content ?? string.Empty);\n }\n\n [Fact]\n public async Task Should_Receive_Session_Events()\n {\n // Use OnEvent to capture events dispatched during session creation.\n // session.start is emitted during the session.create RPC; if the session\n // weren't registered in the sessions map before the RPC, it would be dropped.\n var earlyEvents = new List();\n var sessionStartReceived = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnEvent = evt =>\n {\n earlyEvents.Add(evt);\n if (evt is SessionStartEvent)\n sessionStartReceived.TrySetResult(true);\n },\n });\n\n // session.start is dispatched asynchronously via the event channel;\n // wait briefly for the consumer to deliver it.\n var started = await Task.WhenAny(sessionStartReceived.Task, Task.Delay(TimeSpan.FromSeconds(5)));\n Assert.Equal(sessionStartReceived.Task, started);\n Assert.Contains(earlyEvents, evt => evt is SessionStartEvent);\n\n var receivedEvents = new List();\n var idleReceived = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n var concurrentCount = 0;\n var maxConcurrent = 0;\n\n session.On(evt =>\n {\n // Track concurrent handler invocations to verify serial dispatch.\n var current = Interlocked.Increment(ref concurrentCount);\n var seenMax = Volatile.Read(ref maxConcurrent);\n if (current > seenMax)\n Interlocked.CompareExchange(ref maxConcurrent, current, seenMax);\n\n Thread.Sleep(10);\n\n Interlocked.Decrement(ref concurrentCount);\n\n receivedEvents.Add(evt);\n if (evt is SessionIdleEvent)\n {\n idleReceived.TrySetResult(true);\n }\n });\n\n // Send a message to trigger events\n await session.SendAsync(new MessageOptions { Prompt = \"What is 100+200?\" });\n\n // Wait for session to become idle (indicating message processing is complete)\n await idleReceived.Task.WaitAsync(TimeSpan.FromSeconds(60));\n\n // Should have received multiple events (user message, assistant message, idle, etc.)\n Assert.NotEmpty(receivedEvents);\n Assert.Contains(receivedEvents, evt => evt is UserMessageEvent);\n Assert.Contains(receivedEvents, evt => evt is AssistantMessageEvent);\n Assert.Contains(receivedEvents, evt => evt is SessionIdleEvent);\n\n // Events must be dispatched serially — never more than one handler invocation at a time.\n Assert.Equal(1, maxConcurrent);\n\n // Verify the assistant response contains the expected answer.\n // session.idle is ephemeral and not in getEvents(), but we already\n // confirmed idle via the live event handler above.\n var assistantMessage = await TestHelper.GetFinalAssistantMessageAsync(session, alreadyIdle: true);\n Assert.NotNull(assistantMessage);\n Assert.Contains(\"300\", assistantMessage!.Data.Content);\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Send_Returns_Immediately_While_Events_Stream_In_Background()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n var events = new List();\n\n session.On(evt => events.Add(evt.Type));\n\n // Use a slow command so we can verify SendAsync() returns before completion\n await session.SendAsync(new MessageOptions { Prompt = \"Run 'sleep 2 && echo done'\" });\n\n // SendAsync() should return before turn completes (no session.idle yet)\n Assert.DoesNotContain(\"session.idle\", events);\n\n // Wait for turn to complete\n var message = await TestHelper.GetFinalAssistantMessageAsync(session);\n\n Assert.Contains(\"done\", message?.Data.Content ?? string.Empty);\n Assert.Contains(\"session.idle\", events);\n Assert.Contains(\"assistant.message\", events);\n }\n\n [Fact]\n public async Task SendAndWait_Blocks_Until_Session_Idle_And_Returns_Final_Assistant_Message()\n {\n var session = await CreateSessionAsync();\n var events = new List();\n\n session.On(evt => events.Add(evt.Type));\n\n var response = await session.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 2+2?\" });\n\n Assert.NotNull(response);\n Assert.Equal(\"assistant.message\", response!.Type);\n Assert.Contains(\"4\", response.Data.Content ?? string.Empty);\n Assert.Contains(\"session.idle\", events);\n Assert.Contains(\"assistant.message\", events);\n }\n\n [Fact]\n public async Task Should_List_Sessions_With_Context()\n {\n var session = await CreateSessionAsync();\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Say OK.\" });\n\n SessionMetadata? ourSession = null;\n await WaitForAsync(async () =>\n {\n var sessions = await Client.ListSessionsAsync();\n ourSession = sessions.FirstOrDefault(s => s.SessionId == session.SessionId);\n return ourSession is not null;\n }, TimeSpan.FromSeconds(10));\n Assert.NotNull(ourSession);\n\n var allSessions = await Client.ListSessionsAsync();\n Assert.NotEmpty(allSessions);\n\n // Context may be present on sessions that have been persisted with workspace.yaml\n if (ourSession.Context != null)\n {\n Assert.False(string.IsNullOrEmpty(ourSession.Context.Cwd), \"Expected context.Cwd to be non-empty when context is present\");\n }\n }\n\n [Fact]\n public async Task Should_Get_Session_Metadata_By_Id()\n {\n var session = await CreateSessionAsync();\n\n // Send a message to persist the session to disk\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Say hello\" });\n\n SessionMetadata? metadata = null;\n await WaitForAsync(async () =>\n {\n metadata = await Client.GetSessionMetadataAsync(session.SessionId);\n return metadata is not null;\n }, TimeSpan.FromSeconds(10));\n Assert.NotNull(metadata);\n Assert.Equal(session.SessionId, metadata.SessionId);\n Assert.NotEqual(default, metadata.StartTime);\n Assert.NotEqual(default, metadata.ModifiedTime);\n\n // Verify non-existent session returns null\n var notFound = await Client.GetSessionMetadataAsync(\"non-existent-session-id\");\n Assert.Null(notFound);\n }\n\n [Fact]\n public async Task SendAndWait_Throws_On_Timeout()\n {\n var session = await CreateSessionAsync();\n\n var sessionIdleTask = TestHelper.GetNextEventOfTypeAsync(session);\n\n // Use a slow command to ensure timeout triggers before completion\n var ex = await Assert.ThrowsAsync(() =>\n session.SendAndWaitAsync(new MessageOptions { Prompt = \"Run 'sleep 2 && echo done'\" }, TimeSpan.FromMilliseconds(100)));\n\n Assert.Contains(\"timed out\", ex.Message);\n\n // The timeout only cancels the client-side wait; abort the agent and wait for idle\n // so leftover requests don't leak into subsequent tests.\n await session.AbortAsync();\n await sessionIdleTask;\n }\n\n [Fact]\n public async Task SendAndWait_Throws_OperationCanceledException_When_Token_Cancelled()\n {\n var session = await CreateSessionAsync();\n\n // Set up wait for tool execution to start BEFORE sending\n var toolStartTask = TestHelper.GetNextEventOfTypeAsync(session);\n var sessionIdleTask = TestHelper.GetNextEventOfTypeAsync(session);\n\n using var cts = new CancellationTokenSource();\n\n // Start SendAndWaitAsync - don't await it yet\n var sendTask = session.SendAndWaitAsync(\n new MessageOptions { Prompt = \"run the shell command 'sleep 10' (note this works on both bash and PowerShell)\" },\n cancellationToken: cts.Token);\n\n // Wait for the tool to begin executing before cancelling\n await toolStartTask;\n\n // Cancel the token\n cts.Cancel();\n\n await Assert.ThrowsAnyAsync(() => sendTask);\n\n // Cancelling the token only cancels the client-side wait, not the server-side agent loop.\n // Explicitly abort so the agent stops, then wait for idle to ensure we're not still\n // running this agent's operations in the context of a subsequent test.\n await session.AbortAsync();\n await sessionIdleTask;\n }\n\n [Fact]\n public async Task Should_Create_Session_With_Custom_Config_Dir()\n {\n var customConfigDir = Path.Join(Ctx.HomeDir, \"custom-config\");\n var session = await CreateSessionAsync(new SessionConfig { ConfigDir = customConfigDir });\n\n Assert.Matches(@\"^[a-f0-9-]+$\", session.SessionId);\n\n // Session should work normally with custom config dir\n await session.SendAsync(new MessageOptions { Prompt = \"What is 1+1?\" });\n var assistantMessage = await TestHelper.GetFinalAssistantMessageAsync(session);\n Assert.NotNull(assistantMessage);\n Assert.Contains(\"2\", assistantMessage!.Data.Content);\n }\n\n [Fact]\n public async Task Should_Set_Model_On_Existing_Session()\n {\n var session = await CreateSessionAsync();\n\n // Subscribe for the model change event before calling SetModelAsync\n var modelChangedTask = TestHelper.GetNextEventOfTypeAsync(session);\n\n await session.SetModelAsync(\"gpt-4.1\");\n\n // Verify a model_change event was emitted with the new model\n var modelChanged = await modelChangedTask;\n Assert.Equal(\"gpt-4.1\", modelChanged.Data.NewModel);\n }\n\n [Fact]\n public async Task Should_Set_Model_With_ReasoningEffort()\n {\n var session = await CreateSessionAsync();\n\n var modelChangedTask = TestHelper.GetNextEventOfTypeAsync(session);\n\n await session.SetModelAsync(\"gpt-4.1\", \"high\");\n\n var modelChanged = await modelChangedTask;\n Assert.Equal(\"gpt-4.1\", modelChanged.Data.NewModel);\n Assert.Equal(\"high\", modelChanged.Data.ReasoningEffort);\n }\n\n [Fact]\n public async Task Should_Log_Messages_At_Various_Levels()\n {\n var session = await CreateSessionAsync();\n var events = new List();\n session.On(evt => events.Add(evt));\n\n await session.LogAsync(\"Info message\");\n await session.LogAsync(\"Warning message\", level: SessionLogLevel.Warning);\n await session.LogAsync(\"Error message\", level: SessionLogLevel.Error);\n await session.LogAsync(\"Ephemeral message\", ephemeral: true);\n\n // Poll until all 4 notification events arrive\n await WaitForAsync(() =>\n {\n var notifications = events.Where(e =>\n e is SessionInfoEvent info && info.Data.InfoType == \"notification\" ||\n e is SessionWarningEvent warn && warn.Data.WarningType == \"notification\" ||\n e is SessionErrorEvent err && err.Data.ErrorType == \"notification\"\n ).ToList();\n return notifications.Count >= 4;\n }, timeout: TimeSpan.FromSeconds(10));\n\n var infoEvent = events.OfType().First(e => e.Data.Message == \"Info message\");\n Assert.Equal(\"notification\", infoEvent.Data.InfoType);\n\n var warningEvent = events.OfType().First(e => e.Data.Message == \"Warning message\");\n Assert.Equal(\"notification\", warningEvent.Data.WarningType);\n\n var errorEvent = events.OfType().First(e => e.Data.Message == \"Error message\");\n Assert.Equal(\"notification\", errorEvent.Data.ErrorType);\n\n var ephemeralEvent = events.OfType().First(e => e.Data.Message == \"Ephemeral message\");\n Assert.Equal(\"notification\", ephemeralEvent.Data.InfoType);\n }\n\n [Fact]\n public async Task Handler_Exception_Does_Not_Halt_Event_Delivery()\n {\n var session = await CreateSessionAsync();\n var eventCount = 0;\n var gotIdle = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n\n session.On(evt =>\n {\n eventCount++;\n\n // Throw on the first event to verify the loop keeps going.\n if (eventCount == 1)\n throw new InvalidOperationException(\"boom\");\n\n if (evt is SessionIdleEvent)\n gotIdle.TrySetResult();\n });\n\n await session.SendAsync(new MessageOptions { Prompt = \"What is 1+1?\" });\n\n await gotIdle.Task.WaitAsync(TimeSpan.FromSeconds(30));\n\n // Handler saw more than just the first (throwing) event.\n Assert.True(eventCount > 1);\n }\n\n [Fact]\n public async Task DisposeAsync_From_Handler_Does_Not_Deadlock()\n {\n var session = await CreateSessionAsync();\n var disposed = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n\n session.On(evt =>\n {\n if (evt is UserMessageEvent)\n {\n // Call DisposeAsync from within a handler — must not deadlock.\n session.DisposeAsync().AsTask().ContinueWith(_ => disposed.TrySetResult());\n }\n });\n\n await session.SendAsync(new MessageOptions { Prompt = \"What is 1+1?\" });\n\n // If this times out, we deadlocked.\n await disposed.Task.WaitAsync(TimeSpan.FromSeconds(10));\n }\n\n [Fact]\n public async Task Should_Accept_Blob_Attachments()\n {\n var pngBase64 = \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\";\n await File.WriteAllBytesAsync(Path.Join(Ctx.WorkDir, \"test-pixel.png\"), Convert.FromBase64String(pngBase64));\n\n var session = await CreateSessionAsync();\n\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Describe this image\",\n Attachments =\n [\n new UserMessageAttachmentBlob\n {\n Data = pngBase64,\n MimeType = \"image/png\",\n DisplayName = \"test-pixel.png\",\n },\n ],\n });\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Send_With_File_Attachment()\n {\n var filePath = Path.Join(Ctx.WorkDir, \"attached-file.txt\");\n await File.WriteAllTextAsync(filePath, \"FILE_ATTACHMENT_SENTINEL\");\n\n var session = await CreateSessionAsync();\n\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Read the attached file and reply with its contents.\",\n Attachments =\n [\n new UserMessageAttachmentFile\n {\n DisplayName = \"attached-file.txt\",\n Path = filePath,\n LineRange = new UserMessageAttachmentFileLineRange { Start = 1, End = 1 },\n },\n ],\n });\n\n var userMessage = (await session.GetMessagesAsync()).OfType().Last();\n var attachment = Assert.IsType(Assert.Single(userMessage.Data.Attachments!));\n Assert.Equal(\"attached-file.txt\", attachment.DisplayName);\n Assert.Equal(filePath, attachment.Path);\n Assert.Equal(1, attachment.LineRange!.Start);\n Assert.Equal(1, attachment.LineRange.End);\n }\n\n [Fact]\n public async Task Should_Send_With_Directory_Attachment()\n {\n var directoryPath = Path.Join(Ctx.WorkDir, \"attached-directory\");\n Directory.CreateDirectory(directoryPath);\n await File.WriteAllTextAsync(Path.Join(directoryPath, \"readme.txt\"), \"DIRECTORY_ATTACHMENT_SENTINEL\");\n\n var session = await CreateSessionAsync();\n\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"List the attached directory.\",\n Attachments =\n [\n new UserMessageAttachmentDirectory\n {\n DisplayName = \"attached-directory\",\n Path = directoryPath,\n },\n ],\n });\n\n var userMessage = (await session.GetMessagesAsync()).OfType().Last();\n var attachment = Assert.IsType(Assert.Single(userMessage.Data.Attachments!));\n Assert.Equal(\"attached-directory\", attachment.DisplayName);\n Assert.Equal(directoryPath, attachment.Path);\n }\n\n [Fact]\n public async Task Should_Send_With_Selection_Attachment()\n {\n var filePath = Path.Join(Ctx.WorkDir, \"selected-file.cs\");\n await File.WriteAllTextAsync(filePath, \"class C { string Value = \\\"SELECTION_SENTINEL\\\"; }\");\n\n var session = await CreateSessionAsync();\n\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Summarize the selected code.\",\n Attachments =\n [\n new UserMessageAttachmentSelection\n {\n DisplayName = \"selected-file.cs\",\n FilePath = filePath,\n Text = \"string Value = \\\"SELECTION_SENTINEL\\\";\",\n Selection = new UserMessageAttachmentSelectionDetails\n {\n Start = new UserMessageAttachmentSelectionDetailsStart { Line = 1, Character = 10 },\n End = new UserMessageAttachmentSelectionDetailsEnd { Line = 1, Character = 45 },\n },\n },\n ],\n });\n\n var userMessage = (await session.GetMessagesAsync()).OfType().Last();\n var attachment = Assert.IsType(Assert.Single(userMessage.Data.Attachments!));\n Assert.Equal(\"selected-file.cs\", attachment.DisplayName);\n Assert.Equal(filePath, attachment.FilePath);\n Assert.Equal(\"string Value = \\\"SELECTION_SENTINEL\\\";\", attachment.Text);\n Assert.Equal(1, attachment.Selection.Start.Line);\n Assert.Equal(10, attachment.Selection.Start.Character);\n Assert.Equal(1, attachment.Selection.End.Line);\n Assert.Equal(45, attachment.Selection.End.Character);\n }\n\n [Fact]\n public async Task Should_Send_With_Github_Reference_Attachment()\n {\n var session = await CreateSessionAsync();\n\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Summarize the referenced issue.\",\n Attachments =\n [\n new UserMessageAttachmentGithubReference\n {\n Number = 1234,\n ReferenceType = UserMessageAttachmentGithubReferenceType.Issue,\n State = \"open\",\n Title = \"Add E2E attachment coverage\",\n Url = \"https://github.com/github/copilot-sdk/issues/1234\",\n },\n ],\n });\n\n var userMessage = (await session.GetMessagesAsync()).OfType().Last();\n var attachment = Assert.IsType(Assert.Single(userMessage.Data.Attachments!));\n Assert.Equal(1234, attachment.Number);\n Assert.Equal(UserMessageAttachmentGithubReferenceType.Issue, attachment.ReferenceType);\n Assert.Equal(\"open\", attachment.State);\n Assert.Equal(\"Add E2E attachment coverage\", attachment.Title);\n Assert.Equal(\"https://github.com/github/copilot-sdk/issues/1234\", attachment.Url);\n }\n\n [Fact]\n public async Task Should_Send_With_Mode_Property()\n {\n var session = await CreateSessionAsync();\n\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Say mode ok.\",\n Mode = \"plan\",\n });\n\n var userMessage = (await session.GetMessagesAsync()).OfType().Last();\n Assert.Equal(\"Say mode ok.\", userMessage.Data.Content);\n // The current runtime accepts the per-message mode option but does not echo it on user.message.\n Assert.Null(userMessage.Data.AgentMode);\n }\n\n [Fact]\n public async Task Should_Send_With_Custom_RequestHeaders()\n {\n var session = await CreateSessionAsync();\n\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is 1+1?\",\n RequestHeaders = new Dictionary\n {\n [\"x-copilot-sdk-test-header\"] = \"csharp-request-headers\",\n },\n });\n\n var exchanges = await Ctx.GetExchangesAsync();\n Assert.NotEmpty(exchanges);\n var headers = exchanges.Last().RequestHeaders ?? [];\n Assert.Contains(\n headers,\n pair => string.Equals(pair.Key, \"x-copilot-sdk-test-header\", StringComparison.OrdinalIgnoreCase) &&\n pair.Value.ToString().Contains(\"csharp-request-headers\", StringComparison.Ordinal));\n }\n\n [Fact]\n public async Task Should_Create_Session_With_Custom_Provider()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n Provider = new ProviderConfig\n {\n Type = \"openai\",\n BaseUrl = \"https://api.openai.com/v1\",\n ApiKey = \"fake-key\",\n },\n });\n\n Assert.False(string.IsNullOrEmpty(session.SessionId));\n\n try\n {\n await session.DisposeAsync();\n }\n catch (Exception)\n {\n // disconnect may fail since the provider is fake\n }\n }\n\n [Fact]\n public async Task Should_Create_Session_With_Azure_Provider()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n Provider = new ProviderConfig\n {\n Type = \"azure\",\n BaseUrl = \"https://my-resource.openai.azure.com\",\n ApiKey = \"fake-key\",\n Azure = new AzureOptions\n {\n ApiVersion = \"2024-02-15-preview\",\n },\n },\n });\n\n Assert.False(string.IsNullOrEmpty(session.SessionId));\n\n try\n {\n await session.DisposeAsync();\n }\n catch (Exception)\n {\n // disconnect may fail since the provider is fake\n }\n }\n\n [Fact]\n public async Task Should_Resume_Session_With_Custom_Provider()\n {\n var session = await CreateSessionAsync();\n var sessionId = session.SessionId;\n\n var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig\n {\n Provider = new ProviderConfig\n {\n Type = \"openai\",\n BaseUrl = \"https://api.openai.com/v1\",\n ApiKey = \"fake-key\",\n },\n });\n\n Assert.Equal(sessionId, session2.SessionId);\n\n try\n {\n await session2.DisposeAsync();\n }\n catch (Exception)\n {\n // disconnect may fail since the provider is fake\n }\n\n await session.DisposeAsync();\n }\n\n private static async Task WaitForAsync(Func condition, TimeSpan timeout)\n {\n using var cts = new CancellationTokenSource(timeout);\n while (!condition())\n {\n try\n {\n await Task.Delay(100, cts.Token);\n }\n catch (OperationCanceledException)\n {\n throw new TimeoutException($\"Condition not met within {timeout}\");\n }\n }\n }\n\n private static async Task WaitForAsync(Func> condition, TimeSpan timeout)\n {\n using var cts = new CancellationTokenSource(timeout);\n while (!await condition())\n {\n try\n {\n await Task.Delay(100, cts.Token);\n }\n catch (OperationCanceledException)\n {\n throw new TimeoutException($\"Condition not met within {timeout}\");\n }\n }\n }\n}\n" }, { "path": "dotnet/test/E2E/SessionFsE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Rpc;\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Microsoft.Extensions.AI;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class SessionFsE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"session_fs\", output)\n{\n private static readonly SessionFsConfig SessionFsConfig = new()\n {\n InitialCwd = \"/\",\n SessionStatePath = CreateSessionStatePath(),\n Conventions = SessionFsSetProviderConventions.Posix,\n };\n\n [Fact]\n public async Task Should_Route_File_Operations_Through_The_Session_Fs_Provider()\n {\n var providerRoot = CreateProviderRoot();\n try\n {\n await using var client = CreateSessionFsClient(providerRoot);\n\n var session = await client.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n CreateSessionFsHandler = s => new TestSessionFsHandler(s.SessionId, providerRoot),\n });\n\n var msg = await session.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 100 + 200?\" });\n Assert.Contains(\"300\", msg?.Data.Content ?? string.Empty);\n await session.DisposeAsync();\n\n var eventsPath = GetStoredPath(providerRoot, session.SessionId, $\"{SessionFsConfig.SessionStatePath}/events.jsonl\");\n await WaitForConditionAsync(() => File.Exists(eventsPath));\n var content = await ReadAllTextSharedAsync(eventsPath);\n Assert.Contains(\"300\", content);\n }\n finally\n {\n await TryDeleteDirectoryAsync(providerRoot);\n }\n }\n\n [Fact]\n public async Task Should_Load_Session_Data_From_Fs_Provider_On_Resume()\n {\n var providerRoot = CreateProviderRoot();\n try\n {\n await using var client = CreateSessionFsClient(providerRoot);\n Func createSessionFsHandler = s => new TestSessionFsHandler(s.SessionId, providerRoot);\n\n var session1 = await client.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n CreateSessionFsHandler = createSessionFsHandler,\n });\n var sessionId = session1.SessionId;\n\n var msg = await session1.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 50 + 50?\" });\n Assert.Contains(\"100\", msg?.Data.Content ?? string.Empty);\n await session1.DisposeAsync();\n\n var eventsPath = GetStoredPath(providerRoot, sessionId, $\"{SessionFsConfig.SessionStatePath}/events.jsonl\");\n await WaitForConditionAsync(() => File.Exists(eventsPath));\n\n var session2 = await client.ResumeSessionAsync(sessionId, new ResumeSessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n CreateSessionFsHandler = createSessionFsHandler,\n });\n\n var msg2 = await session2.SendAndWaitAsync(new MessageOptions { Prompt = \"What is that times 3?\" });\n Assert.Contains(\"300\", msg2?.Data.Content ?? string.Empty);\n await session2.DisposeAsync();\n }\n finally\n {\n await TryDeleteDirectoryAsync(providerRoot);\n }\n }\n\n [Fact]\n public async Task Should_Reject_SetProvider_When_Sessions_Already_Exist()\n {\n var providerRoot = CreateProviderRoot();\n try\n {\n await using var client1 = CreateSessionFsClient(providerRoot, useStdio: false);\n var createSessionFsHandler = (Func)(s => new TestSessionFsHandler(s.SessionId, providerRoot));\n\n _ = await client1.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n CreateSessionFsHandler = createSessionFsHandler,\n });\n\n var port = client1.ActualPort\n ?? throw new InvalidOperationException(\"Client1 is not using TCP mode; ActualPort is null\");\n\n var client2 = Ctx.CreateClient(\n useStdio: false,\n options: new CopilotClientOptions\n {\n CliUrl = $\"localhost:{port}\",\n LogLevel = \"error\",\n SessionFs = SessionFsConfig,\n });\n\n try\n {\n await Assert.ThrowsAnyAsync(() => client2.StartAsync());\n }\n finally\n {\n try\n {\n await client2.ForceStopAsync();\n }\n catch (IOException ex)\n {\n Console.Error.WriteLine($\"Ignoring expected teardown IOException from ForceStopAsync: {ex.Message}\");\n }\n }\n }\n finally\n {\n await TryDeleteDirectoryAsync(providerRoot);\n }\n }\n\n [Fact]\n public async Task Should_Map_All_SessionFs_Handler_Operations()\n {\n var providerRoot = CreateProviderRoot();\n var sessionId = \"handler-session\";\n try\n {\n Directory.CreateDirectory(providerRoot);\n ISessionFsHandler handler = new TestSessionFsHandler(sessionId, providerRoot);\n\n var mkdirError = await handler.MkdirAsync(new SessionFsMkdirRequest\n {\n SessionId = sessionId,\n Path = \"/workspace/nested\",\n Recursive = true,\n });\n Assert.Null(mkdirError);\n\n var writeError = await handler.WriteFileAsync(new SessionFsWriteFileRequest\n {\n SessionId = sessionId,\n Path = \"/workspace/nested/file.txt\",\n Content = \"hello\",\n });\n Assert.Null(writeError);\n\n var appendError = await handler.AppendFileAsync(new SessionFsAppendFileRequest\n {\n SessionId = sessionId,\n Path = \"/workspace/nested/file.txt\",\n Content = \" world\",\n });\n Assert.Null(appendError);\n\n var exists = await handler.ExistsAsync(new SessionFsExistsRequest\n {\n SessionId = sessionId,\n Path = \"/workspace/nested/file.txt\",\n });\n Assert.True(exists.Exists);\n\n var stat = await handler.StatAsync(new SessionFsStatRequest\n {\n SessionId = sessionId,\n Path = \"/workspace/nested/file.txt\",\n });\n Assert.True(stat.IsFile);\n Assert.False(stat.IsDirectory);\n Assert.Equal(\"hello world\".Length, stat.Size);\n Assert.Null(stat.Error);\n\n var content = await handler.ReadFileAsync(new SessionFsReadFileRequest\n {\n SessionId = sessionId,\n Path = \"/workspace/nested/file.txt\",\n });\n Assert.Equal(\"hello world\", content.Content);\n Assert.Null(content.Error);\n\n var entries = await handler.ReaddirAsync(new SessionFsReaddirRequest\n {\n SessionId = sessionId,\n Path = \"/workspace/nested\",\n });\n Assert.Contains(\"file.txt\", entries.Entries);\n Assert.Null(entries.Error);\n\n var typedEntries = await handler.ReaddirWithTypesAsync(new SessionFsReaddirWithTypesRequest\n {\n SessionId = sessionId,\n Path = \"/workspace/nested\",\n });\n Assert.Contains(\n typedEntries.Entries,\n entry => entry.Name == \"file.txt\" && entry.Type == SessionFsReaddirWithTypesEntryType.File);\n Assert.Null(typedEntries.Error);\n\n var renameError = await handler.RenameAsync(new SessionFsRenameRequest\n {\n SessionId = sessionId,\n Src = \"/workspace/nested/file.txt\",\n Dest = \"/workspace/nested/renamed.txt\",\n });\n Assert.Null(renameError);\n\n var oldPath = await handler.ExistsAsync(new SessionFsExistsRequest\n {\n SessionId = sessionId,\n Path = \"/workspace/nested/file.txt\",\n });\n Assert.False(oldPath.Exists);\n\n var renamedPath = await handler.ReadFileAsync(new SessionFsReadFileRequest\n {\n SessionId = sessionId,\n Path = \"/workspace/nested/renamed.txt\",\n });\n Assert.Equal(\"hello world\", renamedPath.Content);\n\n var rmError = await handler.RmAsync(new SessionFsRmRequest\n {\n SessionId = sessionId,\n Path = \"/workspace/nested/renamed.txt\",\n });\n Assert.Null(rmError);\n\n var removed = await handler.ExistsAsync(new SessionFsExistsRequest\n {\n SessionId = sessionId,\n Path = \"/workspace/nested/renamed.txt\",\n });\n Assert.False(removed.Exists);\n\n var forcedRmError = await handler.RmAsync(new SessionFsRmRequest\n {\n SessionId = sessionId,\n Path = \"/workspace/nested/missing.txt\",\n Force = true,\n });\n Assert.Null(forcedRmError);\n\n var missing = await handler.StatAsync(new SessionFsStatRequest\n {\n SessionId = sessionId,\n Path = \"/workspace/nested/missing.txt\",\n });\n Assert.Equal(SessionFsErrorCode.ENOENT, missing.Error?.Code);\n }\n finally\n {\n await TryDeleteDirectoryAsync(providerRoot);\n }\n }\n\n [Fact]\n public async Task SessionFsProvider_Converts_Exceptions_To_Rpc_Errors()\n {\n var handler = (ISessionFsHandler)new ThrowingSessionFsProvider(new FileNotFoundException(\"missing\"));\n\n AssertFsError((await handler.ReadFileAsync(new SessionFsReadFileRequest { Path = \"missing.txt\" })).Error);\n AssertFsError(await handler.WriteFileAsync(new SessionFsWriteFileRequest { Path = \"missing.txt\", Content = \"content\" }));\n AssertFsError(await handler.AppendFileAsync(new SessionFsAppendFileRequest { Path = \"missing.txt\", Content = \"content\" }));\n\n var exists = await handler.ExistsAsync(new SessionFsExistsRequest { Path = \"missing.txt\" });\n Assert.False(exists.Exists);\n\n AssertFsError((await handler.StatAsync(new SessionFsStatRequest { Path = \"missing.txt\" })).Error);\n AssertFsError(await handler.MkdirAsync(new SessionFsMkdirRequest { Path = \"missing-dir\" }));\n AssertFsError((await handler.ReaddirAsync(new SessionFsReaddirRequest { Path = \"missing-dir\" })).Error);\n AssertFsError((await handler.ReaddirWithTypesAsync(new SessionFsReaddirWithTypesRequest { Path = \"missing-dir\" })).Error);\n AssertFsError(await handler.RmAsync(new SessionFsRmRequest { Path = \"missing.txt\" }));\n AssertFsError(await handler.RenameAsync(new SessionFsRenameRequest { Src = \"missing.txt\", Dest = \"dest.txt\" }));\n\n var unknown = (ISessionFsHandler)new ThrowingSessionFsProvider(new InvalidOperationException(\"bad path\"));\n var unknownError = await unknown.WriteFileAsync(new SessionFsWriteFileRequest { Path = \"bad.txt\", Content = \"content\" });\n Assert.Equal(SessionFsErrorCode.UNKNOWN, unknownError!.Code);\n\n static void AssertFsError(SessionFsError? error)\n {\n Assert.NotNull(error);\n Assert.Equal(SessionFsErrorCode.ENOENT, error.Code);\n Assert.Contains(\"missing\", error.Message, StringComparison.OrdinalIgnoreCase);\n }\n }\n\n [Fact]\n public async Task Should_Map_Large_Output_Handling_Into_SessionFs()\n {\n var providerRoot = CreateProviderRoot();\n try\n {\n const int largeContentSize = 100_000;\n var suppliedFileContent = new string('x', largeContentSize);\n\n await using var client = CreateSessionFsClient(providerRoot);\n var session = await client.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n CreateSessionFsHandler = s => new TestSessionFsHandler(s.SessionId, providerRoot),\n Tools =\n [\n AIFunctionFactory.Create(() => suppliedFileContent, \"get_big_string\", \"Returns a large string\")\n ],\n });\n\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Call the get_big_string tool and reply with the word DONE only.\",\n });\n\n var messages = await session.GetMessagesAsync();\n var toolResult = FindToolCallResult(messages, \"get_big_string\");\n Assert.NotNull(toolResult);\n Assert.Contains($\"{SessionFsConfig.SessionStatePath}/temp/\", toolResult);\n\n var match = System.Text.RegularExpressions.Regex.Match(\n toolResult!,\n $\"({System.Text.RegularExpressions.Regex.Escape(SessionFsConfig.SessionStatePath)}/temp/[^\\\\s]+)\");\n Assert.True(match.Success);\n\n var fileContent = await ReadAllTextSharedAsync(GetStoredPath(providerRoot, session.SessionId, match.Groups[1].Value));\n Assert.Equal(suppliedFileContent, fileContent);\n await session.DisposeAsync();\n }\n finally\n {\n await TryDeleteDirectoryAsync(providerRoot);\n }\n }\n\n [Fact]\n public async Task Should_Succeed_With_Compaction_While_Using_SessionFs()\n {\n var providerRoot = CreateProviderRoot();\n try\n {\n await using var client = CreateSessionFsClient(providerRoot);\n var session = await client.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n CreateSessionFsHandler = s => new TestSessionFsHandler(s.SessionId, providerRoot),\n });\n\n SessionCompactionCompleteEvent? compactionEvent = null;\n using var _ = session.On(evt =>\n {\n if (evt is SessionCompactionCompleteEvent complete)\n {\n compactionEvent = complete;\n }\n });\n\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 2+2?\" });\n\n var eventsPath = GetStoredPath(providerRoot, session.SessionId, $\"{SessionFsConfig.SessionStatePath}/events.jsonl\");\n await WaitForConditionAsync(() => File.Exists(eventsPath), TimeSpan.FromSeconds(30));\n var contentBefore = await ReadAllTextSharedAsync(eventsPath);\n Assert.DoesNotContain(\"checkpointNumber\", contentBefore);\n\n await session.Rpc.History.CompactAsync();\n await WaitForConditionAsync(() => compactionEvent != null, TimeSpan.FromSeconds(30));\n Assert.NotNull(compactionEvent);\n }\n finally\n {\n await TryDeleteDirectoryAsync(providerRoot);\n }\n }\n\n [Fact]\n public async Task Should_Write_Workspace_Metadata_Via_SessionFs()\n {\n var providerRoot = CreateProviderRoot();\n try\n {\n await using var client = CreateSessionFsClient(providerRoot);\n var session = await client.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n CreateSessionFsHandler = s => new TestSessionFsHandler(s.SessionId, providerRoot),\n });\n\n var msg = await session.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 7 * 8?\" });\n Assert.Contains(\"56\", msg?.Data.Content ?? string.Empty);\n\n var workspaceYamlPath = GetStoredPath(providerRoot, session.SessionId, $\"{SessionFsConfig.SessionStatePath}/workspace.yaml\");\n await WaitForConditionAsync(() => File.Exists(workspaceYamlPath), TimeSpan.FromSeconds(30));\n Assert.Contains(session.SessionId, await ReadAllTextSharedAsync(workspaceYamlPath));\n\n var indexPath = GetStoredPath(providerRoot, session.SessionId, $\"{SessionFsConfig.SessionStatePath}/checkpoints/index.md\");\n await WaitForConditionAsync(() => File.Exists(indexPath), TimeSpan.FromSeconds(30));\n\n await session.DisposeAsync();\n }\n finally\n {\n await TryDeleteDirectoryAsync(providerRoot);\n }\n }\n\n [Fact]\n public async Task Should_Persist_Plan_Md_Via_SessionFs()\n {\n var providerRoot = CreateProviderRoot();\n try\n {\n await using var client = CreateSessionFsClient(providerRoot);\n var session = await client.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n CreateSessionFsHandler = s => new TestSessionFsHandler(s.SessionId, providerRoot),\n });\n\n // Write a plan via the session RPC\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 2 + 3?\" });\n await session.Rpc.Plan.UpdateAsync(\"# Test Plan\\n\\nThis is a test.\");\n\n var planPath = GetStoredPath(providerRoot, session.SessionId, $\"{SessionFsConfig.SessionStatePath}/plan.md\");\n await WaitForConditionAsync(() => File.Exists(planPath), TimeSpan.FromSeconds(30));\n Assert.Contains(\"This is a test.\", await ReadAllTextSharedAsync(planPath));\n\n await session.DisposeAsync();\n }\n finally\n {\n await TryDeleteDirectoryAsync(providerRoot);\n }\n }\n\n private CopilotClient CreateSessionFsClient(string providerRoot, bool useStdio = true)\n {\n Directory.CreateDirectory(providerRoot);\n return Ctx.CreateClient(\n useStdio: useStdio,\n options: new CopilotClientOptions\n {\n SessionFs = SessionFsConfig,\n });\n }\n\n private static string? FindToolCallResult(IReadOnlyList messages, string toolName)\n {\n var callId = messages\n .OfType()\n .FirstOrDefault(m => string.Equals(m.Data.ToolName, toolName, StringComparison.Ordinal))\n ?.Data.ToolCallId;\n\n if (callId is null)\n {\n return null;\n }\n\n return messages\n .OfType()\n .FirstOrDefault(m => string.Equals(m.Data.ToolCallId, callId, StringComparison.Ordinal))\n ?.Data.Result?.Content;\n }\n\n private static string CreateProviderRoot()\n => Path.Join(Path.GetTempPath(), $\"copilot-sessionfs-{Guid.NewGuid():N}\");\n\n private static string CreateSessionStatePath()\n {\n if (OperatingSystem.IsWindows())\n {\n return \"/session-state\";\n }\n\n return Path.Join(Path.GetTempPath(), $\"copilot-sessionfs-state-{Guid.NewGuid():N}\", \"session-state\")\n .Replace(Path.DirectorySeparatorChar, '/');\n }\n\n private static string GetStoredPath(string providerRoot, string sessionId, string sessionPath)\n {\n var safeSessionId = NormalizeRelativePathSegment(sessionId, nameof(sessionId));\n var relativeSegments = sessionPath\n .TrimStart('/', '\\\\')\n .Split(['/', '\\\\'], StringSplitOptions.RemoveEmptyEntries)\n .Select(segment => NormalizeRelativePathSegment(segment, nameof(sessionPath)))\n .ToArray();\n\n return Path.Join([providerRoot, safeSessionId, .. relativeSegments]);\n }\n\n private static async Task WaitForConditionAsync(Func condition, TimeSpan? timeout = null)\n {\n await WaitForConditionAsync(() => Task.FromResult(condition()), timeout);\n }\n\n private static async Task WaitForConditionAsync(Func> condition, TimeSpan? timeout = null)\n {\n using var cts = new CancellationTokenSource(timeout ?? TimeSpan.FromSeconds(30));\n Exception? lastException = null;\n while (!cts.IsCancellationRequested)\n {\n try\n {\n if (await condition())\n {\n return;\n }\n }\n catch (IOException ex)\n {\n lastException = ex;\n }\n catch (UnauthorizedAccessException ex)\n {\n lastException = ex;\n }\n\n try\n {\n await Task.Delay(100, cts.Token);\n }\n catch (OperationCanceledException)\n {\n break;\n }\n }\n\n throw new TimeoutException(\"Timed out waiting for condition.\", lastException);\n }\n\n private static async Task ReadAllTextSharedAsync(string path, CancellationToken cancellationToken = default)\n {\n await using var stream = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.ReadWrite | FileShare.Delete);\n using var reader = new StreamReader(stream);\n return await reader.ReadToEndAsync(cancellationToken);\n }\n\n private static async Task TryDeleteDirectoryAsync(string path)\n {\n if (!Directory.Exists(path))\n {\n return;\n }\n\n using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(5));\n Exception? lastException = null;\n\n while (!cts.IsCancellationRequested)\n {\n try\n {\n if (!Directory.Exists(path))\n {\n return;\n }\n\n Directory.Delete(path, recursive: true);\n return;\n }\n catch (IOException ex)\n {\n lastException = ex;\n }\n catch (UnauthorizedAccessException ex)\n {\n lastException = ex;\n }\n\n try\n {\n await Task.Delay(100, cts.Token);\n }\n catch (OperationCanceledException)\n {\n break;\n }\n }\n\n if (lastException is not null)\n {\n throw lastException;\n }\n }\n\n private static string NormalizeRelativePathSegment(string segment, string paramName)\n {\n if (string.IsNullOrWhiteSpace(segment))\n {\n throw new InvalidOperationException($\"{paramName} must not be empty.\");\n }\n\n var normalized = segment.TrimStart(Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar);\n if (Path.IsPathRooted(normalized) || normalized.Contains(Path.VolumeSeparatorChar))\n {\n throw new InvalidOperationException($\"{paramName} must be a relative path segment: {segment}\");\n }\n\n return normalized;\n }\n\n private sealed class ThrowingSessionFsProvider(Exception exception) : SessionFsProvider\n {\n protected override Task ReadFileAsync(string path, CancellationToken cancellationToken) =>\n Task.FromException(exception);\n\n protected override Task WriteFileAsync(string path, string content, int? mode, CancellationToken cancellationToken) =>\n Task.FromException(exception);\n\n protected override Task AppendFileAsync(string path, string content, int? mode, CancellationToken cancellationToken) =>\n Task.FromException(exception);\n\n protected override Task ExistsAsync(string path, CancellationToken cancellationToken) =>\n Task.FromException(exception);\n\n protected override Task StatAsync(string path, CancellationToken cancellationToken) =>\n Task.FromException(exception);\n\n protected override Task MkdirAsync(string path, bool recursive, int? mode, CancellationToken cancellationToken) =>\n Task.FromException(exception);\n\n protected override Task> ReaddirAsync(string path, CancellationToken cancellationToken) =>\n Task.FromException>(exception);\n\n protected override Task> ReaddirWithTypesAsync(string path, CancellationToken cancellationToken) =>\n Task.FromException>(exception);\n\n protected override Task RmAsync(string path, bool recursive, bool force, CancellationToken cancellationToken) =>\n Task.FromException(exception);\n\n protected override Task RenameAsync(string src, string dest, CancellationToken cancellationToken) =>\n Task.FromException(exception);\n }\n\n private sealed class TestSessionFsHandler(string sessionId, string rootDir) : SessionFsProvider\n {\n protected override async Task ReadFileAsync(string path, CancellationToken cancellationToken)\n {\n return await File.ReadAllTextAsync(ResolvePath(path), cancellationToken);\n }\n\n protected override async Task WriteFileAsync(string path, string content, int? mode, CancellationToken cancellationToken)\n {\n var fullPath = ResolvePath(path);\n Directory.CreateDirectory(Path.GetDirectoryName(fullPath)!);\n await File.WriteAllTextAsync(fullPath, content, cancellationToken);\n }\n\n protected override async Task AppendFileAsync(string path, string content, int? mode, CancellationToken cancellationToken)\n {\n var fullPath = ResolvePath(path);\n Directory.CreateDirectory(Path.GetDirectoryName(fullPath)!);\n await File.AppendAllTextAsync(fullPath, content, cancellationToken);\n }\n\n protected override Task ExistsAsync(string path, CancellationToken cancellationToken)\n {\n var fullPath = ResolvePath(path);\n return Task.FromResult(File.Exists(fullPath) || Directory.Exists(fullPath));\n }\n\n protected override Task StatAsync(string path, CancellationToken cancellationToken)\n {\n var fullPath = ResolvePath(path);\n if (File.Exists(fullPath))\n {\n var info = new FileInfo(fullPath);\n return Task.FromResult(new SessionFsStatResult\n {\n IsFile = true,\n IsDirectory = false,\n Size = info.Length,\n Mtime = info.LastWriteTimeUtc,\n Birthtime = info.CreationTimeUtc,\n });\n }\n\n var dirInfo = new DirectoryInfo(fullPath);\n if (!dirInfo.Exists)\n {\n throw new DirectoryNotFoundException($\"Path does not exist: {path}\");\n }\n\n return Task.FromResult(new SessionFsStatResult\n {\n IsFile = false,\n IsDirectory = true,\n Size = 0,\n Mtime = dirInfo.LastWriteTimeUtc,\n Birthtime = dirInfo.CreationTimeUtc,\n });\n }\n\n protected override Task MkdirAsync(string path, bool recursive, int? mode, CancellationToken cancellationToken)\n {\n Directory.CreateDirectory(ResolvePath(path));\n return Task.CompletedTask;\n }\n\n protected override Task> ReaddirAsync(string path, CancellationToken cancellationToken)\n {\n IList entries = Directory\n .EnumerateFileSystemEntries(ResolvePath(path))\n .Select(Path.GetFileName)\n .Where(name => name is not null)\n .Cast()\n .ToList();\n return Task.FromResult(entries);\n }\n\n protected override Task> ReaddirWithTypesAsync(string path, CancellationToken cancellationToken)\n {\n IList entries = Directory\n .EnumerateFileSystemEntries(ResolvePath(path))\n .Select(p => new SessionFsReaddirWithTypesEntry\n {\n Name = Path.GetFileName(p),\n Type = Directory.Exists(p) ? SessionFsReaddirWithTypesEntryType.Directory : SessionFsReaddirWithTypesEntryType.File,\n })\n .ToList();\n return Task.FromResult(entries);\n }\n\n protected override Task RmAsync(string path, bool recursive, bool force, CancellationToken cancellationToken)\n {\n var fullPath = ResolvePath(path);\n\n if (File.Exists(fullPath))\n {\n File.Delete(fullPath);\n return Task.CompletedTask;\n }\n\n if (Directory.Exists(fullPath))\n {\n Directory.Delete(fullPath, recursive);\n return Task.CompletedTask;\n }\n\n if (force)\n {\n return Task.CompletedTask;\n }\n\n throw new FileNotFoundException($\"Path does not exist: {path}\");\n }\n\n protected override Task RenameAsync(string src, string dest, CancellationToken cancellationToken)\n {\n var srcPath = ResolvePath(src);\n var destPath = ResolvePath(dest);\n Directory.CreateDirectory(Path.GetDirectoryName(destPath)!);\n\n if (Directory.Exists(srcPath))\n {\n Directory.Move(srcPath, destPath);\n }\n else\n {\n File.Move(srcPath, destPath, overwrite: true);\n }\n\n return Task.CompletedTask;\n }\n\n private string ResolvePath(string sessionPath)\n {\n var normalizedSessionId = NormalizeRelativePathSegment(sessionId, nameof(sessionId));\n var sessionRoot = Path.GetFullPath(Path.Join(rootDir, normalizedSessionId));\n var relativeSegments = sessionPath\n .TrimStart('/', '\\\\')\n .Split(['/', '\\\\'], StringSplitOptions.RemoveEmptyEntries)\n .Select(segment => NormalizeRelativePathSegment(segment, nameof(sessionPath)))\n .ToArray();\n\n var fullPath = Path.GetFullPath(Path.Join([sessionRoot, .. relativeSegments]));\n if (!fullPath.StartsWith(sessionRoot, StringComparison.Ordinal))\n {\n throw new InvalidOperationException($\"Path escapes session root: {sessionPath}\");\n }\n\n return fullPath;\n }\n }\n}\n" }, { "path": "dotnet/test/E2E/SessionLifecycleE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\n/// \n/// Lifecycle coverage at the level: listing\n/// persisted sessions, deleting a session, retrieving a session's stored\n/// events, and running multiple sessions concurrently. Mirrors\n/// nodejs/test/e2e/session_lifecycle.e2e.test.ts.\n/// \npublic class SessionLifecycleE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"session_lifecycle\", output)\n{\n [Fact]\n public async Task Should_List_Created_Sessions_After_Sending_A_Message()\n {\n var session1 = await CreateSessionAsync();\n var session2 = await CreateSessionAsync();\n\n // Sessions must have activity to be persisted to disk\n await session1.SendAndWaitAsync(new MessageOptions { Prompt = \"Say hello\" });\n await session2.SendAndWaitAsync(new MessageOptions { Prompt = \"Say world\" });\n\n IList? sessions = null;\n await WaitForAsync(async () =>\n {\n sessions = await Client.ListSessionsAsync();\n var ids = sessions.Select(s => s.SessionId).ToHashSet();\n return ids.Contains(session1.SessionId) && ids.Contains(session2.SessionId);\n }, TimeSpan.FromSeconds(10));\n\n Assert.NotNull(sessions);\n var sessionIds = sessions!.Select(s => s.SessionId).ToList();\n Assert.Contains(session1.SessionId, sessionIds);\n Assert.Contains(session2.SessionId, sessionIds);\n\n await session1.DisposeAsync();\n await session2.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Delete_Session_Permanently()\n {\n var session = await CreateSessionAsync();\n var sessionId = session.SessionId;\n\n // Send a message so the session is persisted\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Say hi\" });\n\n // Wait for the session to appear in the list\n await WaitForAsync(async () =>\n {\n var before = await Client.ListSessionsAsync();\n return before.Any(s => s.SessionId == sessionId);\n }, TimeSpan.FromSeconds(10));\n\n await session.DisposeAsync();\n await Client.DeleteSessionAsync(sessionId);\n\n // After delete, the session should not be in the list\n var after = await Client.ListSessionsAsync();\n Assert.DoesNotContain(after, s => s.SessionId == sessionId);\n }\n\n [Fact]\n public async Task Should_Return_Events_Via_GetMessages_After_Conversation()\n {\n var session = await CreateSessionAsync();\n\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is 2+2? Reply with just the number.\",\n });\n\n var messages = await session.GetMessagesAsync();\n Assert.NotEmpty(messages);\n\n // Should have at least session.start, user.message, assistant.message\n var types = messages.Select(m => m.Type).ToList();\n Assert.Contains(\"session.start\", types);\n Assert.Contains(\"user.message\", types);\n Assert.Contains(\"assistant.message\", types);\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Support_Multiple_Concurrent_Sessions()\n {\n var session1 = await CreateSessionAsync();\n var session2 = await CreateSessionAsync();\n\n // Send to both sessions in parallel\n var task1 = session1.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is 1+1? Reply with just the number.\",\n });\n var task2 = session2.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is 3+3? Reply with just the number.\",\n });\n\n var results = await Task.WhenAll(task1, task2);\n\n Assert.Contains(\"2\", results[0]?.Data.Content ?? string.Empty);\n Assert.Contains(\"6\", results[1]?.Data.Content ?? string.Empty);\n\n await session1.DisposeAsync();\n await session2.DisposeAsync();\n }\n\n /// \n /// Polls until it returns true or the timeout elapses.\n /// \n private static async Task WaitForAsync(Func> condition, TimeSpan timeout)\n {\n var deadline = DateTime.UtcNow + timeout;\n while (DateTime.UtcNow < deadline)\n {\n if (await condition()) return;\n await Task.Delay(100);\n }\n // Final attempt — let the test assertion below catch the failure\n await condition();\n }\n}\n" }, { "path": "dotnet/test/E2E/SessionMcpAndAgentConfigE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class SessionMcpAndAgentConfigE2ETests(E2ETestFixture fixture, ITestOutputHelper output) : E2ETestBase(fixture, \"mcp_and_agents\", output)\n{\n [Fact]\n public async Task Should_Accept_MCP_Server_Configuration_On_Session_Create()\n {\n var mcpServers = new Dictionary\n {\n [\"test-server\"] = new McpStdioServerConfig\n {\n Command = \"echo\",\n Args = [\"hello\"],\n Tools = [\"*\"]\n }\n };\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n McpServers = mcpServers\n });\n\n Assert.Matches(@\"^[a-f0-9-]+$\", session.SessionId);\n\n // Simple interaction to verify session works\n await session.SendAsync(new MessageOptions { Prompt = \"What is 2+2?\" });\n\n var message = await TestHelper.GetFinalAssistantMessageAsync(session);\n Assert.NotNull(message);\n Assert.Contains(\"4\", message!.Data.Content);\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Accept_MCP_Server_Configuration_On_Session_Resume()\n {\n // Create a session first\n var session1 = await CreateSessionAsync();\n var sessionId = session1.SessionId;\n await session1.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 1+1?\" });\n\n // Resume with MCP servers\n var mcpServers = new Dictionary\n {\n [\"test-server\"] = new McpStdioServerConfig\n {\n Command = \"echo\",\n Args = [\"hello\"],\n Tools = [\"*\"]\n }\n };\n\n var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig\n {\n McpServers = mcpServers\n });\n\n Assert.Equal(sessionId, session2.SessionId);\n\n var message = await session2.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 3+3?\" });\n Assert.NotNull(message);\n Assert.Contains(\"6\", message!.Data.Content);\n\n await session2.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Handle_Multiple_MCP_Servers()\n {\n var mcpServers = new Dictionary\n {\n [\"server1\"] = new McpStdioServerConfig\n {\n Command = \"echo\",\n Args = [\"server1\"],\n Tools = [\"*\"]\n },\n [\"server2\"] = new McpStdioServerConfig\n {\n Command = \"echo\",\n Args = [\"server2\"],\n Tools = [\"*\"]\n }\n };\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n McpServers = mcpServers\n });\n\n Assert.Matches(@\"^[a-f0-9-]+$\", session.SessionId);\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Accept_Custom_Agent_Configuration_On_Session_Create()\n {\n var customAgents = new List\n {\n new CustomAgentConfig\n {\n Name = \"test-agent\",\n DisplayName = \"Test Agent\",\n Description = \"A test agent for SDK testing\",\n Prompt = \"You are a helpful test agent.\",\n Infer = true\n }\n };\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n CustomAgents = customAgents\n });\n\n Assert.Matches(@\"^[a-f0-9-]+$\", session.SessionId);\n\n // Simple interaction to verify session works\n await session.SendAsync(new MessageOptions { Prompt = \"What is 5+5?\" });\n\n var message = await TestHelper.GetFinalAssistantMessageAsync(session);\n Assert.NotNull(message);\n Assert.Contains(\"10\", message!.Data.Content);\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Accept_Custom_Agent_Configuration_On_Session_Resume()\n {\n // Create a session first\n var session1 = await CreateSessionAsync();\n var sessionId = session1.SessionId;\n await session1.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 1+1?\" });\n\n // Resume with custom agents\n var customAgents = new List\n {\n new CustomAgentConfig\n {\n Name = \"resume-agent\",\n DisplayName = \"Resume Agent\",\n Description = \"An agent added on resume\",\n Prompt = \"You are a resume test agent.\"\n }\n };\n\n var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig\n {\n CustomAgents = customAgents\n });\n\n Assert.Equal(sessionId, session2.SessionId);\n\n var message = await session2.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 6+6?\" });\n Assert.NotNull(message);\n Assert.Contains(\"12\", message!.Data.Content);\n\n await session2.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Handle_Custom_Agent_With_Tools_Configuration()\n {\n var customAgents = new List\n {\n new CustomAgentConfig\n {\n Name = \"tool-agent\",\n DisplayName = \"Tool Agent\",\n Description = \"An agent with specific tools\",\n Prompt = \"You are an agent with specific tools.\",\n Tools = [\"bash\", \"edit\"],\n Infer = true\n }\n };\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n CustomAgents = customAgents\n });\n\n Assert.Matches(@\"^[a-f0-9-]+$\", session.SessionId);\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Handle_Custom_Agent_With_MCP_Servers()\n {\n var customAgents = new List\n {\n new CustomAgentConfig\n {\n Name = \"mcp-agent\",\n DisplayName = \"MCP Agent\",\n Description = \"An agent with its own MCP servers\",\n Prompt = \"You are an agent with MCP servers.\",\n McpServers = new Dictionary\n {\n [\"agent-server\"] = new McpStdioServerConfig\n {\n Command = \"echo\",\n Args = [\"agent-mcp\"],\n Tools = [\"*\"]\n }\n }\n }\n };\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n CustomAgents = customAgents\n });\n\n Assert.Matches(@\"^[a-f0-9-]+$\", session.SessionId);\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Handle_Multiple_Custom_Agents()\n {\n var customAgents = new List\n {\n new CustomAgentConfig\n {\n Name = \"agent1\",\n DisplayName = \"Agent One\",\n Description = \"First agent\",\n Prompt = \"You are agent one.\"\n },\n new CustomAgentConfig\n {\n Name = \"agent2\",\n DisplayName = \"Agent Two\",\n Description = \"Second agent\",\n Prompt = \"You are agent two.\",\n Infer = false\n }\n };\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n CustomAgents = customAgents\n });\n\n Assert.Matches(@\"^[a-f0-9-]+$\", session.SessionId);\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Pass_Literal_Env_Values_To_Mcp_Server_Subprocess()\n {\n var testHarnessDir = FindTestHarnessDir();\n var mcpServers = new Dictionary\n {\n [\"env-echo\"] = new McpStdioServerConfig\n {\n Command = \"node\",\n Args = [Path.Combine(testHarnessDir, \"test-mcp-server.mjs\")],\n Env = new Dictionary { [\"TEST_SECRET\"] = \"hunter2\" },\n Cwd = testHarnessDir,\n Tools = [\"*\"]\n }\n };\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n McpServers = mcpServers,\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n Assert.Matches(@\"^[a-f0-9-]+$\", session.SessionId);\n\n var message = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Use the env-echo/get_env tool to read the TEST_SECRET environment variable. Reply with just the value, nothing else.\"\n });\n\n Assert.NotNull(message);\n Assert.Contains(\"hunter2\", message!.Data.Content);\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Accept_Both_MCP_Servers_And_Custom_Agents()\n {\n var mcpServers = new Dictionary\n {\n [\"shared-server\"] = new McpStdioServerConfig\n {\n Command = \"echo\",\n Args = [\"shared\"],\n Tools = [\"*\"]\n }\n };\n\n var customAgents = new List\n {\n new CustomAgentConfig\n {\n Name = \"combined-agent\",\n DisplayName = \"Combined Agent\",\n Description = \"An agent using shared MCP servers\",\n Prompt = \"You are a combined test agent.\"\n }\n };\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n McpServers = mcpServers,\n CustomAgents = customAgents\n });\n\n Assert.Matches(@\"^[a-f0-9-]+$\", session.SessionId);\n\n await session.SendAsync(new MessageOptions { Prompt = \"What is 7+7?\" });\n\n // Use a longer timeout to tolerate slower MCP server spawning on Windows.\n var message = await TestHelper.GetFinalAssistantMessageAsync(session, TimeSpan.FromSeconds(120));\n Assert.NotNull(message);\n Assert.Contains(\"14\", message!.Data.Content);\n\n await session.DisposeAsync();\n }\n\n private static string FindTestHarnessDir()\n {\n var dir = new DirectoryInfo(AppContext.BaseDirectory);\n while (dir != null)\n {\n var candidate = Path.Combine(dir.FullName, \"test\", \"harness\", \"test-mcp-server.mjs\");\n if (File.Exists(candidate))\n return Path.GetDirectoryName(candidate)!;\n dir = dir.Parent;\n }\n throw new InvalidOperationException(\"Could not find test/harness/test-mcp-server.mjs\");\n }\n}\n" }, { "path": "dotnet/test/E2E/SkillsE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class SkillsE2ETests : E2ETestBase\n{\n private const string SkillMarker = \"PINEAPPLE_COCONUT_42\";\n\n private readonly string _workDir;\n\n public SkillsE2ETests(E2ETestFixture fixture, ITestOutputHelper output) : base(fixture, \"skills\", output)\n {\n _workDir = fixture.Ctx.WorkDir;\n\n var skillsDir = Path.Join(_workDir, \".test_skills\");\n if (Directory.Exists(skillsDir))\n {\n Directory.Delete(skillsDir, recursive: true);\n }\n }\n\n private string CreateSkillDir()\n {\n var skillsDir = Path.Join(_workDir, \".test_skills\");\n Directory.CreateDirectory(skillsDir);\n\n // Create a skill subdirectory with SKILL.md\n var skillSubdir = Path.Join(skillsDir, \"test-skill\");\n Directory.CreateDirectory(skillSubdir);\n\n // Create a skill that instructs the model to include a specific marker in responses\n var skillContent = $@\"---\nname: test-skill\ndescription: A test skill that adds a marker to responses\n---\n\n# Test Skill Instructions\n\nIMPORTANT: You MUST include the exact text \"\"{SkillMarker}\"\" somewhere in EVERY response you give. This is a mandatory requirement. Include it naturally in your response.\n\".ReplaceLineEndings(\"\\n\");\n File.WriteAllText(Path.Join(skillSubdir, \"SKILL.md\"), skillContent);\n\n return skillsDir;\n }\n\n private static void CreateSkill(string skillsDir, string name, string description, string body)\n {\n var skillSubdir = Path.Join(skillsDir, name);\n Directory.CreateDirectory(skillSubdir);\n\n var skillContent = $\"\"\"\n ---\n name: {name}\n description: {description}\n ---\n\n {body}\n\n \"\"\".ReplaceLineEndings(\"\\n\");\n File.WriteAllText(Path.Join(skillSubdir, \"SKILL.md\"), skillContent);\n }\n\n [Fact]\n public async Task Should_Load_And_Apply_Skill_From_SkillDirectories()\n {\n var skillsDir = CreateSkillDir();\n var session = await CreateSessionAsync(new SessionConfig\n {\n SkillDirectories = [skillsDir]\n });\n\n Assert.Matches(@\"^[a-f0-9-]+$\", session.SessionId);\n\n // The skill instructs the model to include a marker - verify it appears\n var message = await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Say hello briefly using the test skill.\" });\n Assert.NotNull(message);\n Assert.Contains(SkillMarker, message!.Data.Content);\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Not_Apply_Skill_When_Disabled_Via_DisabledSkills()\n {\n var skillsDir = CreateSkillDir();\n var session = await CreateSessionAsync(new SessionConfig\n {\n SkillDirectories = [skillsDir],\n DisabledSkills = [\"test-skill\"]\n });\n\n Assert.Matches(@\"^[a-f0-9-]+$\", session.SessionId);\n\n // The skill is disabled, so the marker should NOT appear\n var message = await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Say hello briefly using the test skill.\" });\n Assert.NotNull(message);\n Assert.DoesNotContain(SkillMarker, message!.Data.Content);\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Control_Ambient_Project_Skills_With_EnableConfigDiscovery()\n {\n var projectDir = Path.Join(_workDir, $\"config-discovery-{Guid.NewGuid():N}\");\n var projectSkillsDir = Path.Join(projectDir, \".github\", \"skills\");\n var skillName = $\"ambient-skill-{Guid.NewGuid():N}\".Substring(0, 32);\n Directory.CreateDirectory(projectSkillsDir);\n CreateSkill(\n projectSkillsDir,\n skillName,\n \"A project skill discovered from .github/skills\",\n \"Use the exact phrase AMBIENT_DISCOVERY_SKILL when this skill is active.\");\n\n var disabledSession = await CreateSessionAsync(new SessionConfig\n {\n WorkingDirectory = projectDir,\n EnableConfigDiscovery = false,\n });\n var disabledSkills = await disabledSession.Rpc.Skills.ListAsync();\n Assert.DoesNotContain(disabledSkills.Skills, skill => string.Equals(skill.Name, skillName, StringComparison.Ordinal));\n await disabledSession.DisposeAsync();\n\n var enabledSession = await CreateSessionAsync(new SessionConfig\n {\n WorkingDirectory = projectDir,\n EnableConfigDiscovery = true,\n });\n var enabledSkills = await enabledSession.Rpc.Skills.ListAsync();\n var discoveredSkill = Assert.Single(enabledSkills.Skills, skill => string.Equals(skill.Name, skillName, StringComparison.Ordinal));\n Assert.True(discoveredSkill.Enabled);\n Assert.Equal(\"project\", discoveredSkill.Source);\n Assert.EndsWith(Path.Join(skillName, \"SKILL.md\"), discoveredSkill.Path);\n await enabledSession.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Allow_Agent_With_Skills_To_Invoke_Skill()\n {\n var skillsDir = CreateSkillDir();\n var customAgents = new List\n {\n new CustomAgentConfig\n {\n Name = \"skill-agent\",\n Description = \"An agent with access to test-skill\",\n Prompt = \"You are a helpful test agent.\",\n Skills = [\"test-skill\"]\n }\n };\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n SkillDirectories = [skillsDir],\n CustomAgents = customAgents,\n Agent = \"skill-agent\"\n });\n\n Assert.Matches(@\"^[a-f0-9-]+$\", session.SessionId);\n\n // The agent has Skills = [\"test-skill\"], so the skill content is preloaded into its context\n var message = await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Say hello briefly using the test skill.\" });\n Assert.NotNull(message);\n Assert.Contains(SkillMarker, message!.Data.Content);\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Not_Provide_Skills_To_Agent_Without_Skills_Field()\n {\n var skillsDir = CreateSkillDir();\n var customAgents = new List\n {\n new CustomAgentConfig\n {\n Name = \"no-skill-agent\",\n Description = \"An agent without skills access\",\n Prompt = \"You are a helpful test agent.\"\n }\n };\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n SkillDirectories = [skillsDir],\n CustomAgents = customAgents,\n Agent = \"no-skill-agent\"\n });\n\n Assert.Matches(@\"^[a-f0-9-]+$\", session.SessionId);\n\n // The agent has no Skills field, so no skill content is injected\n var message = await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Say hello briefly using the test skill.\" });\n Assert.NotNull(message);\n Assert.DoesNotContain(SkillMarker, message!.Data.Content);\n\n await session.DisposeAsync();\n }\n\n [Fact(Skip = \"See the big comment around the equivalent test in the Node SDK. Skipped because the feature doesn't work correctly yet.\")]\n public async Task Should_Apply_Skill_On_Session_Resume_With_SkillDirectories()\n {\n var skillsDir = CreateSkillDir();\n\n // Create a session without skills first\n var session1 = await CreateSessionAsync();\n var sessionId = session1.SessionId;\n\n // First message without skill - marker should not appear\n var message1 = await session1.SendAndWaitAsync(new MessageOptions { Prompt = \"Say hi.\" });\n Assert.NotNull(message1);\n Assert.DoesNotContain(SkillMarker, message1!.Data.Content);\n\n // Resume with skillDirectories - skill should now be active\n var session2 = await ResumeSessionAsync(sessionId, new ResumeSessionConfig\n {\n SkillDirectories = [skillsDir]\n });\n\n Assert.Equal(sessionId, session2.SessionId);\n\n // Now the skill should be applied\n var message2 = await session2.SendAndWaitAsync(new MessageOptions { Prompt = \"Say hello again using the test skill.\" });\n Assert.NotNull(message2);\n Assert.Contains(SkillMarker, message2!.Data.Content);\n\n await session2.DisposeAsync();\n }\n}\n" }, { "path": "dotnet/test/E2E/StreamingFidelityE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class StreamingFidelityE2ETests(E2ETestFixture fixture, ITestOutputHelper output) : E2ETestBase(fixture, \"streaming_fidelity\", output)\n{\n [Fact]\n public async Task Should_Produce_Delta_Events_When_Streaming_Is_Enabled()\n {\n var session = await CreateSessionAsync(new SessionConfig { Streaming = true });\n\n var events = new List();\n session.On(evt => { lock (events) { events.Add(evt); } });\n\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Count from 1 to 5, separated by commas.\" });\n\n List snapshot;\n lock (events) { snapshot = [.. events]; }\n\n var types = snapshot.Select(e => e.Type).ToList();\n\n // Should have streaming deltas before the final message\n var deltaEvents = snapshot.OfType().ToList();\n Assert.NotEmpty(deltaEvents);\n\n // Deltas should have content\n foreach (var delta in deltaEvents)\n {\n Assert.False(string.IsNullOrEmpty(delta.Data.DeltaContent));\n }\n\n // Should still have a final assistant.message\n Assert.Contains(\"assistant.message\", types);\n\n // Deltas should come before the final message\n var firstDeltaIdx = types.IndexOf(\"assistant.message_delta\");\n var lastAssistantIdx = types.LastIndexOf(\"assistant.message\");\n Assert.True(firstDeltaIdx < lastAssistantIdx);\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Not_Produce_Deltas_When_Streaming_Is_Disabled()\n {\n var session = await CreateSessionAsync(new SessionConfig { Streaming = false });\n\n var events = new List();\n session.On(evt => { lock (events) { events.Add(evt); } });\n\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Say 'hello world'.\" });\n\n List snapshot;\n lock (events) { snapshot = [.. events]; }\n\n var deltaEvents = snapshot.OfType().ToList();\n\n // No deltas when streaming is off\n Assert.Empty(deltaEvents);\n\n // But should still have a final assistant.message\n var assistantEvents = snapshot.OfType().ToList();\n Assert.NotEmpty(assistantEvents);\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Produce_Deltas_After_Session_Resume()\n {\n var session = await CreateSessionAsync(new SessionConfig { Streaming = false });\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"What is 3 + 6?\" });\n await session.DisposeAsync();\n\n // Resume using a new client\n using var newClient = Ctx.CreateClient();\n var session2 = await newClient.ResumeSessionAsync(session.SessionId,\n new ResumeSessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll, Streaming = true });\n\n var events = new List();\n session2.On(evt => { lock (events) { events.Add(evt); } });\n\n var answer = await session2.SendAndWaitAsync(new MessageOptions { Prompt = \"Now if you double that, what do you get?\" });\n Assert.NotNull(answer);\n Assert.Contains(\"18\", answer!.Data.Content ?? string.Empty);\n\n List snapshot;\n lock (events) { snapshot = [.. events]; }\n\n // Should have streaming deltas before the final message\n var deltaEvents = snapshot.OfType().ToList();\n Assert.NotEmpty(deltaEvents);\n\n // Deltas should have content\n foreach (var delta in deltaEvents)\n {\n Assert.False(string.IsNullOrEmpty(delta.Data.DeltaContent));\n }\n\n await session2.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Emit_AssistantMessageStart_Before_Deltas_With_Matching_MessageId()\n {\n var session = await CreateSessionAsync(new SessionConfig { Streaming = true });\n\n var events = new List();\n session.On(evt => { lock (events) { events.Add(evt); } });\n\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Count from 1 to 5, separated by commas.\" });\n\n List snapshot;\n lock (events) { snapshot = [.. events]; }\n\n var startEvents = snapshot.OfType().ToList();\n var deltaEvents = snapshot.OfType().ToList();\n var messageEvents = snapshot.OfType().ToList();\n\n Assert.NotEmpty(startEvents);\n Assert.NotEmpty(deltaEvents);\n Assert.NotEmpty(messageEvents);\n\n // The start event must have a non-empty messageId\n var firstStart = startEvents[0];\n Assert.False(string.IsNullOrEmpty(firstStart.Data.MessageId));\n\n // The first message_start should arrive before the first message_delta\n var firstStartIdx = snapshot.IndexOf(firstStart);\n var firstDeltaIdx = snapshot.IndexOf(deltaEvents[0]);\n Assert.True(firstStartIdx < firstDeltaIdx,\n $\"Expected assistant.message_start ({firstStartIdx}) before first assistant.message_delta ({firstDeltaIdx})\");\n\n // Every assistant.message_start should have a corresponding assistant.message\n // emitted later with the same messageId.\n foreach (var start in startEvents)\n {\n Assert.Contains(messageEvents, m => m.Data.MessageId == start.Data.MessageId);\n }\n\n await session.DisposeAsync();\n }\n}\n" }, { "path": "dotnet/test/E2E/SuspendE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.ComponentModel;\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Microsoft.Extensions.AI;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\n/// \n/// E2E coverage for the session.suspend RPC. Suspend is a graceful shutdown\n/// counterpart to : it (1) cancels the current\n/// processing turn, (2) cancels all pending permission requests (resolving them with a\n/// \"cancelled\" outcome at the runtime), (3) rejects all pending external tool requests,\n/// (4) drains any in-flight notification turns, and (5) flushes pending writes to disk\n/// before the RPC returns. After suspend, the session has no pending work and the\n/// conversation log is durably persisted, so a subsequent\n/// on the same session id observes a\n/// consistent state.\n///\n/// Suspend is NOT a handoff for pending work — pending permissions/tools are cancelled\n/// rather than preserved. Tests that need to hand pending work to a new client should\n/// use with\n/// instead (see\n/// PendingWorkResumeE2ETests).\n/// \npublic class SuspendE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"suspend\", output)\n{\n private static readonly TimeSpan SuspendTimeout = TimeSpan.FromSeconds(60);\n\n [Fact]\n public async Task Should_Suspend_Idle_Session_Without_Throwing()\n {\n var session = await CreateSessionAsync();\n\n // Run a short turn so the session has some persisted state, then suspend.\n await session.SendAndWaitAsync(new MessageOptions { Prompt = \"Reply with: SUSPEND_IDLE_OK\" });\n\n // Suspend on an idle session must succeed (no current processing to cancel,\n // notification turns already drained, but pending writes still get flushed).\n await session.Rpc.SuspendAsync().WaitAsync(SuspendTimeout);\n\n await session.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Allow_Resume_And_Continue_Conversation_After_Suspend()\n {\n await using var server = Ctx.CreateClient(useStdio: false);\n await server.StartAsync();\n var cliUrl = GetCliUrl(server);\n\n string sessionId;\n await using (var client1 = Ctx.CreateClient(options: new CopilotClientOptions { CliUrl = cliUrl }))\n {\n var session1 = await client1.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n sessionId = session1.SessionId;\n\n await session1.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Remember the magic word: SUSPENSE. Reply with: SUSPEND_TURN_ONE\",\n });\n\n // Graceful suspend rather than ForceStopAsync — must drain and flush state\n // before the client tears down so the next session sees a consistent log.\n await session1.Rpc.SuspendAsync().WaitAsync(SuspendTimeout);\n await session1.DisposeAsync();\n }\n\n // A different client should be able to pick the session back up. The previous\n // turn was completed before suspend, so there is no pending work to continue.\n await using var client2 = Ctx.CreateClient(options: new CopilotClientOptions { CliUrl = cliUrl });\n var session2 = await client2.ResumeSessionAsync(sessionId, new ResumeSessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n var followUp = await session2.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What was the magic word I asked you to remember? Reply with just the word.\",\n });\n Assert.Contains(\"SUSPENSE\", followUp?.Data.Content ?? string.Empty, StringComparison.OrdinalIgnoreCase);\n\n await session2.DisposeAsync();\n }\n\n [Fact]\n public async Task Should_Cancel_Pending_Permission_Request_When_Suspending()\n {\n // Per the runtime impl, suspend resolves all pending permission requests with\n // a \"cancelled\" outcome on the runtime side and clears them. The SDK-side\n // permission handler task is left dangling (the runtime no longer awaits it),\n // and the underlying tool function is never invoked because the cancelled\n // permission means the runtime never grants execution.\n var permissionHandlerEntered = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n var releasePermissionHandler = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n var toolInvoked = false;\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n Tools = [AIFunctionFactory.Create(SuspendCancelPermissionTool, \"suspend_cancel_permission_tool\")],\n OnPermissionRequest = (request, _) =>\n {\n permissionHandlerEntered.TrySetResult(request);\n return releasePermissionHandler.Task;\n },\n });\n\n try\n {\n // Fire and forget — the SDK send task may complete (with whatever final\n // assistant message the runtime emits after cancellation) or remain pending\n // until the client connection drops. We don't depend on a specific outcome.\n _ = session.SendAsync(new MessageOptions\n {\n Prompt = \"Use suspend_cancel_permission_tool with value 'omega', then reply with the result.\",\n });\n\n var requestObserved = await permissionHandlerEntered.Task.WaitAsync(SuspendTimeout);\n Assert.IsType(requestObserved);\n\n // Suspend must complete promptly — it cancels the in-flight pending\n // permission request (resolving it as \"cancelled\" inside the runtime),\n // drains notification turns, and flushes pending writes to disk. The\n // runtime resolves the cancelled permission *before* it would have invoked\n // the tool, so by the time SuspendAsync returns (after the drain), the\n // tool function is guaranteed never to have been invoked — no Task.Delay\n // probe is needed.\n await session.Rpc.SuspendAsync().WaitAsync(SuspendTimeout);\n\n Assert.False(toolInvoked,\n \"Tool should not have been invoked: suspend cancels the pending permission, so the runtime never grants tool execution. Suspend's drain semantics guarantee this is observable immediately after SuspendAsync returns.\");\n }\n finally\n {\n // Defensive: release the dangling SDK-side handler task so it doesn't keep\n // a stray TaskCompletionSource alive after the test ends.\n releasePermissionHandler.TrySetResult(new PermissionRequestResult\n {\n Kind = PermissionRequestResultKind.UserNotAvailable,\n });\n }\n\n await session.DisposeAsync();\n\n [Description(\"Transforms a value (should not run when suspend cancels permission)\")]\n string SuspendCancelPermissionTool([Description(\"Value to transform\")] string value)\n {\n toolInvoked = true;\n return $\"SHOULD_NOT_RUN_{value}\";\n }\n }\n\n [Fact]\n public async Task Should_Reject_Pending_External_Tool_When_Suspending()\n {\n // Per the runtime impl, suspend rejects all pending external tool requests\n // with an Error(\"Session suspended\") and clears them. We register the tool as\n // a local SDK tool but force it to never return so the runtime hands it back\n // out as an \"external\" pending tool request that the test can observe.\n var toolStarted = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n var releaseTool = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n var externalToolRequested = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n Tools = [AIFunctionFactory.Create(BlockingTool, \"suspend_reject_external_tool\")],\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n using var subscription = session.On(evt =>\n {\n if (evt is ExternalToolRequestedEvent ext && ext.Data.ToolName == \"suspend_reject_external_tool\")\n {\n externalToolRequested.TrySetResult(ext);\n }\n });\n\n try\n {\n // Fire-and-forget the prompt — the SDK send task may complete with an error\n // or remain pending; we don't depend on a specific outcome.\n _ = session.SendAsync(new MessageOptions\n {\n Prompt = \"Use suspend_reject_external_tool with value 'sigma', then reply with the result.\",\n });\n\n // Wait for the tool to start executing (blocks on releaseTool).\n Assert.Equal(\"sigma\", await toolStarted.Task.WaitAsync(SuspendTimeout));\n\n // Suspend must complete promptly — it rejects the pending external tool\n // with an Error(\"Session suspended\"), drains notification turns, and\n // flushes pending writes.\n await session.Rpc.SuspendAsync().WaitAsync(SuspendTimeout);\n }\n finally\n {\n // Defensive: release the dangling SDK-side tool function so its Task\n // doesn't outlive the test.\n releaseTool.TrySetResult(\"RELEASED_AFTER_SUSPEND\");\n }\n\n await session.DisposeAsync();\n\n [Description(\"Looks up a value externally\")]\n async Task BlockingTool([Description(\"Value to look up\")] string value)\n {\n toolStarted.TrySetResult(value);\n return await releaseTool.Task;\n }\n }\n\n private static string GetCliUrl(CopilotClient client)\n {\n var port = client.ActualPort\n ?? throw new InvalidOperationException(\"Expected the test server to be listening on a TCP port.\");\n return $\"localhost:{port}\";\n }\n}\n" }, { "path": "dotnet/test/E2E/SystemMessageTransformE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class SystemMessageTransformE2ETests(E2ETestFixture fixture, ITestOutputHelper output) : E2ETestBase(fixture, \"system_message_transform\", output)\n{\n [Fact]\n public async Task Should_Invoke_Transform_Callbacks_With_Section_Content()\n {\n var identityCallbackInvoked = false;\n var toneCallbackInvoked = false;\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n SystemMessage = new SystemMessageConfig\n {\n Mode = SystemMessageMode.Customize,\n Sections = new Dictionary\n {\n [\"identity\"] = new SectionOverride\n {\n Transform = async (content) =>\n {\n Assert.False(string.IsNullOrEmpty(content));\n identityCallbackInvoked = true;\n return content;\n }\n },\n [\"tone\"] = new SectionOverride\n {\n Transform = async (content) =>\n {\n Assert.False(string.IsNullOrEmpty(content));\n toneCallbackInvoked = true;\n return content;\n }\n }\n }\n }\n });\n\n await File.WriteAllTextAsync(Path.Combine(Ctx.WorkDir, \"test.txt\"), \"Hello transform!\");\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Read the contents of test.txt and tell me what it says\"\n });\n\n await TestHelper.GetFinalAssistantMessageAsync(session);\n\n Assert.True(identityCallbackInvoked, \"Expected identity transform callback to be invoked\");\n Assert.True(toneCallbackInvoked, \"Expected tone transform callback to be invoked\");\n }\n\n [Fact]\n public async Task Should_Apply_Transform_Modifications_To_Section_Content()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n SystemMessage = new SystemMessageConfig\n {\n Mode = SystemMessageMode.Customize,\n Sections = new Dictionary\n {\n [\"identity\"] = new SectionOverride\n {\n Transform = async (content) =>\n {\n return content + \"\\nAlways end your reply with TRANSFORM_MARKER\";\n }\n }\n }\n }\n });\n\n await File.WriteAllTextAsync(Path.Combine(Ctx.WorkDir, \"hello.txt\"), \"Hello!\");\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Read the contents of hello.txt\"\n });\n\n await TestHelper.GetFinalAssistantMessageAsync(session);\n\n // Verify the transform result was actually applied to the system message\n var traffic = await Ctx.GetExchangesAsync();\n Assert.NotEmpty(traffic);\n var systemMessage = GetSystemMessage(traffic[0]);\n Assert.Contains(\"TRANSFORM_MARKER\", systemMessage);\n }\n\n [Fact]\n public async Task Should_Work_With_Static_Overrides_And_Transforms_Together()\n {\n var transformCallbackInvoked = false;\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n SystemMessage = new SystemMessageConfig\n {\n Mode = SystemMessageMode.Customize,\n Sections = new Dictionary\n {\n [\"safety\"] = new SectionOverride\n {\n Action = SectionOverrideAction.Remove\n },\n [\"identity\"] = new SectionOverride\n {\n Transform = async (content) =>\n {\n transformCallbackInvoked = true;\n return content;\n }\n }\n }\n }\n });\n\n await File.WriteAllTextAsync(Path.Combine(Ctx.WorkDir, \"combo.txt\"), \"Combo test!\");\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Read the contents of combo.txt and tell me what it says\"\n });\n\n await TestHelper.GetFinalAssistantMessageAsync(session);\n\n Assert.True(transformCallbackInvoked, \"Expected identity transform callback to be invoked\");\n }\n}\n" }, { "path": "dotnet/test/E2E/TelemetryExportE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Microsoft.Extensions.AI;\nusing System.Text.Json;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic class TelemetryExportE2ETests(E2ETestFixture fixture, ITestOutputHelper output)\n : E2ETestBase(fixture, \"telemetry\", output)\n{\n [Fact]\n public async Task Should_Export_File_Telemetry_For_Sdk_Interactions()\n {\n var telemetryPath = Path.Join(Ctx.WorkDir, $\"telemetry-{Guid.NewGuid():N}.jsonl\");\n const string marker = \"copilot-sdk-telemetry-e2e\";\n const string sourceName = \"dotnet-sdk-telemetry-e2e\";\n const string toolName = \"echo_telemetry_marker\";\n const string prompt = $\"Use the {toolName} tool with value '{marker}', then respond with TELEMETRY_E2E_DONE.\";\n\n await using var client = Ctx.CreateClient(options: new CopilotClientOptions\n {\n Telemetry = new TelemetryConfig\n {\n FilePath = telemetryPath,\n ExporterType = \"file\",\n SourceName = sourceName,\n CaptureContent = true,\n },\n });\n\n var session = await client.CreateSessionAsync(new SessionConfig\n {\n Tools = [AIFunctionFactory.Create(EchoTelemetryMarker, toolName, \"Echoes a marker string for telemetry validation.\")],\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n await session.SendAsync(new MessageOptions { Prompt = prompt });\n var assistantMessage = await TestHelper.GetFinalAssistantMessageAsync(session);\n Assert.NotNull(assistantMessage);\n Assert.Contains(\"TELEMETRY_E2E_DONE\", assistantMessage!.Data.Content ?? string.Empty, StringComparison.Ordinal);\n\n await session.DisposeAsync();\n await client.StopAsync();\n\n var entries = await ReadTelemetryEntriesAsync(\n telemetryPath,\n entries => entries.Any(entry => GetTypeName(entry) == \"span\" &&\n GetStringAttribute(entry, \"gen_ai.operation.name\") == \"invoke_agent\"));\n var spans = entries.Where(entry => GetTypeName(entry) == \"span\").ToList();\n\n Assert.NotEmpty(spans);\n Assert.All(spans, span => Assert.Equal(sourceName, GetInstrumentationScopeName(span)));\n\n // All spans for one SDK turn must share the same trace id and must not be in error state.\n var traceIds = spans.Select(GetTraceId).Where(id => !string.IsNullOrEmpty(id)).Distinct().ToList();\n Assert.Single(traceIds);\n Assert.All(spans, span => Assert.NotEqual(2, GetStatusCode(span)));\n\n var invokeAgentSpan = AssertSpanWithOperation(spans, \"invoke_agent\");\n Assert.Equal(session.SessionId, GetStringAttribute(invokeAgentSpan, \"gen_ai.conversation.id\"));\n Assert.True(IsRootSpan(invokeAgentSpan),\n \"invoke_agent should be the root of the SDK turn trace.\");\n var invokeAgentSpanId = GetSpanId(invokeAgentSpan);\n Assert.False(string.IsNullOrEmpty(invokeAgentSpanId));\n\n var chatSpans = spans.Where(span => IsSpanWithOperation(span, \"chat\")).ToList();\n Assert.NotEmpty(chatSpans);\n Assert.All(chatSpans, chat => Assert.Equal(invokeAgentSpanId, GetParentSpanId(chat)));\n Assert.Contains(\n chatSpans,\n span => (GetStringAttribute(span, \"gen_ai.input.messages\") ?? string.Empty).Contains(prompt, StringComparison.Ordinal));\n Assert.Contains(\n chatSpans,\n span => (GetStringAttribute(span, \"gen_ai.output.messages\") ?? string.Empty).Contains(\"TELEMETRY_E2E_DONE\", StringComparison.Ordinal));\n\n var toolSpan = AssertSpanWithOperation(spans, \"execute_tool\");\n Assert.Equal(invokeAgentSpanId, GetParentSpanId(toolSpan));\n Assert.Equal(toolName, GetStringAttribute(toolSpan, \"gen_ai.tool.name\"));\n Assert.False(string.IsNullOrWhiteSpace(GetStringAttribute(toolSpan, \"gen_ai.tool.call.id\")),\n \"execute_tool span should carry gen_ai.tool.call.id.\");\n Assert.Equal($\"{{\\\"value\\\":\\\"{marker}\\\"}}\", GetStringAttribute(toolSpan, \"gen_ai.tool.call.arguments\"));\n Assert.Equal(marker, GetStringAttribute(toolSpan, \"gen_ai.tool.call.result\"));\n\n static string EchoTelemetryMarker(string value) => value;\n }\n\n private static async Task> ReadTelemetryEntriesAsync(\n string path,\n Func, bool> isComplete)\n {\n using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(30));\n while (!cts.IsCancellationRequested)\n {\n if (File.Exists(path) && new FileInfo(path).Length > 0)\n {\n var entries = new List();\n using var stream = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.ReadWrite | FileShare.Delete);\n using var reader = new StreamReader(stream);\n while (await reader.ReadLineAsync(cts.Token) is { } line)\n {\n if (string.IsNullOrWhiteSpace(line))\n {\n continue;\n }\n\n using var document = JsonDocument.Parse(line);\n entries.Add(document.RootElement.Clone());\n }\n\n if (entries.Count > 0 && isComplete(entries))\n {\n return entries;\n }\n }\n\n try\n {\n await Task.Delay(TimeSpan.FromMilliseconds(100), cts.Token);\n }\n catch (OperationCanceledException)\n {\n break;\n }\n }\n\n throw new TimeoutException($\"Timed out waiting for telemetry records in '{path}'.\");\n }\n\n private static string? GetTraceId(JsonElement entry) => GetStringProperty(entry, \"traceId\");\n\n private static string? GetSpanId(JsonElement entry) => GetStringProperty(entry, \"spanId\");\n\n private static string? GetParentSpanId(JsonElement entry) => GetStringProperty(entry, \"parentSpanId\");\n\n private static bool IsRootSpan(JsonElement entry)\n {\n // OTel exporters represent \"no parent\" inconsistently: the property may be missing,\n // an empty string, or an all-zeros span id. Accept any of the three.\n var parent = GetParentSpanId(entry);\n return string.IsNullOrEmpty(parent) || parent == \"0000000000000000\";\n }\n\n private static int GetStatusCode(JsonElement entry)\n {\n return entry.TryGetProperty(\"status\", out var status) && status.TryGetProperty(\"code\", out var code) && code.ValueKind == JsonValueKind.Number\n ? code.GetInt32()\n : 0;\n }\n\n private static JsonElement AssertSpanWithOperation(IEnumerable spans, string operationName)\n {\n var matchingSpan = spans.FirstOrDefault(span => GetStringAttribute(span, \"gen_ai.operation.name\") == operationName);\n Assert.NotEqual(JsonValueKind.Undefined, matchingSpan.ValueKind);\n return matchingSpan;\n }\n\n private static bool IsSpanWithOperation(JsonElement span, string operationName)\n {\n return GetStringAttribute(span, \"gen_ai.operation.name\") == operationName;\n }\n\n private static string? GetTypeName(JsonElement entry) => GetStringProperty(entry, \"type\");\n\n private static string? GetInstrumentationScopeName(JsonElement entry)\n {\n return entry.TryGetProperty(\"instrumentationScope\", out var scope)\n ? GetStringProperty(scope, \"name\")\n : null;\n }\n\n private static string? GetStringAttribute(JsonElement entry, string name)\n {\n if (!entry.TryGetProperty(\"attributes\", out var attributes) ||\n !attributes.TryGetProperty(name, out var value))\n {\n return null;\n }\n\n return GetStringValue(value);\n }\n\n private static string? GetStringProperty(JsonElement entry, string name)\n {\n return entry.TryGetProperty(name, out var value) ? GetStringValue(value) : null;\n }\n\n private static string? GetStringValue(JsonElement value)\n {\n return value.ValueKind switch\n {\n JsonValueKind.String => value.GetString(),\n JsonValueKind.Number or JsonValueKind.True or JsonValueKind.False or JsonValueKind.Array or JsonValueKind.Object => value.GetRawText(),\n _ => null,\n };\n }\n}\n" }, { "path": "dotnet/test/E2E/ToolResultsE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Microsoft.Extensions.AI;\nusing System.ComponentModel;\nusing System.Text.Json;\nusing System.Text.Json.Serialization;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic partial class ToolResultsE2ETests(E2ETestFixture fixture, ITestOutputHelper output) : E2ETestBase(fixture, \"tool_results\", output)\n{\n [JsonSourceGenerationOptions(JsonSerializerDefaults.Web)]\n [JsonSerializable(typeof(ToolResultAIContent))]\n [JsonSerializable(typeof(ToolResultObject))]\n [JsonSerializable(typeof(JsonElement))]\n private partial class ToolResultsJsonContext : JsonSerializerContext;\n\n [Fact]\n public async Task Should_Handle_Structured_ToolResultObject_From_Custom_Tool()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n Tools = [AIFunctionFactory.Create(GetWeather, \"get_weather\", serializerOptions: ToolResultsJsonContext.Default.Options)],\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"What's the weather in Paris?\"\n });\n\n var assistantMessage = await TestHelper.GetFinalAssistantMessageAsync(session);\n Assert.NotNull(assistantMessage);\n Assert.Matches(\"(?i)sunny|72\", assistantMessage!.Data.Content ?? string.Empty);\n\n [Description(\"Gets weather for a city\")]\n static ToolResultAIContent GetWeather([Description(\"City name\")] string city)\n => new(new()\n {\n TextResultForLlm = $\"The weather in {city} is sunny and 72°F\",\n ResultType = \"success\",\n });\n }\n\n [Fact]\n public async Task Should_Handle_Tool_Result_With_Failure_ResultType()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n Tools = [AIFunctionFactory.Create(CheckStatus, \"check_status\", serializerOptions: ToolResultsJsonContext.Default.Options)],\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Check the status of the service using check_status. If it fails, say 'service is down'.\"\n });\n\n var assistantMessage = await TestHelper.GetFinalAssistantMessageAsync(session);\n Assert.NotNull(assistantMessage);\n Assert.Contains(\"service is down\", assistantMessage!.Data.Content?.ToLowerInvariant() ?? string.Empty);\n\n [Description(\"Checks the status of a service\")]\n static ToolResultAIContent CheckStatus()\n => new(new()\n {\n TextResultForLlm = \"Service unavailable\",\n ResultType = \"failure\",\n Error = \"API timeout\",\n });\n }\n\n [Fact]\n public async Task Should_Preserve_ToolTelemetry_And_Not_Stringify_Structured_Results_For_LLM()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n Tools = [AIFunctionFactory.Create(AnalyzeCode, \"analyze_code\", serializerOptions: ToolResultsJsonContext.Default.Options)],\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Analyze the file main.ts for issues.\"\n });\n\n var assistantMessage = await TestHelper.GetFinalAssistantMessageAsync(session);\n Assert.NotNull(assistantMessage);\n Assert.Contains(\"no issues\", assistantMessage!.Data.Content?.ToLowerInvariant() ?? string.Empty);\n\n // Verify the LLM received just textResultForLlm, not stringified JSON\n var traffic = await Ctx.GetExchangesAsync();\n var lastConversation = traffic[^1];\n\n var toolResults = lastConversation.Request.Messages\n .Where(m => m.Role == \"tool\")\n .ToList();\n\n Assert.Single(toolResults);\n Assert.DoesNotContain(\"toolTelemetry\", toolResults[0].StringContent);\n Assert.DoesNotContain(\"resultType\", toolResults[0].StringContent);\n\n [Description(\"Analyzes code for issues\")]\n static ToolResultAIContent AnalyzeCode([Description(\"File to analyze\")] string file)\n => new(new()\n {\n TextResultForLlm = $\"Analysis of {file}: no issues found\",\n ResultType = \"success\",\n ToolTelemetry = new Dictionary\n {\n [\"metrics\"] = new Dictionary { [\"analysisTimeMs\"] = 150 },\n [\"properties\"] = new Dictionary { [\"analyzer\"] = \"eslint\" },\n },\n });\n }\n}\n" }, { "path": "dotnet/test/E2E/ToolsE2ETests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Microsoft.Extensions.AI;\nusing System.Collections.ObjectModel;\nusing System.ComponentModel;\nusing System.Linq;\nusing System.Text.Json;\nusing System.Text.Json.Serialization;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test.E2E;\n\npublic partial class ToolsE2ETests(E2ETestFixture fixture, ITestOutputHelper output) : E2ETestBase(fixture, \"tools\", output)\n{\n [Fact]\n public async Task Invokes_Built_In_Tools()\n {\n await File.WriteAllTextAsync(\n Path.Combine(Ctx.WorkDir, \"README.md\"),\n \"# ELIZA, the only chatbot you'll ever need\");\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"What's the first line of README.md in this directory?\"\n });\n\n var assistantMessage = await TestHelper.GetFinalAssistantMessageAsync(session);\n Assert.NotNull(assistantMessage);\n Assert.Contains(\"ELIZA\", assistantMessage!.Data.Content ?? string.Empty);\n }\n\n [Fact]\n public async Task Invokes_Custom_Tool()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n Tools = [AIFunctionFactory.Create(EncryptString, \"encrypt_string\")],\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Use encrypt_string to encrypt this string: Hello\"\n });\n\n var assistantMessage = await TestHelper.GetFinalAssistantMessageAsync(session);\n Assert.NotNull(assistantMessage);\n Assert.Contains(\"HELLO\", assistantMessage!.Data.Content ?? string.Empty);\n\n [Description(\"Encrypts a string\")]\n static string EncryptString([Description(\"String to encrypt\")] string input)\n => input.ToUpperInvariant();\n }\n\n [Fact]\n public async Task Handles_Tool_Calling_Errors()\n {\n var getUserLocation = AIFunctionFactory.Create(\n () => { throw new Exception(\"Melbourne\"); }, \"get_user_location\", \"Gets the user's location\");\n\n var session = await CreateSessionAsync(new SessionConfig\n {\n Tools = [getUserLocation],\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n await session.SendAsync(new MessageOptions { Prompt = \"What is my location? If you can't find out, just say 'unknown'.\" });\n var answer = await TestHelper.GetFinalAssistantMessageAsync(session);\n\n // Check the underlying traffic\n var traffic = await Ctx.GetExchangesAsync();\n var lastConversation = traffic[^1];\n\n var toolCalls = lastConversation.Request.Messages\n .Where(m => m.Role == \"assistant\" && m.ToolCalls != null)\n .SelectMany(m => m.ToolCalls!)\n .ToList();\n\n Assert.Single(toolCalls);\n var toolCall = toolCalls[0];\n Assert.Equal(\"function\", toolCall.Type);\n Assert.Equal(\"get_user_location\", toolCall.Function.Name);\n\n var toolResults = lastConversation.Request.Messages\n .Where(m => m.Role == \"tool\")\n .ToList();\n\n Assert.Single(toolResults);\n var toolResult = toolResults[0];\n Assert.Equal(toolCall.Id, toolResult.ToolCallId);\n Assert.DoesNotContain(\"Melbourne\", toolResult.StringContent);\n\n // Importantly, we're checking that the assistant does not see the\n // exception information as if it was the tool's output.\n Assert.DoesNotContain(\"Melbourne\", answer?.Data.Content);\n Assert.Contains(\"unknown\", answer?.Data.Content?.ToLowerInvariant());\n }\n\n [Fact]\n public async Task Can_Receive_And_Return_Complex_Types()\n {\n ToolInvocation? receivedInvocation = null;\n var session = await CreateSessionAsync(new SessionConfig\n {\n Tools = [AIFunctionFactory.Create(PerformDbQuery, \"db_query\", serializerOptions: ToolsTestsJsonContext.Default.Options)],\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt =\n \"Perform a DB query for the 'cities' table using IDs 12 and 19, sorting ascending. \" +\n \"Reply only with lines of the form: [cityname] [population]\"\n });\n\n var assistantMessage = await TestHelper.GetFinalAssistantMessageAsync(session);\n var responseContent = assistantMessage?.Data.Content!;\n Assert.NotNull(assistantMessage);\n Assert.NotEmpty(responseContent);\n Assert.Contains(\"Passos\", responseContent);\n Assert.Contains(\"San Lorenzo\", responseContent);\n Assert.Contains(\"135460\", responseContent.Replace(\",\", \"\"));\n Assert.Contains(\"204356\", responseContent.Replace(\",\", \"\"));\n\n // We can access the raw invocation if needed\n Assert.Equal(session.SessionId, receivedInvocation!.SessionId);\n\n City[] PerformDbQuery(DbQueryOptions query, AIFunctionArguments rawArgs)\n {\n Assert.Equal(\"cities\", query.Table);\n Assert.Equal([12, 19], query.Ids);\n Assert.True(query.SortAscending);\n receivedInvocation = (ToolInvocation)rawArgs.Context![typeof(ToolInvocation)]!;\n return [new(19, \"Passos\", 135460), new(12, \"San Lorenzo\", 204356)];\n }\n }\n\n record DbQueryOptions(string Table, int[] Ids, bool SortAscending);\n record City(int CountryId, string CityName, int Population);\n\n [JsonSourceGenerationOptions(JsonSerializerDefaults.Web)]\n [JsonSerializable(typeof(DbQueryOptions))]\n [JsonSerializable(typeof(City[]))]\n [JsonSerializable(typeof(JsonElement))]\n private partial class ToolsTestsJsonContext : JsonSerializerContext;\n\n [Fact]\n public async Task Overrides_Built_In_Tool_With_Custom_Tool()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n Tools = [AIFunctionFactory.Create((Delegate)CustomGrep, new AIFunctionFactoryOptions\n {\n Name = \"grep\",\n AdditionalProperties = new ReadOnlyDictionary(\n new Dictionary { [\"is_override\"] = true })\n })],\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Use grep to search for the word 'hello'\"\n });\n\n var assistantMessage = await TestHelper.GetFinalAssistantMessageAsync(session);\n Assert.NotNull(assistantMessage);\n Assert.Contains(\"CUSTOM_GREP_RESULT\", assistantMessage!.Data.Content ?? string.Empty);\n\n [Description(\"A custom grep implementation that overrides the built-in\")]\n static string CustomGrep([Description(\"Search query\")] string query)\n => $\"CUSTOM_GREP_RESULT: {query}\";\n }\n\n [Fact]\n public async Task SkipPermission_Sent_In_Tool_Definition()\n {\n [Description(\"A tool that skips permission\")]\n static string SafeLookup([Description(\"Lookup ID\")] string id)\n => $\"RESULT: {id}\";\n\n var tool = AIFunctionFactory.Create((Delegate)SafeLookup, new AIFunctionFactoryOptions\n {\n Name = \"safe_lookup\",\n AdditionalProperties = new ReadOnlyDictionary(\n new Dictionary { [\"skip_permission\"] = true })\n });\n\n var didRunPermissionRequest = false;\n var session = await CreateSessionAsync(new SessionConfig\n {\n Tools = [tool],\n OnPermissionRequest = (_, _) =>\n {\n didRunPermissionRequest = true;\n return Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.NoResult });\n }\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Use safe_lookup to look up 'test123'\"\n });\n\n var assistantMessage = await TestHelper.GetFinalAssistantMessageAsync(session);\n Assert.NotNull(assistantMessage);\n Assert.Contains(\"RESULT\", assistantMessage!.Data.Content ?? string.Empty);\n Assert.False(didRunPermissionRequest);\n }\n\n [Fact(Skip = \"Behaves as if no content was in the result. Likely that binary results aren't fully implemented yet.\")]\n public async Task Can_Return_Binary_Result()\n {\n var session = await CreateSessionAsync(new SessionConfig\n {\n Tools = [AIFunctionFactory.Create(GetImage, \"get_image\")],\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Use get_image. What color is the square in the image?\"\n });\n\n var assistantMessage = await TestHelper.GetFinalAssistantMessageAsync(session);\n Assert.NotNull(assistantMessage);\n\n Assert.Contains(\"yellow\", assistantMessage!.Data.Content?.ToLowerInvariant() ?? string.Empty);\n\n static ToolResultAIContent GetImage() => new(new()\n {\n BinaryResultsForLlm = [new() {\n // 2x2 yellow square\n Data = \"iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAIAAAD91JpzAAAADklEQVR4nGP4/5/h/38GABkAA/0k+7UAAAAASUVORK5CYII=\",\n Type = \"base64\",\n MimeType = \"image/png\",\n }],\n SessionLog = \"Returned an image\",\n });\n }\n\n [Fact]\n public async Task Invokes_Custom_Tool_With_Permission_Handler()\n {\n var permissionRequests = new List();\n\n var session = await Client.CreateSessionAsync(new SessionConfig\n {\n Tools = [AIFunctionFactory.Create(EncryptStringForPermission, \"encrypt_string\")],\n OnPermissionRequest = (request, invocation) =>\n {\n permissionRequests.Add(request);\n return Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved });\n },\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Use encrypt_string to encrypt this string: Hello\"\n });\n\n var assistantMessage = await TestHelper.GetFinalAssistantMessageAsync(session);\n Assert.NotNull(assistantMessage);\n Assert.Contains(\"HELLO\", assistantMessage!.Data.Content ?? string.Empty);\n\n // Should have received a custom-tool permission request with the correct tool name\n var customToolRequest = permissionRequests.OfType().FirstOrDefault();\n Assert.NotNull(customToolRequest);\n Assert.Equal(\"encrypt_string\", customToolRequest!.ToolName);\n\n [Description(\"Encrypts a string\")]\n static string EncryptStringForPermission([Description(\"String to encrypt\")] string input)\n => input.ToUpperInvariant();\n }\n\n [Fact]\n public async Task Denies_Custom_Tool_When_Permission_Denied()\n {\n var toolHandlerCalled = false;\n\n var session = await Client.CreateSessionAsync(new SessionConfig\n {\n Tools = [AIFunctionFactory.Create(EncryptStringDenied, \"encrypt_string\")],\n OnPermissionRequest = async (request, invocation) => new() { Kind = PermissionRequestResultKind.Rejected },\n });\n\n await session.SendAsync(new MessageOptions\n {\n Prompt = \"Use encrypt_string to encrypt this string: Hello\"\n });\n\n await TestHelper.GetFinalAssistantMessageAsync(session);\n\n // The tool handler should NOT have been called since permission was denied\n Assert.False(toolHandlerCalled);\n\n [Description(\"Encrypts a string\")]\n string EncryptStringDenied([Description(\"String to encrypt\")] string input)\n {\n toolHandlerCalled = true;\n return input.ToUpperInvariant();\n }\n }\n}\n" }, { "path": "dotnet/test/GitHub.Copilot.SDK.Test.csproj", "content": "\n\n \n false\n $(NoWarn);GHCP001\n \n\n \n \n false\n \n\n \n \n \n \n runtime; build; native; contentfiles; analyzers; buildtransitive\n all\n \n \n runtime; build; native; contentfiles; analyzers; buildtransitive\n all\n \n \n\n \n \n \n\n\n" }, { "path": "dotnet/test/Harness/CapiProxy.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.Diagnostics;\nusing System.Net.Http.Json;\nusing System.Runtime.InteropServices;\nusing System.Text;\nusing System.Text.Json;\nusing System.Text.Json.Serialization;\nusing System.Text.RegularExpressions;\n\nnamespace GitHub.Copilot.SDK.Test.Harness;\n\npublic sealed partial class CapiProxy : IAsyncDisposable\n{\n private Process? _process;\n private Task? _startupTask;\n\n public Task StartAsync()\n {\n return _startupTask ??= StartCoreAsync();\n\n async Task StartCoreAsync()\n {\n string filename;\n string args;\n\n if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))\n {\n filename = \"cmd.exe\";\n args = \"/c npm.cmd run start\";\n\n }\n else\n {\n filename = \"npm\";\n args = \"run start\";\n }\n\n var startInfo = new ProcessStartInfo\n {\n FileName = filename,\n WorkingDirectory = Path.Join(FindRepoRoot(), \"test\", \"harness\"),\n Arguments = args,\n UseShellExecute = false,\n RedirectStandardOutput = true,\n RedirectStandardError = true,\n CreateNoWindow = true,\n };\n\n _process = new Process { StartInfo = startInfo };\n\n var tcs = new TaskCompletionSource();\n var errorOutput = new StringBuilder();\n\n _process.OutputDataReceived += (_, e) =>\n {\n if (e.Data == null) return;\n var match = Regex.Match(e.Data, @\"Listening: (http://[^\\s]+)\");\n if (match.Success) tcs.TrySetResult(match.Groups[1].Value);\n };\n\n _process.ErrorDataReceived += (_, e) =>\n {\n if (e.Data == null) return;\n errorOutput.AppendLine(e.Data);\n Console.Error.WriteLine(e.Data);\n };\n\n _process.Start();\n _process.BeginOutputReadLine();\n _process.BeginErrorReadLine();\n _ = _process.WaitForExitAsync().ContinueWith(_ =>\n {\n if (_process?.ExitCode is int exitCode && exitCode != 0)\n {\n tcs.TrySetException(new Exception($\"Proxy exited with code {_process.ExitCode}: {errorOutput}\"));\n }\n });\n\n // Use longer timeout on Windows due to slower process startup\n var timeoutSeconds = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? 30 : 10;\n using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(timeoutSeconds));\n cts.Token.Register(() => tcs.TrySetException(new TimeoutException(\"Timeout waiting for proxy\")));\n\n return await tcs.Task;\n }\n }\n\n public async Task StopAsync(bool skipWritingCache = false)\n {\n if (_startupTask != null)\n {\n try\n {\n var url = await _startupTask;\n var stopUrl = skipWritingCache ? $\"{url}/stop?skipWritingCache=true\" : $\"{url}/stop\";\n using var client = new HttpClient();\n await client.PostAsync(stopUrl, null);\n }\n catch { /* Best effort */ }\n }\n\n if (_process is { HasExited: false })\n {\n try { _process.Kill(); await _process.WaitForExitAsync(); }\n catch { /* Ignore */ }\n }\n\n _process = null;\n _startupTask = null;\n }\n\n public async Task ConfigureAsync(string filePath, string workDir)\n {\n var url = await (_startupTask ?? throw new InvalidOperationException(\"Proxy not started\"));\n\n using var client = new HttpClient();\n var response = await client.PostAsJsonAsync($\"{url}/config\", new ConfigureRequest(filePath, workDir), CapiProxyJsonContext.Default.ConfigureRequest);\n response.EnsureSuccessStatusCode();\n }\n\n private record ConfigureRequest(string FilePath, string WorkDir);\n\n public async Task> GetExchangesAsync()\n {\n var url = await (_startupTask ?? throw new InvalidOperationException(\"Proxy not started\"));\n\n using var client = new HttpClient();\n return await client.GetFromJsonAsync($\"{url}/exchanges\", CapiProxyJsonContext.Default.ListParsedHttpExchange)\n ?? [];\n }\n\n public async Task SetCopilotUserByTokenAsync(string token, CopilotUserConfig response)\n {\n var url = await (_startupTask ?? throw new InvalidOperationException(\"Proxy not started\"));\n\n using var client = new HttpClient();\n var payload = new CopilotUserByTokenRequest(token, response);\n var resp = await client.PostAsJsonAsync($\"{url}/copilot-user-config\", payload, CapiProxyJsonContext.Default.CopilotUserByTokenRequest);\n resp.EnsureSuccessStatusCode();\n }\n\n public async ValueTask DisposeAsync()\n {\n await StopAsync();\n }\n\n private static string FindRepoRoot()\n {\n var dir = new DirectoryInfo(AppContext.BaseDirectory);\n while (dir != null)\n {\n if (File.Exists(Path.Combine(dir.FullName, \"justfile\")))\n return dir.FullName;\n dir = dir.Parent;\n }\n throw new InvalidOperationException(\"Could not find repository root\");\n }\n\n [JsonSourceGenerationOptions(JsonSerializerDefaults.Web)]\n [JsonSerializable(typeof(ConfigureRequest))]\n [JsonSerializable(typeof(List))]\n [JsonSerializable(typeof(CopilotUserByTokenRequest))]\n [JsonSerializable(typeof(Dictionary))]\n private partial class CapiProxyJsonContext : JsonSerializerContext;\n}\n\npublic record CopilotUserByTokenRequest(string Token, CopilotUserConfig Response);\n\npublic record CopilotUserConfig(\n string Login,\n [property: JsonPropertyName(\"copilot_plan\")]\n string CopilotPlan,\n CopilotUserEndpoints Endpoints,\n [property: JsonPropertyName(\"analytics_tracking_id\")]\n string AnalyticsTrackingId,\n [property: JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [property: JsonPropertyName(\"quota_snapshots\")]\n IReadOnlyDictionary? QuotaSnapshots = null);\n\npublic record CopilotUserEndpoints(string Api, string Telemetry);\n\npublic record CopilotUserQuotaSnapshot(\n [property: JsonPropertyName(\"entitlement\")]\n int Entitlement,\n [property: JsonPropertyName(\"overage_count\")]\n int OverageCount,\n [property: JsonPropertyName(\"overage_permitted\")]\n bool OveragePermitted,\n [property: JsonPropertyName(\"percent_remaining\")]\n double PercentRemaining,\n [property: JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [property: JsonPropertyName(\"timestamp_utc\")]\n string? TimestampUtc = null,\n [property: JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]\n [property: JsonPropertyName(\"unlimited\")]\n bool? Unlimited = null);\n\npublic record ParsedHttpExchange(\n ChatCompletionRequest Request,\n ChatCompletionResponse? Response,\n Dictionary? RequestHeaders);\n\npublic record ChatCompletionRequest(\n string Model,\n List Messages,\n List? Tools);\n\npublic record ChatCompletionMessage(\n string Role,\n JsonElement? Content,\n [property: JsonPropertyName(\"tool_call_id\")] string? ToolCallId,\n [property: JsonPropertyName(\"tool_calls\")] List? ToolCalls)\n{\n /// \n /// Returns Content as a string when the JSON value is a string, or null otherwise.\n /// \n [JsonIgnore]\n public string? StringContent => Content is { ValueKind: JsonValueKind.String } c ? c.GetString() : null;\n}\n\npublic record ChatCompletionToolCall(string Id, string Type, ChatCompletionToolCallFunction Function);\n\npublic record ChatCompletionToolCallFunction(string Name, string? Arguments);\n\npublic record ChatCompletionTool(string Type, ChatCompletionToolFunction Function);\n\npublic record ChatCompletionToolFunction(string Name, string? Description);\n\npublic record ChatCompletionResponse(string Id, string Model, List Choices);\n\npublic record ChatCompletionChoice(int Index, ChatCompletionMessage Message, [property: JsonPropertyName(\"finish_reason\")] string FinishReason);\n" }, { "path": "dotnet/test/Harness/E2ETestBase.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.Data;\nusing System.Reflection;\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Microsoft.Extensions.Logging;\nusing Xunit;\nusing Xunit.Abstractions;\n\nnamespace GitHub.Copilot.SDK.Test;\n\npublic abstract class E2ETestBase : IClassFixture, IAsyncLifetime\n{\n private readonly E2ETestFixture _fixture;\n private readonly string _snapshotCategory;\n private readonly string _testName;\n\n protected E2ETestContext Ctx => _fixture.Ctx;\n protected CopilotClient Client => _fixture.Client;\n\n protected E2ETestBase(E2ETestFixture fixture, string snapshotCategory, ITestOutputHelper output)\n {\n _fixture = fixture;\n _snapshotCategory = snapshotCategory;\n _testName = GetTestName(output);\n Logger = new XunitLogger(output);\n\n // Wire logger into the shared context so all clients created via Ctx.CreateClient get it.\n Ctx.Logger = Logger;\n }\n\n /// Logger that forwards warnings and above to xunit test output.\n protected ILogger Logger { get; }\n\n /// Bridges to xunit's .\n private sealed class XunitLogger(ITestOutputHelper output) : ILogger\n {\n public IDisposable? BeginScope(TState state) where TState : notnull => null;\n public bool IsEnabled(LogLevel logLevel) => logLevel >= LogLevel.Warning;\n public void Log(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func formatter)\n {\n if (!IsEnabled(logLevel)) return;\n try { output.WriteLine($\"[{logLevel}] {formatter(state, exception)}\"); }\n catch (InvalidOperationException) { /* test already finished */ }\n }\n }\n\n private static string GetTestName(ITestOutputHelper output)\n {\n // xUnit doesn't provide a public API to get the current test name.\n var type = output.GetType();\n var testField = type.GetField(\"test\", BindingFlags.Instance | BindingFlags.NonPublic);\n var test = (ITest?)testField?.GetValue(output);\n return test?.TestCase.TestMethod.Method.Name ?? throw new InvalidOperationException(\"Couldn't find test name\");\n }\n\n public async Task InitializeAsync()\n {\n await Ctx.ConfigureForTestAsync(_snapshotCategory, _testName);\n }\n\n public Task DisposeAsync()\n {\n return Task.CompletedTask;\n }\n\n /// \n /// Creates a session with a default config that approves all permissions.\n /// Convenience wrapper for E2E tests.\n /// \n protected Task CreateSessionAsync(SessionConfig? config = null)\n {\n config ??= new SessionConfig();\n config.OnPermissionRequest ??= PermissionHandler.ApproveAll;\n return Client.CreateSessionAsync(config);\n }\n\n /// \n /// Resumes a session with a default config that approves all permissions.\n /// Convenience wrapper for E2E tests.\n /// \n protected Task ResumeSessionAsync(string sessionId, ResumeSessionConfig? config = null)\n {\n config ??= new ResumeSessionConfig();\n config.OnPermissionRequest ??= PermissionHandler.ApproveAll;\n return Client.ResumeSessionAsync(sessionId, config);\n }\n\n protected static string GetSystemMessage(ParsedHttpExchange exchange)\n {\n return exchange.Request.Messages.FirstOrDefault(m => m.Role == \"system\")?.StringContent ?? string.Empty;\n }\n\n protected static List GetToolNames(ParsedHttpExchange exchange)\n {\n return exchange.Request.Tools?.Select(t => t.Function.Name).ToList() ?? [];\n }\n}\n" }, { "path": "dotnet/test/Harness/E2ETestContext.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.Runtime.CompilerServices;\nusing System.Text.RegularExpressions;\nusing Microsoft.Extensions.Logging;\n\nnamespace GitHub.Copilot.SDK.Test.Harness;\n\npublic sealed class E2ETestContext : IAsyncDisposable\n{\n public string HomeDir { get; }\n public string WorkDir { get; }\n public string ProxyUrl { get; }\n\n /// Optional logger injected by tests; applied to all clients created via .\n public ILogger? Logger { get; set; }\n\n private readonly CapiProxy _proxy;\n private readonly string _repoRoot;\n\n private E2ETestContext(string homeDir, string workDir, string proxyUrl, CapiProxy proxy, string repoRoot)\n {\n HomeDir = homeDir;\n WorkDir = workDir;\n ProxyUrl = proxyUrl;\n _proxy = proxy;\n _repoRoot = repoRoot;\n }\n\n public static async Task CreateAsync()\n {\n var repoRoot = FindRepoRoot();\n\n var homeDir = Path.Combine(Path.GetTempPath(), $\"copilot-test-config-{Guid.NewGuid()}\");\n var workDir = Path.Combine(Path.GetTempPath(), $\"copilot-test-work-{Guid.NewGuid()}\");\n\n Directory.CreateDirectory(homeDir);\n Directory.CreateDirectory(workDir);\n\n // Resolve symlinks (e.g., macOS /var -> /private/var) so paths\n // match what spawned subprocesses see when they resolve their cwd.\n homeDir = ResolveSymlinks(homeDir);\n workDir = ResolveSymlinks(workDir);\n\n var proxy = new CapiProxy();\n var proxyUrl = await proxy.StartAsync();\n\n return new E2ETestContext(homeDir, workDir, proxyUrl, proxy, repoRoot);\n }\n\n /// \n /// Returns a canonical path with symlinks resolved in every directory\n /// component. .NET has no built-in equivalent of POSIX realpath\n /// that walks all parents, so we walk the components ourselves and use\n /// on each one.\n /// On Windows, where the test temp paths don't traverse symlinks,\n /// is sufficient.\n /// \n private static string ResolveSymlinks(string path)\n {\n if (OperatingSystem.IsWindows())\n {\n return Path.GetFullPath(path);\n }\n\n try\n {\n var fullPath = Path.GetFullPath(path);\n var root = Path.GetPathRoot(fullPath);\n if (string.IsNullOrEmpty(root))\n {\n return fullPath;\n }\n\n var components = fullPath\n .Substring(root.Length)\n .Split(Path.DirectorySeparatorChar, StringSplitOptions.RemoveEmptyEntries);\n\n var resolved = root;\n foreach (var component in components)\n {\n resolved = Path.Join(resolved, component);\n try\n {\n var info = new DirectoryInfo(resolved);\n if (info.Exists && info.LinkTarget != null)\n {\n var target = info.ResolveLinkTarget(returnFinalTarget: true);\n if (target != null && !string.IsNullOrEmpty(target.FullName))\n {\n resolved = target.FullName;\n }\n }\n }\n catch (Exception ex) when (ex is IOException or UnauthorizedAccessException)\n {\n // Component we can't inspect; keep what we have and continue.\n }\n }\n\n return resolved;\n }\n catch (Exception ex) when (ex is IOException\n or UnauthorizedAccessException\n or ArgumentException\n or NotSupportedException\n or PathTooLongException)\n {\n return Path.GetFullPath(path);\n }\n }\n\n private static string FindRepoRoot()\n {\n var dir = new DirectoryInfo(AppContext.BaseDirectory);\n while (dir != null)\n {\n if (Directory.Exists(Path.Combine(dir.FullName, \"nodejs\")))\n return dir.FullName;\n dir = dir.Parent;\n }\n throw new InvalidOperationException(\"Could not find repository root\");\n }\n\n private static string GetCliPath(string repoRoot)\n {\n var envPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\");\n if (!string.IsNullOrEmpty(envPath)) return envPath;\n\n var path = Path.Combine(repoRoot, \"nodejs/node_modules/@github/copilot/index.js\");\n if (!File.Exists(path))\n throw new InvalidOperationException($\"CLI not found at {path}. Run 'npm install' in the nodejs directory first.\");\n\n return path;\n }\n\n public async Task ConfigureForTestAsync(string testFile, [CallerMemberName] string? testName = null)\n {\n // Convert test method names to lowercase snake_case for snapshot filenames\n // to avoid case collisions on case-insensitive filesystems (macOS/Windows)\n var sanitizedName = Regex.Replace(testName!, @\"[^a-zA-Z0-9]\", \"_\").ToLowerInvariant();\n var snapshotPath = Path.Combine(_repoRoot, \"test\", \"snapshots\", testFile, $\"{sanitizedName}.yaml\");\n await _proxy.ConfigureAsync(snapshotPath, WorkDir);\n }\n\n public Task> GetExchangesAsync()\n {\n return _proxy.GetExchangesAsync();\n }\n\n public Task SetCopilotUserByTokenAsync(string token, CopilotUserConfig response)\n {\n return _proxy.SetCopilotUserByTokenAsync(token, response);\n }\n\n public IReadOnlyDictionary GetEnvironment()\n {\n var env = Environment.GetEnvironmentVariables()\n .Cast()\n .ToDictionary(e => (string)e.Key, e => e.Value?.ToString());\n\n env[\"COPILOT_API_URL\"] = ProxyUrl;\n env[\"COPILOT_HOME\"] = HomeDir;\n env[\"XDG_CONFIG_HOME\"] = HomeDir;\n env[\"XDG_STATE_HOME\"] = HomeDir;\n\n return env!;\n }\n\n public CopilotClient CreateClient(bool useStdio = true, CopilotClientOptions? options = null, bool autoInjectGitHubToken = true)\n {\n options ??= new CopilotClientOptions();\n\n options.Cwd ??= WorkDir;\n options.Environment ??= GetEnvironment();\n options.UseStdio = useStdio;\n options.Logger ??= Logger;\n\n if (string.IsNullOrEmpty(options.CliUrl))\n {\n options.CliPath ??= GetCliPath(_repoRoot);\n }\n\n if (autoInjectGitHubToken\n && !string.IsNullOrEmpty(Environment.GetEnvironmentVariable(\"GITHUB_ACTIONS\"))\n && string.IsNullOrEmpty(options.GitHubToken)\n && string.IsNullOrEmpty(options.CliUrl))\n {\n options.GitHubToken = \"fake-token-for-e2e-tests\";\n }\n\n return new(options);\n }\n\n public async ValueTask DisposeAsync()\n {\n // Skip writing snapshots in CI to avoid corrupting them on test failures\n var isCI = !string.IsNullOrEmpty(Environment.GetEnvironmentVariable(\"GITHUB_ACTIONS\"));\n await _proxy.StopAsync(skipWritingCache: isCI);\n\n try { if (Directory.Exists(HomeDir)) Directory.Delete(HomeDir, true); } catch { }\n try { if (Directory.Exists(WorkDir)) Directory.Delete(WorkDir, true); } catch { }\n }\n}\n" }, { "path": "dotnet/test/Harness/E2ETestFixture.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing GitHub.Copilot.SDK.Test.Harness;\nusing Xunit;\n\nnamespace GitHub.Copilot.SDK.Test;\n\npublic class E2ETestFixture : IAsyncLifetime\n{\n public E2ETestContext Ctx { get; private set; } = null!;\n public CopilotClient Client { get; private set; } = null!;\n\n public async Task InitializeAsync()\n {\n Ctx = await E2ETestContext.CreateAsync();\n Client = Ctx.CreateClient();\n }\n\n public async Task DisposeAsync()\n {\n if (Client is not null)\n {\n await Client.ForceStopAsync();\n }\n\n await Ctx.DisposeAsync();\n }\n}\n" }, { "path": "dotnet/test/Harness/TestHelper.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nnamespace GitHub.Copilot.SDK.Test.Harness;\n\npublic static class TestHelper\n{\n // Default tolerates CLI / replay-proxy cold start on Windows GitHub Actions\n // runners, where the first test in a fixture can take ~60s before the first\n // assistant message arrives. Subsequent tests in the same fixture typically\n // complete in well under a second.\n private static readonly TimeSpan DefaultEventTimeout = TimeSpan.FromSeconds(120);\n\n public static async Task GetFinalAssistantMessageAsync(\n CopilotSession session,\n TimeSpan? timeout = null,\n bool alreadyIdle = false)\n {\n var tcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n using var cts = new CancellationTokenSource(timeout ?? DefaultEventTimeout);\n\n // Both `finalAssistantMessage` and `sawIdle` are set from two threads — the\n // subscription callback (CLI read loop) and CheckExistingMessages (RPC reply).\n // We complete only once we've observed both, regardless of which path saw which.\n var stateLock = new object();\n AssistantMessageEvent? finalAssistantMessage = null;\n bool sawIdle = false;\n\n void TryComplete()\n {\n AssistantMessageEvent? snapshot;\n bool idle;\n lock (stateLock)\n {\n snapshot = finalAssistantMessage;\n idle = sawIdle;\n }\n if (snapshot != null && idle) tcs.TrySetResult(snapshot);\n }\n\n using var subscription = session.On(evt =>\n {\n switch (evt)\n {\n case AssistantMessageEvent msg:\n lock (stateLock) { finalAssistantMessage = msg; }\n TryComplete();\n break;\n case SessionIdleEvent:\n lock (stateLock) { sawIdle = true; }\n TryComplete();\n break;\n case SessionErrorEvent error:\n tcs.TrySetException(new Exception(error.Data.Message ?? \"session error\"));\n break;\n }\n });\n\n // Backfill from already-delivered messages so we don't lose events that arrived\n // between SendAsync returning and the subscription being installed.\n CheckExistingMessages();\n\n cts.Token.Register(() => tcs.TrySetException(new TimeoutException(\"Timeout waiting for assistant message\")));\n\n return await tcs.Task;\n\n async void CheckExistingMessages()\n {\n try\n {\n var (existingFinal, existingIdle) = await GetExistingMessagesAsync(session, alreadyIdle);\n lock (stateLock)\n {\n // Preserve a newer message captured by the subscription in the meantime.\n if (existingFinal != null && finalAssistantMessage == null)\n {\n finalAssistantMessage = existingFinal;\n }\n if (existingIdle) sawIdle = true;\n }\n TryComplete();\n }\n catch (Exception ex)\n {\n tcs.TrySetException(ex);\n }\n }\n }\n\n private static async Task<(AssistantMessageEvent? Final, bool SawIdle)> GetExistingMessagesAsync(CopilotSession session, bool alreadyIdle)\n {\n var messages = (await session.GetMessagesAsync()).ToList();\n\n var lastUserIdx = messages.FindLastIndex(m => m is UserMessageEvent);\n var currentTurn = lastUserIdx < 0 ? messages : messages.Skip(lastUserIdx).ToList();\n\n var error = currentTurn.OfType().FirstOrDefault();\n if (error != null) throw new Exception(error.Data.Message ?? \"session error\");\n\n var idleIdx = alreadyIdle ? currentTurn.Count : currentTurn.FindIndex(m => m is SessionIdleEvent);\n var sawIdle = alreadyIdle || idleIdx >= 0;\n\n // Find the most recent assistant message in the turn (whether idle has arrived or not).\n var searchEnd = idleIdx >= 0 ? idleIdx : currentTurn.Count;\n for (var i = searchEnd - 1; i >= 0; i--)\n {\n if (currentTurn[i] is AssistantMessageEvent msg)\n return (msg, sawIdle);\n }\n\n return (null, sawIdle);\n }\n\n public static async Task GetNextEventOfTypeAsync(\n CopilotSession session,\n TimeSpan? timeout = null) where T : SessionEvent\n {\n var tcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);\n using var cts = new CancellationTokenSource(timeout ?? DefaultEventTimeout);\n\n using var subscription = session.On(evt =>\n {\n if (evt is T matched)\n {\n tcs.TrySetResult(matched);\n }\n else if (evt is SessionErrorEvent error)\n {\n tcs.TrySetException(new Exception(error.Data.Message ?? \"session error\"));\n }\n });\n\n cts.Token.Register(() => tcs.TrySetException(\n new TimeoutException($\"Timeout waiting for event of type '{typeof(T).Name}'\")));\n\n return await tcs.Task;\n }\n}\n" }, { "path": "dotnet/test/Unit/CloneTests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing Microsoft.Extensions.AI;\nusing Xunit;\n\nnamespace GitHub.Copilot.SDK.Test.Unit;\n\npublic class CloneTests\n{\n [Fact]\n public void CopilotClientOptions_Clone_CopiesAllProperties()\n {\n var original = new CopilotClientOptions\n {\n CliPath = \"/usr/bin/copilot\",\n CliArgs = [\"--verbose\", \"--debug\"],\n Cwd = \"/home/user\",\n Port = 8080,\n UseStdio = false,\n CliUrl = \"http://localhost:8080\",\n LogLevel = \"debug\",\n AutoStart = false,\n\n Environment = new Dictionary { [\"KEY\"] = \"value\" },\n GitHubToken = \"ghp_test\",\n UseLoggedInUser = false,\n SessionIdleTimeoutSeconds = 600,\n };\n\n var clone = original.Clone();\n\n Assert.Equal(original.CliPath, clone.CliPath);\n Assert.Equal(original.CliArgs, clone.CliArgs);\n Assert.Equal(original.Cwd, clone.Cwd);\n Assert.Equal(original.Port, clone.Port);\n Assert.Equal(original.UseStdio, clone.UseStdio);\n Assert.Equal(original.CliUrl, clone.CliUrl);\n Assert.Equal(original.LogLevel, clone.LogLevel);\n Assert.Equal(original.AutoStart, clone.AutoStart);\n\n Assert.Equal(original.Environment, clone.Environment);\n Assert.Equal(original.GitHubToken, clone.GitHubToken);\n Assert.Equal(original.UseLoggedInUser, clone.UseLoggedInUser);\n Assert.Equal(original.SessionIdleTimeoutSeconds, clone.SessionIdleTimeoutSeconds);\n }\n\n [Fact]\n public void CopilotClientOptions_Clone_CollectionsAreIndependent()\n {\n var original = new CopilotClientOptions\n {\n CliArgs = [\"--verbose\"],\n };\n\n var clone = original.Clone();\n\n // Mutate clone array\n clone.CliArgs![0] = \"--quiet\";\n\n // Original is unaffected\n Assert.Equal(\"--verbose\", original.CliArgs![0]);\n }\n\n [Fact]\n public void CopilotClientOptions_Clone_EnvironmentIsShared()\n {\n var env = new Dictionary { [\"key\"] = \"value\" };\n var original = new CopilotClientOptions { Environment = env };\n\n var clone = original.Clone();\n\n Assert.Same(original.Environment, clone.Environment);\n }\n\n [Fact]\n public void SessionConfig_Clone_CopiesAllProperties()\n {\n var original = new SessionConfig\n {\n SessionId = \"test-session\",\n ClientName = \"my-app\",\n Model = \"gpt-4\",\n ReasoningEffort = \"high\",\n ConfigDir = \"/config\",\n AvailableTools = [\"tool1\", \"tool2\"],\n ExcludedTools = [\"tool3\"],\n WorkingDirectory = \"/workspace\",\n Streaming = true,\n IncludeSubAgentStreamingEvents = false,\n McpServers = new Dictionary { [\"server1\"] = new McpStdioServerConfig { Command = \"echo\" } },\n CustomAgents = [new CustomAgentConfig { Name = \"agent1\" }],\n Agent = \"agent1\",\n DefaultAgent = new DefaultAgentConfig { ExcludedTools = [\"hidden-tool\"] },\n SkillDirectories = [\"/skills\"],\n DisabledSkills = [\"skill1\"],\n };\n\n var clone = original.Clone();\n\n Assert.Equal(original.SessionId, clone.SessionId);\n Assert.Equal(original.ClientName, clone.ClientName);\n Assert.Equal(original.Model, clone.Model);\n Assert.Equal(original.ReasoningEffort, clone.ReasoningEffort);\n Assert.Equal(original.ConfigDir, clone.ConfigDir);\n Assert.Equal(original.AvailableTools, clone.AvailableTools);\n Assert.Equal(original.ExcludedTools, clone.ExcludedTools);\n Assert.Equal(original.WorkingDirectory, clone.WorkingDirectory);\n Assert.Equal(original.Streaming, clone.Streaming);\n Assert.Equal(original.IncludeSubAgentStreamingEvents, clone.IncludeSubAgentStreamingEvents);\n Assert.Equal(original.McpServers.Count, clone.McpServers!.Count);\n Assert.Equal(original.CustomAgents.Count, clone.CustomAgents!.Count);\n Assert.Equal(original.Agent, clone.Agent);\n Assert.Equal(original.DefaultAgent!.ExcludedTools, clone.DefaultAgent!.ExcludedTools);\n Assert.Equal(original.SkillDirectories, clone.SkillDirectories);\n Assert.Equal(original.DisabledSkills, clone.DisabledSkills);\n }\n\n [Fact]\n public void SessionConfig_Clone_CollectionsAreIndependent()\n {\n var original = new SessionConfig\n {\n AvailableTools = [\"tool1\"],\n ExcludedTools = [\"tool2\"],\n McpServers = new Dictionary { [\"s1\"] = new McpStdioServerConfig { Command = \"echo\" } },\n CustomAgents = [new CustomAgentConfig { Name = \"a1\" }],\n SkillDirectories = [\"/skills\"],\n DisabledSkills = [\"skill1\"],\n };\n\n var clone = original.Clone();\n\n // Mutate clone collections\n clone.AvailableTools!.Add(\"tool99\");\n clone.ExcludedTools!.Add(\"tool99\");\n clone.McpServers![\"s2\"] = new McpStdioServerConfig { Command = \"echo\" };\n clone.CustomAgents!.Add(new CustomAgentConfig { Name = \"a2\" });\n clone.SkillDirectories!.Add(\"/more\");\n clone.DisabledSkills!.Add(\"skill99\");\n\n // Original is unaffected\n Assert.Single(original.AvailableTools!);\n Assert.Single(original.ExcludedTools!);\n Assert.Single(original.McpServers!);\n Assert.Single(original.CustomAgents!);\n Assert.Single(original.SkillDirectories!);\n Assert.Single(original.DisabledSkills!);\n }\n\n [Fact]\n public void SessionConfig_Clone_PreservesMcpServersComparer()\n {\n var servers = new Dictionary(StringComparer.OrdinalIgnoreCase) { [\"server\"] = new McpStdioServerConfig { Command = \"echo\" } };\n var original = new SessionConfig { McpServers = servers };\n\n var clone = original.Clone();\n\n Assert.True(clone.McpServers!.ContainsKey(\"SERVER\")); // case-insensitive lookup works\n }\n\n [Fact]\n public void ResumeSessionConfig_Clone_CollectionsAreIndependent()\n {\n var original = new ResumeSessionConfig\n {\n AvailableTools = [\"tool1\"],\n ExcludedTools = [\"tool2\"],\n McpServers = new Dictionary { [\"s1\"] = new McpStdioServerConfig { Command = \"echo\" } },\n CustomAgents = [new CustomAgentConfig { Name = \"a1\" }],\n SkillDirectories = [\"/skills\"],\n DisabledSkills = [\"skill1\"],\n };\n\n var clone = original.Clone();\n\n // Mutate clone collections\n clone.AvailableTools!.Add(\"tool99\");\n clone.ExcludedTools!.Add(\"tool99\");\n clone.McpServers![\"s2\"] = new McpStdioServerConfig { Command = \"echo\" };\n clone.CustomAgents!.Add(new CustomAgentConfig { Name = \"a2\" });\n clone.SkillDirectories!.Add(\"/more\");\n clone.DisabledSkills!.Add(\"skill99\");\n\n // Original is unaffected\n Assert.Single(original.AvailableTools!);\n Assert.Single(original.ExcludedTools!);\n Assert.Single(original.McpServers!);\n Assert.Single(original.CustomAgents!);\n Assert.Single(original.SkillDirectories!);\n Assert.Single(original.DisabledSkills!);\n }\n\n [Fact]\n public void ResumeSessionConfig_Clone_PreservesMcpServersComparer()\n {\n var servers = new Dictionary(StringComparer.OrdinalIgnoreCase) { [\"server\"] = new McpStdioServerConfig { Command = \"echo\" } };\n var original = new ResumeSessionConfig { McpServers = servers };\n\n var clone = original.Clone();\n\n Assert.True(clone.McpServers!.ContainsKey(\"SERVER\"));\n }\n\n [Fact]\n public void MessageOptions_Clone_CopiesAllProperties()\n {\n var original = new MessageOptions\n {\n Prompt = \"Hello\",\n Attachments = [new UserMessageAttachmentFile { Path = \"/test.txt\", DisplayName = \"test.txt\" }],\n Mode = \"chat\",\n };\n\n var clone = original.Clone();\n\n Assert.Equal(original.Prompt, clone.Prompt);\n Assert.Equal(original.Mode, clone.Mode);\n Assert.Single(clone.Attachments!);\n }\n\n [Fact]\n public void MessageOptions_Clone_AttachmentsAreIndependent()\n {\n var original = new MessageOptions\n {\n Attachments = [new UserMessageAttachmentFile { Path = \"/test.txt\", DisplayName = \"test.txt\" }],\n };\n\n var clone = original.Clone();\n\n clone.Attachments!.Add(new UserMessageAttachmentFile { Path = \"/other.txt\", DisplayName = \"other.txt\" });\n\n Assert.Single(original.Attachments!);\n }\n\n [Fact]\n public void Clone_WithNullCollections_ReturnsNullCollections()\n {\n var original = new SessionConfig();\n\n var clone = original.Clone();\n\n Assert.Null(clone.AvailableTools);\n Assert.Null(clone.ExcludedTools);\n Assert.Null(clone.McpServers);\n Assert.Null(clone.CustomAgents);\n Assert.Null(clone.SkillDirectories);\n Assert.Null(clone.DisabledSkills);\n Assert.Null(clone.Tools);\n Assert.Null(clone.DefaultAgent);\n Assert.True(clone.IncludeSubAgentStreamingEvents);\n }\n\n [Fact]\n public void SessionConfig_Clone_CopiesAgentProperty()\n {\n var original = new SessionConfig\n {\n Agent = \"test-agent\",\n CustomAgents = [new CustomAgentConfig { Name = \"test-agent\", Prompt = \"You are a test agent.\" }],\n };\n\n var clone = original.Clone();\n\n Assert.Equal(\"test-agent\", clone.Agent);\n }\n\n [Fact]\n public void ResumeSessionConfig_Clone_CopiesAgentProperty()\n {\n var original = new ResumeSessionConfig\n {\n Agent = \"test-agent\",\n CustomAgents = [new CustomAgentConfig { Name = \"test-agent\", Prompt = \"You are a test agent.\" }],\n };\n\n var clone = original.Clone();\n\n Assert.Equal(\"test-agent\", clone.Agent);\n }\n\n [Fact]\n public void ResumeSessionConfig_Clone_CopiesIncludeSubAgentStreamingEvents()\n {\n var original = new ResumeSessionConfig\n {\n IncludeSubAgentStreamingEvents = false,\n };\n\n var clone = original.Clone();\n\n Assert.False(clone.IncludeSubAgentStreamingEvents);\n }\n\n [Fact]\n public void ResumeSessionConfig_Clone_PreservesIncludeSubAgentStreamingEventsDefault()\n {\n var original = new ResumeSessionConfig();\n\n var clone = original.Clone();\n\n Assert.True(clone.IncludeSubAgentStreamingEvents);\n }\n\n [Fact]\n public void ResumeSessionConfig_Clone_CopiesContinuePendingWork()\n {\n var original = new ResumeSessionConfig\n {\n ContinuePendingWork = true,\n };\n\n var clone = original.Clone();\n\n Assert.True(clone.ContinuePendingWork);\n }\n\n [Fact]\n public void ResumeSessionConfig_Clone_PreservesContinuePendingWorkDefault()\n {\n var original = new ResumeSessionConfig();\n\n var clone = original.Clone();\n\n Assert.Null(clone.ContinuePendingWork);\n }\n}\n" }, { "path": "dotnet/test/Unit/ForwardCompatibilityTests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing Xunit;\n\nnamespace GitHub.Copilot.SDK.Test.Unit;\n\n/// \n/// Tests for forward-compatible handling of unknown session event types.\n/// Verifies that the SDK gracefully handles event types introduced by newer CLI versions.\n/// \npublic class ForwardCompatibilityTests\n{\n [Fact]\n public void FromJson_KnownEventType_DeserializesNormally()\n {\n var json = \"\"\"\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"timestamp\": \"2026-01-01T00:00:00Z\",\n \"parentId\": null,\n \"agentId\": \"agent-1\",\n \"type\": \"user.message\",\n \"data\": {\n \"content\": \"Hello\"\n }\n }\n \"\"\";\n\n var result = SessionEvent.FromJson(json);\n\n Assert.IsType(result);\n Assert.Equal(\"user.message\", result.Type);\n Assert.Equal(\"agent-1\", result.AgentId);\n }\n\n [Fact]\n public void FromJson_UnknownEventType_ReturnsBaseSessionEvent()\n {\n var json = \"\"\"\n {\n \"id\": \"12345678-1234-1234-1234-123456789abc\",\n \"timestamp\": \"2026-06-15T10:30:00Z\",\n \"parentId\": \"abcdefab-abcd-abcd-abcd-abcdefabcdef\",\n \"agentId\": \"future-agent\",\n \"type\": \"future.feature_from_server\",\n \"data\": { \"key\": \"value\" }\n }\n \"\"\";\n\n var result = SessionEvent.FromJson(json);\n\n Assert.IsType(result);\n Assert.Equal(\"unknown\", result.Type);\n Assert.Equal(\"future-agent\", result.AgentId);\n }\n\n [Fact]\n public void FromJson_UnknownEventType_PreservesBaseMetadata()\n {\n var json = \"\"\"\n {\n \"id\": \"12345678-1234-1234-1234-123456789abc\",\n \"timestamp\": \"2026-06-15T10:30:00Z\",\n \"parentId\": \"abcdefab-abcd-abcd-abcd-abcdefabcdef\",\n \"type\": \"future.feature_from_server\",\n \"data\": {}\n }\n \"\"\";\n\n var result = SessionEvent.FromJson(json);\n\n Assert.Equal(Guid.Parse(\"12345678-1234-1234-1234-123456789abc\"), result.Id);\n Assert.Equal(DateTimeOffset.Parse(\"2026-06-15T10:30:00Z\"), result.Timestamp);\n Assert.Equal(Guid.Parse(\"abcdefab-abcd-abcd-abcd-abcdefabcdef\"), result.ParentId);\n }\n\n [Fact]\n public void FromJson_MultipleEvents_MixedKnownAndUnknown()\n {\n var events = new[]\n {\n \"\"\"{\"id\":\"00000000-0000-0000-0000-000000000001\",\"timestamp\":\"2026-01-01T00:00:00Z\",\"parentId\":null,\"type\":\"user.message\",\"data\":{\"content\":\"Hi\"}}\"\"\",\n \"\"\"{\"id\":\"00000000-0000-0000-0000-000000000002\",\"timestamp\":\"2026-01-01T00:00:00Z\",\"parentId\":null,\"type\":\"future.unknown_type\",\"data\":{}}\"\"\",\n \"\"\"{\"id\":\"00000000-0000-0000-0000-000000000003\",\"timestamp\":\"2026-01-01T00:00:00Z\",\"parentId\":null,\"type\":\"user.message\",\"data\":{\"content\":\"Bye\"}}\"\"\",\n };\n\n var results = events.Select(SessionEvent.FromJson).ToList();\n\n Assert.Equal(3, results.Count);\n Assert.IsType(results[0]);\n Assert.IsType(results[1]);\n Assert.IsType(results[2]);\n }\n\n [Fact]\n public void FromJson_KnownEventType_WithExtraUnknownFields_IgnoresExtras()\n {\n // Forward-compat: when the runtime adds new fields to a known event,\n // older SDK versions must ignore them and still successfully parse the event.\n var json = \"\"\"\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"timestamp\": \"2026-01-01T00:00:00Z\",\n \"parentId\": null,\n \"agentId\": \"agent-1\",\n \"type\": \"user.message\",\n \"futureEnvelopeField\": {\"someShape\": [1,2,3]},\n \"data\": {\n \"content\": \"Hello\",\n \"futureDataField\": \"ignored\",\n \"anotherFutureField\": {\"nested\": true}\n }\n }\n \"\"\";\n\n var result = SessionEvent.FromJson(json);\n\n var msg = Assert.IsType(result);\n Assert.Equal(\"Hello\", msg.Data.Content);\n }\n\n [Fact]\n public void FromJson_KnownEventType_WithExtraUnknownEnvelopeFields_IgnoresExtras()\n {\n // Pure envelope-level extra field (no inner data extras).\n var json = \"\"\"\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"timestamp\": \"2026-01-01T00:00:00Z\",\n \"parentId\": null,\n \"agentId\": \"agent-1\",\n \"type\": \"session.idle\",\n \"newServerOnlyField\": 42,\n \"data\": {}\n }\n \"\"\";\n\n var result = SessionEvent.FromJson(json);\n\n Assert.IsType(result);\n Assert.Equal(\"agent-1\", result.AgentId);\n }\n\n [Fact]\n public void FromJson_UnknownEventType_WithUnknownEnumInData_DoesNotThrow()\n {\n // Unknown event types are mapped to base SessionEvent which does not parse data.\n // So unknown enum values inside the data of an unknown event must not throw.\n var json = \"\"\"\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"timestamp\": \"2026-01-01T00:00:00Z\",\n \"parentId\": null,\n \"type\": \"future.event_with_enum\",\n \"data\": {\n \"futureMode\": \"future_value_not_in_sdk_enum\"\n }\n }\n \"\"\";\n\n var result = SessionEvent.FromJson(json);\n\n Assert.IsType(result);\n Assert.Equal(\"unknown\", result.Type);\n }\n\n [Fact]\n public void FromJson_KnownEventType_WithNullOptionalFields_DoesNotThrow()\n {\n // The CLI may emit null for optional fields. Verify parsing doesn't throw.\n var json = \"\"\"\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"timestamp\": \"2026-01-01T00:00:00Z\",\n \"parentId\": null,\n \"agentId\": null,\n \"type\": \"user.message\",\n \"data\": {\n \"content\": \"Hello\"\n }\n }\n \"\"\";\n\n var result = SessionEvent.FromJson(json);\n\n var msg = Assert.IsType(result);\n Assert.Null(msg.AgentId);\n Assert.Null(msg.ParentId);\n Assert.Equal(\"Hello\", msg.Data.Content);\n }\n\n [Fact]\n public void FromJson_UnknownEventType_PreservesAgentIdNull()\n {\n // Some events legitimately have no agent id. Verify it round-trips as null.\n var json = \"\"\"\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"timestamp\": \"2026-01-01T00:00:00Z\",\n \"parentId\": null,\n \"type\": \"future.something\",\n \"data\": {}\n }\n \"\"\";\n\n var result = SessionEvent.FromJson(json);\n\n Assert.Equal(\"unknown\", result.Type);\n Assert.Null(result.AgentId);\n }\n}\n" }, { "path": "dotnet/test/Unit/JsonRpcTests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.Reflection;\nusing System.Text.Json;\nusing System.Text.Json.Serialization.Metadata;\nusing GitHub.Copilot.SDK.Rpc;\nusing Xunit;\n\nnamespace GitHub.Copilot.SDK.Test.Unit;\n\n/// \n/// Behavior tests for the SDK's hand-rolled JSON-RPC transport (params shape, serializer\n/// metadata, request/response routing, error propagation). Reflection is used to force\n/// every generated JsonSerializable registration on the ,\n/// which guards against regressions in the C# code generator (scripts/codegen/csharp.ts)\n/// silently dropping a registration. Functional behavior of individual RPC methods lives\n/// in the Rpc*Tests classes; this file owns transport- and serializer-shape concerns.\n/// \npublic class JsonRpcTests\n{\n [Fact]\n public async Task JsonRpc_Handles_Positional_Named_And_Single_Object_Params()\n {\n using var pair = JsonRpcReflectionPair.Create();\n\n pair.Server.SetLocalRpcMethod(\n \"positional\",\n (Func>)HandleNameAndCount);\n pair.Server.SetLocalRpcMethod(\n \"named\",\n (Func>)HandleNameAndCount);\n pair.Server.SetLocalRpcMethod(\n \"single\",\n (Func>)HandleSingleObject,\n singleObjectParam: true);\n\n pair.StartListening();\n\n Assert.Equal(\"Mona:2\", await pair.Client.InvokeAsync(\"positional\", [\"Mona\", 2]));\n Assert.Equal(\"Octo:3\", await pair.Client.InvokeAsync(\"named\", [new NamedParams { Name = \"Octo\", Count = 3 }]));\n\n var response = await pair.Client.InvokeAsync(\n \"single\",\n [new SingleObjectRequest { Value = \"value\" }]);\n Assert.Equal(\"VALUE\", response.Value);\n\n static ValueTask HandleNameAndCount(string name, int count, CancellationToken cancellationToken) =>\n ValueTask.FromResult($\"{name}:{count}\");\n\n static ValueTask HandleSingleObject(SingleObjectRequest request, CancellationToken cancellationToken) =>\n ValueTask.FromResult(new SingleObjectResponse { Value = request.Value.ToUpperInvariant() });\n }\n\n [Fact]\n public async Task JsonRpc_Returns_Errors_For_Missing_Method_And_Invalid_Params()\n {\n using var pair = JsonRpcReflectionPair.Create();\n\n pair.Server.SetLocalRpcMethod(\n \"single\",\n (Func>)HandleSingleObject,\n singleObjectParam: true);\n\n pair.StartListening();\n\n var missing = await Assert.ThrowsAnyAsync(() =>\n pair.Client.InvokeAsync(\"missing\", args: null));\n Assert.Contains(\"Method not found: missing\", missing.Message, StringComparison.Ordinal);\n Assert.Equal(-32601, GetRemoteErrorCode(missing));\n\n var invalidParams = await Assert.ThrowsAnyAsync(() =>\n pair.Client.InvokeAsync(\"single\", [\"not\", \"an\", \"object\"]));\n Assert.Contains(\"Expected JSON object\", invalidParams.Message, StringComparison.Ordinal);\n Assert.Equal(-32603, GetRemoteErrorCode(invalidParams));\n\n static ValueTask HandleSingleObject(SingleObjectRequest request, CancellationToken cancellationToken) =>\n ValueTask.FromResult(new SingleObjectResponse { Value = request.Value });\n }\n\n [Fact]\n public async Task JsonRpc_Cancels_And_Disposes_Pending_Requests()\n {\n using var pair = JsonRpcReflectionPair.Create(startServer: false);\n\n using var cts = new CancellationTokenSource();\n var canceled = pair.Client.InvokeAsync(\"never\", args: null, cts.Token);\n cts.Cancel();\n await Assert.ThrowsAnyAsync(() => canceled);\n\n var pending = pair.Client.InvokeAsync(\"stillPending\", args: null);\n pair.Client.Dispose();\n await Assert.ThrowsAnyAsync(() => pending);\n }\n\n private static int GetRemoteErrorCode(Exception exception)\n {\n var property = exception.GetType().GetProperty(\"ErrorCode\", BindingFlags.Instance | BindingFlags.Public);\n Assert.NotNull(property);\n return (int)property.GetValue(exception)!;\n }\n\n private sealed class NamedParams\n {\n public string Name { get; set; } = string.Empty;\n\n public int Count { get; set; }\n }\n\n private sealed class SingleObjectRequest\n {\n public string Value { get; set; } = string.Empty;\n }\n\n private sealed class SingleObjectResponse\n {\n public string Value { get; set; } = string.Empty;\n }\n\n private sealed class JsonRpcReflectionPair : IDisposable\n {\n private readonly InMemoryDuplexStream _clientStream;\n private readonly InMemoryDuplexStream _serverStream;\n\n private JsonRpcReflectionPair(InMemoryDuplexStream clientStream, InMemoryDuplexStream serverStream)\n {\n _clientStream = clientStream;\n _serverStream = serverStream;\n Client = new JsonRpcReflection(clientStream);\n Server = new JsonRpcReflection(serverStream);\n }\n\n public JsonRpcReflection Client { get; }\n\n public JsonRpcReflection Server { get; }\n\n public static JsonRpcReflectionPair Create(bool startServer = true)\n {\n var (clientStream, serverStream) = InMemoryDuplexStream.CreatePair();\n var pair = new JsonRpcReflectionPair(clientStream, serverStream);\n if (startServer)\n {\n pair.Server.StartListening();\n }\n\n return pair;\n }\n\n public void StartListening() => Client.StartListening();\n\n public void Dispose()\n {\n Client.Dispose();\n Server.Dispose();\n _clientStream.Dispose();\n _serverStream.Dispose();\n }\n }\n\n private sealed class JsonRpcReflection : IDisposable\n {\n private static readonly Type JsonRpcType =\n typeof(CopilotClient).Assembly.GetType(\"GitHub.Copilot.SDK.JsonRpc\", throwOnError: true)!;\n\n private static readonly JsonSerializerOptions SerializerOptions = new(JsonSerializerDefaults.Web)\n {\n TypeInfoResolver = new DefaultJsonTypeInfoResolver(),\n };\n\n private readonly object _instance;\n\n public JsonRpcReflection(Stream stream)\n {\n _instance = Activator.CreateInstance(\n JsonRpcType,\n BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic,\n binder: null,\n args: [stream, stream, SerializerOptions, null],\n culture: null)!;\n }\n\n public void StartListening() => JsonRpcType.GetMethod(nameof(StartListening))!.Invoke(_instance, null);\n\n public void SetLocalRpcMethod(string methodName, Delegate handler, bool singleObjectParam = false) =>\n JsonRpcType.GetMethod(\"SetLocalRpcMethod\")!.Invoke(_instance, [methodName, handler, singleObjectParam]);\n\n public async Task InvokeAsync(string methodName, object?[]? args, CancellationToken cancellationToken = default)\n {\n var method = JsonRpcType\n .GetMethod(\"InvokeAsync\")!\n .MakeGenericMethod(typeof(T));\n\n var task = (Task)method.Invoke(_instance, [methodName, args, cancellationToken])!;\n return await task.ConfigureAwait(false);\n }\n\n public void Dispose() => ((IDisposable)_instance).Dispose();\n }\n\n private sealed class InMemoryDuplexStream : Stream\n {\n private readonly Queue _buffer = new();\n private readonly SemaphoreSlim _dataAvailable = new(0);\n private readonly object _gate = new();\n private InMemoryDuplexStream? _peer;\n private bool _completed;\n\n public override bool CanRead => true;\n\n public override bool CanSeek => false;\n\n public override bool CanWrite => true;\n\n public override long Length => throw new NotSupportedException();\n\n public override long Position { get => throw new NotSupportedException(); set => throw new NotSupportedException(); }\n\n public static (InMemoryDuplexStream Client, InMemoryDuplexStream Server) CreatePair()\n {\n var client = new InMemoryDuplexStream();\n var server = new InMemoryDuplexStream();\n client._peer = server;\n server._peer = client;\n return (client, server);\n }\n\n public override void Flush()\n {\n }\n\n public override Task FlushAsync(CancellationToken cancellationToken) => Task.CompletedTask;\n\n public override int Read(byte[] buffer, int offset, int count) =>\n ReadAsync(buffer.AsMemory(offset, count)).AsTask().GetAwaiter().GetResult();\n\n public override async ValueTask ReadAsync(Memory destination, CancellationToken cancellationToken = default)\n {\n while (true)\n {\n lock (_gate)\n {\n if (_buffer.Count > 0)\n {\n var count = Math.Min(destination.Length, _buffer.Count);\n for (var i = 0; i < count; i++)\n {\n destination.Span[i] = _buffer.Dequeue();\n }\n\n return count;\n }\n\n if (_completed)\n {\n return 0;\n }\n }\n\n await _dataAvailable.WaitAsync(cancellationToken).ConfigureAwait(false);\n }\n }\n\n public override void Write(byte[] buffer, int offset, int count) =>\n WriteAsync(buffer.AsMemory(offset, count)).AsTask().GetAwaiter().GetResult();\n\n public override ValueTask WriteAsync(ReadOnlyMemory source, CancellationToken cancellationToken = default)\n {\n var peer = _peer ?? throw new ObjectDisposedException(nameof(InMemoryDuplexStream));\n peer.Enqueue(source.Span);\n return ValueTask.CompletedTask;\n }\n\n public override long Seek(long offset, SeekOrigin origin) => throw new NotSupportedException();\n\n public override void SetLength(long value) => throw new NotSupportedException();\n\n protected override void Dispose(bool disposing)\n {\n if (disposing)\n {\n lock (_gate)\n {\n _completed = true;\n }\n\n _dataAvailable.Release();\n }\n\n base.Dispose(disposing);\n }\n\n private void Enqueue(ReadOnlySpan source)\n {\n lock (_gate)\n {\n foreach (var value in source)\n {\n _buffer.Enqueue(value);\n }\n }\n\n _dataAvailable.Release();\n }\n }\n}\n" }, { "path": "dotnet/test/Unit/PermissionRequestResultKindTests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.Text.Json;\nusing Xunit;\n\nnamespace GitHub.Copilot.SDK.Test.Unit;\n\npublic class PermissionRequestResultKindTests\n{\n private static readonly JsonSerializerOptions s_jsonOptions = new(JsonSerializerDefaults.Web)\n {\n TypeInfoResolver = TestJsonContext.Default,\n };\n\n [Fact]\n public void WellKnownKinds_HaveExpectedValues()\n {\n Assert.Equal(\"approve-once\", PermissionRequestResultKind.Approved.Value);\n Assert.Equal(\"reject\", PermissionRequestResultKind.Rejected.Value);\n Assert.Equal(\"user-not-available\", PermissionRequestResultKind.UserNotAvailable.Value);\n Assert.Equal(\"no-result\", PermissionRequestResultKind.NoResult.Value);\n\n // Deprecated aliases still resolve\n#pragma warning disable CS0618\n Assert.Equal(PermissionRequestResultKind.Rejected, PermissionRequestResultKind.DeniedInteractivelyByUser);\n Assert.Equal(PermissionRequestResultKind.UserNotAvailable, PermissionRequestResultKind.DeniedCouldNotRequestFromUser);\n Assert.Equal(PermissionRequestResultKind.UserNotAvailable, PermissionRequestResultKind.DeniedByRules);\n#pragma warning restore CS0618\n }\n\n [Fact]\n public void Equals_SameValue_ReturnsTrue()\n {\n var a = new PermissionRequestResultKind(\"approve-once\");\n Assert.True(a == PermissionRequestResultKind.Approved);\n Assert.True(a.Equals(PermissionRequestResultKind.Approved));\n Assert.True(a.Equals((object)PermissionRequestResultKind.Approved));\n }\n\n [Fact]\n public void Equals_DifferentValue_ReturnsFalse()\n {\n Assert.True(PermissionRequestResultKind.Approved != PermissionRequestResultKind.Rejected);\n Assert.False(PermissionRequestResultKind.Approved.Equals(PermissionRequestResultKind.Rejected));\n }\n\n [Fact]\n public void Equals_IsCaseInsensitive()\n {\n var upper = new PermissionRequestResultKind(\"APPROVE-ONCE\");\n Assert.Equal(PermissionRequestResultKind.Approved, upper);\n }\n\n [Fact]\n public void GetHashCode_IsCaseInsensitive()\n {\n var upper = new PermissionRequestResultKind(\"APPROVE-ONCE\");\n Assert.Equal(PermissionRequestResultKind.Approved.GetHashCode(), upper.GetHashCode());\n }\n\n [Fact]\n public void ToString_ReturnsValue()\n {\n Assert.Equal(\"approve-once\", PermissionRequestResultKind.Approved.ToString());\n Assert.Equal(\"reject\", PermissionRequestResultKind.Rejected.ToString());\n }\n\n [Fact]\n public void CustomValue_IsPreserved()\n {\n var custom = new PermissionRequestResultKind(\"custom-kind\");\n Assert.Equal(\"custom-kind\", custom.Value);\n Assert.Equal(\"custom-kind\", custom.ToString());\n }\n\n [Fact]\n public void Constructor_NullValue_TreatedAsEmpty()\n {\n var kind = new PermissionRequestResultKind(null!);\n Assert.Equal(string.Empty, kind.Value);\n }\n\n [Fact]\n public void Default_HasEmptyStringValue()\n {\n var defaultKind = default(PermissionRequestResultKind);\n Assert.Equal(string.Empty, defaultKind.Value);\n Assert.Equal(string.Empty, defaultKind.ToString());\n Assert.Equal(defaultKind.GetHashCode(), defaultKind.GetHashCode());\n }\n\n [Fact]\n public void Equals_NonPermissionRequestResultKindObject_ReturnsFalse()\n {\n Assert.False(PermissionRequestResultKind.Approved.Equals(\"approve-once\"));\n }\n\n [Fact]\n public void JsonSerialize_WritesStringValue()\n {\n var result = new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved };\n var json = JsonSerializer.Serialize(result, s_jsonOptions);\n Assert.Contains(\"\\\"kind\\\":\\\"approve-once\\\"\", json);\n }\n\n [Fact]\n public void JsonDeserialize_ReadsStringValue()\n {\n var json = \"\"\"{\"kind\":\"reject\"}\"\"\";\n var result = JsonSerializer.Deserialize(json, s_jsonOptions)!;\n Assert.Equal(PermissionRequestResultKind.Rejected, result.Kind);\n }\n\n [Fact]\n public void JsonRoundTrip_PreservesAllKinds()\n {\n var kinds = new[]\n {\n PermissionRequestResultKind.Approved,\n PermissionRequestResultKind.Rejected,\n PermissionRequestResultKind.UserNotAvailable,\n PermissionRequestResultKind.NoResult,\n };\n\n foreach (var kind in kinds)\n {\n var result = new PermissionRequestResult { Kind = kind };\n var json = JsonSerializer.Serialize(result, s_jsonOptions);\n var deserialized = JsonSerializer.Deserialize(json, s_jsonOptions)!;\n Assert.Equal(kind, deserialized.Kind);\n }\n }\n\n [Fact]\n public void JsonRoundTrip_CustomValue()\n {\n var result = new PermissionRequestResult { Kind = new PermissionRequestResultKind(\"custom\") };\n var json = JsonSerializer.Serialize(result, s_jsonOptions);\n var deserialized = JsonSerializer.Deserialize(json, s_jsonOptions)!;\n Assert.Equal(\"custom\", deserialized.Kind.Value);\n }\n}\n\n[System.Text.Json.Serialization.JsonSerializable(typeof(PermissionRequestResult))]\ninternal partial class TestJsonContext : System.Text.Json.Serialization.JsonSerializerContext;\n" }, { "path": "dotnet/test/Unit/PublicDtoTests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.Collections;\nusing System.Reflection;\nusing System.Text.Json;\nusing Xunit;\n\nnamespace GitHub.Copilot.SDK.Test.Unit;\n\n/// \n/// Reflection-based safety net that exercises the get/set surface of every public DTO in\n/// the SDK assembly. The intent is to (1) keep System.Text.Json source-generation\n/// configurations from drifting (NativeAOT-friendly serializer must know every public DTO),\n/// and (2) catch accidental property-shape regressions (read-only setters, mismatched\n/// nullability, generated bridge types). It is **not** a serialization-correctness test;\n/// for that, write targeted serializer tests against fixed JSON payloads (see\n/// SessionEventSerializationTests for the pattern).\n/// \npublic class PublicDtoTests\n{\n [Fact]\n public void Public_Dto_Properties_Can_Be_Set_And_Read()\n {\n var exercisedProperties = 0;\n var assembly = typeof(CopilotClient).Assembly;\n var candidateTypes = assembly\n .GetTypes()\n .Where(type =>\n type is { IsClass: true, IsAbstract: false, IsPublic: true } &&\n type.Namespace?.StartsWith(\"GitHub.Copilot.SDK\", StringComparison.Ordinal) == true &&\n type.GetConstructor(Type.EmptyTypes) is not null)\n .OrderBy(type => type.FullName, StringComparer.Ordinal);\n\n foreach (var type in candidateTypes)\n {\n var instance = Activator.CreateInstance(type)!;\n\n foreach (var property in type.GetProperties(BindingFlags.Instance | BindingFlags.Public))\n {\n if (property.GetIndexParameters().Length != 0)\n {\n continue;\n }\n\n if (property.SetMethod?.IsPublic == true &&\n TryCreateSampleValue(property.PropertyType, [], out var sampleValue))\n {\n property.SetValue(instance, sampleValue);\n }\n\n if (property.GetMethod?.IsPublic == true)\n {\n _ = property.GetValue(instance);\n exercisedProperties++;\n }\n }\n }\n\n Assert.True(exercisedProperties > 1_000, $\"Expected to exercise many DTO properties, but only exercised {exercisedProperties}.\");\n }\n\n private static bool TryCreateSampleValue(Type type, HashSet visited, out object? value)\n {\n var nullableType = Nullable.GetUnderlyingType(type);\n if (nullableType is not null)\n {\n return TryCreateSampleValue(nullableType, visited, out value);\n }\n\n if (type == typeof(string))\n {\n value = \"value\";\n return true;\n }\n\n if (type == typeof(bool))\n {\n value = true;\n return true;\n }\n\n if (type == typeof(int))\n {\n value = 1;\n return true;\n }\n\n if (type == typeof(long))\n {\n value = 1L;\n return true;\n }\n\n if (type == typeof(double))\n {\n value = 1.0;\n return true;\n }\n\n if (type == typeof(DateTimeOffset))\n {\n value = DateTimeOffset.UnixEpoch;\n return true;\n }\n\n if (type == typeof(DateTime))\n {\n value = DateTime.UnixEpoch;\n return true;\n }\n\n if (type == typeof(TimeSpan))\n {\n value = TimeSpan.FromMilliseconds(1);\n return true;\n }\n\n if (type == typeof(JsonElement))\n {\n using var document = JsonDocument.Parse(\"\"\"{\"value\":1}\"\"\");\n value = document.RootElement.Clone();\n return true;\n }\n\n if (type == typeof(object))\n {\n value = \"value\";\n return true;\n }\n\n if (type.IsEnum)\n {\n var values = Enum.GetValues(type);\n value = values.Length > 0 ? values.GetValue(0) : Activator.CreateInstance(type);\n return true;\n }\n\n if (type.IsArray)\n {\n var elementType = type.GetElementType()!;\n if (!TryCreateSampleValue(elementType, visited, out var elementValue))\n {\n elementValue = elementType.IsValueType ? Activator.CreateInstance(elementType) : null;\n }\n\n var array = Array.CreateInstance(elementType, 1);\n array.SetValue(elementValue, 0);\n value = array;\n return true;\n }\n\n if (TryCreateGenericCollection(type, visited, out value))\n {\n return true;\n }\n\n if (!type.IsValueType && type.GetConstructor(Type.EmptyTypes) is not null && visited.Add(type))\n {\n value = Activator.CreateInstance(type);\n visited.Remove(type);\n return true;\n }\n\n value = type.IsValueType ? Activator.CreateInstance(type) : null;\n return true;\n }\n\n private static bool TryCreateGenericCollection(Type type, HashSet visited, out object? value)\n {\n var dictionaryInterface = type.GetInterfaces()\n .Append(type)\n .FirstOrDefault(candidate =>\n candidate.IsGenericType &&\n (candidate.GetGenericTypeDefinition() == typeof(IDictionary<,>) ||\n candidate.GetGenericTypeDefinition() == typeof(IReadOnlyDictionary<,>)) &&\n candidate.GetGenericArguments()[0] == typeof(string));\n\n if (dictionaryInterface is not null)\n {\n var valueType = dictionaryInterface.GetGenericArguments()[1];\n TryCreateSampleValue(valueType, visited, out var sampleValue);\n var dictionary = (IDictionary)Activator.CreateInstance(typeof(Dictionary<,>).MakeGenericType(typeof(string), valueType))!;\n dictionary[\"key\"] = sampleValue;\n value = dictionary;\n return true;\n }\n\n var enumerableInterface = type.GetInterfaces()\n .Append(type)\n .FirstOrDefault(candidate =>\n candidate.IsGenericType &&\n (candidate.GetGenericTypeDefinition() == typeof(IList<>) ||\n candidate.GetGenericTypeDefinition() == typeof(IReadOnlyList<>) ||\n candidate.GetGenericTypeDefinition() == typeof(IEnumerable<>)));\n\n if (enumerableInterface is not null)\n {\n var elementType = enumerableInterface.GetGenericArguments()[0];\n TryCreateSampleValue(elementType, visited, out var sampleValue);\n var list = (IList)Activator.CreateInstance(typeof(List<>).MakeGenericType(elementType))!;\n list.Add(sampleValue);\n value = list;\n return true;\n }\n\n value = null;\n return false;\n }\n}\n" }, { "path": "dotnet/test/Unit/SerializationTests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing Xunit;\nusing System.Text.Json;\nusing System.Text.Json.Serialization;\n\nnamespace GitHub.Copilot.SDK.Test.Unit;\n\n/// \n/// Tests for JSON serialization compatibility with the SDK's configured options.\n/// \npublic class SerializationTests\n{\n [Fact]\n public void ProviderConfig_CanSerializeHeaders_WithSdkOptions()\n {\n var options = GetSerializerOptions();\n var original = new ProviderConfig\n {\n BaseUrl = \"https://example.com/provider\",\n Headers = new Dictionary { [\"Authorization\"] = \"Bearer provider-token\" }\n };\n\n var json = JsonSerializer.Serialize(original, options);\n using var document = JsonDocument.Parse(json);\n var root = document.RootElement;\n Assert.Equal(\"https://example.com/provider\", root.GetProperty(\"baseUrl\").GetString());\n Assert.Equal(\"Bearer provider-token\", root.GetProperty(\"headers\").GetProperty(\"Authorization\").GetString());\n\n var deserialized = JsonSerializer.Deserialize(json, options);\n Assert.NotNull(deserialized);\n Assert.Equal(\"https://example.com/provider\", deserialized.BaseUrl);\n Assert.Equal(\"Bearer provider-token\", deserialized.Headers![\"Authorization\"]);\n }\n\n [Fact]\n public void MessageOptions_CanSerializeRequestHeaders_WithSdkOptions()\n {\n var options = GetSerializerOptions();\n var original = new MessageOptions\n {\n Prompt = \"real prompt\",\n Mode = \"plan\",\n RequestHeaders = new Dictionary { [\"X-Trace\"] = \"trace-value\" }\n };\n\n var json = JsonSerializer.Serialize(original, options);\n using var document = JsonDocument.Parse(json);\n var root = document.RootElement;\n Assert.Equal(\"real prompt\", root.GetProperty(\"prompt\").GetString());\n Assert.Equal(\"plan\", root.GetProperty(\"mode\").GetString());\n Assert.Equal(\"trace-value\", root.GetProperty(\"requestHeaders\").GetProperty(\"X-Trace\").GetString());\n\n var deserialized = JsonSerializer.Deserialize(json, options);\n Assert.NotNull(deserialized);\n Assert.Equal(\"real prompt\", deserialized.Prompt);\n Assert.Equal(\"plan\", deserialized.Mode);\n Assert.Equal(\"trace-value\", deserialized.RequestHeaders![\"X-Trace\"]);\n }\n\n [Fact]\n public void SendMessageRequest_CanSerializeRequestHeaders_WithSdkOptions()\n {\n var options = GetSerializerOptions();\n var requestType = GetNestedType(typeof(CopilotSession), \"SendMessageRequest\");\n var request = CreateInternalRequest(\n requestType,\n (\"SessionId\", \"session-id\"),\n (\"Prompt\", \"real prompt\"),\n (\"Mode\", \"plan\"),\n (\"RequestHeaders\", new Dictionary { [\"X-Trace\"] = \"trace-value\" }));\n\n var json = JsonSerializer.Serialize(request, requestType, options);\n using var document = JsonDocument.Parse(json);\n var root = document.RootElement;\n Assert.Equal(\"session-id\", root.GetProperty(\"sessionId\").GetString());\n Assert.Equal(\"real prompt\", root.GetProperty(\"prompt\").GetString());\n Assert.Equal(\"plan\", root.GetProperty(\"mode\").GetString());\n Assert.Equal(\"trace-value\", root.GetProperty(\"requestHeaders\").GetProperty(\"X-Trace\").GetString());\n }\n\n [Fact]\n public void McpHttpServerConfig_CanSerializeOauthOptions_WithSdkOptions()\n {\n var options = GetSerializerOptions();\n McpServerConfig original = new McpHttpServerConfig\n {\n Url = \"https://example.com/mcp\",\n Headers = new Dictionary { [\"Authorization\"] = \"Bearer token\" },\n OauthClientId = \"client-id\",\n OauthPublicClient = false,\n OauthGrantType = McpHttpServerConfigOauthGrantType.ClientCredentials,\n Tools = [\"*\"],\n Timeout = 3000\n };\n\n var json = JsonSerializer.Serialize(original, options);\n using var document = JsonDocument.Parse(json);\n var root = document.RootElement;\n Assert.Equal(\"http\", root.GetProperty(\"type\").GetString());\n Assert.Equal(\"https://example.com/mcp\", root.GetProperty(\"url\").GetString());\n Assert.Equal(\"Bearer token\", root.GetProperty(\"headers\").GetProperty(\"Authorization\").GetString());\n Assert.Equal(\"client-id\", root.GetProperty(\"oauthClientId\").GetString());\n Assert.False(root.GetProperty(\"oauthPublicClient\").GetBoolean());\n Assert.Equal(\"client_credentials\", root.GetProperty(\"oauthGrantType\").GetString());\n Assert.Equal(\"*\", root.GetProperty(\"tools\")[0].GetString());\n Assert.Equal(3000, root.GetProperty(\"timeout\").GetInt32());\n\n var deserialized = JsonSerializer.Deserialize(json, options);\n var httpConfig = Assert.IsType(deserialized);\n Assert.Equal(\"https://example.com/mcp\", httpConfig.Url);\n Assert.Equal(\"Bearer token\", httpConfig.Headers![\"Authorization\"]);\n Assert.Equal(\"client-id\", httpConfig.OauthClientId);\n Assert.False(httpConfig.OauthPublicClient);\n Assert.Equal(McpHttpServerConfigOauthGrantType.ClientCredentials, httpConfig.OauthGrantType);\n Assert.Equal(\"*\", Assert.Single(httpConfig.Tools));\n Assert.Equal(3000, httpConfig.Timeout);\n }\n\n private static JsonSerializerOptions GetSerializerOptions()\n {\n var prop = typeof(CopilotClient)\n .GetProperty(\"SerializerOptionsForMessageFormatter\",\n System.Reflection.BindingFlags.NonPublic | System.Reflection.BindingFlags.Static);\n\n var options = (JsonSerializerOptions?)prop?.GetValue(null);\n Assert.NotNull(options);\n return options;\n }\n\n private static Type GetNestedType(Type containingType, string name)\n {\n var type = containingType.GetNestedType(name, System.Reflection.BindingFlags.NonPublic);\n Assert.NotNull(type);\n return type!;\n }\n\n private static object CreateInternalRequest(Type type, params (string Name, object? Value)[] properties)\n {\n var instance = System.Runtime.CompilerServices.RuntimeHelpers.GetUninitializedObject(type);\n\n foreach (var (name, value) in properties)\n {\n var property = type.GetProperty(name, System.Reflection.BindingFlags.Instance | System.Reflection.BindingFlags.Public | System.Reflection.BindingFlags.NonPublic);\n Assert.NotNull(property);\n\n if (property!.SetMethod is not null)\n {\n property.SetValue(instance, value);\n continue;\n }\n\n var field = type.GetField($\"<{name}>k__BackingField\", System.Reflection.BindingFlags.Instance | System.Reflection.BindingFlags.NonPublic);\n Assert.NotNull(field);\n field!.SetValue(instance, value);\n }\n\n return instance;\n }\n}\n" }, { "path": "dotnet/test/Unit/SessionEventSerializationTests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.Collections.Generic;\nusing System.Text.Json;\nusing Xunit;\n\nnamespace GitHub.Copilot.SDK.Test.Unit;\n\npublic class SessionEventSerializationTests\n{\n public static TheoryData JsonElementBackedEvents => new()\n {\n {\n new AssistantMessageEvent\n {\n Id = Guid.Parse(\"11111111-1111-1111-1111-111111111111\"),\n Timestamp = DateTimeOffset.Parse(\"2026-03-15T21:26:02.642Z\"),\n ParentId = Guid.Parse(\"22222222-2222-2222-2222-222222222222\"),\n AgentId = \"agent-1\",\n Data = new AssistantMessageData\n {\n MessageId = \"msg-1\",\n Content = \"\",\n ToolRequests =\n [\n new AssistantMessageToolRequest\n {\n ToolCallId = \"call-1\",\n Name = \"view\",\n Arguments = ParseJsonElement(\"\"\"{\"path\":\"README.md\"}\"\"\"),\n Type = AssistantMessageToolRequestType.Function,\n },\n ],\n },\n },\n \"assistant.message\"\n },\n {\n new ToolExecutionStartEvent\n {\n Id = Guid.Parse(\"33333333-3333-3333-3333-333333333333\"),\n Timestamp = DateTimeOffset.Parse(\"2026-03-15T21:26:02.642Z\"),\n ParentId = Guid.Parse(\"44444444-4444-4444-4444-444444444444\"),\n Data = new ToolExecutionStartData\n {\n ToolCallId = \"call-1\",\n ToolName = \"view\",\n Arguments = ParseJsonElement(\"\"\"{\"path\":\"README.md\"}\"\"\"),\n },\n },\n \"tool.execution_start\"\n },\n {\n new ToolExecutionCompleteEvent\n {\n Id = Guid.Parse(\"55555555-5555-5555-5555-555555555555\"),\n Timestamp = DateTimeOffset.Parse(\"2026-03-15T21:26:02.642Z\"),\n ParentId = Guid.Parse(\"66666666-6666-6666-6666-666666666666\"),\n Data = new ToolExecutionCompleteData\n {\n ToolCallId = \"call-1\",\n Success = true,\n Result = new ToolExecutionCompleteResult\n {\n Content = \"ok\",\n DetailedContent = \"ok\",\n },\n ToolTelemetry = new Dictionary\n {\n [\"properties\"] = ParseJsonElement(\"\"\"{\"command\":\"view\"}\"\"\"),\n [\"metrics\"] = ParseJsonElement(\"\"\"{\"resultLength\":2}\"\"\"),\n },\n },\n },\n \"tool.execution_complete\"\n },\n {\n new SessionShutdownEvent\n {\n Id = Guid.Parse(\"77777777-7777-7777-7777-777777777777\"),\n Timestamp = DateTimeOffset.Parse(\"2026-03-15T21:26:52.987Z\"),\n ParentId = Guid.Parse(\"88888888-8888-8888-8888-888888888888\"),\n Data = new SessionShutdownData\n {\n ShutdownType = ShutdownType.Routine,\n TotalPremiumRequests = 1,\n TotalApiDurationMs = 100,\n SessionStartTime = 1773609948932,\n CodeChanges = new ShutdownCodeChanges\n {\n LinesAdded = 1,\n LinesRemoved = 0,\n FilesModified = [\"README.md\"],\n },\n ModelMetrics = new Dictionary\n {\n [\"gpt-5.4\"] = new ShutdownModelMetric\n {\n Requests = new ShutdownModelMetricRequests { Count = 1, Cost = 1 },\n TokenDetails = new Dictionary\n {\n [\"input\"] = new ShutdownModelMetricTokenDetail { TokenCount = 10 },\n },\n TotalNanoAiu = 123,\n Usage = new ShutdownModelMetricUsage\n {\n InputTokens = 10,\n OutputTokens = 5,\n CacheReadTokens = 0,\n CacheWriteTokens = 0,\n },\n },\n },\n CurrentModel = \"gpt-5.4\",\n TokenDetails = new Dictionary\n {\n [\"input\"] = new ShutdownTokenDetail { TokenCount = 10 },\n },\n TotalNanoAiu = 123,\n },\n },\n \"session.shutdown\"\n },\n {\n new SystemNotificationEvent\n {\n Id = Guid.Parse(\"99999999-9999-9999-9999-999999999999\"),\n Timestamp = DateTimeOffset.Parse(\"2026-03-15T21:26:53.987Z\"),\n ParentId = Guid.Parse(\"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\"),\n Data = new SystemNotificationData\n {\n Content = \"Instruction discovered\",\n Kind = new SystemNotificationInstructionDiscovered\n {\n Description = \"AGENTS.md from src/\",\n SourcePath = \"src/AGENTS.md\",\n TriggerFile = \"src/Program.cs\",\n TriggerTool = \"view\",\n },\n },\n },\n \"system.notification\"\n },\n {\n new McpOauthRequiredEvent\n {\n Id = Guid.Parse(\"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb\"),\n Timestamp = DateTimeOffset.Parse(\"2026-03-15T21:26:54.987Z\"),\n ParentId = Guid.Parse(\"cccccccc-cccc-cccc-cccc-cccccccccccc\"),\n Data = new McpOauthRequiredData\n {\n RequestId = \"oauth-request\",\n ServerName = \"oauth-server\",\n ServerUrl = \"https://example.com/mcp\",\n StaticClientConfig = new McpOauthRequiredStaticClientConfig\n {\n ClientId = \"client-id\",\n GrantType = \"client_credentials\",\n PublicClient = false,\n },\n },\n },\n \"mcp.oauth_required\"\n },\n {\n new AssistantMessageStartEvent\n {\n Id = Guid.Parse(\"dddddddd-dddd-dddd-dddd-dddddddddddd\"),\n Timestamp = DateTimeOffset.Parse(\"2026-03-15T21:26:55.987Z\"),\n ParentId = Guid.Parse(\"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee\"),\n Data = new AssistantMessageStartData\n {\n MessageId = \"msg-start-1\",\n Phase = \"main\",\n },\n },\n \"assistant.message_start\"\n }\n };\n\n private static JsonElement ParseJsonElement(string json)\n {\n using var document = JsonDocument.Parse(json);\n return document.RootElement.Clone();\n }\n\n [Theory]\n [MemberData(nameof(JsonElementBackedEvents))]\n public void SessionEvent_ToJson_RoundTrips_JsonElementBackedPayloads(SessionEvent sessionEvent, string expectedType)\n {\n var serialized = sessionEvent.ToJson();\n\n using var document = JsonDocument.Parse(serialized);\n var root = document.RootElement;\n\n Assert.Equal(expectedType, root.GetProperty(\"type\").GetString());\n\n switch (expectedType)\n {\n case \"assistant.message\":\n Assert.Equal(\"agent-1\", root.GetProperty(\"agentId\").GetString());\n Assert.Equal(\n \"README.md\",\n root.GetProperty(\"data\")\n .GetProperty(\"toolRequests\")[0]\n .GetProperty(\"arguments\")\n .GetProperty(\"path\")\n .GetString());\n break;\n\n case \"tool.execution_start\":\n Assert.Equal(\n \"README.md\",\n root.GetProperty(\"data\")\n .GetProperty(\"arguments\")\n .GetProperty(\"path\")\n .GetString());\n break;\n\n case \"tool.execution_complete\":\n Assert.Equal(\n \"view\",\n root.GetProperty(\"data\")\n .GetProperty(\"toolTelemetry\")\n .GetProperty(\"properties\")\n .GetProperty(\"command\")\n .GetString());\n break;\n\n case \"session.shutdown\":\n Assert.Equal(\n 1,\n root.GetProperty(\"data\")\n .GetProperty(\"modelMetrics\")\n .GetProperty(\"gpt-5.4\")\n .GetProperty(\"requests\")\n .GetProperty(\"count\")\n .GetInt32());\n Assert.Equal(\n 123,\n root.GetProperty(\"data\")\n .GetProperty(\"totalNanoAiu\")\n .GetInt32());\n Assert.Equal(\n 10,\n root.GetProperty(\"data\")\n .GetProperty(\"tokenDetails\")\n .GetProperty(\"input\")\n .GetProperty(\"tokenCount\")\n .GetInt32());\n Assert.Equal(\n 10,\n root.GetProperty(\"data\")\n .GetProperty(\"modelMetrics\")\n .GetProperty(\"gpt-5.4\")\n .GetProperty(\"tokenDetails\")\n .GetProperty(\"input\")\n .GetProperty(\"tokenCount\")\n .GetInt32());\n break;\n\n case \"system.notification\":\n Assert.Equal(\n \"instruction_discovered\",\n root.GetProperty(\"data\")\n .GetProperty(\"kind\")\n .GetProperty(\"type\")\n .GetString());\n Assert.Equal(\n \"src/AGENTS.md\",\n root.GetProperty(\"data\")\n .GetProperty(\"kind\")\n .GetProperty(\"sourcePath\")\n .GetString());\n break;\n\n case \"mcp.oauth_required\":\n Assert.Equal(\n \"client_credentials\",\n root.GetProperty(\"data\")\n .GetProperty(\"staticClientConfig\")\n .GetProperty(\"grantType\")\n .GetString());\n break;\n\n case \"assistant.message_start\":\n Assert.Equal(\n \"msg-start-1\",\n root.GetProperty(\"data\")\n .GetProperty(\"messageId\")\n .GetString());\n Assert.Equal(\n \"main\",\n root.GetProperty(\"data\")\n .GetProperty(\"phase\")\n .GetString());\n break;\n }\n }\n}\n" }, { "path": "dotnet/test/Unit/TelemetryTests.cs", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nusing System.Diagnostics;\nusing System.Reflection;\nusing Xunit;\n\nnamespace GitHub.Copilot.SDK.Test.Unit;\n\npublic class TelemetryTests\n{\n [Fact]\n public void TelemetryConfig_DefaultValues_AreNull()\n {\n var config = new TelemetryConfig();\n\n Assert.Null(config.OtlpEndpoint);\n Assert.Null(config.FilePath);\n Assert.Null(config.ExporterType);\n Assert.Null(config.SourceName);\n Assert.Null(config.CaptureContent);\n }\n\n [Fact]\n public void TelemetryConfig_CanSetAllProperties()\n {\n var config = new TelemetryConfig\n {\n OtlpEndpoint = \"http://localhost:4318\",\n FilePath = \"/tmp/traces.json\",\n ExporterType = \"otlp-http\",\n SourceName = \"my-app\",\n CaptureContent = true\n };\n\n Assert.Equal(\"http://localhost:4318\", config.OtlpEndpoint);\n Assert.Equal(\"/tmp/traces.json\", config.FilePath);\n Assert.Equal(\"otlp-http\", config.ExporterType);\n Assert.Equal(\"my-app\", config.SourceName);\n Assert.True(config.CaptureContent);\n }\n\n [Fact]\n public void CopilotClientOptions_Telemetry_DefaultsToNull()\n {\n var options = new CopilotClientOptions();\n\n Assert.Null(options.Telemetry);\n }\n\n [Fact]\n public void CopilotClientOptions_Clone_CopiesTelemetry()\n {\n var telemetry = new TelemetryConfig\n {\n OtlpEndpoint = \"http://localhost:4318\",\n ExporterType = \"otlp-http\"\n };\n\n var options = new CopilotClientOptions { Telemetry = telemetry };\n var clone = options.Clone();\n\n Assert.Same(telemetry, clone.Telemetry);\n }\n\n [Fact]\n public void TelemetryHelpers_Restores_W3C_Trace_Context()\n {\n using var parent = new Activity(\"parent\");\n parent.SetIdFormat(ActivityIdFormat.W3C);\n parent.TraceStateString = \"state=value\";\n parent.Start();\n\n var traceContext = InvokeTelemetryHelper<(string? Traceparent, string? Tracestate)>(\"GetTraceContext\");\n Assert.Equal(parent.Id, traceContext.Traceparent);\n Assert.Equal(\"state=value\", traceContext.Tracestate);\n\n parent.Stop();\n using var restored = InvokeTelemetryHelper(\n \"RestoreTraceContext\",\n traceContext.Traceparent,\n traceContext.Tracestate);\n\n Assert.NotNull(restored);\n Assert.Equal(parent.Id, restored.ParentId);\n Assert.Equal(\"state=value\", restored.TraceStateString);\n\n Assert.Null(InvokeTelemetryHelper(\"RestoreTraceContext\", \"not-a-traceparent\", null));\n }\n\n private static T InvokeTelemetryHelper(string name, params object?[] args)\n {\n var helperType = typeof(CopilotClient).Assembly.GetType(\"GitHub.Copilot.SDK.TelemetryHelpers\", throwOnError: true)!;\n var method = helperType.GetMethod(name, BindingFlags.Static | BindingFlags.NonPublic)!;\n return (T)method.Invoke(null, args)!;\n }\n}\n" }, { "path": "go/.gitignore", "content": "# If you prefer the allow list template instead of the deny list, see community template:\n# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore\n#\n# Binaries for programs and plugins\n*.exe\n*.exe~\n*.dll\n*.so\n*.dylib\n\n# Test binary, built with `go test -c`\n*.test\n\n# Output of the go coverage tool, specifically when used with LiteIDE\n*.out\n\n# Dependency directories (remove the comment below to include it)\n# vendor/\n\n# Go workspace file\ngo.work\n\n# env file\n.env\n" }, { "path": "go/.golangci.yml", "content": "version: \"2\"\n\nrun:\n timeout: 5m\n tests: true\n\nlinters:\n enable:\n - govet\n - ineffassign\n - staticcheck\n disable:\n - errcheck\n\n exclusions:\n paths:\n - generated\n\nissues:\n max-issues-per-linter: 0\n max-same-issues: 0\n" }, { "path": "go/README.md", "content": "# Copilot CLI SDK for Go\n\nA Go SDK for programmatic access to the GitHub Copilot CLI.\n\n> **Note:** This SDK is in public preview and may change in breaking ways.\n\n## Installation\n\n```bash\ngo get github.com/github/copilot-sdk/go\n```\n\n## Run the Sample\n\nTry the interactive chat sample (from the repo root):\n\n```bash\ncd go/samples\ngo run chat.go\n```\n\n## Quick Start\n\n```go\npackage main\n\nimport (\n\t\"context\"\n \"fmt\"\n \"log\"\n\n copilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n // Create client\n client := copilot.NewClient(&copilot.ClientOptions{\n LogLevel: \"error\",\n })\n\n // Start the client\n if err := client.Start(context.Background()); err != nil {\n log.Fatal(err)\n }\n defer client.Stop()\n\n // Create a session (OnPermissionRequest is required)\n session, err := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Model: \"gpt-5\",\n OnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n })\n if err != nil {\n log.Fatal(err)\n }\n defer session.Disconnect()\n\n // Set up event handler\n done := make(chan bool)\n session.On(func(event copilot.SessionEvent) {\n switch d := event.Data.(type) {\n case *copilot.AssistantMessageData:\n fmt.Println(d.Content)\n case *copilot.SessionIdleData:\n close(done)\n }\n })\n\n // Send a message\n _, err = session.Send(context.Background(), copilot.MessageOptions{\n Prompt: \"What is 2+2?\",\n })\n if err != nil {\n log.Fatal(err)\n }\n\n // Wait for completion\n <-done\n}\n```\n\n## Distributing your application with an embedded GitHub Copilot CLI\n\nThe SDK supports bundling, using Go's `embed` package, the Copilot CLI binary within your application's distribution.\nThis allows you to bundle a specific CLI version and avoid external dependencies on the user's system.\n\nFollow these steps to embed the CLI:\n\n1. Run `go get -tool github.com/github/copilot-sdk/go/cmd/bundler`. This is a one-time setup step per project.\n2. Run `go tool bundler` in your build environment just before building your application.\n\nThat's it! When your application calls `copilot.NewClient` without a `CLIPath` nor the `COPILOT_CLI_PATH` environment variable, the SDK will automatically install the embedded CLI to a cache directory and use it for all operations.\n\n## API Reference\n\n### Client\n\n- `NewClient(options *ClientOptions) *Client` - Create a new client\n- `Start(ctx context.Context) error` - Start the CLI server\n- `Stop() error` - Stop the CLI server\n- `ForceStop()` - Forcefully stop without graceful cleanup\n- `CreateSession(config *SessionConfig) (*Session, error)` - Create a new session\n- `ResumeSession(sessionID string, config *ResumeSessionConfig) (*Session, error)` - Resume an existing session\n- `ResumeSessionWithOptions(sessionID string, config *ResumeSessionConfig) (*Session, error)` - Resume with additional configuration\n- `ListSessions(filter *SessionListFilter) ([]SessionMetadata, error)` - List sessions (with optional filter)\n- `DeleteSession(sessionID string) error` - Delete a session permanently\n- `GetLastSessionID(ctx context.Context) (*string, error)` - Get the ID of the most recently updated session\n- `GetState() ConnectionState` - Get connection state\n- `Ping(message string) (*PingResponse, error)` - Ping the server\n- `GetForegroundSessionID(ctx context.Context) (*string, error)` - Get the session ID currently displayed in TUI (TUI+server mode only)\n- `SetForegroundSessionID(ctx context.Context, sessionID string) error` - Request TUI to display a specific session (TUI+server mode only)\n- `On(handler SessionLifecycleHandler) func()` - Subscribe to all lifecycle events; returns unsubscribe function\n- `OnEventType(eventType SessionLifecycleEventType, handler SessionLifecycleHandler) func()` - Subscribe to specific lifecycle event type\n\n**Session Lifecycle Events:**\n\n```go\n// Subscribe to all lifecycle events\nunsubscribe := client.On(func(event copilot.SessionLifecycleEvent) {\n fmt.Printf(\"Session %s: %s\\n\", event.SessionID, event.Type)\n})\ndefer unsubscribe()\n\n// Subscribe to specific event type\nunsubscribe := client.OnEventType(copilot.SessionLifecycleForeground, func(event copilot.SessionLifecycleEvent) {\n fmt.Printf(\"Session %s is now in foreground\\n\", event.SessionID)\n})\n```\n\nEvent types: `SessionLifecycleCreated`, `SessionLifecycleDeleted`, `SessionLifecycleUpdated`, `SessionLifecycleForeground`, `SessionLifecycleBackground`\n\n**ClientOptions:**\n\n- `CLIPath` (string): Path to CLI executable (default: \"copilot\" or `COPILOT_CLI_PATH` env var)\n- `CLIUrl` (string): URL of existing CLI server (e.g., `\"localhost:8080\"`, `\"http://127.0.0.1:9000\"`, or just `\"8080\"`). When provided, the client will not spawn a CLI process.\n- `Cwd` (string): Working directory for CLI process\n- `Port` (int): Server port for TCP mode (default: 0 for random)\n- `UseStdio` (bool): Use stdio transport instead of TCP (default: true)\n- `LogLevel` (string): Log level (default: \"info\")\n- `AutoStart` (\\*bool): Auto-start server on first use (default: true). Use `Bool(false)` to disable.\n- `Env` ([]string): Environment variables for CLI process (default: inherits from current process)\n- `GitHubToken` (string): GitHub token for authentication. When provided, takes priority over other auth methods.\n- `UseLoggedInUser` (\\*bool): Whether to use logged-in user for authentication (default: true, but false when `GitHubToken` is provided). Cannot be used with `CLIUrl`.\n- `Telemetry` (\\*TelemetryConfig): OpenTelemetry configuration for the CLI process. Providing this enables telemetry — no separate flag needed. See [Telemetry](#telemetry) below.\n\n**SessionConfig:**\n\n- `Model` (string): Model to use (\"gpt-5\", \"claude-sonnet-4.5\", etc.). **Required when using custom provider.**\n- `ReasoningEffort` (string): Reasoning effort level for models that support it (\"low\", \"medium\", \"high\", \"xhigh\"). Use `ListModels()` to check which models support this option.\n- `SessionID` (string): Custom session ID\n- `Tools` ([]Tool): Custom tools exposed to the CLI\n- `SystemMessage` (\\*SystemMessageConfig): System message configuration. Supports three modes:\n - **append** (default): Appends `Content` after the SDK-managed prompt\n - **replace**: Replaces the entire prompt with `Content`\n - **customize**: Selectively override individual sections via `Sections` map (keys: `SectionIdentity`, `SectionTone`, `SectionToolEfficiency`, `SectionEnvironmentContext`, `SectionCodeChangeRules`, `SectionGuidelines`, `SectionSafety`, `SectionToolInstructions`, `SectionCustomInstructions`, `SectionLastInstructions`; values: `SectionOverride` with `Action` and optional `Content`)\n- `Provider` (\\*ProviderConfig): Custom API provider configuration (BYOK). See [Custom Providers](#custom-providers) section.\n- `Streaming` (bool): Enable streaming delta events\n- `InfiniteSessions` (\\*InfiniteSessionConfig): Automatic context compaction configuration\n- `OnPermissionRequest` (PermissionHandlerFunc): **Required.** Handler called before each tool execution to approve or deny it. Use `copilot.PermissionHandler.ApproveAll` to allow everything, or provide a custom function for fine-grained control. See [Permission Handling](#permission-handling) section.\n- `OnUserInputRequest` (UserInputHandler): Handler for user input requests from the agent (enables ask_user tool). See [User Input Requests](#user-input-requests) section.\n- `Hooks` (\\*SessionHooks): Hook handlers for session lifecycle events. See [Session Hooks](#session-hooks) section.\n- `Commands` ([]CommandDefinition): Slash-commands registered for this session. See [Commands](#commands) section.\n- `OnElicitationRequest` (ElicitationHandler): Handler for elicitation requests from the server. See [Elicitation Requests](#elicitation-requests-serverclient) section.\n\n**ResumeSessionConfig:**\n\n- `OnPermissionRequest` (PermissionHandlerFunc): **Required.** Handler called before each tool execution to approve or deny it. See [Permission Handling](#permission-handling) section.\n- `Tools` ([]Tool): Tools to expose when resuming\n- `ReasoningEffort` (string): Reasoning effort level for models that support it\n- `Provider` (\\*ProviderConfig): Custom API provider configuration (BYOK). See [Custom Providers](#custom-providers) section.\n- `Streaming` (bool): Enable streaming delta events\n- `Commands` ([]CommandDefinition): Slash-commands. See [Commands](#commands) section.\n- `OnElicitationRequest` (ElicitationHandler): Elicitation handler. See [Elicitation Requests](#elicitation-requests-serverclient) section.\n\n### Session\n\n- `Send(ctx context.Context, options MessageOptions) (string, error)` - Send a message\n- `On(handler SessionEventHandler) func()` - Subscribe to events (returns unsubscribe function)\n- `Abort(ctx context.Context) error` - Abort the currently processing message\n- `GetMessages(ctx context.Context) ([]SessionEvent, error)` - Get message history\n- `Disconnect() error` - Disconnect the session (releases in-memory resources, preserves disk state)\n- `Destroy() error` - _(Deprecated)_ Use `Disconnect()` instead\n- `UI() *SessionUI` - Interactive UI API for elicitation dialogs\n- `Capabilities() SessionCapabilities` - Host capabilities (e.g. elicitation support)\n\n### Helper Functions\n\n- `Bool(v bool) *bool` - Helper to create bool pointers for `AutoStart` option\n- `Int(v int) *int` - Helper to create int pointers for `MinLength`, `MaxLength`\n- `String(v string) *string` - Helper to create string pointers\n- `Float64(v float64) *float64` - Helper to create float64 pointers\n\n### System Message Customization\n\nControl the system prompt using `SystemMessage` in session config:\n\n```go\nsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n SystemMessage: &copilot.SystemMessageConfig{\n Content: \"Always check for security vulnerabilities before suggesting changes.\",\n },\n})\n```\n\nThe SDK auto-injects environment context, tool instructions, and security guardrails. The default CLI persona is preserved, and your `Content` is appended after SDK-managed sections. To change the persona or fully redefine the prompt, use `Mode: \"replace\"` or `Mode: \"customize\"`.\n\n#### Customize Mode\n\nUse `Mode: \"customize\"` to selectively override individual sections of the prompt while preserving the rest:\n\n```go\nsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n SystemMessage: &copilot.SystemMessageConfig{\n Mode: \"customize\",\n Sections: map[string]copilot.SectionOverride{\n // Replace the tone/style section\n copilot.SectionTone: {Action: \"replace\", Content: \"Respond in a warm, professional tone. Be thorough in explanations.\"},\n // Remove coding-specific rules\n copilot.SectionCodeChangeRules: {Action: \"remove\"},\n // Append to existing guidelines\n copilot.SectionGuidelines: {Action: \"append\", Content: \"\\n* Always cite data sources\"},\n },\n // Additional instructions appended after all sections\n Content: \"Focus on financial analysis and reporting.\",\n },\n})\n```\n\nAvailable section constants: `SectionIdentity`, `SectionTone`, `SectionToolEfficiency`, `SectionEnvironmentContext`, `SectionCodeChangeRules`, `SectionGuidelines`, `SectionSafety`, `SectionToolInstructions`, `SectionCustomInstructions`, `SectionLastInstructions`.\n\nEach section override supports four actions:\n\n- **`replace`** — Replace the section content entirely\n- **`remove`** — Remove the section from the prompt\n- **`append`** — Add content after the existing section\n- **`prepend`** — Add content before the existing section\n\nUnknown section IDs are handled gracefully: content from `replace`/`append`/`prepend` overrides is appended to additional instructions, and `remove` overrides are silently ignored.\n\n## Image Support\n\nThe SDK supports image attachments via the `Attachments` field in `MessageOptions`. You can attach images by providing their file path, or by passing base64-encoded data directly using a blob attachment:\n\n```go\n// File attachment — runtime reads from disk\n_, err = session.Send(context.Background(), copilot.MessageOptions{\n Prompt: \"What's in this image?\",\n Attachments: []copilot.Attachment{\n {\n Type: \"file\",\n Path: \"/path/to/image.jpg\",\n },\n },\n})\n\n// Blob attachment — provide base64 data directly\nmimeType := \"image/png\"\n_, err = session.Send(context.Background(), copilot.MessageOptions{\n Prompt: \"What's in this image?\",\n Attachments: []copilot.Attachment{\n {\n Type: copilot.AttachmentTypeBlob,\n Data: &base64ImageData,\n MIMEType: &mimeType,\n },\n },\n})\n```\n\nSupported image formats include JPG, PNG, GIF, and other common image types. The agent's `view` tool can also read images directly from the filesystem, so you can also ask questions like:\n\n```go\n_, err = session.Send(context.Background(), copilot.MessageOptions{\n Prompt: \"What does the most recent jpg in this directory portray?\",\n})\n```\n\n### Tools\n\nExpose your own functionality to Copilot by attaching tools to a session.\n\n#### Using DefineTool (Recommended)\n\nUse `DefineTool` for type-safe tools with automatic JSON schema generation:\n\n```go\ntype LookupIssueParams struct {\n ID string `json:\"id\" jsonschema:\"Issue identifier\"`\n}\n\nlookupIssue := copilot.DefineTool(\"lookup_issue\", \"Fetch issue details from our tracker\",\n func(params LookupIssueParams, inv copilot.ToolInvocation) (any, error) {\n // params is automatically unmarshaled from the LLM's arguments\n issue, err := fetchIssue(params.ID)\n if err != nil {\n return nil, err\n }\n return issue.Summary, nil\n })\n\nsession, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Model: \"gpt-5\",\n Tools: []copilot.Tool{lookupIssue},\n})\n```\n\n#### Using Tool struct directly\n\nFor more control over the JSON schema, use the `Tool` struct directly:\n\n```go\nlookupIssue := copilot.Tool{\n Name: \"lookup_issue\",\n Description: \"Fetch issue details from our tracker\",\n Parameters: map[string]any{\n \"type\": \"object\",\n \"properties\": map[string]any{\n \"id\": map[string]any{\n \"type\": \"string\",\n \"description\": \"Issue identifier\",\n },\n },\n \"required\": []string{\"id\"},\n },\n Handler: func(invocation copilot.ToolInvocation) (copilot.ToolResult, error) {\n args := invocation.Arguments.(map[string]any)\n issue, err := fetchIssue(args[\"id\"].(string))\n if err != nil {\n return copilot.ToolResult{}, err\n }\n return copilot.ToolResult{\n TextResultForLLM: issue.Summary,\n ResultType: \"success\",\n SessionLog: fmt.Sprintf(\"Fetched issue %s\", issue.ID),\n }, nil\n },\n}\n\nsession, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Model: \"gpt-5\",\n Tools: []copilot.Tool{lookupIssue},\n})\n```\n\nWhen the model selects a tool, the SDK automatically runs your handler (in parallel with other calls) and responds to the CLI's `tool.call` with the handler's result.\n\n#### Overriding Built-in Tools\n\nIf you register a tool with the same name as a built-in CLI tool (e.g. `edit_file`, `read_file`), the SDK will throw an error unless you explicitly opt in by setting `OverridesBuiltInTool = true`. This flag signals that you intend to replace the built-in tool with your custom implementation.\n\n```go\neditFile := copilot.DefineTool(\"edit_file\", \"Custom file editor with project-specific validation\",\n func(params EditFileParams, inv copilot.ToolInvocation) (any, error) {\n // your logic\n })\neditFile.OverridesBuiltInTool = true\n```\n\n#### Skipping Permission Prompts\n\nSet `SkipPermission = true` on a tool to allow it to execute without triggering a permission prompt:\n\n```go\nsafeLookup := copilot.DefineTool(\"safe_lookup\", \"A read-only lookup that needs no confirmation\",\n func(params LookupParams, inv copilot.ToolInvocation) (any, error) {\n // your logic\n })\nsafeLookup.SkipPermission = true\n```\n\n## Streaming\n\nEnable streaming to receive assistant response chunks as they're generated:\n\n```go\npackage main\n\nimport (\n\t\"context\"\n \"fmt\"\n \"log\"\n\n copilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n client := copilot.NewClient(nil)\n\n if err := client.Start(context.Background()); err != nil {\n log.Fatal(err)\n }\n defer client.Stop()\n\n session, err := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Model: \"gpt-5\",\n Streaming: true,\n })\n if err != nil {\n log.Fatal(err)\n }\n defer session.Disconnect()\n\n done := make(chan bool)\n\n session.On(func(event copilot.SessionEvent) {\n switch d := event.Data.(type) {\n case *copilot.AssistantMessageDeltaData:\n // Streaming message chunk - print incrementally\n fmt.Print(d.DeltaContent)\n case *copilot.AssistantReasoningDeltaData:\n // Streaming reasoning chunk (if model supports reasoning)\n fmt.Print(d.DeltaContent)\n case *copilot.AssistantMessageData:\n // Final message - complete content\n fmt.Println(\"\\n--- Final message ---\")\n fmt.Println(d.Content)\n case *copilot.AssistantReasoningData:\n // Final reasoning content (if model supports reasoning)\n fmt.Println(\"--- Reasoning ---\")\n fmt.Println(d.Content)\n case *copilot.SessionIdleData:\n close(done)\n }\n })\n\n _, err = session.Send(context.Background(), copilot.MessageOptions{\n Prompt: \"Tell me a short story\",\n })\n if err != nil {\n log.Fatal(err)\n }\n\n <-done\n}\n```\n\nWhen `Streaming: true`:\n\n- `assistant.message_delta` events are sent with `DeltaContent` containing incremental text\n- `assistant.reasoning_delta` events are sent with `DeltaContent` for reasoning/chain-of-thought (model-dependent)\n- Accumulate `DeltaContent` values to build the full response progressively\n- The final `assistant.message` and `assistant.reasoning` events contain the complete content\n\nNote: `assistant.message` and `assistant.reasoning` (final events) are always sent regardless of streaming setting.\n\n## Infinite Sessions\n\nBy default, sessions use **infinite sessions** which automatically manage context window limits through background compaction and persist state to a workspace directory.\n\n```go\n// Default: infinite sessions enabled with default thresholds\nsession, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Model: \"gpt-5\",\n})\n\n// Access the workspace path for checkpoints and files\nfmt.Println(session.WorkspacePath())\n// => ~/.copilot/session-state/{sessionId}/\n\n// Custom thresholds\nsession, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Model: \"gpt-5\",\n InfiniteSessions: &copilot.InfiniteSessionConfig{\n Enabled: copilot.Bool(true),\n BackgroundCompactionThreshold: copilot.Float64(0.80), // Start compacting at 80% context usage\n BufferExhaustionThreshold: copilot.Float64(0.95), // Block at 95% until compaction completes\n },\n})\n\n// Disable infinite sessions\nsession, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Model: \"gpt-5\",\n InfiniteSessions: &copilot.InfiniteSessionConfig{\n Enabled: copilot.Bool(false),\n },\n})\n```\n\nWhen enabled, sessions emit compaction events:\n\n- `session.compaction_start` - Background compaction started\n- `session.compaction_complete` - Compaction finished (includes token counts)\n\n## Custom Providers\n\nThe SDK supports custom OpenAI-compatible API providers (BYOK - Bring Your Own Key), including local providers like Ollama. When using a custom provider, you must specify the `Model` explicitly.\n\n**ProviderConfig:**\n\n- `Type` (string): Provider type - \"openai\", \"azure\", or \"anthropic\" (default: \"openai\")\n- `BaseURL` (string): API endpoint URL (required)\n- `APIKey` (string): API key (optional for local providers like Ollama)\n- `BearerToken` (string): Bearer token for authentication (takes precedence over APIKey)\n- `WireApi` (string): API format for OpenAI/Azure - \"completions\" or \"responses\" (default: \"completions\")\n- `Azure.APIVersion` (string): Azure API version (default: \"2024-10-21\")\n\n**Example with Ollama:**\n\n```go\nsession, err := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Model: \"deepseek-coder-v2:16b\", // Required when using custom provider\n Provider: &copilot.ProviderConfig{\n Type: \"openai\",\n BaseURL: \"http://localhost:11434/v1\", // Ollama endpoint\n // APIKey not required for Ollama\n },\n})\n```\n\n**Example with custom OpenAI-compatible API:**\n\n```go\nsession, err := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Model: \"gpt-4\",\n Provider: &copilot.ProviderConfig{\n Type: \"openai\",\n BaseURL: \"https://my-api.example.com/v1\",\n APIKey: os.Getenv(\"MY_API_KEY\"),\n },\n})\n```\n\n**Example with Azure OpenAI:**\n\n```go\nsession, err := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Model: \"gpt-4\",\n Provider: &copilot.ProviderConfig{\n Type: \"azure\", // Must be \"azure\" for Azure endpoints, NOT \"openai\"\n BaseURL: \"https://my-resource.openai.azure.com\", // Just the host, no path\n APIKey: os.Getenv(\"AZURE_OPENAI_KEY\"),\n Azure: &copilot.AzureProviderOptions{\n APIVersion: \"2024-10-21\",\n },\n },\n})\n```\n\n> **Important notes:**\n>\n> - When using a custom provider, the `Model` parameter is **required**. The SDK will return an error if no model is specified.\n> - For Azure OpenAI endpoints (`*.openai.azure.com`), you **must** use `Type: \"azure\"`, not `Type: \"openai\"`.\n> - The `BaseURL` should be just the host (e.g., `https://my-resource.openai.azure.com`). Do **not** include `/openai/v1` in the URL - the SDK handles path construction automatically.\n\n## Telemetry\n\nThe SDK supports OpenTelemetry for distributed tracing. Provide a `Telemetry` config to enable trace export and automatic W3C Trace Context propagation.\n\n```go\nclient, err := copilot.NewClient(copilot.ClientOptions{\n Telemetry: &copilot.TelemetryConfig{\n OTLPEndpoint: \"http://localhost:4318\",\n },\n})\n```\n\n**TelemetryConfig fields:**\n\n- `OTLPEndpoint` (string): OTLP HTTP endpoint URL\n- `FilePath` (string): File path for JSON-lines trace output\n- `ExporterType` (string): `\"otlp-http\"` or `\"file\"`\n- `SourceName` (string): Instrumentation scope name\n- `CaptureContent` (bool): Whether to capture message content\n\nTrace context (`traceparent`/`tracestate`) is automatically propagated between the SDK and CLI on `CreateSession`, `ResumeSession`, and `Send` calls, and inbound when the CLI invokes tool handlers.\n\n> **Note:** The current `ToolHandler` signature does not accept a `context.Context`, so the inbound trace context cannot be passed to handler code. Spans created inside a tool handler will not be automatically parented to the CLI's `execute_tool` span. A future version may add a context parameter.\n\nDependency: `go.opentelemetry.io/otel`\n\n## Permission Handling\n\nAn `OnPermissionRequest` handler is **required** whenever you create or resume a session. The handler is called before the agent executes each tool (file writes, shell commands, custom tools, etc.) and must return a decision.\n\n### Approve All (simplest)\n\nUse the built-in `PermissionHandler.ApproveAll` helper to allow every tool call without any checks:\n\n```go\nsession, err := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Model: \"gpt-5\",\n OnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n})\n```\n\n### Custom Permission Handler\n\nProvide your own `PermissionHandlerFunc` to inspect each request and apply custom logic:\n\n```go\nsession, err := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Model: \"gpt-5\",\n OnPermissionRequest: func(request copilot.PermissionRequest, invocation copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n // request.Kind — what type of operation is being requested:\n // copilot.KindShell — executing a shell command\n // copilot.Write — writing or editing a file\n // copilot.Read — reading a file\n // copilot.MCP — calling an MCP tool\n // copilot.CustomTool — calling one of your registered tools\n // copilot.URL — fetching a URL\n // copilot.Memory — accessing or updating Copilot-managed memory\n // copilot.Hook — invoking a registered hook\n // request.ToolCallID — pointer to the tool call that triggered this request\n // request.ToolName — pointer to the name of the tool (for custom-tool / mcp)\n // request.FileName — pointer to the file being written (for write)\n // request.FullCommandText — pointer to the full shell command (for shell)\n\n if request.Kind == copilot.KindShell {\n // Deny shell commands\n return copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindDeniedInteractivelyByUser}, nil\n }\n\n return copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n },\n})\n```\n\n### Permission Result Kinds\n\n| Constant | Meaning |\n| ---------------------------------------------------------- | --------------------------------------------------------------------------------------- |\n| `PermissionRequestResultKindApproved` | Allow the tool to run |\n| `PermissionRequestResultKindDeniedInteractivelyByUser` | User explicitly denied the request |\n| `PermissionRequestResultKindDeniedCouldNotRequestFromUser` | No approval rule matched and user could not be asked |\n| `PermissionRequestResultKindDeniedByRules` | Denied by a policy rule |\n| `PermissionRequestResultKindNoResult` | Leave the permission request unanswered (protocol v1 only; not allowed for protocol v2) |\n\n### Resuming Sessions\n\nPass `OnPermissionRequest` when resuming a session too — it is required:\n\n```go\nsession, err := client.ResumeSession(context.Background(), sessionID, &copilot.ResumeSessionConfig{\n OnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n})\n```\n\n### Per-Tool Skip Permission\n\nTo let a specific custom tool bypass the permission prompt entirely, set `SkipPermission = true` on the tool. See [Skipping Permission Prompts](#skipping-permission-prompts) under Tools.\n\n## User Input Requests\n\nEnable the agent to ask questions to the user using the `ask_user` tool by providing an `OnUserInputRequest` handler:\n\n```go\nsession, err := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Model: \"gpt-5\",\n OnUserInputRequest: func(request copilot.UserInputRequest, invocation copilot.UserInputInvocation) (copilot.UserInputResponse, error) {\n // request.Question - The question to ask\n // request.Choices - Optional slice of choices for multiple choice\n // request.AllowFreeform - Whether freeform input is allowed (default: true)\n\n fmt.Printf(\"Agent asks: %s\\n\", request.Question)\n if len(request.Choices) > 0 {\n fmt.Printf(\"Choices: %v\\n\", request.Choices)\n }\n\n // Return the user's response\n return copilot.UserInputResponse{\n Answer: \"User's answer here\",\n WasFreeform: true, // Whether the answer was freeform (not from choices)\n }, nil\n },\n})\n```\n\n## Session Hooks\n\nHook into session lifecycle events by providing handlers in the `Hooks` configuration:\n\n```go\nsession, err := client.CreateSession(context.Background(), &copilot.SessionConfig{\n Model: \"gpt-5\",\n Hooks: &copilot.SessionHooks{\n // Called before each tool execution\n OnPreToolUse: func(input copilot.PreToolUseHookInput, invocation copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {\n fmt.Printf(\"About to run tool: %s\\n\", input.ToolName)\n // Return permission decision and optionally modify args\n return &copilot.PreToolUseHookOutput{\n PermissionDecision: \"allow\", // \"allow\", \"deny\", or \"ask\"\n ModifiedArgs: input.ToolArgs, // Optionally modify tool arguments\n AdditionalContext: \"Extra context for the model\",\n }, nil\n },\n\n // Called after each tool execution\n OnPostToolUse: func(input copilot.PostToolUseHookInput, invocation copilot.HookInvocation) (*copilot.PostToolUseHookOutput, error) {\n fmt.Printf(\"Tool %s completed\\n\", input.ToolName)\n return &copilot.PostToolUseHookOutput{\n AdditionalContext: \"Post-execution notes\",\n }, nil\n },\n\n // Called when user submits a prompt\n OnUserPromptSubmitted: func(input copilot.UserPromptSubmittedHookInput, invocation copilot.HookInvocation) (*copilot.UserPromptSubmittedHookOutput, error) {\n fmt.Printf(\"User prompt: %s\\n\", input.Prompt)\n return &copilot.UserPromptSubmittedHookOutput{\n ModifiedPrompt: input.Prompt, // Optionally modify the prompt\n }, nil\n },\n\n // Called when session starts\n OnSessionStart: func(input copilot.SessionStartHookInput, invocation copilot.HookInvocation) (*copilot.SessionStartHookOutput, error) {\n fmt.Printf(\"Session started from: %s\\n\", input.Source) // \"startup\", \"resume\", \"new\"\n return &copilot.SessionStartHookOutput{\n AdditionalContext: \"Session initialization context\",\n }, nil\n },\n\n // Called when session ends\n OnSessionEnd: func(input copilot.SessionEndHookInput, invocation copilot.HookInvocation) (*copilot.SessionEndHookOutput, error) {\n fmt.Printf(\"Session ended: %s\\n\", input.Reason)\n return nil, nil\n },\n\n // Called when an error occurs\n OnErrorOccurred: func(input copilot.ErrorOccurredHookInput, invocation copilot.HookInvocation) (*copilot.ErrorOccurredHookOutput, error) {\n fmt.Printf(\"Error in %s: %s\\n\", input.ErrorContext, input.Error)\n return &copilot.ErrorOccurredHookOutput{\n ErrorHandling: \"retry\", // \"retry\", \"skip\", or \"abort\"\n }, nil\n },\n },\n})\n```\n\n**Available hooks:**\n\n- `OnPreToolUse` - Intercept tool calls before execution. Can allow/deny or modify arguments.\n- `OnPostToolUse` - Process tool results after execution. Can modify results or add context.\n- `OnUserPromptSubmitted` - Intercept user prompts. Can modify the prompt before processing.\n- `OnSessionStart` - Run logic when a session starts or resumes.\n- `OnSessionEnd` - Cleanup or logging when session ends.\n- `OnErrorOccurred` - Handle errors with retry/skip/abort strategies.\n\n## Commands\n\nRegister slash-commands that users can invoke from the CLI TUI. When a user types `/deploy production`, the SDK dispatches to your handler and responds via the RPC layer.\n\n```go\nsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n OnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n Commands: []copilot.CommandDefinition{\n {\n Name: \"deploy\",\n Description: \"Deploy the app to production\",\n Handler: func(ctx copilot.CommandContext) error {\n fmt.Printf(\"Deploying with args: %s\\n\", ctx.Args)\n // ctx.SessionID, ctx.Command, ctx.CommandName, ctx.Args\n return nil\n },\n },\n {\n Name: \"rollback\",\n Description: \"Rollback the last deployment\",\n Handler: func(ctx copilot.CommandContext) error {\n return nil\n },\n },\n },\n})\n```\n\nCommands are also available when resuming sessions:\n\n```go\nsession, err := client.ResumeSession(ctx, sessionID, &copilot.ResumeSessionConfig{\n OnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n Commands: []copilot.CommandDefinition{\n {Name: \"status\", Description: \"Show status\", Handler: statusHandler},\n },\n})\n```\n\nIf a handler returns an error, the SDK sends the error message back to the server. Unknown commands automatically receive an error response.\n\n## UI Elicitation\n\nThe SDK provides convenience methods to ask the user questions via elicitation dialogs. These are gated by host capabilities — check `session.Capabilities().UI.Elicitation` before calling.\n\n```go\nui := session.UI()\n\n// Confirmation dialog — returns bool\nconfirmed, err := ui.Confirm(ctx, \"Deploy to production?\")\n\n// Selection dialog — returns (selected string, ok bool, error)\nchoice, ok, err := ui.Select(ctx, \"Pick an environment\", []string{\"staging\", \"production\"})\n\n// Text input — returns (text, ok bool, error)\nname, ok, err := ui.Input(ctx, \"Enter the release name\", &copilot.InputOptions{\n Title: \"Release Name\",\n Description: \"A short name for the release\",\n MinLength: copilot.Int(1),\n MaxLength: copilot.Int(50),\n})\n\n// Full custom elicitation with a schema\nresult, err := ui.Elicitation(ctx, \"Configure deployment\", rpc.RequestedSchema{\n Type: rpc.RequestedSchemaTypeObject,\n Properties: map[string]rpc.Property{\n \"target\": {Type: rpc.PropertyTypeString, Enum: []string{\"staging\", \"production\"}},\n \"force\": {Type: rpc.PropertyTypeBoolean},\n },\n Required: []string{\"target\"},\n})\n// result.Action is \"accept\", \"decline\", or \"cancel\"\n// result.Content has the form values when Action is \"accept\"\n```\n\n## Elicitation Requests (Server→Client)\n\nWhen the server (or an MCP tool) needs to ask the end-user a question, it sends an `elicitation.requested` event. Register a handler to respond:\n\n```go\nsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n OnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n OnElicitationRequest: func(ctx copilot.ElicitationContext) (copilot.ElicitationResult, error) {\n // ctx.SessionID — session that triggered the request\n // ctx.Message — what's being asked\n // ctx.RequestedSchema — form schema (if mode is \"form\")\n // ctx.Mode — \"form\" or \"url\"\n // ctx.ElicitationSource — e.g. MCP server name\n // ctx.URL — browser URL (if mode is \"url\")\n\n // Return the user's response\n return copilot.ElicitationResult{\n Action: \"accept\",\n Content: map[string]any{\"confirmed\": true},\n }, nil\n },\n})\n```\n\nWhen `OnElicitationRequest` is provided, the SDK automatically:\n\n- Sends `requestElicitation: true` in the create/resume payload\n- Routes `elicitation.requested` events to your handler\n- Auto-cancels the request if your handler returns an error (so the server doesn't hang)\n\n## Transport Modes\n\n### stdio (Default)\n\nCommunicates with CLI via stdin/stdout pipes. Recommended for most use cases.\n\n```go\nclient := copilot.NewClient(nil) // Uses stdio by default\n```\n\n### TCP\n\nCommunicates with CLI via TCP socket. Useful for distributed scenarios.\n\n## Environment Variables\n\n- `COPILOT_CLI_PATH` - Path to the Copilot CLI executable\n\n## License\n\nMIT\n" }, { "path": "go/client.go", "content": "// Package copilot provides a Go SDK for interacting with the GitHub Copilot CLI.\n//\n// The copilot package enables Go applications to communicate with the Copilot CLI\n// server, create and manage conversation sessions, and integrate custom tools.\n//\n// Basic usage:\n//\n//\tclient := copilot.NewClient(nil)\n//\tif err := client.Start(); err != nil {\n//\t log.Fatal(err)\n//\t}\n//\tdefer client.Stop()\n//\n//\tsession, err := client.CreateSession(&copilot.SessionConfig{\n//\t OnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n//\t Model: \"gpt-4\",\n//\t})\n//\tif err != nil {\n//\t log.Fatal(err)\n//\t}\n//\n//\tsession.On(func(event copilot.SessionEvent) {\n//\t if d, ok := event.Data.(*copilot.AssistantMessageData); ok {\n//\t fmt.Println(d.Content)\n//\t }\n//\t})\n//\n//\tsession.Send(copilot.MessageOptions{Prompt: \"Hello!\"})\npackage copilot\n\nimport (\n\t\"bufio\"\n\t\"context\"\n\t\"encoding/json\"\n\t\"errors\"\n\t\"fmt\"\n\t\"net\"\n\t\"os\"\n\t\"os/exec\"\n\t\"regexp\"\n\t\"strconv\"\n\t\"strings\"\n\t\"sync\"\n\t\"sync/atomic\"\n\t\"time\"\n\n\t\"github.com/google/uuid\"\n\n\t\"github.com/github/copilot-sdk/go/internal/embeddedcli\"\n\t\"github.com/github/copilot-sdk/go/internal/jsonrpc2\"\n\t\"github.com/github/copilot-sdk/go/rpc\"\n)\n\nconst noResultPermissionV2Error = \"permission handlers cannot return 'no-result' when connected to a protocol v2 server\"\n\nfunc validateSessionFsConfig(config *SessionFsConfig) error {\n\tif config == nil {\n\t\treturn nil\n\t}\n\tif config.InitialCwd == \"\" {\n\t\treturn errors.New(\"SessionFs.InitialCwd is required\")\n\t}\n\tif config.SessionStatePath == \"\" {\n\t\treturn errors.New(\"SessionFs.SessionStatePath is required\")\n\t}\n\tif config.Conventions != rpc.SessionFSSetProviderConventionsPosix && config.Conventions != rpc.SessionFSSetProviderConventionsWindows {\n\t\treturn errors.New(\"SessionFs.Conventions must be either 'posix' or 'windows'\")\n\t}\n\treturn nil\n}\n\n// Client manages the connection to the Copilot CLI server and provides session management.\n//\n// The Client can either spawn a CLI server process or connect to an existing server.\n// It handles JSON-RPC communication, session lifecycle, tool execution, and permission requests.\n//\n// Example:\n//\n//\t// Create a client with default options (spawns CLI server using stdio)\n//\tclient := copilot.NewClient(nil)\n//\n//\t// Or connect to an existing server\n//\tclient := copilot.NewClient(&copilot.ClientOptions{\n//\t CLIUrl: \"localhost:3000\",\n//\t})\n//\n//\tif err := client.Start(); err != nil {\n//\t log.Fatal(err)\n//\t}\n//\tdefer client.Stop()\ntype Client struct {\n\toptions ClientOptions\n\tprocess *exec.Cmd\n\tclient *jsonrpc2.Client\n\tactualPort int\n\tactualHost string\n\tstate ConnectionState\n\tsessions map[string]*Session\n\tsessionsMux sync.Mutex\n\tisExternalServer bool\n\tconn net.Conn // stores net.Conn for external TCP connections\n\tuseStdio bool // resolved value from options\n\tautoStart bool // resolved value from options\n\n\tmodelsCache []ModelInfo\n\tmodelsCacheMux sync.Mutex\n\tlifecycleHandlers map[uint64]SessionLifecycleHandler\n\ttypedLifecycleHandlers map[SessionLifecycleEventType]map[uint64]SessionLifecycleHandler\n\tnextLifecycleHandlerID uint64\n\tlifecycleHandlersMux sync.Mutex\n\tstartStopMux sync.RWMutex // protects process and state during start/[force]stop\n\tprocessDone chan struct{}\n\tprocessErrorPtr *error\n\tosProcess atomic.Pointer[os.Process]\n\tnegotiatedProtocolVersion int\n\tonListModels func(ctx context.Context) ([]ModelInfo, error)\n\n\t// RPC provides typed server-scoped RPC methods.\n\t// This field is nil until the client is connected via Start().\n\tRPC *rpc.ServerRpc\n}\n\n// NewClient creates a new Copilot CLI client with the given options.\n//\n// If options is nil, default options are used (spawns CLI server using stdio).\n// The client is not connected after creation; call [Client.Start] to connect.\n//\n// Example:\n//\n//\t// Default options\n//\tclient := copilot.NewClient(nil)\n//\n//\t// Custom options\n//\tclient := copilot.NewClient(&copilot.ClientOptions{\n//\t CLIPath: \"/usr/local/bin/copilot\",\n//\t LogLevel: \"debug\",\n//\t})\nfunc NewClient(options *ClientOptions) *Client {\n\topts := ClientOptions{\n\t\tCLIPath: \"\",\n\t\tCwd: \"\",\n\t\tPort: 0,\n\t\tLogLevel: \"info\",\n\t}\n\n\tclient := &Client{\n\t\toptions: opts,\n\t\tstate: StateDisconnected,\n\t\tsessions: make(map[string]*Session),\n\t\tactualHost: \"localhost\",\n\t\tisExternalServer: false,\n\t\tuseStdio: true,\n\t\tautoStart: true, // default\n\t}\n\n\tif options != nil {\n\t\t// Validate mutually exclusive options\n\t\tif options.CLIUrl != \"\" && ((options.UseStdio != nil) || options.CLIPath != \"\") {\n\t\t\tpanic(\"CLIUrl is mutually exclusive with UseStdio and CLIPath\")\n\t\t}\n\n\t\t// Validate auth options with external server\n\t\tif options.CLIUrl != \"\" && (options.GitHubToken != \"\" || options.UseLoggedInUser != nil) {\n\t\t\tpanic(\"GitHubToken and UseLoggedInUser cannot be used with CLIUrl (external server manages its own auth)\")\n\t\t}\n\n\t\t// Parse CLIUrl if provided\n\t\tif options.CLIUrl != \"\" {\n\t\t\thost, port := parseCliUrl(options.CLIUrl)\n\t\t\tclient.actualHost = host\n\t\t\tclient.actualPort = port\n\t\t\tclient.isExternalServer = true\n\t\t\tclient.useStdio = false\n\t\t\topts.CLIUrl = options.CLIUrl\n\t\t}\n\n\t\tif options.CLIPath != \"\" {\n\t\t\topts.CLIPath = options.CLIPath\n\t\t}\n\t\tif len(options.CLIArgs) > 0 {\n\t\t\topts.CLIArgs = append([]string{}, options.CLIArgs...)\n\t\t}\n\t\tif options.Cwd != \"\" {\n\t\t\topts.Cwd = options.Cwd\n\t\t}\n\t\tif options.Port > 0 {\n\t\t\topts.Port = options.Port\n\t\t\t// If port is specified, switch to TCP mode\n\t\t\tclient.useStdio = false\n\t\t}\n\t\tif options.LogLevel != \"\" {\n\t\t\topts.LogLevel = options.LogLevel\n\t\t}\n\t\tif options.Env != nil {\n\t\t\topts.Env = options.Env\n\t\t}\n\t\tif options.UseStdio != nil {\n\t\t\tclient.useStdio = *options.UseStdio\n\t\t}\n\t\tif options.AutoStart != nil {\n\t\t\tclient.autoStart = *options.AutoStart\n\t\t}\n\t\tif options.GitHubToken != \"\" {\n\t\t\topts.GitHubToken = options.GitHubToken\n\t\t}\n\t\tif options.UseLoggedInUser != nil {\n\t\t\topts.UseLoggedInUser = options.UseLoggedInUser\n\t\t}\n\t\tif options.OnListModels != nil {\n\t\t\tclient.onListModels = options.OnListModels\n\t\t}\n\t\tif options.SessionFs != nil {\n\t\t\tif err := validateSessionFsConfig(options.SessionFs); err != nil {\n\t\t\t\tpanic(err.Error())\n\t\t\t}\n\t\t\tsessionFs := *options.SessionFs\n\t\t\topts.SessionFs = &sessionFs\n\t\t}\n\t\tif options.Telemetry != nil {\n\t\t\topts.Telemetry = options.Telemetry\n\t\t}\n\t\topts.SessionIdleTimeoutSeconds = options.SessionIdleTimeoutSeconds\n\t}\n\n\t// Default Env to current environment if not set\n\tif opts.Env == nil {\n\t\topts.Env = os.Environ()\n\t}\n\n\t// Check effective environment for CLI path (only if not explicitly set via options)\n\tif opts.CLIPath == \"\" {\n\t\tif cliPath := getEnvValue(opts.Env, \"COPILOT_CLI_PATH\"); cliPath != \"\" {\n\t\t\topts.CLIPath = cliPath\n\t\t}\n\t}\n\n\tclient.options = opts\n\treturn client\n}\n\n// getEnvValue looks up a key in an environment slice ([]string of \"KEY=VALUE\").\n// Returns the value if found, or empty string otherwise.\nfunc getEnvValue(env []string, key string) string {\n\tprefix := key + \"=\"\n\tfor i := len(env) - 1; i >= 0; i-- {\n\t\tif strings.HasPrefix(env[i], prefix) {\n\t\t\treturn env[i][len(prefix):]\n\t\t}\n\t}\n\treturn \"\"\n}\n\n// parseCliUrl parses a CLI URL into host and port components.\n//\n// Supports formats: \"host:port\", \"http://host:port\", \"https://host:port\", or just \"port\".\n// Panics if the URL format is invalid or the port is out of range.\nfunc parseCliUrl(url string) (string, int) {\n\t// Remove protocol if present\n\tcleanUrl, _ := strings.CutPrefix(url, \"https://\")\n\tcleanUrl, _ = strings.CutPrefix(cleanUrl, \"http://\")\n\n\t// Parse host:port or port format\n\tvar host string\n\tvar portStr string\n\tif before, after, found := strings.Cut(cleanUrl, \":\"); found {\n\t\thost = before\n\t\tportStr = after\n\t} else {\n\t\t// Only port provided\n\t\tportStr = before\n\t}\n\n\tif host == \"\" {\n\t\thost = \"localhost\"\n\t}\n\n\t// Validate port\n\tport, err := strconv.Atoi(portStr)\n\tif err != nil || port <= 0 || port > 65535 {\n\t\tpanic(fmt.Sprintf(\"Invalid port in CLIUrl: %s\", url))\n\t}\n\n\treturn host, port\n}\n\n// Start starts the CLI server (if not using an external server) and establishes\n// a connection.\n//\n// If connecting to an external server (via CLIUrl), only establishes the connection.\n// Otherwise, spawns the CLI server process and then connects.\n//\n// This method is called automatically when creating a session if AutoStart is true (default).\n//\n// Returns an error if the server fails to start or the connection fails.\n//\n// Example:\n//\n//\tclient := copilot.NewClient(&copilot.ClientOptions{AutoStart: boolPtr(false)})\n//\tif err := client.Start(context.Background()); err != nil {\n//\t log.Fatal(\"Failed to start:\", err)\n//\t}\n//\t// Now ready to create sessions\nfunc (c *Client) Start(ctx context.Context) error {\n\tc.startStopMux.Lock()\n\tdefer c.startStopMux.Unlock()\n\n\tif c.state == StateConnected {\n\t\treturn nil\n\t}\n\n\tc.state = StateConnecting\n\n\t// Only start CLI server process if not connecting to external server\n\tif !c.isExternalServer {\n\t\tif err := c.startCLIServer(ctx); err != nil {\n\t\t\tc.process = nil\n\t\t\tc.state = StateError\n\t\t\treturn err\n\t\t}\n\t}\n\n\t// Connect to the server\n\tif err := c.connectToServer(ctx); err != nil {\n\t\tkillErr := c.killProcess()\n\t\tc.state = StateError\n\t\treturn errors.Join(err, killErr)\n\t}\n\n\t// Verify protocol version compatibility\n\tif err := c.verifyProtocolVersion(ctx); err != nil {\n\t\tkillErr := c.killProcess()\n\t\tc.state = StateError\n\t\treturn errors.Join(err, killErr)\n\t}\n\n\t// If a session filesystem provider was configured, register it.\n\tif c.options.SessionFs != nil {\n\t\t_, err := c.RPC.SessionFs.SetProvider(ctx, &rpc.SessionFSSetProviderRequest{\n\t\t\tInitialCwd: c.options.SessionFs.InitialCwd,\n\t\t\tSessionStatePath: c.options.SessionFs.SessionStatePath,\n\t\t\tConventions: c.options.SessionFs.Conventions,\n\t\t})\n\t\tif err != nil {\n\t\t\tkillErr := c.killProcess()\n\t\t\tc.state = StateError\n\t\t\treturn errors.Join(err, killErr)\n\t\t}\n\t}\n\n\tc.state = StateConnected\n\treturn nil\n}\n\n// Stop stops the CLI server and closes all active sessions.\n//\n// This method performs graceful cleanup:\n// 1. Closes all active sessions (releases in-memory resources)\n// 2. Closes the JSON-RPC connection\n// 3. Terminates the CLI server process (if spawned by this client)\n//\n// Note: session data on disk is preserved, so sessions can be resumed later.\n// To permanently remove session data before stopping, call [Client.DeleteSession]\n// for each session first.\n//\n// Returns an error that aggregates all errors encountered during cleanup.\n//\n// Example:\n//\n//\tif err := client.Stop(); err != nil {\n//\t log.Printf(\"Cleanup error: %v\", err)\n//\t}\nfunc (c *Client) Stop() error {\n\tvar errs []error\n\n\t// Disconnect all active sessions\n\tc.sessionsMux.Lock()\n\tsessions := make([]*Session, 0, len(c.sessions))\n\tfor _, session := range c.sessions {\n\t\tsessions = append(sessions, session)\n\t}\n\tc.sessionsMux.Unlock()\n\n\tfor _, session := range sessions {\n\t\tif err := session.Disconnect(); err != nil {\n\t\t\terrs = append(errs, fmt.Errorf(\"failed to disconnect session %s: %w\", session.SessionID, err))\n\t\t}\n\t}\n\n\tc.sessionsMux.Lock()\n\tc.sessions = make(map[string]*Session)\n\tc.sessionsMux.Unlock()\n\n\tc.startStopMux.Lock()\n\tdefer c.startStopMux.Unlock()\n\n\t// Kill CLI process FIRST (this closes stdout and unblocks readLoop) - only if we spawned it\n\tif c.process != nil && !c.isExternalServer {\n\t\tif err := c.killProcess(); err != nil {\n\t\t\terrs = append(errs, err)\n\t\t}\n\t}\n\tc.process = nil\n\n\t// Close external TCP connection if exists\n\tif c.isExternalServer && c.conn != nil {\n\t\tif err := c.conn.Close(); err != nil {\n\t\t\terrs = append(errs, fmt.Errorf(\"failed to close socket: %w\", err))\n\t\t}\n\t\tc.conn = nil\n\t}\n\n\t// Then close JSON-RPC client (readLoop can now exit)\n\tif c.client != nil {\n\t\tc.client.Stop()\n\t\tc.client = nil\n\t}\n\n\t// Clear models cache\n\tc.modelsCacheMux.Lock()\n\tc.modelsCache = nil\n\tc.modelsCacheMux.Unlock()\n\n\tc.state = StateDisconnected\n\tif !c.isExternalServer {\n\t\tc.actualPort = 0\n\t}\n\n\tc.RPC = nil\n\treturn errors.Join(errs...)\n}\n\n// ForceStop forcefully stops the CLI server without graceful cleanup.\n//\n// Use this when [Client.Stop] fails or takes too long. This method:\n// - Clears all sessions immediately without destroying them\n// - Force closes the connection\n// - Kills the CLI process (if spawned by this client)\n//\n// Example:\n//\n//\t// If normal stop hangs, force stop\n//\tdone := make(chan struct{})\n//\tgo func() {\n//\t client.Stop()\n//\t close(done)\n//\t}()\n//\n//\tselect {\n//\tcase <-done:\n//\t // Stopped successfully\n//\tcase <-time.After(5 * time.Second):\n//\t client.ForceStop()\n//\t}\nfunc (c *Client) ForceStop() {\n\t// Kill the process without waiting for startStopMux, which Start may hold.\n\t// This unblocks any I/O Start is doing (connect, version check).\n\tif p := c.osProcess.Swap(nil); p != nil {\n\t\tp.Kill()\n\t}\n\n\t// Clear sessions immediately without trying to destroy them\n\tc.sessionsMux.Lock()\n\tc.sessions = make(map[string]*Session)\n\tc.sessionsMux.Unlock()\n\n\tc.startStopMux.Lock()\n\tdefer c.startStopMux.Unlock()\n\n\t// Kill CLI process (only if we spawned it)\n\t// This is a fallback in case the process wasn't killed above (e.g. if Start hadn't set\n\t// osProcess yet), or if the process was restarted and osProcess now points to a new process.\n\tif c.process != nil && !c.isExternalServer {\n\t\t_ = c.killProcess() // Ignore errors since we're force stopping\n\t}\n\tc.process = nil\n\n\t// Close external TCP connection if exists\n\tif c.isExternalServer && c.conn != nil {\n\t\t_ = c.conn.Close() // Ignore errors\n\t\tc.conn = nil\n\t}\n\n\t// Close JSON-RPC client\n\tif c.client != nil {\n\t\tc.client.Stop()\n\t\tc.client = nil\n\t}\n\n\t// Clear models cache\n\tc.modelsCacheMux.Lock()\n\tc.modelsCache = nil\n\tc.modelsCacheMux.Unlock()\n\n\tc.state = StateDisconnected\n\tif !c.isExternalServer {\n\t\tc.actualPort = 0\n\t}\n\n\tc.RPC = nil\n}\n\nfunc (c *Client) ensureConnected(ctx context.Context) error {\n\tif c.client != nil {\n\t\treturn nil\n\t}\n\tif c.autoStart {\n\t\treturn c.Start(ctx)\n\t}\n\treturn fmt.Errorf(\"client not connected. Call Start() first\")\n}\n\n// CreateSession creates a new conversation session with the Copilot CLI.\n//\n// Sessions maintain conversation state, handle events, and manage tool execution.\n// If the client is not connected and AutoStart is enabled, this will automatically\n// start the connection.\n//\n// The config parameter is required and must include an OnPermissionRequest handler.\n//\n// Returns the created session or an error if session creation fails.\n//\n// Example:\n//\n//\t// Basic session\n//\tsession, err := client.CreateSession(context.Background(), &copilot.SessionConfig{\n//\t OnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n//\t})\n//\n//\t// Session with model and tools\n//\tsession, err := client.CreateSession(context.Background(), &copilot.SessionConfig{\n//\t OnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n//\t Model: \"gpt-4\",\n//\t Tools: []copilot.Tool{\n//\t {\n//\t Name: \"get_weather\",\n//\t Description: \"Get weather for a location\",\n//\t Handler: weatherHandler,\n//\t },\n//\t },\n//\t})\n//\n// extractTransformCallbacks separates transform callbacks from a SystemMessageConfig,\n// returning a wire-safe config and a map of callbacks (nil if none).\nfunc extractTransformCallbacks(config *SystemMessageConfig) (*SystemMessageConfig, map[string]SectionTransformFn) {\n\tif config == nil || config.Mode != \"customize\" || len(config.Sections) == 0 {\n\t\treturn config, nil\n\t}\n\n\tcallbacks := make(map[string]SectionTransformFn)\n\twireSections := make(map[string]SectionOverride)\n\tfor id, override := range config.Sections {\n\t\tif override.Transform != nil {\n\t\t\tcallbacks[id] = override.Transform\n\t\t\twireSections[id] = SectionOverride{Action: \"transform\"}\n\t\t} else {\n\t\t\twireSections[id] = override\n\t\t}\n\t}\n\n\tif len(callbacks) == 0 {\n\t\treturn config, nil\n\t}\n\n\twireConfig := &SystemMessageConfig{\n\t\tMode: config.Mode,\n\t\tContent: config.Content,\n\t\tSections: wireSections,\n\t}\n\treturn wireConfig, callbacks\n}\n\nfunc (c *Client) CreateSession(ctx context.Context, config *SessionConfig) (*Session, error) {\n\tif config == nil || config.OnPermissionRequest == nil {\n\t\treturn nil, fmt.Errorf(\"an OnPermissionRequest handler is required when creating a session. For example, to allow all permissions, use &copilot.SessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll}\")\n\t}\n\n\tif err := c.ensureConnected(ctx); err != nil {\n\t\treturn nil, err\n\t}\n\n\treq := createSessionRequest{}\n\treq.Model = config.Model\n\treq.ClientName = config.ClientName\n\treq.ReasoningEffort = config.ReasoningEffort\n\treq.ConfigDir = config.ConfigDir\n\tif config.EnableConfigDiscovery {\n\t\treq.EnableConfigDiscovery = Bool(true)\n\t}\n\treq.Tools = config.Tools\n\twireSystemMessage, transformCallbacks := extractTransformCallbacks(config.SystemMessage)\n\treq.SystemMessage = wireSystemMessage\n\treq.AvailableTools = config.AvailableTools\n\treq.ExcludedTools = config.ExcludedTools\n\treq.Provider = config.Provider\n\treq.ModelCapabilities = config.ModelCapabilities\n\treq.WorkingDirectory = config.WorkingDirectory\n\treq.MCPServers = config.MCPServers\n\treq.EnvValueMode = \"direct\"\n\treq.CustomAgents = config.CustomAgents\n\treq.DefaultAgent = config.DefaultAgent\n\treq.Agent = config.Agent\n\treq.SkillDirectories = config.SkillDirectories\n\treq.DisabledSkills = config.DisabledSkills\n\treq.InfiniteSessions = config.InfiniteSessions\n\treq.GitHubToken = config.GitHubToken\n\n\tif len(config.Commands) > 0 {\n\t\tcmds := make([]wireCommand, 0, len(config.Commands))\n\t\tfor _, cmd := range config.Commands {\n\t\t\tcmds = append(cmds, wireCommand{Name: cmd.Name, Description: cmd.Description})\n\t\t}\n\t\treq.Commands = cmds\n\t}\n\tif config.OnElicitationRequest != nil {\n\t\treq.RequestElicitation = Bool(true)\n\t}\n\n\tif config.Streaming {\n\t\treq.Streaming = Bool(true)\n\t}\n\tif config.IncludeSubAgentStreamingEvents != nil {\n\t\treq.IncludeSubAgentStreamingEvents = config.IncludeSubAgentStreamingEvents\n\t} else {\n\t\treq.IncludeSubAgentStreamingEvents = Bool(true)\n\t}\n\tif config.OnUserInputRequest != nil {\n\t\treq.RequestUserInput = Bool(true)\n\t}\n\tif config.Hooks != nil && (config.Hooks.OnPreToolUse != nil ||\n\t\tconfig.Hooks.OnPostToolUse != nil ||\n\t\tconfig.Hooks.OnUserPromptSubmitted != nil ||\n\t\tconfig.Hooks.OnSessionStart != nil ||\n\t\tconfig.Hooks.OnSessionEnd != nil ||\n\t\tconfig.Hooks.OnErrorOccurred != nil) {\n\t\treq.Hooks = Bool(true)\n\t}\n\treq.RequestPermission = Bool(true)\n\n\ttraceparent, tracestate := getTraceContext(ctx)\n\treq.Traceparent = traceparent\n\treq.Tracestate = tracestate\n\n\tsessionID := config.SessionID\n\tif sessionID == \"\" {\n\t\tsessionID = uuid.New().String()\n\t}\n\treq.SessionID = sessionID\n\n\t// Create and register the session before issuing the RPC so that\n\t// events emitted by the CLI (e.g. session.start) are not dropped.\n\tsession := newSession(sessionID, c.client, \"\")\n\n\tsession.registerTools(config.Tools)\n\tsession.registerPermissionHandler(config.OnPermissionRequest)\n\tif config.OnUserInputRequest != nil {\n\t\tsession.registerUserInputHandler(config.OnUserInputRequest)\n\t}\n\tif config.Hooks != nil {\n\t\tsession.registerHooks(config.Hooks)\n\t}\n\tif transformCallbacks != nil {\n\t\tsession.registerTransformCallbacks(transformCallbacks)\n\t}\n\tif config.OnEvent != nil {\n\t\tsession.On(config.OnEvent)\n\t}\n\tif len(config.Commands) > 0 {\n\t\tsession.registerCommands(config.Commands)\n\t}\n\tif config.OnElicitationRequest != nil {\n\t\tsession.registerElicitationHandler(config.OnElicitationRequest)\n\t}\n\n\tc.sessionsMux.Lock()\n\tc.sessions[sessionID] = session\n\tc.sessionsMux.Unlock()\n\n\tif c.options.SessionFs != nil {\n\t\tif config.CreateSessionFsHandler == nil {\n\t\t\tc.sessionsMux.Lock()\n\t\t\tdelete(c.sessions, sessionID)\n\t\t\tc.sessionsMux.Unlock()\n\t\t\treturn nil, fmt.Errorf(\"CreateSessionFsHandler is required in session config when SessionFs is enabled in client options\")\n\t\t}\n\t\tsession.clientSessionApis.SessionFs = newSessionFsAdapter(config.CreateSessionFsHandler(session))\n\t}\n\n\tresult, err := c.client.Request(\"session.create\", req)\n\tif err != nil {\n\t\tc.sessionsMux.Lock()\n\t\tdelete(c.sessions, sessionID)\n\t\tc.sessionsMux.Unlock()\n\t\treturn nil, fmt.Errorf(\"failed to create session: %w\", err)\n\t}\n\n\tvar response createSessionResponse\n\tif err := json.Unmarshal(result, &response); err != nil {\n\t\tc.sessionsMux.Lock()\n\t\tdelete(c.sessions, sessionID)\n\t\tc.sessionsMux.Unlock()\n\t\treturn nil, fmt.Errorf(\"failed to unmarshal response: %w\", err)\n\t}\n\n\tsession.workspacePath = response.WorkspacePath\n\tsession.setCapabilities(response.Capabilities)\n\n\treturn session, nil\n}\n\n// ResumeSession resumes an existing conversation session by its ID.\n//\n// This is a convenience method that calls [Client.ResumeSessionWithOptions].\n// The config must include an OnPermissionRequest handler.\n//\n// Example:\n//\n//\tsession, err := client.ResumeSession(context.Background(), \"session-123\", &copilot.ResumeSessionConfig{\n//\t OnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n//\t})\nfunc (c *Client) ResumeSession(ctx context.Context, sessionID string, config *ResumeSessionConfig) (*Session, error) {\n\treturn c.ResumeSessionWithOptions(ctx, sessionID, config)\n}\n\n// ResumeSessionWithOptions resumes an existing conversation session with additional configuration.\n//\n// This allows you to continue a previous conversation, maintaining all conversation history.\n// The session must have been previously created and not deleted.\n//\n// Example:\n//\n//\tsession, err := client.ResumeSessionWithOptions(context.Background(), \"session-123\", &copilot.ResumeSessionConfig{\n//\t OnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n//\t Tools: []copilot.Tool{myNewTool},\n//\t})\nfunc (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, config *ResumeSessionConfig) (*Session, error) {\n\tif config == nil || config.OnPermissionRequest == nil {\n\t\treturn nil, fmt.Errorf(\"an OnPermissionRequest handler is required when resuming a session. For example, to allow all permissions, use &copilot.ResumeSessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll}\")\n\t}\n\n\tif err := c.ensureConnected(ctx); err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar req resumeSessionRequest\n\treq.SessionID = sessionID\n\treq.ClientName = config.ClientName\n\treq.Model = config.Model\n\treq.ReasoningEffort = config.ReasoningEffort\n\twireSystemMessage, transformCallbacks := extractTransformCallbacks(config.SystemMessage)\n\treq.SystemMessage = wireSystemMessage\n\treq.Tools = config.Tools\n\treq.Provider = config.Provider\n\treq.ModelCapabilities = config.ModelCapabilities\n\treq.AvailableTools = config.AvailableTools\n\treq.ExcludedTools = config.ExcludedTools\n\tif config.Streaming {\n\t\treq.Streaming = Bool(true)\n\t}\n\tif config.IncludeSubAgentStreamingEvents != nil {\n\t\treq.IncludeSubAgentStreamingEvents = config.IncludeSubAgentStreamingEvents\n\t} else {\n\t\treq.IncludeSubAgentStreamingEvents = Bool(true)\n\t}\n\tif config.OnUserInputRequest != nil {\n\t\treq.RequestUserInput = Bool(true)\n\t}\n\tif config.Hooks != nil && (config.Hooks.OnPreToolUse != nil ||\n\t\tconfig.Hooks.OnPostToolUse != nil ||\n\t\tconfig.Hooks.OnUserPromptSubmitted != nil ||\n\t\tconfig.Hooks.OnSessionStart != nil ||\n\t\tconfig.Hooks.OnSessionEnd != nil ||\n\t\tconfig.Hooks.OnErrorOccurred != nil) {\n\t\treq.Hooks = Bool(true)\n\t}\n\treq.WorkingDirectory = config.WorkingDirectory\n\treq.ConfigDir = config.ConfigDir\n\tif config.EnableConfigDiscovery {\n\t\treq.EnableConfigDiscovery = Bool(true)\n\t}\n\tif config.DisableResume {\n\t\treq.DisableResume = Bool(true)\n\t}\n\tif config.ContinuePendingWork {\n\t\treq.ContinuePendingWork = Bool(true)\n\t}\n\treq.MCPServers = config.MCPServers\n\treq.EnvValueMode = \"direct\"\n\treq.CustomAgents = config.CustomAgents\n\treq.DefaultAgent = config.DefaultAgent\n\treq.Agent = config.Agent\n\treq.SkillDirectories = config.SkillDirectories\n\treq.DisabledSkills = config.DisabledSkills\n\treq.InfiniteSessions = config.InfiniteSessions\n\treq.GitHubToken = config.GitHubToken\n\treq.RequestPermission = Bool(true)\n\n\tif len(config.Commands) > 0 {\n\t\tcmds := make([]wireCommand, 0, len(config.Commands))\n\t\tfor _, cmd := range config.Commands {\n\t\t\tcmds = append(cmds, wireCommand{Name: cmd.Name, Description: cmd.Description})\n\t\t}\n\t\treq.Commands = cmds\n\t}\n\tif config.OnElicitationRequest != nil {\n\t\treq.RequestElicitation = Bool(true)\n\t}\n\n\ttraceparent, tracestate := getTraceContext(ctx)\n\treq.Traceparent = traceparent\n\treq.Tracestate = tracestate\n\n\t// Create and register the session before issuing the RPC so that\n\t// events emitted by the CLI (e.g. session.start) are not dropped.\n\tsession := newSession(sessionID, c.client, \"\")\n\n\tsession.registerTools(config.Tools)\n\tsession.registerPermissionHandler(config.OnPermissionRequest)\n\tif config.OnUserInputRequest != nil {\n\t\tsession.registerUserInputHandler(config.OnUserInputRequest)\n\t}\n\tif config.Hooks != nil {\n\t\tsession.registerHooks(config.Hooks)\n\t}\n\tif transformCallbacks != nil {\n\t\tsession.registerTransformCallbacks(transformCallbacks)\n\t}\n\tif config.OnEvent != nil {\n\t\tsession.On(config.OnEvent)\n\t}\n\tif len(config.Commands) > 0 {\n\t\tsession.registerCommands(config.Commands)\n\t}\n\tif config.OnElicitationRequest != nil {\n\t\tsession.registerElicitationHandler(config.OnElicitationRequest)\n\t}\n\n\tc.sessionsMux.Lock()\n\tc.sessions[sessionID] = session\n\tc.sessionsMux.Unlock()\n\n\tif c.options.SessionFs != nil {\n\t\tif config.CreateSessionFsHandler == nil {\n\t\t\tc.sessionsMux.Lock()\n\t\t\tdelete(c.sessions, sessionID)\n\t\t\tc.sessionsMux.Unlock()\n\t\t\treturn nil, fmt.Errorf(\"CreateSessionFsHandler is required in session config when SessionFs is enabled in client options\")\n\t\t}\n\t\tsession.clientSessionApis.SessionFs = newSessionFsAdapter(config.CreateSessionFsHandler(session))\n\t}\n\n\tresult, err := c.client.Request(\"session.resume\", req)\n\tif err != nil {\n\t\tc.sessionsMux.Lock()\n\t\tdelete(c.sessions, sessionID)\n\t\tc.sessionsMux.Unlock()\n\t\treturn nil, fmt.Errorf(\"failed to resume session: %w\", err)\n\t}\n\n\tvar response resumeSessionResponse\n\tif err := json.Unmarshal(result, &response); err != nil {\n\t\tc.sessionsMux.Lock()\n\t\tdelete(c.sessions, sessionID)\n\t\tc.sessionsMux.Unlock()\n\t\treturn nil, fmt.Errorf(\"failed to unmarshal response: %w\", err)\n\t}\n\n\tsession.workspacePath = response.WorkspacePath\n\tsession.setCapabilities(response.Capabilities)\n\n\treturn session, nil\n}\n\n// ListSessions returns metadata about all sessions known to the server.\n//\n// Returns a list of SessionMetadata for all available sessions, including their IDs,\n// timestamps, optional summaries, and context information.\n//\n// An optional filter can be provided to filter sessions by cwd, git root, repository, or branch.\n//\n// Example:\n//\n//\tsessions, err := client.ListSessions(context.Background(), nil)\n//\tif err != nil {\n//\t log.Fatal(err)\n//\t}\n//\tfor _, session := range sessions {\n//\t fmt.Printf(\"Session: %s\\n\", session.SessionID)\n//\t}\n//\n// Example with filter:\n//\n//\tsessions, err := client.ListSessions(context.Background(), &SessionListFilter{Repository: \"owner/repo\"})\nfunc (c *Client) ListSessions(ctx context.Context, filter *SessionListFilter) ([]SessionMetadata, error) {\n\tif err := c.ensureConnected(ctx); err != nil {\n\t\treturn nil, err\n\t}\n\n\tparams := listSessionsRequest{}\n\tif filter != nil {\n\t\tparams.Filter = filter\n\t}\n\tresult, err := c.client.Request(\"session.list\", params)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar response listSessionsResponse\n\tif err := json.Unmarshal(result, &response); err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to unmarshal sessions response: %w\", err)\n\t}\n\n\treturn response.Sessions, nil\n}\n\n// GetSessionMetadata returns metadata for a specific session by ID.\n//\n// This provides an efficient O(1) lookup of a single session's metadata\n// instead of listing all sessions. Returns nil if the session is not found.\n//\n// Example:\n//\n//\tmetadata, err := client.GetSessionMetadata(context.Background(), \"session-123\")\n//\tif err != nil {\n//\t log.Fatal(err)\n//\t}\n//\tif metadata != nil {\n//\t fmt.Printf(\"Session started at: %s\\n\", metadata.StartTime)\n//\t}\nfunc (c *Client) GetSessionMetadata(ctx context.Context, sessionID string) (*SessionMetadata, error) {\n\tif err := c.ensureConnected(ctx); err != nil {\n\t\treturn nil, err\n\t}\n\n\tresult, err := c.client.Request(\"session.getMetadata\", getSessionMetadataRequest{SessionID: sessionID})\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar response getSessionMetadataResponse\n\tif err := json.Unmarshal(result, &response); err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to unmarshal session metadata response: %w\", err)\n\t}\n\n\treturn response.Session, nil\n}\n\n// DeleteSession permanently deletes a session and all its data from disk,\n// including conversation history, planning state, and artifacts.\n//\n// Unlike [Session.Disconnect], which only releases in-memory resources and\n// preserves session data for later resumption, DeleteSession is irreversible.\n// The session cannot be resumed after deletion. If the session is in the local\n// sessions map, it will be removed.\n//\n// Example:\n//\n//\tif err := client.DeleteSession(context.Background(), \"session-123\"); err != nil {\n//\t log.Fatal(err)\n//\t}\nfunc (c *Client) DeleteSession(ctx context.Context, sessionID string) error {\n\tif err := c.ensureConnected(ctx); err != nil {\n\t\treturn err\n\t}\n\n\tresult, err := c.client.Request(\"session.delete\", deleteSessionRequest{SessionID: sessionID})\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tvar response deleteSessionResponse\n\tif err := json.Unmarshal(result, &response); err != nil {\n\t\treturn fmt.Errorf(\"failed to unmarshal delete response: %w\", err)\n\t}\n\n\tif !response.Success {\n\t\terrorMsg := \"unknown error\"\n\t\tif response.Error != nil {\n\t\t\terrorMsg = *response.Error\n\t\t}\n\t\treturn fmt.Errorf(\"failed to delete session %s: %s\", sessionID, errorMsg)\n\t}\n\n\t// Remove from local sessions map if present\n\tc.sessionsMux.Lock()\n\tdelete(c.sessions, sessionID)\n\tc.sessionsMux.Unlock()\n\n\treturn nil\n}\n\n// GetLastSessionID returns the ID of the most recently updated session.\n//\n// This is useful for resuming the last conversation when the session ID\n// was not stored. Returns nil if no sessions exist.\n//\n// Example:\n//\n//\tlastID, err := client.GetLastSessionID(context.Background())\n//\tif err != nil {\n//\t log.Fatal(err)\n//\t}\n//\tif lastID != nil {\n//\t session, err := client.ResumeSession(context.Background(), *lastID, &copilot.ResumeSessionConfig{\n//\t OnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n//\t })\n//\t}\nfunc (c *Client) GetLastSessionID(ctx context.Context) (*string, error) {\n\tif err := c.ensureConnected(ctx); err != nil {\n\t\treturn nil, err\n\t}\n\n\tresult, err := c.client.Request(\"session.getLastId\", getLastSessionIDRequest{})\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar response getLastSessionIDResponse\n\tif err := json.Unmarshal(result, &response); err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to unmarshal getLastId response: %w\", err)\n\t}\n\n\treturn response.SessionID, nil\n}\n\n// GetForegroundSessionID returns the ID of the session currently displayed in the TUI.\n//\n// This is only available when connecting to a server running in TUI+server mode\n// (--ui-server). Returns nil if no foreground session is set.\n//\n// Example:\n//\n//\tsessionID, err := client.GetForegroundSessionID()\n//\tif err != nil {\n//\t log.Fatal(err)\n//\t}\n//\tif sessionID != nil {\n//\t fmt.Printf(\"TUI is displaying session: %s\\n\", *sessionID)\n//\t}\nfunc (c *Client) GetForegroundSessionID(ctx context.Context) (*string, error) {\n\tif err := c.ensureConnected(ctx); err != nil {\n\t\treturn nil, err\n\t}\n\n\tresult, err := c.client.Request(\"session.getForeground\", getForegroundSessionRequest{})\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar response getForegroundSessionResponse\n\tif err := json.Unmarshal(result, &response); err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to unmarshal getForeground response: %w\", err)\n\t}\n\n\treturn response.SessionID, nil\n}\n\n// SetForegroundSessionID requests the TUI to switch to displaying the specified session.\n//\n// This is only available when connecting to a server running in TUI+server mode\n// (--ui-server).\n//\n// Example:\n//\n//\tif err := client.SetForegroundSessionID(\"session-123\"); err != nil {\n//\t log.Fatal(err)\n//\t}\nfunc (c *Client) SetForegroundSessionID(ctx context.Context, sessionID string) error {\n\tif err := c.ensureConnected(ctx); err != nil {\n\t\treturn err\n\t}\n\n\tresult, err := c.client.Request(\"session.setForeground\", setForegroundSessionRequest{SessionID: sessionID})\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tvar response setForegroundSessionResponse\n\tif err := json.Unmarshal(result, &response); err != nil {\n\t\treturn fmt.Errorf(\"failed to unmarshal setForeground response: %w\", err)\n\t}\n\n\tif !response.Success {\n\t\terrorMsg := \"unknown error\"\n\t\tif response.Error != nil {\n\t\t\terrorMsg = *response.Error\n\t\t}\n\t\treturn fmt.Errorf(\"failed to set foreground session: %s\", errorMsg)\n\t}\n\n\treturn nil\n}\n\n// On subscribes to all session lifecycle events.\n//\n// Lifecycle events are emitted when sessions are created, deleted, updated,\n// or change foreground/background state (in TUI+server mode).\n//\n// Returns a function that, when called, unsubscribes the handler.\n//\n// Example:\n//\n//\tunsubscribe := client.On(func(event copilot.SessionLifecycleEvent) {\n//\t fmt.Printf(\"Session %s: %s\\n\", event.SessionID, event.Type)\n//\t})\n//\tdefer unsubscribe()\nfunc (c *Client) On(handler SessionLifecycleHandler) func() {\n\tc.lifecycleHandlersMux.Lock()\n\tif c.lifecycleHandlers == nil {\n\t\tc.lifecycleHandlers = make(map[uint64]SessionLifecycleHandler)\n\t}\n\tc.nextLifecycleHandlerID++\n\tid := c.nextLifecycleHandlerID\n\tc.lifecycleHandlers[id] = handler\n\tc.lifecycleHandlersMux.Unlock()\n\n\treturn func() {\n\t\tc.lifecycleHandlersMux.Lock()\n\t\tdefer c.lifecycleHandlersMux.Unlock()\n\t\tdelete(c.lifecycleHandlers, id)\n\t}\n}\n\n// OnEventType subscribes to a specific session lifecycle event type.\n//\n// Returns a function that, when called, unsubscribes the handler.\n//\n// Example:\n//\n//\tunsubscribe := client.OnEventType(copilot.SessionLifecycleForeground, func(event copilot.SessionLifecycleEvent) {\n//\t fmt.Printf(\"Session %s is now in foreground\\n\", event.SessionID)\n//\t})\n//\tdefer unsubscribe()\nfunc (c *Client) OnEventType(eventType SessionLifecycleEventType, handler SessionLifecycleHandler) func() {\n\tc.lifecycleHandlersMux.Lock()\n\tif c.typedLifecycleHandlers == nil {\n\t\tc.typedLifecycleHandlers = make(map[SessionLifecycleEventType]map[uint64]SessionLifecycleHandler)\n\t}\n\tif c.typedLifecycleHandlers[eventType] == nil {\n\t\tc.typedLifecycleHandlers[eventType] = make(map[uint64]SessionLifecycleHandler)\n\t}\n\tc.nextLifecycleHandlerID++\n\tid := c.nextLifecycleHandlerID\n\tc.typedLifecycleHandlers[eventType][id] = handler\n\tc.lifecycleHandlersMux.Unlock()\n\n\treturn func() {\n\t\tc.lifecycleHandlersMux.Lock()\n\t\tdefer c.lifecycleHandlersMux.Unlock()\n\t\tif handlers, ok := c.typedLifecycleHandlers[eventType]; ok {\n\t\t\tdelete(handlers, id)\n\t\t}\n\t}\n}\n\n// handleLifecycleEvent dispatches a lifecycle event to all registered handlers\nfunc (c *Client) handleLifecycleEvent(event SessionLifecycleEvent) {\n\tc.lifecycleHandlersMux.Lock()\n\t// Copy handlers to avoid holding lock during callbacks\n\ttypedHandlers := make([]SessionLifecycleHandler, 0)\n\tif handlers, ok := c.typedLifecycleHandlers[event.Type]; ok {\n\t\tfor _, handler := range handlers {\n\t\t\ttypedHandlers = append(typedHandlers, handler)\n\t\t}\n\t}\n\twildcardHandlers := make([]SessionLifecycleHandler, 0, len(c.lifecycleHandlers))\n\tfor _, handler := range c.lifecycleHandlers {\n\t\twildcardHandlers = append(wildcardHandlers, handler)\n\t}\n\tc.lifecycleHandlersMux.Unlock()\n\n\t// Dispatch to typed handlers\n\tfor _, handler := range typedHandlers {\n\t\tfunc() {\n\t\t\tdefer func() { recover() }() // Ignore handler panics\n\t\t\thandler(event)\n\t\t}()\n\t}\n\n\t// Dispatch to wildcard handlers\n\tfor _, handler := range wildcardHandlers {\n\t\tfunc() {\n\t\t\tdefer func() { recover() }() // Ignore handler panics\n\t\t\thandler(event)\n\t\t}()\n\t}\n}\n\n// State returns the current connection state of the client.\n//\n// Possible states: StateDisconnected, StateConnecting, StateConnected, StateError.\n//\n// Example:\n//\n//\tif client.State() == copilot.StateConnected {\n//\t session, err := client.CreateSession(context.Background(), &copilot.SessionConfig{\n//\t OnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n//\t })\n//\t}\nfunc (c *Client) State() ConnectionState {\n\tc.startStopMux.RLock()\n\tdefer c.startStopMux.RUnlock()\n\treturn c.state\n}\n\n// ActualPort returns the TCP port the CLI server is listening on.\n// Returns 0 if the client is not connected or using stdio transport.\nfunc (c *Client) ActualPort() int {\n\treturn c.actualPort\n}\n\n// Ping sends a ping request to the server to verify connectivity.\n//\n// The message parameter is optional and will be echoed back in the response.\n// Returns a PingResponse containing the message and server timestamp, or an error.\n//\n// Example:\n//\n//\tresp, err := client.Ping(context.Background(), \"health check\")\n//\tif err != nil {\n//\t log.Printf(\"Server unreachable: %v\", err)\n//\t} else {\n//\t log.Printf(\"Server responded at %d\", resp.Timestamp)\n//\t}\nfunc (c *Client) Ping(ctx context.Context, message string) (*PingResponse, error) {\n\tif c.client == nil {\n\t\treturn nil, fmt.Errorf(\"client not connected\")\n\t}\n\n\tresult, err := c.client.Request(\"ping\", pingRequest{Message: message})\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar response PingResponse\n\tif err := json.Unmarshal(result, &response); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &response, nil\n}\n\n// GetStatus returns CLI status including version and protocol information\nfunc (c *Client) GetStatus(ctx context.Context) (*GetStatusResponse, error) {\n\tif c.client == nil {\n\t\treturn nil, fmt.Errorf(\"client not connected\")\n\t}\n\n\tresult, err := c.client.Request(\"status.get\", getStatusRequest{})\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar response GetStatusResponse\n\tif err := json.Unmarshal(result, &response); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &response, nil\n}\n\n// GetAuthStatus returns current authentication status\nfunc (c *Client) GetAuthStatus(ctx context.Context) (*GetAuthStatusResponse, error) {\n\tif c.client == nil {\n\t\treturn nil, fmt.Errorf(\"client not connected\")\n\t}\n\n\tresult, err := c.client.Request(\"auth.getStatus\", getAuthStatusRequest{})\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar response GetAuthStatusResponse\n\tif err := json.Unmarshal(result, &response); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &response, nil\n}\n\n// ListModels returns available models with their metadata.\n//\n// Results are cached after the first successful call to avoid rate limiting.\n// The cache is cleared when the client disconnects.\nfunc (c *Client) ListModels(ctx context.Context) ([]ModelInfo, error) {\n\t// Use mutex for locking to prevent race condition with concurrent calls\n\tc.modelsCacheMux.Lock()\n\tdefer c.modelsCacheMux.Unlock()\n\n\t// Check cache (already inside lock)\n\tif c.modelsCache != nil {\n\t\tresult := make([]ModelInfo, len(c.modelsCache))\n\t\tcopy(result, c.modelsCache)\n\t\treturn result, nil\n\t}\n\n\tvar models []ModelInfo\n\tif c.onListModels != nil {\n\t\t// Use custom handler instead of CLI RPC\n\t\tvar err error\n\t\tmodels, err = c.onListModels(ctx)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t} else {\n\t\tif c.client == nil {\n\t\t\treturn nil, fmt.Errorf(\"client not connected\")\n\t\t}\n\t\t// Cache miss - fetch from backend while holding lock\n\t\tresult, err := c.client.Request(\"models.list\", listModelsRequest{})\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\n\t\tvar response listModelsResponse\n\t\tif err := json.Unmarshal(result, &response); err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to unmarshal models response: %w\", err)\n\t\t}\n\t\tmodels = response.Models\n\t}\n\n\t// Update cache before releasing lock (copy to prevent external mutation)\n\tcache := make([]ModelInfo, len(models))\n\tcopy(cache, models)\n\tc.modelsCache = cache\n\n\t// Return a copy to prevent cache mutation\n\tresult := make([]ModelInfo, len(models))\n\tcopy(result, models)\n\treturn result, nil\n}\n\n// minProtocolVersion is the minimum protocol version this SDK can communicate with.\nconst minProtocolVersion = 2\n\n// verifyProtocolVersion verifies that the server's protocol version is within the supported range\n// and stores the negotiated version.\nfunc (c *Client) verifyProtocolVersion(ctx context.Context) error {\n\tmaxVersion := GetSdkProtocolVersion()\n\tpingResult, err := c.Ping(ctx, \"\")\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tif pingResult.ProtocolVersion == nil {\n\t\treturn fmt.Errorf(\"SDK protocol version mismatch: SDK supports versions %d-%d, but server does not report a protocol version. Please update your server to ensure compatibility\", minProtocolVersion, maxVersion)\n\t}\n\n\tserverVersion := *pingResult.ProtocolVersion\n\tif serverVersion < minProtocolVersion || serverVersion > maxVersion {\n\t\treturn fmt.Errorf(\"SDK protocol version mismatch: SDK supports versions %d-%d, but server reports version %d. Please update your SDK or server to ensure compatibility\", minProtocolVersion, maxVersion, serverVersion)\n\t}\n\n\tc.negotiatedProtocolVersion = serverVersion\n\treturn nil\n}\n\n// startCLIServer starts the CLI server process.\n//\n// This spawns the CLI server as a subprocess using the configured transport\n// mode (stdio or TCP).\nfunc (c *Client) startCLIServer(ctx context.Context) error {\n\tcliPath := c.options.CLIPath\n\tif cliPath == \"\" {\n\t\t// If no CLI path is provided, attempt to use the embedded CLI if available\n\t\tcliPath = embeddedcli.Path()\n\t}\n\tif cliPath == \"\" {\n\t\t// Default to \"copilot\" in PATH if no embedded CLI is available and no custom path is set\n\t\tcliPath = \"copilot\"\n\t}\n\n\t// Start with user-provided CLIArgs, then add SDK-managed args\n\targs := append([]string{}, c.options.CLIArgs...)\n\targs = append(args, \"--headless\", \"--no-auto-update\", \"--log-level\", c.options.LogLevel)\n\n\t// Choose transport mode\n\tif c.useStdio {\n\t\targs = append(args, \"--stdio\")\n\t} else if c.options.Port > 0 {\n\t\targs = append(args, \"--port\", strconv.Itoa(c.options.Port))\n\t}\n\n\t// Add auth-related flags\n\tif c.options.GitHubToken != \"\" {\n\t\targs = append(args, \"--auth-token-env\", \"COPILOT_SDK_AUTH_TOKEN\")\n\t}\n\t// Default useLoggedInUser to false when GitHubToken is provided\n\tuseLoggedInUser := true\n\tif c.options.UseLoggedInUser != nil {\n\t\tuseLoggedInUser = *c.options.UseLoggedInUser\n\t} else if c.options.GitHubToken != \"\" {\n\t\tuseLoggedInUser = false\n\t}\n\tif !useLoggedInUser {\n\t\targs = append(args, \"--no-auto-login\")\n\t}\n\n\tif c.options.SessionIdleTimeoutSeconds > 0 {\n\t\targs = append(args, \"--session-idle-timeout\", strconv.Itoa(c.options.SessionIdleTimeoutSeconds))\n\t}\n\n\t// If CLIPath is a .js file, run it with node\n\t// Note we can't rely on the shebang as Windows doesn't support it\n\tcommand := cliPath\n\tif strings.HasSuffix(cliPath, \".js\") {\n\t\tcommand = \"node\"\n\t\targs = append([]string{cliPath}, args...)\n\t}\n\n\tc.process = exec.Command(command, args...)\n\n\t// Configure platform-specific process attributes (e.g., hide window on Windows)\n\tconfigureProcAttr(c.process)\n\n\t// Set working directory if specified\n\tif c.options.Cwd != \"\" {\n\t\tc.process.Dir = c.options.Cwd\n\t}\n\n\t// Add auth token if needed.\n\tc.process.Env = c.options.Env\n\tif c.options.GitHubToken != \"\" {\n\t\tc.process.Env = append(c.process.Env, \"COPILOT_SDK_AUTH_TOKEN=\"+c.options.GitHubToken)\n\t}\n\n\tif c.options.Telemetry != nil {\n\t\tt := c.options.Telemetry\n\t\tc.process.Env = append(c.process.Env, \"COPILOT_OTEL_ENABLED=true\")\n\t\tif t.OTLPEndpoint != \"\" {\n\t\t\tc.process.Env = append(c.process.Env, \"OTEL_EXPORTER_OTLP_ENDPOINT=\"+t.OTLPEndpoint)\n\t\t}\n\t\tif t.FilePath != \"\" {\n\t\t\tc.process.Env = append(c.process.Env, \"COPILOT_OTEL_FILE_EXPORTER_PATH=\"+t.FilePath)\n\t\t}\n\t\tif t.ExporterType != \"\" {\n\t\t\tc.process.Env = append(c.process.Env, \"COPILOT_OTEL_EXPORTER_TYPE=\"+t.ExporterType)\n\t\t}\n\t\tif t.SourceName != \"\" {\n\t\t\tc.process.Env = append(c.process.Env, \"COPILOT_OTEL_SOURCE_NAME=\"+t.SourceName)\n\t\t}\n\t\tif t.CaptureContent != nil {\n\t\t\tval := \"false\"\n\t\t\tif *t.CaptureContent {\n\t\t\t\tval = \"true\"\n\t\t\t}\n\t\t\tc.process.Env = append(c.process.Env, \"OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=\"+val)\n\t\t}\n\t}\n\n\tif c.useStdio {\n\t\t// For stdio mode, we need stdin/stdout pipes\n\t\tstdin, err := c.process.StdinPipe()\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"failed to create stdin pipe: %w\", err)\n\t\t}\n\n\t\tstdout, err := c.process.StdoutPipe()\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"failed to create stdout pipe: %w\", err)\n\t\t}\n\n\t\tif err := c.process.Start(); err != nil {\n\t\t\treturn fmt.Errorf(\"failed to start CLI server: %w\", err)\n\t\t}\n\n\t\tc.monitorProcess()\n\n\t\t// Create JSON-RPC client immediately\n\t\tc.client = jsonrpc2.NewClient(stdin, stdout)\n\t\tc.client.SetProcessDone(c.processDone, c.processErrorPtr)\n\t\tc.client.SetOnClose(func() {\n\t\t\t// Run in a goroutine to avoid deadlocking with Stop/ForceStop,\n\t\t\t// which hold startStopMux while waiting for readLoop to finish.\n\t\t\tgo func() {\n\t\t\t\tc.startStopMux.Lock()\n\t\t\t\tdefer c.startStopMux.Unlock()\n\t\t\t\tc.state = StateDisconnected\n\t\t\t}()\n\t\t})\n\t\tc.RPC = rpc.NewServerRpc(c.client)\n\t\tc.setupNotificationHandler()\n\t\tc.client.Start()\n\n\t\treturn nil\n\t} else {\n\t\t// For TCP mode, capture stdout to get port number\n\t\tstdout, err := c.process.StdoutPipe()\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"failed to create stdout pipe: %w\", err)\n\t\t}\n\n\t\tif err := c.process.Start(); err != nil {\n\t\t\treturn fmt.Errorf(\"failed to start CLI server: %w\", err)\n\t\t}\n\n\t\tc.monitorProcess()\n\n\t\tscanner := bufio.NewScanner(stdout)\n\t\tportRegex := regexp.MustCompile(`listening on port (\\d+)`)\n\n\t\tctx, cancel := context.WithTimeout(ctx, 10*time.Second)\n\t\tdefer cancel()\n\n\t\tfor {\n\t\t\tselect {\n\t\t\tcase <-ctx.Done():\n\t\t\t\tkillErr := c.killProcess()\n\t\t\t\treturn errors.Join(fmt.Errorf(\"failed waiting for CLI server to start: %w\", ctx.Err()), killErr)\n\t\t\tcase <-c.processDone:\n\t\t\t\tkillErr := c.killProcess()\n\t\t\t\treturn errors.Join(errors.New(\"CLI server process exited before reporting port\"), killErr)\n\t\t\tdefault:\n\t\t\t\tif scanner.Scan() {\n\t\t\t\t\tline := scanner.Text()\n\t\t\t\t\tif matches := portRegex.FindStringSubmatch(line); len(matches) > 1 {\n\t\t\t\t\t\tport, err := strconv.Atoi(matches[1])\n\t\t\t\t\t\tif err != nil {\n\t\t\t\t\t\t\tkillErr := c.killProcess()\n\t\t\t\t\t\t\treturn errors.Join(fmt.Errorf(\"failed to parse port: %w\", err), killErr)\n\t\t\t\t\t\t}\n\t\t\t\t\t\tc.actualPort = port\n\t\t\t\t\t\treturn nil\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\n\nfunc (c *Client) killProcess() error {\n\tif p := c.osProcess.Swap(nil); p != nil {\n\t\tif err := p.Kill(); err != nil {\n\t\t\treturn fmt.Errorf(\"failed to kill CLI process: %w\", err)\n\t\t}\n\t}\n\tc.process = nil\n\treturn nil\n}\n\n// monitorProcess signals when the CLI process exits and captures any exit error.\n// processError is intentionally a local: each process lifecycle gets its own\n// error value, so goroutines from previous processes can't overwrite the\n// current one. Closing the channel synchronizes with readers, guaranteeing\n// they see the final processError value.\nfunc (c *Client) monitorProcess() {\n\tdone := make(chan struct{})\n\tc.processDone = done\n\tproc := c.process\n\tc.osProcess.Store(proc.Process)\n\tvar processError error\n\tc.processErrorPtr = &processError\n\tgo func() {\n\t\twaitErr := proc.Wait()\n\t\tif waitErr != nil {\n\t\t\tprocessError = fmt.Errorf(\"CLI process exited: %w\", waitErr)\n\t\t} else {\n\t\t\tprocessError = errors.New(\"CLI process exited unexpectedly\")\n\t\t}\n\t\tclose(done)\n\t}()\n}\n\n// connectToServer establishes a connection to the server.\nfunc (c *Client) connectToServer(ctx context.Context) error {\n\tif c.useStdio {\n\t\t// Already connected via stdio in startCLIServer\n\t\treturn nil\n\t}\n\n\t// Connect via TCP\n\treturn c.connectViaTcp(ctx)\n}\n\n// connectViaTcp connects to the CLI server via TCP socket.\nfunc (c *Client) connectViaTcp(ctx context.Context) error {\n\tif c.actualPort == 0 {\n\t\treturn fmt.Errorf(\"server port not available\")\n\t}\n\n\t// Merge a 10-second timeout with the caller's context so whichever\n\t// deadline comes first wins.\n\taddress := net.JoinHostPort(c.actualHost, fmt.Sprintf(\"%d\", c.actualPort))\n\tdialCtx, cancel := context.WithTimeout(ctx, 10*time.Second)\n\tdefer cancel()\n\tvar dialer net.Dialer\n\tconn, err := dialer.DialContext(dialCtx, \"tcp\", address)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to connect to CLI server at %s: %w\", address, err)\n\t}\n\n\tc.conn = conn\n\n\t// Create JSON-RPC client with the connection\n\tc.client = jsonrpc2.NewClient(conn, conn)\n\tif c.processDone != nil {\n\t\tc.client.SetProcessDone(c.processDone, c.processErrorPtr)\n\t}\n\tc.client.SetOnClose(func() {\n\t\tgo func() {\n\t\t\tc.startStopMux.Lock()\n\t\t\tdefer c.startStopMux.Unlock()\n\t\t\tc.state = StateDisconnected\n\t\t}()\n\t})\n\tc.RPC = rpc.NewServerRpc(c.client)\n\tc.setupNotificationHandler()\n\tc.client.Start()\n\n\treturn nil\n}\n\n// setupNotificationHandler configures handlers for session events and RPC requests.\n// Protocol v3 servers send tool calls and permission requests as broadcast session events.\n// Protocol v2 servers use the older tool.call / permission.request RPC model.\n// We always register v2 adapters because handlers are set up before version negotiation;\n// a v3 server will simply never send these requests.\nfunc (c *Client) setupNotificationHandler() {\n\tc.client.SetRequestHandler(\"session.event\", jsonrpc2.NotificationHandlerFor(c.handleSessionEvent))\n\tc.client.SetRequestHandler(\"session.lifecycle\", jsonrpc2.NotificationHandlerFor(c.handleLifecycleEvent))\n\tc.client.SetRequestHandler(\"tool.call\", jsonrpc2.RequestHandlerFor(c.handleToolCallRequestV2))\n\tc.client.SetRequestHandler(\"permission.request\", jsonrpc2.RequestHandlerFor(c.handlePermissionRequestV2))\n\tc.client.SetRequestHandler(\"userInput.request\", jsonrpc2.RequestHandlerFor(c.handleUserInputRequest))\n\tc.client.SetRequestHandler(\"hooks.invoke\", jsonrpc2.RequestHandlerFor(c.handleHooksInvoke))\n\tc.client.SetRequestHandler(\"systemMessage.transform\", jsonrpc2.RequestHandlerFor(c.handleSystemMessageTransform))\n\trpc.RegisterClientSessionApiHandlers(c.client, func(sessionID string) *rpc.ClientSessionApiHandlers {\n\t\tc.sessionsMux.Lock()\n\t\tdefer c.sessionsMux.Unlock()\n\t\tsession := c.sessions[sessionID]\n\t\tif session == nil {\n\t\t\treturn nil\n\t\t}\n\t\treturn session.clientSessionApis\n\t})\n}\n\nfunc (c *Client) handleSessionEvent(req sessionEventRequest) {\n\tif req.SessionID == \"\" {\n\t\treturn\n\t}\n\t// Dispatch to session\n\tc.sessionsMux.Lock()\n\tsession, ok := c.sessions[req.SessionID]\n\tc.sessionsMux.Unlock()\n\n\tif ok {\n\t\tsession.dispatchEvent(req.Event)\n\t}\n}\n\n// handleUserInputRequest handles a user input request from the CLI server.\nfunc (c *Client) handleUserInputRequest(req userInputRequest) (*userInputResponse, *jsonrpc2.Error) {\n\tif req.SessionID == \"\" || req.Question == \"\" {\n\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: \"invalid user input request payload\"}\n\t}\n\n\tc.sessionsMux.Lock()\n\tsession, ok := c.sessions[req.SessionID]\n\tc.sessionsMux.Unlock()\n\tif !ok {\n\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf(\"unknown session %s\", req.SessionID)}\n\t}\n\n\tresponse, err := session.handleUserInputRequest(UserInputRequest{\n\t\tQuestion: req.Question,\n\t\tChoices: req.Choices,\n\t\tAllowFreeform: req.AllowFreeform,\n\t})\n\tif err != nil {\n\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: err.Error()}\n\t}\n\n\treturn &userInputResponse{Answer: response.Answer, WasFreeform: response.WasFreeform}, nil\n}\n\n// handleHooksInvoke handles a hooks invocation from the CLI server.\nfunc (c *Client) handleHooksInvoke(req hooksInvokeRequest) (map[string]any, *jsonrpc2.Error) {\n\tif req.SessionID == \"\" || req.Type == \"\" {\n\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: \"invalid hooks invoke payload\"}\n\t}\n\n\tc.sessionsMux.Lock()\n\tsession, ok := c.sessions[req.SessionID]\n\tc.sessionsMux.Unlock()\n\tif !ok {\n\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf(\"unknown session %s\", req.SessionID)}\n\t}\n\n\toutput, err := session.handleHooksInvoke(req.Type, req.Input)\n\tif err != nil {\n\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: err.Error()}\n\t}\n\n\tresult := make(map[string]any)\n\tif output != nil {\n\t\tresult[\"output\"] = output\n\t}\n\treturn result, nil\n}\n\n// handleSystemMessageTransform handles a system message transform request from the CLI server.\nfunc (c *Client) handleSystemMessageTransform(req systemMessageTransformRequest) (systemMessageTransformResponse, *jsonrpc2.Error) {\n\tif req.SessionID == \"\" {\n\t\treturn systemMessageTransformResponse{}, &jsonrpc2.Error{Code: -32602, Message: \"invalid system message transform payload\"}\n\t}\n\n\tc.sessionsMux.Lock()\n\tsession, ok := c.sessions[req.SessionID]\n\tc.sessionsMux.Unlock()\n\tif !ok {\n\t\treturn systemMessageTransformResponse{}, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf(\"unknown session %s\", req.SessionID)}\n\t}\n\n\tresp, err := session.handleSystemMessageTransform(req.Sections)\n\tif err != nil {\n\t\treturn systemMessageTransformResponse{}, &jsonrpc2.Error{Code: -32603, Message: err.Error()}\n\t}\n\treturn resp, nil\n}\n\n// ========================================================================\n// Protocol v2 backward-compatibility adapters\n// ========================================================================\n\n// toolCallRequestV2 is the v2 RPC request payload for tool.call.\ntype toolCallRequestV2 struct {\n\tSessionID string `json:\"sessionId\"`\n\tToolCallID string `json:\"toolCallId\"`\n\tToolName string `json:\"toolName\"`\n\tArguments any `json:\"arguments\"`\n\tTraceparent string `json:\"traceparent,omitempty\"`\n\tTracestate string `json:\"tracestate,omitempty\"`\n}\n\n// toolCallResponseV2 is the v2 RPC response payload for tool.call.\ntype toolCallResponseV2 struct {\n\tResult ToolResult `json:\"result\"`\n}\n\n// permissionRequestV2 is the v2 RPC request payload for permission.request.\ntype permissionRequestV2 struct {\n\tSessionID string `json:\"sessionId\"`\n\tRequest PermissionRequest `json:\"permissionRequest\"`\n}\n\n// permissionResponseV2 is the v2 RPC response payload for permission.request.\ntype permissionResponseV2 struct {\n\tResult PermissionRequestResult `json:\"result\"`\n}\n\n// handleToolCallRequestV2 handles a v2-style tool.call RPC request from the server.\nfunc (c *Client) handleToolCallRequestV2(req toolCallRequestV2) (*toolCallResponseV2, *jsonrpc2.Error) {\n\tif req.SessionID == \"\" || req.ToolCallID == \"\" || req.ToolName == \"\" {\n\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: \"invalid tool call payload\"}\n\t}\n\n\tc.sessionsMux.Lock()\n\tsession, ok := c.sessions[req.SessionID]\n\tc.sessionsMux.Unlock()\n\tif !ok {\n\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf(\"unknown session %s\", req.SessionID)}\n\t}\n\n\thandler, ok := session.getToolHandler(req.ToolName)\n\tif !ok {\n\t\treturn &toolCallResponseV2{Result: ToolResult{\n\t\t\tTextResultForLLM: fmt.Sprintf(\"Tool '%s' is not supported by this client instance.\", req.ToolName),\n\t\t\tResultType: \"failure\",\n\t\t\tError: fmt.Sprintf(\"tool '%s' not supported\", req.ToolName),\n\t\t\tToolTelemetry: map[string]any{},\n\t\t}}, nil\n\t}\n\n\tctx := contextWithTraceParent(context.Background(), req.Traceparent, req.Tracestate)\n\n\tinvocation := ToolInvocation{\n\t\tSessionID: req.SessionID,\n\t\tToolCallID: req.ToolCallID,\n\t\tToolName: req.ToolName,\n\t\tArguments: req.Arguments,\n\t\tTraceContext: ctx,\n\t}\n\n\tresult, err := handler(invocation)\n\tif err != nil {\n\t\treturn &toolCallResponseV2{Result: ToolResult{\n\t\t\tTextResultForLLM: \"Invoking this tool produced an error. Detailed information is not available.\",\n\t\t\tResultType: \"failure\",\n\t\t\tError: err.Error(),\n\t\t\tToolTelemetry: map[string]any{},\n\t\t}}, nil\n\t}\n\n\treturn &toolCallResponseV2{Result: result}, nil\n}\n\n// handlePermissionRequestV2 handles a v2-style permission.request RPC request from the server.\nfunc (c *Client) handlePermissionRequestV2(req permissionRequestV2) (*permissionResponseV2, *jsonrpc2.Error) {\n\tif req.SessionID == \"\" {\n\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: \"invalid permission request payload\"}\n\t}\n\n\tc.sessionsMux.Lock()\n\tsession, ok := c.sessions[req.SessionID]\n\tc.sessionsMux.Unlock()\n\tif !ok {\n\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf(\"unknown session %s\", req.SessionID)}\n\t}\n\n\thandler := session.getPermissionHandler()\n\tif handler == nil {\n\t\treturn &permissionResponseV2{\n\t\t\tResult: PermissionRequestResult{\n\t\t\t\tKind: PermissionRequestResultKindDeniedCouldNotRequestFromUser,\n\t\t\t},\n\t\t}, nil\n\t}\n\n\tinvocation := PermissionInvocation{\n\t\tSessionID: session.SessionID,\n\t}\n\n\tresult, err := handler(req.Request, invocation)\n\tif err != nil {\n\t\treturn &permissionResponseV2{\n\t\t\tResult: PermissionRequestResult{\n\t\t\t\tKind: PermissionRequestResultKindDeniedCouldNotRequestFromUser,\n\t\t\t},\n\t\t}, nil\n\t}\n\tif result.Kind == \"no-result\" {\n\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: noResultPermissionV2Error}\n\t}\n\n\treturn &permissionResponseV2{Result: result}, nil\n}\n" }, { "path": "go/client_test.go", "content": "package copilot\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"reflect\"\n\t\"regexp\"\n\t\"sync\"\n\t\"testing\"\n\n\t\"github.com/github/copilot-sdk/go/rpc\"\n)\n\n// This file is for unit tests. Where relevant, prefer to add e2e tests in e2e/*.test.go instead\n\nfunc TestClient_URLParsing(t *testing.T) {\n\tt.Run(\"should parse port-only URL format\", func(t *testing.T) {\n\t\tclient := NewClient(&ClientOptions{\n\t\t\tCLIUrl: \"8080\",\n\t\t})\n\n\t\tif client.actualPort != 8080 {\n\t\t\tt.Errorf(\"Expected port 8080, got %d\", client.actualPort)\n\t\t}\n\t\tif client.actualHost != \"localhost\" {\n\t\t\tt.Errorf(\"Expected host localhost, got %s\", client.actualHost)\n\t\t}\n\t\tif !client.isExternalServer {\n\t\t\tt.Error(\"Expected isExternalServer to be true\")\n\t\t}\n\t})\n\n\tt.Run(\"should parse host:port URL format\", func(t *testing.T) {\n\t\tclient := NewClient(&ClientOptions{\n\t\t\tCLIUrl: \"127.0.0.1:9000\",\n\t\t})\n\n\t\tif client.actualPort != 9000 {\n\t\t\tt.Errorf(\"Expected port 9000, got %d\", client.actualPort)\n\t\t}\n\t\tif client.actualHost != \"127.0.0.1\" {\n\t\t\tt.Errorf(\"Expected host 127.0.0.1, got %s\", client.actualHost)\n\t\t}\n\t\tif !client.isExternalServer {\n\t\t\tt.Error(\"Expected isExternalServer to be true\")\n\t\t}\n\t})\n\n\tt.Run(\"should parse http://host:port URL format\", func(t *testing.T) {\n\t\tclient := NewClient(&ClientOptions{\n\t\t\tCLIUrl: \"http://localhost:7000\",\n\t\t})\n\n\t\tif client.actualPort != 7000 {\n\t\t\tt.Errorf(\"Expected port 7000, got %d\", client.actualPort)\n\t\t}\n\t\tif client.actualHost != \"localhost\" {\n\t\t\tt.Errorf(\"Expected host localhost, got %s\", client.actualHost)\n\t\t}\n\t\tif !client.isExternalServer {\n\t\t\tt.Error(\"Expected isExternalServer to be true\")\n\t\t}\n\t})\n\n\tt.Run(\"should parse https://host:port URL format\", func(t *testing.T) {\n\t\tclient := NewClient(&ClientOptions{\n\t\t\tCLIUrl: \"https://example.com:443\",\n\t\t})\n\n\t\tif client.actualPort != 443 {\n\t\t\tt.Errorf(\"Expected port 443, got %d\", client.actualPort)\n\t\t}\n\t\tif client.actualHost != \"example.com\" {\n\t\t\tt.Errorf(\"Expected host example.com, got %s\", client.actualHost)\n\t\t}\n\t\tif !client.isExternalServer {\n\t\t\tt.Error(\"Expected isExternalServer to be true\")\n\t\t}\n\t})\n\n\tt.Run(\"should throw error for invalid URL format\", func(t *testing.T) {\n\t\tdefer func() {\n\t\t\tif r := recover(); r == nil {\n\t\t\t\tt.Error(\"Expected panic for invalid URL format\")\n\t\t\t} else {\n\t\t\t\tmatched, _ := regexp.MatchString(\"Invalid port in CLIUrl\", r.(string))\n\t\t\t\tif !matched {\n\t\t\t\t\tt.Errorf(\"Expected panic message to contain 'Invalid port in CLIUrl', got: %v\", r)\n\t\t\t\t}\n\t\t\t}\n\t\t}()\n\n\t\tNewClient(&ClientOptions{\n\t\t\tCLIUrl: \"invalid-url\",\n\t\t})\n\t})\n\n\tt.Run(\"should throw error for invalid port - too high\", func(t *testing.T) {\n\t\tdefer func() {\n\t\t\tif r := recover(); r == nil {\n\t\t\t\tt.Error(\"Expected panic for invalid port\")\n\t\t\t} else {\n\t\t\t\tmatched, _ := regexp.MatchString(\"Invalid port in CLIUrl\", r.(string))\n\t\t\t\tif !matched {\n\t\t\t\t\tt.Errorf(\"Expected panic message to contain 'Invalid port in CLIUrl', got: %v\", r)\n\t\t\t\t}\n\t\t\t}\n\t\t}()\n\n\t\tNewClient(&ClientOptions{\n\t\t\tCLIUrl: \"localhost:99999\",\n\t\t})\n\t})\n\n\tt.Run(\"should throw error for invalid port - zero\", func(t *testing.T) {\n\t\tdefer func() {\n\t\t\tif r := recover(); r == nil {\n\t\t\t\tt.Error(\"Expected panic for invalid port\")\n\t\t\t} else {\n\t\t\t\tmatched, _ := regexp.MatchString(\"Invalid port in CLIUrl\", r.(string))\n\t\t\t\tif !matched {\n\t\t\t\t\tt.Errorf(\"Expected panic message to contain 'Invalid port in CLIUrl', got: %v\", r)\n\t\t\t\t}\n\t\t\t}\n\t\t}()\n\n\t\tNewClient(&ClientOptions{\n\t\t\tCLIUrl: \"localhost:0\",\n\t\t})\n\t})\n\n\tt.Run(\"should throw error for invalid port - negative\", func(t *testing.T) {\n\t\tdefer func() {\n\t\t\tif r := recover(); r == nil {\n\t\t\t\tt.Error(\"Expected panic for invalid port\")\n\t\t\t} else {\n\t\t\t\tmatched, _ := regexp.MatchString(\"Invalid port in CLIUrl\", r.(string))\n\t\t\t\tif !matched {\n\t\t\t\t\tt.Errorf(\"Expected panic message to contain 'Invalid port in CLIUrl', got: %v\", r)\n\t\t\t\t}\n\t\t\t}\n\t\t}()\n\n\t\tNewClient(&ClientOptions{\n\t\t\tCLIUrl: \"localhost:-1\",\n\t\t})\n\t})\n\n\tt.Run(\"should throw error when CLIUrl is used with UseStdio\", func(t *testing.T) {\n\t\tdefer func() {\n\t\t\tif r := recover(); r == nil {\n\t\t\t\tt.Error(\"Expected panic for mutually exclusive options\")\n\t\t\t} else {\n\t\t\t\tmatched, _ := regexp.MatchString(\"CLIUrl is mutually exclusive\", r.(string))\n\t\t\t\tif !matched {\n\t\t\t\t\tt.Errorf(\"Expected panic message to contain 'CLIUrl is mutually exclusive', got: %v\", r)\n\t\t\t\t}\n\t\t\t}\n\t\t}()\n\n\t\tNewClient(&ClientOptions{\n\t\t\tCLIUrl: \"localhost:8080\",\n\t\t\tUseStdio: Bool(true),\n\t\t})\n\t})\n\n\tt.Run(\"should throw error when CLIUrl is used with CLIPath\", func(t *testing.T) {\n\t\tdefer func() {\n\t\t\tif r := recover(); r == nil {\n\t\t\t\tt.Error(\"Expected panic for mutually exclusive options\")\n\t\t\t} else {\n\t\t\t\tmatched, _ := regexp.MatchString(\"CLIUrl is mutually exclusive\", r.(string))\n\t\t\t\tif !matched {\n\t\t\t\t\tt.Errorf(\"Expected panic message to contain 'CLIUrl is mutually exclusive', got: %v\", r)\n\t\t\t\t}\n\t\t\t}\n\t\t}()\n\n\t\tNewClient(&ClientOptions{\n\t\t\tCLIUrl: \"localhost:8080\",\n\t\t\tCLIPath: \"/path/to/cli\",\n\t\t})\n\t})\n\n\tt.Run(\"should set UseStdio to false when CLIUrl is provided\", func(t *testing.T) {\n\t\tclient := NewClient(&ClientOptions{\n\t\t\tCLIUrl: \"8080\",\n\t\t})\n\n\t\tif client.useStdio {\n\t\t\tt.Error(\"Expected UseStdio to be false when CLIUrl is provided\")\n\t\t}\n\t})\n\n\tt.Run(\"should set UseStdio to true when UseStdio is set to true\", func(t *testing.T) {\n\t\tclient := NewClient(&ClientOptions{\n\t\t\tUseStdio: Bool(true),\n\t\t})\n\n\t\tif !client.useStdio {\n\t\t\tt.Error(\"Expected UseStdio to be true when UseStdio is set to true\")\n\t\t}\n\t})\n\n\tt.Run(\"should set UseStdio to false when UseStdio is set to false\", func(t *testing.T) {\n\t\tclient := NewClient(&ClientOptions{\n\t\t\tUseStdio: Bool(false),\n\t\t})\n\n\t\tif client.useStdio {\n\t\t\tt.Error(\"Expected UseStdio to be false when UseStdio is set to false\")\n\t\t}\n\t})\n\n\tt.Run(\"should mark client as using external server\", func(t *testing.T) {\n\t\tclient := NewClient(&ClientOptions{\n\t\t\tCLIUrl: \"localhost:8080\",\n\t\t})\n\n\t\tif !client.isExternalServer {\n\t\t\tt.Error(\"Expected isExternalServer to be true when CLIUrl is provided\")\n\t\t}\n\t})\n}\n\nfunc TestClient_SessionFsConfig(t *testing.T) {\n\tt.Run(\"should throw error when InitialCwd is missing\", func(t *testing.T) {\n\t\tdefer func() {\n\t\t\tif r := recover(); r == nil {\n\t\t\t\tt.Error(\"Expected panic for missing SessionFs.InitialCwd\")\n\t\t\t} else {\n\t\t\t\tmatched, _ := regexp.MatchString(\"SessionFs.InitialCwd is required\", r.(string))\n\t\t\t\tif !matched {\n\t\t\t\t\tt.Errorf(\"Expected panic message to contain 'SessionFs.InitialCwd is required', got: %v\", r)\n\t\t\t\t}\n\t\t\t}\n\t\t}()\n\n\t\tNewClient(&ClientOptions{\n\t\t\tSessionFs: &SessionFsConfig{\n\t\t\t\tSessionStatePath: \"/session-state\",\n\t\t\t\tConventions: rpc.SessionFSSetProviderConventionsPosix,\n\t\t\t},\n\t\t})\n\t})\n\n\tt.Run(\"should throw error when SessionStatePath is missing\", func(t *testing.T) {\n\t\tdefer func() {\n\t\t\tif r := recover(); r == nil {\n\t\t\t\tt.Error(\"Expected panic for missing SessionFs.SessionStatePath\")\n\t\t\t} else {\n\t\t\t\tmatched, _ := regexp.MatchString(\"SessionFs.SessionStatePath is required\", r.(string))\n\t\t\t\tif !matched {\n\t\t\t\t\tt.Errorf(\"Expected panic message to contain 'SessionFs.SessionStatePath is required', got: %v\", r)\n\t\t\t\t}\n\t\t\t}\n\t\t}()\n\n\t\tNewClient(&ClientOptions{\n\t\t\tSessionFs: &SessionFsConfig{\n\t\t\t\tInitialCwd: \"/\",\n\t\t\t\tConventions: rpc.SessionFSSetProviderConventionsPosix,\n\t\t\t},\n\t\t})\n\t})\n}\n\nfunc TestClient_AuthOptions(t *testing.T) {\n\tt.Run(\"should accept GitHubToken option\", func(t *testing.T) {\n\t\tclient := NewClient(&ClientOptions{\n\t\t\tGitHubToken: \"gho_test_token\",\n\t\t})\n\n\t\tif client.options.GitHubToken != \"gho_test_token\" {\n\t\t\tt.Errorf(\"Expected GitHubToken to be 'gho_test_token', got %q\", client.options.GitHubToken)\n\t\t}\n\t})\n\n\tt.Run(\"should default UseLoggedInUser to nil when no GitHubToken\", func(t *testing.T) {\n\t\tclient := NewClient(&ClientOptions{})\n\n\t\tif client.options.UseLoggedInUser != nil {\n\t\t\tt.Errorf(\"Expected UseLoggedInUser to be nil, got %v\", client.options.UseLoggedInUser)\n\t\t}\n\t})\n\n\tt.Run(\"should allow explicit UseLoggedInUser false\", func(t *testing.T) {\n\t\tclient := NewClient(&ClientOptions{\n\t\t\tUseLoggedInUser: Bool(false),\n\t\t})\n\n\t\tif client.options.UseLoggedInUser == nil || *client.options.UseLoggedInUser != false {\n\t\t\tt.Error(\"Expected UseLoggedInUser to be false\")\n\t\t}\n\t})\n\n\tt.Run(\"should allow explicit UseLoggedInUser true with GitHubToken\", func(t *testing.T) {\n\t\tclient := NewClient(&ClientOptions{\n\t\t\tGitHubToken: \"gho_test_token\",\n\t\t\tUseLoggedInUser: Bool(true),\n\t\t})\n\n\t\tif client.options.UseLoggedInUser == nil || *client.options.UseLoggedInUser != true {\n\t\t\tt.Error(\"Expected UseLoggedInUser to be true\")\n\t\t}\n\t})\n\n\tt.Run(\"should throw error when GitHubToken is used with CLIUrl\", func(t *testing.T) {\n\t\tdefer func() {\n\t\t\tif r := recover(); r == nil {\n\t\t\t\tt.Error(\"Expected panic for auth options with CLIUrl\")\n\t\t\t} else {\n\t\t\t\tmatched, _ := regexp.MatchString(\"GitHubToken and UseLoggedInUser cannot be used with CLIUrl\", r.(string))\n\t\t\t\tif !matched {\n\t\t\t\t\tt.Errorf(\"Expected panic message about auth options, got: %v\", r)\n\t\t\t\t}\n\t\t\t}\n\t\t}()\n\n\t\tNewClient(&ClientOptions{\n\t\t\tCLIUrl: \"localhost:8080\",\n\t\t\tGitHubToken: \"gho_test_token\",\n\t\t})\n\t})\n\n\tt.Run(\"should throw error when UseLoggedInUser is used with CLIUrl\", func(t *testing.T) {\n\t\tdefer func() {\n\t\t\tif r := recover(); r == nil {\n\t\t\t\tt.Error(\"Expected panic for auth options with CLIUrl\")\n\t\t\t} else {\n\t\t\t\tmatched, _ := regexp.MatchString(\"GitHubToken and UseLoggedInUser cannot be used with CLIUrl\", r.(string))\n\t\t\t\tif !matched {\n\t\t\t\t\tt.Errorf(\"Expected panic message about auth options, got: %v\", r)\n\t\t\t\t}\n\t\t\t}\n\t\t}()\n\n\t\tNewClient(&ClientOptions{\n\t\t\tCLIUrl: \"localhost:8080\",\n\t\t\tUseLoggedInUser: Bool(false),\n\t\t})\n\t})\n}\n\nfunc TestClient_EnvOptions(t *testing.T) {\n\tt.Run(\"should store custom environment variables\", func(t *testing.T) {\n\t\tclient := NewClient(&ClientOptions{\n\t\t\tEnv: []string{\"FOO=bar\", \"BAZ=qux\"},\n\t\t})\n\n\t\tif len(client.options.Env) != 2 {\n\t\t\tt.Errorf(\"Expected 2 environment variables, got %d\", len(client.options.Env))\n\t\t}\n\t\tif client.options.Env[0] != \"FOO=bar\" {\n\t\t\tt.Errorf(\"Expected first env var to be 'FOO=bar', got %q\", client.options.Env[0])\n\t\t}\n\t\tif client.options.Env[1] != \"BAZ=qux\" {\n\t\t\tt.Errorf(\"Expected second env var to be 'BAZ=qux', got %q\", client.options.Env[1])\n\t\t}\n\t})\n\n\tt.Run(\"should default to inherit from current process\", func(t *testing.T) {\n\t\tclient := NewClient(&ClientOptions{})\n\n\t\tif want := os.Environ(); !reflect.DeepEqual(client.options.Env, want) {\n\t\t\tt.Errorf(\"Expected Env to be %v, got %v\", want, client.options.Env)\n\t\t}\n\t})\n\n\tt.Run(\"should default to inherit from current process with nil options\", func(t *testing.T) {\n\t\tclient := NewClient(nil)\n\n\t\tif want := os.Environ(); !reflect.DeepEqual(client.options.Env, want) {\n\t\t\tt.Errorf(\"Expected Env to be %v, got %v\", want, client.options.Env)\n\t\t}\n\t})\n\n\tt.Run(\"should allow empty environment\", func(t *testing.T) {\n\t\tclient := NewClient(&ClientOptions{\n\t\t\tEnv: []string{},\n\t\t})\n\n\t\tif client.options.Env == nil {\n\t\t\tt.Error(\"Expected Env to be non-nil empty slice\")\n\t\t}\n\t\tif len(client.options.Env) != 0 {\n\t\t\tt.Errorf(\"Expected 0 environment variables, got %d\", len(client.options.Env))\n\t\t}\n\t})\n}\n\nfunc TestClient_SessionIdleTimeoutSeconds(t *testing.T) {\n\tt.Run(\"should store SessionIdleTimeoutSeconds option\", func(t *testing.T) {\n\t\tclient := NewClient(&ClientOptions{\n\t\t\tSessionIdleTimeoutSeconds: 600,\n\t\t})\n\n\t\tif client.options.SessionIdleTimeoutSeconds != 600 {\n\t\t\tt.Errorf(\"Expected SessionIdleTimeoutSeconds to be 600, got %d\", client.options.SessionIdleTimeoutSeconds)\n\t\t}\n\t})\n\n\tt.Run(\"should default SessionIdleTimeoutSeconds to zero\", func(t *testing.T) {\n\t\tclient := NewClient(&ClientOptions{})\n\n\t\tif client.options.SessionIdleTimeoutSeconds != 0 {\n\t\t\tt.Errorf(\"Expected SessionIdleTimeoutSeconds to be 0, got %d\", client.options.SessionIdleTimeoutSeconds)\n\t\t}\n\t})\n}\n\nfunc findCLIPathForTest() string {\n\tabs, _ := filepath.Abs(\"../nodejs/node_modules/@github/copilot/index.js\")\n\tif fileExistsForTest(abs) {\n\t\treturn abs\n\t}\n\treturn \"\"\n}\n\nfunc fileExistsForTest(path string) bool {\n\t_, err := os.Stat(path)\n\treturn err == nil\n}\n\nfunc TestCreateSessionRequest_ClientName(t *testing.T) {\n\tt.Run(\"includes clientName in JSON when set\", func(t *testing.T) {\n\t\treq := createSessionRequest{ClientName: \"my-app\"}\n\t\tdata, err := json.Marshal(req)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to marshal: %v\", err)\n\t\t}\n\t\tvar m map[string]any\n\t\tif err := json.Unmarshal(data, &m); err != nil {\n\t\t\tt.Fatalf(\"Failed to unmarshal: %v\", err)\n\t\t}\n\t\tif m[\"clientName\"] != \"my-app\" {\n\t\t\tt.Errorf(\"Expected clientName to be 'my-app', got %v\", m[\"clientName\"])\n\t\t}\n\t})\n\n\tt.Run(\"omits clientName from JSON when empty\", func(t *testing.T) {\n\t\treq := createSessionRequest{}\n\t\tdata, _ := json.Marshal(req)\n\t\tvar m map[string]any\n\t\tjson.Unmarshal(data, &m)\n\t\tif _, ok := m[\"clientName\"]; ok {\n\t\t\tt.Error(\"Expected clientName to be omitted when empty\")\n\t\t}\n\t})\n}\n\nfunc TestResumeSessionRequest_ClientName(t *testing.T) {\n\tt.Run(\"includes clientName in JSON when set\", func(t *testing.T) {\n\t\treq := resumeSessionRequest{SessionID: \"s1\", ClientName: \"my-app\"}\n\t\tdata, err := json.Marshal(req)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to marshal: %v\", err)\n\t\t}\n\t\tvar m map[string]any\n\t\tif err := json.Unmarshal(data, &m); err != nil {\n\t\t\tt.Fatalf(\"Failed to unmarshal: %v\", err)\n\t\t}\n\t\tif m[\"clientName\"] != \"my-app\" {\n\t\t\tt.Errorf(\"Expected clientName to be 'my-app', got %v\", m[\"clientName\"])\n\t\t}\n\t})\n\n\tt.Run(\"omits clientName from JSON when empty\", func(t *testing.T) {\n\t\treq := resumeSessionRequest{SessionID: \"s1\"}\n\t\tdata, _ := json.Marshal(req)\n\t\tvar m map[string]any\n\t\tjson.Unmarshal(data, &m)\n\t\tif _, ok := m[\"clientName\"]; ok {\n\t\t\tt.Error(\"Expected clientName to be omitted when empty\")\n\t\t}\n\t})\n}\n\nfunc TestCreateSessionRequest_Agent(t *testing.T) {\n\tt.Run(\"includes agent in JSON when set\", func(t *testing.T) {\n\t\treq := createSessionRequest{Agent: \"test-agent\"}\n\t\tdata, err := json.Marshal(req)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to marshal: %v\", err)\n\t\t}\n\t\tvar m map[string]any\n\t\tif err := json.Unmarshal(data, &m); err != nil {\n\t\t\tt.Fatalf(\"Failed to unmarshal: %v\", err)\n\t\t}\n\t\tif m[\"agent\"] != \"test-agent\" {\n\t\t\tt.Errorf(\"Expected agent to be 'test-agent', got %v\", m[\"agent\"])\n\t\t}\n\t})\n\n\tt.Run(\"omits agent from JSON when empty\", func(t *testing.T) {\n\t\treq := createSessionRequest{}\n\t\tdata, _ := json.Marshal(req)\n\t\tvar m map[string]any\n\t\tjson.Unmarshal(data, &m)\n\t\tif _, ok := m[\"agent\"]; ok {\n\t\t\tt.Error(\"Expected agent to be omitted when empty\")\n\t\t}\n\t})\n}\n\nfunc TestResumeSessionRequest_Agent(t *testing.T) {\n\tt.Run(\"includes agent in JSON when set\", func(t *testing.T) {\n\t\treq := resumeSessionRequest{SessionID: \"s1\", Agent: \"test-agent\"}\n\t\tdata, err := json.Marshal(req)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to marshal: %v\", err)\n\t\t}\n\t\tvar m map[string]any\n\t\tif err := json.Unmarshal(data, &m); err != nil {\n\t\t\tt.Fatalf(\"Failed to unmarshal: %v\", err)\n\t\t}\n\t\tif m[\"agent\"] != \"test-agent\" {\n\t\t\tt.Errorf(\"Expected agent to be 'test-agent', got %v\", m[\"agent\"])\n\t\t}\n\t})\n\n\tt.Run(\"omits agent from JSON when empty\", func(t *testing.T) {\n\t\treq := resumeSessionRequest{SessionID: \"s1\"}\n\t\tdata, _ := json.Marshal(req)\n\t\tvar m map[string]any\n\t\tjson.Unmarshal(data, &m)\n\t\tif _, ok := m[\"agent\"]; ok {\n\t\t\tt.Error(\"Expected agent to be omitted when empty\")\n\t\t}\n\t})\n}\n\nfunc TestOverridesBuiltInTool(t *testing.T) {\n\tt.Run(\"OverridesBuiltInTool is serialized in tool definition\", func(t *testing.T) {\n\t\ttool := Tool{\n\t\t\tName: \"grep\",\n\t\t\tDescription: \"Custom grep\",\n\t\t\tOverridesBuiltInTool: true,\n\t\t\tHandler: func(_ ToolInvocation) (ToolResult, error) { return ToolResult{}, nil },\n\t\t}\n\t\tdata, err := json.Marshal(tool)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"failed to marshal: %v\", err)\n\t\t}\n\t\tvar m map[string]any\n\t\tif err := json.Unmarshal(data, &m); err != nil {\n\t\t\tt.Fatalf(\"failed to unmarshal: %v\", err)\n\t\t}\n\t\tif v, ok := m[\"overridesBuiltInTool\"]; !ok || v != true {\n\t\t\tt.Errorf(\"expected overridesBuiltInTool=true, got %v\", m)\n\t\t}\n\t})\n\n\tt.Run(\"OverridesBuiltInTool omitted when false\", func(t *testing.T) {\n\t\ttool := Tool{\n\t\t\tName: \"custom_tool\",\n\t\t\tDescription: \"A custom tool\",\n\t\t\tHandler: func(_ ToolInvocation) (ToolResult, error) { return ToolResult{}, nil },\n\t\t}\n\t\tdata, err := json.Marshal(tool)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"failed to marshal: %v\", err)\n\t\t}\n\t\tvar m map[string]any\n\t\tif err := json.Unmarshal(data, &m); err != nil {\n\t\t\tt.Fatalf(\"failed to unmarshal: %v\", err)\n\t\t}\n\t\tif _, ok := m[\"overridesBuiltInTool\"]; ok {\n\t\t\tt.Errorf(\"expected overridesBuiltInTool to be omitted, got %v\", m)\n\t\t}\n\t})\n}\n\nfunc TestClient_CreateSession_RequiresPermissionHandler(t *testing.T) {\n\tt.Run(\"returns error when config is nil\", func(t *testing.T) {\n\t\tclient := NewClient(nil)\n\t\t_, err := client.CreateSession(t.Context(), nil)\n\t\tif err == nil {\n\t\t\tt.Fatal(\"Expected error when OnPermissionRequest is nil\")\n\t\t}\n\t\tmatched, _ := regexp.MatchString(\"OnPermissionRequest.*is required\", err.Error())\n\t\tif !matched {\n\t\t\tt.Errorf(\"Expected error about OnPermissionRequest being required, got: %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"returns error when OnPermissionRequest is not set\", func(t *testing.T) {\n\t\tclient := NewClient(nil)\n\t\t_, err := client.CreateSession(t.Context(), &SessionConfig{})\n\t\tif err == nil {\n\t\t\tt.Fatal(\"Expected error when OnPermissionRequest is nil\")\n\t\t}\n\t\tmatched, _ := regexp.MatchString(\"OnPermissionRequest.*is required\", err.Error())\n\t\tif !matched {\n\t\t\tt.Errorf(\"Expected error about OnPermissionRequest being required, got: %v\", err)\n\t\t}\n\t})\n}\n\nfunc TestClient_ResumeSession_RequiresPermissionHandler(t *testing.T) {\n\tt.Run(\"returns error when config is nil\", func(t *testing.T) {\n\t\tclient := NewClient(nil)\n\t\t_, err := client.ResumeSessionWithOptions(t.Context(), \"some-id\", nil)\n\t\tif err == nil {\n\t\t\tt.Fatal(\"Expected error when OnPermissionRequest is nil\")\n\t\t}\n\t\tmatched, _ := regexp.MatchString(\"OnPermissionRequest.*is required\", err.Error())\n\t\tif !matched {\n\t\t\tt.Errorf(\"Expected error about OnPermissionRequest being required, got: %v\", err)\n\t\t}\n\t})\n}\n\nfunc TestListModelsWithCustomHandler(t *testing.T) {\n\tcustomModels := []ModelInfo{\n\t\t{\n\t\t\tID: \"my-custom-model\",\n\t\t\tName: \"My Custom Model\",\n\t\t\tCapabilities: ModelCapabilities{\n\t\t\t\tSupports: ModelSupports{Vision: false, ReasoningEffort: false},\n\t\t\t\tLimits: ModelLimits{MaxContextWindowTokens: 128000},\n\t\t\t},\n\t\t},\n\t}\n\n\tcallCount := 0\n\thandler := func(ctx context.Context) ([]ModelInfo, error) {\n\t\tcallCount++\n\t\treturn customModels, nil\n\t}\n\n\tclient := NewClient(&ClientOptions{OnListModels: handler})\n\n\tmodels, err := client.ListModels(t.Context())\n\tif err != nil {\n\t\tt.Fatalf(\"ListModels failed: %v\", err)\n\t}\n\tif callCount != 1 {\n\t\tt.Errorf(\"expected handler called once, got %d\", callCount)\n\t}\n\tif len(models) != 1 || models[0].ID != \"my-custom-model\" {\n\t\tt.Errorf(\"unexpected models: %+v\", models)\n\t}\n}\n\nfunc TestListModelsHandlerCachesResults(t *testing.T) {\n\tcustomModels := []ModelInfo{\n\t\t{\n\t\t\tID: \"cached-model\",\n\t\t\tName: \"Cached Model\",\n\t\t\tCapabilities: ModelCapabilities{\n\t\t\t\tSupports: ModelSupports{Vision: false, ReasoningEffort: false},\n\t\t\t\tLimits: ModelLimits{MaxContextWindowTokens: 128000},\n\t\t\t},\n\t\t},\n\t}\n\n\tcallCount := 0\n\thandler := func(ctx context.Context) ([]ModelInfo, error) {\n\t\tcallCount++\n\t\treturn customModels, nil\n\t}\n\n\tclient := NewClient(&ClientOptions{OnListModels: handler})\n\n\t_, _ = client.ListModels(t.Context())\n\t_, _ = client.ListModels(t.Context())\n\tif callCount != 1 {\n\t\tt.Errorf(\"expected handler called once due to caching, got %d\", callCount)\n\t}\n}\n\nfunc TestClient_StartContextCancellationDoesNotKillProcess(t *testing.T) {\n\tcliPath := findCLIPathForTest()\n\tif cliPath == \"\" {\n\t\tt.Skip(\"CLI not found\")\n\t}\n\n\tclient := NewClient(&ClientOptions{CLIPath: cliPath})\n\tt.Cleanup(func() { client.ForceStop() })\n\n\t// Start with a context, then cancel it after the client is connected.\n\tctx, cancel := context.WithCancel(t.Context())\n\tif err := client.Start(ctx); err != nil {\n\t\tt.Fatalf(\"Start failed: %v\", err)\n\t}\n\tcancel() // cancel the context that was used for Start\n\n\t// The CLI process should still be alive and responsive.\n\tresp, err := client.Ping(t.Context(), \"still alive\")\n\tif err != nil {\n\t\tt.Fatalf(\"Ping after context cancellation failed: %v\", err)\n\t}\n\tif resp == nil {\n\t\tt.Fatal(\"expected non-nil ping response\")\n\t}\n}\n\nfunc TestClient_StartStopRace(t *testing.T) {\n\tcliPath := findCLIPathForTest()\n\tif cliPath == \"\" {\n\t\tt.Skip(\"CLI not found\")\n\t}\n\tclient := NewClient(&ClientOptions{CLIPath: cliPath})\n\tdefer client.ForceStop()\n\terrChan := make(chan error)\n\twg := sync.WaitGroup{}\n\tfor range 10 {\n\t\twg.Add(3)\n\t\tgo func() {\n\t\t\tdefer wg.Done()\n\t\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\t\tselect {\n\t\t\t\tcase errChan <- err:\n\t\t\t\tdefault:\n\t\t\t\t}\n\t\t\t}\n\t\t}()\n\t\tgo func() {\n\t\t\tdefer wg.Done()\n\t\t\tif err := client.Stop(); err != nil {\n\t\t\t\tselect {\n\t\t\t\tcase errChan <- err:\n\t\t\t\tdefault:\n\t\t\t\t}\n\t\t\t}\n\t\t}()\n\t\tgo func() {\n\t\t\tdefer wg.Done()\n\t\t\tclient.ForceStop()\n\t\t}()\n\t}\n\twg.Wait()\n\tclose(errChan)\n\tif err := <-errChan; err != nil {\n\t\tt.Fatal(err)\n\t}\n}\n\nfunc TestCreateSessionRequest_Commands(t *testing.T) {\n\tt.Run(\"forwards commands in session.create RPC\", func(t *testing.T) {\n\t\treq := createSessionRequest{\n\t\t\tCommands: []wireCommand{\n\t\t\t\t{Name: \"deploy\", Description: \"Deploy the app\"},\n\t\t\t\t{Name: \"rollback\", Description: \"Rollback last deploy\"},\n\t\t\t},\n\t\t}\n\t\tdata, err := json.Marshal(req)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to marshal: %v\", err)\n\t\t}\n\t\tvar m map[string]any\n\t\tif err := json.Unmarshal(data, &m); err != nil {\n\t\t\tt.Fatalf(\"Failed to unmarshal: %v\", err)\n\t\t}\n\t\tcmds, ok := m[\"commands\"].([]any)\n\t\tif !ok {\n\t\t\tt.Fatalf(\"Expected commands to be an array, got %T\", m[\"commands\"])\n\t\t}\n\t\tif len(cmds) != 2 {\n\t\t\tt.Fatalf(\"Expected 2 commands, got %d\", len(cmds))\n\t\t}\n\t\tcmd0 := cmds[0].(map[string]any)\n\t\tif cmd0[\"name\"] != \"deploy\" {\n\t\t\tt.Errorf(\"Expected first command name 'deploy', got %v\", cmd0[\"name\"])\n\t\t}\n\t\tif cmd0[\"description\"] != \"Deploy the app\" {\n\t\t\tt.Errorf(\"Expected first command description 'Deploy the app', got %v\", cmd0[\"description\"])\n\t\t}\n\t})\n\n\tt.Run(\"omits commands from JSON when empty\", func(t *testing.T) {\n\t\treq := createSessionRequest{}\n\t\tdata, _ := json.Marshal(req)\n\t\tvar m map[string]any\n\t\tjson.Unmarshal(data, &m)\n\t\tif _, ok := m[\"commands\"]; ok {\n\t\t\tt.Error(\"Expected commands to be omitted when empty\")\n\t\t}\n\t})\n}\n\nfunc TestResumeSessionRequest_Commands(t *testing.T) {\n\tt.Run(\"forwards commands in session.resume RPC\", func(t *testing.T) {\n\t\treq := resumeSessionRequest{\n\t\t\tSessionID: \"s1\",\n\t\t\tCommands: []wireCommand{\n\t\t\t\t{Name: \"deploy\", Description: \"Deploy the app\"},\n\t\t\t},\n\t\t}\n\t\tdata, err := json.Marshal(req)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to marshal: %v\", err)\n\t\t}\n\t\tvar m map[string]any\n\t\tif err := json.Unmarshal(data, &m); err != nil {\n\t\t\tt.Fatalf(\"Failed to unmarshal: %v\", err)\n\t\t}\n\t\tcmds, ok := m[\"commands\"].([]any)\n\t\tif !ok {\n\t\t\tt.Fatalf(\"Expected commands to be an array, got %T\", m[\"commands\"])\n\t\t}\n\t\tif len(cmds) != 1 {\n\t\t\tt.Fatalf(\"Expected 1 command, got %d\", len(cmds))\n\t\t}\n\t\tcmd0 := cmds[0].(map[string]any)\n\t\tif cmd0[\"name\"] != \"deploy\" {\n\t\t\tt.Errorf(\"Expected command name 'deploy', got %v\", cmd0[\"name\"])\n\t\t}\n\t})\n\n\tt.Run(\"omits commands from JSON when empty\", func(t *testing.T) {\n\t\treq := resumeSessionRequest{SessionID: \"s1\"}\n\t\tdata, _ := json.Marshal(req)\n\t\tvar m map[string]any\n\t\tjson.Unmarshal(data, &m)\n\t\tif _, ok := m[\"commands\"]; ok {\n\t\t\tt.Error(\"Expected commands to be omitted when empty\")\n\t\t}\n\t})\n}\n\nfunc TestCreateSessionRequest_RequestElicitation(t *testing.T) {\n\tt.Run(\"sends requestElicitation flag when OnElicitationRequest is provided\", func(t *testing.T) {\n\t\treq := createSessionRequest{\n\t\t\tRequestElicitation: Bool(true),\n\t\t}\n\t\tdata, err := json.Marshal(req)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to marshal: %v\", err)\n\t\t}\n\t\tvar m map[string]any\n\t\tif err := json.Unmarshal(data, &m); err != nil {\n\t\t\tt.Fatalf(\"Failed to unmarshal: %v\", err)\n\t\t}\n\t\tif m[\"requestElicitation\"] != true {\n\t\t\tt.Errorf(\"Expected requestElicitation to be true, got %v\", m[\"requestElicitation\"])\n\t\t}\n\t})\n\n\tt.Run(\"does not send requestElicitation when no handler provided\", func(t *testing.T) {\n\t\treq := createSessionRequest{}\n\t\tdata, _ := json.Marshal(req)\n\t\tvar m map[string]any\n\t\tjson.Unmarshal(data, &m)\n\t\tif _, ok := m[\"requestElicitation\"]; ok {\n\t\t\tt.Error(\"Expected requestElicitation to be omitted when not set\")\n\t\t}\n\t})\n}\n\nfunc TestResumeSessionRequest_RequestElicitation(t *testing.T) {\n\tt.Run(\"sends requestElicitation flag when OnElicitationRequest is provided\", func(t *testing.T) {\n\t\treq := resumeSessionRequest{\n\t\t\tSessionID: \"s1\",\n\t\t\tRequestElicitation: Bool(true),\n\t\t}\n\t\tdata, err := json.Marshal(req)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to marshal: %v\", err)\n\t\t}\n\t\tvar m map[string]any\n\t\tif err := json.Unmarshal(data, &m); err != nil {\n\t\t\tt.Fatalf(\"Failed to unmarshal: %v\", err)\n\t\t}\n\t\tif m[\"requestElicitation\"] != true {\n\t\t\tt.Errorf(\"Expected requestElicitation to be true, got %v\", m[\"requestElicitation\"])\n\t\t}\n\t})\n\n\tt.Run(\"does not send requestElicitation when no handler provided\", func(t *testing.T) {\n\t\treq := resumeSessionRequest{SessionID: \"s1\"}\n\t\tdata, _ := json.Marshal(req)\n\t\tvar m map[string]any\n\t\tjson.Unmarshal(data, &m)\n\t\tif _, ok := m[\"requestElicitation\"]; ok {\n\t\t\tt.Error(\"Expected requestElicitation to be omitted when not set\")\n\t\t}\n\t})\n}\n\nfunc TestResumeSessionRequest_ContinuePendingWork(t *testing.T) {\n\tt.Run(\"forwards continuePendingWork when true\", func(t *testing.T) {\n\t\treq := resumeSessionRequest{\n\t\t\tSessionID: \"s1\",\n\t\t\tContinuePendingWork: Bool(true),\n\t\t}\n\t\tdata, err := json.Marshal(req)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to marshal: %v\", err)\n\t\t}\n\t\tvar m map[string]any\n\t\tif err := json.Unmarshal(data, &m); err != nil {\n\t\t\tt.Fatalf(\"Failed to unmarshal: %v\", err)\n\t\t}\n\t\tif m[\"continuePendingWork\"] != true {\n\t\t\tt.Errorf(\"Expected continuePendingWork to be true, got %v\", m[\"continuePendingWork\"])\n\t\t}\n\t})\n\n\tt.Run(\"omits continuePendingWork when not set\", func(t *testing.T) {\n\t\treq := resumeSessionRequest{SessionID: \"s1\"}\n\t\tdata, _ := json.Marshal(req)\n\t\tvar m map[string]any\n\t\tjson.Unmarshal(data, &m)\n\t\tif _, ok := m[\"continuePendingWork\"]; ok {\n\t\t\tt.Error(\"Expected continuePendingWork to be omitted when not set\")\n\t\t}\n\t})\n}\n\nfunc TestCreateSessionRequest_IncludeSubAgentStreamingEvents(t *testing.T) {\n\tt.Run(\"defaults to true when nil\", func(t *testing.T) {\n\t\treq := createSessionRequest{\n\t\t\tIncludeSubAgentStreamingEvents: Bool(true),\n\t\t}\n\t\tdata, err := json.Marshal(req)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to marshal: %v\", err)\n\t\t}\n\t\tvar m map[string]any\n\t\tif err := json.Unmarshal(data, &m); err != nil {\n\t\t\tt.Fatalf(\"Failed to unmarshal: %v\", err)\n\t\t}\n\t\tif m[\"includeSubAgentStreamingEvents\"] != true {\n\t\t\tt.Errorf(\"Expected includeSubAgentStreamingEvents to be true, got %v\", m[\"includeSubAgentStreamingEvents\"])\n\t\t}\n\t})\n\n\tt.Run(\"preserves explicit false\", func(t *testing.T) {\n\t\treq := createSessionRequest{\n\t\t\tIncludeSubAgentStreamingEvents: Bool(false),\n\t\t}\n\t\tdata, err := json.Marshal(req)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to marshal: %v\", err)\n\t\t}\n\t\tvar m map[string]any\n\t\tif err := json.Unmarshal(data, &m); err != nil {\n\t\t\tt.Fatalf(\"Failed to unmarshal: %v\", err)\n\t\t}\n\t\tif m[\"includeSubAgentStreamingEvents\"] != false {\n\t\t\tt.Errorf(\"Expected includeSubAgentStreamingEvents to be false, got %v\", m[\"includeSubAgentStreamingEvents\"])\n\t\t}\n\t})\n}\n\nfunc TestResumeSessionRequest_IncludeSubAgentStreamingEvents(t *testing.T) {\n\tt.Run(\"defaults to true when nil\", func(t *testing.T) {\n\t\treq := resumeSessionRequest{\n\t\t\tSessionID: \"s1\",\n\t\t\tIncludeSubAgentStreamingEvents: Bool(true),\n\t\t}\n\t\tdata, err := json.Marshal(req)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to marshal: %v\", err)\n\t\t}\n\t\tvar m map[string]any\n\t\tif err := json.Unmarshal(data, &m); err != nil {\n\t\t\tt.Fatalf(\"Failed to unmarshal: %v\", err)\n\t\t}\n\t\tif m[\"includeSubAgentStreamingEvents\"] != true {\n\t\t\tt.Errorf(\"Expected includeSubAgentStreamingEvents to be true, got %v\", m[\"includeSubAgentStreamingEvents\"])\n\t\t}\n\t})\n\n\tt.Run(\"preserves explicit false\", func(t *testing.T) {\n\t\treq := resumeSessionRequest{\n\t\t\tSessionID: \"s1\",\n\t\t\tIncludeSubAgentStreamingEvents: Bool(false),\n\t\t}\n\t\tdata, err := json.Marshal(req)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to marshal: %v\", err)\n\t\t}\n\t\tvar m map[string]any\n\t\tif err := json.Unmarshal(data, &m); err != nil {\n\t\t\tt.Fatalf(\"Failed to unmarshal: %v\", err)\n\t\t}\n\t\tif m[\"includeSubAgentStreamingEvents\"] != false {\n\t\t\tt.Errorf(\"Expected includeSubAgentStreamingEvents to be false, got %v\", m[\"includeSubAgentStreamingEvents\"])\n\t\t}\n\t})\n}\n\nfunc TestCreateSessionResponse_Capabilities(t *testing.T) {\n\tt.Run(\"reads capabilities from session.create response\", func(t *testing.T) {\n\t\tresponseJSON := `{\"sessionId\":\"s1\",\"workspacePath\":\"/tmp\",\"capabilities\":{\"ui\":{\"elicitation\":true}}}`\n\t\tvar response createSessionResponse\n\t\tif err := json.Unmarshal([]byte(responseJSON), &response); err != nil {\n\t\t\tt.Fatalf(\"Failed to unmarshal: %v\", err)\n\t\t}\n\t\tif response.Capabilities == nil {\n\t\t\tt.Fatal(\"Expected capabilities to be non-nil\")\n\t\t}\n\t\tif response.Capabilities.UI == nil {\n\t\t\tt.Fatal(\"Expected capabilities.UI to be non-nil\")\n\t\t}\n\t\tif !response.Capabilities.UI.Elicitation {\n\t\t\tt.Errorf(\"Expected capabilities.UI.Elicitation to be true\")\n\t\t}\n\t})\n\n\tt.Run(\"defaults capabilities when not present\", func(t *testing.T) {\n\t\tresponseJSON := `{\"sessionId\":\"s1\",\"workspacePath\":\"/tmp\"}`\n\t\tvar response createSessionResponse\n\t\tif err := json.Unmarshal([]byte(responseJSON), &response); err != nil {\n\t\t\tt.Fatalf(\"Failed to unmarshal: %v\", err)\n\t\t}\n\t\tif response.Capabilities != nil && response.Capabilities.UI != nil && response.Capabilities.UI.Elicitation {\n\t\t\tt.Errorf(\"Expected capabilities.UI.Elicitation to be falsy when not injected\")\n\t\t}\n\t})\n}\n" }, { "path": "go/cmd/bundler/main.go", "content": "// Bundler downloads Copilot CLI binaries and packages them as a binary file,\n// along with a Go source file that embeds the binary and metadata.\n//\n// Usage:\n//\n//\tgo run github.com/github/copilot-sdk/go/cmd/bundler [--platform GOOS/GOARCH] [--output DIR] [--cli-version VERSION] [--check-only]\n//\n//\t--platform: Target platform using Go conventions (linux/amd64, linux/arm64, darwin/amd64, darwin/arm64, windows/amd64, windows/arm64). Defaults to current platform.\n//\t--output: Output directory for embedded artifacts. Defaults to the current directory.\n//\t--cli-version: CLI version to download. If not specified, automatically detects from the copilot-sdk version in go.mod.\n//\t--check-only: Check that embedded CLI version matches the detected version from package-lock.json without downloading. Exits with error if versions don't match.\npackage main\n\nimport (\n\t\"archive/tar\"\n\t\"compress/gzip\"\n\t\"crypto/sha256\"\n\t\"encoding/base64\"\n\t\"encoding/json\"\n\t\"flag\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"os\"\n\t\"os/exec\"\n\t\"path/filepath\"\n\t\"regexp\"\n\t\"runtime\"\n\t\"strings\"\n\n\t\"github.com/klauspost/compress/zstd\"\n)\n\nconst (\n\t// Keep these URLs centralized so reviewers can verify all outbound calls in one place.\n\tsdkModule = \"github.com/github/copilot-sdk/go\"\n\tpackageLockURLFmt = \"https://raw.githubusercontent.com/github/copilot-sdk/%s/nodejs/package-lock.json\"\n\ttarballURLFmt = \"https://registry.npmjs.org/@github/copilot-%s/-/copilot-%s-%s.tgz\"\n\tlicenseTarballFmt = \"https://registry.npmjs.org/@github/copilot/-/copilot-%s.tgz\"\n)\n\n// Platform info: npm package suffix, binary name\ntype platformInfo struct {\n\tnpmPlatform string\n\tbinaryName string\n}\n\n// Map from GOOS/GOARCH to npm platform info\nvar platforms = map[string]platformInfo{\n\t\"linux/amd64\": {npmPlatform: \"linux-x64\", binaryName: \"copilot\"},\n\t\"linux/arm64\": {npmPlatform: \"linux-arm64\", binaryName: \"copilot\"},\n\t\"darwin/amd64\": {npmPlatform: \"darwin-x64\", binaryName: \"copilot\"},\n\t\"darwin/arm64\": {npmPlatform: \"darwin-arm64\", binaryName: \"copilot\"},\n\t\"windows/amd64\": {npmPlatform: \"win32-x64\", binaryName: \"copilot.exe\"},\n\t\"windows/arm64\": {npmPlatform: \"win32-arm64\", binaryName: \"copilot.exe\"},\n}\n\n// main is the CLI entry point.\nfunc main() {\n\tplatform := flag.String(\"platform\", runtime.GOOS+\"/\"+runtime.GOARCH, \"Target platform as GOOS/GOARCH (e.g. linux/amd64, darwin/arm64), defaults to current platform\")\n\toutput := flag.String(\"output\", \"\", \"Output directory for embedded artifacts. Defaults to the current directory\")\n\tcliVersion := flag.String(\"cli-version\", \"\", \"CLI version to download (auto-detected from go.mod if not specified)\")\n\tcheckOnly := flag.Bool(\"check-only\", false, \"Check that embedded CLI version matches the detected version from go.mod without downloading or updating the embedded files. Exits with error if versions don't match.\")\n\tflag.Parse()\n\n\t// Resolve version first so the default output name can include it.\n\tversion := resolveCLIVersion(*cliVersion)\n\t// Resolve platform once to validate input and get the npm package mapping.\n\tgoos, goarch, info, err := resolvePlatform(*platform)\n\tif err != nil {\n\t\tfmt.Fprintf(os.Stderr, \"Error: %v\\n\", err)\n\t\tfmt.Fprintf(os.Stderr, \"Valid platforms: %s\\n\", strings.Join(validPlatforms(), \", \"))\n\t\tos.Exit(1)\n\t}\n\n\toutputPath := filepath.Join(*output, defaultOutputFileName(version, goos, goarch, info.binaryName))\n\n\tif *checkOnly {\n\t\tfmt.Printf(\"Check only: detected CLI version %s from go.mod\\n\", version)\n\t\tfmt.Printf(\"Check only: verifying embedded version for %s\\n\", *platform)\n\n\t\t// Check if existing embedded version matches\n\t\tif err := checkEmbeddedVersion(version, goos, goarch, *output); err != nil {\n\t\t\tfmt.Fprintf(os.Stderr, \"Error: %v\\n\", err)\n\t\t\tos.Exit(1)\n\t\t}\n\n\t\tfmt.Println(\"Check only: embedded version matches detected version\")\n\t\treturn\n\t}\n\n\tfmt.Printf(\"Building bundle for %s (CLI version %s)\\n\", *platform, version)\n\n\tbinaryPath, sha256Hash, err := buildBundle(info, version, outputPath)\n\tif err != nil {\n\t\tfmt.Fprintf(os.Stderr, \"Error: %v\\n\", err)\n\t\tos.Exit(1)\n\t}\n\n\t// Generate the Go file with embed directive\n\tif err := generateGoFile(goos, goarch, binaryPath, version, sha256Hash, \"main\"); err != nil {\n\t\tfmt.Fprintf(os.Stderr, \"Error: %v\\n\", err)\n\t\tos.Exit(1)\n\t}\n\n\tif err := ensureZstdDependency(); err != nil {\n\t\tfmt.Fprintf(os.Stderr, \"Error: %v\\n\", err)\n\t\tos.Exit(1)\n\t}\n}\n\n// resolvePlatform validates the platform flag and returns GOOS/GOARCH and mapping info.\nfunc resolvePlatform(platform string) (string, string, platformInfo, error) {\n\tgoos, goarch, ok := strings.Cut(platform, \"/\")\n\tif !ok || goos == \"\" || goarch == \"\" {\n\t\treturn \"\", \"\", platformInfo{}, fmt.Errorf(\"invalid platform %q\", platform)\n\t}\n\tinfo, ok := platforms[platform]\n\tif !ok {\n\t\treturn \"\", \"\", platformInfo{}, fmt.Errorf(\"invalid platform %q\", platform)\n\t}\n\treturn goos, goarch, info, nil\n}\n\n// resolveCLIVersion determines the CLI version from the flag or repo metadata.\nfunc resolveCLIVersion(flagValue string) string {\n\tif flagValue != \"\" {\n\t\treturn flagValue\n\t}\n\tversion, err := detectCLIVersion()\n\tif err != nil {\n\t\tfmt.Fprintf(os.Stderr, \"Error detecting CLI version: %v\\n\", err)\n\t\tfmt.Fprintln(os.Stderr, \"Hint: specify --cli-version explicitly, or run from a Go module that depends on github.com/github/copilot-sdk/go\")\n\t\tos.Exit(1)\n\t}\n\tfmt.Printf(\"Auto-detected CLI version: %s\\n\", version)\n\treturn version\n}\n\n// defaultOutputFileName builds the default bundle filename for a platform.\nfunc defaultOutputFileName(version, goos, goarch, binaryName string) string {\n\tbase := strings.TrimSuffix(binaryName, filepath.Ext(binaryName))\n\text := filepath.Ext(binaryName)\n\treturn fmt.Sprintf(\"z%s_%s_%s_%s%s.zst\", base, version, goos, goarch, ext)\n}\n\n// validPlatforms returns valid platform keys for error messages.\nfunc validPlatforms() []string {\n\tresult := make([]string, 0, len(platforms))\n\tfor p := range platforms {\n\t\tresult = append(result, p)\n\t}\n\treturn result\n}\n\n// detectCLIVersion detects the CLI version by:\n// 1. Running \"go list -m\" to get the copilot-sdk version from the user's go.mod\n// 2. Fetching the package-lock.json from the SDK repo at that version\n// 3. Extracting the @github/copilot CLI version from it\nfunc detectCLIVersion() (string, error) {\n\t// Get the SDK version from the user's go.mod\n\tsdkVersion, err := getSDKVersion()\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to get SDK version: %w\", err)\n\t}\n\n\tfmt.Printf(\"Found copilot-sdk %s in go.mod\\n\", sdkVersion)\n\n\t// Fetch package-lock.json from the SDK repo at that version\n\tcliVersion, err := fetchCLIVersionFromRepo(sdkVersion)\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to fetch CLI version: %w\", err)\n\t}\n\n\treturn cliVersion, nil\n}\n\n// getSDKVersion runs \"go list -m\" to get the copilot-sdk version from go.mod\nfunc getSDKVersion() (string, error) {\n\tcmd := exec.Command(\"go\", \"list\", \"-m\", \"-f\", \"{{.Version}}\", sdkModule)\n\toutput, err := cmd.Output()\n\tif err != nil {\n\t\tif exitErr, ok := err.(*exec.ExitError); ok {\n\t\t\treturn \"\", fmt.Errorf(\"go list failed: %s\", string(exitErr.Stderr))\n\t\t}\n\t\treturn \"\", err\n\t}\n\n\tversion := strings.TrimSpace(string(output))\n\tif version == \"\" {\n\t\treturn \"\", fmt.Errorf(\"module %s not found in go.mod\", sdkModule)\n\t}\n\n\treturn version, nil\n}\n\n// fetchCLIVersionFromRepo fetches package-lock.json from GitHub and extracts the CLI version.\nfunc fetchCLIVersionFromRepo(sdkVersion string) (string, error) {\n\t// Convert Go module version to Git ref\n\t// v0.1.0 -> v0.1.0\n\t// v0.1.0-beta.1 -> v0.1.0-beta.1\n\t// v0.0.0-20240101120000-abcdef123456 -> abcdef123456 (pseudo-version)\n\tgitRef := sdkVersion\n\n\t// Pseudo-versions end with a 12-character commit hash.\n\t// Format: vX.Y.Z-yyyymmddhhmmss-abcdefabcdef\n\tif idx := strings.LastIndex(sdkVersion, \"-\"); idx != -1 {\n\t\tsuffix := sdkVersion[idx+1:]\n\t\t// Use the commit hash when present so we fetch the exact source snapshot.\n\t\tif len(suffix) == 12 && isHex(suffix) {\n\t\t\tgitRef = suffix\n\t\t}\n\t}\n\n\turl := fmt.Sprintf(packageLockURLFmt, gitRef)\n\tfmt.Printf(\"Fetching %s...\\n\", url)\n\n\tresp, err := http.Get(url)\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to fetch: %w\", err)\n\t}\n\tdefer resp.Body.Close()\n\n\tif resp.StatusCode != http.StatusOK {\n\t\treturn \"\", fmt.Errorf(\"failed to fetch package-lock.json: %s\", resp.Status)\n\t}\n\n\tvar packageLock struct {\n\t\tPackages map[string]struct {\n\t\t\tVersion string `json:\"version\"`\n\t\t} `json:\"packages\"`\n\t}\n\n\tif err := json.NewDecoder(resp.Body).Decode(&packageLock); err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to parse package-lock.json: %w\", err)\n\t}\n\n\tpkg, ok := packageLock.Packages[\"node_modules/@github/copilot\"]\n\tif !ok || pkg.Version == \"\" {\n\t\treturn \"\", fmt.Errorf(\"could not find @github/copilot version in package-lock.json\")\n\t}\n\n\treturn pkg.Version, nil\n}\n\n// isHex returns true if s contains only hexadecimal characters.\nfunc isHex(s string) bool {\n\tfor _, c := range s {\n\t\tif (c < '0' || c > '9') && (c < 'a' || c > 'f') && (c < 'A' || c > 'F') {\n\t\t\treturn false\n\t\t}\n\t}\n\treturn true\n}\n\n// buildBundle downloads the CLI binary and writes it to outputPath.\nfunc buildBundle(info platformInfo, cliVersion, outputPath string) (string, []byte, error) {\n\toutputDir := filepath.Dir(outputPath)\n\tif outputDir == \"\" {\n\t\toutputDir = \".\"\n\t}\n\n\t// Check if output already exists\n\tif _, err := os.Stat(outputPath); err == nil {\n\t\t// Idempotent output avoids re-downloading in CI or local rebuilds.\n\t\tfmt.Printf(\"Output %s already exists, skipping download\\n\", outputPath)\n\t\tsha256Hash, err := sha256FileFromCompressed(outputPath)\n\t\tif err != nil {\n\t\t\treturn \"\", nil, fmt.Errorf(\"failed to hash existing output: %w\", err)\n\t\t}\n\t\tif err := downloadCLILicense(cliVersion, outputPath); err != nil {\n\t\t\treturn \"\", nil, fmt.Errorf(\"failed to download CLI license: %w\", err)\n\t\t}\n\t\treturn outputPath, sha256Hash, nil\n\t}\n\t// Create temp directory for download\n\ttempDir, err := os.MkdirTemp(\"\", \"copilot-bundler-*\")\n\tif err != nil {\n\t\treturn \"\", nil, fmt.Errorf(\"failed to create temp dir: %w\", err)\n\t}\n\tdefer os.RemoveAll(tempDir)\n\n\t// Download the binary\n\tbinaryPath, err := downloadCLIBinary(info.npmPlatform, info.binaryName, cliVersion, tempDir)\n\tif err != nil {\n\t\treturn \"\", nil, fmt.Errorf(\"failed to download CLI binary: %w\", err)\n\t}\n\n\t// Create output directory if needed\n\tif outputDir != \".\" {\n\t\tif err := os.MkdirAll(outputDir, 0755); err != nil {\n\t\t\treturn \"\", nil, fmt.Errorf(\"failed to create output directory: %w\", err)\n\t\t}\n\t}\n\n\tsha256Hash, err := sha256File(binaryPath)\n\tif err != nil {\n\t\treturn \"\", nil, fmt.Errorf(\"failed to hash output binary: %w\", err)\n\t}\n\tif err := compressZstdFile(binaryPath, outputPath); err != nil {\n\t\treturn \"\", nil, fmt.Errorf(\"failed to write output binary: %w\", err)\n\t}\n\tif err := downloadCLILicense(cliVersion, outputPath); err != nil {\n\t\treturn \"\", nil, fmt.Errorf(\"failed to download CLI license: %w\", err)\n\t}\n\tfmt.Printf(\"Successfully created %s\\n\", outputPath)\n\treturn outputPath, sha256Hash, nil\n}\n\n// generateGoFile creates a Go source file that embeds the binary and metadata.\nfunc generateGoFile(goos, goarch, binaryPath, cliVersion string, sha256Hash []byte, pkgName string) error {\n\t// Generate Go file path: zcopilot_linux_amd64.go (without version)\n\tbinaryName := filepath.Base(binaryPath)\n\tlicenseName := licenseFileName(binaryName)\n\tgoFileName := fmt.Sprintf(\"zcopilot_%s_%s.go\", goos, goarch)\n\tgoFilePath := filepath.Join(filepath.Dir(binaryPath), goFileName)\n\thashBase64 := \"\"\n\tif len(sha256Hash) > 0 {\n\t\thashBase64 = base64.StdEncoding.EncodeToString(sha256Hash)\n\t}\n\n\tcontent := fmt.Sprintf(`// Code generated by copilot-sdk bundler; DO NOT EDIT.\n\npackage %s\n\nimport (\n\t\"bytes\"\n\t\"io\"\n\t\"encoding/base64\"\n\t_ \"embed\"\n\n\t\"github.com/github/copilot-sdk/go/embeddedcli\"\n\t\"github.com/klauspost/compress/zstd\"\n)\n\n//go:embed %s\nvar localEmbeddedCopilotCLI []byte\n\n//go:embed %s\nvar localEmbeddedCopilotCLILicense []byte\n\n\nfunc init() {\n\tembeddedcli.Setup(embeddedcli.Config{\n\t\tCli: cliReader(),\n\t\tLicense: localEmbeddedCopilotCLILicense,\n\t\tVersion: %q,\n\t\tCliHash: mustDecodeBase64(%q),\n\t})\n}\n\nfunc cliReader() io.Reader {\n\tr, err := zstd.NewReader(bytes.NewReader(localEmbeddedCopilotCLI))\n\tif err != nil {\n\t\tpanic(\"failed to create zstd reader: \" + err.Error())\n\t}\n\treturn r\n}\n\nfunc mustDecodeBase64(s string) []byte {\n\tb, err := base64.StdEncoding.DecodeString(s)\n\tif err != nil {\n\t\tpanic(\"failed to decode base64: \" + err.Error())\n\t}\n\treturn b\n}\n`, pkgName, binaryName, licenseName, cliVersion, hashBase64)\n\n\tif err := os.WriteFile(goFilePath, []byte(content), 0644); err != nil {\n\t\treturn err\n\t}\n\n\tfmt.Printf(\"Generated %s\\n\", goFilePath)\n\treturn nil\n}\n\n// downloadCLIBinary downloads the npm tarball and extracts the CLI binary.\nfunc downloadCLIBinary(npmPlatform, binaryName, cliVersion, destDir string) (string, error) {\n\ttarballURL := fmt.Sprintf(tarballURLFmt, npmPlatform, npmPlatform, cliVersion)\n\n\tfmt.Printf(\"Downloading from %s...\\n\", tarballURL)\n\n\tresp, err := http.Get(tarballURL)\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to download: %w\", err)\n\t}\n\tdefer resp.Body.Close()\n\n\tif resp.StatusCode != http.StatusOK {\n\t\treturn \"\", fmt.Errorf(\"failed to download: %s\", resp.Status)\n\t}\n\n\t// Save tarball to temp file\n\ttarballPath := filepath.Join(destDir, fmt.Sprintf(\"copilot-%s-%s.tgz\", npmPlatform, cliVersion))\n\ttarballFile, err := os.Create(tarballPath)\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to create tarball file: %w\", err)\n\t}\n\n\tif _, err := io.Copy(tarballFile, resp.Body); err != nil {\n\t\ttarballFile.Close()\n\t\treturn \"\", fmt.Errorf(\"failed to save tarball: %w\", err)\n\t}\n\tif err := tarballFile.Close(); err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to close tarball file: %w\", err)\n\t}\n\n\t// Extract only the CLI binary to avoid unpacking the full package tree.\n\tbinaryPath := filepath.Join(destDir, binaryName)\n\tif err := extractFileFromTarball(tarballPath, destDir, \"package/\"+binaryName, binaryName); err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to extract binary: %w\", err)\n\t}\n\n\t// Verify binary exists\n\tif _, err := os.Stat(binaryPath); err != nil {\n\t\treturn \"\", fmt.Errorf(\"binary not found after extraction: %w\", err)\n\t}\n\n\t// Make executable on Unix\n\tif !strings.HasSuffix(binaryName, \".exe\") {\n\t\tif err := os.Chmod(binaryPath, 0755); err != nil {\n\t\t\treturn \"\", fmt.Errorf(\"failed to chmod binary: %w\", err)\n\t\t}\n\t}\n\n\tstat, err := os.Stat(binaryPath)\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to stat binary: %w\", err)\n\t}\n\tsizeMB := float64(stat.Size()) / 1024 / 1024\n\tfmt.Printf(\"Downloaded %s (%.1f MB)\\n\", binaryName, sizeMB)\n\n\treturn binaryPath, nil\n}\n\n// downloadCLILicense downloads the @github/copilot package and writes its license next to outputPath.\nfunc downloadCLILicense(cliVersion, outputPath string) error {\n\toutputDir := filepath.Dir(outputPath)\n\tif outputDir == \"\" {\n\t\toutputDir = \".\"\n\t}\n\tlicensePath := licensePathForOutput(outputPath)\n\tif _, err := os.Stat(licensePath); err == nil {\n\t\treturn nil\n\t}\n\n\tlicenseURL := fmt.Sprintf(licenseTarballFmt, cliVersion)\n\tresp, err := http.Get(licenseURL)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to download license tarball: %w\", err)\n\t}\n\tdefer resp.Body.Close()\n\n\tif resp.StatusCode != http.StatusOK {\n\t\treturn fmt.Errorf(\"failed to download license tarball: %s\", resp.Status)\n\t}\n\n\tgzReader, err := gzip.NewReader(resp.Body)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to create gzip reader: %w\", err)\n\t}\n\tdefer gzReader.Close()\n\n\ttarReader := tar.NewReader(gzReader)\n\tfor {\n\t\theader, err := tarReader.Next()\n\t\tif err == io.EOF {\n\t\t\tbreak\n\t\t}\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"failed to read tar: %w\", err)\n\t\t}\n\t\tswitch header.Name {\n\t\tcase \"package/LICENSE.md\", \"package/LICENSE\":\n\t\t\tlicenseName := filepath.Base(licensePath)\n\t\t\tif err := extractFileFromTarballStream(tarReader, outputDir, licenseName, os.FileMode(header.Mode)); err != nil {\n\t\t\t\treturn fmt.Errorf(\"failed to write license: %w\", err)\n\t\t\t}\n\t\t\treturn nil\n\t\t}\n\t}\n\n\treturn fmt.Errorf(\"license file not found in tarball\")\n}\n\nfunc licensePathForOutput(outputPath string) string {\n\tif strings.HasSuffix(outputPath, \".zst\") {\n\t\treturn strings.TrimSuffix(outputPath, \".zst\") + \".license\"\n\t}\n\treturn outputPath + \".license\"\n}\n\nfunc licenseFileName(binaryName string) string {\n\tif strings.HasSuffix(binaryName, \".zst\") {\n\t\treturn strings.TrimSuffix(binaryName, \".zst\") + \".license\"\n\t}\n\treturn binaryName + \".license\"\n}\n\n// extractFileFromTarballStream writes the current tar entry to disk.\nfunc extractFileFromTarballStream(r io.Reader, destDir, outputName string, mode os.FileMode) error {\n\toutPath := filepath.Join(destDir, outputName)\n\toutFile, err := os.OpenFile(outPath, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, mode)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to create output file: %w\", err)\n\t}\n\tif _, err := io.Copy(outFile, r); err != nil {\n\t\tif cerr := outFile.Close(); cerr != nil {\n\t\t\treturn fmt.Errorf(\"failed to extract license: copy error: %v; close error: %w\", err, cerr)\n\t\t}\n\t\treturn fmt.Errorf(\"failed to extract license: %w\", err)\n\t}\n\treturn outFile.Close()\n}\n\n// extractFileFromTarball extracts a single file from a .tgz into destDir with a new name.\nfunc extractFileFromTarball(tarballPath, destDir, targetPath, outputName string) error {\n\tfile, err := os.Open(tarballPath)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer file.Close()\n\n\tgzReader, err := gzip.NewReader(file)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to create gzip reader: %w\", err)\n\t}\n\tdefer gzReader.Close()\n\n\ttarReader := tar.NewReader(gzReader)\n\n\tfor {\n\t\theader, err := tarReader.Next()\n\t\tif err == io.EOF {\n\t\t\tbreak\n\t\t}\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"failed to read tar: %w\", err)\n\t\t}\n\n\t\tif header.Name == targetPath {\n\t\t\toutPath := filepath.Join(destDir, outputName)\n\t\t\toutFile, err := os.OpenFile(outPath, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, os.FileMode(header.Mode))\n\t\t\tif err != nil {\n\t\t\t\treturn fmt.Errorf(\"failed to create output file: %w\", err)\n\t\t\t}\n\n\t\t\tif _, err := io.Copy(outFile, tarReader); err != nil {\n\t\t\t\tif cerr := outFile.Close(); cerr != nil {\n\t\t\t\t\treturn fmt.Errorf(\"failed to extract binary (copy error: %v, close error: %v)\", err, cerr)\n\t\t\t\t}\n\t\t\t\treturn fmt.Errorf(\"failed to extract binary: %w\", err)\n\t\t\t}\n\t\t\tif err := outFile.Close(); err != nil {\n\t\t\t\treturn fmt.Errorf(\"failed to close output file: %w\", err)\n\t\t\t}\n\t\t\treturn nil\n\t\t}\n\t}\n\n\treturn fmt.Errorf(\"file %q not found in tarball\", targetPath)\n}\n\n// compressZstdFile compresses src into dst using zstd.\nfunc compressZstdFile(src, dst string) error {\n\tsrcFile, err := os.Open(src)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer srcFile.Close()\n\n\tdstFile, err := os.Create(dst)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer dstFile.Close()\n\n\twriter, err := zstd.NewWriter(dstFile)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer writer.Close()\n\n\tif _, err := io.Copy(writer, srcFile); err != nil {\n\t\treturn err\n\t}\n\treturn writer.Close()\n}\n\n// sha256HexFileFromCompressed returns SHA-256 of the decompressed zstd stream.\nfunc sha256FileFromCompressed(path string) ([]byte, error) {\n\tfile, err := os.Open(path)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer file.Close()\n\n\treader, err := zstd.NewReader(file)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer reader.Close()\n\n\th := sha256.New()\n\tif _, err := io.Copy(h, reader); err != nil {\n\t\treturn nil, err\n\t}\n\treturn h.Sum(nil), nil\n}\n\n// sha256File returns the SHA-256 hash of a file as raw bytes.\nfunc sha256File(path string) ([]byte, error) {\n\tfile, err := os.Open(path)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer file.Close()\n\n\th := sha256.New()\n\tif _, err := io.Copy(h, file); err != nil {\n\t\treturn nil, err\n\t}\n\treturn h.Sum(nil), nil\n}\n\n// ensureZstdDependency makes sure the module has the zstd dependency for generated code.\nfunc ensureZstdDependency() error {\n\tcmd := exec.Command(\"go\", \"mod\", \"tidy\")\n\toutput, err := cmd.CombinedOutput()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to add zstd dependency: %w\\n%s\", err, strings.TrimSpace(string(output)))\n\t}\n\treturn nil\n}\n\n// checkEmbeddedVersion checks if an embedded CLI version exists and compares it with the detected version.\nfunc checkEmbeddedVersion(detectedVersion, goos, goarch, outputDir string) error {\n\t// Look for the generated Go file for this platform\n\tgoFileName := fmt.Sprintf(\"zcopilot_%s_%s.go\", goos, goarch)\n\tgoFilePath := filepath.Join(outputDir, goFileName)\n\n\tdata, err := os.ReadFile(goFilePath)\n\tif err != nil {\n\t\tif os.IsNotExist(err) {\n\t\t\t// No existing embedded version, nothing to check\n\t\t\treturn nil\n\t\t}\n\t\treturn fmt.Errorf(\"failed to read existing Go file: %w\", err)\n\t}\n\n\t// Extract version from the generated file\n\t// Looking for: Version: \"x.y.z\",\n\tre := regexp.MustCompile(`Version:\\s*\"([^\"]+)\"`)\n\tmatches := re.FindSubmatch(data)\n\tif matches == nil {\n\t\t// Can't parse version, skip check\n\t\treturn nil\n\t}\n\n\tembeddedVersion := string(matches[1])\n\tfmt.Printf(\"Found existing embedded version: %s\\n\", embeddedVersion)\n\n\t// Compare versions\n\tif embeddedVersion != detectedVersion {\n\t\treturn fmt.Errorf(\"embedded version %s does not match detected version %s - update required\", embeddedVersion, detectedVersion)\n\t}\n\n\tfmt.Printf(\"Embedded version is up to date (%s)\\n\", embeddedVersion)\n\treturn nil\n}\n" }, { "path": "go/definetool.go", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\npackage copilot\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"reflect\"\n\t\"strings\"\n\n\t\"github.com/google/jsonschema-go/jsonschema\"\n)\n\n// DefineTool creates a Tool with automatic JSON schema generation from a typed handler function.\n// The handler receives typed arguments (automatically unmarshaled from JSON) and the raw ToolInvocation.\n// The handler can return any value - strings pass through directly, other types are JSON-serialized.\n//\n// Example:\n//\n//\ttype GetWeatherParams struct {\n//\t City string `json:\"city\" jsonschema:\"city name\"`\n//\t Unit string `json:\"unit\" jsonschema:\"temperature unit (celsius or fahrenheit)\"`\n//\t}\n//\n//\ttool := copilot.DefineTool(\"get_weather\", \"Get weather for a city\",\n//\t func(params GetWeatherParams, inv copilot.ToolInvocation) (any, error) {\n//\t return fmt.Sprintf(\"Weather in %s: 22°%s\", params.City, params.Unit), nil\n//\t })\nfunc DefineTool[T any, U any](name, description string, handler func(T, ToolInvocation) (U, error)) Tool {\n\tvar zero T\n\tschema := generateSchemaForType(reflect.TypeOf(zero))\n\n\treturn Tool{\n\t\tName: name,\n\t\tDescription: description,\n\t\tParameters: schema,\n\t\tHandler: createTypedHandler(handler),\n\t}\n}\n\n// createTypedHandler wraps a typed handler function into the standard ToolHandler signature.\nfunc createTypedHandler[T any, U any](handler func(T, ToolInvocation) (U, error)) ToolHandler {\n\treturn func(inv ToolInvocation) (ToolResult, error) {\n\t\tvar params T\n\n\t\t// Convert arguments to typed struct via JSON round-trip\n\t\t// Arguments is already map[string]any from JSON-RPC parsing\n\t\tjsonBytes, err := json.Marshal(inv.Arguments)\n\t\tif err != nil {\n\t\t\treturn ToolResult{}, fmt.Errorf(\"failed to marshal arguments: %w\", err)\n\t\t}\n\n\t\tif err := json.Unmarshal(jsonBytes, ¶ms); err != nil {\n\t\t\treturn ToolResult{}, fmt.Errorf(\"failed to unmarshal arguments into %T: %w\", params, err)\n\t\t}\n\n\t\tresult, err := handler(params, inv)\n\t\tif err != nil {\n\t\t\treturn ToolResult{}, err\n\t\t}\n\n\t\treturn normalizeResult(result)\n\t}\n}\n\n// normalizeResult converts any value to a ToolResult.\n// Strings pass through directly, ToolResult passes through, and other types\n// are JSON-serialized.\nfunc normalizeResult(result any) (ToolResult, error) {\n\tif result == nil {\n\t\treturn ToolResult{\n\t\t\tTextResultForLLM: \"\",\n\t\t\tResultType: \"success\",\n\t\t}, nil\n\t}\n\n\t// ToolResult passes through directly\n\tif tr, ok := result.(ToolResult); ok {\n\t\treturn tr, nil\n\t}\n\n\t// Strings pass through directly\n\tif str, ok := result.(string); ok {\n\t\treturn ToolResult{\n\t\t\tTextResultForLLM: str,\n\t\t\tResultType: \"success\",\n\t\t}, nil\n\t}\n\n\t// Everything else gets JSON-serialized\n\tjsonBytes, err := json.Marshal(result)\n\tif err != nil {\n\t\treturn ToolResult{}, fmt.Errorf(\"failed to serialize result: %w\", err)\n\t}\n\n\treturn ToolResult{\n\t\tTextResultForLLM: string(jsonBytes),\n\t\tResultType: \"success\",\n\t}, nil\n}\n\n// ConvertMCPCallToolResult converts an MCP CallToolResult value (a map or struct\n// with a \"content\" array and optional \"isError\" bool) into a ToolResult.\n// Returns the converted ToolResult and true if the value matched the expected\n// shape, or a zero ToolResult and false otherwise.\nfunc ConvertMCPCallToolResult(value any) (ToolResult, bool) {\n\tm, ok := value.(map[string]any)\n\tif !ok {\n\t\tjsonBytes, err := json.Marshal(value)\n\t\tif err != nil {\n\t\t\treturn ToolResult{}, false\n\t\t}\n\n\t\tif err := json.Unmarshal(jsonBytes, &m); err != nil {\n\t\t\treturn ToolResult{}, false\n\t\t}\n\t}\n\n\tcontentRaw, exists := m[\"content\"]\n\tif !exists {\n\t\treturn ToolResult{}, false\n\t}\n\n\tcontentSlice, ok := contentRaw.([]any)\n\tif !ok {\n\t\treturn ToolResult{}, false\n\t}\n\n\t// Verify every element has a string \"type\" field\n\tfor _, item := range contentSlice {\n\t\tblock, ok := item.(map[string]any)\n\t\tif !ok {\n\t\t\treturn ToolResult{}, false\n\t\t}\n\t\tif _, ok := block[\"type\"].(string); !ok {\n\t\t\treturn ToolResult{}, false\n\t\t}\n\t}\n\n\tvar textParts []string\n\tvar binaryResults []ToolBinaryResult\n\n\tfor _, item := range contentSlice {\n\t\tblock := item.(map[string]any)\n\t\tblockType := block[\"type\"].(string)\n\n\t\tswitch blockType {\n\t\tcase \"text\":\n\t\t\tif text, ok := block[\"text\"].(string); ok {\n\t\t\t\ttextParts = append(textParts, text)\n\t\t\t}\n\t\tcase \"image\":\n\t\t\tdata, _ := block[\"data\"].(string)\n\t\t\tmimeType, _ := block[\"mimeType\"].(string)\n\t\t\tif data == \"\" {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tbinaryResults = append(binaryResults, ToolBinaryResult{\n\t\t\t\tData: data,\n\t\t\t\tMimeType: mimeType,\n\t\t\t\tType: \"image\",\n\t\t\t})\n\t\tcase \"resource\":\n\t\t\tif resRaw, ok := block[\"resource\"].(map[string]any); ok {\n\t\t\t\tif text, ok := resRaw[\"text\"].(string); ok && text != \"\" {\n\t\t\t\t\ttextParts = append(textParts, text)\n\t\t\t\t}\n\t\t\t\tif blob, ok := resRaw[\"blob\"].(string); ok && blob != \"\" {\n\t\t\t\t\tmimeType, _ := resRaw[\"mimeType\"].(string)\n\t\t\t\t\tif mimeType == \"\" {\n\t\t\t\t\t\tmimeType = \"application/octet-stream\"\n\t\t\t\t\t}\n\t\t\t\t\turi, _ := resRaw[\"uri\"].(string)\n\t\t\t\t\tbinaryResults = append(binaryResults, ToolBinaryResult{\n\t\t\t\t\t\tData: blob,\n\t\t\t\t\t\tMimeType: mimeType,\n\t\t\t\t\t\tType: \"resource\",\n\t\t\t\t\t\tDescription: uri,\n\t\t\t\t\t})\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\tresultType := \"success\"\n\tif isErr, ok := m[\"isError\"].(bool); ok && isErr {\n\t\tresultType = \"failure\"\n\t}\n\n\ttr := ToolResult{\n\t\tTextResultForLLM: strings.Join(textParts, \"\\n\"),\n\t\tResultType: resultType,\n\t}\n\tif len(binaryResults) > 0 {\n\t\ttr.BinaryResultsForLLM = binaryResults\n\t}\n\treturn tr, true\n}\n\n// generateSchemaForType generates a JSON schema map from a Go type using reflection.\n// Panics if schema generation fails, as this indicates a programming error.\nfunc generateSchemaForType(t reflect.Type) map[string]any {\n\tif t == nil {\n\t\treturn nil\n\t}\n\n\t// Handle pointer types\n\tif t.Kind() == reflect.Ptr {\n\t\tt = t.Elem()\n\t}\n\n\t// Use google/jsonschema-go to generate the schema\n\tschema, err := jsonschema.ForType(t, nil)\n\tif err != nil {\n\t\tpanic(fmt.Sprintf(\"failed to generate schema for type %v: %v\", t, err))\n\t}\n\n\t// Convert schema to map[string]any\n\tschemaBytes, err := json.Marshal(schema)\n\tif err != nil {\n\t\tpanic(fmt.Sprintf(\"failed to marshal schema for type %v: %v\", t, err))\n\t}\n\n\tvar schemaMap map[string]any\n\tif err := json.Unmarshal(schemaBytes, &schemaMap); err != nil {\n\t\tpanic(fmt.Sprintf(\"failed to unmarshal schema for type %v: %v\", t, err))\n\t}\n\n\treturn schemaMap\n}\n" }, { "path": "go/definetool_test.go", "content": "package copilot\n\nimport (\n\t\"errors\"\n\t\"reflect\"\n\t\"testing\"\n)\n\nfunc TestDefineTool(t *testing.T) {\n\tt.Run(\"creates tool with correct name and description\", func(t *testing.T) {\n\t\ttype Params struct {\n\t\t\tQuery string `json:\"query\"`\n\t\t}\n\n\t\ttool := DefineTool(\"search\", \"Search for something\",\n\t\t\tfunc(params Params, inv ToolInvocation) (any, error) {\n\t\t\t\treturn \"result\", nil\n\t\t\t})\n\n\t\tif tool.Name != \"search\" {\n\t\t\tt.Errorf(\"Expected name 'search', got %q\", tool.Name)\n\t\t}\n\t\tif tool.Description != \"Search for something\" {\n\t\t\tt.Errorf(\"Expected description 'Search for something', got %q\", tool.Description)\n\t\t}\n\t\tif tool.Handler == nil {\n\t\t\tt.Error(\"Expected handler to be set\")\n\t\t}\n\t\tif tool.Parameters == nil {\n\t\t\tt.Error(\"Expected parameters schema to be generated\")\n\t\t}\n\t})\n\n\tt.Run(\"generates schema from struct tags\", func(t *testing.T) {\n\t\ttype Params struct {\n\t\t\tCity string `json:\"city\"`\n\t\t\tUnit string `json:\"unit\"`\n\t\t}\n\n\t\ttool := DefineTool(\"get_weather\", \"Get weather\",\n\t\t\tfunc(params Params, inv ToolInvocation) (any, error) {\n\t\t\t\treturn \"sunny\", nil\n\t\t\t})\n\n\t\tschema := tool.Parameters\n\t\tif schema[\"type\"] != \"object\" {\n\t\t\tt.Errorf(\"Expected schema type 'object', got %v\", schema[\"type\"])\n\t\t}\n\n\t\tprops, ok := schema[\"properties\"].(map[string]any)\n\t\tif !ok {\n\t\t\tt.Fatalf(\"Expected properties to be map, got %T\", schema[\"properties\"])\n\t\t}\n\n\t\tif _, ok := props[\"city\"]; !ok {\n\t\t\tt.Error(\"Expected 'city' property in schema\")\n\t\t}\n\t\tif _, ok := props[\"unit\"]; !ok {\n\t\t\tt.Error(\"Expected 'unit' property in schema\")\n\t\t}\n\t})\n\n\tt.Run(\"handler receives typed arguments\", func(t *testing.T) {\n\t\ttype Params struct {\n\t\t\tName string `json:\"name\"`\n\t\t\tCount int `json:\"count\"`\n\t\t}\n\n\t\tvar receivedParams Params\n\t\ttool := DefineTool(\"test\", \"Test tool\",\n\t\t\tfunc(params Params, inv ToolInvocation) (any, error) {\n\t\t\t\treceivedParams = params\n\t\t\t\treturn \"ok\", nil\n\t\t\t})\n\n\t\tinv := ToolInvocation{\n\t\t\tSessionID: \"session-1\",\n\t\t\tToolCallID: \"call-1\",\n\t\t\tToolName: \"test\",\n\t\t\tArguments: map[string]any{\n\t\t\t\t\"name\": \"Alice\",\n\t\t\t\t\"count\": float64(42), // JSON numbers are float64\n\t\t\t},\n\t\t}\n\n\t\t_, err := tool.Handler(inv)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Handler returned error: %v\", err)\n\t\t}\n\n\t\tif receivedParams.Name != \"Alice\" {\n\t\t\tt.Errorf(\"Expected name 'Alice', got %q\", receivedParams.Name)\n\t\t}\n\t\tif receivedParams.Count != 42 {\n\t\t\tt.Errorf(\"Expected count 42, got %d\", receivedParams.Count)\n\t\t}\n\t})\n\n\tt.Run(\"handler receives ToolInvocation\", func(t *testing.T) {\n\t\ttype Params struct{}\n\n\t\tvar receivedInv ToolInvocation\n\t\ttool := DefineTool(\"test\", \"Test tool\",\n\t\t\tfunc(params Params, inv ToolInvocation) (any, error) {\n\t\t\t\treceivedInv = inv\n\t\t\t\treturn \"ok\", nil\n\t\t\t})\n\n\t\tinv := ToolInvocation{\n\t\t\tSessionID: \"session-123\",\n\t\t\tToolCallID: \"call-456\",\n\t\t\tToolName: \"test\",\n\t\t\tArguments: map[string]any{},\n\t\t}\n\n\t\ttool.Handler(inv)\n\n\t\tif receivedInv.SessionID != \"session-123\" {\n\t\t\tt.Errorf(\"Expected SessionID 'session-123', got %q\", receivedInv.SessionID)\n\t\t}\n\t\tif receivedInv.ToolCallID != \"call-456\" {\n\t\t\tt.Errorf(\"Expected ToolCallID 'call-456', got %q\", receivedInv.ToolCallID)\n\t\t}\n\t})\n\n\tt.Run(\"handler error is propagated\", func(t *testing.T) {\n\t\ttype Params struct{}\n\n\t\ttool := DefineTool(\"failing\", \"A failing tool\",\n\t\t\tfunc(params Params, inv ToolInvocation) (any, error) {\n\t\t\t\treturn nil, errors.New(\"something went wrong\")\n\t\t\t})\n\n\t\tinv := ToolInvocation{\n\t\t\tArguments: map[string]any{},\n\t\t}\n\n\t\t_, err := tool.Handler(inv)\n\t\tif err == nil {\n\t\t\tt.Fatal(\"Expected error, got nil\")\n\t\t}\n\t\tif err.Error() != \"something went wrong\" {\n\t\t\tt.Errorf(\"Expected error 'something went wrong', got %q\", err.Error())\n\t\t}\n\t})\n}\n\nfunc TestNormalizeResult(t *testing.T) {\n\tt.Run(\"nil returns empty success result\", func(t *testing.T) {\n\t\tresult, err := normalizeResult(nil)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Unexpected error: %v\", err)\n\t\t}\n\n\t\tif result.TextResultForLLM != \"\" {\n\t\t\tt.Errorf(\"Expected empty TextResultForLLM, got %q\", result.TextResultForLLM)\n\t\t}\n\t\tif result.ResultType != \"success\" {\n\t\t\tt.Errorf(\"Expected ResultType 'success', got %q\", result.ResultType)\n\t\t}\n\t})\n\n\tt.Run(\"string passes through directly\", func(t *testing.T) {\n\t\tresult, err := normalizeResult(\"hello world\")\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Unexpected error: %v\", err)\n\t\t}\n\n\t\tif result.TextResultForLLM != \"hello world\" {\n\t\t\tt.Errorf(\"Expected 'hello world', got %q\", result.TextResultForLLM)\n\t\t}\n\t\tif result.ResultType != \"success\" {\n\t\t\tt.Errorf(\"Expected ResultType 'success', got %q\", result.ResultType)\n\t\t}\n\t})\n\n\tt.Run(\"ToolResult passes through directly\", func(t *testing.T) {\n\t\tinput := ToolResult{\n\t\t\tTextResultForLLM: \"custom result\",\n\t\t\tResultType: \"failure\",\n\t\t\tError: \"some error\",\n\t\t}\n\n\t\tresult, err := normalizeResult(input)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Unexpected error: %v\", err)\n\t\t}\n\n\t\tif result.TextResultForLLM != \"custom result\" {\n\t\t\tt.Errorf(\"Expected 'custom result', got %q\", result.TextResultForLLM)\n\t\t}\n\t\tif result.ResultType != \"failure\" {\n\t\t\tt.Errorf(\"Expected ResultType 'failure', got %q\", result.ResultType)\n\t\t}\n\t\tif result.Error != \"some error\" {\n\t\t\tt.Errorf(\"Expected Error 'some error', got %q\", result.Error)\n\t\t}\n\t})\n\n\tt.Run(\"struct is JSON serialized\", func(t *testing.T) {\n\t\ttype Response struct {\n\t\t\tStatus string `json:\"status\"`\n\t\t\tCount int `json:\"count\"`\n\t\t}\n\n\t\tresult, err := normalizeResult(Response{Status: \"ok\", Count: 5})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Unexpected error: %v\", err)\n\t\t}\n\n\t\texpected := `{\"status\":\"ok\",\"count\":5}`\n\t\tif result.TextResultForLLM != expected {\n\t\t\tt.Errorf(\"Expected %q, got %q\", expected, result.TextResultForLLM)\n\t\t}\n\t\tif result.ResultType != \"success\" {\n\t\t\tt.Errorf(\"Expected ResultType 'success', got %q\", result.ResultType)\n\t\t}\n\t})\n\n\tt.Run(\"map is JSON serialized\", func(t *testing.T) {\n\t\tresult, err := normalizeResult(map[string]any{\n\t\t\t\"key\": \"value\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Unexpected error: %v\", err)\n\t\t}\n\n\t\texpected := `{\"key\":\"value\"}`\n\t\tif result.TextResultForLLM != expected {\n\t\t\tt.Errorf(\"Expected %q, got %q\", expected, result.TextResultForLLM)\n\t\t}\n\t})\n\n\tt.Run(\"slice is JSON serialized\", func(t *testing.T) {\n\t\tresult, err := normalizeResult([]string{\"a\", \"b\", \"c\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Unexpected error: %v\", err)\n\t\t}\n\n\t\texpected := `[\"a\",\"b\",\"c\"]`\n\t\tif result.TextResultForLLM != expected {\n\t\t\tt.Errorf(\"Expected %q, got %q\", expected, result.TextResultForLLM)\n\t\t}\n\t})\n\n\tt.Run(\"returns error for unserializable value\", func(t *testing.T) {\n\t\t// Channels cannot be JSON serialized\n\t\tch := make(chan int)\n\t\t_, err := normalizeResult(ch)\n\t\tif err == nil {\n\t\t\tt.Fatal(\"Expected error for unserializable value, got nil\")\n\t\t}\n\t})\n}\n\nfunc TestConvertMCPCallToolResult(t *testing.T) {\n\tt.Run(\"typed CallToolResult struct is converted\", func(t *testing.T) {\n\t\ttype Resource struct {\n\t\t\tURI string `json:\"uri\"`\n\t\t\tText string `json:\"text\"`\n\t\t}\n\t\ttype ContentBlock struct {\n\t\t\tType string `json:\"type\"`\n\t\t\tResource *Resource `json:\"resource,omitempty\"`\n\t\t}\n\t\ttype CallToolResult struct {\n\t\t\tContent []ContentBlock `json:\"content\"`\n\t\t}\n\n\t\tinput := CallToolResult{\n\t\t\tContent: []ContentBlock{\n\t\t\t\t{\n\t\t\t\t\tType: \"resource\",\n\t\t\t\t\tResource: &Resource{URI: \"file:///report.txt\", Text: \"details\"},\n\t\t\t\t},\n\t\t\t},\n\t\t}\n\n\t\tresult, ok := ConvertMCPCallToolResult(input)\n\t\tif !ok {\n\t\t\tt.Fatal(\"Expected ConvertMCPCallToolResult to succeed\")\n\t\t}\n\t\tif result.TextResultForLLM != \"details\" {\n\t\t\tt.Errorf(\"Expected 'details', got %q\", result.TextResultForLLM)\n\t\t}\n\t\tif result.ResultType != \"success\" {\n\t\t\tt.Errorf(\"Expected 'success', got %q\", result.ResultType)\n\t\t}\n\t})\n\n\tt.Run(\"text-only CallToolResult is converted\", func(t *testing.T) {\n\t\tinput := map[string]any{\n\t\t\t\"content\": []any{\n\t\t\t\tmap[string]any{\"type\": \"text\", \"text\": \"hello\"},\n\t\t\t},\n\t\t}\n\n\t\tresult, ok := ConvertMCPCallToolResult(input)\n\t\tif !ok {\n\t\t\tt.Fatal(\"Expected ConvertMCPCallToolResult to succeed\")\n\t\t}\n\t\tif result.TextResultForLLM != \"hello\" {\n\t\t\tt.Errorf(\"Expected 'hello', got %q\", result.TextResultForLLM)\n\t\t}\n\t\tif result.ResultType != \"success\" {\n\t\t\tt.Errorf(\"Expected 'success', got %q\", result.ResultType)\n\t\t}\n\t})\n\n\tt.Run(\"multiple text blocks are joined with newline\", func(t *testing.T) {\n\t\tinput := map[string]any{\n\t\t\t\"content\": []any{\n\t\t\t\tmap[string]any{\"type\": \"text\", \"text\": \"line 1\"},\n\t\t\t\tmap[string]any{\"type\": \"text\", \"text\": \"line 2\"},\n\t\t\t},\n\t\t}\n\n\t\tresult, ok := ConvertMCPCallToolResult(input)\n\t\tif !ok {\n\t\t\tt.Fatal(\"Expected ConvertMCPCallToolResult to succeed\")\n\t\t}\n\t\tif result.TextResultForLLM != \"line 1\\nline 2\" {\n\t\t\tt.Errorf(\"Expected 'line 1\\\\nline 2', got %q\", result.TextResultForLLM)\n\t\t}\n\t})\n\n\tt.Run(\"isError maps to failure resultType\", func(t *testing.T) {\n\t\tinput := map[string]any{\n\t\t\t\"content\": []any{\n\t\t\t\tmap[string]any{\"type\": \"text\", \"text\": \"oops\"},\n\t\t\t},\n\t\t\t\"isError\": true,\n\t\t}\n\n\t\tresult, ok := ConvertMCPCallToolResult(input)\n\t\tif !ok {\n\t\t\tt.Fatal(\"Expected ConvertMCPCallToolResult to succeed\")\n\t\t}\n\t\tif result.ResultType != \"failure\" {\n\t\t\tt.Errorf(\"Expected 'failure', got %q\", result.ResultType)\n\t\t}\n\t})\n\n\tt.Run(\"image content becomes binaryResultsForLLM\", func(t *testing.T) {\n\t\tinput := map[string]any{\n\t\t\t\"content\": []any{\n\t\t\t\tmap[string]any{\"type\": \"image\", \"data\": \"base64data\", \"mimeType\": \"image/png\"},\n\t\t\t},\n\t\t}\n\n\t\tresult, ok := ConvertMCPCallToolResult(input)\n\t\tif !ok {\n\t\t\tt.Fatal(\"Expected ConvertMCPCallToolResult to succeed\")\n\t\t}\n\t\tif len(result.BinaryResultsForLLM) != 1 {\n\t\t\tt.Fatalf(\"Expected 1 binary result, got %d\", len(result.BinaryResultsForLLM))\n\t\t}\n\t\tif result.BinaryResultsForLLM[0].Data != \"base64data\" {\n\t\t\tt.Errorf(\"Expected data 'base64data', got %q\", result.BinaryResultsForLLM[0].Data)\n\t\t}\n\t\tif result.BinaryResultsForLLM[0].MimeType != \"image/png\" {\n\t\t\tt.Errorf(\"Expected mimeType 'image/png', got %q\", result.BinaryResultsForLLM[0].MimeType)\n\t\t}\n\t})\n\n\tt.Run(\"resource text goes to textResultForLLM\", func(t *testing.T) {\n\t\tinput := map[string]any{\n\t\t\t\"content\": []any{\n\t\t\t\tmap[string]any{\n\t\t\t\t\t\"type\": \"resource\",\n\t\t\t\t\t\"resource\": map[string]any{\"uri\": \"file:///tmp/data.txt\", \"text\": \"file contents\"},\n\t\t\t\t},\n\t\t\t},\n\t\t}\n\n\t\tresult, ok := ConvertMCPCallToolResult(input)\n\t\tif !ok {\n\t\t\tt.Fatal(\"Expected ConvertMCPCallToolResult to succeed\")\n\t\t}\n\t\tif result.TextResultForLLM != \"file contents\" {\n\t\t\tt.Errorf(\"Expected 'file contents', got %q\", result.TextResultForLLM)\n\t\t}\n\t})\n\n\tt.Run(\"resource blob goes to binaryResultsForLLM\", func(t *testing.T) {\n\t\tinput := map[string]any{\n\t\t\t\"content\": []any{\n\t\t\t\tmap[string]any{\n\t\t\t\t\t\"type\": \"resource\",\n\t\t\t\t\t\"resource\": map[string]any{\"uri\": \"file:///img.png\", \"blob\": \"blobdata\", \"mimeType\": \"image/png\"},\n\t\t\t\t},\n\t\t\t},\n\t\t}\n\n\t\tresult, ok := ConvertMCPCallToolResult(input)\n\t\tif !ok {\n\t\t\tt.Fatal(\"Expected ConvertMCPCallToolResult to succeed\")\n\t\t}\n\t\tif len(result.BinaryResultsForLLM) != 1 {\n\t\t\tt.Fatalf(\"Expected 1 binary result, got %d\", len(result.BinaryResultsForLLM))\n\t\t}\n\t\tif result.BinaryResultsForLLM[0].Description != \"file:///img.png\" {\n\t\t\tt.Errorf(\"Expected description 'file:///img.png', got %q\", result.BinaryResultsForLLM[0].Description)\n\t\t}\n\t})\n\n\tt.Run(\"non-CallToolResult map returns false\", func(t *testing.T) {\n\t\tinput := map[string]any{\n\t\t\t\"key\": \"value\",\n\t\t}\n\n\t\t_, ok := ConvertMCPCallToolResult(input)\n\t\tif ok {\n\t\t\tt.Error(\"Expected ConvertMCPCallToolResult to return false for non-CallToolResult map\")\n\t\t}\n\t})\n\n\tt.Run(\"empty content array is converted\", func(t *testing.T) {\n\t\tinput := map[string]any{\n\t\t\t\"content\": []any{},\n\t\t}\n\n\t\tresult, ok := ConvertMCPCallToolResult(input)\n\t\tif !ok {\n\t\t\tt.Fatal(\"Expected ConvertMCPCallToolResult to succeed\")\n\t\t}\n\t\tif result.TextResultForLLM != \"\" {\n\t\t\tt.Errorf(\"Expected empty text, got %q\", result.TextResultForLLM)\n\t\t}\n\t\tif result.ResultType != \"success\" {\n\t\t\tt.Errorf(\"Expected 'success', got %q\", result.ResultType)\n\t\t}\n\t})\n}\n\nfunc TestGenerateSchemaForType(t *testing.T) {\n\tt.Run(\"generates schema for simple struct\", func(t *testing.T) {\n\t\ttype Simple struct {\n\t\t\tName string `json:\"name\"`\n\t\t\tAge int `json:\"age\"`\n\t\t}\n\n\t\tschema := generateSchemaForType(reflect.TypeOf(Simple{}))\n\n\t\tif schema[\"type\"] != \"object\" {\n\t\t\tt.Errorf(\"Expected type 'object', got %v\", schema[\"type\"])\n\t\t}\n\n\t\tprops, ok := schema[\"properties\"].(map[string]any)\n\t\tif !ok {\n\t\t\tt.Fatalf(\"Expected properties map, got %T\", schema[\"properties\"])\n\t\t}\n\n\t\tnameProp, ok := props[\"name\"].(map[string]any)\n\t\tif !ok {\n\t\t\tt.Fatal(\"Expected 'name' property\")\n\t\t}\n\t\tif nameProp[\"type\"] != \"string\" {\n\t\t\tt.Errorf(\"Expected name type 'string', got %v\", nameProp[\"type\"])\n\t\t}\n\n\t\tageProp, ok := props[\"age\"].(map[string]any)\n\t\tif !ok {\n\t\t\tt.Fatal(\"Expected 'age' property\")\n\t\t}\n\t\tif ageProp[\"type\"] != \"integer\" {\n\t\t\tt.Errorf(\"Expected age type 'integer', got %v\", ageProp[\"type\"])\n\t\t}\n\t})\n\n\tt.Run(\"handles nested structs\", func(t *testing.T) {\n\t\ttype Address struct {\n\t\t\tCity string `json:\"city\"`\n\t\t\tCountry string `json:\"country\"`\n\t\t}\n\t\ttype Person struct {\n\t\t\tName string `json:\"name\"`\n\t\t\tAddress Address `json:\"address\"`\n\t\t}\n\n\t\tschema := generateSchemaForType(reflect.TypeOf(Person{}))\n\n\t\tprops := schema[\"properties\"].(map[string]any)\n\t\taddrProp, ok := props[\"address\"].(map[string]any)\n\t\tif !ok {\n\t\t\tt.Fatal(\"Expected 'address' property\")\n\t\t}\n\n\t\t// Nested struct should have properties\n\t\taddrProps, ok := addrProp[\"properties\"].(map[string]any)\n\t\tif !ok {\n\t\t\tt.Fatal(\"Expected address to have properties\")\n\t\t}\n\t\tif _, ok := addrProps[\"city\"]; !ok {\n\t\t\tt.Error(\"Expected 'city' in address properties\")\n\t\t}\n\t})\n\n\tt.Run(\"handles pointer types\", func(t *testing.T) {\n\t\ttype Params struct {\n\t\t\tValue string `json:\"value\"`\n\t\t}\n\n\t\tschema := generateSchemaForType(reflect.TypeOf(&Params{}))\n\n\t\tif schema[\"type\"] != \"object\" {\n\t\t\tt.Errorf(\"Expected type 'object', got %v\", schema[\"type\"])\n\t\t}\n\n\t\tprops := schema[\"properties\"].(map[string]any)\n\t\tif _, ok := props[\"value\"]; !ok {\n\t\t\tt.Error(\"Expected 'value' property\")\n\t\t}\n\t})\n\n\tt.Run(\"handles nil type\", func(t *testing.T) {\n\t\tschema := generateSchemaForType(nil)\n\n\t\tif schema != nil {\n\t\t\tt.Errorf(\"Expected nil schema for nil type, got %v\", schema)\n\t\t}\n\t})\n\n\tt.Run(\"handles slices\", func(t *testing.T) {\n\t\ttype Params struct {\n\t\t\tTags []string `json:\"tags\"`\n\t\t}\n\n\t\tschema := generateSchemaForType(reflect.TypeOf(Params{}))\n\n\t\tprops := schema[\"properties\"].(map[string]any)\n\t\ttagsProp, ok := props[\"tags\"].(map[string]any)\n\t\tif !ok {\n\t\t\tt.Fatal(\"Expected 'tags' property\")\n\t\t}\n\n\t\t// Schema library may return \"array\" or [\"null\", \"array\"] for slices\n\t\ttagType := tagsProp[\"type\"]\n\t\tswitch v := tagType.(type) {\n\t\tcase string:\n\t\t\tif v != \"array\" {\n\t\t\t\tt.Errorf(\"Expected tags type 'array', got %v\", v)\n\t\t\t}\n\t\tcase []any:\n\t\t\thasArray := false\n\t\t\tfor _, item := range v {\n\t\t\t\tif item == \"array\" {\n\t\t\t\t\thasArray = true\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t}\n\t\t\tif !hasArray {\n\t\t\t\tt.Errorf(\"Expected tags type to include 'array', got %v\", v)\n\t\t\t}\n\t\tdefault:\n\t\t\tt.Errorf(\"Expected tags type to be string or array, got %T: %v\", tagType, tagType)\n\t\t}\n\t})\n}\n" }, { "path": "go/embeddedcli/installer.go", "content": "package embeddedcli\n\nimport \"github.com/github/copilot-sdk/go/internal/embeddedcli\"\n\n// Config defines the inputs used to install and locate the embedded Copilot CLI.\n//\n// Cli and CliHash are required. If Dir is empty, the CLI is installed into the\n// system cache directory. Version is used to suffix the installed binary name to\n// allow multiple versions to coexist. License, when provided, is written next\n// to the installed binary.\ntype Config = embeddedcli.Config\n\n// Setup sets the embedded GitHub Copilot CLI install configuration.\n// The CLI will be lazily installed when needed.\nfunc Setup(cfg Config) {\n\tembeddedcli.Setup(cfg)\n}\n" }, { "path": "go/generated_session_events.go", "content": "// AUTO-GENERATED FILE - DO NOT EDIT\n// Generated from: session-events.schema.json\n\npackage copilot\n\nimport (\n\t\"encoding/json\"\n\t\"time\"\n)\n\n// SessionEventData is the interface implemented by all per-event data types.\ntype SessionEventData interface {\n\tsessionEventData()\n}\n\n// RawSessionEventData holds unparsed JSON data for unrecognized event types.\ntype RawSessionEventData struct {\n\tRaw json.RawMessage\n}\n\nfunc (RawSessionEventData) sessionEventData() {}\n\n// MarshalJSON returns the original raw JSON so round-tripping preserves the payload.\nfunc (r RawSessionEventData) MarshalJSON() ([]byte, error) { return r.Raw, nil }\n\n// SessionEvent represents a single session event with a typed data payload.\ntype SessionEvent struct {\n\t// Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n\tAgentID *string `json:\"agentId,omitempty\"`\n\t// When true, the event is transient and not persisted to the session event log on disk\n\tEphemeral *bool `json:\"ephemeral,omitempty\"`\n\t// Unique event identifier (UUID v4), generated when the event is emitted\n\tID string `json:\"id\"`\n\t// ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n\tParentID *string `json:\"parentId\"`\n\t// ISO 8601 timestamp when the event was created\n\tTimestamp time.Time `json:\"timestamp\"`\n\t// The event type discriminator.\n\tType SessionEventType `json:\"type\"`\n\t// Typed event payload. Use a type switch to access per-event fields.\n\tData SessionEventData `json:\"-\"`\n}\n\n// UnmarshalSessionEvent parses JSON bytes into a SessionEvent.\nfunc UnmarshalSessionEvent(data []byte) (SessionEvent, error) {\n\tvar r SessionEvent\n\terr := json.Unmarshal(data, &r)\n\treturn r, err\n}\n\n// Marshal serializes the SessionEvent to JSON.\nfunc (r *SessionEvent) Marshal() ([]byte, error) {\n\treturn json.Marshal(r)\n}\n\nfunc (e *SessionEvent) UnmarshalJSON(data []byte) error {\n\ttype rawEvent struct {\n\t\tAgentID *string `json:\"agentId,omitempty\"`\n\t\tEphemeral *bool `json:\"ephemeral,omitempty\"`\n\t\tID string `json:\"id\"`\n\t\tParentID *string `json:\"parentId\"`\n\t\tTimestamp time.Time `json:\"timestamp\"`\n\t\tType SessionEventType `json:\"type\"`\n\t\tData json.RawMessage `json:\"data\"`\n\t}\n\tvar raw rawEvent\n\tif err := json.Unmarshal(data, &raw); err != nil {\n\t\treturn err\n\t}\n\te.AgentID = raw.AgentID\n\te.Ephemeral = raw.Ephemeral\n\te.ID = raw.ID\n\te.ParentID = raw.ParentID\n\te.Timestamp = raw.Timestamp\n\te.Type = raw.Type\n\n\tswitch raw.Type {\n\tcase SessionEventTypeSessionStart:\n\t\tvar d SessionStartData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionResume:\n\t\tvar d SessionResumeData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionRemoteSteerableChanged:\n\t\tvar d SessionRemoteSteerableChangedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionError:\n\t\tvar d SessionErrorData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionIdle:\n\t\tvar d SessionIdleData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionTitleChanged:\n\t\tvar d SessionTitleChangedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionInfo:\n\t\tvar d SessionInfoData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionWarning:\n\t\tvar d SessionWarningData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionModelChange:\n\t\tvar d SessionModelChangeData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionModeChanged:\n\t\tvar d SessionModeChangedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionPlanChanged:\n\t\tvar d SessionPlanChangedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionWorkspaceFileChanged:\n\t\tvar d SessionWorkspaceFileChangedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionHandoff:\n\t\tvar d SessionHandoffData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionTruncation:\n\t\tvar d SessionTruncationData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionSnapshotRewind:\n\t\tvar d SessionSnapshotRewindData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionShutdown:\n\t\tvar d SessionShutdownData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionContextChanged:\n\t\tvar d SessionContextChangedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionUsageInfo:\n\t\tvar d SessionUsageInfoData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionCompactionStart:\n\t\tvar d SessionCompactionStartData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionCompactionComplete:\n\t\tvar d SessionCompactionCompleteData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionTaskComplete:\n\t\tvar d SessionTaskCompleteData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeUserMessage:\n\t\tvar d UserMessageData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypePendingMessagesModified:\n\t\tvar d PendingMessagesModifiedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeAssistantTurnStart:\n\t\tvar d AssistantTurnStartData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeAssistantIntent:\n\t\tvar d AssistantIntentData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeAssistantReasoning:\n\t\tvar d AssistantReasoningData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeAssistantReasoningDelta:\n\t\tvar d AssistantReasoningDeltaData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeAssistantStreamingDelta:\n\t\tvar d AssistantStreamingDeltaData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeAssistantMessage:\n\t\tvar d AssistantMessageData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeAssistantMessageStart:\n\t\tvar d AssistantMessageStartData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeAssistantMessageDelta:\n\t\tvar d AssistantMessageDeltaData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeAssistantTurnEnd:\n\t\tvar d AssistantTurnEndData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeAssistantUsage:\n\t\tvar d AssistantUsageData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeModelCallFailure:\n\t\tvar d ModelCallFailureData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeAbort:\n\t\tvar d AbortData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeToolUserRequested:\n\t\tvar d ToolUserRequestedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeToolExecutionStart:\n\t\tvar d ToolExecutionStartData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeToolExecutionPartialResult:\n\t\tvar d ToolExecutionPartialResultData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeToolExecutionProgress:\n\t\tvar d ToolExecutionProgressData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeToolExecutionComplete:\n\t\tvar d ToolExecutionCompleteData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSkillInvoked:\n\t\tvar d SkillInvokedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSubagentStarted:\n\t\tvar d SubagentStartedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSubagentCompleted:\n\t\tvar d SubagentCompletedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSubagentFailed:\n\t\tvar d SubagentFailedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSubagentSelected:\n\t\tvar d SubagentSelectedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSubagentDeselected:\n\t\tvar d SubagentDeselectedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeHookStart:\n\t\tvar d HookStartData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeHookEnd:\n\t\tvar d HookEndData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSystemMessage:\n\t\tvar d SystemMessageData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSystemNotification:\n\t\tvar d SystemNotificationData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypePermissionRequested:\n\t\tvar d PermissionRequestedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypePermissionCompleted:\n\t\tvar d PermissionCompletedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeUserInputRequested:\n\t\tvar d UserInputRequestedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeUserInputCompleted:\n\t\tvar d UserInputCompletedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeElicitationRequested:\n\t\tvar d ElicitationRequestedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeElicitationCompleted:\n\t\tvar d ElicitationCompletedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSamplingRequested:\n\t\tvar d SamplingRequestedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSamplingCompleted:\n\t\tvar d SamplingCompletedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeMcpOauthRequired:\n\t\tvar d McpOauthRequiredData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeMcpOauthCompleted:\n\t\tvar d McpOauthCompletedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeExternalToolRequested:\n\t\tvar d ExternalToolRequestedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeExternalToolCompleted:\n\t\tvar d ExternalToolCompletedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeCommandQueued:\n\t\tvar d CommandQueuedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeCommandExecute:\n\t\tvar d CommandExecuteData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeCommandCompleted:\n\t\tvar d CommandCompletedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeAutoModeSwitchRequested:\n\t\tvar d AutoModeSwitchRequestedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeAutoModeSwitchCompleted:\n\t\tvar d AutoModeSwitchCompletedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeCommandsChanged:\n\t\tvar d CommandsChangedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeCapabilitiesChanged:\n\t\tvar d CapabilitiesChangedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeExitPlanModeRequested:\n\t\tvar d ExitPlanModeRequestedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeExitPlanModeCompleted:\n\t\tvar d ExitPlanModeCompletedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionToolsUpdated:\n\t\tvar d SessionToolsUpdatedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionBackgroundTasksChanged:\n\t\tvar d SessionBackgroundTasksChangedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionSkillsLoaded:\n\t\tvar d SessionSkillsLoadedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionCustomAgentsUpdated:\n\t\tvar d SessionCustomAgentsUpdatedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionMcpServersLoaded:\n\t\tvar d SessionMcpServersLoadedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionMcpServerStatusChanged:\n\t\tvar d SessionMcpServerStatusChangedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tcase SessionEventTypeSessionExtensionsLoaded:\n\t\tvar d SessionExtensionsLoadedData\n\t\tif err := json.Unmarshal(raw.Data, &d); err != nil {\n\t\t\treturn err\n\t\t}\n\t\te.Data = &d\n\tdefault:\n\t\te.Data = &RawSessionEventData{Raw: raw.Data}\n\t}\n\treturn nil\n}\n\nfunc (e SessionEvent) MarshalJSON() ([]byte, error) {\n\ttype rawEvent struct {\n\t\tAgentID *string `json:\"agentId,omitempty\"`\n\t\tEphemeral *bool `json:\"ephemeral,omitempty\"`\n\t\tID string `json:\"id\"`\n\t\tParentID *string `json:\"parentId\"`\n\t\tTimestamp time.Time `json:\"timestamp\"`\n\t\tType SessionEventType `json:\"type\"`\n\t\tData any `json:\"data\"`\n\t}\n\treturn json.Marshal(rawEvent{\n\t\tAgentID: e.AgentID,\n\t\tEphemeral: e.Ephemeral,\n\t\tID: e.ID,\n\t\tParentID: e.ParentID,\n\t\tTimestamp: e.Timestamp,\n\t\tType: e.Type,\n\t\tData: e.Data,\n\t})\n}\n\n// SessionEventType identifies the kind of session event.\ntype SessionEventType string\n\nconst (\n\tSessionEventTypeSessionStart SessionEventType = \"session.start\"\n\tSessionEventTypeSessionResume SessionEventType = \"session.resume\"\n\tSessionEventTypeSessionRemoteSteerableChanged SessionEventType = \"session.remote_steerable_changed\"\n\tSessionEventTypeSessionError SessionEventType = \"session.error\"\n\tSessionEventTypeSessionIdle SessionEventType = \"session.idle\"\n\tSessionEventTypeSessionTitleChanged SessionEventType = \"session.title_changed\"\n\tSessionEventTypeSessionInfo SessionEventType = \"session.info\"\n\tSessionEventTypeSessionWarning SessionEventType = \"session.warning\"\n\tSessionEventTypeSessionModelChange SessionEventType = \"session.model_change\"\n\tSessionEventTypeSessionModeChanged SessionEventType = \"session.mode_changed\"\n\tSessionEventTypeSessionPlanChanged SessionEventType = \"session.plan_changed\"\n\tSessionEventTypeSessionWorkspaceFileChanged SessionEventType = \"session.workspace_file_changed\"\n\tSessionEventTypeSessionHandoff SessionEventType = \"session.handoff\"\n\tSessionEventTypeSessionTruncation SessionEventType = \"session.truncation\"\n\tSessionEventTypeSessionSnapshotRewind SessionEventType = \"session.snapshot_rewind\"\n\tSessionEventTypeSessionShutdown SessionEventType = \"session.shutdown\"\n\tSessionEventTypeSessionContextChanged SessionEventType = \"session.context_changed\"\n\tSessionEventTypeSessionUsageInfo SessionEventType = \"session.usage_info\"\n\tSessionEventTypeSessionCompactionStart SessionEventType = \"session.compaction_start\"\n\tSessionEventTypeSessionCompactionComplete SessionEventType = \"session.compaction_complete\"\n\tSessionEventTypeSessionTaskComplete SessionEventType = \"session.task_complete\"\n\tSessionEventTypeUserMessage SessionEventType = \"user.message\"\n\tSessionEventTypePendingMessagesModified SessionEventType = \"pending_messages.modified\"\n\tSessionEventTypeAssistantTurnStart SessionEventType = \"assistant.turn_start\"\n\tSessionEventTypeAssistantIntent SessionEventType = \"assistant.intent\"\n\tSessionEventTypeAssistantReasoning SessionEventType = \"assistant.reasoning\"\n\tSessionEventTypeAssistantReasoningDelta SessionEventType = \"assistant.reasoning_delta\"\n\tSessionEventTypeAssistantStreamingDelta SessionEventType = \"assistant.streaming_delta\"\n\tSessionEventTypeAssistantMessage SessionEventType = \"assistant.message\"\n\tSessionEventTypeAssistantMessageStart SessionEventType = \"assistant.message_start\"\n\tSessionEventTypeAssistantMessageDelta SessionEventType = \"assistant.message_delta\"\n\tSessionEventTypeAssistantTurnEnd SessionEventType = \"assistant.turn_end\"\n\tSessionEventTypeAssistantUsage SessionEventType = \"assistant.usage\"\n\tSessionEventTypeModelCallFailure SessionEventType = \"model.call_failure\"\n\tSessionEventTypeAbort SessionEventType = \"abort\"\n\tSessionEventTypeToolUserRequested SessionEventType = \"tool.user_requested\"\n\tSessionEventTypeToolExecutionStart SessionEventType = \"tool.execution_start\"\n\tSessionEventTypeToolExecutionPartialResult SessionEventType = \"tool.execution_partial_result\"\n\tSessionEventTypeToolExecutionProgress SessionEventType = \"tool.execution_progress\"\n\tSessionEventTypeToolExecutionComplete SessionEventType = \"tool.execution_complete\"\n\tSessionEventTypeSkillInvoked SessionEventType = \"skill.invoked\"\n\tSessionEventTypeSubagentStarted SessionEventType = \"subagent.started\"\n\tSessionEventTypeSubagentCompleted SessionEventType = \"subagent.completed\"\n\tSessionEventTypeSubagentFailed SessionEventType = \"subagent.failed\"\n\tSessionEventTypeSubagentSelected SessionEventType = \"subagent.selected\"\n\tSessionEventTypeSubagentDeselected SessionEventType = \"subagent.deselected\"\n\tSessionEventTypeHookStart SessionEventType = \"hook.start\"\n\tSessionEventTypeHookEnd SessionEventType = \"hook.end\"\n\tSessionEventTypeSystemMessage SessionEventType = \"system.message\"\n\tSessionEventTypeSystemNotification SessionEventType = \"system.notification\"\n\tSessionEventTypePermissionRequested SessionEventType = \"permission.requested\"\n\tSessionEventTypePermissionCompleted SessionEventType = \"permission.completed\"\n\tSessionEventTypeUserInputRequested SessionEventType = \"user_input.requested\"\n\tSessionEventTypeUserInputCompleted SessionEventType = \"user_input.completed\"\n\tSessionEventTypeElicitationRequested SessionEventType = \"elicitation.requested\"\n\tSessionEventTypeElicitationCompleted SessionEventType = \"elicitation.completed\"\n\tSessionEventTypeSamplingRequested SessionEventType = \"sampling.requested\"\n\tSessionEventTypeSamplingCompleted SessionEventType = \"sampling.completed\"\n\tSessionEventTypeMcpOauthRequired SessionEventType = \"mcp.oauth_required\"\n\tSessionEventTypeMcpOauthCompleted SessionEventType = \"mcp.oauth_completed\"\n\tSessionEventTypeExternalToolRequested SessionEventType = \"external_tool.requested\"\n\tSessionEventTypeExternalToolCompleted SessionEventType = \"external_tool.completed\"\n\tSessionEventTypeCommandQueued SessionEventType = \"command.queued\"\n\tSessionEventTypeCommandExecute SessionEventType = \"command.execute\"\n\tSessionEventTypeCommandCompleted SessionEventType = \"command.completed\"\n\tSessionEventTypeAutoModeSwitchRequested SessionEventType = \"auto_mode_switch.requested\"\n\tSessionEventTypeAutoModeSwitchCompleted SessionEventType = \"auto_mode_switch.completed\"\n\tSessionEventTypeCommandsChanged SessionEventType = \"commands.changed\"\n\tSessionEventTypeCapabilitiesChanged SessionEventType = \"capabilities.changed\"\n\tSessionEventTypeExitPlanModeRequested SessionEventType = \"exit_plan_mode.requested\"\n\tSessionEventTypeExitPlanModeCompleted SessionEventType = \"exit_plan_mode.completed\"\n\tSessionEventTypeSessionToolsUpdated SessionEventType = \"session.tools_updated\"\n\tSessionEventTypeSessionBackgroundTasksChanged SessionEventType = \"session.background_tasks_changed\"\n\tSessionEventTypeSessionSkillsLoaded SessionEventType = \"session.skills_loaded\"\n\tSessionEventTypeSessionCustomAgentsUpdated SessionEventType = \"session.custom_agents_updated\"\n\tSessionEventTypeSessionMcpServersLoaded SessionEventType = \"session.mcp_servers_loaded\"\n\tSessionEventTypeSessionMcpServerStatusChanged SessionEventType = \"session.mcp_server_status_changed\"\n\tSessionEventTypeSessionExtensionsLoaded SessionEventType = \"session.extensions_loaded\"\n)\n\n// Agent intent description for current activity or plan\ntype AssistantIntentData struct {\n\t// Short description of what the agent is currently doing or planning to do\n\tIntent string `json:\"intent\"`\n}\n\nfunc (*AssistantIntentData) sessionEventData() {}\n\n// Agent mode change details including previous and new modes\ntype SessionModeChangedData struct {\n\t// Agent mode after the change (e.g., \"interactive\", \"plan\", \"autopilot\")\n\tNewMode string `json:\"newMode\"`\n\t// Agent mode before the change (e.g., \"interactive\", \"plan\", \"autopilot\")\n\tPreviousMode string `json:\"previousMode\"`\n}\n\nfunc (*SessionModeChangedData) sessionEventData() {}\n\n// Assistant reasoning content for timeline display with complete thinking text\ntype AssistantReasoningData struct {\n\t// The complete extended thinking text from the model\n\tContent string `json:\"content\"`\n\t// Unique identifier for this reasoning block\n\tReasoningID string `json:\"reasoningId\"`\n}\n\nfunc (*AssistantReasoningData) sessionEventData() {}\n\n// Assistant response containing text content, optional tool requests, and interaction metadata\ntype AssistantMessageData struct {\n\t// The assistant's text response content\n\tContent string `json:\"content\"`\n\t// Encrypted reasoning content from OpenAI models. Session-bound and stripped on resume.\n\tEncryptedContent *string `json:\"encryptedContent,omitempty\"`\n\t// CAPI interaction ID for correlating this message with upstream telemetry\n\tInteractionID *string `json:\"interactionId,omitempty\"`\n\t// Unique identifier for this assistant message\n\tMessageID string `json:\"messageId\"`\n\t// Actual output token count from the API response (completion_tokens), used for accurate token accounting\n\tOutputTokens *float64 `json:\"outputTokens,omitempty\"`\n\t// Tool call ID of the parent tool invocation when this event originates from a sub-agent\n\t// Deprecated: ParentToolCallID is deprecated.\n\tParentToolCallID *string `json:\"parentToolCallId,omitempty\"`\n\t// Generation phase for phased-output models (e.g., thinking vs. response phases)\n\tPhase *string `json:\"phase,omitempty\"`\n\t// Opaque/encrypted extended thinking data from Anthropic models. Session-bound and stripped on resume.\n\tReasoningOpaque *string `json:\"reasoningOpaque,omitempty\"`\n\t// Readable reasoning text from the model's extended thinking\n\tReasoningText *string `json:\"reasoningText,omitempty\"`\n\t// GitHub request tracing ID (x-github-request-id header) for correlating with server-side logs\n\tRequestID *string `json:\"requestId,omitempty\"`\n\t// Tool invocations requested by the assistant in this message\n\tToolRequests []AssistantMessageToolRequest `json:\"toolRequests,omitempty\"`\n\t// Identifier for the agent loop turn that produced this message, matching the corresponding assistant.turn_start event\n\tTurnID *string `json:\"turnId,omitempty\"`\n}\n\nfunc (*AssistantMessageData) sessionEventData() {}\n\n// Auto mode switch completion notification\ntype AutoModeSwitchCompletedData struct {\n\t// Request ID of the resolved request; clients should dismiss any UI for this request\n\tRequestID string `json:\"requestId\"`\n\t// The user's choice: 'yes', 'yes_always', or 'no'\n\tResponse string `json:\"response\"`\n}\n\nfunc (*AutoModeSwitchCompletedData) sessionEventData() {}\n\n// Auto mode switch request notification requiring user approval\ntype AutoModeSwitchRequestedData struct {\n\t// The rate limit error code that triggered this request\n\tErrorCode *string `json:\"errorCode,omitempty\"`\n\t// Unique identifier for this request; used to respond via session.respondToAutoModeSwitch()\n\tRequestID string `json:\"requestId\"`\n\t// Seconds until the rate limit resets, when known. Lets clients render a humanized reset time alongside the prompt.\n\tRetryAfterSeconds *float64 `json:\"retryAfterSeconds,omitempty\"`\n}\n\nfunc (*AutoModeSwitchRequestedData) sessionEventData() {}\n\n// Context window breakdown at the start of LLM-powered conversation compaction\ntype SessionCompactionStartData struct {\n\t// Token count from non-system messages (user, assistant, tool) at compaction start\n\tConversationTokens *float64 `json:\"conversationTokens,omitempty\"`\n\t// Token count from system message(s) at compaction start\n\tSystemTokens *float64 `json:\"systemTokens,omitempty\"`\n\t// Token count from tool definitions at compaction start\n\tToolDefinitionsTokens *float64 `json:\"toolDefinitionsTokens,omitempty\"`\n}\n\nfunc (*SessionCompactionStartData) sessionEventData() {}\n\n// Conversation compaction results including success status, metrics, and optional error details\ntype SessionCompactionCompleteData struct {\n\t// Checkpoint snapshot number created for recovery\n\tCheckpointNumber *float64 `json:\"checkpointNumber,omitempty\"`\n\t// File path where the checkpoint was stored\n\tCheckpointPath *string `json:\"checkpointPath,omitempty\"`\n\t// Token usage breakdown for the compaction LLM call (aligned with assistant.usage format)\n\tCompactionTokensUsed *CompactionCompleteCompactionTokensUsed `json:\"compactionTokensUsed,omitempty\"`\n\t// Token count from non-system messages (user, assistant, tool) after compaction\n\tConversationTokens *float64 `json:\"conversationTokens,omitempty\"`\n\t// Error message if compaction failed\n\tError *string `json:\"error,omitempty\"`\n\t// Number of messages removed during compaction\n\tMessagesRemoved *float64 `json:\"messagesRemoved,omitempty\"`\n\t// Total tokens in conversation after compaction\n\tPostCompactionTokens *float64 `json:\"postCompactionTokens,omitempty\"`\n\t// Number of messages before compaction\n\tPreCompactionMessagesLength *float64 `json:\"preCompactionMessagesLength,omitempty\"`\n\t// Total tokens in conversation before compaction\n\tPreCompactionTokens *float64 `json:\"preCompactionTokens,omitempty\"`\n\t// GitHub request tracing ID (x-github-request-id header) for the compaction LLM call\n\tRequestID *string `json:\"requestId,omitempty\"`\n\t// Whether compaction completed successfully\n\tSuccess bool `json:\"success\"`\n\t// LLM-generated summary of the compacted conversation history\n\tSummaryContent *string `json:\"summaryContent,omitempty\"`\n\t// Token count from system message(s) after compaction\n\tSystemTokens *float64 `json:\"systemTokens,omitempty\"`\n\t// Number of tokens removed during compaction\n\tTokensRemoved *float64 `json:\"tokensRemoved,omitempty\"`\n\t// Token count from tool definitions after compaction\n\tToolDefinitionsTokens *float64 `json:\"toolDefinitionsTokens,omitempty\"`\n}\n\nfunc (*SessionCompactionCompleteData) sessionEventData() {}\n\n// Conversation truncation statistics including token counts and removed content metrics\ntype SessionTruncationData struct {\n\t// Number of messages removed by truncation\n\tMessagesRemovedDuringTruncation float64 `json:\"messagesRemovedDuringTruncation\"`\n\t// Identifier of the component that performed truncation (e.g., \"BasicTruncator\")\n\tPerformedBy string `json:\"performedBy\"`\n\t// Number of conversation messages after truncation\n\tPostTruncationMessagesLength float64 `json:\"postTruncationMessagesLength\"`\n\t// Total tokens in conversation messages after truncation\n\tPostTruncationTokensInMessages float64 `json:\"postTruncationTokensInMessages\"`\n\t// Number of conversation messages before truncation\n\tPreTruncationMessagesLength float64 `json:\"preTruncationMessagesLength\"`\n\t// Total tokens in conversation messages before truncation\n\tPreTruncationTokensInMessages float64 `json:\"preTruncationTokensInMessages\"`\n\t// Maximum token count for the model's context window\n\tTokenLimit float64 `json:\"tokenLimit\"`\n\t// Number of tokens removed by truncation\n\tTokensRemovedDuringTruncation float64 `json:\"tokensRemovedDuringTruncation\"`\n}\n\nfunc (*SessionTruncationData) sessionEventData() {}\n\n// Current context window usage statistics including token and message counts\ntype SessionUsageInfoData struct {\n\t// Token count from non-system messages (user, assistant, tool)\n\tConversationTokens *float64 `json:\"conversationTokens,omitempty\"`\n\t// Current number of tokens in the context window\n\tCurrentTokens float64 `json:\"currentTokens\"`\n\t// Whether this is the first usage_info event emitted in this session\n\tIsInitial *bool `json:\"isInitial,omitempty\"`\n\t// Current number of messages in the conversation\n\tMessagesLength float64 `json:\"messagesLength\"`\n\t// Token count from system message(s)\n\tSystemTokens *float64 `json:\"systemTokens,omitempty\"`\n\t// Maximum token count for the model's context window\n\tTokenLimit float64 `json:\"tokenLimit\"`\n\t// Token count from tool definitions\n\tToolDefinitionsTokens *float64 `json:\"toolDefinitionsTokens,omitempty\"`\n}\n\nfunc (*SessionUsageInfoData) sessionEventData() {}\n\n// Custom agent selection details including name and available tools\ntype SubagentSelectedData struct {\n\t// Human-readable display name of the selected custom agent\n\tAgentDisplayName string `json:\"agentDisplayName\"`\n\t// Internal name of the selected custom agent\n\tAgentName string `json:\"agentName\"`\n\t// List of tool names available to this agent, or null for all tools\n\tTools []string `json:\"tools\"`\n}\n\nfunc (*SubagentSelectedData) sessionEventData() {}\n\n// Elicitation request completion with the user's response\ntype ElicitationCompletedData struct {\n\t// The user action: \"accept\" (submitted form), \"decline\" (explicitly refused), or \"cancel\" (dismissed)\n\tAction *ElicitationCompletedAction `json:\"action,omitempty\"`\n\t// The submitted form data when action is 'accept'; keys match the requested schema fields\n\tContent map[string]any `json:\"content,omitempty\"`\n\t// Request ID of the resolved elicitation request; clients should dismiss any UI for this request\n\tRequestID string `json:\"requestId\"`\n}\n\nfunc (*ElicitationCompletedData) sessionEventData() {}\n\n// Elicitation request; may be form-based (structured input) or URL-based (browser redirect)\ntype ElicitationRequestedData struct {\n\t// The source that initiated the request (MCP server name, or absent for agent-initiated)\n\tElicitationSource *string `json:\"elicitationSource,omitempty\"`\n\t// Message describing what information is needed from the user\n\tMessage string `json:\"message\"`\n\t// Elicitation mode; \"form\" for structured input, \"url\" for browser-based. Defaults to \"form\" when absent.\n\tMode *ElicitationRequestedMode `json:\"mode,omitempty\"`\n\t// JSON Schema describing the form fields to present to the user (form mode only)\n\tRequestedSchema *ElicitationRequestedSchema `json:\"requestedSchema,omitempty\"`\n\t// Unique identifier for this elicitation request; used to respond via session.respondToElicitation()\n\tRequestID string `json:\"requestId\"`\n\t// Tool call ID from the LLM completion; used to correlate with CompletionChunk.toolCall.id for remote UIs\n\tToolCallID *string `json:\"toolCallId,omitempty\"`\n\t// URL to open in the user's browser (url mode only)\n\tURL *string `json:\"url,omitempty\"`\n}\n\nfunc (*ElicitationRequestedData) sessionEventData() {}\n\n// Empty payload; the event signals that the custom agent was deselected, returning to the default agent\ntype SubagentDeselectedData struct {\n}\n\nfunc (*SubagentDeselectedData) sessionEventData() {}\n\n// Empty payload; the event signals that the pending message queue has changed\ntype PendingMessagesModifiedData struct {\n}\n\nfunc (*PendingMessagesModifiedData) sessionEventData() {}\n\n// Error details for timeline display including message and optional diagnostic information\ntype SessionErrorData struct {\n\t// Only set on `errorType: \"rate_limit\"`. When `true`, the runtime will follow this error with an `auto_mode_switch.requested` event (or silently switch if `continueOnAutoMode` is enabled). UI clients can use this flag to suppress duplicate rendering of the rate-limit error when they show their own auto-mode-switch prompt.\n\tEligibleForAutoSwitch *bool `json:\"eligibleForAutoSwitch,omitempty\"`\n\t// Fine-grained error code from the upstream provider, when available. For `errorType: \"rate_limit\"`, this is one of the `RateLimitErrorCode` values (e.g., `\"user_weekly_rate_limited\"`, `\"user_global_rate_limited\"`, `\"rate_limited\"`, `\"user_model_rate_limited\"`, `\"integration_rate_limited\"`).\n\tErrorCode *string `json:\"errorCode,omitempty\"`\n\t// Category of error (e.g., \"authentication\", \"authorization\", \"quota\", \"rate_limit\", \"context_limit\", \"query\")\n\tErrorType string `json:\"errorType\"`\n\t// Human-readable error message\n\tMessage string `json:\"message\"`\n\t// GitHub request tracing ID (x-github-request-id header) for correlating with server-side logs\n\tProviderCallID *string `json:\"providerCallId,omitempty\"`\n\t// Error stack trace, when available\n\tStack *string `json:\"stack,omitempty\"`\n\t// HTTP status code from the upstream request, if applicable\n\tStatusCode *int64 `json:\"statusCode,omitempty\"`\n\t// Optional URL associated with this error that the user can open in a browser\n\tURL *string `json:\"url,omitempty\"`\n}\n\nfunc (*SessionErrorData) sessionEventData() {}\n\n// External tool completion notification signaling UI dismissal\ntype ExternalToolCompletedData struct {\n\t// Request ID of the resolved external tool request; clients should dismiss any UI for this request\n\tRequestID string `json:\"requestId\"`\n}\n\nfunc (*ExternalToolCompletedData) sessionEventData() {}\n\n// External tool invocation request for client-side tool execution\ntype ExternalToolRequestedData struct {\n\t// Arguments to pass to the external tool\n\tArguments any `json:\"arguments,omitempty\"`\n\t// Unique identifier for this request; used to respond via session.respondToExternalTool()\n\tRequestID string `json:\"requestId\"`\n\t// Session ID that this external tool request belongs to\n\tSessionID string `json:\"sessionId\"`\n\t// Tool call ID assigned to this external tool invocation\n\tToolCallID string `json:\"toolCallId\"`\n\t// Name of the external tool to invoke\n\tToolName string `json:\"toolName\"`\n\t// W3C Trace Context traceparent header for the execute_tool span\n\tTraceparent *string `json:\"traceparent,omitempty\"`\n\t// W3C Trace Context tracestate header for the execute_tool span\n\tTracestate *string `json:\"tracestate,omitempty\"`\n}\n\nfunc (*ExternalToolRequestedData) sessionEventData() {}\n\n// Failed LLM API call metadata for telemetry\ntype ModelCallFailureData struct {\n\t// Completion ID from the model provider (e.g., chatcmpl-abc123)\n\tAPICallID *string `json:\"apiCallId,omitempty\"`\n\t// Duration of the failed API call in milliseconds\n\tDurationMs *float64 `json:\"durationMs,omitempty\"`\n\t// Raw provider/runtime error message for restricted telemetry\n\tErrorMessage *string `json:\"errorMessage,omitempty\"`\n\t// What initiated this API call (e.g., \"sub-agent\", \"mcp-sampling\"); absent for user-initiated calls\n\tInitiator *string `json:\"initiator,omitempty\"`\n\t// Model identifier used for the failed API call\n\tModel *string `json:\"model,omitempty\"`\n\t// GitHub request tracing ID (x-github-request-id header) for server-side log correlation\n\tProviderCallID *string `json:\"providerCallId,omitempty\"`\n\t// Where the failed model call originated\n\tSource ModelCallFailureSource `json:\"source\"`\n\t// HTTP status code from the failed request\n\tStatusCode *int64 `json:\"statusCode,omitempty\"`\n}\n\nfunc (*ModelCallFailureData) sessionEventData() {}\n\n// Hook invocation completion details including output, success status, and error information\ntype HookEndData struct {\n\t// Error details when the hook failed\n\tError *HookEndError `json:\"error,omitempty\"`\n\t// Identifier matching the corresponding hook.start event\n\tHookInvocationID string `json:\"hookInvocationId\"`\n\t// Type of hook that was invoked (e.g., \"preToolUse\", \"postToolUse\", \"sessionStart\")\n\tHookType string `json:\"hookType\"`\n\t// Output data produced by the hook\n\tOutput any `json:\"output,omitempty\"`\n\t// Whether the hook completed successfully\n\tSuccess bool `json:\"success\"`\n}\n\nfunc (*HookEndData) sessionEventData() {}\n\n// Hook invocation start details including type and input data\ntype HookStartData struct {\n\t// Unique identifier for this hook invocation\n\tHookInvocationID string `json:\"hookInvocationId\"`\n\t// Type of hook being invoked (e.g., \"preToolUse\", \"postToolUse\", \"sessionStart\")\n\tHookType string `json:\"hookType\"`\n\t// Input data passed to the hook\n\tInput any `json:\"input,omitempty\"`\n}\n\nfunc (*HookStartData) sessionEventData() {}\n\n// Informational message for timeline display with categorization\ntype SessionInfoData struct {\n\t// Category of informational message (e.g., \"notification\", \"timing\", \"context_window\", \"mcp\", \"snapshot\", \"configuration\", \"authentication\", \"model\")\n\tInfoType string `json:\"infoType\"`\n\t// Human-readable informational message for display in the timeline\n\tMessage string `json:\"message\"`\n\t// Optional actionable tip displayed with this message\n\tTip *string `json:\"tip,omitempty\"`\n\t// Optional URL associated with this message that the user can open in a browser\n\tURL *string `json:\"url,omitempty\"`\n}\n\nfunc (*SessionInfoData) sessionEventData() {}\n\n// LLM API call usage metrics including tokens, costs, quotas, and billing information\ntype AssistantUsageData struct {\n\t// Completion ID from the model provider (e.g., chatcmpl-abc123)\n\tAPICallID *string `json:\"apiCallId,omitempty\"`\n\t// Number of tokens read from prompt cache\n\tCacheReadTokens *float64 `json:\"cacheReadTokens,omitempty\"`\n\t// Number of tokens written to prompt cache\n\tCacheWriteTokens *float64 `json:\"cacheWriteTokens,omitempty\"`\n\t// Per-request cost and usage data from the CAPI copilot_usage response field\n\tCopilotUsage *AssistantUsageCopilotUsage `json:\"copilotUsage,omitempty\"`\n\t// Model multiplier cost for billing purposes\n\tCost *float64 `json:\"cost,omitempty\"`\n\t// Duration of the API call in milliseconds\n\tDuration *float64 `json:\"duration,omitempty\"`\n\t// What initiated this API call (e.g., \"sub-agent\", \"mcp-sampling\"); absent for user-initiated calls\n\tInitiator *string `json:\"initiator,omitempty\"`\n\t// Number of input tokens consumed\n\tInputTokens *float64 `json:\"inputTokens,omitempty\"`\n\t// Average inter-token latency in milliseconds. Only available for streaming requests\n\tInterTokenLatencyMs *float64 `json:\"interTokenLatencyMs,omitempty\"`\n\t// Model identifier used for this API call\n\tModel string `json:\"model\"`\n\t// Number of output tokens produced\n\tOutputTokens *float64 `json:\"outputTokens,omitempty\"`\n\t// Parent tool call ID when this usage originates from a sub-agent\n\t// Deprecated: ParentToolCallID is deprecated.\n\tParentToolCallID *string `json:\"parentToolCallId,omitempty\"`\n\t// GitHub request tracing ID (x-github-request-id header) for server-side log correlation\n\tProviderCallID *string `json:\"providerCallId,omitempty\"`\n\t// Per-quota resource usage snapshots, keyed by quota identifier\n\tQuotaSnapshots map[string]AssistantUsageQuotaSnapshot `json:\"quotaSnapshots,omitempty\"`\n\t// Reasoning effort level used for model calls, if applicable (e.g. \"low\", \"medium\", \"high\", \"xhigh\")\n\tReasoningEffort *string `json:\"reasoningEffort,omitempty\"`\n\t// Number of output tokens used for reasoning (e.g., chain-of-thought)\n\tReasoningTokens *float64 `json:\"reasoningTokens,omitempty\"`\n\t// Time to first token in milliseconds. Only available for streaming requests\n\tTtftMs *float64 `json:\"ttftMs,omitempty\"`\n}\n\nfunc (*AssistantUsageData) sessionEventData() {}\n\n// MCP OAuth request completion notification\ntype McpOauthCompletedData struct {\n\t// Request ID of the resolved OAuth request\n\tRequestID string `json:\"requestId\"`\n}\n\nfunc (*McpOauthCompletedData) sessionEventData() {}\n\n// Model change details including previous and new model identifiers\ntype SessionModelChangeData struct {\n\t// Reason the change happened, when not user-initiated. Currently `\"rate_limit_auto_switch\"` for changes triggered by the auto-mode-switch rate-limit recovery path. UI clients can use this to render contextual copy.\n\tCause *string `json:\"cause,omitempty\"`\n\t// Newly selected model identifier\n\tNewModel string `json:\"newModel\"`\n\t// Model that was previously selected, if any\n\tPreviousModel *string `json:\"previousModel,omitempty\"`\n\t// Reasoning effort level before the model change, if applicable\n\tPreviousReasoningEffort *string `json:\"previousReasoningEffort,omitempty\"`\n\t// Reasoning effort level after the model change, if applicable\n\tReasoningEffort *string `json:\"reasoningEffort,omitempty\"`\n}\n\nfunc (*SessionModelChangeData) sessionEventData() {}\n\n// Notifies Mission Control that the session's remote steering capability has changed\ntype SessionRemoteSteerableChangedData struct {\n\t// Whether this session now supports remote steering via Mission Control\n\tRemoteSteerable bool `json:\"remoteSteerable\"`\n}\n\nfunc (*SessionRemoteSteerableChangedData) sessionEventData() {}\n\n// OAuth authentication request for an MCP server\ntype McpOauthRequiredData struct {\n\t// Unique identifier for this OAuth request; used to respond via session.respondToMcpOAuth()\n\tRequestID string `json:\"requestId\"`\n\t// Display name of the MCP server that requires OAuth\n\tServerName string `json:\"serverName\"`\n\t// URL of the MCP server that requires OAuth\n\tServerURL string `json:\"serverUrl\"`\n\t// Static OAuth client configuration, if the server specifies one\n\tStaticClientConfig *McpOauthRequiredStaticClientConfig `json:\"staticClientConfig,omitempty\"`\n}\n\nfunc (*McpOauthRequiredData) sessionEventData() {}\n\n// Payload indicating the session is idle with no background agents in flight\ntype SessionIdleData struct {\n\t// True when the preceding agentic loop was cancelled via abort signal\n\tAborted *bool `json:\"aborted,omitempty\"`\n}\n\nfunc (*SessionIdleData) sessionEventData() {}\n\n// Permission request completion notification signaling UI dismissal\ntype PermissionCompletedData struct {\n\t// Request ID of the resolved permission request; clients should dismiss any UI for this request\n\tRequestID string `json:\"requestId\"`\n\t// The result of the permission request\n\tResult PermissionResult `json:\"result\"`\n\t// Optional tool call ID associated with this permission prompt; clients may use it to correlate UI created from tool-scoped prompts\n\tToolCallID *string `json:\"toolCallId,omitempty\"`\n}\n\nfunc (*PermissionCompletedData) sessionEventData() {}\n\n// Permission request notification requiring client approval with request details\ntype PermissionRequestedData struct {\n\t// Details of the permission being requested\n\tPermissionRequest PermissionRequest `json:\"permissionRequest\"`\n\t// Derived user-facing permission prompt details for UI consumers\n\tPromptRequest *PermissionPromptRequest `json:\"promptRequest,omitempty\"`\n\t// Unique identifier for this permission request; used to respond via session.respondToPermission()\n\tRequestID string `json:\"requestId\"`\n\t// When true, this permission was already resolved by a permissionRequest hook and requires no client action\n\tResolvedByHook *bool `json:\"resolvedByHook,omitempty\"`\n}\n\nfunc (*PermissionRequestedData) sessionEventData() {}\n\n// Plan approval request with plan content and available user actions\ntype ExitPlanModeRequestedData struct {\n\t// Available actions the user can take (e.g., approve, edit, reject)\n\tActions []string `json:\"actions\"`\n\t// Full content of the plan file\n\tPlanContent string `json:\"planContent\"`\n\t// The recommended action for the user to take\n\tRecommendedAction string `json:\"recommendedAction\"`\n\t// Unique identifier for this request; used to respond via session.respondToExitPlanMode()\n\tRequestID string `json:\"requestId\"`\n\t// Summary of the plan that was created\n\tSummary string `json:\"summary\"`\n}\n\nfunc (*ExitPlanModeRequestedData) sessionEventData() {}\n\n// Plan file operation details indicating what changed\ntype SessionPlanChangedData struct {\n\t// The type of operation performed on the plan file\n\tOperation PlanChangedOperation `json:\"operation\"`\n}\n\nfunc (*SessionPlanChangedData) sessionEventData() {}\n\n// Plan mode exit completion with the user's approval decision and optional feedback\ntype ExitPlanModeCompletedData struct {\n\t// Whether the plan was approved by the user\n\tApproved *bool `json:\"approved,omitempty\"`\n\t// Whether edits should be auto-approved without confirmation\n\tAutoApproveEdits *bool `json:\"autoApproveEdits,omitempty\"`\n\t// Free-form feedback from the user if they requested changes to the plan\n\tFeedback *string `json:\"feedback,omitempty\"`\n\t// Request ID of the resolved exit plan mode request; clients should dismiss any UI for this request\n\tRequestID string `json:\"requestId\"`\n\t// Which action the user selected (e.g. 'autopilot', 'interactive', 'exit_only')\n\tSelectedAction *string `json:\"selectedAction,omitempty\"`\n}\n\nfunc (*ExitPlanModeCompletedData) sessionEventData() {}\n\n// Queued command completion notification signaling UI dismissal\ntype CommandCompletedData struct {\n\t// Request ID of the resolved command request; clients should dismiss any UI for this request\n\tRequestID string `json:\"requestId\"`\n}\n\nfunc (*CommandCompletedData) sessionEventData() {}\n\n// Queued slash command dispatch request for client execution\ntype CommandQueuedData struct {\n\t// The slash command text to be executed (e.g., /help, /clear)\n\tCommand string `json:\"command\"`\n\t// Unique identifier for this request; used to respond via session.respondToQueuedCommand()\n\tRequestID string `json:\"requestId\"`\n}\n\nfunc (*CommandQueuedData) sessionEventData() {}\n\n// Registered command dispatch request routed to the owning client\ntype CommandExecuteData struct {\n\t// Raw argument string after the command name\n\tArgs string `json:\"args\"`\n\t// The full command text (e.g., /deploy production)\n\tCommand string `json:\"command\"`\n\t// Command name without leading /\n\tCommandName string `json:\"commandName\"`\n\t// Unique identifier; used to respond via session.commands.handlePendingCommand()\n\tRequestID string `json:\"requestId\"`\n}\n\nfunc (*CommandExecuteData) sessionEventData() {}\n\n// SDK command registration change notification\ntype CommandsChangedData struct {\n\t// Current list of registered SDK commands\n\tCommands []CommandsChangedCommand `json:\"commands\"`\n}\n\nfunc (*CommandsChangedData) sessionEventData() {}\n\n// Sampling request completion notification signaling UI dismissal\ntype SamplingCompletedData struct {\n\t// Request ID of the resolved sampling request; clients should dismiss any UI for this request\n\tRequestID string `json:\"requestId\"`\n}\n\nfunc (*SamplingCompletedData) sessionEventData() {}\n\n// Sampling request from an MCP server; contains the server name and a requestId for correlation\ntype SamplingRequestedData struct {\n\t// The JSON-RPC request ID from the MCP protocol\n\tMcpRequestID any `json:\"mcpRequestId\"`\n\t// Unique identifier for this sampling request; used to respond via session.respondToSampling()\n\tRequestID string `json:\"requestId\"`\n\t// Name of the MCP server that initiated the sampling request\n\tServerName string `json:\"serverName\"`\n}\n\nfunc (*SamplingRequestedData) sessionEventData() {}\n\n// Session capability change notification\ntype CapabilitiesChangedData struct {\n\t// UI capability changes\n\tUI *CapabilitiesChangedUI `json:\"ui,omitempty\"`\n}\n\nfunc (*CapabilitiesChangedData) sessionEventData() {}\n\n// Session handoff metadata including source, context, and repository information\ntype SessionHandoffData struct {\n\t// Additional context information for the handoff\n\tContext *string `json:\"context,omitempty\"`\n\t// ISO 8601 timestamp when the handoff occurred\n\tHandoffTime time.Time `json:\"handoffTime\"`\n\t// GitHub host URL for the source session (e.g., https://github.com or https://tenant.ghe.com)\n\tHost *string `json:\"host,omitempty\"`\n\t// Session ID of the remote session being handed off\n\tRemoteSessionID *string `json:\"remoteSessionId,omitempty\"`\n\t// Repository context for the handed-off session\n\tRepository *HandoffRepository `json:\"repository,omitempty\"`\n\t// Origin type of the session being handed off\n\tSourceType HandoffSourceType `json:\"sourceType\"`\n\t// Summary of the work done in the source session\n\tSummary *string `json:\"summary,omitempty\"`\n}\n\nfunc (*SessionHandoffData) sessionEventData() {}\n\n// Session initialization metadata including context and configuration\ntype SessionStartData struct {\n\t// Whether the session was already in use by another client at start time\n\tAlreadyInUse *bool `json:\"alreadyInUse,omitempty\"`\n\t// Working directory and git context at session start\n\tContext *WorkingDirectoryContext `json:\"context,omitempty\"`\n\t// Version string of the Copilot application\n\tCopilotVersion string `json:\"copilotVersion\"`\n\t// Identifier of the software producing the events (e.g., \"copilot-agent\")\n\tProducer string `json:\"producer\"`\n\t// Reasoning effort level used for model calls, if applicable (e.g. \"low\", \"medium\", \"high\", \"xhigh\")\n\tReasoningEffort *string `json:\"reasoningEffort,omitempty\"`\n\t// Whether this session supports remote steering via Mission Control\n\tRemoteSteerable *bool `json:\"remoteSteerable,omitempty\"`\n\t// Model selected at session creation time, if any\n\tSelectedModel *string `json:\"selectedModel,omitempty\"`\n\t// Unique identifier for the session\n\tSessionID string `json:\"sessionId\"`\n\t// ISO 8601 timestamp when the session was created\n\tStartTime time.Time `json:\"startTime\"`\n\t// Schema version number for the session event format\n\tVersion float64 `json:\"version\"`\n}\n\nfunc (*SessionStartData) sessionEventData() {}\n\n// Session resume metadata including current context and event count\ntype SessionResumeData struct {\n\t// Whether the session was already in use by another client at resume time\n\tAlreadyInUse *bool `json:\"alreadyInUse,omitempty\"`\n\t// Updated working directory and git context at resume time\n\tContext *WorkingDirectoryContext `json:\"context,omitempty\"`\n\t// When true, tool calls and permission requests left in flight by the previous session lifetime remain pending after resume and the agentic loop awaits their results. User sends are queued behind the pending work until all such requests reach a terminal state. When false (the default), any such tool calls and permission requests are immediately marked as interrupted on resume.\n\tContinuePendingWork *bool `json:\"continuePendingWork,omitempty\"`\n\t// Total number of persisted events in the session at the time of resume\n\tEventCount float64 `json:\"eventCount\"`\n\t// Reasoning effort level used for model calls, if applicable (e.g. \"low\", \"medium\", \"high\", \"xhigh\")\n\tReasoningEffort *string `json:\"reasoningEffort,omitempty\"`\n\t// Whether this session supports remote steering via Mission Control\n\tRemoteSteerable *bool `json:\"remoteSteerable,omitempty\"`\n\t// ISO 8601 timestamp when the session was resumed\n\tResumeTime time.Time `json:\"resumeTime\"`\n\t// Model currently selected at resume time\n\tSelectedModel *string `json:\"selectedModel,omitempty\"`\n\t// True when this resume attached to a session that the runtime already had running in-memory (for example, an extension joining a session another client was actively driving). False (or omitted) for cold resumes — the runtime had to reconstitute the session from its persisted event log.\n\tSessionWasActive *bool `json:\"sessionWasActive,omitempty\"`\n}\n\nfunc (*SessionResumeData) sessionEventData() {}\n\n// Session rewind details including target event and count of removed events\ntype SessionSnapshotRewindData struct {\n\t// Number of events that were removed by the rewind\n\tEventsRemoved float64 `json:\"eventsRemoved\"`\n\t// Event ID that was rewound to; this event and all after it were removed\n\tUpToEventID string `json:\"upToEventId\"`\n}\n\nfunc (*SessionSnapshotRewindData) sessionEventData() {}\n\n// Session termination metrics including usage statistics, code changes, and shutdown reason\ntype SessionShutdownData struct {\n\t// Aggregate code change metrics for the session\n\tCodeChanges ShutdownCodeChanges `json:\"codeChanges\"`\n\t// Non-system message token count at shutdown\n\tConversationTokens *float64 `json:\"conversationTokens,omitempty\"`\n\t// Model that was selected at the time of shutdown\n\tCurrentModel *string `json:\"currentModel,omitempty\"`\n\t// Total tokens in context window at shutdown\n\tCurrentTokens *float64 `json:\"currentTokens,omitempty\"`\n\t// Error description when shutdownType is \"error\"\n\tErrorReason *string `json:\"errorReason,omitempty\"`\n\t// Per-model usage breakdown, keyed by model identifier\n\tModelMetrics map[string]ShutdownModelMetric `json:\"modelMetrics\"`\n\t// Unix timestamp (milliseconds) when the session started\n\tSessionStartTime float64 `json:\"sessionStartTime\"`\n\t// Whether the session ended normally (\"routine\") or due to a crash/fatal error (\"error\")\n\tShutdownType ShutdownType `json:\"shutdownType\"`\n\t// System message token count at shutdown\n\tSystemTokens *float64 `json:\"systemTokens,omitempty\"`\n\t// Session-wide per-token-type accumulated token counts\n\tTokenDetails map[string]ShutdownTokenDetail `json:\"tokenDetails,omitempty\"`\n\t// Tool definitions token count at shutdown\n\tToolDefinitionsTokens *float64 `json:\"toolDefinitionsTokens,omitempty\"`\n\t// Cumulative time spent in API calls during the session, in milliseconds\n\tTotalAPIDurationMs float64 `json:\"totalApiDurationMs\"`\n\t// Session-wide accumulated nano-AI units cost\n\tTotalNanoAiu *float64 `json:\"totalNanoAiu,omitempty\"`\n\t// Total number of premium API requests used during the session\n\tTotalPremiumRequests float64 `json:\"totalPremiumRequests\"`\n}\n\nfunc (*SessionShutdownData) sessionEventData() {}\n\n// Session title change payload containing the new display title\ntype SessionTitleChangedData struct {\n\t// The new display title for the session\n\tTitle string `json:\"title\"`\n}\n\nfunc (*SessionTitleChangedData) sessionEventData() {}\n\n// SessionBackgroundTasksChangedData holds the payload for session.background_tasks_changed events.\ntype SessionBackgroundTasksChangedData struct {\n}\n\nfunc (*SessionBackgroundTasksChangedData) sessionEventData() {}\n\n// SessionCustomAgentsUpdatedData holds the payload for session.custom_agents_updated events.\ntype SessionCustomAgentsUpdatedData struct {\n\t// Array of loaded custom agent metadata\n\tAgents []CustomAgentsUpdatedAgent `json:\"agents\"`\n\t// Fatal errors from agent loading\n\tErrors []string `json:\"errors\"`\n\t// Non-fatal warnings from agent loading\n\tWarnings []string `json:\"warnings\"`\n}\n\nfunc (*SessionCustomAgentsUpdatedData) sessionEventData() {}\n\n// SessionExtensionsLoadedData holds the payload for session.extensions_loaded events.\ntype SessionExtensionsLoadedData struct {\n\t// Array of discovered extensions and their status\n\tExtensions []ExtensionsLoadedExtension `json:\"extensions\"`\n}\n\nfunc (*SessionExtensionsLoadedData) sessionEventData() {}\n\n// SessionMcpServerStatusChangedData holds the payload for session.mcp_server_status_changed events.\ntype SessionMcpServerStatusChangedData struct {\n\t// Name of the MCP server whose status changed\n\tServerName string `json:\"serverName\"`\n\t// New connection status: connected, failed, needs-auth, pending, disabled, or not_configured\n\tStatus McpServerStatusChangedStatus `json:\"status\"`\n}\n\nfunc (*SessionMcpServerStatusChangedData) sessionEventData() {}\n\n// SessionMcpServersLoadedData holds the payload for session.mcp_servers_loaded events.\ntype SessionMcpServersLoadedData struct {\n\t// Array of MCP server status summaries\n\tServers []McpServersLoadedServer `json:\"servers\"`\n}\n\nfunc (*SessionMcpServersLoadedData) sessionEventData() {}\n\n// SessionSkillsLoadedData holds the payload for session.skills_loaded events.\ntype SessionSkillsLoadedData struct {\n\t// Array of resolved skill metadata\n\tSkills []SkillsLoadedSkill `json:\"skills\"`\n}\n\nfunc (*SessionSkillsLoadedData) sessionEventData() {}\n\n// SessionToolsUpdatedData holds the payload for session.tools_updated events.\ntype SessionToolsUpdatedData struct {\n\tModel string `json:\"model\"`\n}\n\nfunc (*SessionToolsUpdatedData) sessionEventData() {}\n\n// Skill invocation details including content, allowed tools, and plugin metadata\ntype SkillInvokedData struct {\n\t// Tool names that should be auto-approved when this skill is active\n\tAllowedTools []string `json:\"allowedTools,omitempty\"`\n\t// Full content of the skill file, injected into the conversation for the model\n\tContent string `json:\"content\"`\n\t// Description of the skill from its SKILL.md frontmatter\n\tDescription *string `json:\"description,omitempty\"`\n\t// Name of the invoked skill\n\tName string `json:\"name\"`\n\t// File path to the SKILL.md definition\n\tPath string `json:\"path\"`\n\t// Name of the plugin this skill originated from, when applicable\n\tPluginName *string `json:\"pluginName,omitempty\"`\n\t// Version of the plugin this skill originated from, when applicable\n\tPluginVersion *string `json:\"pluginVersion,omitempty\"`\n}\n\nfunc (*SkillInvokedData) sessionEventData() {}\n\n// Streaming assistant message delta for incremental response updates\ntype AssistantMessageDeltaData struct {\n\t// Incremental text chunk to append to the message content\n\tDeltaContent string `json:\"deltaContent\"`\n\t// Message ID this delta belongs to, matching the corresponding assistant.message event\n\tMessageID string `json:\"messageId\"`\n\t// Tool call ID of the parent tool invocation when this event originates from a sub-agent\n\t// Deprecated: ParentToolCallID is deprecated.\n\tParentToolCallID *string `json:\"parentToolCallId,omitempty\"`\n}\n\nfunc (*AssistantMessageDeltaData) sessionEventData() {}\n\n// Streaming assistant message start metadata\ntype AssistantMessageStartData struct {\n\t// Message ID this start event belongs to, matching subsequent deltas and assistant.message\n\tMessageID string `json:\"messageId\"`\n\t// Generation phase this message belongs to for phased-output models\n\tPhase *string `json:\"phase,omitempty\"`\n}\n\nfunc (*AssistantMessageStartData) sessionEventData() {}\n\n// Streaming reasoning delta for incremental extended thinking updates\ntype AssistantReasoningDeltaData struct {\n\t// Incremental text chunk to append to the reasoning content\n\tDeltaContent string `json:\"deltaContent\"`\n\t// Reasoning block ID this delta belongs to, matching the corresponding assistant.reasoning event\n\tReasoningID string `json:\"reasoningId\"`\n}\n\nfunc (*AssistantReasoningDeltaData) sessionEventData() {}\n\n// Streaming response progress with cumulative byte count\ntype AssistantStreamingDeltaData struct {\n\t// Cumulative total bytes received from the streaming response so far\n\tTotalResponseSizeBytes float64 `json:\"totalResponseSizeBytes\"`\n}\n\nfunc (*AssistantStreamingDeltaData) sessionEventData() {}\n\n// Streaming tool execution output for incremental result display\ntype ToolExecutionPartialResultData struct {\n\t// Incremental output chunk from the running tool\n\tPartialOutput string `json:\"partialOutput\"`\n\t// Tool call ID this partial result belongs to\n\tToolCallID string `json:\"toolCallId\"`\n}\n\nfunc (*ToolExecutionPartialResultData) sessionEventData() {}\n\n// Sub-agent completion details for successful execution\ntype SubagentCompletedData struct {\n\t// Human-readable display name of the sub-agent\n\tAgentDisplayName string `json:\"agentDisplayName\"`\n\t// Internal name of the sub-agent\n\tAgentName string `json:\"agentName\"`\n\t// Wall-clock duration of the sub-agent execution in milliseconds\n\tDurationMs *float64 `json:\"durationMs,omitempty\"`\n\t// Model used by the sub-agent\n\tModel *string `json:\"model,omitempty\"`\n\t// Tool call ID of the parent tool invocation that spawned this sub-agent\n\tToolCallID string `json:\"toolCallId\"`\n\t// Total tokens (input + output) consumed by the sub-agent\n\tTotalTokens *float64 `json:\"totalTokens,omitempty\"`\n\t// Total number of tool calls made by the sub-agent\n\tTotalToolCalls *float64 `json:\"totalToolCalls,omitempty\"`\n}\n\nfunc (*SubagentCompletedData) sessionEventData() {}\n\n// Sub-agent failure details including error message and agent information\ntype SubagentFailedData struct {\n\t// Human-readable display name of the sub-agent\n\tAgentDisplayName string `json:\"agentDisplayName\"`\n\t// Internal name of the sub-agent\n\tAgentName string `json:\"agentName\"`\n\t// Wall-clock duration of the sub-agent execution in milliseconds\n\tDurationMs *float64 `json:\"durationMs,omitempty\"`\n\t// Error message describing why the sub-agent failed\n\tError string `json:\"error\"`\n\t// Model used by the sub-agent (if any model calls succeeded before failure)\n\tModel *string `json:\"model,omitempty\"`\n\t// Tool call ID of the parent tool invocation that spawned this sub-agent\n\tToolCallID string `json:\"toolCallId\"`\n\t// Total tokens (input + output) consumed before the sub-agent failed\n\tTotalTokens *float64 `json:\"totalTokens,omitempty\"`\n\t// Total number of tool calls made before the sub-agent failed\n\tTotalToolCalls *float64 `json:\"totalToolCalls,omitempty\"`\n}\n\nfunc (*SubagentFailedData) sessionEventData() {}\n\n// Sub-agent startup details including parent tool call and agent information\ntype SubagentStartedData struct {\n\t// Description of what the sub-agent does\n\tAgentDescription string `json:\"agentDescription\"`\n\t// Human-readable display name of the sub-agent\n\tAgentDisplayName string `json:\"agentDisplayName\"`\n\t// Internal name of the sub-agent\n\tAgentName string `json:\"agentName\"`\n\t// Tool call ID of the parent tool invocation that spawned this sub-agent\n\tToolCallID string `json:\"toolCallId\"`\n}\n\nfunc (*SubagentStartedData) sessionEventData() {}\n\n// System-generated notification for runtime events like background task completion\ntype SystemNotificationData struct {\n\t// The notification text, typically wrapped in XML tags\n\tContent string `json:\"content\"`\n\t// Structured metadata identifying what triggered this notification\n\tKind SystemNotification `json:\"kind\"`\n}\n\nfunc (*SystemNotificationData) sessionEventData() {}\n\n// System/developer instruction content with role and optional template metadata\ntype SystemMessageData struct {\n\t// The system or developer prompt text sent as model input\n\tContent string `json:\"content\"`\n\t// Metadata about the prompt template and its construction\n\tMetadata *SystemMessageMetadata `json:\"metadata,omitempty\"`\n\t// Optional name identifier for the message source\n\tName *string `json:\"name,omitempty\"`\n\t// Message role: \"system\" for system prompts, \"developer\" for developer-injected instructions\n\tRole SystemMessageRole `json:\"role\"`\n}\n\nfunc (*SystemMessageData) sessionEventData() {}\n\n// Task completion notification with summary from the agent\ntype SessionTaskCompleteData struct {\n\t// Whether the tool call succeeded. False when validation failed (e.g., invalid arguments)\n\tSuccess *bool `json:\"success,omitempty\"`\n\t// Summary of the completed task, provided by the agent\n\tSummary *string `json:\"summary,omitempty\"`\n}\n\nfunc (*SessionTaskCompleteData) sessionEventData() {}\n\n// Tool execution completion results including success status, detailed output, and error information\ntype ToolExecutionCompleteData struct {\n\t// Error details when the tool execution failed\n\tError *ToolExecutionCompleteError `json:\"error,omitempty\"`\n\t// CAPI interaction ID for correlating this tool execution with upstream telemetry\n\tInteractionID *string `json:\"interactionId,omitempty\"`\n\t// Whether this tool call was explicitly requested by the user rather than the assistant\n\tIsUserRequested *bool `json:\"isUserRequested,omitempty\"`\n\t// Model identifier that generated this tool call\n\tModel *string `json:\"model,omitempty\"`\n\t// Tool call ID of the parent tool invocation when this event originates from a sub-agent\n\t// Deprecated: ParentToolCallID is deprecated.\n\tParentToolCallID *string `json:\"parentToolCallId,omitempty\"`\n\t// Tool execution result on success\n\tResult *ToolExecutionCompleteResult `json:\"result,omitempty\"`\n\t// Whether the tool execution completed successfully\n\tSuccess bool `json:\"success\"`\n\t// Unique identifier for the completed tool call\n\tToolCallID string `json:\"toolCallId\"`\n\t// Tool-specific telemetry data (e.g., CodeQL check counts, grep match counts)\n\tToolTelemetry map[string]any `json:\"toolTelemetry,omitempty\"`\n\t// Identifier for the agent loop turn this tool was invoked in, matching the corresponding assistant.turn_start event\n\tTurnID *string `json:\"turnId,omitempty\"`\n}\n\nfunc (*ToolExecutionCompleteData) sessionEventData() {}\n\n// Tool execution progress notification with status message\ntype ToolExecutionProgressData struct {\n\t// Human-readable progress status message (e.g., from an MCP server)\n\tProgressMessage string `json:\"progressMessage\"`\n\t// Tool call ID this progress notification belongs to\n\tToolCallID string `json:\"toolCallId\"`\n}\n\nfunc (*ToolExecutionProgressData) sessionEventData() {}\n\n// Tool execution startup details including MCP server information when applicable\ntype ToolExecutionStartData struct {\n\t// Arguments passed to the tool\n\tArguments any `json:\"arguments,omitempty\"`\n\t// Name of the MCP server hosting this tool, when the tool is an MCP tool\n\tMcpServerName *string `json:\"mcpServerName,omitempty\"`\n\t// Original tool name on the MCP server, when the tool is an MCP tool\n\tMcpToolName *string `json:\"mcpToolName,omitempty\"`\n\t// Tool call ID of the parent tool invocation when this event originates from a sub-agent\n\t// Deprecated: ParentToolCallID is deprecated.\n\tParentToolCallID *string `json:\"parentToolCallId,omitempty\"`\n\t// Unique identifier for this tool call\n\tToolCallID string `json:\"toolCallId\"`\n\t// Name of the tool being executed\n\tToolName string `json:\"toolName\"`\n\t// Identifier for the agent loop turn this tool was invoked in, matching the corresponding assistant.turn_start event\n\tTurnID *string `json:\"turnId,omitempty\"`\n}\n\nfunc (*ToolExecutionStartData) sessionEventData() {}\n\n// Turn abort information including the reason for termination\ntype AbortData struct {\n\t// Reason the current turn was aborted (e.g., \"user initiated\")\n\tReason string `json:\"reason\"`\n}\n\nfunc (*AbortData) sessionEventData() {}\n\n// Turn completion metadata including the turn identifier\ntype AssistantTurnEndData struct {\n\t// Identifier of the turn that has ended, matching the corresponding assistant.turn_start event\n\tTurnID string `json:\"turnId\"`\n}\n\nfunc (*AssistantTurnEndData) sessionEventData() {}\n\n// Turn initialization metadata including identifier and interaction tracking\ntype AssistantTurnStartData struct {\n\t// CAPI interaction ID for correlating this turn with upstream telemetry\n\tInteractionID *string `json:\"interactionId,omitempty\"`\n\t// Identifier for this turn within the agentic loop, typically a stringified turn number\n\tTurnID string `json:\"turnId\"`\n}\n\nfunc (*AssistantTurnStartData) sessionEventData() {}\n\n// User input request completion with the user's response\ntype UserInputCompletedData struct {\n\t// The user's answer to the input request\n\tAnswer *string `json:\"answer,omitempty\"`\n\t// Request ID of the resolved user input request; clients should dismiss any UI for this request\n\tRequestID string `json:\"requestId\"`\n\t// Whether the answer was typed as free-form text rather than selected from choices\n\tWasFreeform *bool `json:\"wasFreeform,omitempty\"`\n}\n\nfunc (*UserInputCompletedData) sessionEventData() {}\n\n// User input request notification with question and optional predefined choices\ntype UserInputRequestedData struct {\n\t// Whether the user can provide a free-form text response in addition to predefined choices\n\tAllowFreeform *bool `json:\"allowFreeform,omitempty\"`\n\t// Predefined choices for the user to select from, if applicable\n\tChoices []string `json:\"choices,omitempty\"`\n\t// The question or prompt to present to the user\n\tQuestion string `json:\"question\"`\n\t// Unique identifier for this input request; used to respond via session.respondToUserInput()\n\tRequestID string `json:\"requestId\"`\n\t// The LLM-assigned tool call ID that triggered this request; used by remote UIs to correlate responses\n\tToolCallID *string `json:\"toolCallId,omitempty\"`\n}\n\nfunc (*UserInputRequestedData) sessionEventData() {}\n\n// User-initiated tool invocation request with tool name and arguments\ntype ToolUserRequestedData struct {\n\t// Arguments for the tool invocation\n\tArguments any `json:\"arguments,omitempty\"`\n\t// Unique identifier for this tool call\n\tToolCallID string `json:\"toolCallId\"`\n\t// Name of the tool the user wants to invoke\n\tToolName string `json:\"toolName\"`\n}\n\nfunc (*ToolUserRequestedData) sessionEventData() {}\n\n// UserMessageData holds the payload for user.message events.\ntype UserMessageData struct {\n\t// The agent mode that was active when this message was sent\n\tAgentMode *UserMessageAgentMode `json:\"agentMode,omitempty\"`\n\t// Files, selections, or GitHub references attached to the message\n\tAttachments []UserMessageAttachment `json:\"attachments,omitempty\"`\n\t// The user's message text as displayed in the timeline\n\tContent string `json:\"content\"`\n\t// CAPI interaction ID for correlating this user message with its turn\n\tInteractionID *string `json:\"interactionId,omitempty\"`\n\t// Path-backed native document attachments that stayed on the tagged_files path flow because native upload would exceed the request size limit\n\tNativeDocumentPathFallbackPaths []string `json:\"nativeDocumentPathFallbackPaths,omitempty\"`\n\t// Parent agent task ID for background telemetry correlated to this user turn\n\tParentAgentTaskID *string `json:\"parentAgentTaskId,omitempty\"`\n\t// Origin of this message, used for timeline filtering (e.g., \"skill-pdf\" for skill-injected messages that should be hidden from the user)\n\tSource *string `json:\"source,omitempty\"`\n\t// Normalized document MIME types that were sent natively instead of through tagged_files XML\n\tSupportedNativeDocumentMIMETypes []string `json:\"supportedNativeDocumentMimeTypes,omitempty\"`\n\t// Transformed version of the message sent to the model, with XML wrapping, timestamps, and other augmentations for prompt caching\n\tTransformedContent *string `json:\"transformedContent,omitempty\"`\n}\n\nfunc (*UserMessageData) sessionEventData() {}\n\n// Warning message for timeline display with categorization\ntype SessionWarningData struct {\n\t// Human-readable warning message for display in the timeline\n\tMessage string `json:\"message\"`\n\t// Optional URL associated with this warning that the user can open in a browser\n\tURL *string `json:\"url,omitempty\"`\n\t// Category of warning (e.g., \"subscription\", \"policy\", \"mcp\")\n\tWarningType string `json:\"warningType\"`\n}\n\nfunc (*SessionWarningData) sessionEventData() {}\n\n// Working directory and git context at session start\ntype SessionContextChangedData struct {\n\t// Base commit of current git branch at session start time\n\tBaseCommit *string `json:\"baseCommit,omitempty\"`\n\t// Current git branch name\n\tBranch *string `json:\"branch,omitempty\"`\n\t// Current working directory path\n\tCwd string `json:\"cwd\"`\n\t// Root directory of the git repository, resolved via git rev-parse\n\tGitRoot *string `json:\"gitRoot,omitempty\"`\n\t// Head commit of current git branch at session start time\n\tHeadCommit *string `json:\"headCommit,omitempty\"`\n\t// Hosting platform type of the repository (github or ado)\n\tHostType *WorkingDirectoryContextHostType `json:\"hostType,omitempty\"`\n\t// Repository identifier derived from the git remote URL (\"owner/name\" for GitHub, \"org/project/repo\" for Azure DevOps)\n\tRepository *string `json:\"repository,omitempty\"`\n\t// Raw host string from the git remote URL (e.g. \"github.com\", \"mycompany.ghe.com\", \"dev.azure.com\")\n\tRepositoryHost *string `json:\"repositoryHost,omitempty\"`\n}\n\nfunc (*SessionContextChangedData) sessionEventData() {}\n\n// Workspace file change details including path and operation type\ntype SessionWorkspaceFileChangedData struct {\n\t// Whether the file was newly created or updated\n\tOperation WorkspaceFileChangedOperation `json:\"operation\"`\n\t// Relative path within the session workspace files directory\n\tPath string `json:\"path\"`\n}\n\nfunc (*SessionWorkspaceFileChangedData) sessionEventData() {}\n\n// A content block within a tool result, which may be text, terminal output, image, audio, or a resource\ntype ToolExecutionCompleteContent struct {\n\t// Type discriminator\n\tType ToolExecutionCompleteContentType `json:\"type\"`\n\t// Working directory where the command was executed\n\tCwd *string `json:\"cwd,omitempty\"`\n\t// Base64-encoded image data\n\tData *string `json:\"data,omitempty\"`\n\t// Human-readable description of the resource\n\tDescription *string `json:\"description,omitempty\"`\n\t// Process exit code, if the command has completed\n\tExitCode *float64 `json:\"exitCode,omitempty\"`\n\t// Icons associated with this resource\n\tIcons []ToolExecutionCompleteContentResourceLinkIcon `json:\"icons,omitempty\"`\n\t// MIME type of the image (e.g., image/png, image/jpeg)\n\tMIMEType *string `json:\"mimeType,omitempty\"`\n\t// Resource name identifier\n\tName *string `json:\"name,omitempty\"`\n\t// The embedded resource contents, either text or base64-encoded binary\n\tResource any `json:\"resource,omitempty\"`\n\t// Size of the resource in bytes\n\tSize *float64 `json:\"size,omitempty\"`\n\t// The text content\n\tText *string `json:\"text,omitempty\"`\n\t// Human-readable display title for the resource\n\tTitle *string `json:\"title,omitempty\"`\n\t// URI identifying the resource\n\tURI *string `json:\"uri,omitempty\"`\n}\n\n// A tool invocation request from the assistant\ntype AssistantMessageToolRequest struct {\n\t// Arguments to pass to the tool, format depends on the tool\n\tArguments any `json:\"arguments,omitempty\"`\n\t// Resolved intention summary describing what this specific call does\n\tIntentionSummary *string `json:\"intentionSummary,omitempty\"`\n\t// Name of the MCP server hosting this tool, when the tool is an MCP tool\n\tMcpServerName *string `json:\"mcpServerName,omitempty\"`\n\t// Name of the tool being invoked\n\tName string `json:\"name\"`\n\t// Unique identifier for this tool call\n\tToolCallID string `json:\"toolCallId\"`\n\t// Human-readable display title for the tool\n\tToolTitle *string `json:\"toolTitle,omitempty\"`\n\t// Tool call type: \"function\" for standard tool calls, \"custom\" for grammar-based tool calls. Defaults to \"function\" when absent.\n\tType *AssistantMessageToolRequestType `json:\"type,omitempty\"`\n}\n\n// A user message attachment — a file, directory, code selection, blob, or GitHub reference\ntype UserMessageAttachment struct {\n\t// Type discriminator\n\tType UserMessageAttachmentType `json:\"type\"`\n\t// Base64-encoded content\n\tData *string `json:\"data,omitempty\"`\n\t// User-facing display name for the attachment\n\tDisplayName *string `json:\"displayName,omitempty\"`\n\t// Absolute path to the file containing the selection\n\tFilePath *string `json:\"filePath,omitempty\"`\n\t// Optional line range to scope the attachment to a specific section of the file\n\tLineRange *UserMessageAttachmentFileLineRange `json:\"lineRange,omitempty\"`\n\t// MIME type of the inline data\n\tMIMEType *string `json:\"mimeType,omitempty\"`\n\t// Issue, pull request, or discussion number\n\tNumber *float64 `json:\"number,omitempty\"`\n\t// Absolute file path\n\tPath *string `json:\"path,omitempty\"`\n\t// Type of GitHub reference\n\tReferenceType *UserMessageAttachmentGithubReferenceType `json:\"referenceType,omitempty\"`\n\t// Position range of the selection within the file\n\tSelection *UserMessageAttachmentSelectionDetails `json:\"selection,omitempty\"`\n\t// Current state of the referenced item (e.g., open, closed, merged)\n\tState *string `json:\"state,omitempty\"`\n\t// The selected text content\n\tText *string `json:\"text,omitempty\"`\n\t// Title of the referenced item\n\tTitle *string `json:\"title,omitempty\"`\n\t// URL to the referenced item on GitHub\n\tURL *string `json:\"url,omitempty\"`\n}\n\n// Aggregate code change metrics for the session\ntype ShutdownCodeChanges struct {\n\t// List of file paths that were modified during the session\n\tFilesModified []string `json:\"filesModified\"`\n\t// Total number of lines added during the session\n\tLinesAdded float64 `json:\"linesAdded\"`\n\t// Total number of lines removed during the session\n\tLinesRemoved float64 `json:\"linesRemoved\"`\n}\n\n// Derived user-facing permission prompt details for UI consumers\ntype PermissionPromptRequest struct {\n\t// Kind discriminator\n\tKind PermissionPromptRequestKind `json:\"kind\"`\n\t// Underlying permission kind that needs path approval\n\tAccessKind *PermissionPromptRequestPathAccessKind `json:\"accessKind,omitempty\"`\n\t// Whether this is a store or vote memory operation\n\tAction *PermissionPromptRequestMemoryAction `json:\"action,omitempty\"`\n\t// Arguments to pass to the MCP tool\n\tArgs *any `json:\"args,omitempty\"`\n\t// Whether the UI can offer session-wide approval for this command pattern\n\tCanOfferSessionApproval *bool `json:\"canOfferSessionApproval,omitempty\"`\n\t// Source references for the stored fact (store only)\n\tCitations *string `json:\"citations,omitempty\"`\n\t// Command identifiers covered by this approval prompt\n\tCommandIdentifiers []string `json:\"commandIdentifiers,omitempty\"`\n\t// Unified diff showing the proposed changes\n\tDiff *string `json:\"diff,omitempty\"`\n\t// Vote direction (vote only)\n\tDirection *PermissionPromptRequestMemoryDirection `json:\"direction,omitempty\"`\n\t// The fact being stored or voted on\n\tFact *string `json:\"fact,omitempty\"`\n\t// Path of the file being written to\n\tFileName *string `json:\"fileName,omitempty\"`\n\t// The complete shell command text to be executed\n\tFullCommandText *string `json:\"fullCommandText,omitempty\"`\n\t// Optional message from the hook explaining why confirmation is needed\n\tHookMessage *string `json:\"hookMessage,omitempty\"`\n\t// Human-readable description of what the command intends to do\n\tIntention *string `json:\"intention,omitempty\"`\n\t// Complete new file contents for newly created files\n\tNewFileContents *string `json:\"newFileContents,omitempty\"`\n\t// Path of the file or directory being read\n\tPath *string `json:\"path,omitempty\"`\n\t// File paths that require explicit approval\n\tPaths []string `json:\"paths,omitempty\"`\n\t// Reason for the vote (vote only)\n\tReason *string `json:\"reason,omitempty\"`\n\t// Name of the MCP server providing the tool\n\tServerName *string `json:\"serverName,omitempty\"`\n\t// Topic or subject of the memory (store only)\n\tSubject *string `json:\"subject,omitempty\"`\n\t// Arguments of the tool call being gated\n\tToolArgs any `json:\"toolArgs,omitempty\"`\n\t// Tool call ID that triggered this permission request\n\tToolCallID *string `json:\"toolCallId,omitempty\"`\n\t// Description of what the custom tool does\n\tToolDescription *string `json:\"toolDescription,omitempty\"`\n\t// Internal name of the MCP tool\n\tToolName *string `json:\"toolName,omitempty\"`\n\t// Human-readable title of the MCP tool\n\tToolTitle *string `json:\"toolTitle,omitempty\"`\n\t// URL to be fetched\n\tURL *string `json:\"url,omitempty\"`\n\t// Optional warning message about risks of running this command\n\tWarning *string `json:\"warning,omitempty\"`\n}\n\n// Details of the permission being requested\ntype PermissionRequest struct {\n\t// Kind discriminator\n\tKind PermissionRequestKind `json:\"kind\"`\n\t// Whether this is a store or vote memory operation\n\tAction *PermissionRequestMemoryAction `json:\"action,omitempty\"`\n\t// Arguments to pass to the MCP tool\n\tArgs any `json:\"args,omitempty\"`\n\t// Whether the UI can offer session-wide approval for this command pattern\n\tCanOfferSessionApproval *bool `json:\"canOfferSessionApproval,omitempty\"`\n\t// Source references for the stored fact (store only)\n\tCitations *string `json:\"citations,omitempty\"`\n\t// Parsed command identifiers found in the command text\n\tCommands []PermissionRequestShellCommand `json:\"commands,omitempty\"`\n\t// Unified diff showing the proposed changes\n\tDiff *string `json:\"diff,omitempty\"`\n\t// Vote direction (vote only)\n\tDirection *PermissionRequestMemoryDirection `json:\"direction,omitempty\"`\n\t// The fact being stored or voted on\n\tFact *string `json:\"fact,omitempty\"`\n\t// Path of the file being written to\n\tFileName *string `json:\"fileName,omitempty\"`\n\t// The complete shell command text to be executed\n\tFullCommandText *string `json:\"fullCommandText,omitempty\"`\n\t// Whether the command includes a file write redirection (e.g., > or >>)\n\tHasWriteFileRedirection *bool `json:\"hasWriteFileRedirection,omitempty\"`\n\t// Optional message from the hook explaining why confirmation is needed\n\tHookMessage *string `json:\"hookMessage,omitempty\"`\n\t// Human-readable description of what the command intends to do\n\tIntention *string `json:\"intention,omitempty\"`\n\t// Complete new file contents for newly created files\n\tNewFileContents *string `json:\"newFileContents,omitempty\"`\n\t// Path of the file or directory being read\n\tPath *string `json:\"path,omitempty\"`\n\t// File paths that may be read or written by the command\n\tPossiblePaths []string `json:\"possiblePaths,omitempty\"`\n\t// URLs that may be accessed by the command\n\tPossibleUrls []PermissionRequestShellPossibleURL `json:\"possibleUrls,omitempty\"`\n\t// Whether this MCP tool is read-only (no side effects)\n\tReadOnly *bool `json:\"readOnly,omitempty\"`\n\t// Reason for the vote (vote only)\n\tReason *string `json:\"reason,omitempty\"`\n\t// Name of the MCP server providing the tool\n\tServerName *string `json:\"serverName,omitempty\"`\n\t// Topic or subject of the memory (store only)\n\tSubject *string `json:\"subject,omitempty\"`\n\t// Arguments of the tool call being gated\n\tToolArgs any `json:\"toolArgs,omitempty\"`\n\t// Tool call ID that triggered this permission request\n\tToolCallID *string `json:\"toolCallId,omitempty\"`\n\t// Description of what the custom tool does\n\tToolDescription *string `json:\"toolDescription,omitempty\"`\n\t// Internal name of the MCP tool\n\tToolName *string `json:\"toolName,omitempty\"`\n\t// Human-readable title of the MCP tool\n\tToolTitle *string `json:\"toolTitle,omitempty\"`\n\t// URL to be fetched\n\tURL *string `json:\"url,omitempty\"`\n\t// Optional warning message about risks of running this command\n\tWarning *string `json:\"warning,omitempty\"`\n}\n\n// End position of the selection\ntype UserMessageAttachmentSelectionDetailsEnd struct {\n\t// End character offset within the line (0-based)\n\tCharacter float64 `json:\"character\"`\n\t// End line number (0-based)\n\tLine float64 `json:\"line\"`\n}\n\n// Error details when the hook failed\ntype HookEndError struct {\n\t// Human-readable error message\n\tMessage string `json:\"message\"`\n\t// Error stack trace, when available\n\tStack *string `json:\"stack,omitempty\"`\n}\n\n// Error details when the tool execution failed\ntype ToolExecutionCompleteError struct {\n\t// Machine-readable error code\n\tCode *string `json:\"code,omitempty\"`\n\t// Human-readable error message\n\tMessage string `json:\"message\"`\n}\n\n// Icon image for a resource\ntype ToolExecutionCompleteContentResourceLinkIcon struct {\n\t// MIME type of the icon image\n\tMIMEType *string `json:\"mimeType,omitempty\"`\n\t// Available icon sizes (e.g., ['16x16', '32x32'])\n\tSizes []string `json:\"sizes,omitempty\"`\n\t// URL or path to the icon image\n\tSrc string `json:\"src\"`\n\t// Theme variant this icon is intended for\n\tTheme *ToolExecutionCompleteContentResourceLinkIconTheme `json:\"theme,omitempty\"`\n}\n\n// JSON Schema describing the form fields to present to the user (form mode only)\ntype ElicitationRequestedSchema struct {\n\t// Form field definitions, keyed by field name\n\tProperties map[string]any `json:\"properties\"`\n\t// List of required field names\n\tRequired []string `json:\"required,omitempty\"`\n\t// Schema type indicator (always 'object')\n\tType string `json:\"type\"`\n}\n\n// Metadata about the prompt template and its construction\ntype SystemMessageMetadata struct {\n\t// Version identifier of the prompt template used\n\tPromptVersion *string `json:\"promptVersion,omitempty\"`\n\t// Template variables used when constructing the prompt\n\tVariables map[string]any `json:\"variables,omitempty\"`\n}\n\n// Optional line range to scope the attachment to a specific section of the file\ntype UserMessageAttachmentFileLineRange struct {\n\t// End line number (1-based, inclusive)\n\tEnd float64 `json:\"end\"`\n\t// Start line number (1-based)\n\tStart float64 `json:\"start\"`\n}\n\n// Per-request cost and usage data from the CAPI copilot_usage response field\ntype AssistantUsageCopilotUsage struct {\n\t// Itemized token usage breakdown\n\tTokenDetails []AssistantUsageCopilotUsageTokenDetail `json:\"tokenDetails\"`\n\t// Total cost in nano-AI units for this request\n\tTotalNanoAiu float64 `json:\"totalNanoAiu\"`\n}\n\n// Per-request cost and usage data from the CAPI copilot_usage response field\ntype CompactionCompleteCompactionTokensUsedCopilotUsage struct {\n\t// Itemized token usage breakdown\n\tTokenDetails []CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail `json:\"tokenDetails\"`\n\t// Total cost in nano-AI units for this request\n\tTotalNanoAiu float64 `json:\"totalNanoAiu\"`\n}\n\n// Position range of the selection within the file\ntype UserMessageAttachmentSelectionDetails struct {\n\t// End position of the selection\n\tEnd UserMessageAttachmentSelectionDetailsEnd `json:\"end\"`\n\t// Start position of the selection\n\tStart UserMessageAttachmentSelectionDetailsStart `json:\"start\"`\n}\n\n// Repository context for the handed-off session\ntype HandoffRepository struct {\n\t// Git branch name, if applicable\n\tBranch *string `json:\"branch,omitempty\"`\n\t// Repository name\n\tName string `json:\"name\"`\n\t// Repository owner (user or organization)\n\tOwner string `json:\"owner\"`\n}\n\n// Request count and cost metrics\ntype ShutdownModelMetricRequests struct {\n\t// Cumulative cost multiplier for requests to this model\n\tCost float64 `json:\"cost\"`\n\t// Total number of API requests made to this model\n\tCount float64 `json:\"count\"`\n}\n\n// Start position of the selection\ntype UserMessageAttachmentSelectionDetailsStart struct {\n\t// Start character offset within the line (0-based)\n\tCharacter float64 `json:\"character\"`\n\t// Start line number (0-based)\n\tLine float64 `json:\"line\"`\n}\n\n// Static OAuth client configuration, if the server specifies one\ntype McpOauthRequiredStaticClientConfig struct {\n\t// OAuth client ID for the server\n\tClientID string `json:\"clientId\"`\n\t// Optional non-default OAuth grant type. When set to 'client_credentials', the OAuth flow runs headlessly using the client_id + keychain-stored secret (no browser, no callback server).\n\tGrantType *string `json:\"grantType,omitempty\"`\n\t// Whether this is a public OAuth client\n\tPublicClient *bool `json:\"publicClient,omitempty\"`\n}\n\n// Structured metadata identifying what triggered this notification\ntype SystemNotification struct {\n\t// Type discriminator\n\tType SystemNotificationType `json:\"type\"`\n\t// Unique identifier of the background agent\n\tAgentID *string `json:\"agentId,omitempty\"`\n\t// Type of the agent (e.g., explore, task, general-purpose)\n\tAgentType *string `json:\"agentType,omitempty\"`\n\t// Human-readable description of the agent task\n\tDescription *string `json:\"description,omitempty\"`\n\t// Unique identifier of the inbox entry\n\tEntryID *string `json:\"entryId,omitempty\"`\n\t// Exit code of the shell command, if available\n\tExitCode *float64 `json:\"exitCode,omitempty\"`\n\t// The full prompt given to the background agent\n\tPrompt *string `json:\"prompt,omitempty\"`\n\t// Human-readable name of the sender\n\tSenderName *string `json:\"senderName,omitempty\"`\n\t// Category of the sender (e.g., sidekick-agent, plugin, hook)\n\tSenderType *string `json:\"senderType,omitempty\"`\n\t// Unique identifier of the shell session\n\tShellID *string `json:\"shellId,omitempty\"`\n\t// Relative path to the discovered instruction file\n\tSourcePath *string `json:\"sourcePath,omitempty\"`\n\t// Whether the agent completed successfully or failed\n\tStatus *SystemNotificationAgentCompletedStatus `json:\"status,omitempty\"`\n\t// Short summary shown before the agent decides whether to read the inbox\n\tSummary *string `json:\"summary,omitempty\"`\n\t// Path of the file access that triggered discovery\n\tTriggerFile *string `json:\"triggerFile,omitempty\"`\n\t// Tool command that triggered discovery (currently always 'view')\n\tTriggerTool *string `json:\"triggerTool,omitempty\"`\n}\n\n// The approval to add as a session-scoped rule\ntype UserToolSessionApproval struct {\n\t// Kind discriminator\n\tKind UserToolSessionApprovalKind `json:\"kind\"`\n\t// Command identifiers approved by the user\n\tCommandIdentifiers []string `json:\"commandIdentifiers,omitempty\"`\n\t// MCP server name\n\tServerName *string `json:\"serverName,omitempty\"`\n\t// Optional MCP tool name, or null for all tools on the server\n\tToolName *string `json:\"toolName,omitempty\"`\n}\n\n// The result of the permission request\ntype PermissionResult struct {\n\t// Kind discriminator\n\tKind PermissionResultKind `json:\"kind\"`\n\t// The approval to add as a session-scoped rule\n\tApproval *UserToolSessionApproval `json:\"approval,omitempty\"`\n\t// Optional feedback from the user explaining the denial\n\tFeedback *string `json:\"feedback,omitempty\"`\n\t// Whether to force-reject the current agent turn\n\tForceReject *bool `json:\"forceReject,omitempty\"`\n\t// Whether to interrupt the current agent turn\n\tInterrupt *bool `json:\"interrupt,omitempty\"`\n\t// The location key (git root or cwd) to persist the approval to\n\tLocationKey *string `json:\"locationKey,omitempty\"`\n\t// Human-readable explanation of why the path was excluded\n\tMessage *string `json:\"message,omitempty\"`\n\t// File path that triggered the exclusion\n\tPath *string `json:\"path,omitempty\"`\n\t// Optional explanation of why the request was cancelled\n\tReason *string `json:\"reason,omitempty\"`\n\t// Rules that denied the request\n\tRules []PermissionRule `json:\"rules,omitempty\"`\n}\n\n// Token usage breakdown\ntype ShutdownModelMetricUsage struct {\n\t// Total tokens read from prompt cache across all requests\n\tCacheReadTokens float64 `json:\"cacheReadTokens\"`\n\t// Total tokens written to prompt cache across all requests\n\tCacheWriteTokens float64 `json:\"cacheWriteTokens\"`\n\t// Total input tokens consumed across all requests to this model\n\tInputTokens float64 `json:\"inputTokens\"`\n\t// Total output tokens produced across all requests to this model\n\tOutputTokens float64 `json:\"outputTokens\"`\n\t// Total reasoning tokens produced across all requests to this model\n\tReasoningTokens *float64 `json:\"reasoningTokens,omitempty\"`\n}\n\n// Token usage breakdown for the compaction LLM call (aligned with assistant.usage format)\ntype CompactionCompleteCompactionTokensUsed struct {\n\t// Cached input tokens reused in the compaction LLM call\n\tCacheReadTokens *float64 `json:\"cacheReadTokens,omitempty\"`\n\t// Tokens written to prompt cache in the compaction LLM call\n\tCacheWriteTokens *float64 `json:\"cacheWriteTokens,omitempty\"`\n\t// Per-request cost and usage data from the CAPI copilot_usage response field\n\tCopilotUsage *CompactionCompleteCompactionTokensUsedCopilotUsage `json:\"copilotUsage,omitempty\"`\n\t// Duration of the compaction LLM call in milliseconds\n\tDuration *float64 `json:\"duration,omitempty\"`\n\t// Input tokens consumed by the compaction LLM call\n\tInputTokens *float64 `json:\"inputTokens,omitempty\"`\n\t// Model identifier used for the compaction LLM call\n\tModel *string `json:\"model,omitempty\"`\n\t// Output tokens produced by the compaction LLM call\n\tOutputTokens *float64 `json:\"outputTokens,omitempty\"`\n}\n\n// Token usage detail for a single billing category\ntype AssistantUsageCopilotUsageTokenDetail struct {\n\t// Number of tokens in this billing batch\n\tBatchSize float64 `json:\"batchSize\"`\n\t// Cost per batch of tokens\n\tCostPerBatch float64 `json:\"costPerBatch\"`\n\t// Total token count for this entry\n\tTokenCount float64 `json:\"tokenCount\"`\n\t// Token category (e.g., \"input\", \"output\")\n\tTokenType string `json:\"tokenType\"`\n}\n\n// Token usage detail for a single billing category\ntype CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail struct {\n\t// Number of tokens in this billing batch\n\tBatchSize float64 `json:\"batchSize\"`\n\t// Cost per batch of tokens\n\tCostPerBatch float64 `json:\"costPerBatch\"`\n\t// Total token count for this entry\n\tTokenCount float64 `json:\"tokenCount\"`\n\t// Token category (e.g., \"input\", \"output\")\n\tTokenType string `json:\"tokenType\"`\n}\n\n// Tool execution result on success\ntype ToolExecutionCompleteResult struct {\n\t// Concise tool result text sent to the LLM for chat completion, potentially truncated for token efficiency\n\tContent string `json:\"content\"`\n\t// Structured content blocks (text, images, audio, resources) returned by the tool in their native format\n\tContents []ToolExecutionCompleteContent `json:\"contents,omitempty\"`\n\t// Full detailed tool result for UI/timeline display, preserving complete content such as diffs. Falls back to content when absent.\n\tDetailedContent *string `json:\"detailedContent,omitempty\"`\n}\n\n// UI capability changes\ntype CapabilitiesChangedUI struct {\n\t// Whether elicitation is now supported\n\tElicitation *bool `json:\"elicitation,omitempty\"`\n}\n\n// Working directory and git context at session start\ntype WorkingDirectoryContext struct {\n\t// Base commit of current git branch at session start time\n\tBaseCommit *string `json:\"baseCommit,omitempty\"`\n\t// Current git branch name\n\tBranch *string `json:\"branch,omitempty\"`\n\t// Current working directory path\n\tCwd string `json:\"cwd\"`\n\t// Root directory of the git repository, resolved via git rev-parse\n\tGitRoot *string `json:\"gitRoot,omitempty\"`\n\t// Head commit of current git branch at session start time\n\tHeadCommit *string `json:\"headCommit,omitempty\"`\n\t// Hosting platform type of the repository (github or ado)\n\tHostType *WorkingDirectoryContextHostType `json:\"hostType,omitempty\"`\n\t// Repository identifier derived from the git remote URL (\"owner/name\" for GitHub, \"org/project/repo\" for Azure DevOps)\n\tRepository *string `json:\"repository,omitempty\"`\n\t// Raw host string from the git remote URL (e.g. \"github.com\", \"mycompany.ghe.com\", \"dev.azure.com\")\n\tRepositoryHost *string `json:\"repositoryHost,omitempty\"`\n}\n\ntype AssistantUsageQuotaSnapshot struct {\n\t// Total requests allowed by the entitlement\n\tEntitlementRequests float64 `json:\"entitlementRequests\"`\n\t// Whether the user has an unlimited usage entitlement\n\tIsUnlimitedEntitlement bool `json:\"isUnlimitedEntitlement\"`\n\t// Number of requests over the entitlement limit\n\tOverage float64 `json:\"overage\"`\n\t// Whether overage is allowed when quota is exhausted\n\tOverageAllowedWithExhaustedQuota bool `json:\"overageAllowedWithExhaustedQuota\"`\n\t// Percentage of quota remaining (0.0 to 1.0)\n\tRemainingPercentage float64 `json:\"remainingPercentage\"`\n\t// Date when the quota resets\n\tResetDate *time.Time `json:\"resetDate,omitempty\"`\n\t// Whether usage is still permitted after quota exhaustion\n\tUsageAllowedWithExhaustedQuota bool `json:\"usageAllowedWithExhaustedQuota\"`\n\t// Number of requests already consumed\n\tUsedRequests float64 `json:\"usedRequests\"`\n}\n\ntype CommandsChangedCommand struct {\n\tDescription *string `json:\"description,omitempty\"`\n\tName string `json:\"name\"`\n}\n\ntype CustomAgentsUpdatedAgent struct {\n\t// Description of what the agent does\n\tDescription string `json:\"description\"`\n\t// Human-readable display name\n\tDisplayName string `json:\"displayName\"`\n\t// Unique identifier for the agent\n\tID string `json:\"id\"`\n\t// Model override for this agent, if set\n\tModel *string `json:\"model,omitempty\"`\n\t// Internal name of the agent\n\tName string `json:\"name\"`\n\t// Source location: user, project, inherited, remote, or plugin\n\tSource string `json:\"source\"`\n\t// List of tool names available to this agent\n\tTools []string `json:\"tools\"`\n\t// Whether the agent can be selected by the user\n\tUserInvocable bool `json:\"userInvocable\"`\n}\n\ntype ExtensionsLoadedExtension struct {\n\t// Source-qualified extension ID (e.g., 'project:my-ext', 'user:auth-helper')\n\tID string `json:\"id\"`\n\t// Extension name (directory name)\n\tName string `json:\"name\"`\n\t// Discovery source\n\tSource ExtensionsLoadedExtensionSource `json:\"source\"`\n\t// Current status: running, disabled, failed, or starting\n\tStatus ExtensionsLoadedExtensionStatus `json:\"status\"`\n}\n\ntype McpServersLoadedServer struct {\n\t// Error message if the server failed to connect\n\tError *string `json:\"error,omitempty\"`\n\t// Server name (config key)\n\tName string `json:\"name\"`\n\t// Configuration source: user, workspace, plugin, or builtin\n\tSource *string `json:\"source,omitempty\"`\n\t// Connection status: connected, failed, needs-auth, pending, disabled, or not_configured\n\tStatus McpServersLoadedServerStatus `json:\"status\"`\n}\n\ntype PermissionRequestShellCommand struct {\n\t// Command identifier (e.g., executable name)\n\tIdentifier string `json:\"identifier\"`\n\t// Whether this command is read-only (no side effects)\n\tReadOnly bool `json:\"readOnly\"`\n}\n\ntype PermissionRequestShellPossibleURL struct {\n\t// URL that may be accessed by the command\n\tURL string `json:\"url\"`\n}\n\ntype PermissionRule struct {\n\t// Optional rule argument matched against the request\n\tArgument *string `json:\"argument\"`\n\t// The rule kind, such as Shell or GitHubMCP\n\tKind string `json:\"kind\"`\n}\n\ntype ShutdownModelMetric struct {\n\t// Request count and cost metrics\n\tRequests ShutdownModelMetricRequests `json:\"requests\"`\n\t// Token count details per type\n\tTokenDetails map[string]ShutdownModelMetricTokenDetail `json:\"tokenDetails,omitempty\"`\n\t// Accumulated nano-AI units cost for this model\n\tTotalNanoAiu *float64 `json:\"totalNanoAiu,omitempty\"`\n\t// Token usage breakdown\n\tUsage ShutdownModelMetricUsage `json:\"usage\"`\n}\n\ntype ShutdownModelMetricTokenDetail struct {\n\t// Accumulated token count for this token type\n\tTokenCount float64 `json:\"tokenCount\"`\n}\n\ntype ShutdownTokenDetail struct {\n\t// Accumulated token count for this token type\n\tTokenCount float64 `json:\"tokenCount\"`\n}\n\ntype SkillsLoadedSkill struct {\n\t// Description of what the skill does\n\tDescription string `json:\"description\"`\n\t// Whether the skill is currently enabled\n\tEnabled bool `json:\"enabled\"`\n\t// Unique identifier for the skill\n\tName string `json:\"name\"`\n\t// Absolute path to the skill file, if available\n\tPath *string `json:\"path,omitempty\"`\n\t// Source location type of the skill (e.g., project, personal, plugin)\n\tSource string `json:\"source\"`\n\t// Whether the skill can be invoked by the user as a slash command\n\tUserInvocable bool `json:\"userInvocable\"`\n}\n\n// Connection status: connected, failed, needs-auth, pending, disabled, or not_configured\ntype McpServersLoadedServerStatus string\n\nconst (\n\tMcpServersLoadedServerStatusConnected McpServersLoadedServerStatus = \"connected\"\n\tMcpServersLoadedServerStatusFailed McpServersLoadedServerStatus = \"failed\"\n\tMcpServersLoadedServerStatusNeedsAuth McpServersLoadedServerStatus = \"needs-auth\"\n\tMcpServersLoadedServerStatusPending McpServersLoadedServerStatus = \"pending\"\n\tMcpServersLoadedServerStatusDisabled McpServersLoadedServerStatus = \"disabled\"\n\tMcpServersLoadedServerStatusNotConfigured McpServersLoadedServerStatus = \"not_configured\"\n)\n\n// Current status: running, disabled, failed, or starting\ntype ExtensionsLoadedExtensionStatus string\n\nconst (\n\tExtensionsLoadedExtensionStatusRunning ExtensionsLoadedExtensionStatus = \"running\"\n\tExtensionsLoadedExtensionStatusDisabled ExtensionsLoadedExtensionStatus = \"disabled\"\n\tExtensionsLoadedExtensionStatusFailed ExtensionsLoadedExtensionStatus = \"failed\"\n\tExtensionsLoadedExtensionStatusStarting ExtensionsLoadedExtensionStatus = \"starting\"\n)\n\n// Discovery source\ntype ExtensionsLoadedExtensionSource string\n\nconst (\n\tExtensionsLoadedExtensionSourceProject ExtensionsLoadedExtensionSource = \"project\"\n\tExtensionsLoadedExtensionSourceUser ExtensionsLoadedExtensionSource = \"user\"\n)\n\n// Elicitation mode; \"form\" for structured input, \"url\" for browser-based. Defaults to \"form\" when absent.\ntype ElicitationRequestedMode string\n\nconst (\n\tElicitationRequestedModeForm ElicitationRequestedMode = \"form\"\n\tElicitationRequestedModeURL ElicitationRequestedMode = \"url\"\n)\n\n// Hosting platform type of the repository (github or ado)\ntype WorkingDirectoryContextHostType string\n\nconst (\n\tWorkingDirectoryContextHostTypeGithub WorkingDirectoryContextHostType = \"github\"\n\tWorkingDirectoryContextHostTypeAdo WorkingDirectoryContextHostType = \"ado\"\n)\n\n// Kind discriminator for PermissionPromptRequest.\ntype PermissionPromptRequestKind string\n\nconst (\n\tPermissionPromptRequestKindCommands PermissionPromptRequestKind = \"commands\"\n\tPermissionPromptRequestKindWrite PermissionPromptRequestKind = \"write\"\n\tPermissionPromptRequestKindRead PermissionPromptRequestKind = \"read\"\n\tPermissionPromptRequestKindMcp PermissionPromptRequestKind = \"mcp\"\n\tPermissionPromptRequestKindURL PermissionPromptRequestKind = \"url\"\n\tPermissionPromptRequestKindMemory PermissionPromptRequestKind = \"memory\"\n\tPermissionPromptRequestKindCustomTool PermissionPromptRequestKind = \"custom-tool\"\n\tPermissionPromptRequestKindPath PermissionPromptRequestKind = \"path\"\n\tPermissionPromptRequestKindHook PermissionPromptRequestKind = \"hook\"\n)\n\n// Kind discriminator for PermissionRequest.\ntype PermissionRequestKind string\n\nconst (\n\tPermissionRequestKindShell PermissionRequestKind = \"shell\"\n\tPermissionRequestKindWrite PermissionRequestKind = \"write\"\n\tPermissionRequestKindRead PermissionRequestKind = \"read\"\n\tPermissionRequestKindMcp PermissionRequestKind = \"mcp\"\n\tPermissionRequestKindURL PermissionRequestKind = \"url\"\n\tPermissionRequestKindMemory PermissionRequestKind = \"memory\"\n\tPermissionRequestKindCustomTool PermissionRequestKind = \"custom-tool\"\n\tPermissionRequestKindHook PermissionRequestKind = \"hook\"\n)\n\n// Kind discriminator for PermissionResult.\ntype PermissionResultKind string\n\nconst (\n\tPermissionResultKindApproved PermissionResultKind = \"approved\"\n\tPermissionResultKindApprovedForSession PermissionResultKind = \"approved-for-session\"\n\tPermissionResultKindApprovedForLocation PermissionResultKind = \"approved-for-location\"\n\tPermissionResultKindCancelled PermissionResultKind = \"cancelled\"\n\tPermissionResultKindDeniedByRules PermissionResultKind = \"denied-by-rules\"\n\tPermissionResultKindDeniedNoApprovalRuleAndCouldNotRequestFromUser PermissionResultKind = \"denied-no-approval-rule-and-could-not-request-from-user\"\n\tPermissionResultKindDeniedInteractivelyByUser PermissionResultKind = \"denied-interactively-by-user\"\n\tPermissionResultKindDeniedByContentExclusionPolicy PermissionResultKind = \"denied-by-content-exclusion-policy\"\n\tPermissionResultKindDeniedByPermissionRequestHook PermissionResultKind = \"denied-by-permission-request-hook\"\n)\n\n// Kind discriminator for UserToolSessionApproval.\ntype UserToolSessionApprovalKind string\n\nconst (\n\tUserToolSessionApprovalKindCommands UserToolSessionApprovalKind = \"commands\"\n\tUserToolSessionApprovalKindRead UserToolSessionApprovalKind = \"read\"\n\tUserToolSessionApprovalKindWrite UserToolSessionApprovalKind = \"write\"\n\tUserToolSessionApprovalKindMcp UserToolSessionApprovalKind = \"mcp\"\n\tUserToolSessionApprovalKindMemory UserToolSessionApprovalKind = \"memory\"\n\tUserToolSessionApprovalKindCustomTool UserToolSessionApprovalKind = \"custom-tool\"\n)\n\n// Message role: \"system\" for system prompts, \"developer\" for developer-injected instructions\ntype SystemMessageRole string\n\nconst (\n\tSystemMessageRoleSystem SystemMessageRole = \"system\"\n\tSystemMessageRoleDeveloper SystemMessageRole = \"developer\"\n)\n\n// New connection status: connected, failed, needs-auth, pending, disabled, or not_configured\ntype McpServerStatusChangedStatus string\n\nconst (\n\tMcpServerStatusChangedStatusConnected McpServerStatusChangedStatus = \"connected\"\n\tMcpServerStatusChangedStatusFailed McpServerStatusChangedStatus = \"failed\"\n\tMcpServerStatusChangedStatusNeedsAuth McpServerStatusChangedStatus = \"needs-auth\"\n\tMcpServerStatusChangedStatusPending McpServerStatusChangedStatus = \"pending\"\n\tMcpServerStatusChangedStatusDisabled McpServerStatusChangedStatus = \"disabled\"\n\tMcpServerStatusChangedStatusNotConfigured McpServerStatusChangedStatus = \"not_configured\"\n)\n\n// Origin type of the session being handed off\ntype HandoffSourceType string\n\nconst (\n\tHandoffSourceTypeRemote HandoffSourceType = \"remote\"\n\tHandoffSourceTypeLocal HandoffSourceType = \"local\"\n)\n\n// The agent mode that was active when this message was sent\ntype UserMessageAgentMode string\n\nconst (\n\tUserMessageAgentModeInteractive UserMessageAgentMode = \"interactive\"\n\tUserMessageAgentModePlan UserMessageAgentMode = \"plan\"\n\tUserMessageAgentModeAutopilot UserMessageAgentMode = \"autopilot\"\n\tUserMessageAgentModeShell UserMessageAgentMode = \"shell\"\n)\n\n// The type of operation performed on the plan file\ntype PlanChangedOperation string\n\nconst (\n\tPlanChangedOperationCreate PlanChangedOperation = \"create\"\n\tPlanChangedOperationUpdate PlanChangedOperation = \"update\"\n\tPlanChangedOperationDelete PlanChangedOperation = \"delete\"\n)\n\n// The user action: \"accept\" (submitted form), \"decline\" (explicitly refused), or \"cancel\" (dismissed)\ntype ElicitationCompletedAction string\n\nconst (\n\tElicitationCompletedActionAccept ElicitationCompletedAction = \"accept\"\n\tElicitationCompletedActionDecline ElicitationCompletedAction = \"decline\"\n\tElicitationCompletedActionCancel ElicitationCompletedAction = \"cancel\"\n)\n\n// Theme variant this icon is intended for\ntype ToolExecutionCompleteContentResourceLinkIconTheme string\n\nconst (\n\tToolExecutionCompleteContentResourceLinkIconThemeLight ToolExecutionCompleteContentResourceLinkIconTheme = \"light\"\n\tToolExecutionCompleteContentResourceLinkIconThemeDark ToolExecutionCompleteContentResourceLinkIconTheme = \"dark\"\n)\n\n// Tool call type: \"function\" for standard tool calls, \"custom\" for grammar-based tool calls. Defaults to \"function\" when absent.\ntype AssistantMessageToolRequestType string\n\nconst (\n\tAssistantMessageToolRequestTypeFunction AssistantMessageToolRequestType = \"function\"\n\tAssistantMessageToolRequestTypeCustom AssistantMessageToolRequestType = \"custom\"\n)\n\n// Type discriminator for SystemNotification.\ntype SystemNotificationType string\n\nconst (\n\tSystemNotificationTypeAgentCompleted SystemNotificationType = \"agent_completed\"\n\tSystemNotificationTypeAgentIdle SystemNotificationType = \"agent_idle\"\n\tSystemNotificationTypeNewInboxMessage SystemNotificationType = \"new_inbox_message\"\n\tSystemNotificationTypeShellCompleted SystemNotificationType = \"shell_completed\"\n\tSystemNotificationTypeShellDetachedCompleted SystemNotificationType = \"shell_detached_completed\"\n\tSystemNotificationTypeInstructionDiscovered SystemNotificationType = \"instruction_discovered\"\n)\n\n// Type discriminator for ToolExecutionCompleteContent.\ntype ToolExecutionCompleteContentType string\n\nconst (\n\tToolExecutionCompleteContentTypeText ToolExecutionCompleteContentType = \"text\"\n\tToolExecutionCompleteContentTypeTerminal ToolExecutionCompleteContentType = \"terminal\"\n\tToolExecutionCompleteContentTypeImage ToolExecutionCompleteContentType = \"image\"\n\tToolExecutionCompleteContentTypeAudio ToolExecutionCompleteContentType = \"audio\"\n\tToolExecutionCompleteContentTypeResourceLink ToolExecutionCompleteContentType = \"resource_link\"\n\tToolExecutionCompleteContentTypeResource ToolExecutionCompleteContentType = \"resource\"\n)\n\n// Type discriminator for UserMessageAttachment.\ntype UserMessageAttachmentType string\n\nconst (\n\tUserMessageAttachmentTypeFile UserMessageAttachmentType = \"file\"\n\tUserMessageAttachmentTypeDirectory UserMessageAttachmentType = \"directory\"\n\tUserMessageAttachmentTypeSelection UserMessageAttachmentType = \"selection\"\n\tUserMessageAttachmentTypeGithubReference UserMessageAttachmentType = \"github_reference\"\n\tUserMessageAttachmentTypeBlob UserMessageAttachmentType = \"blob\"\n)\n\n// Type of GitHub reference\ntype UserMessageAttachmentGithubReferenceType string\n\nconst (\n\tUserMessageAttachmentGithubReferenceTypeIssue UserMessageAttachmentGithubReferenceType = \"issue\"\n\tUserMessageAttachmentGithubReferenceTypePr UserMessageAttachmentGithubReferenceType = \"pr\"\n\tUserMessageAttachmentGithubReferenceTypeDiscussion UserMessageAttachmentGithubReferenceType = \"discussion\"\n)\n\n// Underlying permission kind that needs path approval\ntype PermissionPromptRequestPathAccessKind string\n\nconst (\n\tPermissionPromptRequestPathAccessKindRead PermissionPromptRequestPathAccessKind = \"read\"\n\tPermissionPromptRequestPathAccessKindShell PermissionPromptRequestPathAccessKind = \"shell\"\n\tPermissionPromptRequestPathAccessKindWrite PermissionPromptRequestPathAccessKind = \"write\"\n)\n\n// Vote direction (vote only)\ntype PermissionPromptRequestMemoryDirection string\n\nconst (\n\tPermissionPromptRequestMemoryDirectionUpvote PermissionPromptRequestMemoryDirection = \"upvote\"\n\tPermissionPromptRequestMemoryDirectionDownvote PermissionPromptRequestMemoryDirection = \"downvote\"\n)\n\n// Vote direction (vote only)\ntype PermissionRequestMemoryDirection string\n\nconst (\n\tPermissionRequestMemoryDirectionUpvote PermissionRequestMemoryDirection = \"upvote\"\n\tPermissionRequestMemoryDirectionDownvote PermissionRequestMemoryDirection = \"downvote\"\n)\n\n// Where the failed model call originated\ntype ModelCallFailureSource string\n\nconst (\n\tModelCallFailureSourceTopLevel ModelCallFailureSource = \"top_level\"\n\tModelCallFailureSourceSubagent ModelCallFailureSource = \"subagent\"\n\tModelCallFailureSourceMcpSampling ModelCallFailureSource = \"mcp_sampling\"\n)\n\n// Whether the agent completed successfully or failed\ntype SystemNotificationAgentCompletedStatus string\n\nconst (\n\tSystemNotificationAgentCompletedStatusCompleted SystemNotificationAgentCompletedStatus = \"completed\"\n\tSystemNotificationAgentCompletedStatusFailed SystemNotificationAgentCompletedStatus = \"failed\"\n)\n\n// Whether the file was newly created or updated\ntype WorkspaceFileChangedOperation string\n\nconst (\n\tWorkspaceFileChangedOperationCreate WorkspaceFileChangedOperation = \"create\"\n\tWorkspaceFileChangedOperationUpdate WorkspaceFileChangedOperation = \"update\"\n)\n\n// Whether the session ended normally (\"routine\") or due to a crash/fatal error (\"error\")\ntype ShutdownType string\n\nconst (\n\tShutdownTypeRoutine ShutdownType = \"routine\"\n\tShutdownTypeError ShutdownType = \"error\"\n)\n\n// Whether this is a store or vote memory operation\ntype PermissionPromptRequestMemoryAction string\n\nconst (\n\tPermissionPromptRequestMemoryActionStore PermissionPromptRequestMemoryAction = \"store\"\n\tPermissionPromptRequestMemoryActionVote PermissionPromptRequestMemoryAction = \"vote\"\n)\n\n// Whether this is a store or vote memory operation\ntype PermissionRequestMemoryAction string\n\nconst (\n\tPermissionRequestMemoryActionStore PermissionRequestMemoryAction = \"store\"\n\tPermissionRequestMemoryActionVote PermissionRequestMemoryAction = \"vote\"\n)\n\n// Type aliases for convenience.\ntype (\n\tPermissionRequestCommand = PermissionRequestShellCommand\n\tPossibleURL = PermissionRequestShellPossibleURL\n\tAttachment = UserMessageAttachment\n\tAttachmentType = UserMessageAttachmentType\n)\n\n// Constant aliases for convenience.\nconst (\n\tAttachmentTypeFile = UserMessageAttachmentTypeFile\n\tAttachmentTypeDirectory = UserMessageAttachmentTypeDirectory\n\tAttachmentTypeSelection = UserMessageAttachmentTypeSelection\n\tAttachmentTypeGithubReference = UserMessageAttachmentTypeGithubReference\n\tAttachmentTypeBlob = UserMessageAttachmentTypeBlob\n)\n" }, { "path": "go/go.mod", "content": "module github.com/github/copilot-sdk/go\n\ngo 1.24\n\nrequire (\n\tgithub.com/google/jsonschema-go v0.4.2\n\tgithub.com/klauspost/compress v1.18.3\n)\n\nrequire (\n\tgithub.com/google/uuid v1.6.0\n\tgo.opentelemetry.io/otel v1.35.0\n)\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n" }, { "path": "go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/klauspost/compress v1.18.3 h1:9PJRvfbmTabkOX8moIpXPbMMbYN60bWImDDU7L+/6zw=\ngithub.com/klauspost/compress v1.18.3/go.mod h1:R0h/fSBs8DE4ENlcrlib3PsXS61voFxhIs2DeRhCvJ4=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "go/internal/e2e/agent_and_compact_rpc_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n\t\"github.com/github/copilot-sdk/go/rpc\"\n)\n\nfunc TestAgentSelectionRpcE2E(t *testing.T) {\n\tcliPath := testharness.CLIPath()\n\tif cliPath == \"\" {\n\t\tt.Fatal(\"CLI not found. Run 'npm install' in the nodejs directory first.\")\n\t}\n\n\tt.Run(\"should list available custom agents\", func(t *testing.T) {\n\t\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIPath: cliPath,\n\t\t\tUseStdio: copilot.Bool(true),\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tCustomAgents: []copilot.CustomAgentConfig{\n\t\t\t\t{\n\t\t\t\t\tName: \"test-agent\",\n\t\t\t\t\tDisplayName: \"Test Agent\",\n\t\t\t\t\tDescription: \"A test agent\",\n\t\t\t\t\tPrompt: \"You are a test agent.\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tName: \"another-agent\",\n\t\t\t\t\tDisplayName: \"Another Agent\",\n\t\t\t\t\tDescription: \"Another test agent\",\n\t\t\t\t\tPrompt: \"You are another agent.\",\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tresult, err := session.RPC.Agent.List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to list agents: %v\", err)\n\t\t}\n\n\t\tif len(result.Agents) != 2 {\n\t\t\tt.Fatalf(\"Expected 2 agents, got %d\", len(result.Agents))\n\t\t}\n\t\tif result.Agents[0].Name != \"test-agent\" {\n\t\t\tt.Errorf(\"Expected first agent name 'test-agent', got %q\", result.Agents[0].Name)\n\t\t}\n\t\tif result.Agents[0].DisplayName != \"Test Agent\" {\n\t\t\tt.Errorf(\"Expected first agent displayName 'Test Agent', got %q\", result.Agents[0].DisplayName)\n\t\t}\n\t\tif result.Agents[1].Name != \"another-agent\" {\n\t\t\tt.Errorf(\"Expected second agent name 'another-agent', got %q\", result.Agents[1].Name)\n\t\t}\n\n\t\tif err := client.Stop(); err != nil {\n\t\t\tt.Errorf(\"Expected no errors on stop, got %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should return null when no agent is selected\", func(t *testing.T) {\n\t\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIPath: cliPath,\n\t\t\tUseStdio: copilot.Bool(true),\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tCustomAgents: []copilot.CustomAgentConfig{\n\t\t\t\t{\n\t\t\t\t\tName: \"test-agent\",\n\t\t\t\t\tDisplayName: \"Test Agent\",\n\t\t\t\t\tDescription: \"A test agent\",\n\t\t\t\t\tPrompt: \"You are a test agent.\",\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tresult, err := session.RPC.Agent.GetCurrent(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get current agent: %v\", err)\n\t\t}\n\n\t\tif result.Agent != nil {\n\t\t\tt.Errorf(\"Expected no agent selected, got %v\", result.Agent)\n\t\t}\n\n\t\tif err := client.Stop(); err != nil {\n\t\t\tt.Errorf(\"Expected no errors on stop, got %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should select and get current agent\", func(t *testing.T) {\n\t\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIPath: cliPath,\n\t\t\tUseStdio: copilot.Bool(true),\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tCustomAgents: []copilot.CustomAgentConfig{\n\t\t\t\t{\n\t\t\t\t\tName: \"test-agent\",\n\t\t\t\t\tDisplayName: \"Test Agent\",\n\t\t\t\t\tDescription: \"A test agent\",\n\t\t\t\t\tPrompt: \"You are a test agent.\",\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Select the agent\n\t\tselectResult, err := session.RPC.Agent.Select(t.Context(), &rpc.AgentSelectRequest{Name: \"test-agent\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to select agent: %v\", err)\n\t\t}\n\t\tif selectResult.Agent.Name != \"test-agent\" {\n\t\t\tt.Errorf(\"Expected selected agent 'test-agent', got %q\", selectResult.Agent.Name)\n\t\t}\n\t\tif selectResult.Agent.DisplayName != \"Test Agent\" {\n\t\t\tt.Errorf(\"Expected displayName 'Test Agent', got %q\", selectResult.Agent.DisplayName)\n\t\t}\n\n\t\t// Verify getCurrent returns the selected agent\n\t\tcurrentResult, err := session.RPC.Agent.GetCurrent(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get current agent: %v\", err)\n\t\t}\n\t\tif currentResult.Agent == nil {\n\t\t\tt.Fatal(\"Expected an agent to be selected\")\n\t\t}\n\t\tif currentResult.Agent.Name != \"test-agent\" {\n\t\t\tt.Errorf(\"Expected current agent 'test-agent', got %q\", currentResult.Agent.Name)\n\t\t}\n\n\t\tif err := client.Stop(); err != nil {\n\t\t\tt.Errorf(\"Expected no errors on stop, got %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should deselect current agent\", func(t *testing.T) {\n\t\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIPath: cliPath,\n\t\t\tUseStdio: copilot.Bool(true),\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tCustomAgents: []copilot.CustomAgentConfig{\n\t\t\t\t{\n\t\t\t\t\tName: \"test-agent\",\n\t\t\t\t\tDisplayName: \"Test Agent\",\n\t\t\t\t\tDescription: \"A test agent\",\n\t\t\t\t\tPrompt: \"You are a test agent.\",\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Select then deselect\n\t\t_, err = session.RPC.Agent.Select(t.Context(), &rpc.AgentSelectRequest{Name: \"test-agent\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to select agent: %v\", err)\n\t\t}\n\n\t\t_, err = session.RPC.Agent.Deselect(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to deselect agent: %v\", err)\n\t\t}\n\n\t\t// Verify no agent is selected\n\t\tcurrentResult, err := session.RPC.Agent.GetCurrent(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get current agent: %v\", err)\n\t\t}\n\t\tif currentResult.Agent != nil {\n\t\t\tt.Errorf(\"Expected no agent selected after deselect, got %v\", currentResult.Agent)\n\t\t}\n\n\t\tif err := client.Stop(); err != nil {\n\t\t\tt.Errorf(\"Expected no errors on stop, got %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should return no custom agents when none configured\", func(t *testing.T) {\n\t\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIPath: cliPath,\n\t\t\tUseStdio: copilot.Bool(true),\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tresult, err := session.RPC.Agent.List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to list agents: %v\", err)\n\t\t}\n\n\t\t// The CLI may return built-in/default agents even when no custom agents\n\t\t// are configured, so just verify none of the known custom agent names appear.\n\t\tcustomNames := map[string]bool{\"test-agent\": true, \"another-agent\": true}\n\t\tfor _, agent := range result.Agents {\n\t\t\tif customNames[agent.Name] {\n\t\t\t\tt.Errorf(\"Expected no custom agents, but found %q\", agent.Name)\n\t\t\t}\n\t\t}\n\n\t\tif err := client.Stop(); err != nil {\n\t\t\tt.Errorf(\"Expected no errors on stop, got %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should call agent reload\", func(t *testing.T) {\n\t\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIPath: cliPath,\n\t\t\tUseStdio: copilot.Bool(true),\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tCustomAgents: []copilot.CustomAgentConfig{\n\t\t\t\t{\n\t\t\t\t\tName: \"reload-test-agent\",\n\t\t\t\t\tDisplayName: \"Reload Test Agent\",\n\t\t\t\t\tDescription: \"Used by the agent reload RPC test.\",\n\t\t\t\t\tPrompt: \"You are a reload test agent.\",\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tbefore, err := session.RPC.Agent.List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to list agents: %v\", err)\n\t\t}\n\t\tvar sawReloadAgent bool\n\t\tfor _, agent := range before.Agents {\n\t\t\tif agent.Name == \"reload-test-agent\" {\n\t\t\t\tsawReloadAgent = true\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif !sawReloadAgent {\n\t\t\tt.Fatalf(\"Expected reload-test-agent in initial Agent.List, got %+v\", before.Agents)\n\t\t}\n\n\t\t// Reload should succeed; the runtime currently drops session-configured\n\t\t// CustomAgents on reload, so we only assert the result shape is non-nil.\n\t\t// Once that runtime behavior is fixed, tighten this to assert\n\t\t// reload-test-agent is still present.\n\t\tresult, err := session.RPC.Agent.Reload(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to reload agents: %v\", err)\n\t\t}\n\t\tif result.Agents == nil {\n\t\t\tt.Errorf(\"Expected non-nil Agents after reload\")\n\t\t}\n\n\t\tif err := client.Stop(); err != nil {\n\t\t\tt.Errorf(\"Expected no errors on stop, got %v\", err)\n\t\t}\n\t})\n}\n\nfunc TestSessionCompactionRpcE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tif err := client.Start(t.Context()); err != nil {\n\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t}\n\n\tt.Run(\"should compact session history after messages\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Send a message to create some history\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"What is 2+2?\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\t// Compact the session\n\t\tresult, err := session.RPC.History.Compact(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to compact session: %v\", err)\n\t\t}\n\n\t\t// Verify result has expected fields (just check it returned valid data)\n\t\tif result == nil {\n\t\t\tt.Fatal(\"Expected non-nil compact result\")\n\t\t}\n\t})\n}\n" }, { "path": "go/internal/e2e/ask_user_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"sync\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\nfunc TestAskUserE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"should invoke user input handler when model uses ask_user tool\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tvar userInputRequests []copilot.UserInputRequest\n\t\tvar mu sync.Mutex\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tOnUserInputRequest: func(request copilot.UserInputRequest, invocation copilot.UserInputInvocation) (copilot.UserInputResponse, error) {\n\t\t\t\tmu.Lock()\n\t\t\t\tuserInputRequests = append(userInputRequests, request)\n\t\t\t\tmu.Unlock()\n\n\t\t\t\tif invocation.SessionID == \"\" {\n\t\t\t\t\tt.Error(\"Expected non-empty session ID in invocation\")\n\t\t\t\t}\n\n\t\t\t\t// Return the first choice if available, otherwise a freeform answer\n\t\t\t\tanswer := \"freeform answer\"\n\t\t\t\twasFreeform := true\n\t\t\t\tif len(request.Choices) > 0 {\n\t\t\t\t\tanswer = request.Choices[0]\n\t\t\t\t\twasFreeform = false\n\t\t\t\t}\n\n\t\t\t\treturn copilot.UserInputResponse{\n\t\t\t\t\tAnswer: answer,\n\t\t\t\t\tWasFreeform: wasFreeform,\n\t\t\t\t}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Ask me to choose between 'Option A' and 'Option B' using the ask_user tool. Wait for my response before continuing.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tdefer mu.Unlock()\n\n\t\tif len(userInputRequests) == 0 {\n\t\t\tt.Error(\"Expected at least one user input request\")\n\t\t}\n\n\t\thasQuestion := false\n\t\tfor _, req := range userInputRequests {\n\t\t\tif req.Question != \"\" {\n\t\t\t\thasQuestion = true\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif !hasQuestion {\n\t\t\tt.Error(\"Expected at least one request with a question\")\n\t\t}\n\t})\n\n\tt.Run(\"should receive choices in user input request\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tvar userInputRequests []copilot.UserInputRequest\n\t\tvar mu sync.Mutex\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tOnUserInputRequest: func(request copilot.UserInputRequest, invocation copilot.UserInputInvocation) (copilot.UserInputResponse, error) {\n\t\t\t\tmu.Lock()\n\t\t\t\tuserInputRequests = append(userInputRequests, request)\n\t\t\t\tmu.Unlock()\n\n\t\t\t\t// Pick the first choice\n\t\t\t\tanswer := \"default\"\n\t\t\t\tif len(request.Choices) > 0 {\n\t\t\t\t\tanswer = request.Choices[0]\n\t\t\t\t}\n\n\t\t\t\treturn copilot.UserInputResponse{\n\t\t\t\t\tAnswer: answer,\n\t\t\t\t\tWasFreeform: false,\n\t\t\t\t}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Use the ask_user tool to ask me to pick between exactly two options: 'Red' and 'Blue'. These should be provided as choices. Wait for my answer.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tdefer mu.Unlock()\n\n\t\tif len(userInputRequests) == 0 {\n\t\t\tt.Error(\"Expected at least one user input request\")\n\t\t}\n\n\t\thasChoices := false\n\t\tfor _, req := range userInputRequests {\n\t\t\tif len(req.Choices) > 0 {\n\t\t\t\thasChoices = true\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif !hasChoices {\n\t\t\tt.Error(\"Expected at least one request with choices\")\n\t\t}\n\t})\n\n\tt.Run(\"should handle freeform user input response\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tvar userInputRequests []copilot.UserInputRequest\n\t\tvar mu sync.Mutex\n\t\tfreeformAnswer := \"This is my custom freeform answer that was not in the choices\"\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tOnUserInputRequest: func(request copilot.UserInputRequest, invocation copilot.UserInputInvocation) (copilot.UserInputResponse, error) {\n\t\t\t\tmu.Lock()\n\t\t\t\tuserInputRequests = append(userInputRequests, request)\n\t\t\t\tmu.Unlock()\n\n\t\t\t\t// Return a freeform answer (not from choices)\n\t\t\t\treturn copilot.UserInputResponse{\n\t\t\t\t\tAnswer: freeformAnswer,\n\t\t\t\t\tWasFreeform: true,\n\t\t\t\t}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tresponse, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Ask me a question using ask_user and then include my answer in your response. The question should be 'What is your favorite color?'\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tdefer mu.Unlock()\n\n\t\tif len(userInputRequests) == 0 {\n\t\t\tt.Error(\"Expected at least one user input request\")\n\t\t}\n\n\t\t// The model's response should be defined\n\t\tif response == nil {\n\t\t\tt.Error(\"Expected non-nil response\")\n\t\t}\n\t})\n}\n" }, { "path": "go/internal/e2e/builtin_tools_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\t\"runtime\"\n\t\"strings\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\nfunc TestBuiltinToolsE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"should capture exit code in output\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = session.Disconnect() })\n\n\t\tmsg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Run 'echo hello && echo world'. Tell me the exact output.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tcontent := assistantContent(t, msg)\n\t\tif !strings.Contains(content, \"hello\") || !strings.Contains(content, \"world\") {\n\t\t\tt.Fatalf(\"Expected output to contain hello and world, got %q\", content)\n\t\t}\n\t})\n\n\tt.Run(\"should capture stderr output\", func(t *testing.T) {\n\t\tif runtime.GOOS == \"windows\" {\n\t\t\tt.Skip(\"stderr prompt uses bash syntax\")\n\t\t}\n\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = session.Disconnect() })\n\n\t\tmsg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Run 'echo error_msg >&2; echo ok' and tell me what stderr said. Reply with just the stderr content.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tif content := assistantContent(t, msg); !strings.Contains(content, \"error_msg\") {\n\t\t\tt.Fatalf(\"Expected stderr response to contain error_msg, got %q\", content)\n\t\t}\n\t})\n\n\tt.Run(\"should read file with line range\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tif err := os.WriteFile(filepath.Join(ctx.WorkDir, \"lines.txt\"), []byte(\"line1\\nline2\\nline3\\nline4\\nline5\\n\"), 0644); err != nil {\n\t\t\tt.Fatalf(\"Failed to write lines.txt: %v\", err)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = session.Disconnect() })\n\n\t\tmsg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Read lines 2 through 4 of the file 'lines.txt' in this directory. Tell me what those lines contain.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tcontent := assistantContent(t, msg)\n\t\tif !strings.Contains(content, \"line2\") || !strings.Contains(content, \"line4\") {\n\t\t\tt.Fatalf(\"Expected response to contain line2 and line4, got %q\", content)\n\t\t}\n\t})\n\n\tt.Run(\"should handle nonexistent file gracefully\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = session.Disconnect() })\n\n\t\tmsg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Try to read the file 'does_not_exist.txt'. If it doesn't exist, say 'FILE_NOT_FOUND'.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tcontent := strings.ToUpper(assistantContent(t, msg))\n\t\tif !strings.Contains(content, \"NOT FOUND\") &&\n\t\t\t!strings.Contains(content, \"NOT EXIST\") &&\n\t\t\t!strings.Contains(content, \"NO SUCH\") &&\n\t\t\t!strings.Contains(content, \"FILE_NOT_FOUND\") &&\n\t\t\t!strings.Contains(content, \"DOES NOT EXIST\") &&\n\t\t\t!strings.Contains(content, \"ERROR\") {\n\t\t\tt.Fatalf(\"Expected a not-found style response, got %q\", content)\n\t\t}\n\t})\n\n\tt.Run(\"should edit a file successfully\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tif err := os.WriteFile(filepath.Join(ctx.WorkDir, \"edit_me.txt\"), []byte(\"Hello World\\nGoodbye World\\n\"), 0644); err != nil {\n\t\t\tt.Fatalf(\"Failed to write edit_me.txt: %v\", err)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = session.Disconnect() })\n\n\t\tmsg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Edit the file 'edit_me.txt': replace 'Hello World' with 'Hi Universe'. Then read it back and tell me its contents.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tif content := assistantContent(t, msg); !strings.Contains(content, \"Hi Universe\") {\n\t\t\tt.Fatalf(\"Expected response to contain Hi Universe, got %q\", content)\n\t\t}\n\t})\n\n\tt.Run(\"should create a new file\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = session.Disconnect() })\n\n\t\tmsg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Create a file called 'new_file.txt' with the content 'Created by test'. Then read it back to confirm.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tif content := assistantContent(t, msg); !strings.Contains(content, \"Created by test\") {\n\t\t\tt.Fatalf(\"Expected response to contain Created by test, got %q\", content)\n\t\t}\n\t})\n\n\tt.Run(\"should search for patterns in files\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tif err := os.WriteFile(filepath.Join(ctx.WorkDir, \"data.txt\"), []byte(\"apple\\nbanana\\napricot\\ncherry\\n\"), 0644); err != nil {\n\t\t\tt.Fatalf(\"Failed to write data.txt: %v\", err)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = session.Disconnect() })\n\n\t\tmsg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Search for lines starting with 'ap' in the file 'data.txt'. Tell me which lines matched.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tcontent := assistantContent(t, msg)\n\t\tif !strings.Contains(content, \"apple\") || !strings.Contains(content, \"apricot\") {\n\t\t\tt.Fatalf(\"Expected response to contain apple and apricot, got %q\", content)\n\t\t}\n\t})\n\n\tt.Run(\"should find files by pattern\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tif err := os.MkdirAll(filepath.Join(ctx.WorkDir, \"src\"), 0755); err != nil {\n\t\t\tt.Fatalf(\"Failed to create src directory: %v\", err)\n\t\t}\n\t\tif err := os.WriteFile(filepath.Join(ctx.WorkDir, \"src\", \"index.ts\"), []byte(\"export const index = 1;\"), 0644); err != nil {\n\t\t\tt.Fatalf(\"Failed to write index.ts: %v\", err)\n\t\t}\n\t\tif err := os.WriteFile(filepath.Join(ctx.WorkDir, \"README.md\"), []byte(\"# Readme\"), 0644); err != nil {\n\t\t\tt.Fatalf(\"Failed to write README.md: %v\", err)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = session.Disconnect() })\n\n\t\tmsg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Find all .ts files in this directory (recursively). List the filenames you found.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tif content := assistantContent(t, msg); !strings.Contains(content, \"index.ts\") {\n\t\t\tt.Fatalf(\"Expected response to contain index.ts, got %q\", content)\n\t\t}\n\t})\n}\n\nfunc assistantContent(t *testing.T, event *copilot.SessionEvent) string {\n\tt.Helper()\n\n\tif event == nil {\n\t\tt.Fatal(\"Expected assistant message, got nil\")\n\t}\n\tdata, ok := event.Data.(*copilot.AssistantMessageData)\n\tif !ok {\n\t\tt.Fatalf(\"Expected AssistantMessageData, got %T\", event.Data)\n\t}\n\treturn data.Content\n}\n" }, { "path": "go/internal/e2e/client_api_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"strings\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\n// Mirrors dotnet/test/ClientSessionManagementTests.cs (snapshot category \"client_api\").\nfunc TestClientApiE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tif err := client.Start(t.Context()); err != nil {\n\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t}\n\n\tt.Run(\"should delete session by id\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tsessionID := session.SessionID\n\n\t\tif _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Say OK.\"}); err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\t\tif err := session.Disconnect(); err != nil {\n\t\t\tt.Fatalf(\"Failed to disconnect session: %v\", err)\n\t\t}\n\n\t\tif err := client.DeleteSession(t.Context(), sessionID); err != nil {\n\t\t\tt.Fatalf(\"Failed to delete session: %v\", err)\n\t\t}\n\n\t\tmetadata, err := client.GetSessionMetadata(t.Context(), sessionID)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to query session metadata: %v\", err)\n\t\t}\n\t\tif metadata != nil {\n\t\t\tt.Errorf(\"Expected metadata to be nil after delete, got %+v\", metadata)\n\t\t}\n\t})\n\n\tt.Run(\"should report error when deleting unknown session id\", func(t *testing.T) {\n\t\terr := client.DeleteSession(t.Context(), \"00000000-0000-0000-0000-000000000000\")\n\t\tif err == nil {\n\t\t\tt.Fatal(\"Expected DeleteSession to fail for unknown id\")\n\t\t}\n\t\tif !strings.Contains(strings.ToLower(err.Error()), \"session file not found\") {\n\t\t\tt.Errorf(\"Expected error mentioning 'Session file not found', got %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should get null last session id before any sessions exist\", func(t *testing.T) {\n\t\t// Use a fresh client with isolated COPILOT_HOME so other subtests don't pollute state.\n\t\tfreshCtx := testharness.NewTestContext(t)\n\t\tfreshClient := freshCtx.NewClient()\n\t\tt.Cleanup(func() { freshClient.ForceStop() })\n\n\t\tif err := freshClient.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Failed to start fresh client: %v\", err)\n\t\t}\n\n\t\tresult, err := freshClient.GetLastSessionID(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get last session id: %v\", err)\n\t\t}\n\t\tif result != nil {\n\t\t\tt.Errorf(\"Expected nil last session id on fresh client, got %q\", *result)\n\t\t}\n\t})\n\n\tt.Run(\"should track last session id after session created\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tsessionID := session.SessionID\n\n\t\tif _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Say OK.\"}); err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\t\tif err := session.Disconnect(); err != nil {\n\t\t\tt.Fatalf(\"Failed to disconnect session: %v\", err)\n\t\t}\n\n\t\tlastID, err := client.GetLastSessionID(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get last session id: %v\", err)\n\t\t}\n\t\tif lastID == nil || *lastID != sessionID {\n\t\t\tgot := \"\"\n\t\t\tif lastID != nil {\n\t\t\t\tgot = *lastID\n\t\t\t}\n\t\t\tt.Errorf(\"Expected last session id %q, got %q\", sessionID, got)\n\t\t}\n\t})\n\n\tt.Run(\"should get null foreground session id in headless mode\", func(t *testing.T) {\n\t\tsessionID, err := client.GetForegroundSessionID(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get foreground session id: %v\", err)\n\t\t}\n\t\tif sessionID != nil {\n\t\t\tt.Errorf(\"Expected nil foreground session id in headless mode, got %q\", *sessionID)\n\t\t}\n\t})\n\n\tt.Run(\"should report error when setting foreground session in headless mode\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { session.Disconnect() })\n\n\t\terr = client.SetForegroundSessionID(t.Context(), session.SessionID)\n\t\tif err == nil {\n\t\t\tt.Fatal(\"Expected SetForegroundSessionID to fail in headless mode\")\n\t\t}\n\t\tif !strings.Contains(err.Error(), \"Not running in TUI+server mode\") {\n\t\t\tt.Errorf(\"Expected error mentioning 'Not running in TUI+server mode', got %v\", err)\n\t\t}\n\t})\n}\n" }, { "path": "go/internal/e2e/client_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"testing\"\n\t\"time\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\nfunc TestClientE2E(t *testing.T) {\n\tcliPath := testharness.CLIPath()\n\tif cliPath == \"\" {\n\t\tt.Fatal(\"CLI not found. Run 'npm install' in the nodejs directory first.\")\n\t}\n\n\tt.Run(\"should start and connect to server using stdio\", func(t *testing.T) {\n\t\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIPath: cliPath,\n\t\t\tUseStdio: copilot.Bool(true),\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t\t}\n\n\t\tif client.State() != copilot.StateConnected {\n\t\t\tt.Errorf(\"Expected state to be 'connected', got %q\", client.State())\n\t\t}\n\n\t\tpong, err := client.Ping(t.Context(), \"test message\")\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to ping: %v\", err)\n\t\t}\n\n\t\tif pong.Message != \"pong: test message\" {\n\t\t\tt.Errorf(\"Expected pong.message to be 'pong: test message', got %q\", pong.Message)\n\t\t}\n\n\t\tif pong.Timestamp < 0 {\n\t\t\tt.Errorf(\"Expected pong.timestamp >= 0, got %d\", pong.Timestamp)\n\t\t}\n\n\t\tif err := client.Stop(); err != nil {\n\t\t\tt.Errorf(\"Expected no errors on stop, got %v\", err)\n\t\t}\n\n\t\tif client.State() != copilot.StateDisconnected {\n\t\t\tt.Errorf(\"Expected state to be 'disconnected', got %q\", client.State())\n\t\t}\n\t})\n\n\tt.Run(\"should start and connect to server using tcp\", func(t *testing.T) {\n\t\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIPath: cliPath,\n\t\t\tUseStdio: copilot.Bool(false),\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t\t}\n\n\t\tif client.State() != copilot.StateConnected {\n\t\t\tt.Errorf(\"Expected state to be 'connected', got %q\", client.State())\n\t\t}\n\n\t\tpong, err := client.Ping(t.Context(), \"test message\")\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to ping: %v\", err)\n\t\t}\n\n\t\tif pong.Message != \"pong: test message\" {\n\t\t\tt.Errorf(\"Expected pong.message to be 'pong: test message', got %q\", pong.Message)\n\t\t}\n\n\t\tif pong.Timestamp < 0 {\n\t\t\tt.Errorf(\"Expected pong.timestamp >= 0, got %d\", pong.Timestamp)\n\t\t}\n\n\t\tif err := client.Stop(); err != nil {\n\t\t\tt.Errorf(\"Expected no errors on stop, got %v\", err)\n\t\t}\n\n\t\tif client.State() != copilot.StateDisconnected {\n\t\t\tt.Errorf(\"Expected state to be 'disconnected', got %q\", client.State())\n\t\t}\n\t})\n\n\tt.Run(\"should return errors on failed cleanup\", func(t *testing.T) {\n\t\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIPath: cliPath,\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\t_, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Kill the server process to force cleanup to fail\n\t\tclient.ForceStop()\n\t\ttime.Sleep(100 * time.Millisecond)\n\n\t\tif err := client.Stop(); err != nil {\n\t\t\tt.Logf(\"Got expected errors: %v\", err)\n\t\t}\n\n\t\tif client.State() != copilot.StateDisconnected {\n\t\t\tt.Errorf(\"Expected state to be 'disconnected', got %q\", client.State())\n\t\t}\n\t})\n\n\tt.Run(\"should forceStop without cleanup\", func(t *testing.T) {\n\t\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIPath: cliPath,\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\t_, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tclient.ForceStop()\n\n\t\tif client.State() != copilot.StateDisconnected {\n\t\t\tt.Errorf(\"Expected state to be 'disconnected', got %q\", client.State())\n\t\t}\n\t})\n\n\tt.Run(\"should get status with version and protocol info\", func(t *testing.T) {\n\t\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIPath: cliPath,\n\t\t\tUseStdio: copilot.Bool(true),\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t\t}\n\n\t\tstatus, err := client.GetStatus(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get status: %v\", err)\n\t\t}\n\n\t\tif status.Version == \"\" {\n\t\t\tt.Error(\"Expected status.Version to be non-empty\")\n\t\t}\n\n\t\tif status.ProtocolVersion < 1 {\n\t\t\tt.Errorf(\"Expected status.ProtocolVersion >= 1, got %d\", status.ProtocolVersion)\n\t\t}\n\n\t\tclient.Stop()\n\t})\n\n\tt.Run(\"should get auth status\", func(t *testing.T) {\n\t\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIPath: cliPath,\n\t\t\tUseStdio: copilot.Bool(true),\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t\t}\n\n\t\tauthStatus, err := client.GetAuthStatus(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get auth status: %v\", err)\n\t\t}\n\n\t\t// isAuthenticated is a bool, just verify we got a response\n\t\tif authStatus.IsAuthenticated {\n\t\t\tif authStatus.AuthType == nil {\n\t\t\t\tt.Error(\"Expected authType to be set when authenticated\")\n\t\t\t}\n\t\t\tif authStatus.StatusMessage == nil {\n\t\t\t\tt.Error(\"Expected statusMessage to be set when authenticated\")\n\t\t\t}\n\t\t}\n\n\t\tclient.Stop()\n\t})\n\n\tt.Run(\"should list models when authenticated\", func(t *testing.T) {\n\t\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIPath: cliPath,\n\t\t\tUseStdio: copilot.Bool(true),\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t\t}\n\n\t\tauthStatus, err := client.GetAuthStatus(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get auth status: %v\", err)\n\t\t}\n\n\t\tif !authStatus.IsAuthenticated {\n\t\t\t// Skip if not authenticated - models.list requires auth\n\t\t\tclient.Stop()\n\t\t\treturn\n\t\t}\n\n\t\tmodels, err := client.ListModels(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to list models: %v\", err)\n\t\t}\n\n\t\tif len(models) > 0 {\n\t\t\tmodel := models[0]\n\t\t\tif model.ID == \"\" {\n\t\t\t\tt.Error(\"Expected model.ID to be non-empty\")\n\t\t\t}\n\t\t\tif model.Name == \"\" {\n\t\t\t\tt.Error(\"Expected model.Name to be non-empty\")\n\t\t\t}\n\t\t}\n\n\t\tclient.Stop()\n\t})\n\n\tt.Run(\"should report error when CLI fails to start\", func(t *testing.T) {\n\t\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIPath: cliPath,\n\t\t\tCLIArgs: []string{\"--nonexistent-flag-for-testing\"},\n\t\t\tUseStdio: copilot.Bool(true),\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\terr := client.Start(t.Context())\n\t\tif err == nil {\n\t\t\tt.Fatal(\"Expected Start to fail with invalid CLI args\")\n\t\t}\n\n\t\t// Verify subsequent calls also fail (don't hang)\n\t\tsession, err := client.CreateSession(t.Context(), nil)\n\t\tif err == nil {\n\t\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{Prompt: \"test\"})\n\t\t}\n\t\tif err == nil {\n\t\t\tt.Fatal(\"Expected CreateSession/Send to fail after CLI exit\")\n\t\t}\n\t})\n}\n" }, { "path": "go/internal/e2e/client_lifecycle_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"sync/atomic\"\n\t\"testing\"\n\t\"time\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\n// Mirrors dotnet/test/ClientLifecycleTests.cs.\nfunc TestClientLifecycleE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\n\tt.Run(\"should receive session created lifecycle event\", func(t *testing.T) {\n\t\tclient := ctx.NewClient()\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tcreated := make(chan copilot.SessionLifecycleEvent, 4)\n\t\tunsubscribe := client.On(func(event copilot.SessionLifecycleEvent) {\n\t\t\tif event.Type == copilot.SessionLifecycleCreated {\n\t\t\t\tselect {\n\t\t\t\tcase created <- event:\n\t\t\t\tdefault:\n\t\t\t\t}\n\t\t\t}\n\t\t})\n\t\tdefer unsubscribe()\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tselect {\n\t\tcase evt := <-created:\n\t\t\tif evt.Type != copilot.SessionLifecycleCreated {\n\t\t\t\tt.Errorf(\"Expected event type %q, got %q\", copilot.SessionLifecycleCreated, evt.Type)\n\t\t\t}\n\t\t\tif evt.SessionID != session.SessionID {\n\t\t\t\tt.Errorf(\"Expected session id %q, got %q\", session.SessionID, evt.SessionID)\n\t\t\t}\n\t\tcase <-time.After(10 * time.Second):\n\t\t\tt.Fatal(\"Timed out waiting for session.created lifecycle event\")\n\t\t}\n\t})\n\n\tt.Run(\"should filter session lifecycle events by type\", func(t *testing.T) {\n\t\tclient := ctx.NewClient()\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tcreated := make(chan copilot.SessionLifecycleEvent, 4)\n\t\tunsubscribe := client.OnEventType(copilot.SessionLifecycleCreated, func(event copilot.SessionLifecycleEvent) {\n\t\t\tselect {\n\t\t\tcase created <- event:\n\t\t\tdefault:\n\t\t\t}\n\t\t})\n\t\tdefer unsubscribe()\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tselect {\n\t\tcase evt := <-created:\n\t\t\tif evt.Type != copilot.SessionLifecycleCreated {\n\t\t\t\tt.Errorf(\"Expected event type %q, got %q\", copilot.SessionLifecycleCreated, evt.Type)\n\t\t\t}\n\t\t\tif evt.SessionID != session.SessionID {\n\t\t\t\tt.Errorf(\"Expected session id %q, got %q\", session.SessionID, evt.SessionID)\n\t\t\t}\n\t\tcase <-time.After(10 * time.Second):\n\t\t\tt.Fatal(\"Timed out waiting for filtered session.created lifecycle event\")\n\t\t}\n\t})\n\n\tt.Run(\"disposing lifecycle subscription stops receiving events\", func(t *testing.T) {\n\t\tclient := ctx.NewClient()\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tvar disposedCount int64\n\t\tunsubscribeFirst := client.On(func(event copilot.SessionLifecycleEvent) {\n\t\t\tatomic.AddInt64(&disposedCount, 1)\n\t\t})\n\t\t// Dispose before any session is created — should never be invoked.\n\t\tunsubscribeFirst()\n\n\t\tcreated := make(chan copilot.SessionLifecycleEvent, 4)\n\t\tunsubscribeActive := client.OnEventType(copilot.SessionLifecycleCreated, func(event copilot.SessionLifecycleEvent) {\n\t\t\tselect {\n\t\t\tcase created <- event:\n\t\t\tdefault:\n\t\t\t}\n\t\t})\n\t\tdefer unsubscribeActive()\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tselect {\n\t\tcase evt := <-created:\n\t\t\tif evt.SessionID != session.SessionID {\n\t\t\t\tt.Errorf(\"Expected session id %q, got %q\", session.SessionID, evt.SessionID)\n\t\t\t}\n\t\tcase <-time.After(10 * time.Second):\n\t\t\tt.Fatal(\"Timed out waiting for active subscription to receive event\")\n\t\t}\n\n\t\tif got := atomic.LoadInt64(&disposedCount); got != 0 {\n\t\t\tt.Errorf(\"Expected disposed subscription to receive 0 events, got %d\", got)\n\t\t}\n\t})\n\n\tt.Run(\"stop disconnects client\", func(t *testing.T) {\n\t\tclient := ctx.NewClient()\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t\t}\n\t\tif client.State() != copilot.StateConnected {\n\t\t\tt.Errorf(\"Expected state to be connected after Start, got %q\", client.State())\n\t\t}\n\n\t\tif err := client.Stop(); err != nil {\n\t\t\tt.Fatalf(\"Failed to stop client: %v\", err)\n\t\t}\n\t\tif client.State() != copilot.StateDisconnected {\n\t\t\tt.Errorf(\"Expected state to be disconnected after Stop, got %q\", client.State())\n\t\t}\n\t})\n\n\tt.Run(\"force stop disconnects client\", func(t *testing.T) {\n\t\tclient := ctx.NewClient()\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t\t}\n\t\tif client.State() != copilot.StateConnected {\n\t\t\tt.Errorf(\"Expected state to be connected after Start, got %q\", client.State())\n\t\t}\n\n\t\tclient.ForceStop()\n\t\tif client.State() != copilot.StateDisconnected {\n\t\t\tt.Errorf(\"Expected state to be disconnected after ForceStop, got %q\", client.State())\n\t\t}\n\t})\n}\n" }, { "path": "go/internal/e2e/client_options_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"encoding/json\"\n\t\"net\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\n// Mirrors the E2E portions of dotnet/test/ClientOptionsTests.cs (snapshot category \"client_options\").\n// .NET-only tests that exercise validation on the options struct alone are skipped here because\n// Go's ClientOptions is a plain struct with no setter validation; equivalent behavior is covered\n// in package-level unit tests.\nfunc TestClientOptionsE2E(t *testing.T) {\n\tt.Run(\"autostart false requires explicit start\", func(t *testing.T) {\n\t\tctx := testharness.NewTestContext(t)\n\t\tclient := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\t\topts.AutoStart = copilot.Bool(false)\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif got := client.State(); got != copilot.StateDisconnected {\n\t\t\tt.Errorf(\"Expected initial state Disconnected, got %v\", got)\n\t\t}\n\n\t\tif _, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t}); err == nil {\n\t\t\tt.Fatal(\"Expected CreateSession to fail when AutoStart=false and Start was not called\")\n\t\t}\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Start failed: %v\", err)\n\t\t}\n\t\tif got := client.State(); got != copilot.StateConnected {\n\t\t\tt.Errorf(\"Expected state Connected after Start, got %v\", got)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed after Start: %v\", err)\n\t\t}\n\t\tif session.SessionID == \"\" {\n\t\t\tt.Error(\"Expected non-empty session id\")\n\t\t}\n\t\tsession.Disconnect()\n\t})\n\n\tt.Run(\"should listen on configured tcp port\", func(t *testing.T) {\n\t\tctx := testharness.NewTestContext(t)\n\t\tport := getAvailableTcpPort(t)\n\n\t\tclient := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\t\topts.UseStdio = copilot.Bool(false)\n\t\t\topts.Port = port\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Start failed: %v\", err)\n\t\t}\n\t\tif got := client.State(); got != copilot.StateConnected {\n\t\t\tt.Errorf(\"Expected state Connected, got %v\", got)\n\t\t}\n\t\tif got := client.ActualPort(); got != port {\n\t\t\tt.Errorf(\"Expected ActualPort=%d, got %d\", port, got)\n\t\t}\n\n\t\t// Ping over the connection to confirm it is usable.\n\t\tpingResp, err := client.Ping(t.Context(), \"fixed-port\")\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Ping failed: %v\", err)\n\t\t}\n\t\tif !strings.Contains(pingResp.Message, \"fixed-port\") {\n\t\t\tt.Errorf(\"Expected ping response to echo 'fixed-port', got %q\", pingResp.Message)\n\t\t}\n\t})\n\n\tt.Run(\"should use client cwd for default workingdirectory\", func(t *testing.T) {\n\t\tctx := testharness.NewTestContext(t)\n\t\tctx.ConfigureForTest(t)\n\n\t\tclientCwd := filepath.Join(ctx.WorkDir, \"client-cwd\")\n\t\tif err := os.MkdirAll(clientCwd, 0755); err != nil {\n\t\t\tt.Fatalf(\"Failed to create clientCwd: %v\", err)\n\t\t}\n\t\tif err := os.WriteFile(filepath.Join(clientCwd, \"marker.txt\"), []byte(\"I am in the client cwd\"), 0644); err != nil {\n\t\t\tt.Fatalf(\"Failed to write marker file: %v\", err)\n\t\t}\n\n\t\tclient := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\t\topts.Cwd = clientCwd\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { session.Disconnect() })\n\n\t\tevt, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Read the file marker.txt and tell me what it says\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\t\tassistant, ok := evt.Data.(*copilot.AssistantMessageData)\n\t\tif !ok {\n\t\t\tt.Fatalf(\"Expected AssistantMessageData, got %T\", evt.Data)\n\t\t}\n\t\tif !strings.Contains(assistant.Content, \"client cwd\") {\n\t\t\tt.Errorf(\"Expected assistant message to contain 'client cwd', got %q\", assistant.Content)\n\t\t}\n\t})\n\n\tt.Run(\"should propagate process options to spawned cli\", func(t *testing.T) {\n\t\t// Mirrors: Should_Propagate_Process_Options_To_Spawned_Cli\n\t\t// Spawns a fake stdio CLI (a Node.js script) so we can assert that the\n\t\t// SDK passes the right argv / env / cwd / RPC params through to the\n\t\t// subprocess.\n\t\tctx := testharness.NewTestContext(t)\n\n\t\tcliPath := filepath.Join(ctx.WorkDir, \"fake-cli-\"+randomHex(t)+\".js\")\n\t\tcapturePath := filepath.Join(ctx.WorkDir, \"fake-cli-capture-\"+randomHex(t)+\".json\")\n\t\ttelemetryPath := filepath.Join(ctx.WorkDir, \"telemetry.jsonl\")\n\t\tif err := os.WriteFile(cliPath, []byte(fakeStdioCliScript), 0644); err != nil {\n\t\t\tt.Fatalf(\"Failed to write fake CLI script: %v\", err)\n\t\t}\n\n\t\tclient := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\t\topts.AutoStart = copilot.Bool(false)\n\t\t\topts.CLIPath = cliPath\n\t\t\topts.CLIArgs = []string{\"--capture-file\", capturePath}\n\t\t\topts.GitHubToken = \"process-option-token\"\n\t\t\topts.LogLevel = \"debug\"\n\t\t\topts.SessionIdleTimeoutSeconds = 17\n\t\t\topts.Telemetry = &copilot.TelemetryConfig{\n\t\t\t\tOTLPEndpoint: \"http://127.0.0.1:4318\",\n\t\t\t\tFilePath: telemetryPath,\n\t\t\t\tExporterType: \"file\",\n\t\t\t\tSourceName: \"go-sdk-e2e\",\n\t\t\t\tCaptureContent: copilot.Bool(true),\n\t\t\t}\n\t\t\topts.UseLoggedInUser = copilot.Bool(false)\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Start failed: %v\", err)\n\t\t}\n\n\t\tcapture := readCapture(t, capturePath)\n\t\targs := capture.Args\n\n\t\tassertArgValue(t, args, \"--log-level\", \"debug\")\n\t\tif !containsStringE(args, \"--stdio\") {\n\t\t\tt.Errorf(\"Expected --stdio in args, got %v\", args)\n\t\t}\n\t\tassertArgValue(t, args, \"--auth-token-env\", \"COPILOT_SDK_AUTH_TOKEN\")\n\t\tif !containsStringE(args, \"--no-auto-login\") {\n\t\t\tt.Errorf(\"Expected --no-auto-login in args, got %v\", args)\n\t\t}\n\t\tassertArgValue(t, args, \"--session-idle-timeout\", \"17\")\n\n\t\texpectedCwd, _ := filepath.Abs(ctx.WorkDir)\n\t\tactualCwd, _ := filepath.Abs(capture.Cwd)\n\t\tif expectedCwd != actualCwd {\n\t\t\tt.Errorf(\"Expected cwd=%q, got %q\", expectedCwd, actualCwd)\n\t\t}\n\n\t\texpectEnv := map[string]string{\n\t\t\t\"COPILOT_SDK_AUTH_TOKEN\": \"process-option-token\",\n\t\t\t\"COPILOT_OTEL_ENABLED\": \"true\",\n\t\t\t\"OTEL_EXPORTER_OTLP_ENDPOINT\": \"http://127.0.0.1:4318\",\n\t\t\t\"COPILOT_OTEL_FILE_EXPORTER_PATH\": telemetryPath,\n\t\t\t\"COPILOT_OTEL_EXPORTER_TYPE\": \"file\",\n\t\t\t\"COPILOT_OTEL_SOURCE_NAME\": \"go-sdk-e2e\",\n\t\t\t\"OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT\": \"true\",\n\t\t}\n\t\tfor k, v := range expectEnv {\n\t\t\tif got := capture.Env[k]; got != v {\n\t\t\t\tt.Errorf(\"Expected env[%s]=%q, got %q\", k, v, got)\n\t\t\t}\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tEnableConfigDiscovery: true,\n\t\t\tIncludeSubAgentStreamingEvents: copilot.Bool(false),\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { session.Disconnect() })\n\n\t\tupdated := readCapture(t, capturePath)\n\t\tvar createReq *capturedRequest\n\t\tfor i := range updated.Requests {\n\t\t\tif updated.Requests[i].Method == \"session.create\" {\n\t\t\t\tcreateReq = &updated.Requests[i]\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif createReq == nil {\n\t\t\tt.Fatalf(\"session.create request was not captured. Captured requests: %+v\", updated.Requests)\n\t\t}\n\t\tparams, ok := createReq.Params.(map[string]any)\n\t\tif !ok {\n\t\t\tt.Fatalf(\"Expected session.create params to be an object, got %T\", createReq.Params)\n\t\t}\n\t\tif v, ok := params[\"enableConfigDiscovery\"].(bool); !ok || v != true {\n\t\t\tt.Errorf(\"Expected session.create.params.enableConfigDiscovery=true, got %v\", params[\"enableConfigDiscovery\"])\n\t\t}\n\t\tif v, ok := params[\"includeSubAgentStreamingEvents\"].(bool); !ok || v != false {\n\t\t\tt.Errorf(\"Expected session.create.params.includeSubAgentStreamingEvents=false, got %v\", params[\"includeSubAgentStreamingEvents\"])\n\t\t}\n\t})\n}\n\n// ---------------------------------------------------------------------------\n// Unit-style tests mirroring the property-only tests in\n// dotnet/test/ClientOptionsTests.cs.\n// ---------------------------------------------------------------------------\n\nfunc TestClientOptionsUnit(t *testing.T) {\n\tt.Run(\"should accept GitHubToken option\", func(t *testing.T) {\n\t\t// Mirrors: Should_Accept_GitHubToken_Option\n\t\topts := copilot.ClientOptions{GitHubToken: \"gho_test_token\"}\n\t\tif opts.GitHubToken != \"gho_test_token\" {\n\t\t\tt.Errorf(\"Expected GitHubToken=%q, got %q\", \"gho_test_token\", opts.GitHubToken)\n\t\t}\n\t})\n\n\tt.Run(\"should default UseLoggedInUser to nil\", func(t *testing.T) {\n\t\t// Mirrors: Should_Default_UseLoggedInUser_To_Null\n\t\topts := copilot.ClientOptions{}\n\t\tif opts.UseLoggedInUser != nil {\n\t\t\tt.Errorf(\"Expected UseLoggedInUser to be nil by default, got %v\", opts.UseLoggedInUser)\n\t\t}\n\t})\n\n\tt.Run(\"should allow explicit UseLoggedInUser false\", func(t *testing.T) {\n\t\t// Mirrors: Should_Allow_Explicit_UseLoggedInUser_False\n\t\topts := copilot.ClientOptions{UseLoggedInUser: copilot.Bool(false)}\n\t\tif opts.UseLoggedInUser == nil || *opts.UseLoggedInUser != false {\n\t\t\tt.Errorf(\"Expected UseLoggedInUser=false, got %v\", opts.UseLoggedInUser)\n\t\t}\n\t})\n\n\tt.Run(\"should allow explicit UseLoggedInUser true with GitHubToken\", func(t *testing.T) {\n\t\t// Mirrors: Should_Allow_Explicit_UseLoggedInUser_True_With_GitHubToken\n\t\topts := copilot.ClientOptions{\n\t\t\tGitHubToken: \"gho_test_token\",\n\t\t\tUseLoggedInUser: copilot.Bool(true),\n\t\t}\n\t\tif opts.UseLoggedInUser == nil || *opts.UseLoggedInUser != true {\n\t\t\tt.Errorf(\"Expected UseLoggedInUser=true, got %v\", opts.UseLoggedInUser)\n\t\t}\n\t\tif opts.GitHubToken != \"gho_test_token\" {\n\t\t\tt.Errorf(\"Expected GitHubToken=%q, got %q\", \"gho_test_token\", opts.GitHubToken)\n\t\t}\n\t})\n\n\tt.Run(\"should panic when GitHubToken used with CliUrl\", func(t *testing.T) {\n\t\t// Mirrors: Should_Throw_When_GitHubToken_Used_With_CliUrl\n\t\t// Go's NewClient validates mutually exclusive auth + CLIUrl combinations\n\t\t// with panic() instead of an exception.\n\t\tassertPanics(t, func() {\n\t\t\t_ = copilot.NewClient(&copilot.ClientOptions{\n\t\t\t\tCLIUrl: \"localhost:8080\",\n\t\t\t\tGitHubToken: \"gho_test_token\",\n\t\t\t})\n\t\t})\n\t})\n\n\tt.Run(\"should panic when UseLoggedInUser used with CliUrl\", func(t *testing.T) {\n\t\t// Mirrors: Should_Throw_When_UseLoggedInUser_Used_With_CliUrl\n\t\tassertPanics(t, func() {\n\t\t\t_ = copilot.NewClient(&copilot.ClientOptions{\n\t\t\t\tCLIUrl: \"localhost:8080\",\n\t\t\t\tUseLoggedInUser: copilot.Bool(false),\n\t\t\t})\n\t\t})\n\t})\n\n\tt.Run(\"should default SessionIdleTimeoutSeconds to zero\", func(t *testing.T) {\n\t\t// Mirrors: Should_Default_SessionIdleTimeoutSeconds_To_Null\n\t\t// Go uses int (no nullable wrapper); the zero value is 0 and is\n\t\t// treated as \"unset\" by the SDK (no --session-idle-timeout flag).\n\t\topts := copilot.ClientOptions{}\n\t\tif opts.SessionIdleTimeoutSeconds != 0 {\n\t\t\tt.Errorf(\"Expected SessionIdleTimeoutSeconds=0 by default, got %d\", opts.SessionIdleTimeoutSeconds)\n\t\t}\n\t})\n\n\tt.Run(\"should accept SessionIdleTimeoutSeconds option\", func(t *testing.T) {\n\t\t// Mirrors: Should_Accept_SessionIdleTimeoutSeconds_Option\n\t\topts := copilot.ClientOptions{SessionIdleTimeoutSeconds: 600}\n\t\tif opts.SessionIdleTimeoutSeconds != 600 {\n\t\t\tt.Errorf(\"Expected SessionIdleTimeoutSeconds=600, got %d\", opts.SessionIdleTimeoutSeconds)\n\t\t}\n\t})\n}\n\nfunc getAvailableTcpPort(t *testing.T) int {\n\tt.Helper()\n\tlistener, err := net.Listen(\"tcp\", \"127.0.0.1:0\")\n\tif err != nil {\n\t\tt.Fatalf(\"Failed to listen on a free TCP port: %v\", err)\n\t}\n\tdefer listener.Close()\n\treturn listener.Addr().(*net.TCPAddr).Port\n}\n\nfunc assertPanics(t *testing.T, fn func()) {\n\tt.Helper()\n\tdefer func() {\n\t\tif r := recover(); r == nil {\n\t\t\tt.Error(\"Expected the function to panic, but it did not\")\n\t\t}\n\t}()\n\tfn()\n}\n\nfunc containsStringE(slice []string, s string) bool {\n\tfor _, v := range slice {\n\t\tif v == s {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\nfunc assertArgValue(t *testing.T, args []string, name, expected string) {\n\tt.Helper()\n\tfor i, v := range args {\n\t\tif v == name {\n\t\t\tif i+1 >= len(args) {\n\t\t\t\tt.Errorf(\"Argument %q is missing a value. Args: %v\", name, args)\n\t\t\t\treturn\n\t\t\t}\n\t\t\tif args[i+1] != expected {\n\t\t\t\tt.Errorf(\"Expected argument %q to have value %q, got %q. Args: %v\", name, expected, args[i+1], args)\n\t\t\t}\n\t\t\treturn\n\t\t}\n\t}\n\tt.Errorf(\"Argument %q was not present. Args: %v\", name, args)\n}\n\n// capturedCli mirrors the JSON file written by the fake stdio CLI script.\ntype capturedCli struct {\n\tArgs []string `json:\"args\"`\n\tCwd string `json:\"cwd\"`\n\tRequests []capturedRequest `json:\"requests\"`\n\tEnv map[string]string `json:\"env\"`\n}\n\ntype capturedRequest struct {\n\tMethod string `json:\"method\"`\n\tParams any `json:\"params\"`\n}\n\nfunc readCapture(t *testing.T, path string) capturedCli {\n\tt.Helper()\n\tdata, err := os.ReadFile(path)\n\tif err != nil {\n\t\tt.Fatalf(\"Failed to read capture file %q: %v\", path, err)\n\t}\n\tvar c capturedCli\n\tif err := json.Unmarshal(data, &c); err != nil {\n\t\tt.Fatalf(\"Failed to parse capture file %q: %v\\nContent: %s\", path, err, string(data))\n\t}\n\treturn c\n}\n\n// fakeStdioCliScript is identical to the one used by the .NET / Python\n// equivalents (dotnet/test/ClientOptionsTests.cs and python/e2e/test_client_options.py).\nconst fakeStdioCliScript = `\nconst fs = require(\"fs\");\n\nconst captureIndex = process.argv.indexOf(\"--capture-file\");\nconst captureFile = captureIndex >= 0 ? process.argv[captureIndex + 1] : undefined;\nconst requests = [];\n\nfunction saveCapture() {\n if (!captureFile) {\n return;\n }\n fs.writeFileSync(captureFile, JSON.stringify({\n args: process.argv.slice(2),\n cwd: process.cwd(),\n requests,\n env: {\n COPILOT_SDK_AUTH_TOKEN: process.env.COPILOT_SDK_AUTH_TOKEN,\n COPILOT_OTEL_ENABLED: process.env.COPILOT_OTEL_ENABLED,\n OTEL_EXPORTER_OTLP_ENDPOINT: process.env.OTEL_EXPORTER_OTLP_ENDPOINT,\n COPILOT_OTEL_FILE_EXPORTER_PATH: process.env.COPILOT_OTEL_FILE_EXPORTER_PATH,\n COPILOT_OTEL_EXPORTER_TYPE: process.env.COPILOT_OTEL_EXPORTER_TYPE,\n COPILOT_OTEL_SOURCE_NAME: process.env.COPILOT_OTEL_SOURCE_NAME,\n OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT:\n process.env.OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT,\n },\n }));\n}\n\nsaveCapture();\n\nlet buffer = Buffer.alloc(0);\nprocess.stdin.on(\"data\", chunk => {\n buffer = Buffer.concat([buffer, chunk]);\n processBuffer();\n});\nprocess.stdin.resume();\n\nfunction processBuffer() {\n while (true) {\n const headerEnd = buffer.indexOf(\"\\r\\n\\r\\n\");\n if (headerEnd < 0) return;\n const header = buffer.subarray(0, headerEnd).toString(\"utf8\");\n const match = /Content-Length:\\s*(\\d+)/i.exec(header);\n if (!match) throw new Error(\"Missing Content-Length header\");\n const length = Number(match[1]);\n const bodyStart = headerEnd + 4;\n const bodyEnd = bodyStart + length;\n if (buffer.length < bodyEnd) return;\n const body = buffer.subarray(bodyStart, bodyEnd).toString(\"utf8\");\n buffer = buffer.subarray(bodyEnd);\n handleMessage(JSON.parse(body));\n }\n}\n\nfunction handleMessage(message) {\n if (!Object.prototype.hasOwnProperty.call(message, \"id\")) {\n return;\n }\n requests.push({ method: message.method, params: message.params });\n saveCapture();\n if (message.method === \"ping\") {\n writeResponse(message.id, { message: \"pong\", protocolVersion: 3, timestamp: Date.now() });\n return;\n }\n if (message.method === \"session.create\") {\n const sessionId = (message.params && message.params.sessionId) || \"fake-session\";\n writeResponse(message.id, { sessionId, workspacePath: null, capabilities: null });\n return;\n }\n writeResponse(message.id, {});\n}\n\nfunction writeResponse(id, result) {\n const body = JSON.stringify({ jsonrpc: \"2.0\", id, result });\n process.stdout.write(\"Content-Length: \" + Buffer.byteLength(body, \"utf8\") + \"\\r\\n\\r\\n\" + body);\n}\n`\n" }, { "path": "go/internal/e2e/commands_and_elicitation_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"testing\"\n\t\"time\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n\t\"github.com/github/copilot-sdk/go/rpc\"\n)\n\nfunc TestCommandsE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient1 := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\topts.UseStdio = copilot.Bool(false)\n\t})\n\tt.Cleanup(func() { client1.ForceStop() })\n\n\t// Start client1 with an init session to get the port\n\tinitSession, err := client1.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t})\n\tif err != nil {\n\t\tt.Fatalf(\"Failed to create init session: %v\", err)\n\t}\n\tinitSession.Disconnect()\n\n\tactualPort := client1.ActualPort()\n\tif actualPort == 0 {\n\t\tt.Fatalf(\"Expected non-zero port from TCP mode client\")\n\t}\n\n\tclient2 := copilot.NewClient(&copilot.ClientOptions{\n\t\tCLIUrl: fmt.Sprintf(\"localhost:%d\", actualPort),\n\t})\n\tt.Cleanup(func() { client2.ForceStop() })\n\n\tt.Run(\"commands.changed event when another client joins with commands\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t// Client1 creates a session without commands\n\t\tsession1, err := client1.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Listen for commands.changed event on client1\n\t\tcommandsChangedCh := make(chan copilot.SessionEvent, 1)\n\t\tunsubscribe := session1.On(func(event copilot.SessionEvent) {\n\t\t\tif event.Type == copilot.SessionEventTypeCommandsChanged {\n\t\t\t\tselect {\n\t\t\t\tcase commandsChangedCh <- event:\n\t\t\t\tdefault:\n\t\t\t\t}\n\t\t\t}\n\t\t})\n\t\tdefer unsubscribe()\n\n\t\t// Client2 joins with commands\n\t\tsession2, err := client2.ResumeSession(t.Context(), session1.SessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tDisableResume: true,\n\t\t\tCommands: []copilot.CommandDefinition{\n\t\t\t\t{\n\t\t\t\t\tName: \"deploy\",\n\t\t\t\t\tDescription: \"Deploy the app\",\n\t\t\t\t\tHandler: func(ctx copilot.CommandContext) error { return nil },\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\n\t\tselect {\n\t\tcase event := <-commandsChangedCh:\n\t\t\td, ok := event.Data.(*copilot.CommandsChangedData)\n\t\t\tif !ok || len(d.Commands) == 0 {\n\t\t\t\tt.Errorf(\"Expected commands in commands.changed event\")\n\t\t\t} else {\n\t\t\t\tfound := false\n\t\t\t\tfor _, cmd := range d.Commands {\n\t\t\t\t\tif cmd.Name == \"deploy\" {\n\t\t\t\t\t\tfound = true\n\t\t\t\t\t\tif cmd.Description == nil || *cmd.Description != \"Deploy the app\" {\n\t\t\t\t\t\t\tt.Errorf(\"Expected deploy command description 'Deploy the app', got %v\", cmd.Description)\n\t\t\t\t\t\t}\n\t\t\t\t\t\tbreak\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tif !found {\n\t\t\t\t\tt.Errorf(\"Expected 'deploy' command in commands.changed event, got %+v\", d.Commands)\n\t\t\t\t}\n\t\t\t}\n\t\tcase <-time.After(30 * time.Second):\n\t\t\tt.Fatal(\"Timed out waiting for commands.changed event\")\n\t\t}\n\n\t\tsession2.Disconnect()\n\t})\n\n\tt.Run(\"session with commands creates successfully\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client1.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tCommands: []copilot.CommandDefinition{\n\t\t\t\t{Name: \"deploy\", Description: \"Deploy the app\", Handler: func(_ copilot.CommandContext) error { return nil }},\n\t\t\t\t{Name: \"rollback\", Handler: func(_ copilot.CommandContext) error { return nil }},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\t\tif session.SessionID == \"\" {\n\t\t\tt.Error(\"Expected non-empty SessionID\")\n\t\t}\n\t\t_ = session.Disconnect()\n\t})\n\n\tt.Run(\"session with commands resumes successfully\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession1, err := client1.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\t\tsessionID := session1.SessionID\n\t\tt.Cleanup(func() { _ = session1.Disconnect() })\n\n\t\tsession2, err := client1.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tCommands: []copilot.CommandDefinition{\n\t\t\t\t{Name: \"deploy\", Description: \"Deploy\", Handler: func(_ copilot.CommandContext) error { return nil }},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"ResumeSession failed: %v\", err)\n\t\t}\n\t\tif session2.SessionID != sessionID {\n\t\t\tt.Errorf(\"Expected SessionID %q, got %q\", sessionID, session2.SessionID)\n\t\t}\n\t\t_ = session2.Disconnect()\n\t})\n\n\tt.Run(\"session with no commands creates successfully\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client1.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\t\tif session == nil {\n\t\t\tt.Fatal(\"Expected non-nil session\")\n\t\t}\n\t\t_ = session.Disconnect()\n\t})\n}\n\nfunc TestUIElicitationE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"elicitation methods error in headless mode\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Verify capabilities report no elicitation\n\t\tcaps := session.Capabilities()\n\t\tif caps.UI != nil && caps.UI.Elicitation {\n\t\t\tt.Error(\"Expected no elicitation capability in headless mode\")\n\t\t}\n\n\t\t// All UI methods should return a \"not supported\" error\n\t\tui := session.UI()\n\n\t\t_, err = ui.Confirm(t.Context(), \"Are you sure?\")\n\t\tif err == nil {\n\t\t\tt.Error(\"Expected error calling Confirm without elicitation capability\")\n\t\t} else if !strings.Contains(err.Error(), \"not supported\") {\n\t\t\tt.Errorf(\"Expected 'not supported' in error message, got: %s\", err.Error())\n\t\t}\n\n\t\t_, _, err = ui.Select(t.Context(), \"Pick one\", []string{\"a\", \"b\"})\n\t\tif err == nil {\n\t\t\tt.Error(\"Expected error calling Select without elicitation capability\")\n\t\t} else if !strings.Contains(err.Error(), \"not supported\") {\n\t\t\tt.Errorf(\"Expected 'not supported' in error message, got: %s\", err.Error())\n\t\t}\n\n\t\t_, _, err = ui.Input(t.Context(), \"Enter name\", nil)\n\t\tif err == nil {\n\t\t\tt.Error(\"Expected error calling Input without elicitation capability\")\n\t\t} else if !strings.Contains(err.Error(), \"not supported\") {\n\t\t\tt.Errorf(\"Expected 'not supported' in error message, got: %s\", err.Error())\n\t\t}\n\t})\n}\n\nfunc TestUIElicitationCallbackE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"session with OnElicitationRequest reports elicitation capability\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tOnElicitationRequest: func(ctx copilot.ElicitationContext) (copilot.ElicitationResult, error) {\n\t\t\t\treturn copilot.ElicitationResult{Action: \"accept\", Content: map[string]any{}}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tcaps := session.Capabilities()\n\t\tif caps.UI == nil || !caps.UI.Elicitation {\n\t\t\t// The test harness may or may not include capabilities in the response.\n\t\t\t// When running against a real CLI, this will be true.\n\t\t\tt.Logf(\"Note: capabilities.ui.elicitation=%v (may be false with test harness)\", caps.UI)\n\t\t}\n\t})\n\n\tt.Run(\"session without OnElicitationRequest reports no elicitation capability\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tcaps := session.Capabilities()\n\t\tif caps.UI != nil && caps.UI.Elicitation {\n\t\t\tt.Error(\"Expected no elicitation capability when OnElicitationRequest is not provided\")\n\t\t}\n\t})\n\n\tt.Run(\"confirm returns true when handler accepts\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tOnElicitationRequest: func(ec copilot.ElicitationContext) (copilot.ElicitationResult, error) {\n\t\t\t\tif ec.Message != \"Confirm?\" {\n\t\t\t\t\tt.Errorf(\"Expected Message='Confirm?', got %q\", ec.Message)\n\t\t\t\t}\n\t\t\t\tif !schemaHasProperty(ec.RequestedSchema, \"confirmed\") {\n\t\t\t\t\tt.Errorf(\"Expected RequestedSchema to contain 'confirmed' property\")\n\t\t\t\t}\n\t\t\t\treturn copilot.ElicitationResult{\n\t\t\t\t\tAction: \"accept\",\n\t\t\t\t\tContent: map[string]any{\"confirmed\": true},\n\t\t\t\t}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tok, err := session.UI().Confirm(t.Context(), \"Confirm?\")\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Confirm failed: %v\", err)\n\t\t}\n\t\tif !ok {\n\t\t\tt.Error(\"Expected Confirm to return true when handler accepts\")\n\t\t}\n\t})\n\n\tt.Run(\"confirm returns false when handler declines\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tOnElicitationRequest: func(ec copilot.ElicitationContext) (copilot.ElicitationResult, error) {\n\t\t\t\treturn copilot.ElicitationResult{Action: \"decline\"}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tok, err := session.UI().Confirm(t.Context(), \"Confirm?\")\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Confirm failed: %v\", err)\n\t\t}\n\t\tif ok {\n\t\t\tt.Error(\"Expected Confirm to return false when handler declines\")\n\t\t}\n\t})\n\n\tt.Run(\"select returns selected option\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tOnElicitationRequest: func(ec copilot.ElicitationContext) (copilot.ElicitationResult, error) {\n\t\t\t\tif ec.Message != \"Choose\" {\n\t\t\t\t\tt.Errorf(\"Expected Message='Choose', got %q\", ec.Message)\n\t\t\t\t}\n\t\t\t\tif !schemaHasProperty(ec.RequestedSchema, \"selection\") {\n\t\t\t\t\tt.Errorf(\"Expected RequestedSchema to contain 'selection' property\")\n\t\t\t\t}\n\t\t\t\treturn copilot.ElicitationResult{\n\t\t\t\t\tAction: \"accept\",\n\t\t\t\t\tContent: map[string]any{\"selection\": \"beta\"},\n\t\t\t\t}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tvalue, ok, err := session.UI().Select(t.Context(), \"Choose\", []string{\"alpha\", \"beta\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Select failed: %v\", err)\n\t\t}\n\t\tif !ok {\n\t\t\tt.Error(\"Expected Select to return ok=true on accept\")\n\t\t}\n\t\tif value != \"beta\" {\n\t\t\tt.Errorf(\"Expected selected value 'beta', got %q\", value)\n\t\t}\n\t})\n\n\tt.Run(\"input returns freeform value\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tOnElicitationRequest: func(ec copilot.ElicitationContext) (copilot.ElicitationResult, error) {\n\t\t\t\tif ec.Message != \"Enter value\" {\n\t\t\t\t\tt.Errorf(\"Expected Message='Enter value', got %q\", ec.Message)\n\t\t\t\t}\n\t\t\t\tif !schemaHasProperty(ec.RequestedSchema, \"value\") {\n\t\t\t\t\tt.Errorf(\"Expected RequestedSchema to contain 'value' property\")\n\t\t\t\t}\n\t\t\t\treturn copilot.ElicitationResult{\n\t\t\t\t\tAction: \"accept\",\n\t\t\t\t\tContent: map[string]any{\"value\": \"typed value\"},\n\t\t\t\t}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tminLen := 1\n\t\tmaxLen := 20\n\t\tvalue, ok, err := session.UI().Input(t.Context(), \"Enter value\", &copilot.InputOptions{\n\t\t\tTitle: \"Value\",\n\t\t\tDescription: \"A value to test\",\n\t\t\tMinLength: &minLen,\n\t\t\tMaxLength: &maxLen,\n\t\t\tDefault: \"default\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Input failed: %v\", err)\n\t\t}\n\t\tif !ok {\n\t\t\tt.Error(\"Expected Input to return ok=true on accept\")\n\t\t}\n\t\tif value != \"typed value\" {\n\t\t\tt.Errorf(\"Expected typed value 'typed value', got %q\", value)\n\t\t}\n\t})\n\n\tt.Run(\"elicitation returns all action shapes\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tresponses := []copilot.ElicitationResult{\n\t\t\t{Action: \"accept\", Content: map[string]any{\"name\": \"Mona\"}},\n\t\t\t{Action: \"decline\"},\n\t\t\t{Action: \"cancel\"},\n\t\t}\n\t\tvar idx int\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tOnElicitationRequest: func(ec copilot.ElicitationContext) (copilot.ElicitationResult, error) {\n\t\t\t\tif ec.Message != \"Name?\" {\n\t\t\t\t\tt.Errorf(\"Expected Message='Name?', got %q\", ec.Message)\n\t\t\t\t}\n\t\t\t\tif idx >= len(responses) {\n\t\t\t\t\tt.Fatalf(\"Handler called more times than expected (%d)\", idx+1)\n\t\t\t\t}\n\t\t\t\tresp := responses[idx]\n\t\t\t\tidx++\n\t\t\t\treturn resp, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tschema := rpc.UIElicitationSchema{\n\t\t\tType: rpc.UIElicitationSchemaTypeObject,\n\t\t\tProperties: map[string]rpc.UIElicitationSchemaProperty{\n\t\t\t\t\"name\": {Type: rpc.UIElicitationSchemaPropertyTypeString},\n\t\t\t},\n\t\t\tRequired: []string{\"name\"},\n\t\t}\n\n\t\taccept, err := session.UI().Elicitation(t.Context(), \"Name?\", schema)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Elicitation accept call failed: %v\", err)\n\t\t}\n\t\tif accept.Action != \"accept\" {\n\t\t\tt.Errorf(\"Expected accept.Action='accept', got %q\", accept.Action)\n\t\t}\n\t\tif accept.Content == nil || fmt.Sprintf(\"%v\", accept.Content[\"name\"]) != \"Mona\" {\n\t\t\tt.Errorf(\"Expected accept.Content[name]='Mona', got %v\", accept.Content)\n\t\t}\n\n\t\tdecline, err := session.UI().Elicitation(t.Context(), \"Name?\", schema)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Elicitation decline call failed: %v\", err)\n\t\t}\n\t\tif decline.Action != \"decline\" {\n\t\t\tt.Errorf(\"Expected decline.Action='decline', got %q\", decline.Action)\n\t\t}\n\n\t\tcancel, err := session.UI().Elicitation(t.Context(), \"Name?\", schema)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Elicitation cancel call failed: %v\", err)\n\t\t}\n\t\tif cancel.Action != \"cancel\" {\n\t\t\tt.Errorf(\"Expected cancel.Action='cancel', got %q\", cancel.Action)\n\t\t}\n\t})\n\n\tt.Run(\"defaults capabilities when not provided\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\t\t// A session always exposes some capability struct (even when empty).\n\t\t_ = session.Capabilities()\n\t\t_ = session.Disconnect()\n\t})\n\n\tt.Run(\"sends requestElicitation when handler provided\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tOnElicitationRequest: func(ec copilot.ElicitationContext) (copilot.ElicitationResult, error) {\n\t\t\t\treturn copilot.ElicitationResult{Action: \"accept\", Content: map[string]any{}}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\t\tif session.SessionID == \"\" {\n\t\t\tt.Error(\"Expected non-empty SessionID when handler provided\")\n\t\t}\n\t\t_ = session.Disconnect()\n\t})\n}\n\n// schemaHasProperty reports whether the elicitation schema map has a top-level\n// property with the given name. RequestedSchema[\"properties\"] is typically a\n// map[string]rpc.UIElicitationSchemaProperty, but we accept any map[string]X.\nfunc schemaHasProperty(schema map[string]any, name string) bool {\n\tif schema == nil {\n\t\treturn false\n\t}\n\tprops, ok := schema[\"properties\"]\n\tif !ok || props == nil {\n\t\treturn false\n\t}\n\tswitch p := props.(type) {\n\tcase map[string]any:\n\t\t_, found := p[name]\n\t\treturn found\n\tcase map[string]rpc.UIElicitationSchemaProperty:\n\t\t_, found := p[name]\n\t\treturn found\n\tdefault:\n\t\t// Fallback: marshal/unmarshal via reflection-friendly route.\n\t\t// For test diagnostic purposes we treat unknown shapes as not found.\n\t\treturn false\n\t}\n}\n\nfunc TestUIElicitationMultiClientE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient1 := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\topts.UseStdio = copilot.Bool(false)\n\t})\n\tt.Cleanup(func() { client1.ForceStop() })\n\n\t// Start client1 with an init session to get the port\n\tinitSession, err := client1.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t})\n\tif err != nil {\n\t\tt.Fatalf(\"Failed to create init session: %v\", err)\n\t}\n\tinitSession.Disconnect()\n\n\tactualPort := client1.ActualPort()\n\tif actualPort == 0 {\n\t\tt.Fatalf(\"Expected non-zero port from TCP mode client\")\n\t}\n\n\tt.Run(\"capabilities.changed fires when second client joins with elicitation handler\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t// Client1 creates a session without elicitation handler\n\t\tsession1, err := client1.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Verify initial state: no elicitation capability\n\t\tcaps := session1.Capabilities()\n\t\tif caps.UI != nil && caps.UI.Elicitation {\n\t\t\tt.Error(\"Expected no elicitation capability before second client joins\")\n\t\t}\n\n\t\t// Listen for capabilities.changed with elicitation enabled\n\t\tcapEnabledCh := make(chan copilot.SessionEvent, 1)\n\t\tunsubscribe := session1.On(func(event copilot.SessionEvent) {\n\t\t\tif event.Type == copilot.SessionEventTypeCapabilitiesChanged {\n\t\t\t\tif d, ok := event.Data.(*copilot.CapabilitiesChangedData); ok && d.UI != nil && d.UI.Elicitation != nil && *d.UI.Elicitation {\n\t\t\t\t\tselect {\n\t\t\t\t\tcase capEnabledCh <- event:\n\t\t\t\t\tdefault:\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t})\n\n\t\t// Client2 joins with elicitation handler — should trigger capabilities.changed\n\t\tclient2 := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIUrl: fmt.Sprintf(\"localhost:%d\", actualPort),\n\t\t})\n\t\tsession2, err := client2.ResumeSession(t.Context(), session1.SessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tDisableResume: true,\n\t\t\tOnElicitationRequest: func(ctx copilot.ElicitationContext) (copilot.ElicitationResult, error) {\n\t\t\t\treturn copilot.ElicitationResult{Action: \"accept\", Content: map[string]any{}}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tclient2.ForceStop()\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\n\t\t// Wait for the elicitation-enabled capabilities.changed event\n\t\tselect {\n\t\tcase capEvent := <-capEnabledCh:\n\t\t\tcapData, capOk := capEvent.Data.(*copilot.CapabilitiesChangedData)\n\t\t\tif !capOk || capData.UI == nil || capData.UI.Elicitation == nil || !*capData.UI.Elicitation {\n\t\t\t\tt.Errorf(\"Expected capabilities.changed with ui.elicitation=true, got %+v\", capEvent.Data)\n\t\t\t}\n\t\tcase <-time.After(30 * time.Second):\n\t\t\tt.Fatal(\"Timed out waiting for capabilities.changed event (elicitation enabled)\")\n\t\t}\n\n\t\tunsubscribe()\n\t\tsession2.Disconnect()\n\t\tclient2.ForceStop()\n\t})\n\n\tt.Run(\"capabilities.changed fires when elicitation provider disconnects\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t// Client1 creates a session without elicitation handler\n\t\tsession1, err := client1.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Verify initial state: no elicitation capability\n\t\tcaps := session1.Capabilities()\n\t\tif caps.UI != nil && caps.UI.Elicitation {\n\t\t\tt.Error(\"Expected no elicitation capability before provider joins\")\n\t\t}\n\n\t\t// Listen for capability enabled\n\t\tcapEnabledCh := make(chan struct{}, 1)\n\t\tunsubEnabled := session1.On(func(event copilot.SessionEvent) {\n\t\t\tif event.Type == copilot.SessionEventTypeCapabilitiesChanged {\n\t\t\t\tif d, ok := event.Data.(*copilot.CapabilitiesChangedData); ok && d.UI != nil && d.UI.Elicitation != nil && *d.UI.Elicitation {\n\t\t\t\t\tselect {\n\t\t\t\t\tcase capEnabledCh <- struct{}{}:\n\t\t\t\t\tdefault:\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t})\n\n\t\t// Client3 (dedicated for this test) joins with elicitation handler\n\t\tclient3 := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIUrl: fmt.Sprintf(\"localhost:%d\", actualPort),\n\t\t})\n\t\t_, err = client3.ResumeSession(t.Context(), session1.SessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tDisableResume: true,\n\t\t\tOnElicitationRequest: func(ctx copilot.ElicitationContext) (copilot.ElicitationResult, error) {\n\t\t\t\treturn copilot.ElicitationResult{Action: \"accept\", Content: map[string]any{}}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tclient3.ForceStop()\n\t\t\tt.Fatalf(\"Failed to resume session for client3: %v\", err)\n\t\t}\n\n\t\t// Wait for elicitation to become enabled\n\t\tselect {\n\t\tcase <-capEnabledCh:\n\t\t\t// Good — elicitation is now enabled\n\t\tcase <-time.After(30 * time.Second):\n\t\t\tclient3.ForceStop()\n\t\t\tt.Fatal(\"Timed out waiting for capabilities.changed event (elicitation enabled)\")\n\t\t}\n\t\tunsubEnabled()\n\n\t\t// Now listen for elicitation to become disabled\n\t\tcapDisabledCh := make(chan struct{}, 1)\n\t\tunsubDisabled := session1.On(func(event copilot.SessionEvent) {\n\t\t\tif event.Type == copilot.SessionEventTypeCapabilitiesChanged {\n\t\t\t\tif d, ok := event.Data.(*copilot.CapabilitiesChangedData); ok && d.UI != nil && d.UI.Elicitation != nil && !*d.UI.Elicitation {\n\t\t\t\t\tselect {\n\t\t\t\t\tcase capDisabledCh <- struct{}{}:\n\t\t\t\t\tdefault:\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t})\n\n\t\t// Disconnect client3 — should trigger capabilities.changed with elicitation=false\n\t\tclient3.ForceStop()\n\n\t\tselect {\n\t\tcase <-capDisabledCh:\n\t\t\t// Good — got the disabled event\n\t\tcase <-time.After(30 * time.Second):\n\t\t\tt.Fatal(\"Timed out waiting for capabilities.changed event (elicitation disabled)\")\n\t\t}\n\t\tunsubDisabled()\n\t})\n}\n" }, { "path": "go/internal/e2e/compaction_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"strings\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\nfunc TestCompactionE2E(t *testing.T) {\n\tt.Skip(\"Compaction tests are skipped due to flakiness — re-enable once stabilized\")\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"should trigger compaction with low threshold and emit events\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tenabled := true\n\t\tbackgroundThreshold := 0.005 // 0.5%\n\t\tbufferThreshold := 0.01 // 1%\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tInfiniteSessions: &copilot.InfiniteSessionConfig{\n\t\t\t\tEnabled: &enabled,\n\t\t\t\tBackgroundCompactionThreshold: &backgroundThreshold,\n\t\t\t\tBufferExhaustionThreshold: &bufferThreshold,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tvar compactionStartEvents []copilot.SessionEvent\n\t\tvar compactionCompleteEvents []copilot.SessionEvent\n\n\t\tsession.On(func(event copilot.SessionEvent) {\n\t\t\tif event.Type == copilot.SessionEventTypeSessionCompactionStart {\n\t\t\t\tcompactionStartEvents = append(compactionStartEvents, event)\n\t\t\t}\n\t\t\tif event.Type == copilot.SessionEventTypeSessionCompactionComplete {\n\t\t\t\tcompactionCompleteEvents = append(compactionCompleteEvents, event)\n\t\t\t}\n\t\t})\n\n\t\t// Send multiple messages to fill up the context window\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Tell me a story about a dragon. Be detailed.\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send first message: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Continue the story with more details about the dragon's castle.\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send second message: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Now describe the dragon's treasure in great detail.\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send third message: %v\", err)\n\t\t}\n\n\t\t// Should have triggered compaction at least once\n\t\tif len(compactionStartEvents) < 1 {\n\t\t\tt.Errorf(\"Expected at least 1 compaction_start event, got %d\", len(compactionStartEvents))\n\t\t}\n\t\tif len(compactionCompleteEvents) < 1 {\n\t\t\tt.Errorf(\"Expected at least 1 compaction_complete event, got %d\", len(compactionCompleteEvents))\n\t\t}\n\n\t\t// Compaction should have succeeded\n\t\tif len(compactionCompleteEvents) > 0 {\n\t\t\tlastComplete := compactionCompleteEvents[len(compactionCompleteEvents)-1]\n\t\t\td, ok := lastComplete.Data.(*copilot.SessionCompactionCompleteData)\n\t\t\tif !ok || !d.Success {\n\t\t\t\tt.Errorf(\"Expected compaction to succeed\")\n\t\t\t}\n\t\t\tif ok && d.TokensRemoved != nil && *d.TokensRemoved <= 0 {\n\t\t\t\tt.Errorf(\"Expected tokensRemoved > 0, got %v\", *d.TokensRemoved)\n\t\t\t}\n\t\t}\n\n\t\t// Verify session still works after compaction\n\t\tanswer, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What was the story about?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send verification message: %v\", err)\n\t\t}\n\t\tif ad, ok := answer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(strings.ToLower(ad.Content), \"dragon\") {\n\t\t\tt.Errorf(\"Expected answer to contain 'dragon', got %v\", answer.Data)\n\t\t}\n\t})\n\n\tt.Run(\"should not emit compaction events when infinite sessions disabled\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tenabled := false\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tInfiniteSessions: &copilot.InfiniteSessionConfig{\n\t\t\t\tEnabled: &enabled,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tvar compactionEvents []copilot.SessionEvent\n\t\tsession.On(func(event copilot.SessionEvent) {\n\t\t\tif event.Type == copilot.SessionEventTypeSessionCompactionStart || event.Type == copilot.SessionEventTypeSessionCompactionComplete {\n\t\t\t\tcompactionEvents = append(compactionEvents, event)\n\t\t\t}\n\t\t})\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 2+2?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\t// Should not have any compaction events when disabled\n\t\tif len(compactionEvents) != 0 {\n\t\t\tt.Errorf(\"Expected 0 compaction events when disabled, got %d\", len(compactionEvents))\n\t\t}\n\t})\n}\n" }, { "path": "go/internal/e2e/error_resilience_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"context\"\n\t\"testing\"\n\t\"time\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\nfunc TestErrorResilienceE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"should throw when sending to disconnected session\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tif err := session.Disconnect(); err != nil {\n\t\t\tt.Fatalf(\"Disconnect failed: %v\", err)\n\t\t}\n\n\t\ttimeoutCtx, cancel := context.WithTimeout(t.Context(), 10*time.Second)\n\t\tdefer cancel()\n\t\tif _, err := session.SendAndWait(timeoutCtx, copilot.MessageOptions{Prompt: \"Hello\"}); err == nil {\n\t\t\tt.Fatal(\"Expected SendAndWait on disconnected session to fail\")\n\t\t}\n\t})\n\n\tt.Run(\"should throw when getting messages from disconnected session\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tif err := session.Disconnect(); err != nil {\n\t\t\tt.Fatalf(\"Disconnect failed: %v\", err)\n\t\t}\n\n\t\ttimeoutCtx, cancel := context.WithTimeout(t.Context(), 10*time.Second)\n\t\tdefer cancel()\n\t\tif _, err := session.GetMessages(timeoutCtx); err == nil {\n\t\t\tt.Fatal(\"Expected GetMessages on disconnected session to fail\")\n\t\t}\n\t})\n\n\tt.Run(\"should handle double abort without error\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tif err := session.Abort(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"First abort failed: %v\", err)\n\t\t}\n\t\tif err := session.Abort(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Second abort failed: %v\", err)\n\t\t}\n\t\tif err := session.Disconnect(); err != nil {\n\t\t\tt.Fatalf(\"Disconnect failed: %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should throw when resuming non-existent session\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\ttimeoutCtx, cancel := context.WithTimeout(t.Context(), 10*time.Second)\n\t\tdefer cancel()\n\t\tif _, err := client.ResumeSession(timeoutCtx, \"non-existent-session-id-12345\", &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t}); err == nil {\n\t\t\tt.Fatal(\"Expected ResumeSession for non-existent session to fail\")\n\t\t}\n\t})\n}\n" }, { "path": "go/internal/e2e/event_fidelity_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"sync\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\nfunc TestEventFidelityE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"should emit events in correct order for tool-using conversation\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tif err := os.WriteFile(filepath.Join(ctx.WorkDir, \"hello.txt\"), []byte(\"Hello World\"), 0644); err != nil {\n\t\t\tt.Fatalf(\"Failed to write hello.txt: %v\", err)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = session.Disconnect() })\n\n\t\tvar mu sync.Mutex\n\t\tvar events []copilot.SessionEvent\n\t\tsession.On(func(event copilot.SessionEvent) {\n\t\t\tmu.Lock()\n\t\t\tevents = append(events, event)\n\t\t\tmu.Unlock()\n\t\t})\n\n\t\tif _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Read the file 'hello.txt' and tell me its contents.\",\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tsnapshot := snapshotEventFidelityEvents(&mu, &events)\n\t\ttypes := make([]copilot.SessionEventType, 0, len(snapshot))\n\t\tfor _, event := range snapshot {\n\t\t\ttypes = append(types, event.Type)\n\t\t}\n\n\t\tif !containsEventFidelityType(types, copilot.SessionEventTypeUserMessage) {\n\t\t\tt.Fatalf(\"Expected user.message event, got %v\", types)\n\t\t}\n\t\tif !containsEventFidelityType(types, copilot.SessionEventTypeAssistantMessage) {\n\t\t\tt.Fatalf(\"Expected assistant.message event, got %v\", types)\n\t\t}\n\n\t\tuserIdx := firstEventFidelityTypeIndex(types, copilot.SessionEventTypeUserMessage)\n\t\tassistantIdx := lastEventFidelityTypeIndex(types, copilot.SessionEventTypeAssistantMessage)\n\t\tif userIdx < 0 || assistantIdx < 0 || userIdx >= assistantIdx {\n\t\t\tt.Fatalf(\"Expected user.message before last assistant.message; types=%v\", types)\n\t\t}\n\n\t\tidleIdx := lastEventFidelityTypeIndex(types, copilot.SessionEventTypeSessionIdle)\n\t\tif idleIdx != len(types)-1 {\n\t\t\tt.Fatalf(\"Expected session.idle to be last event; idleIdx=%d len=%d types=%v\", idleIdx, len(types), types)\n\t\t}\n\t})\n\n\tt.Run(\"should include valid fields on all events\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = session.Disconnect() })\n\n\t\tvar mu sync.Mutex\n\t\tvar events []copilot.SessionEvent\n\t\tsession.On(func(event copilot.SessionEvent) {\n\t\t\tmu.Lock()\n\t\t\tevents = append(events, event)\n\t\t\tmu.Unlock()\n\t\t})\n\n\t\tif _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"What is 5+5? Reply with just the number.\",\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tsnapshot := snapshotEventFidelityEvents(&mu, &events)\n\t\tfor _, event := range snapshot {\n\t\t\tif event.ID == \"\" {\n\t\t\t\tt.Fatalf(\"Expected event id to be populated for %q\", event.Type)\n\t\t\t}\n\t\t\tif event.Timestamp.IsZero() {\n\t\t\t\tt.Fatalf(\"Expected event timestamp to be populated for %q\", event.Type)\n\t\t\t}\n\t\t}\n\n\t\tuserEvent := firstUserMessageEventFidelityData(snapshot)\n\t\tif userEvent == nil || userEvent.Content == \"\" {\n\t\t\tt.Fatalf(\"Expected user.message content, got %#v\", userEvent)\n\t\t}\n\n\t\tassistantEvent := firstAssistantMessageEventFidelityData(snapshot)\n\t\tif assistantEvent == nil || assistantEvent.MessageID == \"\" || assistantEvent.Content == \"\" {\n\t\t\tt.Fatalf(\"Expected assistant.message messageId and content, got %#v\", assistantEvent)\n\t\t}\n\t})\n\n\tt.Run(\"should emit tool execution events with correct fields\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tif err := os.WriteFile(filepath.Join(ctx.WorkDir, \"data.txt\"), []byte(\"test data\"), 0644); err != nil {\n\t\t\tt.Fatalf(\"Failed to write data.txt: %v\", err)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = session.Disconnect() })\n\n\t\tvar mu sync.Mutex\n\t\tvar events []copilot.SessionEvent\n\t\tsession.On(func(event copilot.SessionEvent) {\n\t\t\tmu.Lock()\n\t\t\tevents = append(events, event)\n\t\t\tmu.Unlock()\n\t\t})\n\n\t\tif _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Read the file 'data.txt'.\",\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tsnapshot := snapshotEventFidelityEvents(&mu, &events)\n\t\tvar toolStarts []*copilot.ToolExecutionStartData\n\t\tvar toolCompletes []*copilot.ToolExecutionCompleteData\n\t\tfor _, event := range snapshot {\n\t\t\tswitch data := event.Data.(type) {\n\t\t\tcase *copilot.ToolExecutionStartData:\n\t\t\t\ttoolStarts = append(toolStarts, data)\n\t\t\tcase *copilot.ToolExecutionCompleteData:\n\t\t\t\ttoolCompletes = append(toolCompletes, data)\n\t\t\t}\n\t\t}\n\n\t\tif len(toolStarts) == 0 {\n\t\t\tt.Fatalf(\"Expected at least one tool.execution_start event; events=%v\", eventFidelityTypes(snapshot))\n\t\t}\n\t\tif len(toolCompletes) == 0 {\n\t\t\tt.Fatalf(\"Expected at least one tool.execution_complete event; events=%v\", eventFidelityTypes(snapshot))\n\t\t}\n\t\tif toolStarts[0].ToolCallID == \"\" || toolStarts[0].ToolName == \"\" {\n\t\t\tt.Fatalf(\"Expected tool.execution_start toolCallId and toolName, got %#v\", toolStarts[0])\n\t\t}\n\t\tif toolCompletes[0].ToolCallID == \"\" {\n\t\t\tt.Fatalf(\"Expected tool.execution_complete toolCallId, got %#v\", toolCompletes[0])\n\t\t}\n\t})\n\n\tt.Run(\"should emit assistant.message with messageId\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = session.Disconnect() })\n\n\t\tvar mu sync.Mutex\n\t\tvar events []copilot.SessionEvent\n\t\tsession.On(func(event copilot.SessionEvent) {\n\t\t\tmu.Lock()\n\t\t\tevents = append(events, event)\n\t\t\tmu.Unlock()\n\t\t})\n\n\t\tif _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Say 'pong'.\",\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tsnapshot := snapshotEventFidelityEvents(&mu, &events)\n\t\tassistantEvent := firstAssistantMessageEventFidelityData(snapshot)\n\t\tif assistantEvent == nil {\n\t\t\tt.Fatalf(\"Expected at least one assistant.message event; events=%v\", eventFidelityTypes(snapshot))\n\t\t}\n\t\tif assistantEvent.MessageID == \"\" {\n\t\t\tt.Fatalf(\"Expected assistant.message messageId, got %#v\", assistantEvent)\n\t\t}\n\t\tif !strings.Contains(assistantEvent.Content, \"pong\") {\n\t\t\tt.Fatalf(\"Expected assistant.message content to contain pong, got %q\", assistantEvent.Content)\n\t\t}\n\t})\n}\n\nfunc snapshotEventFidelityEvents(mu *sync.Mutex, events *[]copilot.SessionEvent) []copilot.SessionEvent {\n\tmu.Lock()\n\tdefer mu.Unlock()\n\n\tsnapshot := make([]copilot.SessionEvent, len(*events))\n\tcopy(snapshot, *events)\n\treturn snapshot\n}\n\nfunc eventFidelityTypes(events []copilot.SessionEvent) []copilot.SessionEventType {\n\ttypes := make([]copilot.SessionEventType, 0, len(events))\n\tfor _, event := range events {\n\t\ttypes = append(types, event.Type)\n\t}\n\treturn types\n}\n\nfunc containsEventFidelityType(types []copilot.SessionEventType, eventType copilot.SessionEventType) bool {\n\treturn firstEventFidelityTypeIndex(types, eventType) >= 0\n}\n\nfunc firstEventFidelityTypeIndex(types []copilot.SessionEventType, eventType copilot.SessionEventType) int {\n\tfor i, typ := range types {\n\t\tif typ == eventType {\n\t\t\treturn i\n\t\t}\n\t}\n\treturn -1\n}\n\nfunc lastEventFidelityTypeIndex(types []copilot.SessionEventType, eventType copilot.SessionEventType) int {\n\tfor i := len(types) - 1; i >= 0; i-- {\n\t\tif types[i] == eventType {\n\t\t\treturn i\n\t\t}\n\t}\n\treturn -1\n}\n\nfunc firstUserMessageEventFidelityData(events []copilot.SessionEvent) *copilot.UserMessageData {\n\tfor _, event := range events {\n\t\tif data, ok := event.Data.(*copilot.UserMessageData); ok {\n\t\t\treturn data\n\t\t}\n\t}\n\treturn nil\n}\n\nfunc firstAssistantMessageEventFidelityData(events []copilot.SessionEvent) *copilot.AssistantMessageData {\n\tfor _, event := range events {\n\t\tif data, ok := event.Data.(*copilot.AssistantMessageData); ok {\n\t\t\treturn data\n\t\t}\n\t}\n\treturn nil\n}\n" }, { "path": "go/internal/e2e/hooks_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\t\"sync\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\nfunc TestHooksE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"should invoke preToolUse hook when model runs a tool\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tvar preToolUseInputs []copilot.PreToolUseHookInput\n\t\tvar mu sync.Mutex\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tHooks: &copilot.SessionHooks{\n\t\t\t\tOnPreToolUse: func(input copilot.PreToolUseHookInput, invocation copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {\n\t\t\t\t\tmu.Lock()\n\t\t\t\t\tpreToolUseInputs = append(preToolUseInputs, input)\n\t\t\t\t\tmu.Unlock()\n\n\t\t\t\t\tif invocation.SessionID == \"\" {\n\t\t\t\t\t\tt.Error(\"Expected non-empty session ID in invocation\")\n\t\t\t\t\t}\n\n\t\t\t\t\treturn &copilot.PreToolUseHookOutput{PermissionDecision: \"allow\"}, nil\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Create a file for the model to read\n\t\ttestFile := filepath.Join(ctx.WorkDir, \"hello.txt\")\n\t\terr = os.WriteFile(testFile, []byte(\"Hello from the test!\"), 0644)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to write test file: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Read the contents of hello.txt and tell me what it says\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tdefer mu.Unlock()\n\n\t\tif len(preToolUseInputs) == 0 {\n\t\t\tt.Error(\"Expected at least one preToolUse hook call\")\n\t\t}\n\n\t\thasToolName := false\n\t\tfor _, input := range preToolUseInputs {\n\t\t\tif input.ToolName != \"\" {\n\t\t\t\thasToolName = true\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif !hasToolName {\n\t\t\tt.Error(\"Expected at least one input with a tool name\")\n\t\t}\n\t})\n\n\tt.Run(\"should invoke postToolUse hook after model runs a tool\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tvar postToolUseInputs []copilot.PostToolUseHookInput\n\t\tvar mu sync.Mutex\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tHooks: &copilot.SessionHooks{\n\t\t\t\tOnPostToolUse: func(input copilot.PostToolUseHookInput, invocation copilot.HookInvocation) (*copilot.PostToolUseHookOutput, error) {\n\t\t\t\t\tmu.Lock()\n\t\t\t\t\tpostToolUseInputs = append(postToolUseInputs, input)\n\t\t\t\t\tmu.Unlock()\n\n\t\t\t\t\tif invocation.SessionID == \"\" {\n\t\t\t\t\t\tt.Error(\"Expected non-empty session ID in invocation\")\n\t\t\t\t\t}\n\n\t\t\t\t\treturn nil, nil\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Create a file for the model to read\n\t\ttestFile := filepath.Join(ctx.WorkDir, \"world.txt\")\n\t\terr = os.WriteFile(testFile, []byte(\"World from the test!\"), 0644)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to write test file: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Read the contents of world.txt and tell me what it says\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tdefer mu.Unlock()\n\n\t\tif len(postToolUseInputs) == 0 {\n\t\t\tt.Error(\"Expected at least one postToolUse hook call\")\n\t\t}\n\n\t\thasToolName := false\n\t\thasResult := false\n\t\tfor _, input := range postToolUseInputs {\n\t\t\tif input.ToolName != \"\" {\n\t\t\t\thasToolName = true\n\t\t\t}\n\t\t\tif input.ToolResult != nil {\n\t\t\t\thasResult = true\n\t\t\t}\n\t\t}\n\t\tif !hasToolName {\n\t\t\tt.Error(\"Expected at least one input with a tool name\")\n\t\t}\n\t\tif !hasResult {\n\t\t\tt.Error(\"Expected at least one input with a tool result\")\n\t\t}\n\t})\n\n\tt.Run(\"should invoke both preToolUse and postToolUse hooks for a single tool call\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tvar preToolUseInputs []copilot.PreToolUseHookInput\n\t\tvar postToolUseInputs []copilot.PostToolUseHookInput\n\t\tvar mu sync.Mutex\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tHooks: &copilot.SessionHooks{\n\t\t\t\tOnPreToolUse: func(input copilot.PreToolUseHookInput, invocation copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {\n\t\t\t\t\tmu.Lock()\n\t\t\t\t\tpreToolUseInputs = append(preToolUseInputs, input)\n\t\t\t\t\tmu.Unlock()\n\t\t\t\t\treturn &copilot.PreToolUseHookOutput{PermissionDecision: \"allow\"}, nil\n\t\t\t\t},\n\t\t\t\tOnPostToolUse: func(input copilot.PostToolUseHookInput, invocation copilot.HookInvocation) (*copilot.PostToolUseHookOutput, error) {\n\t\t\t\t\tmu.Lock()\n\t\t\t\t\tpostToolUseInputs = append(postToolUseInputs, input)\n\t\t\t\t\tmu.Unlock()\n\t\t\t\t\treturn nil, nil\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\ttestFile := filepath.Join(ctx.WorkDir, \"both.txt\")\n\t\terr = os.WriteFile(testFile, []byte(\"Testing both hooks!\"), 0644)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to write test file: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Read the contents of both.txt\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tdefer mu.Unlock()\n\n\t\tif len(preToolUseInputs) == 0 {\n\t\t\tt.Error(\"Expected at least one preToolUse hook call\")\n\t\t}\n\t\tif len(postToolUseInputs) == 0 {\n\t\t\tt.Error(\"Expected at least one postToolUse hook call\")\n\t\t}\n\n\t\t// Check that the same tool appears in both\n\t\tpreToolNames := make(map[string]bool)\n\t\tfor _, input := range preToolUseInputs {\n\t\t\tif input.ToolName != \"\" {\n\t\t\t\tpreToolNames[input.ToolName] = true\n\t\t\t}\n\t\t}\n\n\t\tfoundCommon := false\n\t\tfor _, input := range postToolUseInputs {\n\t\t\tif preToolNames[input.ToolName] {\n\t\t\t\tfoundCommon = true\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif !foundCommon {\n\t\t\tt.Error(\"Expected the same tool to appear in both pre and post hooks\")\n\t\t}\n\t})\n\n\tt.Run(\"should deny tool execution when preToolUse returns deny\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tvar preToolUseInputs []copilot.PreToolUseHookInput\n\t\tvar mu sync.Mutex\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tHooks: &copilot.SessionHooks{\n\t\t\t\tOnPreToolUse: func(input copilot.PreToolUseHookInput, invocation copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {\n\t\t\t\t\tmu.Lock()\n\t\t\t\t\tpreToolUseInputs = append(preToolUseInputs, input)\n\t\t\t\t\tmu.Unlock()\n\t\t\t\t\t// Deny all tool calls\n\t\t\t\t\treturn &copilot.PreToolUseHookOutput{PermissionDecision: \"deny\"}, nil\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Create a file\n\t\toriginalContent := \"Original content that should not be modified\"\n\t\ttestFile := filepath.Join(ctx.WorkDir, \"protected.txt\")\n\t\terr = os.WriteFile(testFile, []byte(originalContent), 0644)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to write test file: %v\", err)\n\t\t}\n\n\t\tresponse, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Edit protected.txt and replace 'Original' with 'Modified'\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tdefer mu.Unlock()\n\n\t\tif len(preToolUseInputs) == 0 {\n\t\t\tt.Error(\"Expected at least one preToolUse hook call\")\n\t\t}\n\n\t\t// The response should be defined\n\t\tif response == nil {\n\t\t\tt.Error(\"Expected non-nil response\")\n\t\t}\n\n\t\t// Strengthen: verify the actual deny behavior — the protected file was NOT\n\t\t// modified by the runtime even though the LLM tried to edit it. The\n\t\t// pre-tool-use hook denial blocks tool execution before it can mutate state.\n\t\tactualContent, readErr := os.ReadFile(testFile)\n\t\tif readErr != nil {\n\t\t\tt.Fatalf(\"Failed to read protected.txt: %v\", readErr)\n\t\t}\n\t\tif string(actualContent) != originalContent {\n\t\t\tt.Errorf(\"protected.txt should be unchanged after deny; got: %q\", string(actualContent))\n\t\t}\n\t})\n}\n" }, { "path": "go/internal/e2e/hooks_extended_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"strings\"\n\t\"sync\"\n\t\"testing\"\n\t\"time\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\n// Mirrors dotnet/test/HookLifecycleAndOutputTests.cs (snapshot category \"hooks_extended\").\n//\n// Covers each handler exposed on copilot.SessionHooks: OnPreToolUse, OnPostToolUse,\n// OnUserPromptSubmitted, OnSessionStart, OnSessionEnd, OnErrorOccurred. Output-shape\n// behavior (modifiedPrompt / additionalContext / errorHandling / modifiedArgs /\n// modifiedResult / sessionSummary) is asserted alongside hook invocation. If a new\n// handler is added to SessionHooks, add a corresponding test here.\nfunc TestHooksExtendedE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"should invoke userPromptSubmitted hook and modify prompt\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tvar (\n\t\t\tmu sync.Mutex\n\t\t\tinputs []copilot.UserPromptSubmittedHookInput\n\t\t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tHooks: &copilot.SessionHooks{\n\t\t\t\tOnUserPromptSubmitted: func(input copilot.UserPromptSubmittedHookInput, invocation copilot.HookInvocation) (*copilot.UserPromptSubmittedHookOutput, error) {\n\t\t\t\t\tmu.Lock()\n\t\t\t\t\tinputs = append(inputs, input)\n\t\t\t\t\tmu.Unlock()\n\t\t\t\t\tif invocation.SessionID == \"\" {\n\t\t\t\t\t\tt.Error(\"Expected non-empty session ID in invocation\")\n\t\t\t\t\t}\n\t\t\t\t\treturn &copilot.UserPromptSubmittedHookOutput{\n\t\t\t\t\t\tModifiedPrompt: \"Reply with exactly: HOOKED_PROMPT\",\n\t\t\t\t\t}, nil\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tresponse, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Say something else\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tdefer mu.Unlock()\n\t\tif len(inputs) == 0 {\n\t\t\tt.Fatal(\"Expected at least one userPromptSubmitted hook invocation\")\n\t\t}\n\t\tif !strings.Contains(inputs[0].Prompt, \"Say something else\") {\n\t\t\tt.Errorf(\"Expected hook input prompt to contain original prompt, got %q\", inputs[0].Prompt)\n\t\t}\n\n\t\tassistantMessage, ok := response.Data.(*copilot.AssistantMessageData)\n\t\tif !ok || !strings.Contains(assistantMessage.Content, \"HOOKED_PROMPT\") {\n\t\t\tt.Errorf(\"Expected response to contain 'HOOKED_PROMPT', got %v\", response.Data)\n\t\t}\n\t})\n\n\tt.Run(\"should invoke sessionStart hook\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tvar (\n\t\t\tmu sync.Mutex\n\t\t\tinputs []copilot.SessionStartHookInput\n\t\t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tHooks: &copilot.SessionHooks{\n\t\t\t\tOnSessionStart: func(input copilot.SessionStartHookInput, invocation copilot.HookInvocation) (*copilot.SessionStartHookOutput, error) {\n\t\t\t\t\tmu.Lock()\n\t\t\t\t\tinputs = append(inputs, input)\n\t\t\t\t\tmu.Unlock()\n\t\t\t\t\tif invocation.SessionID == \"\" {\n\t\t\t\t\t\tt.Error(\"Expected non-empty session ID in invocation\")\n\t\t\t\t\t}\n\t\t\t\t\treturn &copilot.SessionStartHookOutput{\n\t\t\t\t\t\tAdditionalContext: \"Session start hook context.\",\n\t\t\t\t\t}, nil\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tif _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Say hi\"}); err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tdefer mu.Unlock()\n\t\tif len(inputs) == 0 {\n\t\t\tt.Fatal(\"Expected sessionStart hook to be invoked at least once\")\n\t\t}\n\t\tif inputs[0].Source != \"new\" {\n\t\t\tt.Errorf(\"Expected source 'new', got %q\", inputs[0].Source)\n\t\t}\n\t\tif inputs[0].Cwd == \"\" {\n\t\t\tt.Error(\"Expected non-empty cwd in sessionStart hook input\")\n\t\t}\n\t})\n\n\tt.Run(\"should invoke sessionEnd hook\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tvar (\n\t\t\tmu sync.Mutex\n\t\t\tinputs []copilot.SessionEndHookInput\n\t\t\tinvocations = make(chan copilot.SessionEndHookInput, 4)\n\t\t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tHooks: &copilot.SessionHooks{\n\t\t\t\tOnSessionEnd: func(input copilot.SessionEndHookInput, invocation copilot.HookInvocation) (*copilot.SessionEndHookOutput, error) {\n\t\t\t\t\tmu.Lock()\n\t\t\t\t\tinputs = append(inputs, input)\n\t\t\t\t\tmu.Unlock()\n\t\t\t\t\tif invocation.SessionID == \"\" {\n\t\t\t\t\t\tt.Error(\"Expected non-empty session ID in invocation\")\n\t\t\t\t\t}\n\t\t\t\t\tselect {\n\t\t\t\t\tcase invocations <- input:\n\t\t\t\t\tdefault:\n\t\t\t\t\t}\n\t\t\t\t\treturn &copilot.SessionEndHookOutput{\n\t\t\t\t\t\tSessionSummary: \"session ended\",\n\t\t\t\t\t}, nil\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tif _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Say bye\"}); err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\t\tif err := session.Disconnect(); err != nil {\n\t\t\tt.Fatalf(\"Failed to disconnect session: %v\", err)\n\t\t}\n\n\t\tselect {\n\t\tcase <-invocations:\n\t\tcase <-time.After(10 * time.Second):\n\t\t\tt.Fatal(\"Timed out waiting for sessionEnd hook invocation\")\n\t\t}\n\n\t\tmu.Lock()\n\t\tdefer mu.Unlock()\n\t\tif len(inputs) == 0 {\n\t\t\tt.Fatal(\"Expected sessionEnd hook to be invoked at least once\")\n\t\t}\n\t})\n\n\tt.Run(\"should register errorOccurred hook\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tvar (\n\t\t\tmu sync.Mutex\n\t\t\tinputs []copilot.ErrorOccurredHookInput\n\t\t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tHooks: &copilot.SessionHooks{\n\t\t\t\tOnErrorOccurred: func(input copilot.ErrorOccurredHookInput, invocation copilot.HookInvocation) (*copilot.ErrorOccurredHookOutput, error) {\n\t\t\t\t\tmu.Lock()\n\t\t\t\t\tinputs = append(inputs, input)\n\t\t\t\t\tmu.Unlock()\n\t\t\t\t\tif invocation.SessionID == \"\" {\n\t\t\t\t\t\tt.Error(\"Expected non-empty session ID in invocation\")\n\t\t\t\t\t}\n\t\t\t\t\treturn &copilot.ErrorOccurredHookOutput{ErrorHandling: \"skip\"}, nil\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tif _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Say hi\"}); err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\t// OnErrorOccurred is dispatched only by genuine runtime errors (e.g. provider\n\t\t// failures, internal exceptions). A normal turn cannot deterministically trigger\n\t\t// one, so this is a registration-only test: the SDK must accept the hook and not\n\t\t// invoke it inappropriately during a healthy turn.\n\t\tmu.Lock()\n\t\tgot := len(inputs)\n\t\tmu.Unlock()\n\t\tif got != 0 {\n\t\t\tt.Errorf(\"Expected errorOccurred hook to not fire on a healthy turn, got %d invocations\", got)\n\t\t}\n\t\tif session.SessionID == \"\" {\n\t\t\tt.Error(\"Expected session id to be set\")\n\t\t}\n\t})\n\n\tt.Run(\"should allow preToolUse to return modifiedArgs and suppressOutput\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\ttype EchoParams struct {\n\t\t\tValue string `json:\"value\" jsonschema:\"Value to echo\"`\n\t\t}\n\t\techoTool := copilot.DefineTool(\"echo_value\", \"Echoes the supplied value\",\n\t\t\tfunc(params EchoParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\treturn params.Value, nil\n\t\t\t})\n\n\t\tvar (\n\t\t\tmu sync.Mutex\n\t\t\tinputs []copilot.PreToolUseHookInput\n\t\t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tTools: []copilot.Tool{echoTool},\n\t\t\tHooks: &copilot.SessionHooks{\n\t\t\t\tOnPreToolUse: func(input copilot.PreToolUseHookInput, invocation copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {\n\t\t\t\t\tmu.Lock()\n\t\t\t\t\tinputs = append(inputs, input)\n\t\t\t\t\tmu.Unlock()\n\t\t\t\t\tif input.ToolName != \"echo_value\" {\n\t\t\t\t\t\treturn &copilot.PreToolUseHookOutput{PermissionDecision: \"allow\"}, nil\n\t\t\t\t\t}\n\t\t\t\t\treturn &copilot.PreToolUseHookOutput{\n\t\t\t\t\t\tPermissionDecision: \"allow\",\n\t\t\t\t\t\tModifiedArgs: map[string]any{\"value\": \"modified by hook\"},\n\t\t\t\t\t\tSuppressOutput: false,\n\t\t\t\t\t}, nil\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tresponse, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Call echo_value with value 'original', then reply with the result.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tdefer mu.Unlock()\n\t\tif len(inputs) == 0 {\n\t\t\tt.Fatal(\"Expected preToolUse hook to be invoked at least once\")\n\t\t}\n\t\thadEchoInput := false\n\t\tfor _, input := range inputs {\n\t\t\tif input.ToolName == \"echo_value\" {\n\t\t\t\thadEchoInput = true\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif !hadEchoInput {\n\t\t\tt.Errorf(\"Expected at least one preToolUse invocation for echo_value, got %+v\", inputs)\n\t\t}\n\n\t\tassistantMessage, ok := response.Data.(*copilot.AssistantMessageData)\n\t\tif !ok || !strings.Contains(assistantMessage.Content, \"modified by hook\") {\n\t\t\tt.Errorf(\"Expected response to contain 'modified by hook', got %v\", response.Data)\n\t\t}\n\t})\n\n\tt.Run(\"should allow postToolUse to return modifiedResult\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tvar (\n\t\t\tmu sync.Mutex\n\t\t\tinputs []copilot.PostToolUseHookInput\n\t\t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tAvailableTools: []string{\"report_intent\"},\n\t\t\tHooks: &copilot.SessionHooks{\n\t\t\t\tOnPostToolUse: func(input copilot.PostToolUseHookInput, invocation copilot.HookInvocation) (*copilot.PostToolUseHookOutput, error) {\n\t\t\t\t\tmu.Lock()\n\t\t\t\t\tinputs = append(inputs, input)\n\t\t\t\t\tmu.Unlock()\n\t\t\t\t\tif input.ToolName != \"report_intent\" {\n\t\t\t\t\t\treturn nil, nil\n\t\t\t\t\t}\n\t\t\t\t\treturn &copilot.PostToolUseHookOutput{\n\t\t\t\t\t\tModifiedResult: \"modified by post hook\",\n\t\t\t\t\t\tSuppressOutput: false,\n\t\t\t\t\t}, nil\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tresponse, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Call the report_intent tool with intent 'Testing post hook', then reply done.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tdefer mu.Unlock()\n\t\thadReportIntent := false\n\t\tfor _, input := range inputs {\n\t\t\tif input.ToolName == \"report_intent\" {\n\t\t\t\thadReportIntent = true\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif !hadReportIntent {\n\t\t\tt.Errorf(\"Expected at least one postToolUse invocation for report_intent, got %+v\", inputs)\n\t\t}\n\n\t\tassistantMessage, ok := response.Data.(*copilot.AssistantMessageData)\n\t\tif !ok || assistantMessage.Content != \"Done.\" {\n\t\t\tt.Errorf(\"Expected response content to be 'Done.', got %v\", response.Data)\n\t\t}\n\t})\n}\n" }, { "path": "go/internal/e2e/mcp_and_agents_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\nfunc TestMCPServersE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"accept MCP server config on create\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tmcpServers := map[string]copilot.MCPServerConfig{\n\t\t\t\"test-server\": copilot.MCPStdioServerConfig{\n\t\t\t\tCommand: \"echo\",\n\t\t\t\tArgs: []string{\"hello\"},\n\t\t\t\tTools: []string{\"*\"},\n\t\t\t},\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tMCPServers: mcpServers,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tif session.SessionID == \"\" {\n\t\t\tt.Error(\"Expected non-empty session ID\")\n\t\t}\n\n\t\t// Simple interaction to verify session works\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"What is 2+2?\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmessage, err := testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get final message: %v\", err)\n\t\t}\n\n\t\tif md, ok := message.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(md.Content, \"4\") {\n\t\t\tt.Errorf(\"Expected message to contain '4', got: %v\", message.Data)\n\t\t}\n\n\t\tsession.Disconnect()\n\t})\n\n\tt.Run(\"accept MCP server config on resume\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t// Create a session first\n\t\tsession1, err := client.CreateSession(t.Context(), &copilot.SessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tsessionID := session1.SessionID\n\n\t\t_, err = session1.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 1+1?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\t// Resume with MCP servers\n\t\tmcpServers := map[string]copilot.MCPServerConfig{\n\t\t\t\"test-server\": copilot.MCPStdioServerConfig{\n\t\t\t\tCommand: \"echo\",\n\t\t\t\tArgs: []string{\"hello\"},\n\t\t\t\tTools: []string{\"*\"},\n\t\t\t},\n\t\t}\n\n\t\tsession2, err := client.ResumeSessionWithOptions(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tMCPServers: mcpServers,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\n\t\tif session2.SessionID != sessionID {\n\t\t\tt.Errorf(\"Expected session ID %s, got %s\", sessionID, session2.SessionID)\n\t\t}\n\n\t\tmessage, err := session2.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 3+3?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tif md, ok := message.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(md.Content, \"6\") {\n\t\t\tt.Errorf(\"Expected message to contain '6', got: %v\", message.Data)\n\t\t}\n\n\t\tsession2.Disconnect()\n\t})\n\n\tt.Run(\"should pass literal env values to MCP server subprocess\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tmcpServerPath, err := filepath.Abs(\"../../../test/harness/test-mcp-server.mjs\")\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resolve test-mcp-server path: %v\", err)\n\t\t}\n\t\tmcpServerDir := filepath.Dir(mcpServerPath)\n\n\t\tmcpServers := map[string]copilot.MCPServerConfig{\n\t\t\t\"env-echo\": copilot.MCPStdioServerConfig{\n\t\t\t\tCommand: \"node\",\n\t\t\t\tArgs: []string{mcpServerPath},\n\t\t\t\tTools: []string{\"*\"},\n\t\t\t\tEnv: map[string]string{\"TEST_SECRET\": \"hunter2\"},\n\t\t\t\tCwd: mcpServerDir,\n\t\t\t},\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tMCPServers: mcpServers,\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tif session.SessionID == \"\" {\n\t\t\tt.Error(\"Expected non-empty session ID\")\n\t\t}\n\n\t\tmessage, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Use the env-echo/get_env tool to read the TEST_SECRET environment variable. Reply with just the value, nothing else.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tif md, ok := message.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(md.Content, \"hunter2\") {\n\t\t\tt.Errorf(\"Expected message to contain 'hunter2', got: %v\", message.Data)\n\t\t}\n\n\t\tsession.Disconnect()\n\t})\n\n\tt.Run(\"handle multiple MCP servers\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tmcpServers := map[string]copilot.MCPServerConfig{\n\t\t\t\"server1\": copilot.MCPStdioServerConfig{\n\t\t\t\tCommand: \"echo\",\n\t\t\t\tArgs: []string{\"server1\"},\n\t\t\t\tTools: []string{\"*\"},\n\t\t\t},\n\t\t\t\"server2\": copilot.MCPStdioServerConfig{\n\t\t\t\tCommand: \"echo\",\n\t\t\t\tArgs: []string{\"server2\"},\n\t\t\t\tTools: []string{\"*\"},\n\t\t\t},\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tMCPServers: mcpServers,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tif session.SessionID == \"\" {\n\t\t\tt.Error(\"Expected non-empty session ID\")\n\t\t}\n\n\t\tsession.Disconnect()\n\t})\n}\n\nfunc TestCustomAgentsE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"accept custom agent config on create\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tinfer := true\n\t\tcustomAgents := []copilot.CustomAgentConfig{\n\t\t\t{\n\t\t\t\tName: \"test-agent\",\n\t\t\t\tDisplayName: \"Test Agent\",\n\t\t\t\tDescription: \"A test agent for SDK testing\",\n\t\t\t\tPrompt: \"You are a helpful test agent.\",\n\t\t\t\tInfer: &infer,\n\t\t\t},\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tCustomAgents: customAgents,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tif session.SessionID == \"\" {\n\t\t\tt.Error(\"Expected non-empty session ID\")\n\t\t}\n\n\t\t// Simple interaction to verify session works\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"What is 5+5?\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmessage, err := testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get final message: %v\", err)\n\t\t}\n\n\t\tif md, ok := message.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(md.Content, \"10\") {\n\t\t\tt.Errorf(\"Expected message to contain '10', got: %v\", message.Data)\n\t\t}\n\n\t\tsession.Disconnect()\n\t})\n\n\tt.Run(\"accept custom agent config on resume\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t// Create a session first\n\t\tsession1, err := client.CreateSession(t.Context(), &copilot.SessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tsessionID := session1.SessionID\n\n\t\t_, err = session1.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 1+1?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\t// Resume with custom agents\n\t\tcustomAgents := []copilot.CustomAgentConfig{\n\t\t\t{\n\t\t\t\tName: \"resume-agent\",\n\t\t\t\tDisplayName: \"Resume Agent\",\n\t\t\t\tDescription: \"An agent added on resume\",\n\t\t\t\tPrompt: \"You are a resume test agent.\",\n\t\t\t},\n\t\t}\n\n\t\tsession2, err := client.ResumeSessionWithOptions(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tCustomAgents: customAgents,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\n\t\tif session2.SessionID != sessionID {\n\t\t\tt.Errorf(\"Expected session ID %s, got %s\", sessionID, session2.SessionID)\n\t\t}\n\n\t\tmessage, err := session2.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 6+6?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tif md, ok := message.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(md.Content, \"12\") {\n\t\t\tt.Errorf(\"Expected message to contain '12', got: %v\", message.Data)\n\t\t}\n\n\t\tsession2.Disconnect()\n\t})\n\n\tt.Run(\"handle custom agent with tools\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tinfer := true\n\t\tcustomAgents := []copilot.CustomAgentConfig{\n\t\t\t{\n\t\t\t\tName: \"tool-agent\",\n\t\t\t\tDisplayName: \"Tool Agent\",\n\t\t\t\tDescription: \"An agent with specific tools\",\n\t\t\t\tPrompt: \"You are an agent with specific tools.\",\n\t\t\t\tTools: []string{\"bash\", \"edit\"},\n\t\t\t\tInfer: &infer,\n\t\t\t},\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tCustomAgents: customAgents,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tif session.SessionID == \"\" {\n\t\t\tt.Error(\"Expected non-empty session ID\")\n\t\t}\n\n\t\tsession.Disconnect()\n\t})\n\n\tt.Run(\"handle custom agent with MCP servers\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tcustomAgents := []copilot.CustomAgentConfig{\n\t\t\t{\n\t\t\t\tName: \"mcp-agent\",\n\t\t\t\tDisplayName: \"MCP Agent\",\n\t\t\t\tDescription: \"An agent with its own MCP servers\",\n\t\t\t\tPrompt: \"You are an agent with MCP servers.\",\n\t\t\t\tMCPServers: map[string]copilot.MCPServerConfig{\n\t\t\t\t\t\"agent-server\": copilot.MCPStdioServerConfig{\n\t\t\t\t\t\tCommand: \"echo\",\n\t\t\t\t\t\tArgs: []string{\"agent-mcp\"},\n\t\t\t\t\t\tTools: []string{\"*\"},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tCustomAgents: customAgents,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tif session.SessionID == \"\" {\n\t\t\tt.Error(\"Expected non-empty session ID\")\n\t\t}\n\n\t\tsession.Disconnect()\n\t})\n\n\tt.Run(\"handle multiple custom agents\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tinferTrue := true\n\t\tinferFalse := false\n\t\tcustomAgents := []copilot.CustomAgentConfig{\n\t\t\t{\n\t\t\t\tName: \"agent1\",\n\t\t\t\tDisplayName: \"Agent One\",\n\t\t\t\tDescription: \"First agent\",\n\t\t\t\tPrompt: \"You are agent one.\",\n\t\t\t\tInfer: &inferTrue,\n\t\t\t},\n\t\t\t{\n\t\t\t\tName: \"agent2\",\n\t\t\t\tDisplayName: \"Agent Two\",\n\t\t\t\tDescription: \"Second agent\",\n\t\t\t\tPrompt: \"You are agent two.\",\n\t\t\t\tInfer: &inferFalse,\n\t\t\t},\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tCustomAgents: customAgents,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tif session.SessionID == \"\" {\n\t\t\tt.Error(\"Expected non-empty session ID\")\n\t\t}\n\n\t\tsession.Disconnect()\n\t})\n}\n\nfunc TestCombinedConfigurationE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"accept MCP servers and custom agents\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tmcpServers := map[string]copilot.MCPServerConfig{\n\t\t\t\"shared-server\": copilot.MCPStdioServerConfig{\n\t\t\t\tCommand: \"echo\",\n\t\t\t\tArgs: []string{\"shared\"},\n\t\t\t\tTools: []string{\"*\"},\n\t\t\t},\n\t\t}\n\n\t\tcustomAgents := []copilot.CustomAgentConfig{\n\t\t\t{\n\t\t\t\tName: \"combined-agent\",\n\t\t\t\tDisplayName: \"Combined Agent\",\n\t\t\t\tDescription: \"An agent using shared MCP servers\",\n\t\t\t\tPrompt: \"You are a combined test agent.\",\n\t\t\t},\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tMCPServers: mcpServers,\n\t\t\tCustomAgents: customAgents,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tif session.SessionID == \"\" {\n\t\t\tt.Error(\"Expected non-empty session ID\")\n\t\t}\n\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"What is 7+7?\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmessage, err := testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get final message: %v\", err)\n\t\t}\n\n\t\tif md, ok := message.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(md.Content, \"14\") {\n\t\t\tt.Errorf(\"Expected message to contain '14', got: %v\", message.Data)\n\t\t}\n\n\t\tsession.Disconnect()\n\t})\n}\n" }, { "path": "go/internal/e2e/multi_client_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"sync\"\n\t\"testing\"\n\t\"time\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\nfunc TestMultiClientE2E(t *testing.T) {\n\t// Use TCP mode so a second client can connect to the same CLI process\n\tctx := testharness.NewTestContext(t)\n\tclient1 := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\topts.UseStdio = copilot.Bool(false)\n\t})\n\tt.Cleanup(func() { client1.ForceStop() })\n\n\t// Trigger connection so we can read the port\n\tinitSession, err := client1.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t})\n\tif err != nil {\n\t\tt.Fatalf(\"Failed to create init session: %v\", err)\n\t}\n\tinitSession.Disconnect()\n\n\tactualPort := client1.ActualPort()\n\tif actualPort == 0 {\n\t\tt.Fatalf(\"Expected non-zero port from TCP mode client\")\n\t}\n\n\tclient2 := copilot.NewClient(&copilot.ClientOptions{\n\t\tCLIUrl: fmt.Sprintf(\"localhost:%d\", actualPort),\n\t})\n\tt.Cleanup(func() { client2.ForceStop() })\n\n\tt.Run(\"both clients see tool request and completion events\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\ttype SeedParams struct {\n\t\t\tSeed string `json:\"seed\" jsonschema:\"A seed value\"`\n\t\t}\n\n\t\ttool := copilot.DefineTool(\"magic_number\", \"Returns a magic number\",\n\t\t\tfunc(params SeedParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\treturn fmt.Sprintf(\"MAGIC_%s_42\", params.Seed), nil\n\t\t\t})\n\n\t\t// Client 1 creates a session with a custom tool\n\t\tsession1, err := client1.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tTools: []copilot.Tool{tool},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Client 2 resumes with NO tools — should not overwrite client 1's tools\n\t\tsession2, err := client2.ResumeSession(t.Context(), session1.SessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\n\t\t// Set up event waiters BEFORE sending the prompt to avoid race conditions\n\t\tclient1Requested := make(chan struct{}, 1)\n\t\tclient2Requested := make(chan struct{}, 1)\n\t\tclient1Completed := make(chan struct{}, 1)\n\t\tclient2Completed := make(chan struct{}, 1)\n\n\t\tsession1.On(func(event copilot.SessionEvent) {\n\t\t\tif event.Type == copilot.SessionEventTypeExternalToolRequested {\n\t\t\t\tselect {\n\t\t\t\tcase client1Requested <- struct{}{}:\n\t\t\t\tdefault:\n\t\t\t\t}\n\t\t\t}\n\t\t\tif event.Type == copilot.SessionEventTypeExternalToolCompleted {\n\t\t\t\tselect {\n\t\t\t\tcase client1Completed <- struct{}{}:\n\t\t\t\tdefault:\n\t\t\t\t}\n\t\t\t}\n\t\t})\n\t\tsession2.On(func(event copilot.SessionEvent) {\n\t\t\tif event.Type == copilot.SessionEventTypeExternalToolRequested {\n\t\t\t\tselect {\n\t\t\t\tcase client2Requested <- struct{}{}:\n\t\t\t\tdefault:\n\t\t\t\t}\n\t\t\t}\n\t\t\tif event.Type == copilot.SessionEventTypeExternalToolCompleted {\n\t\t\t\tselect {\n\t\t\t\tcase client2Completed <- struct{}{}:\n\t\t\t\tdefault:\n\t\t\t\t}\n\t\t\t}\n\t\t})\n\n\t\t// Send a prompt that triggers the custom tool\n\t\tresponse, err := session1.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Use the magic_number tool with seed 'hello' and tell me the result\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tif response == nil {\n\t\t\tt.Errorf(\"Expected response to contain 'MAGIC_hello_42', got nil\")\n\t\t} else if rd, ok := response.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(rd.Content, \"MAGIC_hello_42\") {\n\t\t\tt.Errorf(\"Expected response to contain 'MAGIC_hello_42', got %v\", response)\n\t\t}\n\n\t\t// Wait for all broadcast events to arrive on both clients\n\t\ttimeout := time.After(30 * time.Second)\n\t\tfor _, ch := range []chan struct{}{client1Requested, client2Requested, client1Completed, client2Completed} {\n\t\t\tselect {\n\t\t\tcase <-ch:\n\t\t\tcase <-timeout:\n\t\t\t\tt.Fatal(\"Timed out waiting for broadcast events on both clients\")\n\t\t\t}\n\t\t}\n\n\t\tsession2.Disconnect()\n\t})\n\n\tt.Run(\"one client approves permission and both see the result\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tvar client1PermissionRequests []copilot.PermissionRequest\n\t\tvar mu sync.Mutex\n\n\t\t// Client 1 creates a session and manually approves permission requests\n\t\tsession1, err := client1.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: func(request copilot.PermissionRequest, invocation copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\t\tmu.Lock()\n\t\t\t\tclient1PermissionRequests = append(client1PermissionRequests, request)\n\t\t\t\tmu.Unlock()\n\t\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Client 2 resumes — its handler never resolves, so only client 1's approval takes effect\n\t\tsession2, err := client2.ResumeSession(t.Context(), session1.SessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: func(request copilot.PermissionRequest, invocation copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\t\t// Block forever so only client 1's handler responds\n\t\t\t\tselect {}\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\n\t\t// Track events\n\t\tvar client1Events, client2Events []copilot.SessionEvent\n\t\tvar mu1, mu2 sync.Mutex\n\t\tsession1.On(func(event copilot.SessionEvent) {\n\t\t\tmu1.Lock()\n\t\t\tclient1Events = append(client1Events, event)\n\t\t\tmu1.Unlock()\n\t\t})\n\t\tsession2.On(func(event copilot.SessionEvent) {\n\t\t\tmu2.Lock()\n\t\t\tclient2Events = append(client2Events, event)\n\t\t\tmu2.Unlock()\n\t\t})\n\n\t\t// Send a prompt that triggers a write operation (requires permission)\n\t\tresponse, err := session1.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Create a file called hello.txt containing the text 'hello world'\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\t\tif response == nil {\n\t\t\tt.Errorf(\"Expected non-empty response\")\n\t\t} else if rd, ok := response.Data.(*copilot.AssistantMessageData); !ok || rd.Content == \"\" {\n\t\t\tt.Errorf(\"Expected non-empty response\")\n\t\t}\n\n\t\t// Client 1 should have handled the permission request\n\t\tmu.Lock()\n\t\tpermCount := len(client1PermissionRequests)\n\t\tmu.Unlock()\n\t\tif permCount == 0 {\n\t\t\tt.Errorf(\"Expected client 1 to handle at least one permission request\")\n\t\t}\n\n\t\t// Both clients should have seen permission.requested events\n\t\tmu1.Lock()\n\t\tc1PermRequested := filterEventsByType(client1Events, copilot.SessionEventTypePermissionRequested)\n\t\tmu1.Unlock()\n\t\tc2PermRequested := waitForEventsByType(t, &mu2, &client2Events, copilot.SessionEventTypePermissionRequested, 5*time.Second)\n\n\t\tif len(c1PermRequested) == 0 {\n\t\t\tt.Errorf(\"Expected client 1 to see permission.requested events\")\n\t\t}\n\t\tif len(c2PermRequested) == 0 {\n\t\t\tt.Errorf(\"Expected client 2 to see permission.requested events\")\n\t\t}\n\n\t\t// Both clients should have seen permission.completed events with approved result\n\t\tmu1.Lock()\n\t\tc1PermCompleted := filterEventsByType(client1Events, copilot.SessionEventTypePermissionCompleted)\n\t\tmu1.Unlock()\n\t\tc2PermCompleted := waitForEventsByType(t, &mu2, &client2Events, copilot.SessionEventTypePermissionCompleted, 5*time.Second)\n\n\t\tif len(c1PermCompleted) == 0 {\n\t\t\tt.Errorf(\"Expected client 1 to see permission.completed events\")\n\t\t}\n\t\tif len(c2PermCompleted) == 0 {\n\t\t\tt.Errorf(\"Expected client 2 to see permission.completed events\")\n\t\t}\n\t\tfor _, event := range append(c1PermCompleted, c2PermCompleted...) {\n\t\t\td, ok := event.Data.(*copilot.PermissionCompletedData)\n\t\t\tif !ok || string(d.Result.Kind) != \"approved\" {\n\t\t\t\tt.Errorf(\"Expected permission.completed result kind 'approved', got %v\", event.Data)\n\t\t\t}\n\t\t}\n\n\t\tsession2.Disconnect()\n\t})\n\n\tt.Run(\"one client rejects permission and both see the result\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t// Client 1 creates a session and denies all permission requests\n\t\tsession1, err := client1.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: func(request copilot.PermissionRequest, invocation copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindRejected}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Client 2 resumes — its handler never resolves so only client 1's denial takes effect\n\t\tsession2, err := client2.ResumeSession(t.Context(), session1.SessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: func(request copilot.PermissionRequest, invocation copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\t\tselect {}\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\n\t\tvar client1Events, client2Events []copilot.SessionEvent\n\t\tvar mu1, mu2 sync.Mutex\n\t\tsession1.On(func(event copilot.SessionEvent) {\n\t\t\tmu1.Lock()\n\t\t\tclient1Events = append(client1Events, event)\n\t\t\tmu1.Unlock()\n\t\t})\n\t\tsession2.On(func(event copilot.SessionEvent) {\n\t\t\tmu2.Lock()\n\t\t\tclient2Events = append(client2Events, event)\n\t\t\tmu2.Unlock()\n\t\t})\n\n\t\t// Write a test file and ask the agent to edit it\n\t\ttestFile := filepath.Join(ctx.WorkDir, \"protected.txt\")\n\t\tif err := os.WriteFile(testFile, []byte(\"protected content\"), 0644); err != nil {\n\t\t\tt.Fatalf(\"Failed to write test file: %v\", err)\n\t\t}\n\n\t\t_, err = session1.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Edit protected.txt and replace 'protected' with 'hacked'.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\t// Verify the file was NOT modified (permission was denied)\n\t\tcontent, err := os.ReadFile(testFile)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to read test file: %v\", err)\n\t\t}\n\t\tif string(content) != \"protected content\" {\n\t\t\tt.Errorf(\"Expected file content 'protected content', got '%s'\", string(content))\n\t\t}\n\n\t\t// Both clients should have seen permission.requested events\n\t\tmu1.Lock()\n\t\tc1PermRequested := filterEventsByType(client1Events, copilot.SessionEventTypePermissionRequested)\n\t\tmu1.Unlock()\n\t\tc2PermRequested := waitForEventsByType(t, &mu2, &client2Events, copilot.SessionEventTypePermissionRequested, 5*time.Second)\n\n\t\tif len(c1PermRequested) == 0 {\n\t\t\tt.Errorf(\"Expected client 1 to see permission.requested events\")\n\t\t}\n\t\tif len(c2PermRequested) == 0 {\n\t\t\tt.Errorf(\"Expected client 2 to see permission.requested events\")\n\t\t}\n\n\t\t// Both clients should see the denial in the completed event\n\t\tmu1.Lock()\n\t\tc1PermCompleted := filterEventsByType(client1Events, copilot.SessionEventTypePermissionCompleted)\n\t\tmu1.Unlock()\n\t\tc2PermCompleted := waitForEventsByType(t, &mu2, &client2Events, copilot.SessionEventTypePermissionCompleted, 5*time.Second)\n\n\t\tif len(c1PermCompleted) == 0 {\n\t\t\tt.Errorf(\"Expected client 1 to see permission.completed events\")\n\t\t}\n\t\tif len(c2PermCompleted) == 0 {\n\t\t\tt.Errorf(\"Expected client 2 to see permission.completed events\")\n\t\t}\n\t\tfor _, event := range append(c1PermCompleted, c2PermCompleted...) {\n\t\t\td, ok := event.Data.(*copilot.PermissionCompletedData)\n\t\t\tif !ok || string(d.Result.Kind) != \"denied-interactively-by-user\" {\n\t\t\t\tt.Errorf(\"Expected permission.completed result kind 'denied-interactively-by-user', got %v\", event.Data)\n\t\t\t}\n\t\t}\n\n\t\tsession2.Disconnect()\n\t})\n\n\tt.Run(\"two clients register different tools and agent uses both\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\ttype CountryCodeParams struct {\n\t\t\tCountryCode string `json:\"countryCode\" jsonschema:\"A two-letter country code\"`\n\t\t}\n\n\t\ttoolA := copilot.DefineTool(\"city_lookup\", \"Returns a city name for a given country code\",\n\t\t\tfunc(params CountryCodeParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\treturn fmt.Sprintf(\"CITY_FOR_%s\", params.CountryCode), nil\n\t\t\t})\n\n\t\ttoolB := copilot.DefineTool(\"currency_lookup\", \"Returns a currency for a given country code\",\n\t\t\tfunc(params CountryCodeParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\treturn fmt.Sprintf(\"CURRENCY_FOR_%s\", params.CountryCode), nil\n\t\t\t})\n\n\t\t// Client 1 creates a session with tool A\n\t\tsession1, err := client1.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tTools: []copilot.Tool{toolA},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Client 2 resumes with tool B (different tool, union should have both)\n\t\tsession2, err := client2.ResumeSession(t.Context(), session1.SessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tTools: []copilot.Tool{toolB},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\n\t\t// Send prompts sequentially to avoid nondeterministic tool_call ordering\n\t\tresponse1, err := session1.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Use the city_lookup tool with countryCode 'US' and tell me the result.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\t\tif response1 == nil {\n\t\t\tt.Fatalf(\"Expected response with content\")\n\t\t}\n\t\trd1, ok := response1.Data.(*copilot.AssistantMessageData)\n\t\tif !ok {\n\t\t\tt.Fatalf(\"Expected AssistantMessageData\")\n\t\t}\n\t\tif !strings.Contains(rd1.Content, \"CITY_FOR_US\") {\n\t\t\tt.Errorf(\"Expected response to contain 'CITY_FOR_US', got '%s'\", rd1.Content)\n\t\t}\n\n\t\tresponse2, err := session1.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Now use the currency_lookup tool with countryCode 'US' and tell me the result.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\t\tif response2 == nil {\n\t\t\tt.Fatalf(\"Expected response with content\")\n\t\t}\n\t\trd2, ok := response2.Data.(*copilot.AssistantMessageData)\n\t\tif !ok {\n\t\t\tt.Fatalf(\"Expected AssistantMessageData\")\n\t\t}\n\t\tif !strings.Contains(rd2.Content, \"CURRENCY_FOR_US\") {\n\t\t\tt.Errorf(\"Expected response to contain 'CURRENCY_FOR_US', got '%s'\", rd2.Content)\n\t\t}\n\n\t\tsession2.Disconnect()\n\t})\n\n\tt.Run(\"disconnecting client removes its tools\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\ttype InputParams struct {\n\t\t\tInput string `json:\"input\" jsonschema:\"Input string\"`\n\t\t}\n\n\t\ttoolA := copilot.DefineTool(\"stable_tool\", \"A tool that persists across disconnects\",\n\t\t\tfunc(params InputParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\treturn fmt.Sprintf(\"STABLE_%s\", params.Input), nil\n\t\t\t})\n\n\t\ttoolB := copilot.DefineTool(\"ephemeral_tool\", \"A tool that will disappear when its client disconnects\",\n\t\t\tfunc(params InputParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\treturn fmt.Sprintf(\"EPHEMERAL_%s\", params.Input), nil\n\t\t\t})\n\n\t\t// Client 1 creates a session with stable_tool\n\t\tsession1, err := client1.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tTools: []copilot.Tool{toolA},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Client 2 resumes with ephemeral_tool\n\t\t_, err = client2.ResumeSession(t.Context(), session1.SessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tTools: []copilot.Tool{toolB},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\n\t\t// Verify both tools work before disconnect (sequential to avoid nondeterministic tool_call ordering)\n\t\tstableResponse, err := session1.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Use the stable_tool with input 'test1' and tell me the result.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\t\tif stableResponse == nil {\n\t\t\tt.Fatalf(\"Expected response with content\")\n\t\t}\n\t\tsrd, ok := stableResponse.Data.(*copilot.AssistantMessageData)\n\t\tif !ok {\n\t\t\tt.Fatalf(\"Expected AssistantMessageData\")\n\t\t}\n\t\tif !strings.Contains(srd.Content, \"STABLE_test1\") {\n\t\t\tt.Errorf(\"Expected response to contain 'STABLE_test1', got '%s'\", srd.Content)\n\t\t}\n\n\t\tephemeralResponse, err := session1.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Use the ephemeral_tool with input 'test2' and tell me the result.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\t\tif ephemeralResponse == nil {\n\t\t\tt.Fatalf(\"Expected response with content\")\n\t\t}\n\t\terd, ok := ephemeralResponse.Data.(*copilot.AssistantMessageData)\n\t\tif !ok {\n\t\t\tt.Fatalf(\"Expected AssistantMessageData\")\n\t\t}\n\t\tif !strings.Contains(erd.Content, \"EPHEMERAL_test2\") {\n\t\t\tt.Errorf(\"Expected response to contain 'EPHEMERAL_test2', got '%s'\", erd.Content)\n\t\t}\n\n\t\t// Disconnect client 2 without destroying the shared session\n\t\tclient2.ForceStop()\n\n\t\t// Give the server time to process the connection close and remove tools\n\t\ttime.Sleep(500 * time.Millisecond)\n\n\t\t// Recreate client2 for cleanup (but don't rejoin the session)\n\t\tclient2 = copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIUrl: fmt.Sprintf(\"localhost:%d\", actualPort),\n\t\t})\n\n\t\t// Now only stable_tool should be available\n\t\tafterResponse, err := session1.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Use the stable_tool with input 'still_here'. Also try using ephemeral_tool if it is available.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\t\tif afterResponse == nil {\n\t\t\tt.Fatalf(\"Expected response with content\")\n\t\t}\n\t\tard, ok := afterResponse.Data.(*copilot.AssistantMessageData)\n\t\tif !ok {\n\t\t\tt.Fatalf(\"Expected AssistantMessageData\")\n\t\t}\n\t\tif !strings.Contains(ard.Content, \"STABLE_still_here\") {\n\t\t\tt.Errorf(\"Expected response to contain 'STABLE_still_here', got '%s'\", ard.Content)\n\t\t}\n\t\t// ephemeral_tool should NOT have produced a result\n\t\tif strings.Contains(ard.Content, \"EPHEMERAL_\") {\n\t\t\tt.Errorf(\"Expected response NOT to contain 'EPHEMERAL_', got '%s'\", ard.Content)\n\t\t}\n\t})\n}\n\nfunc filterEventsByType(events []copilot.SessionEvent, eventType copilot.SessionEventType) []copilot.SessionEvent {\n\tvar filtered []copilot.SessionEvent\n\tfor _, e := range events {\n\t\tif e.Type == eventType {\n\t\t\tfiltered = append(filtered, e)\n\t\t}\n\t}\n\treturn filtered\n}\n\n// waitForEventsByType polls the event slice until at least one event of the given type appears\n// or the timeout is reached. This avoids flaky assertions on async event delivery.\nfunc waitForEventsByType(t *testing.T, mu *sync.Mutex, events *[]copilot.SessionEvent, eventType copilot.SessionEventType, timeout time.Duration) []copilot.SessionEvent {\n\tt.Helper()\n\tdeadline := time.Now().Add(timeout)\n\tfor time.Now().Before(deadline) {\n\t\tmu.Lock()\n\t\tfiltered := filterEventsByType(*events, eventType)\n\t\tmu.Unlock()\n\t\tif len(filtered) > 0 {\n\t\t\treturn filtered\n\t\t}\n\t\ttime.Sleep(50 * time.Millisecond)\n\t}\n\treturn nil\n}\n" }, { "path": "go/internal/e2e/multi_turn_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\nfunc TestMultiTurnE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"should use tool results from previous turns\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tif err := os.WriteFile(filepath.Join(ctx.WorkDir, \"secret.txt\"), []byte(\"The magic number is 42.\"), 0644); err != nil {\n\t\t\tt.Fatalf(\"Failed to write secret.txt: %v\", err)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = session.Disconnect() })\n\n\t\tmsg1, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Read the file 'secret.txt' and tell me what the magic number is.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"First SendAndWait failed: %v\", err)\n\t\t}\n\t\tif content := assistantContent(t, msg1); !strings.Contains(content, \"42\") {\n\t\t\tt.Fatalf(\"Expected first response to contain 42, got %q\", content)\n\t\t}\n\n\t\tmsg2, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"What is that magic number multiplied by 2?\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Second SendAndWait failed: %v\", err)\n\t\t}\n\t\tif content := assistantContent(t, msg2); !strings.Contains(content, \"84\") {\n\t\t\tt.Fatalf(\"Expected second response to contain 84, got %q\", content)\n\t\t}\n\t})\n\n\tt.Run(\"should handle file creation then reading across turns\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = session.Disconnect() })\n\n\t\tif _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Create a file called 'greeting.txt' with the content 'Hello from multi-turn test'.\",\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"First SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tmsg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Read the file 'greeting.txt' and tell me its exact contents.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Second SendAndWait failed: %v\", err)\n\t\t}\n\t\tif content := assistantContent(t, msg); !strings.Contains(content, \"Hello from multi-turn test\") {\n\t\t\tt.Fatalf(\"Expected response to contain created file contents, got %q\", content)\n\t\t}\n\t})\n}\n" }, { "path": "go/internal/e2e/pending_work_resume_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"strings\"\n\t\"sync\"\n\t\"testing\"\n\t\"time\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n\t\"github.com/github/copilot-sdk/go/rpc\"\n)\n\nconst pendingWorkTimeout = 60 * time.Second\n\n// Mirrors dotnet/test/PendingWorkResumeTests.cs (snapshot category \"pending_work_resume\").\n//\n// Each subtest spawns a TCP server client, connects a \"suspended\" client through CLIUrl,\n// triggers some pending work (permission request or external tool call), then ForceStops\n// the suspended client (preserving session state) and resumes from a fresh client with\n// ContinuePendingWork=true.\nfunc TestPendingWorkResumeE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\n\tt.Run(\"should continue pending permission request after resume\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t_, cliURL := startTcpServer(t, ctx)\n\n\t\ttype ValueParams struct {\n\t\t\tValue string `json:\"value\" jsonschema:\"Value to transform\"`\n\t\t}\n\t\t// Original tool: should NOT actually run because we ForceStop before approving.\n\t\toriginalTool := copilot.DefineTool(\"resume_permission_tool\", \"Transforms a value after permission is granted\",\n\t\t\tfunc(params ValueParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\treturn \"ORIGINAL_SHOULD_NOT_RUN_\" + params.Value, nil\n\t\t\t})\n\n\t\tpermissionRequested := make(chan copilot.PermissionRequest, 1)\n\t\treleasePermission := make(chan copilot.PermissionRequestResult, 1)\n\n\t\tsuspendedClient := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\t\topts.CLIUrl = cliURL\n\t\t\topts.CLIPath = \"\"\n\t\t})\n\t\tsession1, err := suspendedClient.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tTools: []copilot.Tool{originalTool},\n\t\t\tOnPermissionRequest: func(req copilot.PermissionRequest, _ copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\t\tselect {\n\t\t\t\tcase permissionRequested <- req:\n\t\t\t\tdefault:\n\t\t\t\t}\n\t\t\t\treturn <-releasePermission, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tsessionID := session1.SessionID\n\n\t\t// Subscribe to the permission.requested event before sending the prompt.\n\t\tpermissionEventCh := make(chan *copilot.SessionEvent, 1)\n\t\tunsub := session1.On(func(evt copilot.SessionEvent) {\n\t\t\tif evt.Type == copilot.SessionEventTypePermissionRequested {\n\t\t\t\tselect {\n\t\t\t\tcase permissionEventCh <- &evt:\n\t\t\t\tdefault:\n\t\t\t\t}\n\t\t\t}\n\t\t})\n\t\tdefer unsub()\n\n\t\tif _, err := session1.Send(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Use resume_permission_tool with value 'alpha', then reply with the result.\",\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tselect {\n\t\tcase <-permissionRequested:\n\t\tcase <-time.After(pendingWorkTimeout):\n\t\t\tt.Fatal(\"Timed out waiting for original permission handler invocation\")\n\t\t}\n\t\tvar permissionEvent *copilot.SessionEvent\n\t\tselect {\n\t\tcase permissionEvent = <-permissionEventCh:\n\t\tcase <-time.After(pendingWorkTimeout):\n\t\t\tt.Fatal(\"Timed out waiting for permission.requested event\")\n\t\t}\n\t\tpermData, ok := permissionEvent.Data.(*copilot.PermissionRequestedData)\n\t\tif !ok {\n\t\t\tt.Fatalf(\"Expected PermissionRequestedData, got %T\", permissionEvent.Data)\n\t\t}\n\n\t\t// Snap the suspended client offline before the original handler resolves.\n\t\tsuspendedClient.ForceStop()\n\n\t\tvar resumedToolInvoked bool\n\t\tvar mu sync.Mutex\n\t\tresumedTool := copilot.DefineTool(\"resume_permission_tool\", \"Transforms a value after permission is granted\",\n\t\t\tfunc(params ValueParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\tmu.Lock()\n\t\t\t\tresumedToolInvoked = true\n\t\t\t\tmu.Unlock()\n\t\t\t\treturn \"PERMISSION_RESUMED_\" + strings.ToUpper(params.Value), nil\n\t\t\t})\n\n\t\tresumedClient := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\t\topts.CLIUrl = cliURL\n\t\t\topts.CLIPath = \"\"\n\t\t})\n\t\tt.Cleanup(func() { resumedClient.ForceStop() })\n\n\t\tsession2, err := resumedClient.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tContinuePendingWork: true,\n\t\t\tOnPermissionRequest: func(_ copilot.PermissionRequest, _ copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindNoResult}, nil\n\t\t\t},\n\t\t\tTools: []copilot.Tool{resumedTool},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\n\t\tpermResult, err := session2.RPC.Permissions.HandlePendingPermissionRequest(t.Context(), &rpc.PermissionDecisionRequest{\n\t\t\tRequestID: permData.RequestID,\n\t\t\tResult: rpc.PermissionDecision{\n\t\t\t\tKind: rpc.PermissionDecisionKindApproveOnce,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to handle pending permission request: %v\", err)\n\t\t}\n\t\tif !permResult.Success {\n\t\t\tt.Fatalf(\"Expected HandlePendingPermissionRequest to succeed, got %+v\", permResult)\n\t\t}\n\n\t\tctxFinal, cancel := context.WithTimeout(t.Context(), pendingWorkTimeout)\n\t\tdefer cancel()\n\t\tanswer, err := testharness.GetFinalAssistantMessage(ctxFinal, session2)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to wait for final assistant message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tinvoked := resumedToolInvoked\n\t\tmu.Unlock()\n\t\tif !invoked {\n\t\t\tt.Error(\"Expected resumed tool implementation to be invoked\")\n\t\t}\n\n\t\tif assistant, ok := answer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(assistant.Content, \"PERMISSION_RESUMED_ALPHA\") {\n\t\t\tt.Errorf(\"Expected response to contain 'PERMISSION_RESUMED_ALPHA', got %v\", answer.Data)\n\t\t}\n\n\t\t// Allow original handler to unblock so cleanup proceeds.\n\t\tselect {\n\t\tcase releasePermission <- copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindUserNotAvailable}:\n\t\tdefault:\n\t\t}\n\n\t\tsession2.Disconnect()\n\t})\n\n\tt.Run(\"should continue pending external tool request after resume\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t_, cliURL := startTcpServer(t, ctx)\n\n\t\ttype ValueParams struct {\n\t\t\tValue string `json:\"value\" jsonschema:\"Value to look up\"`\n\t\t}\n\t\ttoolStarted := make(chan string, 1)\n\t\treleaseTool := make(chan string, 1)\n\n\t\t// Original tool blocks until we release it; we ForceStop before that happens.\n\t\toriginalTool := copilot.DefineTool(\"resume_external_tool\", \"Looks up a value after resumption\",\n\t\t\tfunc(params ValueParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\tselect {\n\t\t\t\tcase toolStarted <- params.Value:\n\t\t\t\tdefault:\n\t\t\t\t}\n\t\t\t\treturn <-releaseTool, nil\n\t\t\t})\n\n\t\tsuspendedClient := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\t\topts.CLIUrl = cliURL\n\t\t\topts.CLIPath = \"\"\n\t\t})\n\t\tsession1, err := suspendedClient.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tTools: []copilot.Tool{originalTool},\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tsessionID := session1.SessionID\n\n\t\ttoolEventCh := waitForExternalToolRequests(session1, []string{\"resume_external_tool\"})\n\n\t\tif _, err := session1.Send(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Use resume_external_tool with value 'beta', then reply with the result.\",\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\ttoolEvents, err := waitForExternalToolResults(toolEventCh, pendingWorkTimeout)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"waiting for external tool requests: %v\", err)\n\t\t}\n\t\ttoolEvent := toolEvents[\"resume_external_tool\"]\n\t\tselect {\n\t\tcase v := <-toolStarted:\n\t\t\tif v != \"beta\" {\n\t\t\t\tt.Errorf(\"Expected original tool started with 'beta', got %q\", v)\n\t\t\t}\n\t\tcase <-time.After(pendingWorkTimeout):\n\t\t\tt.Fatal(\"Timed out waiting for original tool to start\")\n\t\t}\n\n\t\tsuspendedClient.ForceStop()\n\n\t\tresumedClient := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\t\topts.CLIUrl = cliURL\n\t\t\topts.CLIPath = \"\"\n\t\t})\n\t\tt.Cleanup(func() { resumedClient.ForceStop() })\n\n\t\tsession2, err := resumedClient.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tContinuePendingWork: true,\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\n\t\ttoolResult, err := session2.RPC.Tools.HandlePendingToolCall(t.Context(), &rpc.HandlePendingToolCallRequest{\n\t\t\tRequestID: toolEvent.RequestID,\n\t\t\tResult: &rpc.ExternalToolResult{\n\t\t\t\tString: copilot.String(\"EXTERNAL_RESUMED_BETA\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to handle pending tool call: %v\", err)\n\t\t}\n\t\tif !toolResult.Success {\n\t\t\tt.Errorf(\"Expected HandlePendingToolCall to succeed, got %+v\", toolResult)\n\t\t}\n\n\t\tctxFinal, cancel := context.WithTimeout(t.Context(), pendingWorkTimeout)\n\t\tdefer cancel()\n\t\tanswer, err := testharness.GetFinalAssistantMessage(ctxFinal, session2)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to wait for final assistant message: %v\", err)\n\t\t}\n\t\tif assistant, ok := answer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(assistant.Content, \"EXTERNAL_RESUMED_BETA\") {\n\t\t\tt.Errorf(\"Expected response to contain 'EXTERNAL_RESUMED_BETA', got %v\", answer.Data)\n\t\t}\n\n\t\tselect {\n\t\tcase releaseTool <- \"ORIGINAL_SHOULD_NOT_WIN\":\n\t\tdefault:\n\t\t}\n\n\t\tsession2.Disconnect()\n\t})\n\n\tt.Run(\"should continue parallel pending external tool requests after resume\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t_, cliURL := startTcpServer(t, ctx)\n\n\t\ttype ValueParams struct {\n\t\t\tValue string `json:\"value\" jsonschema:\"Value to look up\"`\n\t\t}\n\t\tstartedA := make(chan string, 1)\n\t\tstartedB := make(chan string, 1)\n\t\treleaseA := make(chan string, 1)\n\t\treleaseB := make(chan string, 1)\n\n\t\toriginalA := copilot.DefineTool(\"pending_lookup_a\", \"Looks up the first value after resumption\",\n\t\t\tfunc(params ValueParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\tselect {\n\t\t\t\tcase startedA <- params.Value:\n\t\t\t\tdefault:\n\t\t\t\t}\n\t\t\t\treturn <-releaseA, nil\n\t\t\t})\n\t\toriginalB := copilot.DefineTool(\"pending_lookup_b\", \"Looks up the second value after resumption\",\n\t\t\tfunc(params ValueParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\tselect {\n\t\t\t\tcase startedB <- params.Value:\n\t\t\t\tdefault:\n\t\t\t\t}\n\t\t\t\treturn <-releaseB, nil\n\t\t\t})\n\n\t\tsuspendedClient := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\t\topts.CLIUrl = cliURL\n\t\t\topts.CLIPath = \"\"\n\t\t})\n\t\tsession1, err := suspendedClient.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tTools: []copilot.Tool{originalA, originalB},\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tsessionID := session1.SessionID\n\n\t\ttoolEventCh := waitForExternalToolRequests(session1, []string{\"pending_lookup_a\", \"pending_lookup_b\"})\n\n\t\tif _, err := session1.Send(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Call pending_lookup_a with value 'alpha' and pending_lookup_b with value 'beta', then reply with both results.\",\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\ttoolEvents, err := waitForExternalToolResults(toolEventCh, pendingWorkTimeout)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"waiting for external tool requests: %v\", err)\n\t\t}\n\t\tselect {\n\t\tcase v := <-startedA:\n\t\t\tif v != \"alpha\" {\n\t\t\t\tt.Errorf(\"Expected pending_lookup_a started with 'alpha', got %q\", v)\n\t\t\t}\n\t\tcase <-time.After(pendingWorkTimeout):\n\t\t\tt.Fatal(\"Timed out waiting for pending_lookup_a to start\")\n\t\t}\n\t\tselect {\n\t\tcase v := <-startedB:\n\t\t\tif v != \"beta\" {\n\t\t\t\tt.Errorf(\"Expected pending_lookup_b started with 'beta', got %q\", v)\n\t\t\t}\n\t\tcase <-time.After(pendingWorkTimeout):\n\t\t\tt.Fatal(\"Timed out waiting for pending_lookup_b to start\")\n\t\t}\n\n\t\tsuspendedClient.ForceStop()\n\n\t\tresumedClient := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\t\topts.CLIUrl = cliURL\n\t\t\topts.CLIPath = \"\"\n\t\t})\n\t\tt.Cleanup(func() { resumedClient.ForceStop() })\n\n\t\tsession2, err := resumedClient.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tContinuePendingWork: true,\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\n\t\t// Resolve B first to verify ordering doesn't matter.\n\t\tresB, err := session2.RPC.Tools.HandlePendingToolCall(t.Context(), &rpc.HandlePendingToolCallRequest{\n\t\t\tRequestID: toolEvents[\"pending_lookup_b\"].RequestID,\n\t\t\tResult: &rpc.ExternalToolResult{String: copilot.String(\"PARALLEL_B_BETA\")},\n\t\t})\n\t\tif err != nil || !resB.Success {\n\t\t\tt.Fatalf(\"HandlePendingToolCall(B) failed: err=%v result=%+v\", err, resB)\n\t\t}\n\t\tresA, err := session2.RPC.Tools.HandlePendingToolCall(t.Context(), &rpc.HandlePendingToolCallRequest{\n\t\t\tRequestID: toolEvents[\"pending_lookup_a\"].RequestID,\n\t\t\tResult: &rpc.ExternalToolResult{String: copilot.String(\"PARALLEL_A_ALPHA\")},\n\t\t})\n\t\tif err != nil || !resA.Success {\n\t\t\tt.Fatalf(\"HandlePendingToolCall(A) failed: err=%v result=%+v\", err, resA)\n\t\t}\n\n\t\tctxFinal, cancel := context.WithTimeout(t.Context(), pendingWorkTimeout)\n\t\tdefer cancel()\n\t\tanswer, err := testharness.GetFinalAssistantMessage(ctxFinal, session2)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to wait for final assistant message: %v\", err)\n\t\t}\n\t\tassistant, ok := answer.Data.(*copilot.AssistantMessageData)\n\t\tif !ok {\n\t\t\tt.Fatalf(\"Expected AssistantMessageData, got %T\", answer.Data)\n\t\t}\n\t\tif !strings.Contains(assistant.Content, \"PARALLEL_A_ALPHA\") {\n\t\t\tt.Errorf(\"Expected response to contain 'PARALLEL_A_ALPHA', got %q\", assistant.Content)\n\t\t}\n\t\tif !strings.Contains(assistant.Content, \"PARALLEL_B_BETA\") {\n\t\t\tt.Errorf(\"Expected response to contain 'PARALLEL_B_BETA', got %q\", assistant.Content)\n\t\t}\n\n\t\tselect {\n\t\tcase releaseA <- \"ORIGINAL_A_SHOULD_NOT_WIN\":\n\t\tdefault:\n\t\t}\n\t\tselect {\n\t\tcase releaseB <- \"ORIGINAL_B_SHOULD_NOT_WIN\":\n\t\tdefault:\n\t\t}\n\n\t\tsession2.Disconnect()\n\t})\n\n\tt.Run(\"should resume successfully when no pending work exists\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t_, cliURL := startTcpServer(t, ctx)\n\n\t\tvar sessionID string\n\t\tfunc() {\n\t\t\tfirstClient := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\t\t\topts.CLIUrl = cliURL\n\t\t\t\topts.CLIPath = \"\"\n\t\t\t})\n\t\t\tdefer firstClient.ForceStop()\n\n\t\t\tfirstSession, err := firstClient.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\t})\n\t\t\tif err != nil {\n\t\t\t\tt.Fatalf(\"Failed to create first session: %v\", err)\n\t\t\t}\n\t\t\tsessionID = firstSession.SessionID\n\n\t\t\tanswer, err := firstSession.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\t\tPrompt: \"Reply with exactly: NO_PENDING_TURN_ONE\",\n\t\t\t})\n\t\t\tif err != nil {\n\t\t\t\tt.Fatalf(\"Failed to send first turn: %v\", err)\n\t\t\t}\n\t\t\tif assistant, ok := answer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(assistant.Content, \"NO_PENDING_TURN_ONE\") {\n\t\t\t\tt.Errorf(\"Expected first answer to contain 'NO_PENDING_TURN_ONE', got %v\", answer.Data)\n\t\t\t}\n\n\t\t\tfirstSession.Disconnect()\n\t\t}()\n\n\t\tresumedClient := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\t\topts.CLIUrl = cliURL\n\t\t\topts.CLIPath = \"\"\n\t\t})\n\t\tt.Cleanup(func() { resumedClient.ForceStop() })\n\n\t\tresumedSession, err := resumedClient.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tContinuePendingWork: true,\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\n\t\tfollowUp, err := resumedSession.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Reply with exactly: NO_PENDING_TURN_TWO\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send follow-up turn: %v\", err)\n\t\t}\n\t\tif assistant, ok := followUp.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(assistant.Content, \"NO_PENDING_TURN_TWO\") {\n\t\t\tt.Errorf(\"Expected follow-up answer to contain 'NO_PENDING_TURN_TWO', got %v\", followUp.Data)\n\t\t}\n\n\t\tresumedSession.Disconnect()\n\t})\n}\n\n// serverCliURL extracts the local CLI URL from a TCP-mode server client.\n// The server must already be started; this function panics with a fatal\n// test failure if the port is not yet available.\nfunc serverCliURL(t *testing.T, server *copilot.Client) string {\n\tt.Helper()\n\tport := server.ActualPort()\n\tif port == 0 {\n\t\tt.Fatal(\"Expected non-zero ActualPort from TCP server client; ensure the server is started before calling serverCliURL\")\n\t}\n\treturn fmt.Sprintf(\"localhost:%d\", port)\n}\n\n// startTcpServer starts a TCP-mode server client and returns its CLI URL.\n// It triggers an initial connection so ActualPort is populated.\nfunc startTcpServer(t *testing.T, ctx *testharness.TestContext) (*copilot.Client, string) {\n\tt.Helper()\n\tserver := ctx.NewClient(func(opts *copilot.ClientOptions) { opts.UseStdio = copilot.Bool(false) })\n\tt.Cleanup(func() { server.ForceStop() })\n\t// Trigger connection so we can read the port. CreateSession+Disconnect is the\n\t// established pattern (see multi_client_test.go).\n\tinitSession, err := server.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t})\n\tif err != nil {\n\t\tt.Fatalf(\"Failed to start TCP server client: %v\", err)\n\t}\n\tinitSession.Disconnect()\n\treturn server, serverCliURL(t, server)\n}\n\ntype collectedExternalRequests struct {\n\tmu sync.Mutex\n\tseen map[string]*copilot.ExternalToolRequestedData\n\twant map[string]struct{}\n\tdone chan struct{}\n}\n\n// waitForExternalToolRequests subscribes to a session and returns a struct that\n// blocks until all requested tool names have been observed via external_tool.requested.\nfunc waitForExternalToolRequests(session *copilot.Session, names []string) *collectedExternalRequests {\n\tc := &collectedExternalRequests{\n\t\tseen: make(map[string]*copilot.ExternalToolRequestedData),\n\t\twant: make(map[string]struct{}, len(names)),\n\t\tdone: make(chan struct{}),\n\t}\n\tfor _, n := range names {\n\t\tc.want[n] = struct{}{}\n\t}\n\tsession.On(func(evt copilot.SessionEvent) {\n\t\tif evt.Type != copilot.SessionEventTypeExternalToolRequested {\n\t\t\treturn\n\t\t}\n\t\td, ok := evt.Data.(*copilot.ExternalToolRequestedData)\n\t\tif !ok {\n\t\t\treturn\n\t\t}\n\t\tc.mu.Lock()\n\t\tdefer c.mu.Unlock()\n\t\tif _, want := c.want[d.ToolName]; !want {\n\t\t\treturn\n\t\t}\n\t\tif _, dup := c.seen[d.ToolName]; dup {\n\t\t\treturn\n\t\t}\n\t\tc.seen[d.ToolName] = d\n\t\tif len(c.seen) == len(c.want) {\n\t\t\tselect {\n\t\t\tcase <-c.done:\n\t\t\tdefault:\n\t\t\t\tclose(c.done)\n\t\t\t}\n\t\t}\n\t})\n\treturn c\n}\n\nfunc waitForExternalToolResults(c *collectedExternalRequests, timeout time.Duration) (map[string]*copilot.ExternalToolRequestedData, error) {\n\tselect {\n\tcase <-c.done:\n\tcase <-time.After(timeout):\n\t\tc.mu.Lock()\n\t\tgot := make([]string, 0, len(c.seen))\n\t\tfor name := range c.seen {\n\t\t\tgot = append(got, name)\n\t\t}\n\t\tc.mu.Unlock()\n\t\treturn nil, errors.New(\"timed out waiting for external tool requests; got: \" + strings.Join(got, \", \"))\n\t}\n\tc.mu.Lock()\n\tdefer c.mu.Unlock()\n\tout := make(map[string]*copilot.ExternalToolRequestedData, len(c.seen))\n\tfor k, v := range c.seen {\n\t\tout[k] = v\n\t}\n\treturn out, nil\n}\n" }, { "path": "go/internal/e2e/per_session_auth_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\nfunc TestPerSessionAuthE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\n\t// Create client with COPILOT_DEBUG_GITHUB_API_URL redirected to the proxy\n\t// so per-session auth token resolution (fetchCopilotUser) is intercepted.\n\tclient := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\topts.Env = append(opts.Env, \"COPILOT_DEBUG_GITHUB_API_URL=\"+ctx.ProxyURL)\n\t})\n\tt.Cleanup(func() { client.ForceStop() })\n\t// Register per-token user configs on the proxy\n\tif err := ctx.SetCopilotUserByToken(\"token-alice\", map[string]interface{}{\n\t\t\"login\": \"alice\",\n\t\t\"copilot_plan\": \"individual_pro\",\n\t\t\"endpoints\": map[string]interface{}{\"api\": ctx.ProxyURL, \"telemetry\": \"https://localhost:1/telemetry\"},\n\t\t\"analytics_tracking_id\": \"alice-tracking-id\",\n\t}); err != nil {\n\t\tt.Fatalf(\"Failed to set copilot user for alice: %v\", err)\n\t}\n\n\tif err := ctx.SetCopilotUserByToken(\"token-bob\", map[string]interface{}{\n\t\t\"login\": \"bob\",\n\t\t\"copilot_plan\": \"business\",\n\t\t\"endpoints\": map[string]interface{}{\"api\": ctx.ProxyURL, \"telemetry\": \"https://localhost:1/telemetry\"},\n\t\t\"analytics_tracking_id\": \"bob-tracking-id\",\n\t}); err != nil {\n\t\tt.Fatalf(\"Failed to set copilot user for bob: %v\", err)\n\t}\n\n\tt.Run(\"should authenticate with per-session token\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tGitHubToken: \"token-alice\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tauthStatus, err := session.RPC.Auth.GetStatus(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get auth status: %v\", err)\n\t\t}\n\n\t\tif !authStatus.IsAuthenticated {\n\t\t\tt.Errorf(\"Expected session to be authenticated\")\n\t\t}\n\t\tif authStatus.Login == nil || *authStatus.Login != \"alice\" {\n\t\t\tt.Errorf(\"Expected login to be 'alice', got %v\", authStatus.Login)\n\t\t}\n\t})\n\n\tt.Run(\"should isolate auth between sessions\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsessionA, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tGitHubToken: \"token-alice\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session A: %v\", err)\n\t\t}\n\n\t\tsessionB, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tGitHubToken: \"token-bob\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session B: %v\", err)\n\t\t}\n\n\t\tstatusA, err := sessionA.RPC.Auth.GetStatus(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get auth status for session A: %v\", err)\n\t\t}\n\n\t\tstatusB, err := sessionB.RPC.Auth.GetStatus(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get auth status for session B: %v\", err)\n\t\t}\n\n\t\tif statusA.Login == nil || *statusA.Login != \"alice\" {\n\t\t\tt.Errorf(\"Expected session A login to be 'alice', got %v\", statusA.Login)\n\t\t}\n\t\tif statusB.Login == nil || *statusB.Login != \"bob\" {\n\t\t\tt.Errorf(\"Expected session B login to be 'bob', got %v\", statusB.Login)\n\t\t}\n\t})\n\n\tt.Run(\"should be unauthenticated without token\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tauthStatus, err := session.RPC.Auth.GetStatus(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get auth status: %v\", err)\n\t\t}\n\n\t\t// Without a per-session token, there is no per-session identity.\n\t\t// In CI the process-level fake token may still authenticate globally,\n\t\t// so we check Login rather than IsAuthenticated.\n\t\tif authStatus.Login != nil && *authStatus.Login != \"\" {\n\t\t\tt.Errorf(\"Expected no per-session login without token, got %q\", *authStatus.Login)\n\t\t}\n\t})\n\n\tt.Run(\"should fail with invalid token\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t_, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tGitHubToken: \"invalid-token\",\n\t\t})\n\t\tif err == nil {\n\t\t\tt.Fatal(\"Expected session creation to fail with invalid token\")\n\t\t}\n\t\tt.Logf(\"Got expected error: %v\", err)\n\t})\n}\n" }, { "path": "go/internal/e2e/permissions_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"sync\"\n\t\"testing\"\n\t\"time\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\nfunc TestPermissionsE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"permission handler for write operations\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tvar permissionRequests []copilot.PermissionRequest\n\t\tvar mu sync.Mutex\n\n\t\tonPermissionRequest := func(request copilot.PermissionRequest, invocation copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\tmu.Lock()\n\t\t\tpermissionRequests = append(permissionRequests, request)\n\t\t\tmu.Unlock()\n\n\t\t\tif invocation.SessionID == \"\" {\n\t\t\t\tt.Error(\"Expected non-empty session ID in invocation\")\n\t\t\t}\n\n\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: onPermissionRequest,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\ttestFile := filepath.Join(ctx.WorkDir, \"test.txt\")\n\t\terr = os.WriteFile(testFile, []byte(\"original content\"), 0644)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to write test file: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Edit test.txt and replace 'original' with 'modified'\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tif len(permissionRequests) == 0 {\n\t\t\tt.Error(\"Expected at least one permission request\")\n\t\t}\n\t\twriteCount := 0\n\t\tfor _, req := range permissionRequests {\n\t\t\tif req.Kind == \"write\" {\n\t\t\t\twriteCount++\n\t\t\t}\n\t\t}\n\t\tmu.Unlock()\n\n\t\tif writeCount == 0 {\n\t\t\tt.Error(\"Expected at least one write permission request\")\n\t\t}\n\t})\n\n\tt.Run(\"permission handler for shell commands\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tvar permissionRequests []copilot.PermissionRequest\n\t\tvar mu sync.Mutex\n\n\t\tonPermissionRequest := func(request copilot.PermissionRequest, invocation copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\tmu.Lock()\n\t\t\tpermissionRequests = append(permissionRequests, request)\n\t\t\tmu.Unlock()\n\n\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: onPermissionRequest,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Run 'echo hello' and tell me the output\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tshellCount := 0\n\t\tfor _, req := range permissionRequests {\n\t\t\tif req.Kind == \"shell\" {\n\t\t\t\tshellCount++\n\t\t\t}\n\t\t}\n\t\tmu.Unlock()\n\n\t\tif shellCount == 0 {\n\t\t\tt.Error(\"Expected at least one shell permission request\")\n\t\t}\n\t})\n\n\tt.Run(\"deny permission\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tonPermissionRequest := func(request copilot.PermissionRequest, invocation copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindRejected}, nil\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: onPermissionRequest,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\ttestFile := filepath.Join(ctx.WorkDir, \"protected.txt\")\n\t\toriginalContent := []byte(\"protected content\")\n\t\terr = os.WriteFile(testFile, originalContent, 0644)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to write test file: %v\", err)\n\t\t}\n\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Edit protected.txt and replace 'protected' with 'hacked'.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\t_, err = testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get final message: %v\", err)\n\t\t}\n\n\t\t// Verify the file was NOT modified\n\t\tcontent, err := os.ReadFile(testFile)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to read test file: %v\", err)\n\t\t}\n\n\t\tif string(content) != string(originalContent) {\n\t\t\tt.Errorf(\"Expected file to remain unchanged after denied permission, got: %s\", string(content))\n\t\t}\n\t})\n\n\tt.Run(\"should deny tool operations when handler explicitly denies\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: func(request copilot.PermissionRequest, invocation copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindUserNotAvailable}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tvar mu sync.Mutex\n\t\tpermissionDenied := false\n\n\t\tsession.On(func(event copilot.SessionEvent) {\n\t\t\tif event.Type == copilot.SessionEventTypeToolExecutionComplete {\n\t\t\t\tif d, ok := event.Data.(*copilot.ToolExecutionCompleteData); ok &&\n\t\t\t\t\t!d.Success &&\n\t\t\t\t\td.Error != nil &&\n\t\t\t\t\tstrings.Contains(d.Error.Message, \"Permission denied\") {\n\t\t\t\t\tmu.Lock()\n\t\t\t\t\tpermissionDenied = true\n\t\t\t\t\tmu.Unlock()\n\t\t\t\t}\n\t\t\t}\n\t\t})\n\n\t\tif _, err = session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Run 'node --version'\",\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tdefer mu.Unlock()\n\t\tif !permissionDenied {\n\t\t\tt.Error(\"Expected a tool.execution_complete event with Permission denied result\")\n\t\t}\n\t})\n\n\tt.Run(\"should deny tool operations when handler explicitly denies after resume\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession1, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tsessionID := session1.SessionID\n\t\tif _, err = session1.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 1+1?\"}); err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tsession2, err := client.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: func(request copilot.PermissionRequest, invocation copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindUserNotAvailable}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\n\t\tvar mu sync.Mutex\n\t\tpermissionDenied := false\n\n\t\tsession2.On(func(event copilot.SessionEvent) {\n\t\t\tif event.Type == copilot.SessionEventTypeToolExecutionComplete {\n\t\t\t\tif d, ok := event.Data.(*copilot.ToolExecutionCompleteData); ok &&\n\t\t\t\t\t!d.Success &&\n\t\t\t\t\td.Error != nil &&\n\t\t\t\t\tstrings.Contains(d.Error.Message, \"Permission denied\") {\n\t\t\t\t\tmu.Lock()\n\t\t\t\t\tpermissionDenied = true\n\t\t\t\t\tmu.Unlock()\n\t\t\t\t}\n\t\t\t}\n\t\t})\n\n\t\tif _, err = session2.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Run 'node --version'\",\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tdefer mu.Unlock()\n\t\tif !permissionDenied {\n\t\t\tt.Error(\"Expected a tool.execution_complete event with Permission denied result\")\n\t\t}\n\t})\n\n\tt.Run(\"should work with approve-all permission handler\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{Prompt: \"What is 2+2?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmessage, err := testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get final message: %v\", err)\n\t\t}\n\n\t\tif md, ok := message.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(md.Content, \"4\") {\n\t\t\tvar content string\n\t\t\tif ok {\n\t\t\t\tcontent = md.Content\n\t\t\t}\n\t\t\tt.Errorf(\"Expected message to contain '4', got: %v\", content)\n\t\t}\n\t})\n\n\tt.Run(\"should handle async permission handler\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tvar permissionRequestReceived atomicBool\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\t\tpermissionRequestReceived.Set(true)\n\t\t\t\t// Simulate async work.\n\t\t\t\ttime.Sleep(20 * time.Millisecond)\n\t\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Run 'echo test' and tell me what happens\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\t\tif !permissionRequestReceived.Get() {\n\t\t\tt.Error(\"Expected permission handler to have been invoked\")\n\t\t}\n\t})\n\n\tt.Run(\"should resume session with permission handler\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession1, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\t\tsessionID := session1.SessionID\n\t\tif _, err := session1.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 1+1?\"}); err != nil {\n\t\t\tt.Fatalf(\"Initial SendAndWait failed: %v\", err)\n\t\t}\n\t\tif err := session1.Disconnect(); err != nil {\n\t\t\tt.Fatalf(\"Disconnect failed: %v\", err)\n\t\t}\n\n\t\tvar permissionRequestReceived atomicBool\n\t\tsession2, err := client.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\t\tpermissionRequestReceived.Set(true)\n\t\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"ResumeSession failed: %v\", err)\n\t\t}\n\n\t\t_, err = session2.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Run 'echo resumed' for me\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait (after resume) failed: %v\", err)\n\t\t}\n\t\tif !permissionRequestReceived.Get() {\n\t\t\tt.Error(\"Expected permission handler from ResumeSessionConfig to have been invoked\")\n\t\t}\n\t})\n\n\tt.Run(\"should handle permission handler errors gracefully\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\t\treturn copilot.PermissionRequestResult{}, fmt.Errorf(\"handler error\")\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tmessage, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Run 'echo test'. If you can't, say 'failed'.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tad, ok := message.Data.(*copilot.AssistantMessageData)\n\t\tif !ok {\n\t\t\tt.Fatalf(\"Expected *AssistantMessageData, got %T\", message.Data)\n\t\t}\n\t\tcontent := strings.ToLower(ad.Content)\n\t\tmatched := false\n\t\tfor _, keyword := range []string{\"fail\", \"cannot\", \"unable\", \"permission\"} {\n\t\t\tif strings.Contains(content, keyword) {\n\t\t\t\tmatched = true\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif !matched {\n\t\t\tt.Errorf(\"Expected response to indicate failure (fail/cannot/unable/permission), got %q\", ad.Content)\n\t\t}\n\t})\n\n\tt.Run(\"should receive toolCallId in permission requests\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tvar receivedToolCallID atomicBool\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\t\tif req.Kind == copilot.PermissionRequestKindShell && req.ToolCallID != nil && *req.ToolCallID != \"\" {\n\t\t\t\t\treceivedToolCallID.Set(true)\n\t\t\t\t}\n\t\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Run 'echo test'\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\t\tif !receivedToolCallID.Get() {\n\t\t\tt.Error(\"Expected ToolCallID to be populated on shell permission request\")\n\t\t}\n\t})\n}\n\n// atomicBool is a tiny helper for concurrent flag updates in handler callbacks.\ntype atomicBool struct {\n\tmu sync.Mutex\n\tv bool\n}\n\nfunc (a *atomicBool) Set(v bool) {\n\ta.mu.Lock()\n\ta.v = v\n\ta.mu.Unlock()\n}\n\nfunc (a *atomicBool) Get() bool {\n\ta.mu.Lock()\n\tdefer a.mu.Unlock()\n\treturn a.v\n}\n" }, { "path": "go/internal/e2e/rpc_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"strings\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n\t\"github.com/github/copilot-sdk/go/rpc\"\n)\n\nfunc TestRpcE2E(t *testing.T) {\n\tcliPath := testharness.CLIPath()\n\tif cliPath == \"\" {\n\t\tt.Fatal(\"CLI not found. Run 'npm install' in the nodejs directory first.\")\n\t}\n\n\tt.Run(\"should call RPC.Ping with typed params and result\", func(t *testing.T) {\n\t\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIPath: cliPath,\n\t\t\tUseStdio: copilot.Bool(true),\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t\t}\n\n\t\tresult, err := client.RPC.Ping(t.Context(), &rpc.PingRequest{Message: copilot.String(\"typed rpc test\")})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to call RPC.Ping: %v\", err)\n\t\t}\n\n\t\tif result.Message != \"pong: typed rpc test\" {\n\t\t\tt.Errorf(\"Expected message 'pong: typed rpc test', got %q\", result.Message)\n\t\t}\n\n\t\tif result.Timestamp < 0 {\n\t\t\tt.Errorf(\"Expected timestamp >= 0, got %d\", result.Timestamp)\n\t\t}\n\n\t\tif err := client.Stop(); err != nil {\n\t\t\tt.Errorf(\"Expected no errors on stop, got %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should call RPC.Models.List with typed result\", func(t *testing.T) {\n\t\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIPath: cliPath,\n\t\t\tUseStdio: copilot.Bool(true),\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t\t}\n\n\t\tauthStatus, err := client.GetAuthStatus(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get auth status: %v\", err)\n\t\t}\n\n\t\tif !authStatus.IsAuthenticated {\n\t\t\tt.Skip(\"Not authenticated - skipping models.list test\")\n\t\t}\n\n\t\tresult, err := client.RPC.Models.List(t.Context(), nil)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to call RPC.Models.List: %v\", err)\n\t\t}\n\n\t\tif result.Models == nil {\n\t\t\tt.Error(\"Expected models to be defined\")\n\t\t}\n\n\t\tif err := client.Stop(); err != nil {\n\t\t\tt.Errorf(\"Expected no errors on stop, got %v\", err)\n\t\t}\n\t})\n\n\t// account.getQuota is defined in schema but not yet implemented in CLI\n\tt.Run(\"should call RPC.Account.GetQuota when authenticated\", func(t *testing.T) {\n\t\tt.Skip(\"account.getQuota not yet implemented in CLI\")\n\n\t\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIPath: cliPath,\n\t\t\tUseStdio: copilot.Bool(true),\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t\t}\n\n\t\tauthStatus, err := client.GetAuthStatus(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get auth status: %v\", err)\n\t\t}\n\n\t\tif !authStatus.IsAuthenticated {\n\t\t\tt.Skip(\"Not authenticated - skipping account.getQuota test\")\n\t\t}\n\n\t\tresult, err := client.RPC.Account.GetQuota(t.Context(), nil)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to call RPC.Account.GetQuota: %v\", err)\n\t\t}\n\n\t\tif result.QuotaSnapshots == nil {\n\t\t\tt.Error(\"Expected quotaSnapshots to be defined\")\n\t\t}\n\n\t\tif err := client.Stop(); err != nil {\n\t\t\tt.Errorf(\"Expected no errors on stop, got %v\", err)\n\t\t}\n\t})\n}\n\nfunc TestSessionRpcE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tif err := client.Start(t.Context()); err != nil {\n\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t}\n\n\t// session.model.getCurrent is defined in schema but not yet implemented in CLI\n\tt.Run(\"should call session.RPC.Model.GetCurrent\", func(t *testing.T) {\n\t\tt.Skip(\"session.model.getCurrent not yet implemented in CLI\")\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tModel: \"claude-sonnet-4.5\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tresult, err := session.RPC.Model.GetCurrent(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to call session.RPC.Model.GetCurrent: %v\", err)\n\t\t}\n\n\t\tif result.ModelID == nil || *result.ModelID == \"\" {\n\t\t\tt.Error(\"Expected modelId to be defined\")\n\t\t}\n\t})\n\n\t// session.model.switchTo is defined in schema but not yet implemented in CLI\n\tt.Run(\"should call session.RPC.Model.SwitchTo\", func(t *testing.T) {\n\t\tt.Skip(\"session.model.switchTo not yet implemented in CLI\")\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tModel: \"claude-sonnet-4.5\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Get initial model\n\t\tbefore, err := session.RPC.Model.GetCurrent(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get current model: %v\", err)\n\t\t}\n\t\tif before.ModelID == nil || *before.ModelID == \"\" {\n\t\t\tt.Error(\"Expected initial modelId to be defined\")\n\t\t}\n\n\t\t// Switch to a different model with reasoning effort\n\t\tre := \"high\"\n\t\tresult, err := session.RPC.Model.SwitchTo(t.Context(), &rpc.ModelSwitchToRequest{\n\t\t\tModelID: \"gpt-4.1\",\n\t\t\tReasoningEffort: &re,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to switch model: %v\", err)\n\t\t}\n\t\tif result.ModelID == nil || *result.ModelID != \"gpt-4.1\" {\n\t\t\tt.Errorf(\"Expected modelId 'gpt-4.1', got %v\", result.ModelID)\n\t\t}\n\n\t\t// Verify the switch persisted\n\t\tafter, err := session.RPC.Model.GetCurrent(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get current model after switch: %v\", err)\n\t\t}\n\t\tif after.ModelID == nil || *after.ModelID != \"gpt-4.1\" {\n\t\t\tt.Errorf(\"Expected modelId 'gpt-4.1' after switch, got %v\", after.ModelID)\n\t\t}\n\t})\n\n\t// session.model.switchTo is defined in schema but not yet implemented in CLI\n\tt.Run(\"should call session.SetModel\", func(t *testing.T) {\n\t\tt.Skip(\"session.model.switchTo not yet implemented in CLI\")\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tModel: \"claude-sonnet-4.5\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tif err := session.SetModel(t.Context(), \"gpt-4.1\", &copilot.SetModelOptions{ReasoningEffort: copilot.String(\"high\")}); err != nil {\n\t\t\tt.Fatalf(\"SetModel returned error: %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should get and set session mode\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Get initial mode (default should be interactive)\n\t\tinitial, err := session.RPC.Mode.Get(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get mode: %v\", err)\n\t\t}\n\t\tif *initial != rpc.SessionModeInteractive {\n\t\t\tt.Errorf(\"Expected initial mode 'interactive', got %q\", *initial)\n\t\t}\n\n\t\t// Switch to plan mode\n\t\t_, err = session.RPC.Mode.Set(t.Context(), &rpc.ModeSetRequest{Mode: rpc.SessionModePlan})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to set mode to plan: %v\", err)\n\t\t}\n\n\t\t// Verify mode persisted\n\t\tafterPlan, err := session.RPC.Mode.Get(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get mode after plan: %v\", err)\n\t\t}\n\t\tif *afterPlan != rpc.SessionModePlan {\n\t\t\tt.Errorf(\"Expected mode 'plan' after set, got %q\", *afterPlan)\n\t\t}\n\n\t\t// Switch back to interactive\n\t\t_, err = session.RPC.Mode.Set(t.Context(), &rpc.ModeSetRequest{Mode: rpc.SessionModeInteractive})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to set mode to interactive: %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should read, update, and delete plan\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Initially plan should not exist\n\t\tinitial, err := session.RPC.Plan.Read(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to read plan: %v\", err)\n\t\t}\n\t\tif initial.Exists {\n\t\t\tt.Error(\"Expected plan to not exist initially\")\n\t\t}\n\t\tif initial.Content != nil {\n\t\t\tt.Error(\"Expected content to be nil initially\")\n\t\t}\n\n\t\t// Create/update plan\n\t\tplanContent := \"# Test Plan\\n\\n- Step 1\\n- Step 2\"\n\t\t_, err = session.RPC.Plan.Update(t.Context(), &rpc.PlanUpdateRequest{Content: planContent})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to update plan: %v\", err)\n\t\t}\n\n\t\t// Verify plan exists and has correct content\n\t\tafterUpdate, err := session.RPC.Plan.Read(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to read plan after update: %v\", err)\n\t\t}\n\t\tif !afterUpdate.Exists {\n\t\t\tt.Error(\"Expected plan to exist after update\")\n\t\t}\n\t\tif afterUpdate.Content == nil || *afterUpdate.Content != planContent {\n\t\t\tt.Errorf(\"Expected content %q, got %v\", planContent, afterUpdate.Content)\n\t\t}\n\n\t\t// Delete plan\n\t\t_, err = session.RPC.Plan.Delete(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to delete plan: %v\", err)\n\t\t}\n\n\t\t// Verify plan is deleted\n\t\tafterDelete, err := session.RPC.Plan.Read(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to read plan after delete: %v\", err)\n\t\t}\n\t\tif afterDelete.Exists {\n\t\t\tt.Error(\"Expected plan to not exist after delete\")\n\t\t}\n\t\tif afterDelete.Content != nil {\n\t\t\tt.Error(\"Expected content to be nil after delete\")\n\t\t}\n\t})\n\n\tt.Run(\"should create, list, and read workspace files\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Initially no files\n\t\tinitialFiles, err := session.RPC.Workspaces.ListFiles(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to list files: %v\", err)\n\t\t}\n\t\tif len(initialFiles.Files) != 0 {\n\t\t\tt.Errorf(\"Expected no files initially, got %v\", initialFiles.Files)\n\t\t}\n\n\t\t// Create a file\n\t\tfileContent := \"Hello, workspace!\"\n\t\t_, err = session.RPC.Workspaces.CreateFile(t.Context(), &rpc.WorkspacesCreateFileRequest{\n\t\t\tPath: \"test.txt\",\n\t\t\tContent: fileContent,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create file: %v\", err)\n\t\t}\n\n\t\t// List files\n\t\tafterCreate, err := session.RPC.Workspaces.ListFiles(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to list files after create: %v\", err)\n\t\t}\n\t\tif !containsString(afterCreate.Files, \"test.txt\") {\n\t\t\tt.Errorf(\"Expected files to contain 'test.txt', got %v\", afterCreate.Files)\n\t\t}\n\n\t\t// Read file\n\t\treadResult, err := session.RPC.Workspaces.ReadFile(t.Context(), &rpc.WorkspacesReadFileRequest{\n\t\t\tPath: \"test.txt\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to read file: %v\", err)\n\t\t}\n\t\tif readResult.Content != fileContent {\n\t\t\tt.Errorf(\"Expected content %q, got %q\", fileContent, readResult.Content)\n\t\t}\n\n\t\t// Create nested file\n\t\t_, err = session.RPC.Workspaces.CreateFile(t.Context(), &rpc.WorkspacesCreateFileRequest{\n\t\t\tPath: \"subdir/nested.txt\",\n\t\t\tContent: \"Nested content\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create nested file: %v\", err)\n\t\t}\n\n\t\tafterNested, err := session.RPC.Workspaces.ListFiles(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to list files after nested: %v\", err)\n\t\t}\n\t\tif !containsString(afterNested.Files, \"test.txt\") {\n\t\t\tt.Errorf(\"Expected files to contain 'test.txt', got %v\", afterNested.Files)\n\t\t}\n\t\thasNested := false\n\t\tfor _, f := range afterNested.Files {\n\t\t\tif strings.Contains(f, \"nested.txt\") {\n\t\t\t\thasNested = true\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif !hasNested {\n\t\t\tt.Errorf(\"Expected files to contain 'nested.txt', got %v\", afterNested.Files)\n\t\t}\n\t})\n}\n\nfunc containsString(slice []string, str string) bool {\n\tfor _, s := range slice {\n\t\tif s == str {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n" }, { "path": "go/internal/e2e/rpc_mcp_and_skills_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n\t\"github.com/github/copilot-sdk/go/rpc\"\n)\n\n// Mirrors dotnet/test/RpcMcpAndSkillsTests.cs (snapshot category \"rpc_mcp_and_skills\").\n// Tests session-scoped MCP, skills, plugins, and extensions RPCs.\nfunc TestRpcMcpAndSkillsE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"should list and toggle session skills\", func(t *testing.T) {\n\t\tskillName := fmt.Sprintf(\"session-rpc-skill-%s\", randomHex(t))\n\t\tskillsDir := createMcpSkillsRpcDirectory(t, ctx.WorkDir, \"session-rpc-skills\", skillName, \"Session skill controlled by RPC.\")\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tSkillDirectories: []string{skillsDir},\n\t\t\tDisabledSkills: []string{skillName},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tdisabled, err := session.RPC.Skills.List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Skills.List (initial) failed: %v\", err)\n\t\t}\n\t\tassertSkillState(t, disabled, skillName, false)\n\n\t\tif _, err := session.RPC.Skills.Enable(t.Context(), &rpc.SkillsEnableRequest{Name: skillName}); err != nil {\n\t\t\tt.Fatalf(\"Skills.Enable failed: %v\", err)\n\t\t}\n\t\tenabled, err := session.RPC.Skills.List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Skills.List (after enable) failed: %v\", err)\n\t\t}\n\t\tassertSkillState(t, enabled, skillName, true)\n\n\t\tif _, err := session.RPC.Skills.Disable(t.Context(), &rpc.SkillsDisableRequest{Name: skillName}); err != nil {\n\t\t\tt.Fatalf(\"Skills.Disable failed: %v\", err)\n\t\t}\n\t\tdisabledAgain, err := session.RPC.Skills.List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Skills.List (after disable) failed: %v\", err)\n\t\t}\n\t\tassertSkillState(t, disabledAgain, skillName, false)\n\t})\n\n\tt.Run(\"should reload session skills\", func(t *testing.T) {\n\t\tskillsDir := filepath.Join(ctx.WorkDir, \"reloadable-rpc-skills\", randomHex(t))\n\t\tif err := os.MkdirAll(skillsDir, 0755); err != nil {\n\t\t\tt.Fatalf(\"Failed to create skills directory: %v\", err)\n\t\t}\n\t\tskillName := fmt.Sprintf(\"reload-rpc-skill-%s\", randomHex(t))\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tSkillDirectories: []string{skillsDir},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tbefore, err := session.RPC.Skills.List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Skills.List (before) failed: %v\", err)\n\t\t}\n\t\tfor _, skill := range before.Skills {\n\t\t\tif skill.Name == skillName {\n\t\t\t\tt.Fatalf(\"Did not expect %q to be present before creation\", skillName)\n\t\t\t}\n\t\t}\n\n\t\twriteSkillFile(t, skillsDir, skillName, \"Skill added after session creation.\")\n\n\t\tif _, err := session.RPC.Skills.Reload(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Skills.Reload failed: %v\", err)\n\t\t}\n\n\t\tafter, err := session.RPC.Skills.List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Skills.List (after) failed: %v\", err)\n\t\t}\n\t\treloaded := assertSkillState(t, after, skillName, true)\n\t\tif reloaded != nil && reloaded.Description != \"Skill added after session creation.\" {\n\t\t\tt.Errorf(\"Expected description %q, got %q\", \"Skill added after session creation.\", reloaded.Description)\n\t\t}\n\t})\n\n\tt.Run(\"should list mcp servers with configured server\", func(t *testing.T) {\n\t\tconst serverName = \"rpc-list-mcp-server\"\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tMCPServers: map[string]copilot.MCPServerConfig{\n\t\t\t\tserverName: copilot.MCPStdioServerConfig{\n\t\t\t\t\tCommand: \"echo\",\n\t\t\t\t\tArgs: []string{\"rpc-list-mcp-server\"},\n\t\t\t\t\tTools: []string{\"*\"},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tresult, err := session.RPC.Mcp.List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Mcp.List failed: %v\", err)\n\t\t}\n\t\tvar found bool\n\t\tfor _, server := range result.Servers {\n\t\t\tif server.Name == serverName {\n\t\t\t\tfound = true\n\t\t\t\tif string(server.Status) == \"\" {\n\t\t\t\t\tt.Errorf(\"Expected non-empty MCP server status, got empty\")\n\t\t\t\t}\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif !found {\n\t\t\tt.Errorf(\"Expected MCP server %q in result, got %+v\", serverName, result.Servers)\n\t\t}\n\t})\n\n\tt.Run(\"should list plugins\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tresult, err := session.RPC.Plugins.List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Plugins.List failed: %v\", err)\n\t\t}\n\t\tif result.Plugins == nil {\n\t\t\tt.Error(\"Expected non-nil Plugins list\")\n\t\t}\n\t\tfor i, plugin := range result.Plugins {\n\t\t\tif strings.TrimSpace(plugin.Name) == \"\" {\n\t\t\t\tt.Errorf(\"Plugin[%d] has empty Name\", i)\n\t\t\t}\n\t\t}\n\t})\n\n\tt.Run(\"should list extensions\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tresult, err := session.RPC.Extensions.List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Extensions.List failed: %v\", err)\n\t\t}\n\t\tif result.Extensions == nil {\n\t\t\tt.Error(\"Expected non-nil Extensions list\")\n\t\t}\n\t\tfor i, ext := range result.Extensions {\n\t\t\tif strings.TrimSpace(ext.ID) == \"\" {\n\t\t\t\tt.Errorf(\"Extension[%d] has empty ID\", i)\n\t\t\t}\n\t\t\tif strings.TrimSpace(ext.Name) == \"\" {\n\t\t\t\tt.Errorf(\"Extension[%d] has empty Name\", i)\n\t\t\t}\n\t\t}\n\t})\n\n\tt.Run(\"should report error when mcp host is not initialized\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tassertRpcError(t, \"Mcp.Enable\", func() error {\n\t\t\t_, e := session.RPC.Mcp.Enable(t.Context(), &rpc.MCPEnableRequest{ServerName: \"missing-server\"})\n\t\t\treturn e\n\t\t}, \"no mcp host initialized\")\n\t\tassertRpcError(t, \"Mcp.Disable\", func() error {\n\t\t\t_, e := session.RPC.Mcp.Disable(t.Context(), &rpc.MCPDisableRequest{ServerName: \"missing-server\"})\n\t\t\treturn e\n\t\t}, \"no mcp host initialized\")\n\t\tassertRpcError(t, \"Mcp.Reload\", func() error {\n\t\t\t_, e := session.RPC.Mcp.Reload(t.Context())\n\t\t\treturn e\n\t\t}, \"mcp config reload not available\")\n\t})\n\n\tt.Run(\"should report error when extensions are not available\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tassertRpcError(t, \"Extensions.Enable\", func() error {\n\t\t\t_, e := session.RPC.Extensions.Enable(t.Context(), &rpc.ExtensionsEnableRequest{ID: \"missing-extension\"})\n\t\t\treturn e\n\t\t}, \"extensions not available\")\n\t\tassertRpcError(t, \"Extensions.Disable\", func() error {\n\t\t\t_, e := session.RPC.Extensions.Disable(t.Context(), &rpc.ExtensionsDisableRequest{ID: \"missing-extension\"})\n\t\t\treturn e\n\t\t}, \"extensions not available\")\n\t\tassertRpcError(t, \"Extensions.Reload\", func() error {\n\t\t\t_, e := session.RPC.Extensions.Reload(t.Context())\n\t\t\treturn e\n\t\t}, \"extensions not available\")\n\t})\n}\n\n// createMcpSkillsRpcDirectory creates a unique skills directory containing a single\n// SKILL.md and returns the parent directory suitable for SkillDirectories.\nfunc createMcpSkillsRpcDirectory(t *testing.T, workDir, baseName, skillName, description string) string {\n\tt.Helper()\n\tskillsDir := filepath.Join(workDir, baseName, randomHex(t))\n\tif err := os.MkdirAll(skillsDir, 0755); err != nil {\n\t\tt.Fatalf(\"Failed to create skills directory: %v\", err)\n\t}\n\twriteSkillFile(t, skillsDir, skillName, description)\n\treturn skillsDir\n}\n\nfunc writeSkillFile(t *testing.T, skillsDir, skillName, description string) {\n\tt.Helper()\n\tskillSubdir := filepath.Join(skillsDir, skillName)\n\tif err := os.MkdirAll(skillSubdir, 0755); err != nil {\n\t\tt.Fatalf(\"Failed to create skill subdirectory: %v\", err)\n\t}\n\tcontent := fmt.Sprintf(\"---\\nname: %s\\ndescription: %s\\n---\\n\\n# %s\\n\\nThis skill is used by RPC E2E tests.\\n\", skillName, description, skillName)\n\tif err := os.WriteFile(filepath.Join(skillSubdir, \"SKILL.md\"), []byte(content), 0644); err != nil {\n\t\tt.Fatalf(\"Failed to write SKILL.md: %v\", err)\n\t}\n}\n\n// assertSkillState finds a skill by name in the list and asserts it has the\n// expected enabled state, returning the matched skill (or nil if not found).\nfunc assertSkillState(t *testing.T, list *rpc.SkillList, name string, enabled bool) *rpc.Skill {\n\tt.Helper()\n\tvar matched *rpc.Skill\n\tcount := 0\n\tfor i, skill := range list.Skills {\n\t\tif skill.Name == name {\n\t\t\tcount++\n\t\t\tmatched = &list.Skills[i]\n\t\t}\n\t}\n\tif count != 1 {\n\t\tt.Fatalf(\"Expected exactly 1 skill named %q, found %d\", name, count)\n\t}\n\tif matched.Enabled != enabled {\n\t\tt.Errorf(\"Expected skill %q Enabled=%t, got %t\", name, enabled, matched.Enabled)\n\t}\n\tif matched.Path == nil || !strings.HasSuffix(strings.ReplaceAll(*matched.Path, \"\\\\\", \"/\"), strings.Join([]string{name, \"SKILL.md\"}, \"/\")) {\n\t\tt.Errorf(\"Expected skill path to end with %s/SKILL.md, got %v\", name, matched.Path)\n\t}\n\treturn matched\n}\n\nfunc assertRpcError(t *testing.T, name string, action func() error, expectedSubstring string) {\n\tt.Helper()\n\terr := action()\n\tif err == nil {\n\t\tt.Errorf(\"Expected %s to fail with error containing %q, got nil\", name, expectedSubstring)\n\t\treturn\n\t}\n\tif !strings.Contains(strings.ToLower(err.Error()), strings.ToLower(expectedSubstring)) {\n\t\tt.Errorf(\"Expected %s error to contain %q, got %v\", name, expectedSubstring, err)\n\t}\n}\n" }, { "path": "go/internal/e2e/rpc_mcp_config_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"fmt\"\n\t\"testing\"\n\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n\t\"github.com/github/copilot-sdk/go/rpc\"\n)\n\n// Mirrors dotnet/test/RpcMcpConfigTests.cs (snapshot category \"rpc_mcp_config\").\n// Tests server-scoped MCP configuration management via mcp.config.* RPCs.\nfunc TestRpcMcpConfigE2E(t *testing.T) {\n\tt.Run(\"should call server mcp config rpcs\", func(t *testing.T) {\n\t\tctx := testharness.NewTestContext(t)\n\t\tclient := ctx.NewClient()\n\t\tt.Cleanup(func() { client.ForceStop() })\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Start failed: %v\", err)\n\t\t}\n\n\t\tserverName := fmt.Sprintf(\"sdk-test-%s\", randomHex(t))\n\n\t\tnodeCmd := \"node\"\n\t\tbaseConfig := rpc.MCPServerConfig{\n\t\t\tCommand: &nodeCmd,\n\t\t\tArgs: []string{\"-v\"},\n\t\t}\n\t\tupdatedConfig := rpc.MCPServerConfig{\n\t\t\tCommand: &nodeCmd,\n\t\t\tArgs: []string{\"--version\"},\n\t\t}\n\n\t\tinitial, err := client.RPC.Mcp.Config().List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Mcp.Config.List (initial) failed: %v\", err)\n\t\t}\n\t\tif _, present := initial.Servers[serverName]; present {\n\t\t\tt.Fatalf(\"Did not expect %q to be present initially\", serverName)\n\t\t}\n\n\t\t// Best-effort cleanup if a subtest assertion fails mid-flight.\n\t\tt.Cleanup(func() {\n\t\t\t_, _ = client.RPC.Mcp.Config().Remove(t.Context(), &rpc.MCPConfigRemoveRequest{Name: serverName})\n\t\t})\n\n\t\tif _, err := client.RPC.Mcp.Config().Add(t.Context(), &rpc.MCPConfigAddRequest{\n\t\t\tName: serverName,\n\t\t\tConfig: baseConfig,\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"Mcp.Config.Add failed: %v\", err)\n\t\t}\n\n\t\tafterAdd, err := client.RPC.Mcp.Config().List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Mcp.Config.List (after add) failed: %v\", err)\n\t\t}\n\t\tif _, present := afterAdd.Servers[serverName]; !present {\n\t\t\tt.Fatalf(\"Expected %q to be present after Add\", serverName)\n\t\t}\n\n\t\tif _, err := client.RPC.Mcp.Config().Update(t.Context(), &rpc.MCPConfigUpdateRequest{\n\t\t\tName: serverName,\n\t\t\tConfig: updatedConfig,\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"Mcp.Config.Update failed: %v\", err)\n\t\t}\n\n\t\tafterUpdate, err := client.RPC.Mcp.Config().List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Mcp.Config.List (after update) failed: %v\", err)\n\t\t}\n\t\tupdated, present := afterUpdate.Servers[serverName]\n\t\tif !present {\n\t\t\tt.Fatalf(\"Expected %q to still be present after Update\", serverName)\n\t\t}\n\t\tif updated.Command == nil || *updated.Command != \"node\" {\n\t\t\tt.Errorf(\"Expected command='node', got %v\", updated.Command)\n\t\t}\n\t\tif len(updated.Args) == 0 || updated.Args[0] != \"--version\" {\n\t\t\tt.Errorf(\"Expected args[0]='--version', got %v\", updated.Args)\n\t\t}\n\n\t\tif _, err := client.RPC.Mcp.Config().Disable(t.Context(), &rpc.MCPConfigDisableRequest{Names: []string{serverName}}); err != nil {\n\t\t\tt.Fatalf(\"Mcp.Config.Disable failed: %v\", err)\n\t\t}\n\t\tif _, err := client.RPC.Mcp.Config().Enable(t.Context(), &rpc.MCPConfigEnableRequest{Names: []string{serverName}}); err != nil {\n\t\t\tt.Fatalf(\"Mcp.Config.Enable failed: %v\", err)\n\t\t}\n\n\t\tif _, err := client.RPC.Mcp.Config().Remove(t.Context(), &rpc.MCPConfigRemoveRequest{Name: serverName}); err != nil {\n\t\t\tt.Fatalf(\"Mcp.Config.Remove failed: %v\", err)\n\t\t}\n\n\t\tafterRemove, err := client.RPC.Mcp.Config().List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Mcp.Config.List (after remove) failed: %v\", err)\n\t\t}\n\t\tif _, present := afterRemove.Servers[serverName]; present {\n\t\t\tt.Errorf(\"Expected %q to be removed\", serverName)\n\t\t}\n\t})\n\n\tt.Run(\"should round trip http mcp oauth config rpc\", func(t *testing.T) {\n\t\tctx := testharness.NewTestContext(t)\n\t\tclient := ctx.NewClient()\n\t\tt.Cleanup(func() { client.ForceStop() })\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Start failed: %v\", err)\n\t\t}\n\n\t\tserverName := fmt.Sprintf(\"sdk-http-oauth-%s\", randomHex(t))\n\n\t\thttpType := rpc.MCPServerConfigTypeHTTP\n\t\turlBase := \"https://example.com/mcp\"\n\t\turlUpdated := \"https://example.com/updated-mcp\"\n\t\tclientID := \"client-id\"\n\t\tclientIDUpdated := \"updated-client-id\"\n\t\tgrantClientCreds := rpc.MCPServerConfigHTTPOauthGrantTypeClientCredentials\n\t\tgrantAuthCode := rpc.MCPServerConfigHTTPOauthGrantTypeAuthorizationCode\n\t\tvar publicFalse = false\n\t\tvar publicTrue = true\n\t\tvar timeoutBase int64 = 3000\n\t\tvar timeoutUpdated int64 = 4000\n\n\t\tbaseConfig := rpc.MCPServerConfig{\n\t\t\tType: &httpType,\n\t\t\tURL: &urlBase,\n\t\t\tHeaders: map[string]string{\"Authorization\": \"Bearer token\"},\n\t\t\tOauthClientID: &clientID,\n\t\t\tOauthPublicClient: &publicFalse,\n\t\t\tOauthGrantType: &grantClientCreds,\n\t\t\tTools: []string{\"*\"},\n\t\t\tTimeout: &timeoutBase,\n\t\t}\n\t\tupdatedConfig := rpc.MCPServerConfig{\n\t\t\tType: &httpType,\n\t\t\tURL: &urlUpdated,\n\t\t\tOauthClientID: &clientIDUpdated,\n\t\t\tOauthPublicClient: &publicTrue,\n\t\t\tOauthGrantType: &grantAuthCode,\n\t\t\tTools: []string{\"updated-tool\"},\n\t\t\tTimeout: &timeoutUpdated,\n\t\t}\n\n\t\tt.Cleanup(func() {\n\t\t\t_, _ = client.RPC.Mcp.Config().Remove(t.Context(), &rpc.MCPConfigRemoveRequest{Name: serverName})\n\t\t})\n\n\t\tif _, err := client.RPC.Mcp.Config().Add(t.Context(), &rpc.MCPConfigAddRequest{\n\t\t\tName: serverName,\n\t\t\tConfig: baseConfig,\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"Mcp.Config.Add failed: %v\", err)\n\t\t}\n\n\t\tafterAdd, err := client.RPC.Mcp.Config().List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Mcp.Config.List (after add) failed: %v\", err)\n\t\t}\n\t\tadded, present := afterAdd.Servers[serverName]\n\t\tif !present {\n\t\t\tt.Fatalf(\"Expected %q to be present after Add\", serverName)\n\t\t}\n\t\tif added.Type == nil || *added.Type != \"http\" {\n\t\t\tt.Errorf(\"Expected type='http', got %v\", added.Type)\n\t\t}\n\t\tif added.URL == nil || *added.URL != \"https://example.com/mcp\" {\n\t\t\tt.Errorf(\"Expected url='https://example.com/mcp', got %v\", added.URL)\n\t\t}\n\t\tif got := added.Headers[\"Authorization\"]; got != \"Bearer token\" {\n\t\t\tt.Errorf(\"Expected Authorization='Bearer token', got %q\", got)\n\t\t}\n\t\tif added.OauthClientID == nil || *added.OauthClientID != \"client-id\" {\n\t\t\tt.Errorf(\"Expected oauthClientId='client-id', got %v\", added.OauthClientID)\n\t\t}\n\t\tif added.OauthPublicClient == nil || *added.OauthPublicClient {\n\t\t\tt.Errorf(\"Expected oauthPublicClient=false, got %v\", added.OauthPublicClient)\n\t\t}\n\t\tif added.OauthGrantType == nil || *added.OauthGrantType != \"client_credentials\" {\n\t\t\tt.Errorf(\"Expected oauthGrantType='client_credentials', got %v\", added.OauthGrantType)\n\t\t}\n\n\t\tif _, err := client.RPC.Mcp.Config().Update(t.Context(), &rpc.MCPConfigUpdateRequest{\n\t\t\tName: serverName,\n\t\t\tConfig: updatedConfig,\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"Mcp.Config.Update failed: %v\", err)\n\t\t}\n\t\tafterUpdate, err := client.RPC.Mcp.Config().List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Mcp.Config.List (after update) failed: %v\", err)\n\t\t}\n\t\tupdated, present := afterUpdate.Servers[serverName]\n\t\tif !present {\n\t\t\tt.Fatalf(\"Expected %q to still be present after Update\", serverName)\n\t\t}\n\t\tif updated.URL == nil || *updated.URL != \"https://example.com/updated-mcp\" {\n\t\t\tt.Errorf(\"Expected url='https://example.com/updated-mcp', got %v\", updated.URL)\n\t\t}\n\t\tif updated.OauthClientID == nil || *updated.OauthClientID != \"updated-client-id\" {\n\t\t\tt.Errorf(\"Expected oauthClientId='updated-client-id', got %v\", updated.OauthClientID)\n\t\t}\n\t\tif updated.OauthPublicClient == nil || !*updated.OauthPublicClient {\n\t\t\tt.Errorf(\"Expected oauthPublicClient=true, got %v\", updated.OauthPublicClient)\n\t\t}\n\t\tif updated.OauthGrantType == nil || *updated.OauthGrantType != \"authorization_code\" {\n\t\t\tt.Errorf(\"Expected oauthGrantType='authorization_code', got %v\", updated.OauthGrantType)\n\t\t}\n\t\tif len(updated.Tools) == 0 || updated.Tools[0] != \"updated-tool\" {\n\t\t\tt.Errorf(\"Expected tools[0]='updated-tool', got %v\", updated.Tools)\n\t\t}\n\t\tif updated.Timeout == nil || *updated.Timeout != 4000 {\n\t\t\tt.Errorf(\"Expected timeout=4000, got %v\", updated.Timeout)\n\t\t}\n\n\t\tif _, err := client.RPC.Mcp.Config().Remove(t.Context(), &rpc.MCPConfigRemoveRequest{Name: serverName}); err != nil {\n\t\t\tt.Fatalf(\"Mcp.Config.Remove failed: %v\", err)\n\t\t}\n\n\t\tafterRemove, err := client.RPC.Mcp.Config().List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Mcp.Config.List (after remove) failed: %v\", err)\n\t\t}\n\t\tif _, present := afterRemove.Servers[serverName]; present {\n\t\t\tt.Errorf(\"Expected %q to be removed\", serverName)\n\t\t}\n\t})\n}\n" }, { "path": "go/internal/e2e/rpc_server_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"fmt\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n\t\"github.com/github/copilot-sdk/go/rpc\"\n)\n\n// Mirrors dotnet/test/RpcServerTests.cs (snapshot category \"rpc_server\").\n// Tests server-scoped (non-session) RPCs.\nfunc TestRpcServerE2E(t *testing.T) {\n\tt.Run(\"should call rpc ping with typed params and result\", func(t *testing.T) {\n\t\tctx := testharness.NewTestContext(t)\n\t\tctx.ConfigureForTest(t)\n\t\tclient := ctx.NewClient()\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Start failed: %v\", err)\n\t\t}\n\n\t\tmessage := \"typed rpc test\"\n\t\tresult, err := client.RPC.Ping(t.Context(), &rpc.PingRequest{Message: &message})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"RPC.Ping failed: %v\", err)\n\t\t}\n\t\tif !strings.Contains(result.Message, \"typed rpc test\") {\n\t\t\tt.Errorf(\"Expected ping response to contain 'typed rpc test', got %q\", result.Message)\n\t\t}\n\t\tif result.Timestamp < 0 {\n\t\t\tt.Errorf(\"Expected non-negative Timestamp, got %d\", result.Timestamp)\n\t\t}\n\t})\n\n\tt.Run(\"should call rpc models list with typed result\", func(t *testing.T) {\n\t\tctx := testharness.NewTestContext(t)\n\t\tctx.ConfigureForTest(t)\n\t\tconst token = \"rpc-models-token\"\n\t\tregisterProxyUser(t, ctx, token, \"rpc-user\", nil)\n\t\tclient := newAuthenticatedClient(ctx, token)\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Start failed: %v\", err)\n\t\t}\n\n\t\tresult, err := client.RPC.Models.List(t.Context(), &rpc.ModelsListRequest{})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Models.List failed: %v\", err)\n\t\t}\n\t\tif result.Models == nil {\n\t\t\tt.Fatal(\"Expected non-nil Models list\")\n\t\t}\n\t\tvar hasClaude bool\n\t\tfor _, model := range result.Models {\n\t\t\tif strings.TrimSpace(model.Name) == \"\" {\n\t\t\t\tt.Errorf(\"Model %q has empty Name\", model.ID)\n\t\t\t}\n\t\t\tif model.ID == \"claude-sonnet-4.5\" {\n\t\t\t\thasClaude = true\n\t\t\t}\n\t\t}\n\t\tif !hasClaude {\n\t\t\tt.Errorf(\"Expected models list to contain 'claude-sonnet-4.5'\")\n\t\t}\n\t})\n\n\tt.Run(\"should call rpc account get quota when authenticated\", func(t *testing.T) {\n\t\tctx := testharness.NewTestContext(t)\n\t\tctx.ConfigureForTest(t)\n\t\tconst token = \"rpc-quota-token\"\n\t\tregisterProxyUser(t, ctx, token, \"rpc-user\", map[string]any{\n\t\t\t\"chat\": map[string]any{\n\t\t\t\t\"entitlement\": 100,\n\t\t\t\t\"overage_count\": 2,\n\t\t\t\t\"overage_permitted\": true,\n\t\t\t\t\"percent_remaining\": 75,\n\t\t\t\t\"timestamp_utc\": \"2026-04-30T00:00:00Z\",\n\t\t\t},\n\t\t})\n\t\tclient := newAuthenticatedClient(ctx, token)\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Start failed: %v\", err)\n\t\t}\n\n\t\ttokenCopy := token\n\t\tresult, err := client.RPC.Account.GetQuota(t.Context(), &rpc.AccountGetQuotaRequest{GitHubToken: &tokenCopy})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Account.GetQuota failed: %v\", err)\n\t\t}\n\t\tchat, present := result.QuotaSnapshots[\"chat\"]\n\t\tif !present {\n\t\t\tt.Fatalf(\"Expected 'chat' quota in snapshots, got %+v\", result.QuotaSnapshots)\n\t\t}\n\t\tif chat.EntitlementRequests != 100 {\n\t\t\tt.Errorf(\"Expected EntitlementRequests=100, got %d\", chat.EntitlementRequests)\n\t\t}\n\t\tif chat.UsedRequests != 25 {\n\t\t\tt.Errorf(\"Expected UsedRequests=25, got %d\", chat.UsedRequests)\n\t\t}\n\t\tif chat.RemainingPercentage != 75 {\n\t\t\tt.Errorf(\"Expected RemainingPercentage=75, got %v\", chat.RemainingPercentage)\n\t\t}\n\t\tif chat.Overage != 2 {\n\t\t\tt.Errorf(\"Expected Overage=2, got %v\", chat.Overage)\n\t\t}\n\t\tif !chat.UsageAllowedWithExhaustedQuota {\n\t\t\tt.Errorf(\"Expected UsageAllowedWithExhaustedQuota=true\")\n\t\t}\n\t\tif !chat.OverageAllowedWithExhaustedQuota {\n\t\t\tt.Errorf(\"Expected OverageAllowedWithExhaustedQuota=true\")\n\t\t}\n\t\tif chat.ResetDate == nil || *chat.ResetDate != \"2026-04-30T00:00:00Z\" {\n\t\t\tt.Errorf(\"Expected ResetDate='2026-04-30T00:00:00Z', got %v\", chat.ResetDate)\n\t\t}\n\t})\n\n\tt.Run(\"should call rpc tools list with typed result\", func(t *testing.T) {\n\t\tctx := testharness.NewTestContext(t)\n\t\tctx.ConfigureForTest(t)\n\t\tclient := ctx.NewClient()\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Start failed: %v\", err)\n\t\t}\n\n\t\tresult, err := client.RPC.Tools.List(t.Context(), &rpc.ToolsListRequest{})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Tools.List failed: %v\", err)\n\t\t}\n\t\tif len(result.Tools) == 0 {\n\t\t\tt.Fatal(\"Expected non-empty Tools list\")\n\t\t}\n\t\tfor i, tool := range result.Tools {\n\t\t\tif strings.TrimSpace(tool.Name) == \"\" {\n\t\t\t\tt.Errorf(\"Tool[%d] has empty Name\", i)\n\t\t\t}\n\t\t}\n\t})\n\n\tt.Run(\"should discover server mcp and skills\", func(t *testing.T) {\n\t\tctx := testharness.NewTestContext(t)\n\t\tctx.ConfigureForTest(t)\n\t\tclient := ctx.NewClient()\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tif err := client.Start(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Start failed: %v\", err)\n\t\t}\n\n\t\tskillName := fmt.Sprintf(\"server-rpc-skill-%s\", randomHex(t))\n\t\tskillsDir := createMcpSkillsRpcDirectory(t, ctx.WorkDir, \"server-rpc-skills\", skillName, \"Skill discovered by server-scoped RPC tests.\")\n\n\t\tworkingDir := ctx.WorkDir\n\t\tmcp, err := client.RPC.Mcp.Discover(t.Context(), &rpc.MCPDiscoverRequest{WorkingDirectory: &workingDir})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Mcp.Discover failed: %v\", err)\n\t\t}\n\t\tif mcp.Servers == nil {\n\t\t\tt.Errorf(\"Expected non-nil Servers\")\n\t\t}\n\n\t\tskills, err := client.RPC.Skills.Discover(t.Context(), &rpc.SkillsDiscoverRequest{SkillDirectories: []string{skillsDir}})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Skills.Discover failed: %v\", err)\n\t\t}\n\t\tdiscovered := findServerSkill(skills.Skills, skillName)\n\t\tif discovered == nil {\n\t\t\tt.Fatalf(\"Expected to discover skill %q\", skillName)\n\t\t}\n\t\tif discovered.Description != \"Skill discovered by server-scoped RPC tests.\" {\n\t\t\tt.Errorf(\"Expected description to match, got %q\", discovered.Description)\n\t\t}\n\t\tif !discovered.Enabled {\n\t\t\tt.Errorf(\"Expected discovered skill to be Enabled\")\n\t\t}\n\t\texpectedSuffix := filepath.Join(skillName, \"SKILL.md\")\n\t\tif discovered.Path == nil || !strings.HasSuffix(filepath.ToSlash(*discovered.Path), filepath.ToSlash(expectedSuffix)) {\n\t\t\tt.Errorf(\"Expected skill path to end with %q, got %v\", expectedSuffix, discovered.Path)\n\t\t}\n\n\t\t// Disable the skill globally and re-discover.\n\t\tif _, err := client.RPC.Skills.Config().SetDisabledSkills(t.Context(), &rpc.SkillsConfigSetDisabledSkillsRequest{\n\t\t\tDisabledSkills: []string{skillName},\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"Skills.Config.SetDisabledSkills failed: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() {\n\t\t\t_, _ = client.RPC.Skills.Config().SetDisabledSkills(t.Context(), &rpc.SkillsConfigSetDisabledSkillsRequest{\n\t\t\t\tDisabledSkills: []string{},\n\t\t\t})\n\t\t})\n\n\t\tdisabled, err := client.RPC.Skills.Discover(t.Context(), &rpc.SkillsDiscoverRequest{SkillDirectories: []string{skillsDir}})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Skills.Discover (after disable) failed: %v\", err)\n\t\t}\n\t\tdisabledSkill := findServerSkill(disabled.Skills, skillName)\n\t\tif disabledSkill == nil {\n\t\t\tt.Fatalf(\"Expected to find skill %q after disable\", skillName)\n\t\t}\n\t\tif disabledSkill.Enabled {\n\t\t\tt.Errorf(\"Expected skill %q to be Enabled=false after global disable\", skillName)\n\t\t}\n\t})\n}\n\n// newAuthenticatedClient builds a client that resolves auth through the test proxy.\nfunc newAuthenticatedClient(ctx *testharness.TestContext, token string) *copilot.Client {\n\treturn ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\topts.Env = append(opts.Env, \"COPILOT_DEBUG_GITHUB_API_URL=\"+ctx.ProxyURL)\n\t\topts.GitHubToken = token\n\t})\n}\n\n// registerProxyUser configures the proxy with a fake CopilotUser response for the given token.\nfunc registerProxyUser(t *testing.T, ctx *testharness.TestContext, token, login string, quotaSnapshots map[string]any) {\n\tt.Helper()\n\tuser := map[string]any{\n\t\t\"login\": login,\n\t\t\"copilot_plan\": \"individual_pro\",\n\t\t\"endpoints\": map[string]any{\"api\": ctx.ProxyURL, \"telemetry\": \"https://localhost:1/telemetry\"},\n\t\t\"analytics_tracking_id\": login + \"-tracking-id\",\n\t}\n\tif quotaSnapshots != nil {\n\t\tuser[\"quota_snapshots\"] = quotaSnapshots\n\t}\n\tif err := ctx.SetCopilotUserByToken(token, user); err != nil {\n\t\tt.Fatalf(\"SetCopilotUserByToken failed: %v\", err)\n\t}\n}\n\nfunc findServerSkill(skills []rpc.ServerSkill, name string) *rpc.ServerSkill {\n\tfor i, skill := range skills {\n\t\tif skill.Name == name {\n\t\t\treturn &skills[i]\n\t\t}\n\t}\n\treturn nil\n}\n" }, { "path": "go/internal/e2e/rpc_session_state_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"strings\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n\t\"github.com/github/copilot-sdk/go/rpc\"\n)\n\n// Mirrors dotnet/test/RpcSessionStateTests.cs (snapshot category \"rpc_session_state\").\n//\n// Reuses snapshot files in test/snapshots/rpc_session_state/. Tests that don't issue\n// LLM calls don't need snapshots.\nfunc TestRpcSessionStateE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tif err := client.Start(t.Context()); err != nil {\n\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t}\n\n\tt.Run(\"should call session rpc model getCurrent\", func(t *testing.T) {\n\t\tt.Skip(\"session.model.getCurrent not yet implemented in CLI\")\n\t})\n\n\tt.Run(\"should call session rpc model switchTo\", func(t *testing.T) {\n\t\tt.Skip(\"session.model.switchTo not yet implemented in CLI\")\n\t})\n\n\tt.Run(\"should get and set session mode\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tinitial, err := session.RPC.Mode.Get(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get mode: %v\", err)\n\t\t}\n\t\tif initial == nil || *initial != rpc.SessionModeInteractive {\n\t\t\tt.Errorf(\"Expected initial mode 'interactive', got %v\", initial)\n\t\t}\n\n\t\tif _, err := session.RPC.Mode.Set(t.Context(), &rpc.ModeSetRequest{Mode: rpc.SessionModePlan}); err != nil {\n\t\t\tt.Fatalf(\"Failed to set mode to plan: %v\", err)\n\t\t}\n\t\tafterPlan, err := session.RPC.Mode.Get(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get mode after plan: %v\", err)\n\t\t}\n\t\tif afterPlan == nil || *afterPlan != rpc.SessionModePlan {\n\t\t\tt.Errorf(\"Expected mode 'plan' after set, got %v\", afterPlan)\n\t\t}\n\n\t\tif _, err := session.RPC.Mode.Set(t.Context(), &rpc.ModeSetRequest{Mode: rpc.SessionModeInteractive}); err != nil {\n\t\t\tt.Fatalf(\"Failed to set mode to interactive: %v\", err)\n\t\t}\n\t\tfinal, err := session.RPC.Mode.Get(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get mode after revert: %v\", err)\n\t\t}\n\t\tif final == nil || *final != rpc.SessionModeInteractive {\n\t\t\tt.Errorf(\"Expected mode 'interactive' after revert, got %v\", final)\n\t\t}\n\t})\n\n\tt.Run(\"should read update and delete plan\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tinitial, err := session.RPC.Plan.Read(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to read plan: %v\", err)\n\t\t}\n\t\tif initial.Exists {\n\t\t\tt.Error(\"Expected plan to not exist initially\")\n\t\t}\n\t\tif initial.Content != nil {\n\t\t\tt.Error(\"Expected plan content to be nil initially\")\n\t\t}\n\n\t\tconst planContent = \"# Test Plan\\n\\n- Step 1\\n- Step 2\"\n\t\tif _, err := session.RPC.Plan.Update(t.Context(), &rpc.PlanUpdateRequest{Content: planContent}); err != nil {\n\t\t\tt.Fatalf(\"Failed to update plan: %v\", err)\n\t\t}\n\n\t\tafterUpdate, err := session.RPC.Plan.Read(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to read plan after update: %v\", err)\n\t\t}\n\t\tif !afterUpdate.Exists {\n\t\t\tt.Error(\"Expected plan to exist after update\")\n\t\t}\n\t\tif afterUpdate.Content == nil || *afterUpdate.Content != planContent {\n\t\t\tt.Errorf(\"Expected plan content %q, got %v\", planContent, afterUpdate.Content)\n\t\t}\n\n\t\tif _, err := session.RPC.Plan.Delete(t.Context()); err != nil {\n\t\t\tt.Fatalf(\"Failed to delete plan: %v\", err)\n\t\t}\n\n\t\tafterDelete, err := session.RPC.Plan.Read(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to read plan after delete: %v\", err)\n\t\t}\n\t\tif afterDelete.Exists {\n\t\t\tt.Error(\"Expected plan to not exist after delete\")\n\t\t}\n\t\tif afterDelete.Content != nil {\n\t\t\tt.Error(\"Expected plan content to be nil after delete\")\n\t\t}\n\t})\n\n\tt.Run(\"should call workspace file rpc methods\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tinitial, err := session.RPC.Workspaces.ListFiles(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to list workspace files: %v\", err)\n\t\t}\n\t\tif initial.Files == nil {\n\t\t\tt.Error(\"Expected workspace files slice to be non-nil\")\n\t\t}\n\n\t\tif _, err := session.RPC.Workspaces.CreateFile(t.Context(), &rpc.WorkspacesCreateFileRequest{\n\t\t\tPath: \"test.txt\",\n\t\t\tContent: \"Hello, workspace!\",\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"Failed to create workspace file: %v\", err)\n\t\t}\n\n\t\tafterCreate, err := session.RPC.Workspaces.ListFiles(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to list workspace files after create: %v\", err)\n\t\t}\n\t\tif !containsString(afterCreate.Files, \"test.txt\") {\n\t\t\tt.Errorf(\"Expected workspace files to contain 'test.txt', got %v\", afterCreate.Files)\n\t\t}\n\n\t\tfile, err := session.RPC.Workspaces.ReadFile(t.Context(), &rpc.WorkspacesReadFileRequest{Path: \"test.txt\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to read workspace file: %v\", err)\n\t\t}\n\t\tif file.Content != \"Hello, workspace!\" {\n\t\t\tt.Errorf(\"Expected file content 'Hello, workspace!', got %q\", file.Content)\n\t\t}\n\n\t\tworkspace, err := session.RPC.Workspaces.GetWorkspace(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get workspace: %v\", err)\n\t\t}\n\t\tif workspace.Workspace == nil {\n\t\t\tt.Fatal(\"Expected non-nil workspace metadata\")\n\t\t}\n\t\tif workspace.Workspace.ID == \"\" {\n\t\t\tt.Error(\"Expected workspace.ID to be non-empty\")\n\t\t}\n\t})\n\n\tt.Run(\"should get and set session metadata\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tif _, err := session.RPC.Name.Set(t.Context(), &rpc.NameSetRequest{Name: \"SDK test session\"}); err != nil {\n\t\t\tt.Fatalf(\"Failed to set session name: %v\", err)\n\t\t}\n\t\tname, err := session.RPC.Name.Get(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get session name: %v\", err)\n\t\t}\n\t\tif name.Name == nil || *name.Name != \"SDK test session\" {\n\t\t\tt.Errorf(\"Expected session name 'SDK test session', got %v\", name.Name)\n\t\t}\n\n\t\tsources, err := session.RPC.Instructions.GetSources(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get instruction sources: %v\", err)\n\t\t}\n\t\tif sources.Sources == nil {\n\t\t\tt.Error(\"Expected instructions.Sources to be non-nil\")\n\t\t}\n\t})\n\n\tt.Run(\"should fork session with persisted messages\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tconst sourcePrompt = \"Say FORK_SOURCE_ALPHA exactly.\"\n\t\tconst forkPrompt = \"Now say FORK_CHILD_BETA exactly.\"\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tinitialAnswer, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: sourcePrompt})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send sourcePrompt: %v\", err)\n\t\t}\n\t\tif assistant, ok := initialAnswer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(assistant.Content, \"FORK_SOURCE_ALPHA\") {\n\t\t\tt.Errorf(\"Expected initial answer to contain FORK_SOURCE_ALPHA, got %v\", initialAnswer.Data)\n\t\t}\n\n\t\tsourceMessages, err := session.GetMessages(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to read source messages: %v\", err)\n\t\t}\n\t\tsourceConversation := conversationMessages(sourceMessages)\n\t\tif !containsConversation(sourceConversation, \"user\", sourcePrompt, false) {\n\t\t\tt.Errorf(\"Expected source conversation to contain user message %q, got %v\", sourcePrompt, sourceConversation)\n\t\t}\n\t\tif !containsConversation(sourceConversation, \"assistant\", \"FORK_SOURCE_ALPHA\", true) {\n\t\t\tt.Errorf(\"Expected source conversation to contain assistant text 'FORK_SOURCE_ALPHA', got %v\", sourceConversation)\n\t\t}\n\n\t\tfork, err := client.RPC.Sessions.Fork(t.Context(), &rpc.SessionsForkRequest{SessionID: session.SessionID})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to fork session: %v\", err)\n\t\t}\n\t\tif strings.TrimSpace(fork.SessionID) == \"\" {\n\t\t\tt.Fatal(\"Expected non-empty fork session id\")\n\t\t}\n\t\tif fork.SessionID == session.SessionID {\n\t\t\tt.Errorf(\"Expected fork session id to differ from source %q\", session.SessionID)\n\t\t}\n\n\t\tforkedSession, err := client.ResumeSession(t.Context(), fork.SessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume forked session: %v\", err)\n\t\t}\n\n\t\tforkedMessages, err := forkedSession.GetMessages(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to read forked messages: %v\", err)\n\t\t}\n\t\tforkedConversation := conversationMessages(forkedMessages)\n\t\tif len(forkedConversation) < len(sourceConversation) {\n\t\t\tt.Fatalf(\"Expected forked conversation to include source conversation, got source=%v fork=%v\", sourceConversation, forkedConversation)\n\t\t}\n\t\tfor i := range sourceConversation {\n\t\t\tif forkedConversation[i] != sourceConversation[i] {\n\t\t\t\tt.Errorf(\"Forked conversation diverges at index %d: got %+v, expected %+v\", i, forkedConversation[i], sourceConversation[i])\n\t\t\t}\n\t\t}\n\n\t\tforkAnswer, err := forkedSession.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: forkPrompt})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send forkPrompt to fork: %v\", err)\n\t\t}\n\t\tif assistant, ok := forkAnswer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(assistant.Content, \"FORK_CHILD_BETA\") {\n\t\t\tt.Errorf(\"Expected forked answer to contain FORK_CHILD_BETA, got %v\", forkAnswer.Data)\n\t\t}\n\n\t\tsourceAfterFork, err := session.GetMessages(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to read source messages after fork: %v\", err)\n\t\t}\n\t\tfor _, m := range conversationMessages(sourceAfterFork) {\n\t\t\tif m.content == forkPrompt {\n\t\t\t\tt.Errorf(\"Source conversation should not contain fork prompt %q after fork\", forkPrompt)\n\t\t\t}\n\t\t}\n\n\t\tforkAfterPrompt, err := forkedSession.GetMessages(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to read forked messages after prompt: %v\", err)\n\t\t}\n\t\tforkConv := conversationMessages(forkAfterPrompt)\n\t\tif !containsConversation(forkConv, \"user\", forkPrompt, false) {\n\t\t\tt.Errorf(\"Expected fork conversation to contain user prompt %q, got %v\", forkPrompt, forkConv)\n\t\t}\n\t\tif !containsConversation(forkConv, \"assistant\", \"FORK_CHILD_BETA\", true) {\n\t\t\tt.Errorf(\"Expected fork conversation to contain assistant text 'FORK_CHILD_BETA', got %v\", forkConv)\n\t\t}\n\n\t\tforkedSession.Disconnect()\n\t})\n\n\tt.Run(\"should report error when forking session without persisted events\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = client.RPC.Sessions.Fork(t.Context(), &rpc.SessionsForkRequest{SessionID: session.SessionID})\n\t\tif err == nil {\n\t\t\tt.Fatal(\"Expected fork on empty session to fail\")\n\t\t}\n\t\tif !strings.Contains(strings.ToLower(err.Error()), \"not found or has no persisted events\") {\n\t\t\tt.Errorf(\"Expected error mentioning 'not found or has no persisted events', got %v\", err)\n\t\t}\n\t\tif strings.Contains(strings.ToLower(err.Error()), \"unhandled method sessions.fork\") {\n\t\t\tt.Errorf(\"sessions.fork should be implemented; error suggests it isn't: %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should call session usage and permission rpcs\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tmetrics, err := session.RPC.Usage.GetMetrics(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get usage metrics: %v\", err)\n\t\t}\n\t\tif metrics.SessionStartTime <= 0 {\n\t\t\tt.Errorf(\"Expected positive sessionStartTime, got %d\", metrics.SessionStartTime)\n\t\t}\n\t\tif metrics.TotalNanoAiu != nil && *metrics.TotalNanoAiu < 0 {\n\t\t\tt.Errorf(\"Expected non-negative totalNanoAiu, got %d\", *metrics.TotalNanoAiu)\n\t\t}\n\t\tfor k, detail := range metrics.TokenDetails {\n\t\t\tif detail.TokenCount < 0 {\n\t\t\t\tt.Errorf(\"Expected non-negative tokenCount for %q, got %d\", k, detail.TokenCount)\n\t\t\t}\n\t\t}\n\t\tfor modelName, modelMetric := range metrics.ModelMetrics {\n\t\t\tif modelMetric.TotalNanoAiu != nil && *modelMetric.TotalNanoAiu < 0 {\n\t\t\t\tt.Errorf(\"Expected non-negative totalNanoAiu for model %q, got %d\", modelName, *modelMetric.TotalNanoAiu)\n\t\t\t}\n\t\t\tfor tokenType, detail := range modelMetric.TokenDetails {\n\t\t\t\tif detail.TokenCount < 0 {\n\t\t\t\t\tt.Errorf(\"Expected non-negative tokenCount for model %q type %q, got %d\", modelName, tokenType, detail.TokenCount)\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tapprove, err := session.RPC.Permissions.SetApproveAll(t.Context(), &rpc.PermissionsSetApproveAllRequest{Enabled: true})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to call SetApproveAll(true): %v\", err)\n\t\t}\n\t\tif !approve.Success {\n\t\t\tt.Errorf(\"Expected SetApproveAll(true) to succeed, got %+v\", approve)\n\t\t}\n\n\t\treset, err := session.RPC.Permissions.ResetSessionApprovals(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to call ResetSessionApprovals: %v\", err)\n\t\t}\n\t\tif !reset.Success {\n\t\t\tt.Errorf(\"Expected ResetSessionApprovals to succeed, got %+v\", reset)\n\t\t}\n\n\t\t// Restore.\n\t\tif _, err := session.RPC.Permissions.SetApproveAll(t.Context(), &rpc.PermissionsSetApproveAllRequest{Enabled: false}); err != nil {\n\t\t\tt.Errorf(\"Failed to restore SetApproveAll(false): %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should report implemented errors for unsupported session rpc paths\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.RPC.History.Truncate(t.Context(), &rpc.HistoryTruncateRequest{EventID: \"missing-event\"})\n\t\tif err == nil {\n\t\t\tt.Fatal(\"Expected History.Truncate with unknown event id to fail\")\n\t\t}\n\t\tif strings.Contains(strings.ToLower(err.Error()), \"unhandled method session.history.truncate\") {\n\t\t\tt.Errorf(\"session.history.truncate should be implemented; error suggests it isn't: %v\", err)\n\t\t}\n\n\t\t_, err = session.RPC.Mcp.Oauth().Login(t.Context(), &rpc.MCPOauthLoginRequest{ServerName: \"missing-server\"})\n\t\tif err == nil {\n\t\t\tt.Fatal(\"Expected Mcp.Oauth.Login with unknown server to fail\")\n\t\t}\n\t\tif strings.Contains(strings.ToLower(err.Error()), \"unhandled method session.mcp.oauth.login\") {\n\t\t\tt.Errorf(\"session.mcp.oauth.login should be implemented; error suggests it isn't: %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should compact session history after messages\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tif _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 2+2?\"}); err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tresult, err := session.RPC.History.Compact(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to compact session: %v\", err)\n\t\t}\n\t\tif result == nil {\n\t\t\tt.Fatal(\"Expected non-nil compaction result\")\n\t\t}\n\t})\n}\n\ntype roleContent struct {\n\trole string\n\tcontent string\n}\n\nfunc conversationMessages(events []copilot.SessionEvent) []roleContent {\n\tvar msgs []roleContent\n\tfor _, evt := range events {\n\t\tswitch d := evt.Data.(type) {\n\t\tcase *copilot.UserMessageData:\n\t\t\tmsgs = append(msgs, roleContent{role: \"user\", content: d.Content})\n\t\tcase *copilot.AssistantMessageData:\n\t\t\tmsgs = append(msgs, roleContent{role: \"assistant\", content: d.Content})\n\t\t}\n\t}\n\treturn msgs\n}\n\nfunc containsConversation(msgs []roleContent, role, contentNeedle string, contains bool) bool {\n\tfor _, m := range msgs {\n\t\tif m.role != role {\n\t\t\tcontinue\n\t\t}\n\t\tif contains {\n\t\t\tif strings.Contains(m.content, contentNeedle) {\n\t\t\t\treturn true\n\t\t\t}\n\t\t} else if m.content == contentNeedle {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n" }, { "path": "go/internal/e2e/rpc_shell_and_fleet_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"crypto/rand\"\n\t\"encoding/hex\"\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"runtime\"\n\t\"strings\"\n\t\"testing\"\n\t\"time\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n\t\"github.com/github/copilot-sdk/go/rpc\"\n)\n\n// Mirrors dotnet/test/RpcShellAndFleetTests.cs (snapshot category \"rpc_shell_and_fleet\").\nfunc TestRpcShellAndFleetE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"should execute shell command\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tmarkerPath := filepath.Join(ctx.WorkDir, \"shell-rpc-\"+randomHex(t)+\".txt\")\n\t\tconst marker = \"copilot-sdk-shell-rpc\"\n\n\t\tcwd := ctx.WorkDir\n\t\tresult, err := session.RPC.Shell.Exec(t.Context(), &rpc.ShellExecRequest{\n\t\t\tCommand: writeFileCommand(markerPath, marker),\n\t\t\tCwd: &cwd,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to call session.shell.exec: %v\", err)\n\t\t}\n\t\tif strings.TrimSpace(result.ProcessID) == \"\" {\n\t\t\tt.Fatal(\"Expected non-empty processId from shell.exec\")\n\t\t}\n\n\t\twaitForFileText(t, markerPath, marker)\n\t})\n\n\tt.Run(\"should kill shell process\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tvar command string\n\t\tif runtime.GOOS == \"windows\" {\n\t\t\tcommand = \"powershell -NoLogo -NoProfile -Command \\\"Start-Sleep -Seconds 30\\\"\"\n\t\t} else {\n\t\t\tcommand = \"sleep 30\"\n\t\t}\n\n\t\texec, err := session.RPC.Shell.Exec(t.Context(), &rpc.ShellExecRequest{Command: command})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to call session.shell.exec: %v\", err)\n\t\t}\n\t\tif strings.TrimSpace(exec.ProcessID) == \"\" {\n\t\t\tt.Fatal(\"Expected non-empty processId from shell.exec\")\n\t\t}\n\n\t\tkill, err := session.RPC.Shell.Kill(t.Context(), &rpc.ShellKillRequest{ProcessID: exec.ProcessID})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to call session.shell.kill: %v\", err)\n\t\t}\n\t\tif !kill.Killed {\n\t\t\tt.Errorf(\"Expected shell.kill to report Killed=true, got %+v\", kill)\n\t\t}\n\t})\n\n\tt.Run(\"should start fleet and complete custom tool task\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tmarkerPath := filepath.Join(ctx.WorkDir, \"fleet-rpc-\"+randomHex(t)+\".txt\")\n\t\tconst marker = \"copilot-sdk-fleet-rpc\"\n\t\tconst toolName = \"record_fleet_completion\"\n\n\t\ttype RecordParams struct {\n\t\t\tContent string `json:\"content\" jsonschema:\"Content to record\"`\n\t\t}\n\t\trecordTool := copilot.DefineTool(toolName, \"Records completion of the fleet validation task.\",\n\t\t\tfunc(params RecordParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\tif err := os.WriteFile(markerPath, []byte(params.Content), 0644); err != nil {\n\t\t\t\t\treturn \"\", err\n\t\t\t\t}\n\t\t\t\treturn params.Content, nil\n\t\t\t})\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tTools: []copilot.Tool{recordTool},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tprompt := fmt.Sprintf(\"Use the %s tool with content '%s', then report that the fleet task is complete.\", toolName, marker)\n\t\tpromptCopy := prompt\n\n\t\tfleet, err := session.RPC.Fleet.Start(t.Context(), &rpc.FleetStartRequest{Prompt: &promptCopy})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to call session.fleet.start: %v\", err)\n\t\t}\n\t\tif !fleet.Started {\n\t\t\tt.Fatal(\"Expected fleet.start to report Started=true\")\n\t\t}\n\n\t\twaitForFileText(t, markerPath, marker)\n\n\t\t// Fleet-mode tasks do not emit SessionIdleEvent; poll session messages until the\n\t\t// assistant reply contains the expected text.\n\t\tmessages := waitForFleetCompletion(t, session, \"fleet task\")\n\n\t\tvar sawUser, sawAssistant bool\n\t\tvar sawToolStart, sawToolComplete bool\n\t\tfor _, evt := range messages {\n\t\t\tswitch d := evt.Data.(type) {\n\t\t\tcase *copilot.UserMessageData:\n\t\t\t\tif strings.Contains(d.Content, prompt) {\n\t\t\t\t\tsawUser = true\n\t\t\t\t}\n\t\t\tcase *copilot.AssistantMessageData:\n\t\t\t\tif strings.Contains(strings.ToLower(d.Content), \"fleet task\") {\n\t\t\t\t\tsawAssistant = true\n\t\t\t\t}\n\t\t\tcase *copilot.ToolExecutionStartData:\n\t\t\t\tif d.ToolName == toolName {\n\t\t\t\t\tsawToolStart = true\n\t\t\t\t}\n\t\t\tcase *copilot.ToolExecutionCompleteData:\n\t\t\t\tif d.Success && d.Result != nil && strings.Contains(d.Result.Content, marker) {\n\t\t\t\t\tsawToolComplete = true\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif !sawUser {\n\t\t\tt.Errorf(\"Expected user message containing original prompt; messages: %d\", len(messages))\n\t\t}\n\t\tif !sawAssistant {\n\t\t\tt.Errorf(\"Expected assistant message containing 'fleet task'\")\n\t\t}\n\t\tif !sawToolStart {\n\t\t\tt.Errorf(\"Expected ToolExecutionStart for %q\", toolName)\n\t\t}\n\t\tif !sawToolComplete {\n\t\t\tt.Errorf(\"Expected successful ToolExecutionComplete with content containing %q\", marker)\n\t\t}\n\t})\n}\n\nfunc randomHex(t *testing.T) string {\n\tt.Helper()\n\tvar buf [8]byte\n\tif _, err := rand.Read(buf[:]); err != nil {\n\t\tt.Fatalf(\"Failed to generate random bytes: %v\", err)\n\t}\n\treturn hex.EncodeToString(buf[:])\n}\n\nfunc writeFileCommand(markerPath, marker string) string {\n\tif runtime.GOOS == \"windows\" {\n\t\treturn fmt.Sprintf(\"powershell -NoLogo -NoProfile -Command \\\"Set-Content -LiteralPath '%s' -Value '%s'\\\"\", markerPath, marker)\n\t}\n\treturn fmt.Sprintf(\"sh -c \\\"printf '%%s' '%s' > '%s'\\\"\", marker, markerPath)\n}\n\nfunc waitForFileText(t *testing.T, path, expected string) {\n\tt.Helper()\n\tdeadline := time.Now().Add(30 * time.Second)\n\tfor time.Now().Before(deadline) {\n\t\tif data, err := os.ReadFile(path); err == nil && strings.Contains(string(data), expected) {\n\t\t\treturn\n\t\t}\n\t\ttime.Sleep(100 * time.Millisecond)\n\t}\n\tt.Fatalf(\"Timed out waiting for shell command to write %q to %q\", expected, path)\n}\n\nfunc waitForFleetCompletion(t *testing.T, session *copilot.Session, contentNeedle string) []copilot.SessionEvent {\n\tt.Helper()\n\tdeadline := time.Now().Add(120 * time.Second)\n\tfor time.Now().Before(deadline) {\n\t\tmessages, err := session.GetMessages(t.Context())\n\t\tif err == nil {\n\t\t\tfor _, evt := range messages {\n\t\t\t\tif d, ok := evt.Data.(*copilot.AssistantMessageData); ok && strings.Contains(strings.ToLower(d.Content), contentNeedle) {\n\t\t\t\t\treturn messages\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\ttime.Sleep(250 * time.Millisecond)\n\t}\n\tt.Fatal(\"Timed out waiting for fleet-mode assistant reply\")\n\treturn nil\n}\n" }, { "path": "go/internal/e2e/rpc_tasks_and_handlers_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"strings\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n\t\"github.com/github/copilot-sdk/go/rpc\"\n)\n\n// Mirrors dotnet/test/RpcTasksAndHandlersTests.cs (snapshot category \"rpc_tasks_and_handlers\").\nfunc TestRpcTasksAndHandlersE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"should list task state and return false for missing task operations\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\ttasks, err := session.RPC.Tasks.List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Tasks.List failed: %v\", err)\n\t\t}\n\t\tif tasks.Tasks == nil {\n\t\t\tt.Error(\"Expected non-nil Tasks list\")\n\t\t}\n\t\tif len(tasks.Tasks) != 0 {\n\t\t\tt.Errorf(\"Expected empty Tasks list, got %d tasks\", len(tasks.Tasks))\n\t\t}\n\n\t\tpromote, err := session.RPC.Tasks.PromoteToBackground(t.Context(), &rpc.TasksPromoteToBackgroundRequest{ID: \"missing-task\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"PromoteToBackground failed: %v\", err)\n\t\t}\n\t\tif promote.Promoted {\n\t\t\tt.Error(\"Expected Promoted=false for missing task\")\n\t\t}\n\n\t\tcancel, err := session.RPC.Tasks.Cancel(t.Context(), &rpc.TasksCancelRequest{ID: \"missing-task\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Cancel failed: %v\", err)\n\t\t}\n\t\tif cancel.Cancelled {\n\t\t\tt.Error(\"Expected Cancelled=false for missing task\")\n\t\t}\n\n\t\tremove, err := session.RPC.Tasks.Remove(t.Context(), &rpc.TasksRemoveRequest{ID: \"missing-task\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Remove failed: %v\", err)\n\t\t}\n\t\tif remove.Removed {\n\t\t\tt.Error(\"Expected Removed=false for missing task\")\n\t\t}\n\t})\n\n\tt.Run(\"should report implemented error for missing task agent type\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\t_, err = session.RPC.Tasks.StartAgent(t.Context(), &rpc.TasksStartAgentRequest{\n\t\t\tAgentType: \"missing-agent-type\",\n\t\t\tPrompt: \"Say hi\",\n\t\t\tName: \"sdk-test-task\",\n\t\t})\n\t\tif err == nil {\n\t\t\tt.Fatal(\"Expected an error for missing agent type\")\n\t\t}\n\t\tif strings.Contains(strings.ToLower(err.Error()), \"unhandled method session.tasks.startagent\") {\n\t\t\tt.Errorf(\"Expected an implemented error, but the method appears unhandled: %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should return expected results for missing pending handler request ids\", func(t *testing.T) {\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\ttool, err := session.RPC.Tools.HandlePendingToolCall(t.Context(), &rpc.HandlePendingToolCallRequest{\n\t\t\tRequestID: \"missing-tool-request\",\n\t\t\tResult: &rpc.ExternalToolResult{String: copilot.String(\"tool result\")},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Tools.HandlePendingToolCall failed: %v\", err)\n\t\t}\n\t\tif tool.Success {\n\t\t\tt.Error(\"Expected Success=false for missing tool request id\")\n\t\t}\n\n\t\tcommandErr := \"command error\"\n\t\tcommand, err := session.RPC.Commands.HandlePendingCommand(t.Context(), &rpc.CommandsHandlePendingCommandRequest{\n\t\t\tRequestID: \"missing-command-request\",\n\t\t\tError: &commandErr,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Commands.HandlePendingCommand failed: %v\", err)\n\t\t}\n\t\t// Per dotnet RpcTasksAndHandlersTests, missing command requests return Success=true.\n\t\tif !command.Success {\n\t\t\tt.Error(\"Expected Success=true for missing command request id\")\n\t\t}\n\n\t\telicitation, err := session.RPC.UI.HandlePendingElicitation(t.Context(), &rpc.UIHandlePendingElicitationRequest{\n\t\t\tRequestID: \"missing-elicitation-request\",\n\t\t\tResult: rpc.UIElicitationResponse{Action: rpc.UIElicitationResponseActionCancel},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"UI.HandlePendingElicitation failed: %v\", err)\n\t\t}\n\t\tif elicitation.Success {\n\t\t\tt.Error(\"Expected Success=false for missing elicitation request id\")\n\t\t}\n\n\t\tfeedback := \"not approved\"\n\t\tpermission, err := session.RPC.Permissions.HandlePendingPermissionRequest(t.Context(), &rpc.PermissionDecisionRequest{\n\t\t\tRequestID: \"missing-permission-request\",\n\t\t\tResult: rpc.PermissionDecision{\n\t\t\t\tKind: rpc.PermissionDecisionKindReject,\n\t\t\t\tFeedback: &feedback,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Permissions.HandlePendingPermissionRequest (reject) failed: %v\", err)\n\t\t}\n\t\tif permission.Success {\n\t\t\tt.Error(\"Expected Success=false for missing permission request id\")\n\t\t}\n\n\t\tdomain := \"example.com\"\n\t\tpermanent, err := session.RPC.Permissions.HandlePendingPermissionRequest(t.Context(), &rpc.PermissionDecisionRequest{\n\t\t\tRequestID: \"missing-permanent-permission-request\",\n\t\t\tResult: rpc.PermissionDecision{\n\t\t\t\tKind: rpc.PermissionDecisionKindApprovePermanently,\n\t\t\t\tDomain: &domain,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Permissions.HandlePendingPermissionRequest (approve-permanently) failed: %v\", err)\n\t\t}\n\t\tif permanent.Success {\n\t\t\tt.Error(\"Expected Success=false for missing permanent permission request id\")\n\t\t}\n\t})\n}\n" }, { "path": "go/internal/e2e/session_config_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"crypto/rand\"\n\t\"encoding/base64\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\n// hasImageURLContent returns true if any user message in the given exchanges\n// contains an image_url content part (multimodal vision content).\nfunc hasImageURLContent(exchanges []testharness.ParsedHttpExchange) bool {\n\tfor _, ex := range exchanges {\n\t\tfor _, msg := range ex.Request.Messages {\n\t\t\tif msg.Role == \"user\" && len(msg.RawContent) > 0 {\n\t\t\t\tvar content []interface{}\n\t\t\t\tif json.Unmarshal(msg.RawContent, &content) == nil {\n\t\t\t\t\tfor _, part := range content {\n\t\t\t\t\t\tif m, ok := part.(map[string]interface{}); ok {\n\t\t\t\t\t\t\tif m[\"type\"] == \"image_url\" {\n\t\t\t\t\t\t\t\treturn true\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn false\n}\n\nfunc TestSessionConfigE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tif err := client.Start(t.Context()); err != nil {\n\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t}\n\n\t// Write 1x1 PNG to the work directory\n\tpng1x1, err := base64.StdEncoding.DecodeString(\"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\")\n\tif err != nil {\n\t\tt.Fatalf(\"Failed to decode PNG: %v\", err)\n\t}\n\tif err := os.WriteFile(filepath.Join(ctx.WorkDir, \"test.png\"), png1x1, 0644); err != nil {\n\t\tt.Fatalf(\"Failed to write test.png: %v\", err)\n\t}\n\n\tviewImagePrompt := \"Use the view tool to look at the file test.png and describe what you see\"\n\n\tt.Run(\"vision disabled then enabled via setModel\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tModelCapabilities: &copilot.ModelCapabilitiesOverride{\n\t\t\t\tSupports: &copilot.ModelCapabilitiesOverrideSupports{\n\t\t\t\t\tVision: copilot.Bool(false),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Turn 1: vision off — no image_url expected\n\t\tif _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: viewImagePrompt}); err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\ttrafficAfterT1, err := ctx.GetExchanges()\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get exchanges: %v\", err)\n\t\t}\n\t\tif hasImageURLContent(trafficAfterT1) {\n\t\t\tt.Error(\"Expected no image_url content parts when vision is disabled\")\n\t\t}\n\n\t\t// Switch vision on\n\t\tif err := session.SetModel(t.Context(), \"claude-sonnet-4.5\", &copilot.SetModelOptions{\n\t\t\tModelCapabilities: &copilot.ModelCapabilitiesOverride{\n\t\t\t\tSupports: &copilot.ModelCapabilitiesOverrideSupports{\n\t\t\t\t\tVision: copilot.Bool(true),\n\t\t\t\t},\n\t\t\t},\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"SetModel returned error: %v\", err)\n\t\t}\n\n\t\t// Turn 2: vision on — image_url expected in new exchanges\n\t\tif _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: viewImagePrompt}); err != nil {\n\t\t\tt.Fatalf(\"Failed to send second message: %v\", err)\n\t\t}\n\n\t\ttrafficAfterT2, err := ctx.GetExchanges()\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get exchanges after turn 2: %v\", err)\n\t\t}\n\t\tnewExchanges := trafficAfterT2[len(trafficAfterT1):]\n\t\tif !hasImageURLContent(newExchanges) {\n\t\t\tt.Error(\"Expected image_url content parts when vision is enabled\")\n\t\t}\n\t})\n\n\tt.Run(\"vision enabled then disabled via setModel\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tModelCapabilities: &copilot.ModelCapabilitiesOverride{\n\t\t\t\tSupports: &copilot.ModelCapabilitiesOverrideSupports{\n\t\t\t\t\tVision: copilot.Bool(true),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Turn 1: vision on — image_url expected\n\t\tif _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: viewImagePrompt}); err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\ttrafficAfterT1, err := ctx.GetExchanges()\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get exchanges: %v\", err)\n\t\t}\n\t\tif !hasImageURLContent(trafficAfterT1) {\n\t\t\tt.Error(\"Expected image_url content parts when vision is enabled\")\n\t\t}\n\n\t\t// Switch vision off\n\t\tif err := session.SetModel(t.Context(), \"claude-sonnet-4.5\", &copilot.SetModelOptions{\n\t\t\tModelCapabilities: &copilot.ModelCapabilitiesOverride{\n\t\t\t\tSupports: &copilot.ModelCapabilitiesOverrideSupports{\n\t\t\t\t\tVision: copilot.Bool(false),\n\t\t\t\t},\n\t\t\t},\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"SetModel returned error: %v\", err)\n\t\t}\n\n\t\t// Turn 2: vision off — no image_url expected in new exchanges\n\t\tif _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: viewImagePrompt}); err != nil {\n\t\t\tt.Fatalf(\"Failed to send second message: %v\", err)\n\t\t}\n\n\t\ttrafficAfterT2, err := ctx.GetExchanges()\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get exchanges after turn 2: %v\", err)\n\t\t}\n\t\tnewExchanges := trafficAfterT2[len(trafficAfterT1):]\n\t\tif hasImageURLContent(newExchanges) {\n\t\t\tt.Error(\"Expected no image_url content parts when vision is disabled\")\n\t\t}\n\t})\n}\n\n// TestSessionConfigExtras mirrors the additional Should_* tests in dotnet/test/SessionConfigTests.cs:\n//\n//\tShould_Use_Custom_SessionId\n//\tShould_Forward_ClientName_In_UserAgent\n//\tShould_Forward_Custom_Provider_Headers_On_Create\n//\tShould_Forward_Custom_Provider_Headers_On_Resume\n//\tShould_Use_WorkingDirectory_For_Tool_Execution\n//\tShould_Apply_WorkingDirectory_On_Session_Resume\n//\tShould_Apply_SystemMessage_On_Session_Resume\n//\tShould_Apply_AvailableTools_On_Session_Resume\nfunc TestSessionConfigExtrasE2E(t *testing.T) {\n\tconst providerHeaderName = \"x-copilot-sdk-provider-header\"\n\tconst clientName = \"go-public-surface-client\"\n\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tif err := client.Start(t.Context()); err != nil {\n\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t}\n\n\tt.Run(\"should use custom sessionId\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\trequestedSessionID := newUUID(t)\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tSessionID: requestedSessionID,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\t\tif session.SessionID != requestedSessionID {\n\t\t\tt.Errorf(\"Expected SessionID=%q, got %q\", requestedSessionID, session.SessionID)\n\t\t}\n\n\t\tmessages, err := session.GetMessages(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"GetMessages failed: %v\", err)\n\t\t}\n\t\tif len(messages) == 0 || messages[0].Type != copilot.SessionEventTypeSessionStart {\n\t\t\tt.Fatalf(\"Expected first event to be session.start, got %+v\", messages)\n\t\t}\n\t\tstartData := messages[0].Data.(*copilot.SessionStartData)\n\t\tif startData.SessionID != requestedSessionID {\n\t\t\tt.Errorf(\"Expected start.SessionID=%q, got %q\", requestedSessionID, startData.SessionID)\n\t\t}\n\t})\n\n\tt.Run(\"should forward clientName in userAgent\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tClientName: clientName,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 1+1?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\texchanges, err := ctx.GetExchanges()\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"GetExchanges failed: %v\", err)\n\t\t}\n\t\tif len(exchanges) != 1 {\n\t\t\tt.Fatalf(\"Expected exactly 1 exchange, got %d\", len(exchanges))\n\t\t}\n\t\tif !exchangeHasHeader(exchanges[0], \"user-agent\", clientName) {\n\t\t\tt.Errorf(\"Expected user-agent to contain %q, got %v\", clientName, exchanges[0].RequestHeaders)\n\t\t}\n\t})\n\n\tt.Run(\"should forward custom provider headers on create\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tModel: \"claude-sonnet-4.5\",\n\t\t\tProvider: createProxyProvider(ctx, providerHeaderName, \"create-provider-header\"),\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tmessage, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 1+1?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\t\tif !assistantMessageContains(message, \"2\") {\n\t\t\tt.Errorf(\"Expected response to contain '2', got %v\", message)\n\t\t}\n\n\t\texchanges, err := ctx.GetExchanges()\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"GetExchanges failed: %v\", err)\n\t\t}\n\t\tif len(exchanges) != 1 {\n\t\t\tt.Fatalf(\"Expected exactly 1 exchange, got %d\", len(exchanges))\n\t\t}\n\t\tif !exchangeHasHeader(exchanges[0], \"authorization\", \"Bearer test-provider-key\") {\n\t\t\tt.Errorf(\"Expected authorization header to contain 'Bearer test-provider-key', got %v\", exchanges[0].RequestHeaders)\n\t\t}\n\t\tif !exchangeHasHeader(exchanges[0], providerHeaderName, \"create-provider-header\") {\n\t\t\tt.Errorf(\"Expected %s header to contain 'create-provider-header', got %v\", providerHeaderName, exchanges[0].RequestHeaders)\n\t\t}\n\t})\n\n\tt.Run(\"should forward custom provider headers on resume\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession1, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\t\tsessionID := session1.SessionID\n\t\tt.Cleanup(func() { _ = session1.Disconnect() })\n\n\t\tsession2, err := client.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tModel: \"claude-sonnet-4.5\",\n\t\t\tProvider: createProxyProvider(ctx, providerHeaderName, \"resume-provider-header\"),\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"ResumeSession failed: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = session2.Disconnect() })\n\n\t\tmessage, err := session2.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 2+2?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\t\tif !assistantMessageContains(message, \"4\") {\n\t\t\tt.Errorf(\"Expected response to contain '4', got %v\", message)\n\t\t}\n\n\t\texchanges, err := ctx.GetExchanges()\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"GetExchanges failed: %v\", err)\n\t\t}\n\t\tif len(exchanges) != 1 {\n\t\t\tt.Fatalf(\"Expected exactly 1 exchange, got %d\", len(exchanges))\n\t\t}\n\t\tif !exchangeHasHeader(exchanges[0], \"authorization\", \"Bearer test-provider-key\") {\n\t\t\tt.Errorf(\"Expected authorization header to contain 'Bearer test-provider-key', got %v\", exchanges[0].RequestHeaders)\n\t\t}\n\t\tif !exchangeHasHeader(exchanges[0], providerHeaderName, \"resume-provider-header\") {\n\t\t\tt.Errorf(\"Expected %s header to contain 'resume-provider-header', got %v\", providerHeaderName, exchanges[0].RequestHeaders)\n\t\t}\n\t})\n\n\tt.Run(\"should use workingDirectory for tool execution\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsubDir := filepath.Join(ctx.WorkDir, \"subproject\")\n\t\tif err := os.MkdirAll(subDir, 0755); err != nil {\n\t\t\tt.Fatalf(\"MkdirAll failed: %v\", err)\n\t\t}\n\t\tif err := os.WriteFile(filepath.Join(subDir, \"marker.txt\"), []byte(\"I am in the subdirectory\"), 0644); err != nil {\n\t\t\tt.Fatalf(\"WriteFile failed: %v\", err)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tWorkingDirectory: subDir,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tmessage, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Read the file marker.txt and tell me what it says\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\t\tif !assistantMessageContains(message, \"subdirectory\") {\n\t\t\tt.Errorf(\"Expected response to contain 'subdirectory', got %v\", message)\n\t\t}\n\t})\n\n\tt.Run(\"should apply workingDirectory on session resume\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsubDir := filepath.Join(ctx.WorkDir, \"resume-subproject\")\n\t\tif err := os.MkdirAll(subDir, 0755); err != nil {\n\t\t\tt.Fatalf(\"MkdirAll failed: %v\", err)\n\t\t}\n\t\tif err := os.WriteFile(filepath.Join(subDir, \"resume-marker.txt\"), []byte(\"I am in the resume working directory\"), 0644); err != nil {\n\t\t\tt.Fatalf(\"WriteFile failed: %v\", err)\n\t\t}\n\n\t\tsession1, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\t\tsessionID := session1.SessionID\n\t\tt.Cleanup(func() { _ = session1.Disconnect() })\n\n\t\tsession2, err := client.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tWorkingDirectory: subDir,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"ResumeSession failed: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = session2.Disconnect() })\n\n\t\tmessage, err := session2.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Read the file resume-marker.txt and tell me what it says\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\t\tif !assistantMessageContains(message, \"resume working directory\") {\n\t\t\tt.Errorf(\"Expected response to contain 'resume working directory', got %v\", message)\n\t\t}\n\t})\n\n\tt.Run(\"should apply systemMessage on session resume\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession1, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\t\tsessionID := session1.SessionID\n\t\tt.Cleanup(func() { _ = session1.Disconnect() })\n\n\t\tconst resumeInstruction = \"End the response with RESUME_SYSTEM_MESSAGE_SENTINEL.\"\n\t\tsession2, err := client.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\t\tMode: \"append\",\n\t\t\t\tContent: resumeInstruction,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"ResumeSession failed: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = session2.Disconnect() })\n\n\t\tmessage, err := session2.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 1+1?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\t\tif !assistantMessageContains(message, \"RESUME_SYSTEM_MESSAGE_SENTINEL\") {\n\t\t\tt.Errorf(\"Expected response to contain 'RESUME_SYSTEM_MESSAGE_SENTINEL', got %v\", message)\n\t\t}\n\n\t\texchanges, err := ctx.GetExchanges()\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"GetExchanges failed: %v\", err)\n\t\t}\n\t\tif len(exchanges) != 1 {\n\t\t\tt.Fatalf(\"Expected exactly 1 exchange, got %d\", len(exchanges))\n\t\t}\n\t\tif !strings.Contains(getSystemMessage(exchanges[0]), resumeInstruction) {\n\t\t\tt.Errorf(\"Expected system message to contain %q\", resumeInstruction)\n\t\t}\n\t})\n\n\tt.Run(\"should apply availableTools on session resume\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession1, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\t\tsessionID := session1.SessionID\n\t\tt.Cleanup(func() { _ = session1.Disconnect() })\n\n\t\tsession2, err := client.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tAvailableTools: []string{\"view\"},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"ResumeSession failed: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = session2.Disconnect() })\n\n\t\t_, err = session2.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 1+1?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\texchanges, err := ctx.GetExchanges()\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"GetExchanges failed: %v\", err)\n\t\t}\n\t\tif len(exchanges) != 1 {\n\t\t\tt.Fatalf(\"Expected exactly 1 exchange, got %d\", len(exchanges))\n\t\t}\n\t\ttoolNames := getToolNames(exchanges[0])\n\t\tif len(toolNames) != 1 || toolNames[0] != \"view\" {\n\t\t\tt.Errorf(\"Expected toolNames=[view], got %v\", toolNames)\n\t\t}\n\t})\n}\n\n// createProxyProvider returns a ProviderConfig that points at the test proxy and\n// includes a custom header — used for the \"should forward custom provider headers\" tests.\nfunc createProxyProvider(ctx *testharness.TestContext, headerName, headerValue string) *copilot.ProviderConfig {\n\treturn &copilot.ProviderConfig{\n\t\tType: \"openai\",\n\t\tBaseURL: ctx.ProxyURL,\n\t\tAPIKey: \"test-provider-key\",\n\t\tHeaders: map[string]string{\n\t\t\theaderName: headerValue,\n\t\t},\n\t}\n}\n\n// newUUID generates a v4 UUID string for tests that need a custom session ID.\nfunc newUUID(t *testing.T) string {\n\tt.Helper()\n\tb := make([]byte, 16)\n\tif _, err := rand.Read(b); err != nil {\n\t\tt.Fatalf(\"rand.Read failed: %v\", err)\n\t}\n\tb[6] = (b[6] & 0x0f) | 0x40\n\tb[8] = (b[8] & 0x3f) | 0x80\n\treturn fmt.Sprintf(\"%x-%x-%x-%x-%x\", b[0:4], b[4:6], b[6:8], b[8:10], b[10:16])\n}\n\n// assistantMessageContains returns true when the SendAndWait return value is a\n// non-nil assistant.message event whose content contains the given substring.\nfunc assistantMessageContains(message *copilot.SessionEvent, substring string) bool {\n\tif message == nil {\n\t\treturn false\n\t}\n\tdata, ok := message.Data.(*copilot.AssistantMessageData)\n\tif !ok {\n\t\treturn false\n\t}\n\treturn strings.Contains(data.Content, substring)\n}\n" }, { "path": "go/internal/e2e/session_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"encoding/base64\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"regexp\"\n\t\"strings\"\n\t\"sync\"\n\t\"testing\"\n\t\"time\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n\t\"github.com/github/copilot-sdk/go/rpc\"\n)\n\nfunc TestSessionE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"should create and disconnect sessions\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll, Model: \"claude-sonnet-4.5\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tmatched, _ := regexp.MatchString(`^[a-f0-9-]+$`, session.SessionID)\n\t\tif !matched {\n\t\t\tt.Errorf(\"Expected session ID to match UUID pattern, got %q\", session.SessionID)\n\t\t}\n\n\t\tmessages, err := session.GetMessages(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get messages: %v\", err)\n\t\t}\n\n\t\tif len(messages) == 0 || messages[0].Type != \"session.start\" {\n\t\t\tt.Fatalf(\"Expected first message to be session.start, got %v\", messages)\n\t\t}\n\n\t\tstartData, startOk := messages[0].Data.(*copilot.SessionStartData)\n\t\tif !startOk || startData.SessionID != session.SessionID {\n\t\t\tt.Errorf(\"Expected session.start sessionId to match\")\n\t\t}\n\n\t\tif !startOk || startData.SelectedModel == nil || *startData.SelectedModel != \"claude-sonnet-4.5\" {\n\t\t\tt.Errorf(\"Expected selectedModel to be 'claude-sonnet-4.5', got %v\", startData)\n\t\t}\n\n\t\tif err := session.Disconnect(); err != nil {\n\t\t\tt.Fatalf(\"Failed to disconnect session: %v\", err)\n\t\t}\n\n\t\t_, err = session.GetMessages(t.Context())\n\t\tif err == nil || !strings.Contains(err.Error(), \"not found\") {\n\t\t\tt.Errorf(\"Expected GetMessages to fail with 'not found' after disconnect, got %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should have stateful conversation\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tassistantMessage, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 1+1?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tif ad, ok := assistantMessage.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(ad.Content, \"2\") {\n\t\t\tt.Errorf(\"Expected assistant message to contain '2', got %v\", assistantMessage.Data)\n\t\t}\n\n\t\tsecondMessage, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Now if you double that, what do you get?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send second message: %v\", err)\n\t\t}\n\n\t\tif ad, ok := secondMessage.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(ad.Content, \"4\") {\n\t\t\tt.Errorf(\"Expected second message to contain '4', got %v\", secondMessage.Data)\n\t\t}\n\t})\n\n\tt.Run(\"should create a session with appended systemMessage config\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsystemMessageSuffix := \"End each response with the phrase 'Have a nice day!'\"\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\t\tMode: \"append\",\n\t\t\t\tContent: systemMessageSuffix,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tassistantMessage, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is your full name?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tcontent := \"\"\n\t\tif assistantMessage != nil {\n\t\t\tif ad, ok := assistantMessage.Data.(*copilot.AssistantMessageData); ok {\n\t\t\t\tcontent = ad.Content\n\t\t\t}\n\t\t}\n\n\t\tif !strings.Contains(content, \"GitHub\") {\n\t\t\tt.Errorf(\"Expected response to contain 'GitHub', got %q\", content)\n\t\t}\n\t\tif !strings.Contains(content, \"Have a nice day!\") {\n\t\t\tt.Errorf(\"Expected response to contain 'Have a nice day!', got %q\", content)\n\t\t}\n\n\t\t// Validate the underlying traffic\n\t\ttraffic, err := ctx.GetExchanges()\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get exchanges: %v\", err)\n\t\t}\n\t\tif len(traffic) == 0 {\n\t\t\tt.Fatal(\"Expected at least one exchange\")\n\t\t}\n\t\tsystemMessage := getSystemMessage(traffic[0])\n\t\tif !strings.Contains(systemMessage, \"GitHub\") {\n\t\t\tt.Errorf(\"Expected system message to contain 'GitHub', got %q\", systemMessage)\n\t\t}\n\t\tif !strings.Contains(systemMessage, systemMessageSuffix) {\n\t\t\tt.Errorf(\"Expected system message to contain suffix, got %q\", systemMessage)\n\t\t}\n\t})\n\n\tt.Run(\"should create a session with replaced systemMessage config\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\ttestSystemMessage := \"You are an assistant called Testy McTestface. Reply succinctly.\"\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\t\tMode: \"replace\",\n\t\t\t\tContent: testSystemMessage,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{Prompt: \"What is your full name?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tassistantMessage, err := testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\n\t\tcontent := \"\"\n\t\tif ad, ok := assistantMessage.Data.(*copilot.AssistantMessageData); ok {\n\t\t\tcontent = ad.Content\n\t\t}\n\n\t\tif strings.Contains(content, \"GitHub\") {\n\t\t\tt.Errorf(\"Expected response to NOT contain 'GitHub', got %q\", content)\n\t\t}\n\t\tif !strings.Contains(content, \"Testy\") {\n\t\t\tt.Errorf(\"Expected response to contain 'Testy', got %q\", content)\n\t\t}\n\n\t\t// Validate the underlying traffic\n\t\ttraffic, err := ctx.GetExchanges()\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get exchanges: %v\", err)\n\t\t}\n\t\tif len(traffic) == 0 {\n\t\t\tt.Fatal(\"Expected at least one exchange\")\n\t\t}\n\t\tsystemMessage := getSystemMessage(traffic[0])\n\t\tif systemMessage != testSystemMessage {\n\t\t\tt.Errorf(\"Expected system message to be exact match, got %q\", systemMessage)\n\t\t}\n\t})\n\n\tt.Run(\"should create a session with customized systemMessage config\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tcustomTone := \"Respond in a warm, professional tone. Be thorough in explanations.\"\n\t\tappendedContent := \"Always mention quarterly earnings.\"\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\t\tMode: \"customize\",\n\t\t\t\tSections: map[string]copilot.SectionOverride{\n\t\t\t\t\tcopilot.SectionTone: {Action: \"replace\", Content: customTone},\n\t\t\t\t\tcopilot.SectionCodeChangeRules: {Action: \"remove\"},\n\t\t\t\t},\n\t\t\t\tContent: appendedContent,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Who are you?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\t// Validate the system message sent to the model\n\t\ttraffic, err := ctx.GetExchanges()\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get exchanges: %v\", err)\n\t\t}\n\t\tif len(traffic) == 0 {\n\t\t\tt.Fatal(\"Expected at least one exchange\")\n\t\t}\n\t\tsystemMessage := getSystemMessage(traffic[0])\n\t\tif !strings.Contains(systemMessage, customTone) {\n\t\t\tt.Errorf(\"Expected system message to contain custom tone, got %q\", systemMessage)\n\t\t}\n\t\tif !strings.Contains(systemMessage, appendedContent) {\n\t\t\tt.Errorf(\"Expected system message to contain appended content, got %q\", systemMessage)\n\t\t}\n\t\tif strings.Contains(systemMessage, \"\") {\n\t\t\tt.Error(\"Expected system message to NOT contain code_change_instructions (it was removed)\")\n\t\t}\n\t})\n\n\tt.Run(\"should create a session with availableTools\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tAvailableTools: []string{\"view\", \"edit\"},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{Prompt: \"What is 1+1?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\t_, err = testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\n\t\t// Validate that only the specified tools are present\n\t\ttraffic, err := ctx.GetExchanges()\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get exchanges: %v\", err)\n\t\t}\n\t\tif len(traffic) == 0 {\n\t\t\tt.Fatal(\"Expected at least one exchange\")\n\t\t}\n\n\t\ttoolNames := getToolNames(traffic[0])\n\t\tif len(toolNames) != 2 {\n\t\t\tt.Errorf(\"Expected exactly 2 tools, got %d: %v\", len(toolNames), toolNames)\n\t\t}\n\t\tif !contains(toolNames, \"view\") || !contains(toolNames, \"edit\") {\n\t\t\tt.Errorf(\"Expected tools to contain 'view' and 'edit', got %v\", toolNames)\n\t\t}\n\t})\n\n\tt.Run(\"should create a session with excludedTools\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tExcludedTools: []string{\"view\"},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{Prompt: \"What is 1+1?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\t_, err = testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\n\t\t// Validate that excluded tool is not present but others are\n\t\ttraffic, err := ctx.GetExchanges()\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get exchanges: %v\", err)\n\t\t}\n\t\tif len(traffic) == 0 {\n\t\t\tt.Fatal(\"Expected at least one exchange\")\n\t\t}\n\n\t\ttoolNames := getToolNames(traffic[0])\n\t\tif contains(toolNames, \"view\") {\n\t\t\tt.Errorf(\"Expected 'view' to be excluded, got %v\", toolNames)\n\t\t}\n\t\tif !contains(toolNames, \"edit\") || !contains(toolNames, \"grep\") {\n\t\t\tt.Errorf(\"Expected 'edit' and 'grep' to be present, got %v\", toolNames)\n\t\t}\n\t})\n\n\tt.Run(\"should create a session with defaultAgent excludedTools\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tTools: []copilot.Tool{\n\t\t\t\t{\n\t\t\t\t\tName: \"secret_tool\",\n\t\t\t\t\tDescription: \"A secret tool hidden from the default agent\",\n\t\t\t\t\tParameters: map[string]any{\n\t\t\t\t\t\t\"type\": \"object\",\n\t\t\t\t\t\t\"properties\": map[string]any{\"input\": map[string]any{\"type\": \"string\"}},\n\t\t\t\t\t},\n\t\t\t\t\tHandler: func(invocation copilot.ToolInvocation) (copilot.ToolResult, error) {\n\t\t\t\t\t\treturn copilot.ToolResult{TextResultForLLM: \"SECRET\", ResultType: \"success\"}, nil\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\tDefaultAgent: &copilot.DefaultAgentConfig{\n\t\t\t\tExcludedTools: []string{\"secret_tool\"},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{Prompt: \"What is 1+1?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\t_, err = testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\n\t\t// The real assertion: verify the runtime excluded the tool from the CAPI request\n\t\ttraffic, err := ctx.GetExchanges()\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get exchanges: %v\", err)\n\t\t}\n\t\tif len(traffic) == 0 {\n\t\t\tt.Fatal(\"Expected at least one exchange\")\n\t\t}\n\n\t\ttoolNames := getToolNames(traffic[0])\n\t\tif contains(toolNames, \"secret_tool\") {\n\t\t\tt.Errorf(\"Expected 'secret_tool' to be excluded from default agent, got %v\", toolNames)\n\t\t}\n\t})\n\n\tt.Run(\"should create session with custom tool\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tTools: []copilot.Tool{\n\t\t\t\t{\n\t\t\t\t\tName: \"get_secret_number\",\n\t\t\t\t\tDescription: \"Gets the secret number\",\n\t\t\t\t\tParameters: map[string]any{\n\t\t\t\t\t\t\"type\": \"object\",\n\t\t\t\t\t\t\"properties\": map[string]any{\n\t\t\t\t\t\t\t\"key\": map[string]any{\n\t\t\t\t\t\t\t\t\"type\": \"string\",\n\t\t\t\t\t\t\t\t\"description\": \"Key\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"required\": []string{\"key\"},\n\t\t\t\t\t},\n\t\t\t\t\tHandler: func(invocation copilot.ToolInvocation) (copilot.ToolResult, error) {\n\t\t\t\t\t\targs, _ := invocation.Arguments.(map[string]any)\n\t\t\t\t\t\tkey, _ := args[\"key\"].(string)\n\t\t\t\t\t\tif key == \"ALPHA\" {\n\t\t\t\t\t\t\treturn copilot.ToolResult{\n\t\t\t\t\t\t\t\tTextResultForLLM: \"54321\",\n\t\t\t\t\t\t\t\tResultType: \"success\",\n\t\t\t\t\t\t\t}, nil\n\t\t\t\t\t\t}\n\t\t\t\t\t\treturn copilot.ToolResult{\n\t\t\t\t\t\t\tTextResultForLLM: \"unknown\",\n\t\t\t\t\t\t\tResultType: \"success\",\n\t\t\t\t\t\t}, nil\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{Prompt: \"What is the secret number for key ALPHA?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tassistantMessage, err := testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\n\t\tcontent := \"\"\n\t\tif ad, ok := assistantMessage.Data.(*copilot.AssistantMessageData); ok {\n\t\t\tcontent = ad.Content\n\t\t}\n\n\t\tif !strings.Contains(content, \"54321\") {\n\t\t\tt.Errorf(\"Expected response to contain '54321', got %q\", content)\n\t\t}\n\t})\n\n\tt.Run(\"should handle multiple concurrent sessions\", func(t *testing.T) {\n\t\tt.Skip(\"Known race condition - see TypeScript test\")\n\t})\n\n\tt.Run(\"should resume a session using the same client\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t// Create initial session\n\t\tsession1, err := client.CreateSession(t.Context(), &copilot.SessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tsessionID := session1.SessionID\n\n\t\t_, err = session1.Send(t.Context(), copilot.MessageOptions{Prompt: \"What is 1+1?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tanswer, err := testharness.GetFinalAssistantMessage(t.Context(), session1)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\n\t\tif ad, ok := answer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(ad.Content, \"2\") {\n\t\t\tt.Errorf(\"Expected answer to contain '2', got %v\", answer.Data)\n\t\t}\n\n\t\t// Resume using the same client\n\t\tsession2, err := client.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\n\t\tif session2.SessionID != sessionID {\n\t\t\tt.Errorf(\"Expected resumed session ID to match, got %q vs %q\", session2.SessionID, sessionID)\n\t\t}\n\n\t\tanswer2, err := testharness.GetFinalAssistantMessage(t.Context(), session2, true)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message from resumed session: %v\", err)\n\t\t}\n\n\t\tif ad, ok := answer2.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(ad.Content, \"2\") {\n\t\t\tt.Errorf(\"Expected resumed session answer to contain '2', got %v\", answer2.Data)\n\t\t}\n\n\t\t// Can continue the conversation statefully\n\t\tanswer3, err := session2.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Now if you double that, what do you get?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send follow-up message: %v\", err)\n\t\t}\n\t\tif answer3 == nil {\n\t\t\tt.Errorf(\"Expected follow-up answer to contain '4', got nil\")\n\t\t} else if ad, ok := answer3.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(ad.Content, \"4\") {\n\t\t\tt.Errorf(\"Expected follow-up answer to contain '4', got %v\", answer3)\n\t\t}\n\t})\n\n\tt.Run(\"should resume a session using a new client\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t// Create initial session\n\t\tsession1, err := client.CreateSession(t.Context(), &copilot.SessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tsessionID := session1.SessionID\n\n\t\t_, err = session1.Send(t.Context(), copilot.MessageOptions{Prompt: \"What is 1+1?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tanswer, err := testharness.GetFinalAssistantMessage(t.Context(), session1)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\n\t\tif ad, ok := answer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(ad.Content, \"2\") {\n\t\t\tt.Errorf(\"Expected answer to contain '2', got %v\", answer.Data)\n\t\t}\n\n\t\t// Resume using a new client\n\t\tnewClient := ctx.NewClient()\n\t\tdefer newClient.ForceStop()\n\n\t\tsession2, err := newClient.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\n\t\tif session2.SessionID != sessionID {\n\t\t\tt.Errorf(\"Expected resumed session ID to match, got %q vs %q\", session2.SessionID, sessionID)\n\t\t}\n\n\t\t// When resuming with a new client, we check messages contain expected types\n\t\tmessages, err := session2.GetMessages(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get messages: %v\", err)\n\t\t}\n\n\t\thasUserMessage := false\n\t\thasSessionResume := false\n\t\tfor _, msg := range messages {\n\t\t\tif msg.Type == \"user.message\" {\n\t\t\t\thasUserMessage = true\n\t\t\t}\n\t\t\tif msg.Type == \"session.resume\" {\n\t\t\t\thasSessionResume = true\n\t\t\t}\n\t\t}\n\n\t\tif !hasUserMessage {\n\t\t\tt.Error(\"Expected messages to contain 'user.message'\")\n\t\t}\n\t\tif !hasSessionResume {\n\t\t\tt.Error(\"Expected messages to contain 'session.resume'\")\n\t\t}\n\n\t\t// Can continue the conversation statefully\n\t\tanswer3, err := session2.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Now if you double that, what do you get?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send follow-up message: %v\", err)\n\t\t}\n\t\tif answer3 == nil {\n\t\t\tt.Errorf(\"Expected follow-up answer to contain '4', got nil\")\n\t\t} else if ad, ok := answer3.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(ad.Content, \"4\") {\n\t\t\tt.Errorf(\"Expected follow-up answer to contain '4', got %v\", answer3)\n\t\t}\n\t})\n\n\tt.Run(\"should throw error when resuming non-existent session\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t_, err := client.ResumeSession(t.Context(), \"non-existent-session-id\", &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err == nil {\n\t\t\tt.Error(\"Expected error when resuming non-existent session\")\n\t\t}\n\t})\n\n\tt.Run(\"should resume session with a custom provider\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tsessionID := session.SessionID\n\n\t\t// Resume the session with a provider\n\t\tsession2, err := client.ResumeSessionWithOptions(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tProvider: &copilot.ProviderConfig{\n\t\t\t\tType: \"openai\",\n\t\t\t\tBaseURL: \"https://api.openai.com/v1\",\n\t\t\t\tAPIKey: \"fake-key\",\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session with provider: %v\", err)\n\t\t}\n\n\t\tif session2.SessionID != sessionID {\n\t\t\tt.Errorf(\"Expected resumed session ID to match, got %q vs %q\", session2.SessionID, sessionID)\n\t\t}\n\t})\n\n\tt.Run(\"should abort a session\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Set up event listeners BEFORE sending to avoid race conditions\n\t\ttoolStartCh := make(chan *copilot.SessionEvent, 1)\n\t\ttoolStartErrCh := make(chan error, 1)\n\t\tgo func() {\n\t\t\tevt, err := testharness.GetNextEventOfType(session, copilot.SessionEventTypeToolExecutionStart, 60*time.Second)\n\t\t\tif err != nil {\n\t\t\t\ttoolStartErrCh <- err\n\t\t\t} else {\n\t\t\t\ttoolStartCh <- evt\n\t\t\t}\n\t\t}()\n\n\t\tsessionIdleCh := make(chan *copilot.SessionEvent, 1)\n\t\tsessionIdleErrCh := make(chan error, 1)\n\t\tgo func() {\n\t\t\tevt, err := testharness.GetNextEventOfType(session, copilot.SessionEventTypeSessionIdle, 60*time.Second)\n\t\t\tif err != nil {\n\t\t\t\tsessionIdleErrCh <- err\n\t\t\t} else {\n\t\t\t\tsessionIdleCh <- evt\n\t\t\t}\n\t\t}()\n\n\t\t// Send a message that triggers a long-running shell command\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{Prompt: \"run the shell command 'sleep 100' (note this works on both bash and PowerShell)\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\t// Wait for tool.execution_start\n\t\tselect {\n\t\tcase <-toolStartCh:\n\t\t\t// Tool execution has started\n\t\tcase err := <-toolStartErrCh:\n\t\t\tt.Fatalf(\"Failed waiting for tool.execution_start: %v\", err)\n\t\t}\n\n\t\t// Abort the session\n\t\terr = session.Abort(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to abort session: %v\", err)\n\t\t}\n\n\t\t// Wait for session.idle after abort\n\t\tselect {\n\t\tcase <-sessionIdleCh:\n\t\t\t// Session is idle\n\t\tcase err := <-sessionIdleErrCh:\n\t\t\tt.Fatalf(\"Failed waiting for session.idle after abort: %v\", err)\n\t\t}\n\n\t\t// The session should still be alive and usable after abort\n\t\tmessages, err := session.GetMessages(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get messages after abort: %v\", err)\n\t\t}\n\t\tif len(messages) == 0 {\n\t\t\tt.Error(\"Expected messages to exist after abort\")\n\t\t}\n\n\t\t// Verify messages contain an abort event\n\t\thasAbortEvent := false\n\t\tfor _, msg := range messages {\n\t\t\tif msg.Type == copilot.SessionEventTypeAbort {\n\t\t\t\thasAbortEvent = true\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif !hasAbortEvent {\n\t\t\tt.Error(\"Expected messages to contain an 'abort' event\")\n\t\t}\n\n\t\t// We should be able to send another message\n\t\tanswer, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 2+2?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message after abort: %v\", err)\n\t\t}\n\n\t\tif ad, ok := answer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(ad.Content, \"4\") {\n\t\t\tt.Errorf(\"Expected answer to contain '4', got %v\", answer.Data)\n\t\t}\n\t})\n\n\tt.Run(\"should receive session events\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t// Use OnEvent to capture events dispatched during session creation.\n\t\t// session.start is emitted during the session.create RPC; with channel-based\n\t\t// dispatch it may not have been delivered by the time CreateSession returns.\n\t\tsessionStartCh := make(chan bool, 1)\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tOnEvent: func(event copilot.SessionEvent) {\n\t\t\t\tif event.Type == \"session.start\" {\n\t\t\t\t\tselect {\n\t\t\t\t\tcase sessionStartCh <- true:\n\t\t\t\t\tdefault:\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tselect {\n\t\tcase <-sessionStartCh:\n\t\tcase <-time.After(5 * time.Second):\n\t\t\tt.Error(\"Expected session.start event via OnEvent during creation\")\n\t\t}\n\n\t\tvar receivedEvents []copilot.SessionEvent\n\t\tidle := make(chan bool)\n\n\t\tsession.On(func(event copilot.SessionEvent) {\n\t\t\treceivedEvents = append(receivedEvents, event)\n\t\t\tif event.Type == \"session.idle\" {\n\t\t\t\tselect {\n\t\t\t\tcase idle <- true:\n\t\t\t\tdefault:\n\t\t\t\t}\n\t\t\t}\n\t\t})\n\n\t\t// Send a message to trigger events\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{Prompt: \"What is 100+200?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\t// Wait for session to become idle\n\t\tselect {\n\t\tcase <-idle:\n\t\tcase <-time.After(60 * time.Second):\n\t\t\tt.Fatal(\"Timed out waiting for session.idle\")\n\t\t}\n\n\t\t// Should have received multiple events\n\t\tif len(receivedEvents) == 0 {\n\t\t\tt.Error(\"Expected to receive events, got none\")\n\t\t}\n\n\t\thasUserMessage := false\n\t\thasAssistantMessage := false\n\t\thasSessionIdle := false\n\t\tfor _, evt := range receivedEvents {\n\t\t\tswitch evt.Type {\n\t\t\tcase \"user.message\":\n\t\t\t\thasUserMessage = true\n\t\t\tcase \"assistant.message\":\n\t\t\t\thasAssistantMessage = true\n\t\t\tcase \"session.idle\":\n\t\t\t\thasSessionIdle = true\n\t\t\t}\n\t\t}\n\n\t\tif !hasUserMessage {\n\t\t\tt.Error(\"Expected to receive user.message event\")\n\t\t}\n\t\tif !hasAssistantMessage {\n\t\t\tt.Error(\"Expected to receive assistant.message event\")\n\t\t}\n\t\tif !hasSessionIdle {\n\t\t\tt.Error(\"Expected to receive session.idle event\")\n\t\t}\n\n\t\t// Verify the assistant response contains the expected answer.\n\t\t// session.idle is ephemeral and not in GetMessages(), but we already\n\t\t// confirmed idle via the live event handler above.\n\t\tassistantMessage, err := testharness.GetFinalAssistantMessage(t.Context(), session, true)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\t\tif ad, ok := assistantMessage.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(ad.Content, \"300\") {\n\t\t\tt.Errorf(\"Expected assistant message to contain '300', got %v\", assistantMessage.Data)\n\t\t}\n\t})\n\n\tt.Run(\"should create session with custom config dir\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tcustomConfigDir := ctx.HomeDir + \"/custom-config\"\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tConfigDir: customConfigDir,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session with custom config dir: %v\", err)\n\t\t}\n\n\t\tmatched, _ := regexp.MatchString(`^[a-f0-9-]+$`, session.SessionID)\n\t\tif !matched {\n\t\t\tt.Errorf(\"Expected session ID to match UUID pattern, got %q\", session.SessionID)\n\t\t}\n\n\t\t// Session should work normally with custom config dir\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{Prompt: \"What is 1+1?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tassistantMessage, err := testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\n\t\tif ad, ok := assistantMessage.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(ad.Content, \"2\") {\n\t\t\tt.Errorf(\"Expected assistant message to contain '2', got %v\", assistantMessage.Data)\n\t\t}\n\t})\n\n\tt.Run(\"should list sessions\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t// Create a couple of sessions and send messages to persist them\n\t\tsession1, err := client.CreateSession(t.Context(), &copilot.SessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session1: %v\", err)\n\t\t}\n\n\t\t_, err = session1.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Say hello\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message to session1: %v\", err)\n\t\t}\n\n\t\tsession2, err := client.CreateSession(t.Context(), &copilot.SessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session2: %v\", err)\n\t\t}\n\n\t\t_, err = session2.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Say goodbye\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message to session2: %v\", err)\n\t\t}\n\n\t\t// Small delay to ensure session files are written to disk\n\t\ttime.Sleep(200 * time.Millisecond)\n\n\t\t// List sessions and verify they're included\n\t\tsessions, err := client.ListSessions(t.Context(), nil)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to list sessions: %v\", err)\n\t\t}\n\n\t\t// Verify it's a list\n\t\tif sessions == nil {\n\t\t\tt.Fatal(\"Expected sessions to be non-nil\")\n\t\t}\n\n\t\t// Extract session IDs\n\t\tsessionIDs := make([]string, len(sessions))\n\t\tfor i, s := range sessions {\n\t\t\tsessionIDs[i] = s.SessionID\n\t\t}\n\n\t\t// Verify both sessions are in the list\n\t\tif !contains(sessionIDs, session1.SessionID) {\n\t\t\tt.Errorf(\"Expected session1 ID %s to be in sessions list %v\", session1.SessionID, sessionIDs)\n\t\t}\n\t\tif !contains(sessionIDs, session2.SessionID) {\n\t\t\tt.Errorf(\"Expected session2 ID %s to be in sessions list %v\", session2.SessionID, sessionIDs)\n\t\t}\n\n\t\t// Verify session metadata structure\n\t\tfor _, sessionData := range sessions {\n\t\t\tif sessionData.SessionID == \"\" {\n\t\t\t\tt.Error(\"Expected sessionId to be non-empty\")\n\t\t\t}\n\t\t\tif sessionData.StartTime == \"\" {\n\t\t\t\tt.Error(\"Expected startTime to be non-empty\")\n\t\t\t}\n\t\t\tif sessionData.ModifiedTime == \"\" {\n\t\t\t\tt.Error(\"Expected modifiedTime to be non-empty\")\n\t\t\t}\n\t\t\t// isRemote is a boolean, so it's always set\n\t\t}\n\n\t\t// Verify context field is present on sessions\n\t\tfor _, s := range sessions {\n\t\t\tif s.Context != nil {\n\t\t\t\tif s.Context.Cwd == \"\" {\n\t\t\t\t\tt.Error(\"Expected context.Cwd to be non-empty when context is present\")\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t})\n\n\tt.Run(\"should delete session\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t// Create a session and send a message to persist it\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Hello\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tsessionID := session.SessionID\n\n\t\t// Small delay to ensure session file is written to disk\n\t\ttime.Sleep(200 * time.Millisecond)\n\n\t\t// Verify session exists in the list\n\t\tsessions, err := client.ListSessions(t.Context(), nil)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to list sessions: %v\", err)\n\t\t}\n\n\t\tsessionIDs := make([]string, len(sessions))\n\t\tfor i, s := range sessions {\n\t\t\tsessionIDs[i] = s.SessionID\n\t\t}\n\n\t\tif !contains(sessionIDs, sessionID) {\n\t\t\tt.Errorf(\"Expected session ID %s to be in sessions list before delete\", sessionID)\n\t\t}\n\n\t\t// Delete the session\n\t\terr = client.DeleteSession(t.Context(), sessionID)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to delete session: %v\", err)\n\t\t}\n\n\t\t// Verify session no longer exists in the list\n\t\tsessionsAfter, err := client.ListSessions(t.Context(), nil)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to list sessions after delete: %v\", err)\n\t\t}\n\n\t\tsessionIDsAfter := make([]string, len(sessionsAfter))\n\t\tfor i, s := range sessionsAfter {\n\t\t\tsessionIDsAfter[i] = s.SessionID\n\t\t}\n\n\t\tif contains(sessionIDsAfter, sessionID) {\n\t\t\tt.Errorf(\"Expected session ID %s to NOT be in sessions list after delete\", sessionID)\n\t\t}\n\n\t\t// Verify we cannot resume the deleted session\n\t\t_, err = client.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err == nil {\n\t\t\tt.Error(\"Expected error when resuming deleted session\")\n\t\t}\n\t})\n\tt.Run(\"should get session metadata\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t// Create a session and send a message to persist it\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Say hello\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\t// Small delay to ensure session file is written to disk\n\t\ttime.Sleep(200 * time.Millisecond)\n\n\t\t// Get metadata for the session we just created\n\t\tmetadata, err := client.GetSessionMetadata(t.Context(), session.SessionID)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get session metadata: %v\", err)\n\t\t}\n\n\t\tif metadata == nil {\n\t\t\tt.Fatal(\"Expected metadata to be non-nil\")\n\t\t}\n\n\t\tif metadata.SessionID != session.SessionID {\n\t\t\tt.Errorf(\"Expected sessionId %s, got %s\", session.SessionID, metadata.SessionID)\n\t\t}\n\n\t\tif metadata.StartTime == \"\" {\n\t\t\tt.Error(\"Expected startTime to be non-empty\")\n\t\t}\n\n\t\tif metadata.ModifiedTime == \"\" {\n\t\t\tt.Error(\"Expected modifiedTime to be non-empty\")\n\t\t}\n\n\t\t// Verify context field\n\t\tif metadata.Context != nil {\n\t\t\tif metadata.Context.Cwd == \"\" {\n\t\t\t\tt.Error(\"Expected context.Cwd to be non-empty when context is present\")\n\t\t\t}\n\t\t}\n\n\t\t// Verify non-existent session returns nil\n\t\tnotFound, err := client.GetSessionMetadata(t.Context(), \"non-existent-session-id\")\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Expected no error for non-existent session, got: %v\", err)\n\t\t}\n\t\tif notFound != nil {\n\t\t\tt.Error(\"Expected nil metadata for non-existent session\")\n\t\t}\n\t})\n\tt.Run(\"should get last session id\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t// Create a session and send a message to persist it\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Say hello\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\t// Small delay to ensure session data is flushed to disk\n\t\ttime.Sleep(500 * time.Millisecond)\n\n\t\tlastSessionID, err := client.GetLastSessionID(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get last session ID: %v\", err)\n\t\t}\n\n\t\tif lastSessionID == nil {\n\t\t\tt.Fatal(\"Expected last session ID to be non-nil\")\n\t\t}\n\n\t\tif *lastSessionID != session.SessionID {\n\t\t\tt.Errorf(\"Expected last session ID to be %s, got %s\", session.SessionID, *lastSessionID)\n\t\t}\n\n\t\tif err := session.Disconnect(); err != nil {\n\t\t\tt.Fatalf(\"Failed to destroy session: %v\", err)\n\t\t}\n\t})\n}\n\nfunc getSystemMessage(exchange testharness.ParsedHttpExchange) string {\n\tfor _, msg := range exchange.Request.Messages {\n\t\tif msg.Role == \"system\" {\n\t\t\treturn msg.Content\n\t\t}\n\t}\n\treturn \"\"\n}\n\nfunc TestSetModelWithReasoningEffortE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tif err := client.Start(t.Context()); err != nil {\n\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t}\n\n\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t})\n\tif err != nil {\n\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t}\n\n\tmodelChanged := make(chan copilot.SessionEvent, 1)\n\tsession.On(func(event copilot.SessionEvent) {\n\t\tif event.Type == copilot.SessionEventTypeSessionModelChange {\n\t\t\tselect {\n\t\t\tcase modelChanged <- event:\n\t\t\tdefault:\n\t\t\t}\n\t\t}\n\t})\n\n\tif err := session.SetModel(t.Context(), \"gpt-4.1\", &copilot.SetModelOptions{ReasoningEffort: copilot.String(\"high\")}); err != nil {\n\t\tt.Fatalf(\"SetModel returned error: %v\", err)\n\t}\n\n\tselect {\n\tcase evt := <-modelChanged:\n\t\tmd, mdOk := evt.Data.(*copilot.SessionModelChangeData)\n\t\tif !mdOk || md.NewModel != \"gpt-4.1\" {\n\t\t\tt.Errorf(\"Expected newModel 'gpt-4.1', got %v\", evt.Data)\n\t\t}\n\t\tif !mdOk || md.ReasoningEffort == nil || *md.ReasoningEffort != \"high\" {\n\t\t\tt.Errorf(\"Expected reasoningEffort 'high', got %v\", evt.Data)\n\t\t}\n\tcase <-time.After(30 * time.Second):\n\t\tt.Fatal(\"Timed out waiting for session.model_change event\")\n\t}\n}\n\nfunc TestSessionBlobAttachmentE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tif err := client.Start(t.Context()); err != nil {\n\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t}\n\n\tt.Run(\"should accept blob attachments\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t// Write the image to disk so the model can view it\n\t\tdata := \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\"\n\t\tpngBytes, _ := base64.StdEncoding.DecodeString(data)\n\t\tif err := os.WriteFile(filepath.Join(ctx.WorkDir, \"test-pixel.png\"), pngBytes, 0644); err != nil {\n\t\t\tt.Fatalf(\"Failed to write test image: %v\", err)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tmimeType := \"image/png\"\n\t\tdisplayName := \"test-pixel.png\"\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Describe this image\",\n\t\t\tAttachments: []copilot.Attachment{\n\t\t\t\t{\n\t\t\t\t\tType: copilot.AttachmentTypeBlob,\n\t\t\t\t\tData: &data,\n\t\t\t\t\tMIMEType: &mimeType,\n\t\t\t\t\tDisplayName: &displayName,\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Send with blob attachment failed: %v\", err)\n\t\t}\n\n\t\tsession.Disconnect()\n\t})\n}\n\nfunc getToolNames(exchange testharness.ParsedHttpExchange) []string {\n\tvar names []string\n\tfor _, tool := range exchange.Request.Tools {\n\t\tnames = append(names, tool.Function.Name)\n\t}\n\treturn names\n}\n\nfunc contains(slice []string, item string) bool {\n\tfor _, s := range slice {\n\t\tif s == item {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\nfunc TestSessionLogE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tif err := client.Start(t.Context()); err != nil {\n\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t}\n\n\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t})\n\tif err != nil {\n\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t}\n\n\t// Collect events\n\tvar events []copilot.SessionEvent\n\tvar mu sync.Mutex\n\tunsubscribe := session.On(func(event copilot.SessionEvent) {\n\t\tmu.Lock()\n\t\tdefer mu.Unlock()\n\t\tevents = append(events, event)\n\t})\n\tdefer unsubscribe()\n\n\tt.Run(\"should log info message (default level)\", func(t *testing.T) {\n\t\tif err := session.Log(t.Context(), \"Info message\", nil); err != nil {\n\t\t\tt.Fatalf(\"Log failed: %v\", err)\n\t\t}\n\n\t\tevt := waitForEvent(t, &mu, &events, copilot.SessionEventTypeSessionInfo, \"Info message\", 5*time.Second)\n\t\tid, idOk := evt.Data.(*copilot.SessionInfoData)\n\t\tif !idOk || id.InfoType != \"notification\" {\n\t\t\tt.Errorf(\"Expected infoType 'notification', got %v\", evt.Data)\n\t\t}\n\t\tif !idOk || id.Message != \"Info message\" {\n\t\t\tt.Errorf(\"Expected message 'Info message', got %v\", evt.Data)\n\t\t}\n\t})\n\n\tt.Run(\"should log warning message\", func(t *testing.T) {\n\t\tif err := session.Log(t.Context(), \"Warning message\", &copilot.LogOptions{Level: rpc.SessionLogLevelWarning}); err != nil {\n\t\t\tt.Fatalf(\"Log failed: %v\", err)\n\t\t}\n\n\t\tevt := waitForEvent(t, &mu, &events, copilot.SessionEventTypeSessionWarning, \"Warning message\", 5*time.Second)\n\t\twd, wdOk := evt.Data.(*copilot.SessionWarningData)\n\t\tif !wdOk || wd.WarningType != \"notification\" {\n\t\t\tt.Errorf(\"Expected warningType 'notification', got %v\", evt.Data)\n\t\t}\n\t\tif !wdOk || wd.Message != \"Warning message\" {\n\t\t\tt.Errorf(\"Expected message 'Warning message', got %v\", evt.Data)\n\t\t}\n\t})\n\n\tt.Run(\"should log error message\", func(t *testing.T) {\n\t\tif err := session.Log(t.Context(), \"Error message\", &copilot.LogOptions{Level: rpc.SessionLogLevelError}); err != nil {\n\t\t\tt.Fatalf(\"Log failed: %v\", err)\n\t\t}\n\n\t\tevt := waitForEvent(t, &mu, &events, copilot.SessionEventTypeSessionError, \"Error message\", 5*time.Second)\n\t\ted, edOk := evt.Data.(*copilot.SessionErrorData)\n\t\tif !edOk || ed.ErrorType != \"notification\" {\n\t\t\tt.Errorf(\"Expected errorType 'notification', got %v\", evt.Data)\n\t\t}\n\t\tif !edOk || ed.Message != \"Error message\" {\n\t\t\tt.Errorf(\"Expected message 'Error message', got %v\", evt.Data)\n\t\t}\n\t})\n\n\tt.Run(\"should log ephemeral message\", func(t *testing.T) {\n\t\tif err := session.Log(t.Context(), \"Ephemeral message\", &copilot.LogOptions{Ephemeral: copilot.Bool(true)}); err != nil {\n\t\t\tt.Fatalf(\"Log failed: %v\", err)\n\t\t}\n\n\t\tevt := waitForEvent(t, &mu, &events, copilot.SessionEventTypeSessionInfo, \"Ephemeral message\", 5*time.Second)\n\t\tid2, id2Ok := evt.Data.(*copilot.SessionInfoData)\n\t\tif !id2Ok || id2.InfoType != \"notification\" {\n\t\t\tt.Errorf(\"Expected infoType 'notification', got %v\", evt.Data)\n\t\t}\n\t\tif !id2Ok || id2.Message != \"Ephemeral message\" {\n\t\t\tt.Errorf(\"Expected message 'Ephemeral message', got %v\", evt.Data)\n\t\t}\n\t})\n}\n\n// waitForEvent polls the collected events for a matching event type and message.\nfunc waitForEvent(t *testing.T, mu *sync.Mutex, events *[]copilot.SessionEvent, eventType copilot.SessionEventType, message string, timeout time.Duration) copilot.SessionEvent {\n\tt.Helper()\n\tdeadline := time.Now().Add(timeout)\n\tfor time.Now().Before(deadline) {\n\t\tmu.Lock()\n\t\tfor _, evt := range *events {\n\t\t\tif evt.Type == eventType && getEventMessage(evt) == message {\n\t\t\t\tmu.Unlock()\n\t\t\t\treturn evt\n\t\t\t}\n\t\t}\n\t\tmu.Unlock()\n\t\ttime.Sleep(50 * time.Millisecond)\n\t}\n\tt.Fatalf(\"Timed out waiting for %s event with message %q\", eventType, message)\n\treturn copilot.SessionEvent{} // unreachable\n}\n\n// getEventMessage extracts the Message field from session info/warning/error event data.\nfunc getEventMessage(evt copilot.SessionEvent) string {\n\tswitch d := evt.Data.(type) {\n\tcase *copilot.SessionInfoData:\n\t\treturn d.Message\n\tcase *copilot.SessionWarningData:\n\t\treturn d.Message\n\tcase *copilot.SessionErrorData:\n\t\treturn d.Message\n\tdefault:\n\t\treturn \"\"\n\t}\n}\n\n// TestSessionAttachments mirrors the C# Should_Send_With_*_Attachment tests in SessionTests.cs.\n// Each subtest exercises a different UserMessageAttachment shape end-to-end through SendAndWait\n// and verifies the resulting user.message event captured by GetMessages.\nfunc TestSessionAttachmentsE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tif err := client.Start(t.Context()); err != nil {\n\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t}\n\n\tt.Run(\"should send with file attachment\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tfilePath := filepath.Join(ctx.WorkDir, \"attached-file.txt\")\n\t\tif err := os.WriteFile(filePath, []byte(\"FILE_ATTACHMENT_SENTINEL\"), 0644); err != nil {\n\t\t\tt.Fatalf(\"WriteFile failed: %v\", err)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tdisplayName := \"attached-file.txt\"\n\t\tpath := filePath\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Read the attached file and reply with its contents.\",\n\t\t\tAttachments: []copilot.Attachment{{\n\t\t\t\tType: copilot.AttachmentTypeFile,\n\t\t\t\tDisplayName: &displayName,\n\t\t\t\tPath: &path,\n\t\t\t\tLineRange: &copilot.UserMessageAttachmentFileLineRange{Start: 1, End: 1},\n\t\t\t}},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tattachment := lastUserAttachment(t, session)\n\t\tif attachment.Type != copilot.AttachmentTypeFile {\n\t\t\tt.Errorf(\"Expected attachment type %q, got %q\", copilot.AttachmentTypeFile, attachment.Type)\n\t\t}\n\t\tif attachment.DisplayName == nil || *attachment.DisplayName != \"attached-file.txt\" {\n\t\t\tt.Errorf(\"Expected DisplayName 'attached-file.txt', got %v\", attachment.DisplayName)\n\t\t}\n\t\tif attachment.Path == nil || *attachment.Path != filePath {\n\t\t\tt.Errorf(\"Expected Path %q, got %v\", filePath, attachment.Path)\n\t\t}\n\t\tif attachment.LineRange == nil || attachment.LineRange.Start != 1 || attachment.LineRange.End != 1 {\n\t\t\tt.Errorf(\"Expected LineRange {1,1}, got %+v\", attachment.LineRange)\n\t\t}\n\t})\n\n\tt.Run(\"should send with directory attachment\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tdirectoryPath := filepath.Join(ctx.WorkDir, \"attached-directory\")\n\t\tif err := os.MkdirAll(directoryPath, 0755); err != nil {\n\t\t\tt.Fatalf(\"MkdirAll failed: %v\", err)\n\t\t}\n\t\tif err := os.WriteFile(filepath.Join(directoryPath, \"readme.txt\"), []byte(\"DIRECTORY_ATTACHMENT_SENTINEL\"), 0644); err != nil {\n\t\t\tt.Fatalf(\"WriteFile failed: %v\", err)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tdisplayName := \"attached-directory\"\n\t\tpath := directoryPath\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"List the attached directory.\",\n\t\t\tAttachments: []copilot.Attachment{{\n\t\t\t\tType: copilot.AttachmentTypeDirectory,\n\t\t\t\tDisplayName: &displayName,\n\t\t\t\tPath: &path,\n\t\t\t}},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tattachment := lastUserAttachment(t, session)\n\t\tif attachment.Type != copilot.AttachmentTypeDirectory {\n\t\t\tt.Errorf(\"Expected attachment type %q, got %q\", copilot.AttachmentTypeDirectory, attachment.Type)\n\t\t}\n\t\tif attachment.DisplayName == nil || *attachment.DisplayName != \"attached-directory\" {\n\t\t\tt.Errorf(\"Expected DisplayName 'attached-directory', got %v\", attachment.DisplayName)\n\t\t}\n\t\tif attachment.Path == nil || *attachment.Path != directoryPath {\n\t\t\tt.Errorf(\"Expected Path %q, got %v\", directoryPath, attachment.Path)\n\t\t}\n\t})\n\n\tt.Run(\"should send with selection attachment\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tfilePath := filepath.Join(ctx.WorkDir, \"selected-file.cs\")\n\t\tif err := os.WriteFile(filePath, []byte(`class C { string Value = \"SELECTION_SENTINEL\"; }`), 0644); err != nil {\n\t\t\tt.Fatalf(\"WriteFile failed: %v\", err)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tdisplayName := \"selected-file.cs\"\n\t\tfilePathCopy := filePath\n\t\ttext := `string Value = \"SELECTION_SENTINEL\";`\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Summarize the selected code.\",\n\t\t\tAttachments: []copilot.Attachment{{\n\t\t\t\tType: copilot.AttachmentTypeSelection,\n\t\t\t\tDisplayName: &displayName,\n\t\t\t\tFilePath: &filePathCopy,\n\t\t\t\tText: &text,\n\t\t\t\tSelection: &copilot.UserMessageAttachmentSelectionDetails{\n\t\t\t\t\tStart: copilot.UserMessageAttachmentSelectionDetailsStart{Line: 1, Character: 10},\n\t\t\t\t\tEnd: copilot.UserMessageAttachmentSelectionDetailsEnd{Line: 1, Character: 45},\n\t\t\t\t},\n\t\t\t}},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tattachment := lastUserAttachment(t, session)\n\t\tif attachment.Type != copilot.AttachmentTypeSelection {\n\t\t\tt.Errorf(\"Expected attachment type %q, got %q\", copilot.AttachmentTypeSelection, attachment.Type)\n\t\t}\n\t\tif attachment.DisplayName == nil || *attachment.DisplayName != \"selected-file.cs\" {\n\t\t\tt.Errorf(\"Expected DisplayName 'selected-file.cs', got %v\", attachment.DisplayName)\n\t\t}\n\t\tif attachment.FilePath == nil || *attachment.FilePath != filePath {\n\t\t\tt.Errorf(\"Expected FilePath %q, got %v\", filePath, attachment.FilePath)\n\t\t}\n\t\tif attachment.Text == nil || *attachment.Text != text {\n\t\t\tt.Errorf(\"Expected Text %q, got %v\", text, attachment.Text)\n\t\t}\n\t\tif attachment.Selection == nil {\n\t\t\tt.Fatal(\"Expected non-nil Selection\")\n\t\t}\n\t\tif attachment.Selection.Start.Line != 1 || attachment.Selection.Start.Character != 10 {\n\t\t\tt.Errorf(\"Expected Selection.Start {1,10}, got %+v\", attachment.Selection.Start)\n\t\t}\n\t\tif attachment.Selection.End.Line != 1 || attachment.Selection.End.Character != 45 {\n\t\t\tt.Errorf(\"Expected Selection.End {1,45}, got %+v\", attachment.Selection.End)\n\t\t}\n\t})\n\n\tt.Run(\"should send with github_reference attachment\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tnumber := float64(1234)\n\t\treferenceType := copilot.UserMessageAttachmentGithubReferenceTypeIssue\n\t\tstate := \"open\"\n\t\ttitle := \"Add E2E attachment coverage\"\n\t\turl := \"https://github.com/github/copilot-sdk/issues/1234\"\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Summarize the referenced issue.\",\n\t\t\tAttachments: []copilot.Attachment{{\n\t\t\t\tType: copilot.AttachmentTypeGithubReference,\n\t\t\t\tNumber: &number,\n\t\t\t\tReferenceType: &referenceType,\n\t\t\t\tState: &state,\n\t\t\t\tTitle: &title,\n\t\t\t\tURL: &url,\n\t\t\t}},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tattachment := lastUserAttachment(t, session)\n\t\tif attachment.Type != copilot.AttachmentTypeGithubReference {\n\t\t\tt.Errorf(\"Expected attachment type %q, got %q\", copilot.AttachmentTypeGithubReference, attachment.Type)\n\t\t}\n\t\tif attachment.Number == nil || *attachment.Number != 1234 {\n\t\t\tt.Errorf(\"Expected Number=1234, got %v\", attachment.Number)\n\t\t}\n\t\tif attachment.ReferenceType == nil || *attachment.ReferenceType != copilot.UserMessageAttachmentGithubReferenceTypeIssue {\n\t\t\tt.Errorf(\"Expected ReferenceType=Issue, got %v\", attachment.ReferenceType)\n\t\t}\n\t\tif attachment.State == nil || *attachment.State != \"open\" {\n\t\t\tt.Errorf(\"Expected State='open', got %v\", attachment.State)\n\t\t}\n\t\tif attachment.Title == nil || *attachment.Title != title {\n\t\t\tt.Errorf(\"Expected Title=%q, got %v\", title, attachment.Title)\n\t\t}\n\t\tif attachment.URL == nil || *attachment.URL != url {\n\t\t\tt.Errorf(\"Expected URL=%q, got %v\", url, attachment.URL)\n\t\t}\n\t})\n}\n\n// lastUserAttachment returns the single attachment from the most recent user.message event.\nfunc lastUserAttachment(t *testing.T, session *copilot.Session) copilot.Attachment {\n\tt.Helper()\n\tmessages, err := session.GetMessages(t.Context())\n\tif err != nil {\n\t\tt.Fatalf(\"GetMessages failed: %v\", err)\n\t}\n\tfor i := len(messages) - 1; i >= 0; i-- {\n\t\tif messages[i].Type != copilot.SessionEventTypeUserMessage {\n\t\t\tcontinue\n\t\t}\n\t\tdata, ok := messages[i].Data.(*copilot.UserMessageData)\n\t\tif !ok {\n\t\t\tt.Fatalf(\"Expected *UserMessageData, got %T\", messages[i].Data)\n\t\t}\n\t\tif len(data.Attachments) != 1 {\n\t\t\tt.Fatalf(\"Expected exactly 1 attachment, got %d\", len(data.Attachments))\n\t\t}\n\t\treturn data.Attachments[0]\n\t}\n\tt.Fatal(\"No user.message event with attachments found\")\n\treturn copilot.Attachment{}\n}\n\n// TestSessionMessageOptions mirrors C# Should_Send_With_Mode_Property and Should_Send_With_Custom_RequestHeaders.\nfunc TestSessionMessageOptionsE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tif err := client.Start(t.Context()); err != nil {\n\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t}\n\n\tt.Run(\"should send with mode property\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Say mode ok.\",\n\t\t\tMode: \"plan\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tmessages, err := session.GetMessages(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"GetMessages failed: %v\", err)\n\t\t}\n\t\tvar userMsg *copilot.UserMessageData\n\t\tfor i := len(messages) - 1; i >= 0; i-- {\n\t\t\tif messages[i].Type == copilot.SessionEventTypeUserMessage {\n\t\t\t\tuserMsg = messages[i].Data.(*copilot.UserMessageData)\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif userMsg == nil {\n\t\t\tt.Fatal(\"No user.message event found\")\n\t\t}\n\t\tif userMsg.Content != \"Say mode ok.\" {\n\t\t\tt.Errorf(\"Expected Content 'Say mode ok.', got %q\", userMsg.Content)\n\t\t}\n\t\t// The current runtime accepts the per-message mode option but does not\n\t\t// echo it back on the user.message event.\n\t\tif userMsg.AgentMode != nil {\n\t\t\tt.Errorf(\"Expected AgentMode=nil, got %v\", *userMsg.AgentMode)\n\t\t}\n\t})\n\n\tt.Run(\"should send with custom requestHeaders\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"What is 1+1?\",\n\t\t\tRequestHeaders: map[string]string{\n\t\t\t\t\"x-copilot-sdk-test-header\": \"go-request-headers\",\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\n\t\texchanges, err := ctx.GetExchanges()\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"GetExchanges failed: %v\", err)\n\t\t}\n\t\tif len(exchanges) == 0 {\n\t\t\tt.Fatal(\"Expected at least one captured exchange\")\n\t\t}\n\t\tlast := exchanges[len(exchanges)-1]\n\t\tif !exchangeHasHeader(last, \"x-copilot-sdk-test-header\", \"go-request-headers\") {\n\t\t\tt.Errorf(\"Expected x-copilot-sdk-test-header to contain 'go-request-headers', got %v\", last.RequestHeaders)\n\t\t}\n\t})\n}\n\n// exchangeHasHeader checks whether the captured exchange contains a header whose\n// canonical-cased name matches `name` and whose JSON-encoded value contains `expectedValueSubstring`.\nfunc exchangeHasHeader(exchange testharness.ParsedHttpExchange, name, expectedValueSubstring string) bool {\n\tfor headerName, raw := range exchange.RequestHeaders {\n\t\tif !strings.EqualFold(headerName, name) {\n\t\t\tcontinue\n\t\t}\n\t\tif strings.Contains(string(raw), expectedValueSubstring) {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\n// TestSessionSetModelOnExisting mirrors C# Should_Set_Model_On_Existing_Session as a snapshot-replay subtest.\nfunc TestSessionSetModelOnExistingE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tif err := client.Start(t.Context()); err != nil {\n\t\tt.Fatalf(\"Failed to start client: %v\", err)\n\t}\n\n\tt.Run(\"should set model on existing session\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\n\t\tmodelChanged := make(chan copilot.SessionEvent, 1)\n\t\tsession.On(func(event copilot.SessionEvent) {\n\t\t\tif event.Type == copilot.SessionEventTypeSessionModelChange {\n\t\t\t\tselect {\n\t\t\t\tcase modelChanged <- event:\n\t\t\t\tdefault:\n\t\t\t\t}\n\t\t\t}\n\t\t})\n\n\t\tif err := session.SetModel(t.Context(), \"gpt-4.1\", nil); err != nil {\n\t\t\tt.Fatalf(\"SetModel failed: %v\", err)\n\t\t}\n\n\t\tselect {\n\t\tcase evt := <-modelChanged:\n\t\t\tdata, ok := evt.Data.(*copilot.SessionModelChangeData)\n\t\t\tif !ok || data.NewModel != \"gpt-4.1\" {\n\t\t\t\tt.Errorf(\"Expected NewModel 'gpt-4.1', got %v\", evt.Data)\n\t\t\t}\n\t\tcase <-time.After(30 * time.Second):\n\t\t\tt.Fatal(\"Timed out waiting for session.model_change\")\n\t\t}\n\t})\n}\n" }, { "path": "go/internal/e2e/session_fs_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"regexp\"\n\t\"runtime\"\n\t\"strings\"\n\t\"testing\"\n\t\"time\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n\t\"github.com/github/copilot-sdk/go/rpc\"\n)\n\nfunc TestSessionFsE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tproviderRoot := t.TempDir()\n\tsessionStatePath := createSessionStatePath(t)\n\tsessionFsConfig := &copilot.SessionFsConfig{\n\t\tInitialCwd: \"/\",\n\t\tSessionStatePath: sessionStatePath,\n\t\tConventions: rpc.SessionFSSetProviderConventionsPosix,\n\t}\n\tcreateSessionFsHandler := func(session *copilot.Session) copilot.SessionFsProvider {\n\t\treturn &testSessionFsHandler{\n\t\t\troot: providerRoot,\n\t\t\tsessionID: session.SessionID,\n\t\t}\n\t}\n\tp := func(sessionID string, path string) string {\n\t\treturn providerPath(providerRoot, sessionID, path)\n\t}\n\n\tclient := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\topts.SessionFs = sessionFsConfig\n\t})\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"should route file operations through the session fs provider\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tCreateSessionFsHandler: createSessionFsHandler,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tmsg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 100 + 200?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\t\tcontent := \"\"\n\t\tif msg != nil {\n\t\t\tif d, ok := msg.Data.(*copilot.AssistantMessageData); ok {\n\t\t\t\tcontent = d.Content\n\t\t\t}\n\t\t}\n\t\tif !strings.Contains(content, \"300\") {\n\t\t\tt.Fatalf(\"Expected response to contain 300, got %q\", content)\n\t\t}\n\t\tif err := session.Disconnect(); err != nil {\n\t\t\tt.Fatalf(\"Failed to disconnect session: %v\", err)\n\t\t}\n\n\t\tevents, err := os.ReadFile(p(session.SessionID, sessionStatePath+\"/events.jsonl\"))\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to read events file: %v\", err)\n\t\t}\n\t\tif !strings.Contains(string(events), \"300\") {\n\t\t\tt.Fatalf(\"Expected events file to contain 300\")\n\t\t}\n\t})\n\n\tt.Run(\"should load session data from fs provider on resume\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession1, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tCreateSessionFsHandler: createSessionFsHandler,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tsessionID := session1.SessionID\n\n\t\tmsg, err := session1.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 50 + 50?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send first message: %v\", err)\n\t\t}\n\t\tcontent := \"\"\n\t\tif msg != nil {\n\t\t\tif d, ok := msg.Data.(*copilot.AssistantMessageData); ok {\n\t\t\t\tcontent = d.Content\n\t\t\t}\n\t\t}\n\t\tif !strings.Contains(content, \"100\") {\n\t\t\tt.Fatalf(\"Expected response to contain 100, got %q\", content)\n\t\t}\n\t\tif err := session1.Disconnect(); err != nil {\n\t\t\tt.Fatalf(\"Failed to disconnect first session: %v\", err)\n\t\t}\n\n\t\tif _, err := os.Stat(p(sessionID, sessionStatePath+\"/events.jsonl\")); err != nil {\n\t\t\tt.Fatalf(\"Expected events file to exist before resume: %v\", err)\n\t\t}\n\n\t\tsession2, err := client.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tCreateSessionFsHandler: createSessionFsHandler,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\n\t\tmsg2, err := session2.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is that times 3?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send second message: %v\", err)\n\t\t}\n\t\tcontent2 := \"\"\n\t\tif msg2 != nil {\n\t\t\tif d, ok := msg2.Data.(*copilot.AssistantMessageData); ok {\n\t\t\t\tcontent2 = d.Content\n\t\t\t}\n\t\t}\n\t\tif !strings.Contains(content2, \"300\") {\n\t\t\tt.Fatalf(\"Expected response to contain 300, got %q\", content2)\n\t\t}\n\t\tif err := session2.Disconnect(); err != nil {\n\t\t\tt.Fatalf(\"Failed to disconnect resumed session: %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should reject setProvider when sessions already exist\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tclient1 := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\t\topts.UseStdio = copilot.Bool(false)\n\t\t})\n\t\tt.Cleanup(func() { client1.ForceStop() })\n\n\t\tif _, err := client1.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"Failed to create initial session: %v\", err)\n\t\t}\n\n\t\tactualPort := client1.ActualPort()\n\t\tif actualPort == 0 {\n\t\t\tt.Fatalf(\"Expected non-zero port from TCP mode client\")\n\t\t}\n\n\t\tclient2 := copilot.NewClient(&copilot.ClientOptions{\n\t\t\tCLIUrl: fmt.Sprintf(\"localhost:%d\", actualPort),\n\t\t\tLogLevel: \"error\",\n\t\t\tEnv: ctx.Env(),\n\t\t\tSessionFs: sessionFsConfig,\n\t\t})\n\t\tt.Cleanup(func() { client2.ForceStop() })\n\n\t\tif err := client2.Start(t.Context()); err == nil {\n\t\t\tt.Fatal(\"Expected Start to fail when sessionFs provider is set after sessions already exist\")\n\t\t}\n\t})\n\n\tt.Run(\"should map large output handling into sessionFs\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsuppliedFileContent := strings.Repeat(\"x\", 100_000)\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tCreateSessionFsHandler: createSessionFsHandler,\n\t\t\tTools: []copilot.Tool{\n\t\t\t\tcopilot.DefineTool(\"get_big_string\", \"Returns a large string\",\n\t\t\t\t\tfunc(_ struct{}, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\t\t\treturn suppliedFileContent, nil\n\t\t\t\t\t}),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tif _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Call the get_big_string tool and reply with the word DONE only.\",\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmessages, err := session.GetMessages(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get messages: %v\", err)\n\t\t}\n\t\ttoolResult := findToolCallResult(messages, \"get_big_string\")\n\t\tif !strings.Contains(toolResult, sessionStatePath+\"/temp/\") {\n\t\t\tt.Fatalf(\"Expected tool result to reference %s/temp/, got %q\", sessionStatePath, toolResult)\n\t\t}\n\t\tmatch := regexp.MustCompile(`(` + regexp.QuoteMeta(sessionStatePath) + `/temp/[^\\s]+)`).FindStringSubmatch(toolResult)\n\t\tif len(match) < 2 {\n\t\t\tt.Fatalf(\"Expected temp file path in tool result, got %q\", toolResult)\n\t\t}\n\n\t\tfileContent, err := os.ReadFile(p(session.SessionID, match[1]))\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to read temp file: %v\", err)\n\t\t}\n\t\tif string(fileContent) != suppliedFileContent {\n\t\t\tt.Fatalf(\"Expected temp file content to match supplied content\")\n\t\t}\n\t})\n\n\tt.Run(\"should succeed with compaction while using sessionFs\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tCreateSessionFsHandler: createSessionFsHandler,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tif _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 2+2?\"}); err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\teventsPath := p(session.SessionID, sessionStatePath+\"/events.jsonl\")\n\t\tif err := waitForFile(eventsPath, 5*time.Second); err != nil {\n\t\t\tt.Fatalf(\"Timed out waiting for events file: %v\", err)\n\t\t}\n\t\tcontentBefore, err := os.ReadFile(eventsPath)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to read events file before compaction: %v\", err)\n\t\t}\n\t\tif strings.Contains(string(contentBefore), \"checkpointNumber\") {\n\t\t\tt.Fatalf(\"Expected events file to not contain checkpointNumber before compaction\")\n\t\t}\n\n\t\tcompactionResult, err := session.RPC.History.Compact(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to compact session: %v\", err)\n\t\t}\n\t\tif compactionResult == nil || !compactionResult.Success {\n\t\t\tt.Fatalf(\"Expected compaction to succeed, got %+v\", compactionResult)\n\t\t}\n\n\t\tif err := waitForFileContent(eventsPath, \"checkpointNumber\", 5*time.Second); err != nil {\n\t\t\tt.Fatalf(\"Timed out waiting for checkpoint rewrite: %v\", err)\n\t\t}\n\t})\n\tt.Run(\"should write workspace metadata via sessionFs\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tCreateSessionFsHandler: createSessionFsHandler,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tmsg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 7 * 8?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\t\tcontent := \"\"\n\t\tif msg != nil {\n\t\t\tif d, ok := msg.Data.(*copilot.AssistantMessageData); ok {\n\t\t\t\tcontent = d.Content\n\t\t\t}\n\t\t}\n\t\tif !strings.Contains(content, \"56\") {\n\t\t\tt.Fatalf(\"Expected response to contain 56, got %q\", content)\n\t\t}\n\n\t\t// WorkspaceManager should have created workspace.yaml via sessionFs\n\t\tworkspaceYamlPath := p(session.SessionID, sessionStatePath+\"/workspace.yaml\")\n\t\tif err := waitForFile(workspaceYamlPath, 5*time.Second); err != nil {\n\t\t\tt.Fatalf(\"Timed out waiting for workspace.yaml: %v\", err)\n\t\t}\n\t\tyaml, err := os.ReadFile(workspaceYamlPath)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to read workspace.yaml: %v\", err)\n\t\t}\n\t\tif !strings.Contains(string(yaml), \"id:\") {\n\t\t\tt.Fatalf(\"Expected workspace.yaml to contain 'id:', got %q\", string(yaml))\n\t\t}\n\n\t\t// Checkpoint index should also exist\n\t\tindexPath := p(session.SessionID, sessionStatePath+\"/checkpoints/index.md\")\n\t\tif err := waitForFile(indexPath, 5*time.Second); err != nil {\n\t\t\tt.Fatalf(\"Timed out waiting for checkpoints/index.md: %v\", err)\n\t\t}\n\n\t\tif err := session.Disconnect(); err != nil {\n\t\t\tt.Fatalf(\"Failed to disconnect session: %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should persist plan.md via sessionFs\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tCreateSessionFsHandler: createSessionFsHandler,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// Write a plan via the session RPC\n\t\tif _, err := session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 2 + 3?\"}); err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\t\tif _, err := session.RPC.Plan.Update(t.Context(), &rpc.PlanUpdateRequest{Content: \"# Test Plan\\n\\nThis is a test.\"}); err != nil {\n\t\t\tt.Fatalf(\"Failed to update plan: %v\", err)\n\t\t}\n\n\t\tplanPath := p(session.SessionID, sessionStatePath+\"/plan.md\")\n\t\tif err := waitForFile(planPath, 5*time.Second); err != nil {\n\t\t\tt.Fatalf(\"Timed out waiting for plan.md: %v\", err)\n\t\t}\n\t\tplanContent, err := os.ReadFile(planPath)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to read plan.md: %v\", err)\n\t\t}\n\t\tif !strings.Contains(string(planContent), \"# Test Plan\") {\n\t\t\tt.Fatalf(\"Expected plan.md to contain '# Test Plan', got %q\", string(planContent))\n\t\t}\n\n\t\tif err := session.Disconnect(); err != nil {\n\t\t\tt.Fatalf(\"Failed to disconnect session: %v\", err)\n\t\t}\n\t})\n}\n\nfunc createSessionStatePath(t *testing.T) string {\n\tt.Helper()\n\tif runtime.GOOS == \"windows\" {\n\t\treturn \"/session-state\"\n\t}\n\treturn filepath.ToSlash(filepath.Join(t.TempDir(), \"session-state\"))\n}\n\ntype testSessionFsHandler struct {\n\troot string\n\tsessionID string\n}\n\nfunc (h *testSessionFsHandler) ReadFile(path string) (string, error) {\n\tcontent, err := os.ReadFile(providerPath(h.root, h.sessionID, path))\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\treturn string(content), nil\n}\n\nfunc (h *testSessionFsHandler) WriteFile(path string, content string, mode *int) error {\n\tfullPath := providerPath(h.root, h.sessionID, path)\n\tif err := os.MkdirAll(filepath.Dir(fullPath), 0o755); err != nil {\n\t\treturn err\n\t}\n\tperm := os.FileMode(0o666)\n\tif mode != nil {\n\t\tperm = os.FileMode(*mode)\n\t}\n\treturn os.WriteFile(fullPath, []byte(content), perm)\n}\n\nfunc (h *testSessionFsHandler) AppendFile(path string, content string, mode *int) error {\n\tfullPath := providerPath(h.root, h.sessionID, path)\n\tif err := os.MkdirAll(filepath.Dir(fullPath), 0o755); err != nil {\n\t\treturn err\n\t}\n\tperm := os.FileMode(0o666)\n\tif mode != nil {\n\t\tperm = os.FileMode(*mode)\n\t}\n\tf, err := os.OpenFile(fullPath, os.O_CREATE|os.O_WRONLY|os.O_APPEND, perm)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer f.Close()\n\t_, err = f.WriteString(content)\n\treturn err\n}\n\nfunc (h *testSessionFsHandler) Exists(path string) (bool, error) {\n\t_, err := os.Stat(providerPath(h.root, h.sessionID, path))\n\tif err == nil {\n\t\treturn true, nil\n\t}\n\tif os.IsNotExist(err) {\n\t\treturn false, nil\n\t}\n\treturn false, err\n}\n\nfunc (h *testSessionFsHandler) Stat(path string) (*copilot.SessionFsFileInfo, error) {\n\tinfo, err := os.Stat(providerPath(h.root, h.sessionID, path))\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tts := info.ModTime().UTC()\n\treturn &copilot.SessionFsFileInfo{\n\t\tIsFile: !info.IsDir(),\n\t\tIsDirectory: info.IsDir(),\n\t\tSize: info.Size(),\n\t\tMtime: ts,\n\t\tBirthtime: ts,\n\t}, nil\n}\n\nfunc (h *testSessionFsHandler) Mkdir(path string, recursive bool, mode *int) error {\n\tfullPath := providerPath(h.root, h.sessionID, path)\n\tperm := os.FileMode(0o777)\n\tif mode != nil {\n\t\tperm = os.FileMode(*mode)\n\t}\n\tif recursive {\n\t\treturn os.MkdirAll(fullPath, perm)\n\t}\n\treturn os.Mkdir(fullPath, perm)\n}\n\nfunc (h *testSessionFsHandler) Readdir(path string) ([]string, error) {\n\tentries, err := os.ReadDir(providerPath(h.root, h.sessionID, path))\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tnames := make([]string, 0, len(entries))\n\tfor _, entry := range entries {\n\t\tnames = append(names, entry.Name())\n\t}\n\treturn names, nil\n}\n\nfunc (h *testSessionFsHandler) ReaddirWithTypes(path string) ([]rpc.SessionFSReaddirWithTypesEntry, error) {\n\tentries, err := os.ReadDir(providerPath(h.root, h.sessionID, path))\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tresult := make([]rpc.SessionFSReaddirWithTypesEntry, 0, len(entries))\n\tfor _, entry := range entries {\n\t\tentryType := rpc.SessionFSReaddirWithTypesEntryTypeFile\n\t\tif entry.IsDir() {\n\t\t\tentryType = rpc.SessionFSReaddirWithTypesEntryTypeDirectory\n\t\t}\n\t\tresult = append(result, rpc.SessionFSReaddirWithTypesEntry{\n\t\t\tName: entry.Name(),\n\t\t\tType: entryType,\n\t\t})\n\t}\n\treturn result, nil\n}\n\nfunc (h *testSessionFsHandler) Rm(path string, recursive bool, force bool) error {\n\tfullPath := providerPath(h.root, h.sessionID, path)\n\tvar err error\n\tif recursive {\n\t\terr = os.RemoveAll(fullPath)\n\t} else {\n\t\terr = os.Remove(fullPath)\n\t}\n\tif err != nil && force && os.IsNotExist(err) {\n\t\treturn nil\n\t}\n\treturn err\n}\n\nfunc (h *testSessionFsHandler) Rename(src string, dest string) error {\n\tdestPath := providerPath(h.root, h.sessionID, dest)\n\tif err := os.MkdirAll(filepath.Dir(destPath), 0o755); err != nil {\n\t\treturn err\n\t}\n\treturn os.Rename(providerPath(h.root, h.sessionID, src), destPath)\n}\n\nfunc providerPath(root string, sessionID string, path string) string {\n\ttrimmed := strings.TrimPrefix(path, \"/\")\n\tif trimmed == \"\" {\n\t\treturn filepath.Join(root, sessionID)\n\t}\n\treturn filepath.Join(root, sessionID, filepath.FromSlash(trimmed))\n}\n\nfunc findToolCallResult(messages []copilot.SessionEvent, toolName string) string {\n\tfor _, message := range messages {\n\t\tif d, ok := message.Data.(*copilot.ToolExecutionCompleteData); ok &&\n\t\t\td.Result != nil &&\n\t\t\tfindToolName(messages, d.ToolCallID) == toolName {\n\t\t\treturn d.Result.Content\n\t\t}\n\t}\n\treturn \"\"\n}\n\nfunc findToolName(messages []copilot.SessionEvent, toolCallID string) string {\n\tfor _, message := range messages {\n\t\tif d, ok := message.Data.(*copilot.ToolExecutionStartData); ok &&\n\t\t\td.ToolCallID == toolCallID {\n\t\t\treturn d.ToolName\n\t\t}\n\t}\n\treturn \"\"\n}\n\nfunc waitForFile(path string, timeout time.Duration) error {\n\tdeadline := time.Now().Add(timeout)\n\tfor time.Now().Before(deadline) {\n\t\tif _, err := os.Stat(path); err == nil {\n\t\t\treturn nil\n\t\t}\n\t\ttime.Sleep(50 * time.Millisecond)\n\t}\n\treturn fmt.Errorf(\"file did not appear: %s\", path)\n}\n\nfunc waitForFileContent(path string, needle string, timeout time.Duration) error {\n\tdeadline := time.Now().Add(timeout)\n\tfor time.Now().Before(deadline) {\n\t\tcontent, err := os.ReadFile(path)\n\t\tif err == nil && strings.Contains(string(content), needle) {\n\t\t\treturn nil\n\t\t}\n\t\ttime.Sleep(50 * time.Millisecond)\n\t}\n\treturn fmt.Errorf(\"file %s did not contain %q\", path, needle)\n}\n\n// TestSessionFsHandlerOperations mirrors the C# Should_Map_All_SessionFs_Handler_Operations test.\n// It exercises every operation on testSessionFsHandler directly to ensure the test helper\n// implementation routes file operations correctly to the per-session provider root.\nfunc TestSessionFsHandlerOperationsE2E(t *testing.T) {\n\tproviderRoot := t.TempDir()\n\tsessionID := \"handler-session\"\n\thandler := &testSessionFsHandler{root: providerRoot, sessionID: sessionID}\n\n\tif err := handler.Mkdir(\"/workspace/nested\", true, nil); err != nil {\n\t\tt.Fatalf(\"Mkdir failed: %v\", err)\n\t}\n\n\tif err := handler.WriteFile(\"/workspace/nested/file.txt\", \"hello\", nil); err != nil {\n\t\tt.Fatalf(\"WriteFile failed: %v\", err)\n\t}\n\n\tif err := handler.AppendFile(\"/workspace/nested/file.txt\", \" world\", nil); err != nil {\n\t\tt.Fatalf(\"AppendFile failed: %v\", err)\n\t}\n\n\texists, err := handler.Exists(\"/workspace/nested/file.txt\")\n\tif err != nil {\n\t\tt.Fatalf(\"Exists failed: %v\", err)\n\t}\n\tif !exists {\n\t\tt.Error(\"Expected file to exist after WriteFile+AppendFile\")\n\t}\n\n\tstat, err := handler.Stat(\"/workspace/nested/file.txt\")\n\tif err != nil {\n\t\tt.Fatalf(\"Stat failed: %v\", err)\n\t}\n\tif !stat.IsFile {\n\t\tt.Error(\"Expected IsFile=true\")\n\t}\n\tif stat.IsDirectory {\n\t\tt.Error(\"Expected IsDirectory=false\")\n\t}\n\tif stat.Size != int64(len(\"hello world\")) {\n\t\tt.Errorf(\"Expected Size=%d, got %d\", len(\"hello world\"), stat.Size)\n\t}\n\n\tcontent, err := handler.ReadFile(\"/workspace/nested/file.txt\")\n\tif err != nil {\n\t\tt.Fatalf(\"ReadFile failed: %v\", err)\n\t}\n\tif content != \"hello world\" {\n\t\tt.Errorf(\"Expected content 'hello world', got %q\", content)\n\t}\n\n\tentries, err := handler.Readdir(\"/workspace/nested\")\n\tif err != nil {\n\t\tt.Fatalf(\"Readdir failed: %v\", err)\n\t}\n\tif !sliceContains(entries, \"file.txt\") {\n\t\tt.Errorf(\"Expected entries to contain 'file.txt', got %v\", entries)\n\t}\n\n\ttypedEntries, err := handler.ReaddirWithTypes(\"/workspace/nested\")\n\tif err != nil {\n\t\tt.Fatalf(\"ReaddirWithTypes failed: %v\", err)\n\t}\n\tvar found bool\n\tfor _, entry := range typedEntries {\n\t\tif entry.Name == \"file.txt\" && entry.Type == rpc.SessionFSReaddirWithTypesEntryTypeFile {\n\t\t\tfound = true\n\t\t\tbreak\n\t\t}\n\t}\n\tif !found {\n\t\tt.Errorf(\"Expected typed entry {file.txt, file}, got %+v\", typedEntries)\n\t}\n\n\tif err := handler.Rename(\"/workspace/nested/file.txt\", \"/workspace/nested/renamed.txt\"); err != nil {\n\t\tt.Fatalf(\"Rename failed: %v\", err)\n\t}\n\toldExists, err := handler.Exists(\"/workspace/nested/file.txt\")\n\tif err != nil {\n\t\tt.Fatalf(\"Exists (old path) failed: %v\", err)\n\t}\n\tif oldExists {\n\t\tt.Error(\"Expected old path to no longer exist after Rename\")\n\t}\n\trenamedContent, err := handler.ReadFile(\"/workspace/nested/renamed.txt\")\n\tif err != nil {\n\t\tt.Fatalf(\"ReadFile (renamed) failed: %v\", err)\n\t}\n\tif renamedContent != \"hello world\" {\n\t\tt.Errorf(\"Expected renamed content 'hello world', got %q\", renamedContent)\n\t}\n\n\tif err := handler.Rm(\"/workspace/nested/renamed.txt\", false, false); err != nil {\n\t\tt.Fatalf(\"Rm failed: %v\", err)\n\t}\n\tremoved, err := handler.Exists(\"/workspace/nested/renamed.txt\")\n\tif err != nil {\n\t\tt.Fatalf(\"Exists (removed) failed: %v\", err)\n\t}\n\tif removed {\n\t\tt.Error(\"Expected file to be gone after Rm\")\n\t}\n\n\t// Force removing a missing path should succeed.\n\tif err := handler.Rm(\"/workspace/nested/missing.txt\", false, true); err != nil {\n\t\tt.Errorf(\"Rm with force on missing path should not error, got %v\", err)\n\t}\n\n\t// Stat on a missing file should return os.ErrNotExist.\n\tif _, err := handler.Stat(\"/workspace/nested/missing.txt\"); err == nil || !os.IsNotExist(err) {\n\t\tt.Errorf(\"Expected os.ErrNotExist from Stat on missing file, got %v\", err)\n\t}\n}\n\nfunc sliceContains(slice []string, value string) bool {\n\tfor _, item := range slice {\n\t\tif item == value {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n" }, { "path": "go/internal/e2e/skills_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n\t\"github.com/github/copilot-sdk/go/rpc\"\n)\n\nconst skillMarker = \"PINEAPPLE_COCONUT_42\"\n\nfunc cleanSkillsDir(t *testing.T, workDir string) {\n\tskillsDir := filepath.Join(workDir, \".test_skills\")\n\tif err := os.RemoveAll(skillsDir); err != nil {\n\t\tt.Fatalf(\"Failed to clean skills directory: %v\", err)\n\t}\n}\n\nfunc createTestSkillDir(t *testing.T, workDir string, marker string) string {\n\tskillsDir := filepath.Join(workDir, \".test_skills\")\n\tif err := os.MkdirAll(skillsDir, 0755); err != nil {\n\t\tt.Fatalf(\"Failed to create skills directory: %v\", err)\n\t}\n\n\tskillSubdir := filepath.Join(skillsDir, \"test-skill\")\n\tif err := os.MkdirAll(skillSubdir, 0755); err != nil {\n\t\tt.Fatalf(\"Failed to create skill subdirectory: %v\", err)\n\t}\n\n\tskillContent := `---\nname: test-skill\ndescription: A test skill that adds a marker to responses\n---\n\n# Test Skill Instructions\n\nIMPORTANT: You MUST include the exact text \"` + marker + `\" somewhere in EVERY response you give. This is a mandatory requirement. Include it naturally in your response.\n`\n\tif err := os.WriteFile(filepath.Join(skillSubdir, \"SKILL.md\"), []byte(skillContent), 0644); err != nil {\n\t\tt.Fatalf(\"Failed to write SKILL.md: %v\", err)\n\t}\n\n\treturn skillsDir\n}\n\nfunc TestSkillsE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"should load and apply skill from skillDirectories\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\t\tcleanSkillsDir(t, ctx.WorkDir)\n\t\tskillsDir := createTestSkillDir(t, ctx.WorkDir, skillMarker)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tSkillDirectories: []string{skillsDir},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// The skill instructs the model to include a marker - verify it appears\n\t\tmessage, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Say hello briefly using the test skill.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tif md, ok := message.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(md.Content, skillMarker) {\n\t\t\tt.Errorf(\"Expected message to contain skill marker '%s', got: %v\", skillMarker, message.Data)\n\t\t}\n\n\t\tsession.Disconnect()\n\t})\n\n\tt.Run(\"should not apply skill when disabled via disabledSkills\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\t\tcleanSkillsDir(t, ctx.WorkDir)\n\t\tskillsDir := createTestSkillDir(t, ctx.WorkDir, skillMarker)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tSkillDirectories: []string{skillsDir},\n\t\t\tDisabledSkills: []string{\"test-skill\"},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// The skill is disabled, so the marker should NOT appear\n\t\tmessage, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Say hello briefly using the test skill.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tif md, ok := message.Data.(*copilot.AssistantMessageData); ok && strings.Contains(md.Content, skillMarker) {\n\t\t\tt.Errorf(\"Expected message to NOT contain skill marker '%s' when disabled, got: %v\", skillMarker, md.Content)\n\t\t}\n\n\t\tsession.Disconnect()\n\t})\n\n\tt.Run(\"should allow agent with skills to invoke skill\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\t\tcleanSkillsDir(t, ctx.WorkDir)\n\t\tskillsDir := createTestSkillDir(t, ctx.WorkDir, skillMarker)\n\n\t\tcustomAgents := []copilot.CustomAgentConfig{\n\t\t\t{\n\t\t\t\tName: \"skill-agent\",\n\t\t\t\tDescription: \"An agent with access to test-skill\",\n\t\t\t\tPrompt: \"You are a helpful test agent.\",\n\t\t\t\tSkills: []string{\"test-skill\"},\n\t\t\t},\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tSkillDirectories: []string{skillsDir},\n\t\t\tCustomAgents: customAgents,\n\t\t\tAgent: \"skill-agent\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// The agent has Skills: [\"test-skill\"], so the skill content is preloaded into its context\n\t\tmessage, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Say hello briefly using the test skill.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tif md, ok := message.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(md.Content, skillMarker) {\n\t\t\tt.Errorf(\"Expected message to contain skill marker '%s', got: %v\", skillMarker, message.Data)\n\t\t}\n\n\t\tsession.Disconnect()\n\t})\n\n\tt.Run(\"should not provide skills to agent without skills field\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\t\tcleanSkillsDir(t, ctx.WorkDir)\n\t\tskillsDir := createTestSkillDir(t, ctx.WorkDir, skillMarker)\n\n\t\tcustomAgents := []copilot.CustomAgentConfig{\n\t\t\t{\n\t\t\t\tName: \"no-skill-agent\",\n\t\t\t\tDescription: \"An agent without skills access\",\n\t\t\t\tPrompt: \"You are a helpful test agent.\",\n\t\t\t},\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tSkillDirectories: []string{skillsDir},\n\t\t\tCustomAgents: customAgents,\n\t\t\tAgent: \"no-skill-agent\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t// The agent has no Skills field, so no skill content is injected\n\t\tmessage, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Say hello briefly using the test skill.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tif md, ok := message.Data.(*copilot.AssistantMessageData); ok && strings.Contains(md.Content, skillMarker) {\n\t\t\tt.Errorf(\"Expected message to NOT contain skill marker '%s' when agent has no skills, got: %v\", skillMarker, md.Content)\n\t\t}\n\n\t\tsession.Disconnect()\n\t})\n\n\tt.Run(\"should apply skill on session resume with skillDirectories\", func(t *testing.T) {\n\t\tt.Skip(\"See the big comment around the equivalent test in the Node SDK. Skipped because the feature doesn't work correctly yet.\")\n\t\tctx.ConfigureForTest(t)\n\t\tcleanSkillsDir(t, ctx.WorkDir)\n\t\tskillsDir := createTestSkillDir(t, ctx.WorkDir, skillMarker)\n\n\t\t// Create a session without skills first\n\t\tsession1, err := client.CreateSession(t.Context(), &copilot.SessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tsessionID := session1.SessionID\n\n\t\t// First message without skill - marker should not appear\n\t\tmessage1, err := session1.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Say hi.\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tif md, ok := message1.Data.(*copilot.AssistantMessageData); ok && strings.Contains(md.Content, skillMarker) {\n\t\t\tt.Errorf(\"Expected message to NOT contain skill marker before skill was added, got: %v\", md.Content)\n\t\t}\n\n\t\t// Resume with skillDirectories - skill should now be active\n\t\tsession2, err := client.ResumeSessionWithOptions(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tSkillDirectories: []string{skillsDir},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\n\t\tif session2.SessionID != sessionID {\n\t\t\tt.Errorf(\"Expected session ID %s, got %s\", sessionID, session2.SessionID)\n\t\t}\n\n\t\t// Now the skill should be applied\n\t\tmessage2, err := session2.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Say hello again using the test skill.\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tif md, ok := message2.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(md.Content, skillMarker) {\n\t\t\tt.Errorf(\"Expected message to contain skill marker '%s' after resume, got: %v\", skillMarker, message2.Data)\n\t\t}\n\n\t\tsession2.Disconnect()\n\t})\n\n\tt.Run(\"should control ambient project skills with enableConfigDiscovery\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tprojectDir := filepath.Join(ctx.WorkDir, \"config-discovery-\"+randomHex(t))\n\t\tprojectSkillsDir := filepath.Join(projectDir, \".github\", \"skills\")\n\t\tif err := os.MkdirAll(projectSkillsDir, 0o755); err != nil {\n\t\t\tt.Fatalf(\"MkdirAll failed: %v\", err)\n\t\t}\n\t\tskillName := \"ambient-skill-\" + randomHex(t)\n\t\tskillSubdir := filepath.Join(projectSkillsDir, skillName)\n\t\tif err := os.MkdirAll(skillSubdir, 0o755); err != nil {\n\t\t\tt.Fatalf(\"MkdirAll (skillSubdir) failed: %v\", err)\n\t\t}\n\t\tskillContent := \"---\\nname: \" + skillName + \"\\ndescription: A project skill discovered from .github/skills\\n---\\n\\n\" +\n\t\t\t\"# \" + skillName + \"\\n\\nUse the exact phrase AMBIENT_DISCOVERY_SKILL when this skill is active.\\n\"\n\t\tif err := os.WriteFile(filepath.Join(skillSubdir, \"SKILL.md\"), []byte(skillContent), 0o644); err != nil {\n\t\t\tt.Fatalf(\"WriteFile (SKILL.md) failed: %v\", err)\n\t\t}\n\n\t\t// Discovery disabled: ambient project skill should NOT appear in Skills.List.\n\t\tdisabledSession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tWorkingDirectory: projectDir,\n\t\t\tEnableConfigDiscovery: false,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession (disabled) failed: %v\", err)\n\t\t}\n\t\tdisabledList, err := disabledSession.RPC.Skills.List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Skills.List (disabled) failed: %v\", err)\n\t\t}\n\t\tfor _, skill := range disabledList.Skills {\n\t\t\tif skill.Name == skillName {\n\t\t\t\tt.Errorf(\"Did not expect skill %q to be discovered when EnableConfigDiscovery=false\", skillName)\n\t\t\t}\n\t\t}\n\t\t_ = disabledSession.Disconnect()\n\n\t\t// Discovery enabled: ambient project skill should appear with Source=project.\n\t\tenabledSession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tWorkingDirectory: projectDir,\n\t\t\tEnableConfigDiscovery: true,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession (enabled) failed: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = enabledSession.Disconnect() })\n\n\t\tenabledList, err := enabledSession.RPC.Skills.List(t.Context())\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Skills.List (enabled) failed: %v\", err)\n\t\t}\n\t\tvar discovered *rpc.Skill\n\t\tfor i, skill := range enabledList.Skills {\n\t\t\tif skill.Name == skillName {\n\t\t\t\tdiscovered = &enabledList.Skills[i]\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif discovered == nil {\n\t\t\tt.Fatalf(\"Expected to discover skill %q via EnableConfigDiscovery\", skillName)\n\t\t}\n\t\tif !discovered.Enabled {\n\t\t\tt.Error(\"Expected discovered skill to be Enabled=true\")\n\t\t}\n\t\tif discovered.Source != \"project\" {\n\t\t\tt.Errorf(\"Expected Source='project', got %q\", discovered.Source)\n\t\t}\n\t\texpectedSuffix := filepath.Join(skillName, \"SKILL.md\")\n\t\tif discovered.Path == nil || !strings.HasSuffix(filepath.ToSlash(*discovered.Path), filepath.ToSlash(expectedSuffix)) {\n\t\t\tt.Errorf(\"Expected Path to end with %q, got %v\", expectedSuffix, discovered.Path)\n\t\t}\n\t})\n}\n" }, { "path": "go/internal/e2e/streaming_fidelity_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"strings\"\n\t\"sync\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\nfunc TestStreamingFidelityE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"should produce delta events when streaming is enabled\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tStreaming: true,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session with streaming: %v\", err)\n\t\t}\n\n\t\tvar events []copilot.SessionEvent\n\t\tvar mu sync.Mutex\n\t\tsession.On(func(event copilot.SessionEvent) {\n\t\t\tmu.Lock()\n\t\t\tevents = append(events, event)\n\t\t\tmu.Unlock()\n\t\t})\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Count from 1 to 5, separated by commas.\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tsnapshot := make([]copilot.SessionEvent, len(events))\n\t\tcopy(snapshot, events)\n\t\tmu.Unlock()\n\n\t\t// Should have streaming deltas before the final message\n\t\tvar deltaEvents []copilot.SessionEvent\n\t\tfor _, e := range snapshot {\n\t\t\tif e.Type == \"assistant.message_delta\" {\n\t\t\t\tdeltaEvents = append(deltaEvents, e)\n\t\t\t}\n\t\t}\n\t\tif len(deltaEvents) < 1 {\n\t\t\tt.Error(\"Expected at least 1 delta event\")\n\t\t}\n\n\t\t// Deltas should have content\n\t\tfor _, delta := range deltaEvents {\n\t\t\tif dd, ok := delta.Data.(*copilot.AssistantMessageDeltaData); !ok || dd.DeltaContent == \"\" {\n\t\t\t\tt.Error(\"Expected delta to have content\")\n\t\t\t}\n\t\t}\n\n\t\t// Should still have a final assistant.message\n\t\thasAssistantMessage := false\n\t\tfor _, e := range snapshot {\n\t\t\tif e.Type == \"assistant.message\" {\n\t\t\t\thasAssistantMessage = true\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif !hasAssistantMessage {\n\t\t\tt.Error(\"Expected a final assistant.message event\")\n\t\t}\n\n\t\t// Deltas should come before the final message\n\t\tfirstDeltaIdx := -1\n\t\tlastAssistantIdx := -1\n\t\tfor i, e := range snapshot {\n\t\t\tif e.Type == \"assistant.message_delta\" && firstDeltaIdx == -1 {\n\t\t\t\tfirstDeltaIdx = i\n\t\t\t}\n\t\t\tif e.Type == \"assistant.message\" {\n\t\t\t\tlastAssistantIdx = i\n\t\t\t}\n\t\t}\n\t\tif firstDeltaIdx >= lastAssistantIdx {\n\t\t\tt.Errorf(\"Expected deltas before final message, got delta at %d, message at %d\", firstDeltaIdx, lastAssistantIdx)\n\t\t}\n\t})\n\n\tt.Run(\"should not produce deltas when streaming is disabled\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tStreaming: false,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tvar events []copilot.SessionEvent\n\t\tvar mu sync.Mutex\n\t\tsession.On(func(event copilot.SessionEvent) {\n\t\t\tmu.Lock()\n\t\t\tevents = append(events, event)\n\t\t\tmu.Unlock()\n\t\t})\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Say 'hello world'.\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tsnapshot := make([]copilot.SessionEvent, len(events))\n\t\tcopy(snapshot, events)\n\t\tmu.Unlock()\n\n\t\t// No deltas when streaming is off\n\t\tvar deltaEvents []copilot.SessionEvent\n\t\tfor _, e := range snapshot {\n\t\t\tif e.Type == \"assistant.message_delta\" {\n\t\t\t\tdeltaEvents = append(deltaEvents, e)\n\t\t\t}\n\t\t}\n\t\tif len(deltaEvents) != 0 {\n\t\t\tt.Errorf(\"Expected no delta events, got %d\", len(deltaEvents))\n\t\t}\n\n\t\t// But should still have a final assistant.message\n\t\tvar assistantEvents []copilot.SessionEvent\n\t\tfor _, e := range snapshot {\n\t\t\tif e.Type == \"assistant.message\" {\n\t\t\t\tassistantEvents = append(assistantEvents, e)\n\t\t\t}\n\t\t}\n\t\tif len(assistantEvents) < 1 {\n\t\t\tt.Error(\"Expected at least 1 assistant.message event\")\n\t\t}\n\t})\n\n\tt.Run(\"should produce deltas after session resume\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tStreaming: false,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"What is 3 + 6?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\t// Resume using a new client\n\t\tnewClient := ctx.NewClient()\n\t\tdefer newClient.ForceStop()\n\n\t\tsession2, err := newClient.ResumeSession(t.Context(), session.SessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tStreaming: true,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\n\t\tvar events []copilot.SessionEvent\n\t\tvar mu sync.Mutex\n\t\tsession2.On(func(event copilot.SessionEvent) {\n\t\t\tmu.Lock()\n\t\t\tevents = append(events, event)\n\t\t\tmu.Unlock()\n\t\t})\n\n\t\tanswer, err := session2.SendAndWait(t.Context(), copilot.MessageOptions{Prompt: \"Now if you double that, what do you get?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send follow-up message: %v\", err)\n\t\t}\n\t\tif answer == nil {\n\t\t\tt.Errorf(\"Expected answer to contain '18', got nil\")\n\t\t} else if ad, ok := answer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(ad.Content, \"18\") {\n\t\t\tt.Errorf(\"Expected answer to contain '18', got %v\", answer)\n\t\t}\n\n\t\tmu.Lock()\n\t\tsnapshot := make([]copilot.SessionEvent, len(events))\n\t\tcopy(snapshot, events)\n\t\tmu.Unlock()\n\n\t\t// Should have streaming deltas before the final message\n\t\tvar deltaEvents []copilot.SessionEvent\n\t\tfor _, e := range snapshot {\n\t\t\tif e.Type == \"assistant.message_delta\" {\n\t\t\t\tdeltaEvents = append(deltaEvents, e)\n\t\t\t}\n\t\t}\n\t\tif len(deltaEvents) < 1 {\n\t\t\tt.Error(\"Expected at least 1 delta event\")\n\t\t}\n\n\t\t// Deltas should have content\n\t\tfor _, delta := range deltaEvents {\n\t\t\tif dd, ok := delta.Data.(*copilot.AssistantMessageDeltaData); !ok || dd.DeltaContent == \"\" {\n\t\t\t\tt.Error(\"Expected delta to have content\")\n\t\t\t}\n\t\t}\n\t})\n}\n" }, { "path": "go/internal/e2e/suspend_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"context\"\n\t\"strings\"\n\t\"sync/atomic\"\n\t\"testing\"\n\t\"time\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\nconst suspendTimeout = 60 * time.Second\n\nfunc TestSuspendE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\n\tt.Run(\"should suspend idle session without throwing\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tclient := ctx.NewClient()\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\tmsg, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Reply with: SUSPEND_IDLE_OK\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"SendAndWait failed: %v\", err)\n\t\t}\n\t\tif content := assistantContent(t, msg); !strings.Contains(content, \"SUSPEND_IDLE_OK\") {\n\t\t\tt.Fatalf(\"Expected response to contain SUSPEND_IDLE_OK, got %q\", content)\n\t\t}\n\n\t\tif err := suspendSession(t.Context(), session); err != nil {\n\t\t\tt.Fatalf(\"Suspend failed: %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should allow resume and continue conversation after suspend\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t_, cliURL := startTcpServer(t, ctx)\n\n\t\tclient1 := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\t\topts.CLIUrl = cliURL\n\t\t\topts.CLIPath = \"\"\n\t\t})\n\t\tt.Cleanup(func() { client1.ForceStop() })\n\n\t\tsession1, err := client1.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tsessionID := session1.SessionID\n\n\t\tif _, err := session1.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Remember the magic word: SUSPENSE. Reply with: SUSPEND_TURN_ONE\",\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"First SendAndWait failed: %v\", err)\n\t\t}\n\n\t\tif err := suspendSession(t.Context(), session1); err != nil {\n\t\t\tt.Fatalf(\"Suspend failed: %v\", err)\n\t\t}\n\t\tclient1.ForceStop()\n\n\t\tclient2 := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\t\topts.CLIUrl = cliURL\n\t\t\topts.CLIPath = \"\"\n\t\t})\n\t\tt.Cleanup(func() { client2.ForceStop() })\n\n\t\tsession2, err := client2.ResumeSession(t.Context(), sessionID, &copilot.ResumeSessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to resume session: %v\", err)\n\t\t}\n\t\tt.Cleanup(func() { _ = session2.Disconnect() })\n\n\t\tfollowUp, err := session2.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"What was the magic word I asked you to remember? Reply with just the word.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Follow-up SendAndWait failed: %v\", err)\n\t\t}\n\t\tif content := strings.ToUpper(assistantContent(t, followUp)); !strings.Contains(content, \"SUSPENSE\") {\n\t\t\tt.Fatalf(\"Expected response to contain SUSPENSE, got %q\", content)\n\t\t}\n\t})\n\n\tt.Run(\"should cancel pending permission request when suspending\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tclient := ctx.NewClient()\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\ttype ValueParams struct {\n\t\t\tValue string `json:\"value\" jsonschema:\"Value to transform\"`\n\t\t}\n\n\t\tpermissionRequested := make(chan copilot.PermissionRequest, 1)\n\t\treleasePermission := make(chan copilot.PermissionRequestResult, 1)\n\t\tvar toolInvoked atomic.Bool\n\n\t\ttool := copilot.DefineTool(\"suspend_cancel_permission_tool\", \"Transforms a value (should not run when suspend cancels permission)\",\n\t\t\tfunc(params ValueParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\ttoolInvoked.Store(true)\n\t\t\t\treturn \"SHOULD_NOT_RUN_\" + params.Value, nil\n\t\t\t})\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tTools: []copilot.Tool{tool},\n\t\t\tOnPermissionRequest: func(request copilot.PermissionRequest, _ copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\t\tselect {\n\t\t\t\tcase permissionRequested <- request:\n\t\t\t\tdefault:\n\t\t\t\t}\n\t\t\t\treturn <-releasePermission, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tdefer func() {\n\t\t\tselect {\n\t\t\tcase releasePermission <- copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindUserNotAvailable}:\n\t\t\tdefault:\n\t\t\t}\n\t\t}()\n\n\t\tif _, err := session.Send(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Use suspend_cancel_permission_tool with value 'omega', then reply with the result.\",\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"Send failed: %v\", err)\n\t\t}\n\n\t\tvar request copilot.PermissionRequest\n\t\tselect {\n\t\tcase request = <-permissionRequested:\n\t\tcase <-time.After(suspendTimeout):\n\t\t\tt.Fatal(\"Timed out waiting for permission request\")\n\t\t}\n\t\tif request.Kind != copilot.PermissionRequestKindCustomTool {\n\t\t\tt.Fatalf(\"Expected custom-tool permission request, got %q\", request.Kind)\n\t\t}\n\t\tif request.ToolName == nil || *request.ToolName != \"suspend_cancel_permission_tool\" {\n\t\t\tt.Fatalf(\"Expected permission request for suspend_cancel_permission_tool, got %#v\", request.ToolName)\n\t\t}\n\n\t\tif err := suspendSession(t.Context(), session); err != nil {\n\t\t\tt.Fatalf(\"Suspend failed: %v\", err)\n\t\t}\n\n\t\tif toolInvoked.Load() {\n\t\t\tt.Fatal(\"Tool should not have been invoked after suspend cancelled its pending permission\")\n\t\t}\n\t})\n\n\tt.Run(\"should reject pending external tool when suspending\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tclient := ctx.NewClient()\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\ttype ValueParams struct {\n\t\t\tValue string `json:\"value\" jsonschema:\"Value to look up\"`\n\t\t}\n\n\t\ttoolStarted := make(chan string, 1)\n\t\treleaseTool := make(chan string, 1)\n\n\t\ttool := copilot.DefineTool(\"suspend_reject_external_tool\", \"Looks up a value externally\",\n\t\t\tfunc(params ValueParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\tselect {\n\t\t\t\tcase toolStarted <- params.Value:\n\t\t\t\tdefault:\n\t\t\t\t}\n\t\t\t\treturn <-releaseTool, nil\n\t\t\t})\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tTools: []copilot.Tool{tool},\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\t\tdefer func() {\n\t\t\tselect {\n\t\t\tcase releaseTool <- \"RELEASED_AFTER_SUSPEND\":\n\t\t\tdefault:\n\t\t\t}\n\t\t}()\n\n\t\ttoolEventCh := waitForExternalToolRequests(session, []string{\"suspend_reject_external_tool\"})\n\n\t\tif _, err := session.Send(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Use suspend_reject_external_tool with value 'sigma', then reply with the result.\",\n\t\t}); err != nil {\n\t\t\tt.Fatalf(\"Send failed: %v\", err)\n\t\t}\n\n\t\ttoolEvents, err := waitForExternalToolResults(toolEventCh, suspendTimeout)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"waiting for external tool request: %v\", err)\n\t\t}\n\t\trequestID := toolEvents[\"suspend_reject_external_tool\"].RequestID\n\t\tif requestID == \"\" {\n\t\t\tt.Fatal(\"Expected external tool request id to be populated\")\n\t\t}\n\n\t\tselect {\n\t\tcase value := <-toolStarted:\n\t\t\tif value != \"sigma\" {\n\t\t\t\tt.Fatalf(\"Expected tool to start with value sigma, got %q\", value)\n\t\t\t}\n\t\tcase <-time.After(suspendTimeout):\n\t\t\tt.Fatal(\"Timed out waiting for tool to start\")\n\t\t}\n\n\t\tif err := suspendSession(t.Context(), session); err != nil {\n\t\t\tt.Fatalf(\"Suspend failed: %v\", err)\n\t\t}\n\t})\n}\n\nfunc suspendSession(ctx context.Context, session *copilot.Session) error {\n\tctx, cancel := context.WithTimeout(ctx, suspendTimeout)\n\tdefer cancel()\n\t_, err := session.RPC.Suspend(ctx)\n\treturn err\n}\n" }, { "path": "go/internal/e2e/system_message_transform_e2e_test.go", "content": "// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\npackage e2e\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"sync\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\nfunc TestSystemMessageTransformE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"should_invoke_transform_callbacks_with_section_content\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tvar identityContent string\n\t\tvar toneContent string\n\t\tvar mu sync.Mutex\n\t\tidentityCalled := false\n\t\ttoneCalled := false\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\t\tMode: \"customize\",\n\t\t\t\tSections: map[string]copilot.SectionOverride{\n\t\t\t\t\t\"identity\": {\n\t\t\t\t\t\tTransform: func(currentContent string) (string, error) {\n\t\t\t\t\t\t\tmu.Lock()\n\t\t\t\t\t\t\tidentityCalled = true\n\t\t\t\t\t\t\tidentityContent = currentContent\n\t\t\t\t\t\t\tmu.Unlock()\n\t\t\t\t\t\t\treturn currentContent, nil\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t\"tone\": {\n\t\t\t\t\t\tTransform: func(currentContent string) (string, error) {\n\t\t\t\t\t\t\tmu.Lock()\n\t\t\t\t\t\t\ttoneCalled = true\n\t\t\t\t\t\t\ttoneContent = currentContent\n\t\t\t\t\t\t\tmu.Unlock()\n\t\t\t\t\t\t\treturn currentContent, nil\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\ttestFile := filepath.Join(ctx.WorkDir, \"test.txt\")\n\t\terr = os.WriteFile(testFile, []byte(\"Hello transform!\"), 0644)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to write test file: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Read the contents of test.txt and tell me what it says\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tdefer mu.Unlock()\n\n\t\tif !identityCalled {\n\t\t\tt.Error(\"Expected identity transform callback to be invoked\")\n\t\t}\n\t\tif !toneCalled {\n\t\t\tt.Error(\"Expected tone transform callback to be invoked\")\n\t\t}\n\t\tif identityContent == \"\" {\n\t\t\tt.Error(\"Expected identity transform to receive non-empty content\")\n\t\t}\n\t\tif toneContent == \"\" {\n\t\t\tt.Error(\"Expected tone transform to receive non-empty content\")\n\t\t}\n\t})\n\n\tt.Run(\"should_apply_transform_modifications_to_section_content\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\t\tMode: \"customize\",\n\t\t\t\tSections: map[string]copilot.SectionOverride{\n\t\t\t\t\t\"identity\": {\n\t\t\t\t\t\tTransform: func(currentContent string) (string, error) {\n\t\t\t\t\t\t\treturn currentContent + \"\\nAlways end your reply with TRANSFORM_MARKER\", nil\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\ttestFile := filepath.Join(ctx.WorkDir, \"hello.txt\")\n\t\terr = os.WriteFile(testFile, []byte(\"Hello!\"), 0644)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to write test file: %v\", err)\n\t\t}\n\n\t\tassistantMessage, err := session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Read the contents of hello.txt\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\t// Verify the transform result was actually applied to the system message\n\t\ttraffic, err := ctx.GetExchanges()\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get exchanges: %v\", err)\n\t\t}\n\t\tif len(traffic) == 0 {\n\t\t\tt.Fatal(\"Expected at least one exchange\")\n\t\t}\n\t\tsystemMessage := getSystemMessage(traffic[0])\n\t\tif !strings.Contains(systemMessage, \"TRANSFORM_MARKER\") {\n\t\t\tt.Errorf(\"Expected system message to contain TRANSFORM_MARKER, got %q\", systemMessage)\n\t\t}\n\n\t\t_ = assistantMessage\n\t})\n\n\tt.Run(\"should_work_with_static_overrides_and_transforms_together\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tvar mu sync.Mutex\n\t\ttransformCalled := false\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\t\tMode: \"customize\",\n\t\t\t\tSections: map[string]copilot.SectionOverride{\n\t\t\t\t\t\"safety\": {\n\t\t\t\t\t\tAction: copilot.SectionActionRemove,\n\t\t\t\t\t},\n\t\t\t\t\t\"identity\": {\n\t\t\t\t\t\tTransform: func(currentContent string) (string, error) {\n\t\t\t\t\t\t\tmu.Lock()\n\t\t\t\t\t\t\ttransformCalled = true\n\t\t\t\t\t\t\tmu.Unlock()\n\t\t\t\t\t\t\treturn currentContent, nil\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\ttestFile := filepath.Join(ctx.WorkDir, \"combo.txt\")\n\t\terr = os.WriteFile(testFile, []byte(\"Combo test!\"), 0644)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to write test file: %v\", err)\n\t\t}\n\n\t\t_, err = session.SendAndWait(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Read the contents of combo.txt and tell me what it says\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tmu.Lock()\n\t\tdefer mu.Unlock()\n\n\t\tif !transformCalled {\n\t\t\tt.Error(\"Expected identity transform callback to be invoked\")\n\t\t}\n\t})\n}\n" }, { "path": "go/internal/e2e/telemetry_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\t\"time\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\n// Mirrors dotnet/test/TelemetryExportTests.cs (snapshot category \"telemetry\").\nfunc TestTelemetryE2E(t *testing.T) {\n\tt.Run(\"should export file telemetry for sdk interactions\", func(t *testing.T) {\n\t\tctx := testharness.NewTestContext(t)\n\t\tctx.ConfigureForTest(t)\n\n\t\ttelemetryPath := filepath.Join(ctx.WorkDir, fmt.Sprintf(\"telemetry-%s.jsonl\", randomHex(t)))\n\t\tconst marker = \"copilot-sdk-telemetry-e2e\"\n\t\tconst sourceName = \"go-sdk-telemetry-e2e\"\n\t\tconst toolName = \"echo_telemetry_marker\"\n\t\tprompt := fmt.Sprintf(\"Use the %s tool with value '%s', then respond with TELEMETRY_E2E_DONE.\", toolName, marker)\n\n\t\tclient := ctx.NewClient(func(opts *copilot.ClientOptions) {\n\t\t\topts.Telemetry = &copilot.TelemetryConfig{\n\t\t\t\tFilePath: telemetryPath,\n\t\t\t\tExporterType: \"file\",\n\t\t\t\tSourceName: sourceName,\n\t\t\t\tCaptureContent: copilot.Bool(true),\n\t\t\t}\n\t\t})\n\t\tt.Cleanup(func() { client.ForceStop() })\n\n\t\ttype EchoParams struct {\n\t\t\tValue string `json:\"value\" jsonschema:\"Marker value to echo\"`\n\t\t}\n\t\techoTool := copilot.DefineTool(toolName, \"Echoes a marker string for telemetry validation.\",\n\t\t\tfunc(params EchoParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\treturn params.Value, nil\n\t\t\t})\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tTools: []copilot.Tool{echoTool},\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"CreateSession failed: %v\", err)\n\t\t}\n\t\tsessionID := session.SessionID\n\n\t\tif _, err := session.Send(t.Context(), copilot.MessageOptions{Prompt: prompt}); err != nil {\n\t\t\tt.Fatalf(\"Send failed: %v\", err)\n\t\t}\n\t\tfinal, err := testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to wait for final assistant message: %v\", err)\n\t\t}\n\t\tassistant, ok := final.Data.(*copilot.AssistantMessageData)\n\t\tif !ok {\n\t\t\tt.Fatalf(\"Expected AssistantMessageData, got %T\", final.Data)\n\t\t}\n\t\tif !strings.Contains(assistant.Content, \"TELEMETRY_E2E_DONE\") {\n\t\t\tt.Errorf(\"Expected response to contain 'TELEMETRY_E2E_DONE', got %q\", assistant.Content)\n\t\t}\n\n\t\tsession.Disconnect()\n\t\tif err := client.Stop(); err != nil {\n\t\t\tt.Logf(\"Stop returned: %v\", err)\n\t\t}\n\n\t\tentries, err := readTelemetryEntries(t, telemetryPath, 30*time.Second, func(es []map[string]any) bool {\n\t\t\tfor _, e := range es {\n\t\t\t\tif telemetryType(e) == \"span\" && stringAttr(e, \"gen_ai.operation.name\") == \"invoke_agent\" {\n\t\t\t\t\treturn true\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn false\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"readTelemetryEntries failed: %v\", err)\n\t\t}\n\n\t\tvar spans []map[string]any\n\t\tfor _, e := range entries {\n\t\t\tif telemetryType(e) == \"span\" {\n\t\t\t\tspans = append(spans, e)\n\t\t\t}\n\t\t}\n\t\tif len(spans) == 0 {\n\t\t\tt.Fatalf(\"Expected at least one span entry; got %d entries\", len(entries))\n\t\t}\n\n\t\tfor _, span := range spans {\n\t\t\tif got := instrumentationScopeName(span); got != sourceName {\n\t\t\t\tt.Errorf(\"Expected instrumentationScope.name=%q, got %q\", sourceName, got)\n\t\t\t}\n\t\t\tif statusCode(span) == 2 {\n\t\t\t\tt.Errorf(\"Span has error status: %v\", span)\n\t\t\t}\n\t\t}\n\n\t\ttraceIDs := map[string]struct{}{}\n\t\tfor _, span := range spans {\n\t\t\tid := stringProp(span, \"traceId\")\n\t\t\tif id != \"\" {\n\t\t\t\ttraceIDs[id] = struct{}{}\n\t\t\t}\n\t\t}\n\t\tif len(traceIDs) != 1 {\n\t\t\tt.Errorf(\"Expected exactly 1 trace id across spans, got %d (%v)\", len(traceIDs), traceIDs)\n\t\t}\n\n\t\tinvokeAgent := findSpanWithOperation(spans, \"invoke_agent\")\n\t\tif invokeAgent == nil {\n\t\t\tt.Fatal(\"Expected an invoke_agent span\")\n\t\t}\n\t\tif got := stringAttr(invokeAgent, \"gen_ai.conversation.id\"); got != sessionID {\n\t\t\tt.Errorf(\"Expected gen_ai.conversation.id=%q, got %q\", sessionID, got)\n\t\t}\n\t\tif !isRootSpan(invokeAgent) {\n\t\t\tt.Errorf(\"invoke_agent should be a root span, got parentSpanId=%q\", stringProp(invokeAgent, \"parentSpanId\"))\n\t\t}\n\t\tinvokeAgentSpanID := stringProp(invokeAgent, \"spanId\")\n\t\tif invokeAgentSpanID == \"\" {\n\t\t\tt.Fatal(\"invoke_agent span has empty spanId\")\n\t\t}\n\n\t\tvar chatSpans []map[string]any\n\t\tfor _, span := range spans {\n\t\t\tif stringAttr(span, \"gen_ai.operation.name\") == \"chat\" {\n\t\t\t\tchatSpans = append(chatSpans, span)\n\t\t\t}\n\t\t}\n\t\tif len(chatSpans) == 0 {\n\t\t\tt.Fatal(\"Expected at least one chat span\")\n\t\t}\n\t\tfor _, chat := range chatSpans {\n\t\t\tif got := stringProp(chat, \"parentSpanId\"); got != invokeAgentSpanID {\n\t\t\t\tt.Errorf(\"Expected chat span parentSpanId=%q, got %q\", invokeAgentSpanID, got)\n\t\t\t}\n\t\t}\n\t\tvar sawPromptInput, sawDoneOutput bool\n\t\tfor _, chat := range chatSpans {\n\t\t\tif strings.Contains(stringAttr(chat, \"gen_ai.input.messages\"), prompt) {\n\t\t\t\tsawPromptInput = true\n\t\t\t}\n\t\t\tif strings.Contains(stringAttr(chat, \"gen_ai.output.messages\"), \"TELEMETRY_E2E_DONE\") {\n\t\t\t\tsawDoneOutput = true\n\t\t\t}\n\t\t}\n\t\tif !sawPromptInput {\n\t\t\tt.Errorf(\"Expected at least one chat span input.messages containing the prompt\")\n\t\t}\n\t\tif !sawDoneOutput {\n\t\t\tt.Errorf(\"Expected at least one chat span output.messages containing 'TELEMETRY_E2E_DONE'\")\n\t\t}\n\n\t\ttoolSpan := findSpanWithOperation(spans, \"execute_tool\")\n\t\tif toolSpan == nil {\n\t\t\tt.Fatal(\"Expected an execute_tool span\")\n\t\t}\n\t\tif got := stringProp(toolSpan, \"parentSpanId\"); got != invokeAgentSpanID {\n\t\t\tt.Errorf(\"Expected execute_tool parentSpanId=%q, got %q\", invokeAgentSpanID, got)\n\t\t}\n\t\tif got := stringAttr(toolSpan, \"gen_ai.tool.name\"); got != toolName {\n\t\t\tt.Errorf(\"Expected gen_ai.tool.name=%q, got %q\", toolName, got)\n\t\t}\n\t\tif got := stringAttr(toolSpan, \"gen_ai.tool.call.id\"); strings.TrimSpace(got) == \"\" {\n\t\t\tt.Errorf(\"Expected non-empty gen_ai.tool.call.id, got %q\", got)\n\t\t}\n\t\texpectedArgs := fmt.Sprintf(\"{\\\"value\\\":\\\"%s\\\"}\", marker)\n\t\tif got := stringAttr(toolSpan, \"gen_ai.tool.call.arguments\"); got != expectedArgs {\n\t\t\tt.Errorf(\"Expected gen_ai.tool.call.arguments=%q, got %q\", expectedArgs, got)\n\t\t}\n\t\tif got := stringAttr(toolSpan, \"gen_ai.tool.call.result\"); got != marker {\n\t\t\tt.Errorf(\"Expected gen_ai.tool.call.result=%q, got %q\", marker, got)\n\t\t}\n\t})\n}\n\nfunc readTelemetryEntries(t *testing.T, path string, timeout time.Duration, isComplete func([]map[string]any) bool) ([]map[string]any, error) {\n\tt.Helper()\n\tdeadline := time.Now().Add(timeout)\n\tfor time.Now().Before(deadline) {\n\t\tif info, err := os.Stat(path); err == nil && info.Size() > 0 {\n\t\t\tdata, err := os.ReadFile(path)\n\t\t\tif err == nil {\n\t\t\t\tvar entries []map[string]any\n\t\t\t\tfor _, line := range strings.Split(string(data), \"\\n\") {\n\t\t\t\t\tline = strings.TrimSpace(line)\n\t\t\t\t\tif line == \"\" {\n\t\t\t\t\t\tcontinue\n\t\t\t\t\t}\n\t\t\t\t\tvar entry map[string]any\n\t\t\t\t\tif err := json.Unmarshal([]byte(line), &entry); err != nil {\n\t\t\t\t\t\tcontinue\n\t\t\t\t\t}\n\t\t\t\t\tentries = append(entries, entry)\n\t\t\t\t}\n\t\t\t\tif len(entries) > 0 && isComplete(entries) {\n\t\t\t\t\treturn entries, nil\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\ttime.Sleep(100 * time.Millisecond)\n\t}\n\treturn nil, fmt.Errorf(\"timed out waiting for telemetry records in %q\", path)\n}\n\nfunc telemetryType(e map[string]any) string { return stringProp(e, \"type\") }\n\nfunc stringProp(e map[string]any, name string) string {\n\tv, ok := e[name]\n\tif !ok {\n\t\treturn \"\"\n\t}\n\tswitch x := v.(type) {\n\tcase string:\n\t\treturn x\n\tcase float64, bool:\n\t\traw, _ := json.Marshal(x)\n\t\treturn string(raw)\n\tdefault:\n\t\traw, _ := json.Marshal(x)\n\t\treturn string(raw)\n\t}\n}\n\nfunc stringAttr(e map[string]any, name string) string {\n\tattrs, ok := e[\"attributes\"].(map[string]any)\n\tif !ok {\n\t\treturn \"\"\n\t}\n\tv, ok := attrs[name]\n\tif !ok {\n\t\treturn \"\"\n\t}\n\tswitch x := v.(type) {\n\tcase string:\n\t\treturn x\n\tdefault:\n\t\traw, _ := json.Marshal(x)\n\t\treturn string(raw)\n\t}\n}\n\nfunc instrumentationScopeName(e map[string]any) string {\n\tscope, ok := e[\"instrumentationScope\"].(map[string]any)\n\tif !ok {\n\t\treturn \"\"\n\t}\n\tif name, ok := scope[\"name\"].(string); ok {\n\t\treturn name\n\t}\n\treturn \"\"\n}\n\nfunc statusCode(e map[string]any) int {\n\tstatus, ok := e[\"status\"].(map[string]any)\n\tif !ok {\n\t\treturn 0\n\t}\n\tswitch v := status[\"code\"].(type) {\n\tcase float64:\n\t\treturn int(v)\n\tcase int:\n\t\treturn v\n\t}\n\treturn 0\n}\n\nfunc isRootSpan(e map[string]any) bool {\n\tparent := stringProp(e, \"parentSpanId\")\n\treturn parent == \"\" || parent == \"0000000000000000\"\n}\n\nfunc findSpanWithOperation(spans []map[string]any, op string) map[string]any {\n\tfor _, span := range spans {\n\t\tif stringAttr(span, \"gen_ai.operation.name\") == op {\n\t\t\treturn span\n\t\t}\n\t}\n\treturn nil\n}\n\n// ---------------------------------------------------------------------------\n// Unit-style tests mirroring dotnet/test/TelemetryTests.cs.\n// These exercise the TelemetryConfig / ClientOptions struct shape only.\n// ---------------------------------------------------------------------------\n\n// TestTelemetryConfigUnit covers the dataclass-equivalent unit tests.\n//\n// CopilotClientOptions_Clone_CopiesTelemetry from the C# baseline has no Go\n// equivalent (ClientOptions has no Clone() method).\n//\n// TelemetryHelpers_Restores_W3C_Trace_Context lives in the copilot package\n// (helpers are unexported), so it is tested in go/telemetry_test.go and is\n// intentionally not duplicated here.\nfunc TestTelemetryConfigUnit(t *testing.T) {\n\tt.Run(\"default values are zero\", func(t *testing.T) {\n\t\t// Mirrors: TelemetryConfig_DefaultValues_AreNull\n\t\tvar cfg copilot.TelemetryConfig\n\t\tif cfg.OTLPEndpoint != \"\" {\n\t\t\tt.Errorf(\"Expected empty OTLPEndpoint, got %q\", cfg.OTLPEndpoint)\n\t\t}\n\t\tif cfg.FilePath != \"\" {\n\t\t\tt.Errorf(\"Expected empty FilePath, got %q\", cfg.FilePath)\n\t\t}\n\t\tif cfg.ExporterType != \"\" {\n\t\t\tt.Errorf(\"Expected empty ExporterType, got %q\", cfg.ExporterType)\n\t\t}\n\t\tif cfg.SourceName != \"\" {\n\t\t\tt.Errorf(\"Expected empty SourceName, got %q\", cfg.SourceName)\n\t\t}\n\t\tif cfg.CaptureContent != nil {\n\t\t\tt.Errorf(\"Expected nil CaptureContent, got %v\", cfg.CaptureContent)\n\t\t}\n\t})\n\n\tt.Run(\"can set all properties\", func(t *testing.T) {\n\t\t// Mirrors: TelemetryConfig_CanSetAllProperties\n\t\tcfg := copilot.TelemetryConfig{\n\t\t\tOTLPEndpoint: \"http://localhost:4318\",\n\t\t\tFilePath: \"/tmp/traces.json\",\n\t\t\tExporterType: \"otlp-http\",\n\t\t\tSourceName: \"my-app\",\n\t\t\tCaptureContent: copilot.Bool(true),\n\t\t}\n\t\tif cfg.OTLPEndpoint != \"http://localhost:4318\" {\n\t\t\tt.Errorf(\"OTLPEndpoint mismatch: %q\", cfg.OTLPEndpoint)\n\t\t}\n\t\tif cfg.FilePath != \"/tmp/traces.json\" {\n\t\t\tt.Errorf(\"FilePath mismatch: %q\", cfg.FilePath)\n\t\t}\n\t\tif cfg.ExporterType != \"otlp-http\" {\n\t\t\tt.Errorf(\"ExporterType mismatch: %q\", cfg.ExporterType)\n\t\t}\n\t\tif cfg.SourceName != \"my-app\" {\n\t\t\tt.Errorf(\"SourceName mismatch: %q\", cfg.SourceName)\n\t\t}\n\t\tif cfg.CaptureContent == nil || *cfg.CaptureContent != true {\n\t\t\tt.Errorf(\"CaptureContent mismatch: %v\", cfg.CaptureContent)\n\t\t}\n\t})\n\n\tt.Run(\"client options telemetry defaults to nil\", func(t *testing.T) {\n\t\t// Mirrors: CopilotClientOptions_Telemetry_DefaultsToNull\n\t\topts := copilot.ClientOptions{}\n\t\tif opts.Telemetry != nil {\n\t\t\tt.Errorf(\"Expected ClientOptions.Telemetry to be nil by default, got %v\", opts.Telemetry)\n\t\t}\n\t})\n}\n" }, { "path": "go/internal/e2e/testharness/context.go", "content": "package testharness\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\t\"regexp\"\n\t\"runtime\"\n\t\"strings\"\n\t\"sync\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nvar (\n\tcliPath string\n\tcliPathOnce sync.Once\n)\n\n// CLIPath returns the path to the Copilot CLI, discovering it once and caching.\nfunc CLIPath() string {\n\tcliPathOnce.Do(func() {\n\t\t// Check environment variable first\n\t\tif path := os.Getenv(\"COPILOT_CLI_PATH\"); path != \"\" {\n\t\t\tcliPath = path\n\t\t\treturn\n\t\t}\n\n\t\t// Look for CLI in sibling nodejs directory's node_modules\n\t\tabs, err := filepath.Abs(\"../../../nodejs/node_modules/@github/copilot/index.js\")\n\t\tif err == nil && fileExists(abs) {\n\t\t\tcliPath = abs\n\t\t\treturn\n\t\t}\n\t})\n\treturn cliPath\n}\n\n// TestContext holds shared resources for E2E tests.\ntype TestContext struct {\n\tCLIPath string\n\tHomeDir string\n\tWorkDir string\n\tProxyURL string\n\n\tproxy *CapiProxy\n}\n\n// NewTestContext creates a new test context with isolated directories and a replaying proxy.\nfunc NewTestContext(t *testing.T) *TestContext {\n\tt.Helper()\n\n\tcliPath := CLIPath()\n\tif cliPath == \"\" || !fileExists(cliPath) {\n\t\tt.Fatalf(\"CLI not found at %s. Run 'npm install' in the nodejs directory first.\", cliPath)\n\t}\n\n\thomeDir, err := os.MkdirTemp(\"\", \"copilot-test-config-\")\n\tif err != nil {\n\t\tt.Fatalf(\"Failed to create temp home dir: %v\", err)\n\t}\n\tif resolved, err := filepath.EvalSymlinks(homeDir); err == nil {\n\t\thomeDir = resolved\n\t}\n\n\tworkDir, err := os.MkdirTemp(\"\", \"copilot-test-work-\")\n\tif err != nil {\n\t\tos.RemoveAll(homeDir)\n\t\tt.Fatalf(\"Failed to create temp work dir: %v\", err)\n\t}\n\t// Resolve symlinks (e.g., macOS /var -> /private/var) so paths\n\t// match what spawned subprocesses see when they resolve their cwd.\n\tif resolved, err := filepath.EvalSymlinks(workDir); err == nil {\n\t\tworkDir = resolved\n\t}\n\n\tproxy := NewCapiProxy()\n\tproxyURL, err := proxy.Start()\n\tif err != nil {\n\t\tos.RemoveAll(homeDir)\n\t\tos.RemoveAll(workDir)\n\t\tt.Fatalf(\"Failed to start proxy: %v\", err)\n\t}\n\n\tctx := &TestContext{\n\t\tCLIPath: cliPath,\n\t\tHomeDir: homeDir,\n\t\tWorkDir: workDir,\n\t\tProxyURL: proxyURL,\n\t\tproxy: proxy,\n\t}\n\n\tt.Cleanup(func() {\n\t\tctx.Close(t.Failed())\n\t})\n\n\treturn ctx\n}\n\n// ConfigureForTest configures the proxy for a specific subtest.\n// Call this at the start of each t.Run subtest.\nfunc (c *TestContext) ConfigureForTest(t *testing.T) {\n\tt.Helper()\n\n\t// Format: test/snapshots//.yaml\n\t// e.g., test/snapshots/session/should_have_stateful_conversation.yaml\n\n\t// Get the test file name from the caller's file path\n\t_, callerFile, _, ok := runtime.Caller(1)\n\tif !ok {\n\t\tt.Fatal(\"Failed to get caller information\")\n\t}\n\n\t// Extract test file name: ask_user_test.go -> ask_user, ask_user_e2e_test.go -> ask_user\n\ttestFile := strings.TrimSuffix(filepath.Base(callerFile), \"_test.go\")\n\ttestFile = strings.TrimSuffix(testFile, \"_e2e\")\n\n\t// Extract and sanitize the subtest name from t.Name()\n\t// t.Name() returns \"TestAskUser/should_handle_freeform_user_input_response\"\n\ttestName := t.Name()\n\tparts := strings.SplitN(testName, \"/\", 2)\n\tif len(parts) < 2 {\n\t\tt.Fatalf(\"Expected test name with subtest, got: %s\", testName)\n\t}\n\tsanitizedName := strings.ToLower(regexp.MustCompile(`[^a-zA-Z0-9]`).ReplaceAllString(parts[1], \"_\"))\n\tsnapshotPath := filepath.Join(\"..\", \"..\", \"..\", \"test\", \"snapshots\", testFile, sanitizedName+\".yaml\")\n\n\tabsSnapshotPath, err := filepath.Abs(snapshotPath)\n\tif err != nil {\n\t\tt.Fatalf(\"Failed to get absolute path: %v\", err)\n\t}\n\n\tif err := c.proxy.Configure(absSnapshotPath, c.WorkDir); err != nil {\n\t\tt.Fatalf(\"Failed to configure proxy: %v\", err)\n\t}\n}\n\n// Close cleans up the test context resources.\nfunc (c *TestContext) Close(testFailed bool) {\n\tif c.proxy != nil {\n\t\tc.proxy.StopWithOptions(testFailed)\n\t}\n\tif c.HomeDir != \"\" {\n\t\tos.RemoveAll(c.HomeDir)\n\t}\n\tif c.WorkDir != \"\" {\n\t\tos.RemoveAll(c.WorkDir)\n\t}\n}\n\n// GetExchanges retrieves the captured HTTP exchanges from the proxy.\nfunc (c *TestContext) GetExchanges() ([]ParsedHttpExchange, error) {\n\treturn c.proxy.GetExchanges()\n}\n\n// SetCopilotUserByToken registers a per-token user configuration on the proxy.\nfunc (c *TestContext) SetCopilotUserByToken(token string, response map[string]interface{}) error {\n\treturn c.proxy.SetCopilotUserByToken(token, response)\n}\n\n// Env returns environment variables configured for isolated testing.\nfunc (c *TestContext) Env() []string {\n\tenv := os.Environ()\n\n\t// Add overrides (later values take precedence in most systems)\n\tenv = append(env,\n\t\t\"COPILOT_API_URL=\"+c.ProxyURL,\n\t\t\"COPILOT_HOME=\"+c.HomeDir,\n\t\t\"XDG_CONFIG_HOME=\"+c.HomeDir,\n\t\t\"XDG_STATE_HOME=\"+c.HomeDir,\n\t)\n\treturn env\n}\n\n// NewClient creates a CopilotClient configured for this test context.\n// Optional overrides can be applied to the default ClientOptions via the opts function.\nfunc (c *TestContext) NewClient(opts ...func(*copilot.ClientOptions)) *copilot.Client {\n\toptions := &copilot.ClientOptions{\n\t\tCLIPath: c.CLIPath,\n\t\tCwd: c.WorkDir,\n\t\tEnv: c.Env(),\n\t}\n\n\tfor _, opt := range opts {\n\t\topt(options)\n\t}\n\n\t// Use fake token in CI to allow cached responses without real auth for spawned subprocess clients.\n\tif os.Getenv(\"GITHUB_ACTIONS\") == \"true\" && options.GitHubToken == \"\" && options.CLIUrl == \"\" {\n\t\toptions.GitHubToken = \"fake-token-for-e2e-tests\"\n\t}\n\n\treturn copilot.NewClient(options)\n}\n\nfunc fileExists(path string) bool {\n\t_, err := os.Stat(path)\n\treturn err == nil\n}\n" }, { "path": "go/internal/e2e/testharness/helper.go", "content": "package testharness\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"time\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\n// GetFinalAssistantMessage waits for and returns the final assistant message from a session turn.\n// If alreadyIdle is true, skip waiting for session.idle (useful for resumed sessions where the\n// idle event was ephemeral and not persisted in the event history).\nfunc GetFinalAssistantMessage(ctx context.Context, session *copilot.Session, alreadyIdle ...bool) (*copilot.SessionEvent, error) {\n\tresult := make(chan *copilot.SessionEvent, 1)\n\terrCh := make(chan error, 1)\n\n\t// Subscribe to future events\n\tvar finalAssistantMessage *copilot.SessionEvent\n\tunsubscribe := session.On(func(event copilot.SessionEvent) {\n\t\tswitch d := event.Data.(type) {\n\t\tcase *copilot.AssistantMessageData:\n\t\t\tfinalAssistantMessage = &event\n\t\tcase *copilot.SessionIdleData:\n\t\t\tif finalAssistantMessage != nil {\n\t\t\t\tresult <- finalAssistantMessage\n\t\t\t}\n\t\tcase *copilot.SessionErrorData:\n\t\t\terrCh <- errors.New(d.Message)\n\t\t}\n\t})\n\tdefer unsubscribe()\n\n\t// Also check existing messages in case the response already arrived\n\tisAlreadyIdle := len(alreadyIdle) > 0 && alreadyIdle[0]\n\tgo func() {\n\t\texisting, err := getExistingFinalResponse(ctx, session, isAlreadyIdle)\n\t\tif err != nil {\n\t\t\terrCh <- err\n\t\t\treturn\n\t\t}\n\t\tif existing != nil {\n\t\t\tresult <- existing\n\t\t}\n\t}()\n\n\tselect {\n\tcase msg := <-result:\n\t\treturn msg, nil\n\tcase err := <-errCh:\n\t\treturn nil, err\n\tcase <-ctx.Done():\n\t\treturn nil, errors.New(\"timeout waiting for assistant message\")\n\t}\n}\n\n// GetNextEventOfType waits for and returns the next event of the specified type from a session.\nfunc GetNextEventOfType(session *copilot.Session, eventType copilot.SessionEventType, timeout time.Duration) (*copilot.SessionEvent, error) {\n\tresult := make(chan *copilot.SessionEvent, 1)\n\terrCh := make(chan error, 1)\n\n\tunsubscribe := session.On(func(event copilot.SessionEvent) {\n\t\tswitch event.Type {\n\t\tcase eventType:\n\t\t\tselect {\n\t\t\tcase result <- &event:\n\t\t\tdefault:\n\t\t\t}\n\t\tcase copilot.SessionEventTypeSessionError:\n\t\t\tmsg := \"session error\"\n\t\t\tif d, ok := event.Data.(*copilot.SessionErrorData); ok {\n\t\t\t\tmsg = d.Message\n\t\t\t}\n\t\t\tselect {\n\t\t\tcase errCh <- errors.New(msg):\n\t\t\tdefault:\n\t\t\t}\n\t\t}\n\t})\n\tdefer unsubscribe()\n\n\tselect {\n\tcase evt := <-result:\n\t\treturn evt, nil\n\tcase err := <-errCh:\n\t\treturn nil, err\n\tcase <-time.After(timeout):\n\t\treturn nil, errors.New(\"timeout waiting for event: \" + string(eventType))\n\t}\n}\n\nfunc getExistingFinalResponse(ctx context.Context, session *copilot.Session, alreadyIdle bool) (*copilot.SessionEvent, error) {\n\tmessages, err := session.GetMessages(ctx)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t// Find last user message\n\tfinalUserMessageIndex := -1\n\tfor i := len(messages) - 1; i >= 0; i-- {\n\t\tif messages[i].Type == \"user.message\" {\n\t\t\tfinalUserMessageIndex = i\n\t\t\tbreak\n\t\t}\n\t}\n\n\tvar currentTurnMessages []copilot.SessionEvent\n\tif finalUserMessageIndex < 0 {\n\t\tcurrentTurnMessages = messages\n\t} else {\n\t\tcurrentTurnMessages = messages[finalUserMessageIndex:]\n\t}\n\n\t// Check for errors\n\tfor _, msg := range currentTurnMessages {\n\t\tif msg.Type == \"session.error\" {\n\t\t\terrMsg := \"session error\"\n\t\t\tif d, ok := msg.Data.(*copilot.SessionErrorData); ok {\n\t\t\t\terrMsg = d.Message\n\t\t\t}\n\t\t\treturn nil, errors.New(errMsg)\n\t\t}\n\t}\n\n\t// Find session.idle and get last assistant message before it\n\tsessionIdleIndex := -1\n\tif alreadyIdle {\n\t\tsessionIdleIndex = len(currentTurnMessages)\n\t} else {\n\t\tfor i, msg := range currentTurnMessages {\n\t\t\tif msg.Type == \"session.idle\" {\n\t\t\t\tsessionIdleIndex = i\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t}\n\n\tif sessionIdleIndex != -1 {\n\t\t// Find last assistant.message before session.idle\n\t\tfor i := sessionIdleIndex - 1; i >= 0; i-- {\n\t\t\tif currentTurnMessages[i].Type == \"assistant.message\" {\n\t\t\t\treturn ¤tTurnMessages[i], nil\n\t\t\t}\n\t\t}\n\t}\n\n\treturn nil, nil\n}\n" }, { "path": "go/internal/e2e/testharness/proxy.go", "content": "package testharness\n\nimport (\n\t\"bufio\"\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"os\"\n\t\"os/exec\"\n\t\"regexp\"\n\t\"strings\"\n\t\"sync\"\n)\n\n// CapiProxy manages a child process that acts as a replaying proxy to AI endpoints.\n// It spawns the shared test harness server from test/harness/server.ts.\ntype CapiProxy struct {\n\tcmd *exec.Cmd\n\tproxyURL string\n\tmu sync.Mutex\n}\n\n// NewCapiProxy creates a new proxy instance.\nfunc NewCapiProxy() *CapiProxy {\n\treturn &CapiProxy{}\n}\n\n// Start launches the proxy server and returns its URL.\nfunc (p *CapiProxy) Start() (string, error) {\n\tp.mu.Lock()\n\tdefer p.mu.Unlock()\n\n\tif p.proxyURL != \"\" {\n\t\treturn p.proxyURL, nil\n\t}\n\n\t// The harness server is in the shared test directory\n\tserverPath := \"../../../test/harness/server.ts\"\n\n\tp.cmd = exec.Command(\"npx\", \"tsx\", serverPath)\n\tp.cmd.Dir = \".\" // Will be resolved relative to test execution\n\n\tstdout, err := p.cmd.StdoutPipe()\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to get stdout pipe: %w\", err)\n\t}\n\n\t// Forward stderr to parent for debugging\n\tp.cmd.Stderr = os.Stderr\n\n\tif err := p.cmd.Start(); err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to start proxy server: %w\", err)\n\t}\n\n\t// Read the first line to get the listening URL\n\treader := bufio.NewReader(stdout)\n\tline, err := reader.ReadString('\\n')\n\tif err != nil && err != io.EOF {\n\t\tp.cmd.Process.Kill()\n\t\treturn \"\", fmt.Errorf(\"failed to read proxy URL: %w\", err)\n\t}\n\n\t// Parse \"Listening: http://...\" from output\n\tre := regexp.MustCompile(`Listening: (http://[^\\s]+)`)\n\tmatches := re.FindStringSubmatch(strings.TrimSpace(line))\n\tif len(matches) < 2 {\n\t\tp.cmd.Process.Kill()\n\t\treturn \"\", fmt.Errorf(\"unexpected proxy output: %s\", line)\n\t}\n\n\tp.proxyURL = matches[1]\n\treturn p.proxyURL, nil\n}\n\n// Stop gracefully shuts down the proxy server.\nfunc (p *CapiProxy) Stop() error {\n\treturn p.StopWithOptions(false)\n}\n\n// StopWithOptions gracefully shuts down the proxy server.\n// If skipWritingCache is true, the proxy won't write captured exchanges to disk.\nfunc (p *CapiProxy) StopWithOptions(skipWritingCache bool) error {\n\tp.mu.Lock()\n\tdefer p.mu.Unlock()\n\n\tif p.cmd == nil || p.cmd.Process == nil {\n\t\treturn nil\n\t}\n\n\t// Send stop request to the server\n\tif p.proxyURL != \"\" {\n\t\tstopURL := p.proxyURL + \"/stop\"\n\t\tif skipWritingCache {\n\t\t\tstopURL += \"?skipWritingCache=true\"\n\t\t}\n\t\t// Best effort - ignore errors\n\t\tresp, err := http.Post(stopURL, \"application/json\", nil)\n\t\tif err == nil {\n\t\t\tresp.Body.Close()\n\t\t}\n\t}\n\n\t// Wait for process to exit\n\tp.cmd.Wait()\n\tp.cmd = nil\n\tp.proxyURL = \"\"\n\n\treturn nil\n}\n\n// Configure sends configuration to the proxy.\nfunc (p *CapiProxy) Configure(filePath, workDir string) error {\n\tp.mu.Lock()\n\turl := p.proxyURL\n\tp.mu.Unlock()\n\n\tif url == \"\" {\n\t\treturn fmt.Errorf(\"proxy not started\")\n\t}\n\n\tconfig := fmt.Sprintf(`{\"filePath\":%q,\"workDir\":%q}`, filePath, workDir)\n\tresp, err := http.Post(url+\"/config\", \"application/json\", strings.NewReader(config))\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to configure proxy: %w\", err)\n\t}\n\tdefer resp.Body.Close()\n\n\tif resp.StatusCode != 200 {\n\t\treturn fmt.Errorf(\"proxy config failed with status %d\", resp.StatusCode)\n\t}\n\n\treturn nil\n}\n\n// GetExchanges retrieves the captured HTTP exchanges from the proxy.\nfunc (p *CapiProxy) GetExchanges() ([]ParsedHttpExchange, error) {\n\tp.mu.Lock()\n\turl := p.proxyURL\n\tp.mu.Unlock()\n\n\tif url == \"\" {\n\t\treturn nil, fmt.Errorf(\"proxy not started\")\n\t}\n\n\tresp, err := http.Get(url + \"/exchanges\")\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get exchanges: %w\", err)\n\t}\n\tdefer resp.Body.Close()\n\n\tvar exchanges []ParsedHttpExchange\n\tif err := json.NewDecoder(resp.Body).Decode(&exchanges); err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to decode exchanges: %w\", err)\n\t}\n\n\treturn exchanges, nil\n}\n\n// ParsedHttpExchange represents a captured HTTP exchange.\ntype ParsedHttpExchange struct {\n\tRequest ChatCompletionRequest `json:\"request\"`\n\tResponse *ChatCompletionResponse `json:\"response,omitempty\"`\n\tRequestHeaders map[string]json.RawMessage `json:\"requestHeaders,omitempty\"`\n}\n\n// ChatCompletionRequest represents an OpenAI chat completion request.\ntype ChatCompletionRequest struct {\n\tModel string `json:\"model\"`\n\tMessages []ChatCompletionMessage `json:\"messages\"`\n\tTools []ChatCompletionTool `json:\"tools,omitempty\"`\n}\n\n// ChatCompletionMessage represents a message in the chat completion request.\ntype ChatCompletionMessage struct {\n\tRole string `json:\"role\"`\n\tContent string `json:\"content,omitempty\"`\n\tRawContent json.RawMessage `json:\"-\"`\n\tToolCallID string `json:\"tool_call_id,omitempty\"`\n\tToolCalls []ToolCall `json:\"tool_calls,omitempty\"`\n}\n\n// UnmarshalJSON handles Content being either a plain string or an array of\n// content parts (e.g. multimodal messages with image_url entries).\nfunc (m *ChatCompletionMessage) UnmarshalJSON(data []byte) error {\n\ttype Alias ChatCompletionMessage\n\taux := &struct {\n\t\tContent json.RawMessage `json:\"content,omitempty\"`\n\t\t*Alias\n\t}{\n\t\tAlias: (*Alias)(m),\n\t}\n\tif err := json.Unmarshal(data, aux); err != nil {\n\t\treturn err\n\t}\n\tm.RawContent = aux.Content\n\tm.Content = \"\"\n\tif len(aux.Content) > 0 {\n\t\tvar s string\n\t\tif json.Unmarshal(aux.Content, &s) == nil {\n\t\t\tm.Content = s\n\t\t}\n\t}\n\treturn nil\n}\n\n// ToolCall represents a tool call in an assistant message.\ntype ToolCall struct {\n\tID string `json:\"id\"`\n\tType string `json:\"type\"`\n\tFunction FunctionCall `json:\"function\"`\n}\n\n// FunctionCall represents the function details in a tool call.\ntype FunctionCall struct {\n\tName string `json:\"name\"`\n\tArguments string `json:\"arguments\"`\n}\n\n// Message is an alias for ChatCompletionMessage for test convenience.\ntype Message = ChatCompletionMessage\n\n// ChatCompletionTool represents a tool in the chat completion request.\ntype ChatCompletionTool struct {\n\tType string `json:\"type\"`\n\tFunction ChatCompletionToolFunction `json:\"function\"`\n}\n\n// ChatCompletionToolFunction represents a function tool.\ntype ChatCompletionToolFunction struct {\n\tName string `json:\"name\"`\n\tDescription string `json:\"description,omitempty\"`\n}\n\n// ChatCompletionResponse represents an OpenAI chat completion response.\ntype ChatCompletionResponse struct {\n\tID string `json:\"id\"`\n\tModel string `json:\"model\"`\n\tChoices []ChatCompletionChoice `json:\"choices\"`\n}\n\n// ChatCompletionChoice represents a choice in the response.\ntype ChatCompletionChoice struct {\n\tIndex int `json:\"index\"`\n\tMessage ChatCompletionMessage `json:\"message\"`\n\tFinishReason string `json:\"finish_reason\"`\n}\n\n// URL returns the proxy URL, or empty if not started.\nfunc (p *CapiProxy) URL() string {\n\tp.mu.Lock()\n\tdefer p.mu.Unlock()\n\treturn p.proxyURL\n}\n\n// SetCopilotUserByToken registers a per-token user configuration on the proxy.\nfunc (p *CapiProxy) SetCopilotUserByToken(token string, response map[string]interface{}) error {\n\tp.mu.Lock()\n\turl := p.proxyURL\n\tp.mu.Unlock()\n\n\tif url == \"\" {\n\t\treturn fmt.Errorf(\"proxy not started\")\n\t}\n\n\tbody := map[string]interface{}{\n\t\t\"token\": token,\n\t\t\"response\": response,\n\t}\n\tdata, err := json.Marshal(body)\n\tif err != nil {\n\t\treturn err\n\t}\n\tresp, err := http.Post(url+\"/copilot-user-config\", \"application/json\", bytes.NewReader(data))\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer resp.Body.Close()\n\tif resp.StatusCode != 200 {\n\t\treturn fmt.Errorf(\"setCopilotUserByToken: unexpected status %d\", resp.StatusCode)\n\t}\n\treturn nil\n}\n" }, { "path": "go/internal/e2e/tool_results_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"strings\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\nfunc TestToolResultsE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"should handle structured toolresultobject from custom tool\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\ttype WeatherParams struct {\n\t\t\tCity string `json:\"city\" jsonschema:\"City name\"`\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tTools: []copilot.Tool{\n\t\t\t\tcopilot.DefineTool(\"get_weather\", \"Gets weather for a city\",\n\t\t\t\t\tfunc(params WeatherParams, inv copilot.ToolInvocation) (copilot.ToolResult, error) {\n\t\t\t\t\t\treturn copilot.ToolResult{\n\t\t\t\t\t\t\tTextResultForLLM: \"The weather in \" + params.City + \" is sunny and 72°F\",\n\t\t\t\t\t\t\tResultType: \"success\",\n\t\t\t\t\t\t}, nil\n\t\t\t\t\t}),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{Prompt: \"What's the weather in Paris?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tanswer, err := testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\n\t\tcontent := \"\"\n\t\tif ad, ok := answer.Data.(*copilot.AssistantMessageData); ok {\n\t\t\tcontent = ad.Content\n\t\t}\n\t\tif !strings.Contains(strings.ToLower(content), \"sunny\") && !strings.Contains(content, \"72\") {\n\t\t\tt.Errorf(\"Expected answer to mention sunny or 72, got %q\", content)\n\t\t}\n\n\t\tif err := session.Disconnect(); err != nil {\n\t\t\tt.Errorf(\"Failed to disconnect session: %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should handle tool result with failure resulttype\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tTools: []copilot.Tool{\n\t\t\t\t{\n\t\t\t\t\tName: \"check_status\",\n\t\t\t\t\tDescription: \"Checks the status of a service\",\n\t\t\t\t\tHandler: func(inv copilot.ToolInvocation) (copilot.ToolResult, error) {\n\t\t\t\t\t\treturn copilot.ToolResult{\n\t\t\t\t\t\t\tTextResultForLLM: \"Service unavailable\",\n\t\t\t\t\t\t\tResultType: \"failure\",\n\t\t\t\t\t\t\tError: \"API timeout\",\n\t\t\t\t\t\t}, nil\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Check the status of the service using check_status. If it fails, say 'service is down'.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tanswer, err := testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\n\t\tcontent := \"\"\n\t\tif ad, ok := answer.Data.(*copilot.AssistantMessageData); ok {\n\t\t\tcontent = ad.Content\n\t\t}\n\t\tif !strings.Contains(strings.ToLower(content), \"service is down\") {\n\t\t\tt.Errorf(\"Expected 'service is down', got %q\", content)\n\t\t}\n\n\t\tif err := session.Disconnect(); err != nil {\n\t\t\tt.Errorf(\"Failed to disconnect session: %v\", err)\n\t\t}\n\t})\n\n\tt.Run(\"should preserve tooltelemetry and not stringify structured results for llm\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\ttype AnalyzeParams struct {\n\t\t\tFile string `json:\"file\" jsonschema:\"File to analyze\"`\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tTools: []copilot.Tool{\n\t\t\t\tcopilot.DefineTool(\"analyze_code\", \"Analyzes code for issues\",\n\t\t\t\t\tfunc(params AnalyzeParams, inv copilot.ToolInvocation) (copilot.ToolResult, error) {\n\t\t\t\t\t\treturn copilot.ToolResult{\n\t\t\t\t\t\t\tTextResultForLLM: \"Analysis of \" + params.File + \": no issues found\",\n\t\t\t\t\t\t\tResultType: \"success\",\n\t\t\t\t\t\t\tToolTelemetry: map[string]any{\n\t\t\t\t\t\t\t\t\"metrics\": map[string]any{\"analysisTimeMs\": 150},\n\t\t\t\t\t\t\t\t\"properties\": map[string]any{\"analyzer\": \"eslint\"},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}, nil\n\t\t\t\t\t}),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{Prompt: \"Analyze the file main.ts for issues.\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tanswer, err := testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\n\t\tcontent := \"\"\n\t\tif ad, ok := answer.Data.(*copilot.AssistantMessageData); ok {\n\t\t\tcontent = ad.Content\n\t\t}\n\t\tif !strings.Contains(strings.ToLower(content), \"no issues\") {\n\t\t\tt.Errorf(\"Expected 'no issues', got %q\", content)\n\t\t}\n\n\t\t// Verify the LLM received just textResultForLlm, not stringified JSON\n\t\ttraffic, err := ctx.GetExchanges()\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get exchanges: %v\", err)\n\t\t}\n\n\t\tlastConversation := traffic[len(traffic)-1]\n\t\tvar toolResults []testharness.ChatCompletionMessage\n\t\tfor _, msg := range lastConversation.Request.Messages {\n\t\t\tif msg.Role == \"tool\" {\n\t\t\t\ttoolResults = append(toolResults, msg)\n\t\t\t}\n\t\t}\n\n\t\tif len(toolResults) != 1 {\n\t\t\tt.Fatalf(\"Expected 1 tool result, got %d\", len(toolResults))\n\t\t}\n\t\tif strings.Contains(toolResults[0].Content, \"toolTelemetry\") {\n\t\t\tt.Error(\"Tool result content should not contain 'toolTelemetry'\")\n\t\t}\n\t\tif strings.Contains(toolResults[0].Content, \"resultType\") {\n\t\t\tt.Error(\"Tool result content should not contain 'resultType'\")\n\t\t}\n\n\t\tif err := session.Disconnect(); err != nil {\n\t\t\tt.Errorf(\"Failed to disconnect session: %v\", err)\n\t\t}\n\t})\n}\n" }, { "path": "go/internal/e2e/tools_e2e_test.go", "content": "package e2e\n\nimport (\n\t\"errors\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"sync\"\n\t\"testing\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n\t\"github.com/github/copilot-sdk/go/internal/e2e/testharness\"\n)\n\nfunc TestToolsE2E(t *testing.T) {\n\tctx := testharness.NewTestContext(t)\n\tclient := ctx.NewClient()\n\tt.Cleanup(func() { client.ForceStop() })\n\n\tt.Run(\"invokes built-in tools\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\t// Write a test file\n\t\terr := os.WriteFile(filepath.Join(ctx.WorkDir, \"README.md\"), []byte(\"# ELIZA, the only chatbot you'll ever need\"), 0644)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to write test file: %v\", err)\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{Prompt: \"What's the first line of README.md in this directory?\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tanswer, err := testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\n\t\tif md, ok := answer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(md.Content, \"ELIZA\") {\n\t\t\tt.Errorf(\"Expected answer to contain 'ELIZA', got %v\", answer.Data)\n\t\t}\n\t})\n\n\tt.Run(\"invokes custom tool\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\ttype EncryptParams struct {\n\t\t\tInput string `json:\"input\" jsonschema:\"String to encrypt\"`\n\t\t}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tTools: []copilot.Tool{\n\t\t\t\tcopilot.DefineTool(\"encrypt_string\", \"Encrypts a string\",\n\t\t\t\t\tfunc(params EncryptParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\t\t\treturn strings.ToUpper(params.Input), nil\n\t\t\t\t\t}),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{Prompt: \"Use encrypt_string to encrypt this string: Hello\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tanswer, err := testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\n\t\tif md, ok := answer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(md.Content, \"HELLO\") {\n\t\t\tt.Errorf(\"Expected answer to contain 'HELLO', got %v\", answer.Data)\n\t\t}\n\t})\n\n\tt.Run(\"handles tool calling errors\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\ttype EmptyParams struct{}\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tTools: []copilot.Tool{\n\t\t\t\tcopilot.DefineTool(\"get_user_location\", \"Gets the user's location\",\n\t\t\t\t\tfunc(params EmptyParams, inv copilot.ToolInvocation) (any, error) {\n\t\t\t\t\t\treturn nil, errors.New(\"Melbourne\")\n\t\t\t\t\t}),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"What is my location? If you can't find out, just say 'unknown'.\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tanswer, err := testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\n\t\t// Check the underlying traffic\n\t\ttraffic, err := ctx.GetExchanges()\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get exchanges: %v\", err)\n\t\t}\n\n\t\tlastConversation := traffic[len(traffic)-1]\n\n\t\t// Find tool calls\n\t\tvar toolCalls []testharness.ToolCall\n\t\tfor _, msg := range lastConversation.Request.Messages {\n\t\t\tif msg.Role == \"assistant\" && msg.ToolCalls != nil {\n\t\t\t\ttoolCalls = append(toolCalls, msg.ToolCalls...)\n\t\t\t}\n\t\t}\n\n\t\tif len(toolCalls) != 1 {\n\t\t\tt.Fatalf(\"Expected 1 tool call, got %d\", len(toolCalls))\n\t\t}\n\t\ttoolCall := toolCalls[0]\n\t\tif toolCall.Type != \"function\" {\n\t\t\tt.Errorf(\"Expected tool call type 'function', got '%s'\", toolCall.Type)\n\t\t}\n\t\tif toolCall.Function.Name != \"get_user_location\" {\n\t\t\tt.Errorf(\"Expected tool call name 'get_user_location', got '%s'\", toolCall.Function.Name)\n\t\t}\n\n\t\t// Find tool results\n\t\tvar toolResults []testharness.Message\n\t\tfor _, msg := range lastConversation.Request.Messages {\n\t\t\tif msg.Role == \"tool\" {\n\t\t\t\ttoolResults = append(toolResults, msg)\n\t\t\t}\n\t\t}\n\n\t\tif len(toolResults) != 1 {\n\t\t\tt.Fatalf(\"Expected 1 tool result, got %d\", len(toolResults))\n\t\t}\n\t\ttoolResult := toolResults[0]\n\t\tif toolResult.ToolCallID != toolCall.ID {\n\t\t\tt.Errorf(\"Expected tool result ID '%s', got '%s'\", toolCall.ID, toolResult.ToolCallID)\n\t\t}\n\n\t\t// The error message \"Melbourne\" should NOT be exposed to the LLM\n\t\tif strings.Contains(toolResult.Content, \"Melbourne\") {\n\t\t\tt.Errorf(\"Tool result should not contain error details 'Melbourne', got '%s'\", toolResult.Content)\n\t\t}\n\n\t\t// The assistant should not see the exception information\n\t\tif md, ok := answer.Data.(*copilot.AssistantMessageData); ok && strings.Contains(md.Content, \"Melbourne\") {\n\t\t\tt.Errorf(\"Assistant should not see error details 'Melbourne', got '%s'\", md.Content)\n\t\t}\n\t\tif md, ok := answer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(strings.ToLower(md.Content), \"unknown\") {\n\t\t\tt.Errorf(\"Expected answer to contain 'unknown', got %v\", answer.Data)\n\t\t}\n\t})\n\n\tt.Run(\"can receive and return complex types\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\ttype DbQuery struct {\n\t\t\tTable string `json:\"table\"`\n\t\t\tIDs []int `json:\"ids\"`\n\t\t\tSortAscending bool `json:\"sortAscending\"`\n\t\t}\n\n\t\ttype DbQueryParams struct {\n\t\t\tQuery DbQuery `json:\"query\"`\n\t\t}\n\n\t\ttype City struct {\n\t\t\tCountryID int `json:\"countryId\"`\n\t\t\tCityName string `json:\"cityName\"`\n\t\t\tPopulation int `json:\"population\"`\n\t\t}\n\n\t\tvar receivedInvocation *copilot.ToolInvocation\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tTools: []copilot.Tool{\n\t\t\t\tcopilot.DefineTool(\"db_query\", \"Performs a database query\",\n\t\t\t\t\tfunc(params DbQueryParams, inv copilot.ToolInvocation) ([]City, error) {\n\t\t\t\t\t\treceivedInvocation = &inv\n\n\t\t\t\t\t\tif params.Query.Table != \"cities\" {\n\t\t\t\t\t\t\tt.Errorf(\"Expected table 'cities', got '%s'\", params.Query.Table)\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif len(params.Query.IDs) != 2 || params.Query.IDs[0] != 12 || params.Query.IDs[1] != 19 {\n\t\t\t\t\t\t\tt.Errorf(\"Expected IDs [12, 19], got %v\", params.Query.IDs)\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif !params.Query.SortAscending {\n\t\t\t\t\t\t\tt.Errorf(\"Expected sortAscending to be true\")\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\treturn []City{\n\t\t\t\t\t\t\t{CountryID: 19, CityName: \"Passos\", Population: 135460},\n\t\t\t\t\t\t\t{CountryID: 12, CityName: \"San Lorenzo\", Population: 204356},\n\t\t\t\t\t\t}, nil\n\t\t\t\t\t}),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{\n\t\t\tPrompt: \"Perform a DB query for the 'cities' table using IDs 12 and 19, sorting ascending. \" +\n\t\t\t\t\"Reply only with lines of the form: [cityname] [population]\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tanswer, err := testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\n\t\tif answer == nil {\n\t\t\tt.Fatalf(\"Expected assistant message with content\")\n\t\t}\n\t\tad, ok := answer.Data.(*copilot.AssistantMessageData)\n\t\tif !ok {\n\t\t\tt.Fatalf(\"Expected assistant message with content\")\n\t\t}\n\n\t\tresponseContent := ad.Content\n\t\tif responseContent == \"\" {\n\t\t\tt.Errorf(\"Expected non-empty response\")\n\t\t}\n\t\tif !strings.Contains(responseContent, \"Passos\") {\n\t\t\tt.Errorf(\"Expected response to contain 'Passos', got '%s'\", responseContent)\n\t\t}\n\t\tif !strings.Contains(responseContent, \"San Lorenzo\") {\n\t\t\tt.Errorf(\"Expected response to contain 'San Lorenzo', got '%s'\", responseContent)\n\t\t}\n\t\t// Remove commas for number checking (e.g., \"135,460\" -> \"135460\")\n\t\tresponseWithoutCommas := strings.ReplaceAll(responseContent, \",\", \"\")\n\t\tif !strings.Contains(responseWithoutCommas, \"135460\") {\n\t\t\tt.Errorf(\"Expected response to contain '135460', got '%s'\", responseContent)\n\t\t}\n\t\tif !strings.Contains(responseWithoutCommas, \"204356\") {\n\t\t\tt.Errorf(\"Expected response to contain '204356', got '%s'\", responseContent)\n\t\t}\n\n\t\t// We can access the raw invocation if needed\n\t\tif receivedInvocation == nil {\n\t\t\tt.Fatalf(\"Expected to receive invocation\")\n\t\t}\n\t\tif receivedInvocation.SessionID != session.SessionID {\n\t\t\tt.Errorf(\"Expected session ID '%s', got '%s'\", session.SessionID, receivedInvocation.SessionID)\n\t\t}\n\t})\n\n\tt.Run(\"skipPermission sent in tool definition\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\ttype LookupParams struct {\n\t\t\tID string `json:\"id\" jsonschema:\"ID to look up\"`\n\t\t}\n\n\t\tsafeLookupTool := copilot.DefineTool(\"safe_lookup\", \"A safe lookup that skips permission\",\n\t\t\tfunc(params LookupParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\treturn \"RESULT: \" + params.ID, nil\n\t\t\t})\n\t\tsafeLookupTool.SkipPermission = true\n\n\t\tdidRunPermissionRequest := false\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: func(request copilot.PermissionRequest, invocation copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\t\tdidRunPermissionRequest = true\n\t\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindNoResult}, nil\n\t\t\t},\n\t\t\tTools: []copilot.Tool{\n\t\t\t\tsafeLookupTool,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{Prompt: \"Use safe_lookup to look up 'test123'\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tanswer, err := testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\n\t\tif md, ok := answer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(md.Content, \"RESULT: test123\") {\n\t\t\tt.Errorf(\"Expected answer to contain 'RESULT: test123', got %v\", answer.Data)\n\t\t}\n\n\t\tif didRunPermissionRequest {\n\t\t\tt.Errorf(\"Expected permission handler to NOT be called for skipPermission tool\")\n\t\t}\n\t})\n\n\tt.Run(\"overrides built-in tool with custom tool\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\ttype GrepParams struct {\n\t\t\tQuery string `json:\"query\" jsonschema:\"Search query\"`\n\t\t}\n\n\t\tgrepTool := copilot.DefineTool(\"grep\", \"A custom grep implementation that overrides the built-in\",\n\t\t\tfunc(params GrepParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\treturn \"CUSTOM_GREP_RESULT: \" + params.Query, nil\n\t\t\t})\n\t\tgrepTool.OverridesBuiltInTool = true\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\t\tTools: []copilot.Tool{\n\t\t\t\tgrepTool,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{Prompt: \"Use grep to search for the word 'hello'\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tanswer, err := testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\n\t\tif md, ok := answer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(md.Content, \"CUSTOM_GREP_RESULT\") {\n\t\t\tt.Errorf(\"Expected answer to contain 'CUSTOM_GREP_RESULT', got %v\", answer.Data)\n\t\t}\n\t})\n\n\tt.Run(\"invokes custom tool with permission handler\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\ttype EncryptParams struct {\n\t\t\tInput string `json:\"input\" jsonschema:\"String to encrypt\"`\n\t\t}\n\n\t\tvar permissionRequests []copilot.PermissionRequest\n\t\tvar mu sync.Mutex\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tTools: []copilot.Tool{\n\t\t\t\tcopilot.DefineTool(\"encrypt_string\", \"Encrypts a string\",\n\t\t\t\t\tfunc(params EncryptParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\t\t\treturn strings.ToUpper(params.Input), nil\n\t\t\t\t\t}),\n\t\t\t},\n\t\t\tOnPermissionRequest: func(request copilot.PermissionRequest, invocation copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\t\tmu.Lock()\n\t\t\t\tpermissionRequests = append(permissionRequests, request)\n\t\t\t\tmu.Unlock()\n\t\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindApproved}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{Prompt: \"Use encrypt_string to encrypt this string: Hello\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\tanswer, err := testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\n\t\tif md, ok := answer.Data.(*copilot.AssistantMessageData); !ok || !strings.Contains(md.Content, \"HELLO\") {\n\t\t\tt.Errorf(\"Expected answer to contain 'HELLO', got %v\", answer.Data)\n\t\t}\n\n\t\t// Should have received a custom-tool permission request\n\t\tmu.Lock()\n\t\tcustomToolReqs := 0\n\t\tfor _, req := range permissionRequests {\n\t\t\tif req.Kind == \"custom-tool\" {\n\t\t\t\tcustomToolReqs++\n\t\t\t\tif req.ToolName == nil || *req.ToolName != \"encrypt_string\" {\n\t\t\t\t\tt.Errorf(\"Expected toolName 'encrypt_string', got '%v'\", req.ToolName)\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tmu.Unlock()\n\t\tif customToolReqs == 0 {\n\t\t\tt.Errorf(\"Expected at least one custom-tool permission request, got none\")\n\t\t}\n\t})\n\n\tt.Run(\"denies custom tool when permission denied\", func(t *testing.T) {\n\t\tctx.ConfigureForTest(t)\n\n\t\ttype EncryptParams struct {\n\t\t\tInput string `json:\"input\" jsonschema:\"String to encrypt\"`\n\t\t}\n\n\t\ttoolHandlerCalled := false\n\n\t\tsession, err := client.CreateSession(t.Context(), &copilot.SessionConfig{\n\t\t\tTools: []copilot.Tool{\n\t\t\t\tcopilot.DefineTool(\"encrypt_string\", \"Encrypts a string\",\n\t\t\t\t\tfunc(params EncryptParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\t\t\t\ttoolHandlerCalled = true\n\t\t\t\t\t\treturn strings.ToUpper(params.Input), nil\n\t\t\t\t\t}),\n\t\t\t},\n\t\t\tOnPermissionRequest: func(request copilot.PermissionRequest, invocation copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\t\treturn copilot.PermissionRequestResult{Kind: copilot.PermissionRequestResultKindRejected}, nil\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to create session: %v\", err)\n\t\t}\n\n\t\t_, err = session.Send(t.Context(), copilot.MessageOptions{Prompt: \"Use encrypt_string to encrypt this string: Hello\"})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to send message: %v\", err)\n\t\t}\n\n\t\t_, err = testharness.GetFinalAssistantMessage(t.Context(), session)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Failed to get assistant message: %v\", err)\n\t\t}\n\n\t\tif toolHandlerCalled {\n\t\t\tt.Errorf(\"Tool handler should NOT have been called since permission was denied\")\n\t\t}\n\t})\n}\n" }, { "path": "go/internal/embeddedcli/embeddedcli.go", "content": "package embeddedcli\n\nimport (\n\t\"bytes\"\n\t\"crypto/sha256\"\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"runtime\"\n\t\"strings\"\n\t\"sync\"\n\t\"time\"\n\n\t\"github.com/github/copilot-sdk/go/internal/flock\"\n)\n\n// Config defines the inputs used to install and locate the embedded Copilot CLI.\n//\n// Cli and CliHash are required. If Dir is empty, the CLI is installed into the\n// system cache directory. Version is used to suffix the installed binary name to\n// allow multiple versions to coexist. License, when provided, is written next\n// to the installed binary.\ntype Config struct {\n\tCli io.Reader\n\tCliHash []byte\n\n\tLicense []byte\n\n\tDir string\n\tVersion string\n}\n\nfunc Setup(cfg Config) {\n\tif cfg.Cli == nil {\n\t\tpanic(\"Cli reader is required\")\n\t}\n\tif len(cfg.CliHash) != sha256.Size {\n\t\tpanic(fmt.Sprintf(\"CliHash must be a SHA-256 hash (%d bytes), got %d bytes\", sha256.Size, len(cfg.CliHash)))\n\t}\n\tsetupMu.Lock()\n\tdefer setupMu.Unlock()\n\tif setupDone {\n\t\tpanic(\"Setup must only be called once\")\n\t}\n\tif pathInitialized {\n\t\tpanic(\"Setup must be called before Path is accessed\")\n\t}\n\tconfig = cfg\n\tsetupDone = true\n}\n\nvar Path = sync.OnceValue(func() string {\n\tsetupMu.Lock()\n\tdefer setupMu.Unlock()\n\tif !setupDone {\n\t\treturn \"\"\n\t}\n\tpathInitialized = true\n\tpath := install()\n\treturn path\n})\n\nvar (\n\tconfig Config\n\tsetupMu sync.Mutex\n\tsetupDone bool\n\tpathInitialized bool\n)\n\nfunc install() (path string) {\n\tverbose := os.Getenv(\"COPILOT_CLI_INSTALL_VERBOSE\") == \"1\"\n\tlogError := func(msg string, err error) {\n\t\tif verbose {\n\t\t\tfmt.Printf(\"embedded CLI installation error: %s: %v\\n\", msg, err)\n\t\t}\n\t}\n\tif verbose {\n\t\tstart := time.Now()\n\t\tdefer func() {\n\t\t\tduration := time.Since(start)\n\t\t\tfmt.Printf(\"installing embedded CLI at %s installation took %s\\n\", path, duration)\n\t\t}()\n\t}\n\tinstallDir := config.Dir\n\tif installDir == \"\" {\n\t\tvar err error\n\t\tif installDir, err = os.UserCacheDir(); err != nil {\n\t\t\t// Fall back to temp dir if UserCacheDir is unavailable\n\t\t\tinstallDir = os.TempDir()\n\t\t}\n\t\tinstallDir = filepath.Join(installDir, \"copilot-sdk\")\n\t}\n\tpath, err := installAt(installDir)\n\tif err != nil {\n\t\tlogError(\"installing in configured directory\", err)\n\t\treturn \"\"\n\t}\n\treturn path\n}\n\nfunc installAt(installDir string) (string, error) {\n\tif err := os.MkdirAll(installDir, 0755); err != nil {\n\t\treturn \"\", fmt.Errorf(\"creating install directory: %w\", err)\n\t}\n\tversion := sanitizeVersion(config.Version)\n\tlockName := \".copilot-cli.lock\"\n\tif version != \"\" {\n\t\tlockName = fmt.Sprintf(\".copilot-cli-%s.lock\", version)\n\t}\n\n\t// Best effort to prevent concurrent installs.\n\tif release, _ := flock.Acquire(filepath.Join(installDir, lockName)); release != nil {\n\t\tdefer release()\n\t}\n\n\tbinaryName := \"copilot\"\n\tif runtime.GOOS == \"windows\" {\n\t\tbinaryName += \".exe\"\n\t}\n\tfinalPath := versionedBinaryPath(installDir, binaryName, version)\n\n\tif _, err := os.Stat(finalPath); err == nil {\n\t\texistingHash, err := hashFile(finalPath)\n\t\tif err != nil {\n\t\t\treturn \"\", fmt.Errorf(\"hashing existing binary: %w\", err)\n\t\t}\n\t\tif !bytes.Equal(existingHash, config.CliHash) {\n\t\t\treturn \"\", fmt.Errorf(\"existing binary hash mismatch\")\n\t\t}\n\t\treturn finalPath, nil\n\t}\n\n\tf, err := os.OpenFile(finalPath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0755)\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"creating binary file: %w\", err)\n\t}\n\t_, err = io.Copy(f, config.Cli)\n\tif err1 := f.Close(); err1 != nil && err == nil {\n\t\terr = err1\n\t}\n\tif closer, ok := config.Cli.(io.Closer); ok {\n\t\tcloser.Close()\n\t}\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"writing binary file: %w\", err)\n\t}\n\tif len(config.License) > 0 {\n\t\tlicensePath := finalPath + \".license\"\n\t\tif err := os.WriteFile(licensePath, config.License, 0644); err != nil {\n\t\t\treturn \"\", fmt.Errorf(\"writing license file: %w\", err)\n\t\t}\n\t}\n\treturn finalPath, nil\n}\n\n// versionedBinaryPath builds the unpacked binary filename with an optional version suffix.\nfunc versionedBinaryPath(dir, binaryName, version string) string {\n\tif version == \"\" {\n\t\treturn filepath.Join(dir, binaryName)\n\t}\n\tbase := strings.TrimSuffix(binaryName, filepath.Ext(binaryName))\n\text := filepath.Ext(binaryName)\n\treturn filepath.Join(dir, fmt.Sprintf(\"%s_%s%s\", base, version, ext))\n}\n\n// sanitizeVersion makes a version string safe for filenames.\nfunc sanitizeVersion(version string) string {\n\tif version == \"\" {\n\t\treturn \"\"\n\t}\n\tvar b strings.Builder\n\tfor _, r := range version {\n\t\tswitch {\n\t\tcase r >= 'a' && r <= 'z':\n\t\t\tb.WriteRune(r)\n\t\tcase r >= 'A' && r <= 'Z':\n\t\t\tb.WriteRune(r)\n\t\tcase r >= '0' && r <= '9':\n\t\t\tb.WriteRune(r)\n\t\tcase r == '.' || r == '-' || r == '_':\n\t\t\tb.WriteRune(r)\n\t\tdefault:\n\t\t\tb.WriteRune('_')\n\t\t}\n\t}\n\treturn b.String()\n}\n\n// hashFile returns the SHA-256 hash of a file on disk.\nfunc hashFile(path string) ([]byte, error) {\n\tfile, err := os.Open(path)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer file.Close()\n\th := sha256.New()\n\tif _, err := io.Copy(h, file); err != nil {\n\t\treturn nil, err\n\t}\n\treturn h.Sum(nil), nil\n}\n" }, { "path": "go/internal/embeddedcli/embeddedcli_test.go", "content": "package embeddedcli\n\nimport (\n\t\"bytes\"\n\t\"crypto/sha256\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"runtime\"\n\t\"strings\"\n\t\"testing\"\n)\n\nfunc resetGlobals() {\n\tsetupMu.Lock()\n\tdefer setupMu.Unlock()\n\tconfig = Config{}\n\tsetupDone = false\n\tpathInitialized = false\n}\n\nfunc mustPanic(t *testing.T, fn func()) {\n\tt.Helper()\n\tdefer func() {\n\t\tif r := recover(); r == nil {\n\t\t\tt.Fatalf(\"expected panic\")\n\t\t}\n\t}()\n\tfn()\n}\n\nfunc binaryNameForOS() string {\n\tname := \"copilot\"\n\tif runtime.GOOS == \"windows\" {\n\t\tname += \".exe\"\n\t}\n\treturn name\n}\n\nfunc TestSetupPanicsOnNilCli(t *testing.T) {\n\tresetGlobals()\n\tmustPanic(t, func() { Setup(Config{}) })\n}\n\nfunc TestSetupPanicsOnSecondCall(t *testing.T) {\n\tresetGlobals()\n\thash := sha256.Sum256([]byte(\"ok\"))\n\tSetup(Config{Cli: bytes.NewReader([]byte(\"ok\")), CliHash: hash[:]})\n\thash2 := sha256.Sum256([]byte(\"ok\"))\n\tmustPanic(t, func() { Setup(Config{Cli: bytes.NewReader([]byte(\"ok\")), CliHash: hash2[:]}) })\n\tresetGlobals()\n}\n\nfunc TestInstallAtWritesBinaryAndLicense(t *testing.T) {\n\tresetGlobals()\n\ttempDir := t.TempDir()\n\tcontent := []byte(\"hello\")\n\thash := sha256.Sum256(content)\n\tSetup(Config{\n\t\tCli: bytes.NewReader(content),\n\t\tCliHash: hash[:],\n\t\tLicense: []byte(\"license\"),\n\t\tVersion: \"1.2.3\",\n\t\tDir: tempDir,\n\t})\n\n\tpath := Path()\n\n\texpectedPath := versionedBinaryPath(tempDir, binaryNameForOS(), \"1.2.3\")\n\tif path != expectedPath {\n\t\tt.Fatalf(\"unexpected path: got %q want %q\", path, expectedPath)\n\t}\n\n\tgot, err := os.ReadFile(path)\n\tif err != nil {\n\t\tt.Fatalf(\"read binary: %v\", err)\n\t}\n\tif !bytes.Equal(got, content) {\n\t\tt.Fatalf(\"binary content mismatch\")\n\t}\n\n\tlicensePath := path + \".license\"\n\tlicense, err := os.ReadFile(licensePath)\n\tif err != nil {\n\t\tt.Fatalf(\"read license: %v\", err)\n\t}\n\tif string(license) != \"license\" {\n\t\tt.Fatalf(\"license content mismatch\")\n\t}\n\n\tgotHash, err := hashFile(path)\n\tif err != nil {\n\t\tt.Fatalf(\"hash file: %v\", err)\n\t}\n\tif !bytes.Equal(gotHash, hash[:]) {\n\t\tt.Fatalf(\"hash mismatch\")\n\t}\n}\n\nfunc TestInstallAtExistingBinaryHashMismatch(t *testing.T) {\n\tresetGlobals()\n\ttempDir := t.TempDir()\n\tbinaryPath := versionedBinaryPath(tempDir, binaryNameForOS(), \"\")\n\tif err := os.MkdirAll(filepath.Dir(binaryPath), 0755); err != nil {\n\t\tt.Fatalf(\"mkdir: %v\", err)\n\t}\n\tif err := os.WriteFile(binaryPath, []byte(\"bad\"), 0755); err != nil {\n\t\tt.Fatalf(\"write binary: %v\", err)\n\t}\n\n\tgoodHash := sha256.Sum256([]byte(\"good\"))\n\tconfig = Config{\n\t\tCli: bytes.NewReader([]byte(\"good\")),\n\t\tCliHash: goodHash[:],\n\t}\n\n\t_, err := installAt(tempDir)\n\tif err == nil || !strings.Contains(err.Error(), \"hash mismatch\") {\n\t\tt.Fatalf(\"expected hash mismatch error, got %v\", err)\n\t}\n}\n\nfunc TestSanitizeVersion(t *testing.T) {\n\tgot := sanitizeVersion(\"v1.2.3+build/abc\")\n\twant := \"v1.2.3_build_abc\"\n\tif got != want {\n\t\tt.Fatalf(\"sanitizeVersion() = %q want %q\", got, want)\n\t}\n}\n\nfunc TestVersionedBinaryPath(t *testing.T) {\n\tgot := versionedBinaryPath(\"/tmp\", \"copilot.exe\", \"1.0.0\")\n\twant := filepath.Join(\"/tmp\", \"copilot_1.0.0.exe\")\n\tif got != want {\n\t\tt.Fatalf(\"versionedBinaryPath() = %q want %q\", got, want)\n\t}\n}\n" }, { "path": "go/internal/flock/flock.go", "content": "package flock\n\nimport \"os\"\n\n// Acquire opens (or creates) the lock file at path and blocks until the lock is acquired.\n// It returns a release function to unlock and close the file.\nfunc Acquire(path string) (func() error, error) {\n\tf, err := os.OpenFile(path, os.O_CREATE, 0644)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tif err := lockFile(f); err != nil {\n\t\t_ = f.Close()\n\t\treturn nil, err\n\t}\n\treleased := false\n\trelease := func() error {\n\t\tif released {\n\t\t\treturn nil\n\t\t}\n\t\treleased = true\n\t\terr := unlockFile(f)\n\t\tif err1 := f.Close(); err == nil {\n\t\t\terr = err1\n\t\t}\n\t\treturn err\n\t}\n\treturn release, nil\n}\n" }, { "path": "go/internal/flock/flock_other.go", "content": "//go:build !windows && (!unix || aix || (solaris && !illumos))\n\npackage flock\n\nimport (\n\t\"errors\"\n\t\"os\"\n)\n\nfunc lockFile(_ *os.File) error {\n\treturn errors.ErrUnsupported\n}\n\nfunc unlockFile(_ *os.File) (err error) {\n\treturn errors.ErrUnsupported\n}\n" }, { "path": "go/internal/flock/flock_test.go", "content": "package flock\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"testing\"\n\t\"time\"\n)\n\nfunc TestAcquireReleaseCreatesFile(t *testing.T) {\n\tpath := filepath.Join(t.TempDir(), \"lockfile\")\n\n\trelease, err := Acquire(path)\n\tif errors.Is(err, errors.ErrUnsupported) {\n\t\tt.Skip(\"file locking unsupported on this platform\")\n\t}\n\tif err != nil {\n\t\tt.Fatalf(\"Acquire failed: %v\", err)\n\t}\n\tif _, err := os.Stat(path); err != nil {\n\t\trelease()\n\t\tt.Fatalf(\"lock file not created: %v\", err)\n\t}\n\n\tif err := release(); err != nil {\n\t\tt.Fatalf(\"Release failed: %v\", err)\n\t}\n\tif err := release(); err != nil {\n\t\tt.Fatalf(\"Release should be idempotent: %v\", err)\n\t}\n}\n\nfunc TestLockBlocksUntilRelease(t *testing.T) {\n\tpath := filepath.Join(t.TempDir(), \"lockfile\")\n\n\tfirst, err := Acquire(path)\n\tif errors.Is(err, errors.ErrUnsupported) {\n\t\tt.Skip(\"file locking unsupported on this platform\")\n\t}\n\tif err != nil {\n\t\tt.Fatalf(\"Acquire failed: %v\", err)\n\t}\n\tdefer first()\n\n\tresult := make(chan error, 1)\n\tvar second func() error\n\tgo func() {\n\t\tlock, err := Acquire(path)\n\t\tif err == nil {\n\t\t\tsecond = lock\n\t\t}\n\t\tresult <- err\n\t}()\n\n\tblockCtx, cancelBlock := context.WithTimeout(t.Context(), 50*time.Millisecond)\n\tdefer cancelBlock()\n\tselect {\n\tcase err := <-result:\n\t\tif err == nil && second != nil {\n\t\t\t_ = second()\n\t\t}\n\t\tt.Fatalf(\"second Acquire should block, returned early: %v\", err)\n\tcase <-blockCtx.Done():\n\t}\n\n\tif err := first(); err != nil {\n\t\tt.Fatalf(\"Release failed: %v\", err)\n\t}\n\n\tunlockCtx, cancelUnlock := context.WithTimeout(t.Context(), 1*time.Second)\n\tdefer cancelUnlock()\n\tselect {\n\tcase err := <-result:\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"second Acquire failed: %v\", err)\n\t\t}\n\t\tif second == nil {\n\t\t\tt.Fatalf(\"second lock was not set\")\n\t\t}\n\t\tif err := second(); err != nil {\n\t\t\tt.Fatalf(\"second Release failed: %v\", err)\n\t\t}\n\tcase <-unlockCtx.Done():\n\t\tt.Fatalf(\"second Acquire did not unblock\")\n\t}\n}\n" }, { "path": "go/internal/flock/flock_unix.go", "content": "//go:build darwin || dragonfly || freebsd || illumos || linux || netbsd || openbsd\n\npackage flock\n\nimport (\n\t\"os\"\n\t\"syscall\"\n)\n\nfunc lockFile(f *os.File) (err error) {\n\tfor {\n\t\terr = syscall.Flock(int(f.Fd()), syscall.LOCK_EX)\n\t\tif err != syscall.EINTR {\n\t\t\tbreak\n\t\t}\n\t}\n\treturn err\n}\n\nfunc unlockFile(f *os.File) (err error) {\n\tfor {\n\t\terr = syscall.Flock(int(f.Fd()), syscall.LOCK_UN)\n\t\tif err != syscall.EINTR {\n\t\t\tbreak\n\t\t}\n\t}\n\treturn err\n}\n" }, { "path": "go/internal/flock/flock_windows.go", "content": "//go:build windows\n\npackage flock\n\nimport (\n\t\"os\"\n\t\"syscall\"\n\t\"unsafe\"\n)\n\nvar (\n\tmodKernel32 = syscall.NewLazyDLL(\"kernel32.dll\")\n\tprocLockFileEx = modKernel32.NewProc(\"LockFileEx\")\n\tprocUnlockFileEx = modKernel32.NewProc(\"UnlockFileEx\")\n)\n\nconst LOCKFILE_EXCLUSIVE_LOCK = 0x00000002\n\nfunc lockFile(f *os.File) error {\n\trc, err := f.SyscallConn()\n\tif err != nil {\n\t\treturn err\n\t}\n\tvar callErr error\n\tif err := rc.Control(func(fd uintptr) {\n\t\tvar ol syscall.Overlapped\n\t\tr1, _, e1 := procLockFileEx.Call(\n\t\t\tfd,\n\t\t\tuintptr(LOCKFILE_EXCLUSIVE_LOCK),\n\t\t\t0,\n\t\t\t1,\n\t\t\t0,\n\t\t\tuintptr(unsafe.Pointer(&ol)),\n\t\t)\n\t\tif r1 == 0 {\n\t\t\tcallErr = e1\n\t\t}\n\t}); err != nil {\n\t\treturn err\n\t}\n\treturn callErr\n}\n\nfunc unlockFile(f *os.File) error {\n\trc, err := f.SyscallConn()\n\tif err != nil {\n\t\treturn err\n\t}\n\tvar callErr error\n\tif err := rc.Control(func(fd uintptr) {\n\t\tvar ol syscall.Overlapped\n\t\tr1, _, e1 := procUnlockFileEx.Call(\n\t\t\tfd,\n\t\t\t0,\n\t\t\t1,\n\t\t\t0,\n\t\t\tuintptr(unsafe.Pointer(&ol)),\n\t\t)\n\t\tif r1 == 0 {\n\t\t\tcallErr = e1\n\t\t}\n\t}); err != nil {\n\t\treturn err\n\t}\n\treturn callErr\n}\n" }, { "path": "go/internal/jsonrpc2/frame.go", "content": "package jsonrpc2\n\nimport (\n\t\"bufio\"\n\t\"fmt\"\n\t\"io\"\n\t\"math\"\n\t\"strconv\"\n\t\"strings\"\n)\n\n// headerReader reads Content-Length delimited JSON-RPC frames from a stream.\ntype headerReader struct {\n\tin *bufio.Reader\n}\n\nfunc newHeaderReader(r io.Reader) *headerReader {\n\treturn &headerReader{in: bufio.NewReader(r)}\n}\n\n// Read reads the next complete frame from the stream. It returns io.EOF on a\n// clean end-of-stream (no partial data) and io.ErrUnexpectedEOF if the stream\n// was interrupted mid-header.\nfunc (r *headerReader) Read() ([]byte, error) {\n\tfirstRead := true\n\tvar contentLength int64\n\t// Read headers, stop on the first blank line.\n\tfor {\n\t\tline, err := r.in.ReadString('\\n')\n\t\tif err != nil {\n\t\t\tif err == io.EOF {\n\t\t\t\tif firstRead && line == \"\" {\n\t\t\t\t\treturn nil, io.EOF // clean EOF\n\t\t\t\t}\n\t\t\t\terr = io.ErrUnexpectedEOF\n\t\t\t}\n\t\t\treturn nil, fmt.Errorf(\"failed reading header line: %w\", err)\n\t\t}\n\t\tfirstRead = false\n\n\t\tline = strings.TrimSpace(line)\n\t\tif line == \"\" {\n\t\t\tbreak\n\t\t}\n\t\tcolon := strings.IndexRune(line, ':')\n\t\tif colon < 0 {\n\t\t\treturn nil, fmt.Errorf(\"invalid header line %q\", line)\n\t\t}\n\t\tname, value := line[:colon], strings.TrimSpace(line[colon+1:])\n\t\tswitch name {\n\t\tcase \"Content-Length\":\n\t\t\tcontentLength, err = strconv.ParseInt(value, 10, 64)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, fmt.Errorf(\"failed parsing Content-Length: %v\", value)\n\t\t\t}\n\t\t\tif contentLength <= 0 {\n\t\t\t\treturn nil, fmt.Errorf(\"invalid Content-Length: %v\", contentLength)\n\t\t\t}\n\t\tdefault:\n\t\t\t// ignoring unknown headers\n\t\t}\n\t}\n\tif contentLength == 0 {\n\t\treturn nil, fmt.Errorf(\"missing Content-Length header\")\n\t}\n\tif contentLength > math.MaxInt {\n\t\treturn nil, fmt.Errorf(\"Content-Length too large: %d\", contentLength)\n\t}\n\tdata := make([]byte, contentLength)\n\tif _, err := io.ReadFull(r.in, data); err != nil {\n\t\treturn nil, err\n\t}\n\treturn data, nil\n}\n\n// headerWriter writes Content-Length delimited JSON-RPC frames to a stream.\ntype headerWriter struct {\n\tout io.Writer\n}\n\nfunc newHeaderWriter(w io.Writer) *headerWriter {\n\treturn &headerWriter{out: w}\n}\n\n// Write sends a single frame with Content-Length header.\nfunc (w *headerWriter) Write(data []byte) error {\n\tif _, err := fmt.Fprintf(w.out, \"Content-Length: %d\\r\\n\\r\\n\", len(data)); err != nil {\n\t\treturn err\n\t}\n\t_, err := w.out.Write(data)\n\treturn err\n}\n" }, { "path": "go/internal/jsonrpc2/jsonrpc2.go", "content": "package jsonrpc2\n\nimport (\n\t\"crypto/rand\"\n\t\"encoding/json\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"reflect\"\n\t\"sync\"\n\t\"sync/atomic\"\n)\n\nconst version = \"2.0\"\n\n// Standard JSON-RPC 2.0 error codes.\nvar (\n\tErrParse = &Error{Code: -32700, Message: \"parse error\"}\n\tErrInvalidRequest = &Error{Code: -32600, Message: \"invalid request\"}\n\tErrMethodNotFound = &Error{Code: -32601, Message: \"method not found\"}\n\tErrInvalidParams = &Error{Code: -32602, Message: \"invalid params\"}\n\tErrInternal = &Error{Code: -32603, Message: \"internal error\"}\n)\n\n// Error represents a JSON-RPC error response.\ntype Error struct {\n\tCode int `json:\"code\"`\n\tMessage string `json:\"message\"`\n\tData json.RawMessage `json:\"data,omitempty\"`\n}\n\nfunc (e *Error) Error() string {\n\treturn fmt.Sprintf(\"JSON-RPC Error %d: %s\", e.Code, e.Message)\n}\n\n// Request represents a JSON-RPC 2.0 request\ntype Request struct {\n\tJSONRPC string `json:\"jsonrpc\"`\n\tID json.RawMessage `json:\"id\"` // nil for notifications\n\tMethod string `json:\"method\"`\n\tParams json.RawMessage `json:\"params\"`\n}\n\nfunc (r *Request) IsCall() bool {\n\treturn len(r.ID) > 0\n}\n\n// Response represents a JSON-RPC 2.0 response\ntype Response struct {\n\tJSONRPC string `json:\"jsonrpc\"`\n\tID json.RawMessage `json:\"id,omitempty\"`\n\tResult json.RawMessage `json:\"result,omitempty\"`\n\tError *Error `json:\"error,omitempty\"`\n}\n\n// NotificationHandler handles incoming notifications\ntype NotificationHandler func(method string, params json.RawMessage)\n\n// RequestHandler handles incoming server requests and returns a result or error\ntype RequestHandler func(params json.RawMessage) (json.RawMessage, *Error)\n\n// Client is a minimal JSON-RPC 2.0 client for stdio transport.\ntype Client struct {\n\treader *headerReader // reads frames from the remote side\n\tstdout io.ReadCloser\n\twriter chan *headerWriter // 1-buffered; holds the writer when not in use\n\tmu sync.Mutex\n\tpendingRequests map[string]chan *Response\n\trequestHandlers map[string]RequestHandler\n\trunning atomic.Bool\n\tstopChan chan struct{}\n\twg sync.WaitGroup\n\tprocessDone chan struct{} // closed when the underlying process exits\n\tprocessError error // set before processDone is closed\n\tprocessErrorMu sync.RWMutex // protects processError\n\tonClose func() // called when the read loop exits unexpectedly\n}\n\n// NewClient creates a new JSON-RPC client.\nfunc NewClient(stdin io.WriteCloser, stdout io.ReadCloser) *Client {\n\tc := &Client{\n\t\treader: newHeaderReader(stdout),\n\t\tstdout: stdout,\n\t\twriter: make(chan *headerWriter, 1),\n\t\tpendingRequests: make(map[string]chan *Response),\n\t\trequestHandlers: make(map[string]RequestHandler),\n\t\tstopChan: make(chan struct{}),\n\t}\n\tc.writer <- newHeaderWriter(stdin)\n\treturn c\n}\n\n// SetProcessDone sets a channel that will be closed when the process exits,\n// and stores the error that should be returned to pending/future requests.\nfunc (c *Client) SetProcessDone(done chan struct{}, errPtr *error) {\n\tc.processDone = done\n\t// Monitor the channel and copy the error when it closes\n\tgo func() {\n\t\t<-done\n\t\tif errPtr != nil {\n\t\t\tc.processErrorMu.Lock()\n\t\t\tc.processError = *errPtr\n\t\t\tc.processErrorMu.Unlock()\n\t\t}\n\t}()\n}\n\n// getProcessError returns the process exit error if the process has exited\nfunc (c *Client) getProcessError() error {\n\tc.processErrorMu.RLock()\n\tdefer c.processErrorMu.RUnlock()\n\treturn c.processError\n}\n\n// Start begins listening for messages in a background goroutine\nfunc (c *Client) Start() {\n\tc.running.Store(true)\n\tc.wg.Add(1)\n\tgo c.readLoop()\n}\n\n// Stop stops the client and cleans up\nfunc (c *Client) Stop() {\n\tif !c.running.Load() {\n\t\treturn\n\t}\n\tc.running.Store(false)\n\tclose(c.stopChan)\n\n\t// Close stdout to unblock the readLoop\n\tif c.stdout != nil {\n\t\tc.stdout.Close()\n\t}\n\n\tc.wg.Wait()\n}\n\nfunc NotificationHandlerFor[In any](handler func(params In)) RequestHandler {\n\treturn func(params json.RawMessage) (json.RawMessage, *Error) {\n\t\tvar in In\n\t\t// If In is a pointer type, allocate the underlying value and unmarshal into it directly\n\t\tvar target any = &in\n\t\tif t := reflect.TypeFor[In](); t.Kind() == reflect.Pointer {\n\t\t\tin = reflect.New(t.Elem()).Interface().(In)\n\t\t\ttarget = in\n\t\t}\n\t\tif err := json.Unmarshal(params, target); err != nil {\n\t\t\treturn nil, &Error{\n\t\t\t\tCode: ErrInvalidParams.Code,\n\t\t\t\tMessage: fmt.Sprintf(\"Invalid params: %v\", err),\n\t\t\t}\n\t\t}\n\t\thandler(in)\n\t\treturn nil, nil\n\t}\n}\n\n// RequestHandlerFor creates a RequestHandler from a typed function\nfunc RequestHandlerFor[In, Out any](handler func(params In) (Out, *Error)) RequestHandler {\n\treturn func(params json.RawMessage) (json.RawMessage, *Error) {\n\t\tvar in In\n\t\t// If In is a pointer type, allocate the underlying value and unmarshal into it directly\n\t\tvar target any = &in\n\t\tif t := reflect.TypeOf(in); t != nil && t.Kind() == reflect.Pointer {\n\t\t\tin = reflect.New(t.Elem()).Interface().(In)\n\t\t\ttarget = in\n\t\t}\n\t\tif err := json.Unmarshal(params, target); err != nil {\n\t\t\treturn nil, &Error{\n\t\t\t\tCode: ErrInvalidParams.Code,\n\t\t\t\tMessage: fmt.Sprintf(\"Invalid params: %v\", err),\n\t\t\t}\n\t\t}\n\t\tout, errj := handler(in)\n\t\tif errj != nil {\n\t\t\treturn nil, errj\n\t\t}\n\t\toutData, err := json.Marshal(out)\n\t\tif err != nil {\n\t\t\treturn nil, &Error{\n\t\t\t\tCode: ErrInternal.Code,\n\t\t\t\tMessage: fmt.Sprintf(\"Failed to marshal response: %v\", err),\n\t\t\t}\n\t\t}\n\t\treturn outData, nil\n\t}\n}\n\n// SetRequestHandler registers a handler for incoming requests from the server\nfunc (c *Client) SetRequestHandler(method string, handler RequestHandler) {\n\tc.mu.Lock()\n\tdefer c.mu.Unlock()\n\tif handler == nil {\n\t\tdelete(c.requestHandlers, method)\n\t\treturn\n\t}\n\tc.requestHandlers[method] = handler\n}\n\n// Request sends a JSON-RPC request and waits for the response\nfunc (c *Client) Request(method string, params any) (json.RawMessage, error) {\n\trequestID := generateUUID()\n\n\t// Create response channel\n\tresponseChan := make(chan *Response, 1)\n\tc.mu.Lock()\n\tc.pendingRequests[requestID] = responseChan\n\tc.mu.Unlock()\n\n\t// Clean up on exit\n\tdefer func() {\n\t\tc.mu.Lock()\n\t\tdelete(c.pendingRequests, requestID)\n\t\tc.mu.Unlock()\n\t}()\n\n\t// Check if process already exited before sending\n\tif c.processDone != nil {\n\t\tselect {\n\t\tcase <-c.processDone:\n\t\t\tif err := c.getProcessError(); err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\treturn nil, fmt.Errorf(\"process exited unexpectedly\")\n\t\tdefault:\n\t\t\t// Process still running, continue\n\t\t}\n\t}\n\n\tvar paramsData json.RawMessage\n\tif params == nil {\n\t\tparamsData = json.RawMessage(\"{}\")\n\t} else {\n\t\tvar err error\n\t\tparamsData, err = json.Marshal(params)\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to marshal params: %w\", err)\n\t\t}\n\t}\n\n\t// Send request\n\trequest := Request{\n\t\tJSONRPC: version,\n\t\tID: json.RawMessage(`\"` + requestID + `\"`),\n\t\tMethod: method,\n\t\tParams: paramsData,\n\t}\n\n\tif err := c.sendMessage(request); err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to send request: %w\", err)\n\t}\n\n\t// Wait for response, also checking for process exit\n\tif c.processDone != nil {\n\t\tselect {\n\t\tcase response := <-responseChan:\n\t\t\tif response.Error != nil {\n\t\t\t\treturn nil, response.Error\n\t\t\t}\n\t\t\treturn response.Result, nil\n\t\tcase <-c.processDone:\n\t\t\tif err := c.getProcessError(); err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\treturn nil, fmt.Errorf(\"process exited unexpectedly\")\n\t\tcase <-c.stopChan:\n\t\t\treturn nil, fmt.Errorf(\"client stopped\")\n\t\t}\n\t}\n\tselect {\n\tcase response := <-responseChan:\n\t\tif response.Error != nil {\n\t\t\treturn nil, response.Error\n\t\t}\n\t\treturn response.Result, nil\n\tcase <-c.stopChan:\n\t\treturn nil, fmt.Errorf(\"client stopped\")\n\t}\n}\n\n// sendMessage writes a message to the stream.\n// Write serialization is achieved via a 1-buffered channel that holds the\n// writer when not in use, avoiding the need for a mutex on the write path.\nfunc (c *Client) sendMessage(message any) error {\n\tdata, err := json.Marshal(message)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to marshal message: %w\", err)\n\t}\n\n\tw := <-c.writer\n\tdefer func() { c.writer <- w }()\n\treturn w.Write(data)\n}\n\n// SetOnClose sets a callback invoked when the read loop exits unexpectedly\n// (e.g. the underlying connection or process was lost).\nfunc (c *Client) SetOnClose(fn func()) {\n\tc.onClose = fn\n}\n\n// readLoop reads messages from the stream in a background goroutine.\nfunc (c *Client) readLoop() {\n\tdefer c.wg.Done()\n\tdefer func() {\n\t\t// If still running, the read loop exited unexpectedly (process died or\n\t\t// connection dropped). Notify the caller so it can update its state.\n\t\tif c.onClose != nil && c.running.Load() {\n\t\t\tc.onClose()\n\t\t}\n\t}()\n\n\tfor c.running.Load() {\n\t\t// Read the next frame.\n\t\tdata, err := c.reader.Read()\n\t\tif err != nil {\n\t\t\tif !errors.Is(err, io.EOF) && !errors.Is(err, io.ErrClosedPipe) && !errors.Is(err, os.ErrClosed) && c.running.Load() {\n\t\t\t\tfmt.Printf(\"Error reading message: %v\\n\", err)\n\t\t\t}\n\t\t\treturn\n\t\t}\n\n\t\t// Decode using a single unmarshal into the combined wire format.\n\t\tmsg, err := decodeMessage(data)\n\t\tif err != nil {\n\t\t\tif c.running.Load() {\n\t\t\t\tfmt.Printf(\"Error decoding message: %v\\n\", err)\n\t\t\t}\n\t\t\tcontinue\n\t\t}\n\n\t\tswitch msg := msg.(type) {\n\t\tcase *Request:\n\t\t\tc.handleRequest(msg)\n\t\tcase *Response:\n\t\t\tc.handleResponse(msg)\n\t\t}\n\t}\n}\n\n// handleResponse dispatches a response to the waiting request\nfunc (c *Client) handleResponse(response *Response) {\n\tvar id string\n\tif err := json.Unmarshal(response.ID, &id); err != nil {\n\t\treturn // ignore responses with non-string IDs\n\t}\n\tc.mu.Lock()\n\tresponseChan, ok := c.pendingRequests[id]\n\tc.mu.Unlock()\n\n\tif ok {\n\t\tselect {\n\t\tcase responseChan <- response:\n\t\tdefault:\n\t\t}\n\t}\n}\n\nfunc (c *Client) handleRequest(request *Request) {\n\tc.mu.Lock()\n\thandler := c.requestHandlers[request.Method]\n\tc.mu.Unlock()\n\n\tif handler == nil {\n\t\tif request.IsCall() {\n\t\t\tc.sendErrorResponse(request.ID, &Error{\n\t\t\t\tCode: ErrMethodNotFound.Code,\n\t\t\t\tMessage: fmt.Sprintf(\"Method not found: %s\", request.Method),\n\t\t\t})\n\t\t}\n\t\treturn\n\t}\n\n\t// Notifications run synchronously, calls run in a goroutine to avoid blocking\n\tif !request.IsCall() {\n\t\thandler(request.Params)\n\t\treturn\n\t}\n\n\tgo func() {\n\t\tdefer func() {\n\t\t\tif r := recover(); r != nil {\n\t\t\t\tc.sendErrorResponse(request.ID, &Error{\n\t\t\t\t\tCode: ErrInternal.Code,\n\t\t\t\t\tMessage: fmt.Sprintf(\"request handler panic: %v\", r),\n\t\t\t\t})\n\t\t\t}\n\t\t}()\n\n\t\tresult, err := handler(request.Params)\n\t\tif err != nil {\n\t\t\tc.sendErrorResponse(request.ID, err)\n\t\t\treturn\n\t\t}\n\t\tc.sendResponse(request.ID, result)\n\t}()\n}\n\nfunc (c *Client) sendResponse(id json.RawMessage, result json.RawMessage) {\n\tresponse := Response{\n\t\tJSONRPC: version,\n\t\tID: id,\n\t\tResult: result,\n\t}\n\tif err := c.sendMessage(response); err != nil {\n\t\tfmt.Printf(\"Failed to send JSON-RPC response: %v\\n\", err)\n\t}\n}\n\nfunc (c *Client) sendErrorResponse(id json.RawMessage, rpcErr *Error) {\n\tresponse := Response{\n\t\tJSONRPC: version,\n\t\tID: id,\n\t\tError: rpcErr,\n\t}\n\tif err := c.sendMessage(response); err != nil {\n\t\tfmt.Printf(\"Failed to send JSON-RPC error response: %v\\n\", err)\n\t}\n}\n\n// generateUUID generates a simple UUID v4 without external dependencies\nfunc generateUUID() string {\n\tb := make([]byte, 16)\n\trand.Read(b)\n\tb[6] = (b[6] & 0x0f) | 0x40 // Version 4\n\tb[8] = (b[8] & 0x3f) | 0x80 // Variant is 10\n\treturn fmt.Sprintf(\"%x-%x-%x-%x-%x\", b[0:4], b[4:6], b[6:8], b[8:10], b[10:])\n}\n\n// decodeMessage decodes a JSON-RPC message from raw bytes, returning either\n// a *Request or a *Response.\nfunc decodeMessage(data []byte) (any, error) {\n\t// msg contains all fields of both Request and Response.\n\tvar msg struct {\n\t\tJSONRPC string `json:\"jsonrpc\"`\n\t\tID json.RawMessage `json:\"id,omitempty\"`\n\t\tMethod string `json:\"method,omitempty\"`\n\t\tParams json.RawMessage `json:\"params,omitempty\"`\n\t\tResult json.RawMessage `json:\"result,omitempty\"`\n\t\tError *Error `json:\"error,omitempty\"`\n\t}\n\tif err := json.Unmarshal(data, &msg); err != nil {\n\t\treturn nil, fmt.Errorf(\"unmarshaling jsonrpc message: %w\", err)\n\t}\n\tif msg.JSONRPC != version {\n\t\treturn nil, fmt.Errorf(\"unsupported JSON-RPC version %q; expected %q\", msg.JSONRPC, version)\n\t}\n\tif msg.Method != \"\" {\n\t\treturn &Request{\n\t\t\tJSONRPC: msg.JSONRPC,\n\t\t\tID: msg.ID,\n\t\t\tMethod: msg.Method,\n\t\t\tParams: msg.Params,\n\t\t}, nil\n\t}\n\tif len(msg.ID) > 0 {\n\t\tif msg.Error != nil && len(msg.Result) > 0 {\n\t\t\treturn nil, fmt.Errorf(\"response must not contain both result and error: %w\", ErrInvalidRequest)\n\t\t}\n\t\tif msg.Error == nil && len(msg.Result) == 0 {\n\t\t\treturn nil, fmt.Errorf(\"response must contain either result or error: %w\", ErrInvalidRequest)\n\t\t}\n\t\treturn &Response{\n\t\t\tJSONRPC: msg.JSONRPC,\n\t\t\tID: msg.ID,\n\t\t\tResult: msg.Result,\n\t\t\tError: msg.Error,\n\t\t}, nil\n\t}\n\treturn nil, fmt.Errorf(\"message is neither a request nor a response: %w\", ErrInvalidRequest)\n}\n" }, { "path": "go/internal/jsonrpc2/jsonrpc2_test.go", "content": "package jsonrpc2\n\nimport (\n\t\"io\"\n\t\"sync\"\n\t\"testing\"\n\t\"time\"\n)\n\nfunc TestOnCloseCalledOnUnexpectedExit(t *testing.T) {\n\tstdinR, stdinW := io.Pipe()\n\tstdoutR, stdoutW := io.Pipe()\n\tdefer stdinR.Close()\n\n\tclient := NewClient(stdinW, stdoutR)\n\n\tvar called bool\n\tvar mu sync.Mutex\n\tclient.SetOnClose(func() {\n\t\tmu.Lock()\n\t\tcalled = true\n\t\tmu.Unlock()\n\t})\n\n\tclient.Start()\n\n\t// Simulate unexpected process death by closing the stdout writer\n\tstdoutW.Close()\n\n\t// Wait for readLoop to detect the close and invoke the callback\n\ttime.Sleep(200 * time.Millisecond)\n\n\tmu.Lock()\n\tdefer mu.Unlock()\n\tif !called {\n\t\tt.Error(\"expected onClose to be called when read loop exits unexpectedly\")\n\t}\n}\n\nfunc TestOnCloseNotCalledOnIntentionalStop(t *testing.T) {\n\tstdinR, stdinW := io.Pipe()\n\tstdoutR, stdoutW := io.Pipe()\n\tdefer stdinR.Close()\n\tdefer stdoutW.Close()\n\n\tclient := NewClient(stdinW, stdoutR)\n\n\tvar called bool\n\tvar mu sync.Mutex\n\tclient.SetOnClose(func() {\n\t\tmu.Lock()\n\t\tcalled = true\n\t\tmu.Unlock()\n\t})\n\n\tclient.Start()\n\n\t// Intentional stop — should set running=false before closing stdout,\n\t// so the readLoop should NOT invoke onClose.\n\tclient.Stop()\n\n\ttime.Sleep(200 * time.Millisecond)\n\n\tmu.Lock()\n\tdefer mu.Unlock()\n\tif called {\n\t\tt.Error(\"onClose should not be called on intentional Stop()\")\n\t}\n}\n" }, { "path": "go/permissions.go", "content": "package copilot\n\n// PermissionHandler provides pre-built OnPermissionRequest implementations.\nvar PermissionHandler = struct {\n\t// ApproveAll approves all permission requests.\n\tApproveAll PermissionHandlerFunc\n}{\n\tApproveAll: func(_ PermissionRequest, _ PermissionInvocation) (PermissionRequestResult, error) {\n\t\treturn PermissionRequestResult{Kind: PermissionRequestResultKindApproved}, nil\n\t},\n}\n" }, { "path": "go/process_other.go", "content": "//go:build !windows\n\npackage copilot\n\nimport \"os/exec\"\n\n// configureProcAttr configures platform-specific process attributes.\n// On non-Windows platforms, this is a no-op.\nfunc configureProcAttr(cmd *exec.Cmd) {\n\t// No special configuration needed on non-Windows platforms\n}\n" }, { "path": "go/process_windows.go", "content": "//go:build windows\n\npackage copilot\n\nimport (\n\t\"os/exec\"\n\t\"syscall\"\n)\n\n// configureProcAttr configures platform-specific process attributes.\n// On Windows, this hides the console window to avoid distracting users in GUI apps.\nfunc configureProcAttr(cmd *exec.Cmd) {\n\tcmd.SysProcAttr = &syscall.SysProcAttr{\n\t\tHideWindow: true,\n\t}\n}\n" }, { "path": "go/rpc/generated_rpc.go", "content": "// AUTO-GENERATED FILE - DO NOT EDIT\n// Generated from: api.schema.json\n\npackage rpc\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"errors\"\n\t\"fmt\"\n\t\"github.com/github/copilot-sdk/go/internal/jsonrpc2\"\n\t\"time\"\n)\n\ntype RPCTypes struct {\n\tAccountGetQuotaRequest AccountGetQuotaRequest `json:\"AccountGetQuotaRequest\"`\n\tAccountGetQuotaResult AccountGetQuotaResult `json:\"AccountGetQuotaResult\"`\n\tAccountQuotaSnapshot AccountQuotaSnapshot `json:\"AccountQuotaSnapshot\"`\n\tAgentDeselectResult AgentDeselectResult `json:\"AgentDeselectResult\"`\n\tAgentGetCurrentResult AgentGetCurrentResult `json:\"AgentGetCurrentResult\"`\n\tAgentInfo AgentInfo `json:\"AgentInfo\"`\n\tAgentList AgentList `json:\"AgentList\"`\n\tAgentReloadResult AgentReloadResult `json:\"AgentReloadResult\"`\n\tAgentSelectRequest AgentSelectRequest `json:\"AgentSelectRequest\"`\n\tAgentSelectResult AgentSelectResult `json:\"AgentSelectResult\"`\n\tAuthInfoType AuthInfoType `json:\"AuthInfoType\"`\n\tCommandsHandlePendingCommandRequest CommandsHandlePendingCommandRequest `json:\"CommandsHandlePendingCommandRequest\"`\n\tCommandsHandlePendingCommandResult CommandsHandlePendingCommandResult `json:\"CommandsHandlePendingCommandResult\"`\n\tCurrentModel CurrentModel `json:\"CurrentModel\"`\n\tDiscoveredMCPServer DiscoveredMCPServer `json:\"DiscoveredMcpServer\"`\n\tDiscoveredMCPServerSource MCPServerSource `json:\"DiscoveredMcpServerSource\"`\n\tDiscoveredMCPServerType DiscoveredMCPServerType `json:\"DiscoveredMcpServerType\"`\n\tEmbeddedBlobResourceContents EmbeddedBlobResourceContents `json:\"EmbeddedBlobResourceContents\"`\n\tEmbeddedTextResourceContents EmbeddedTextResourceContents `json:\"EmbeddedTextResourceContents\"`\n\tExtension Extension `json:\"Extension\"`\n\tExtensionList ExtensionList `json:\"ExtensionList\"`\n\tExtensionsDisableRequest ExtensionsDisableRequest `json:\"ExtensionsDisableRequest\"`\n\tExtensionsDisableResult ExtensionsDisableResult `json:\"ExtensionsDisableResult\"`\n\tExtensionsEnableRequest ExtensionsEnableRequest `json:\"ExtensionsEnableRequest\"`\n\tExtensionsEnableResult ExtensionsEnableResult `json:\"ExtensionsEnableResult\"`\n\tExtensionSource ExtensionSource `json:\"ExtensionSource\"`\n\tExtensionsReloadResult ExtensionsReloadResult `json:\"ExtensionsReloadResult\"`\n\tExtensionStatus ExtensionStatus `json:\"ExtensionStatus\"`\n\tExternalToolResult *ExternalToolResult `json:\"ExternalToolResult\"`\n\tExternalToolTextResultForLlm ExternalToolTextResultForLlm `json:\"ExternalToolTextResultForLlm\"`\n\tExternalToolTextResultForLlmContent ExternalToolTextResultForLlmContent `json:\"ExternalToolTextResultForLlmContent\"`\n\tExternalToolTextResultForLlmContentAudio ExternalToolTextResultForLlmContentAudio `json:\"ExternalToolTextResultForLlmContentAudio\"`\n\tExternalToolTextResultForLlmContentImage ExternalToolTextResultForLlmContentImage `json:\"ExternalToolTextResultForLlmContentImage\"`\n\tExternalToolTextResultForLlmContentResource ExternalToolTextResultForLlmContentResource `json:\"ExternalToolTextResultForLlmContentResource\"`\n\tExternalToolTextResultForLlmContentResourceDetails ExternalToolTextResultForLlmContentResourceDetails `json:\"ExternalToolTextResultForLlmContentResourceDetails\"`\n\tExternalToolTextResultForLlmContentResourceLink ExternalToolTextResultForLlmContentResourceLink `json:\"ExternalToolTextResultForLlmContentResourceLink\"`\n\tExternalToolTextResultForLlmContentResourceLinkIcon ExternalToolTextResultForLlmContentResourceLinkIcon `json:\"ExternalToolTextResultForLlmContentResourceLinkIcon\"`\n\tExternalToolTextResultForLlmContentResourceLinkIconTheme ExternalToolTextResultForLlmContentResourceLinkIconTheme `json:\"ExternalToolTextResultForLlmContentResourceLinkIconTheme\"`\n\tExternalToolTextResultForLlmContentTerminal ExternalToolTextResultForLlmContentTerminal `json:\"ExternalToolTextResultForLlmContentTerminal\"`\n\tExternalToolTextResultForLlmContentText ExternalToolTextResultForLlmContentText `json:\"ExternalToolTextResultForLlmContentText\"`\n\tFilterMapping *FilterMapping `json:\"FilterMapping\"`\n\tFilterMappingString FilterMappingString `json:\"FilterMappingString\"`\n\tFilterMappingValue FilterMappingString `json:\"FilterMappingValue\"`\n\tFleetStartRequest FleetStartRequest `json:\"FleetStartRequest\"`\n\tFleetStartResult FleetStartResult `json:\"FleetStartResult\"`\n\tHandlePendingToolCallRequest HandlePendingToolCallRequest `json:\"HandlePendingToolCallRequest\"`\n\tHandlePendingToolCallResult HandlePendingToolCallResult `json:\"HandlePendingToolCallResult\"`\n\tHistoryCompactContextWindow HistoryCompactContextWindow `json:\"HistoryCompactContextWindow\"`\n\tHistoryCompactResult HistoryCompactResult `json:\"HistoryCompactResult\"`\n\tHistoryTruncateRequest HistoryTruncateRequest `json:\"HistoryTruncateRequest\"`\n\tHistoryTruncateResult HistoryTruncateResult `json:\"HistoryTruncateResult\"`\n\tInstructionsGetSourcesResult InstructionsGetSourcesResult `json:\"InstructionsGetSourcesResult\"`\n\tInstructionsSources InstructionsSources `json:\"InstructionsSources\"`\n\tInstructionsSourcesLocation InstructionsSourcesLocation `json:\"InstructionsSourcesLocation\"`\n\tInstructionsSourcesType InstructionsSourcesType `json:\"InstructionsSourcesType\"`\n\tLogRequest LogRequest `json:\"LogRequest\"`\n\tLogResult LogResult `json:\"LogResult\"`\n\tMCPConfigAddRequest MCPConfigAddRequest `json:\"McpConfigAddRequest\"`\n\tMCPConfigAddResult MCPConfigAddResult `json:\"McpConfigAddResult\"`\n\tMCPConfigDisableRequest MCPConfigDisableRequest `json:\"McpConfigDisableRequest\"`\n\tMCPConfigDisableResult MCPConfigDisableResult `json:\"McpConfigDisableResult\"`\n\tMCPConfigEnableRequest MCPConfigEnableRequest `json:\"McpConfigEnableRequest\"`\n\tMCPConfigEnableResult MCPConfigEnableResult `json:\"McpConfigEnableResult\"`\n\tMCPConfigList MCPConfigList `json:\"McpConfigList\"`\n\tMCPConfigRemoveRequest MCPConfigRemoveRequest `json:\"McpConfigRemoveRequest\"`\n\tMCPConfigRemoveResult MCPConfigRemoveResult `json:\"McpConfigRemoveResult\"`\n\tMCPConfigUpdateRequest MCPConfigUpdateRequest `json:\"McpConfigUpdateRequest\"`\n\tMCPConfigUpdateResult MCPConfigUpdateResult `json:\"McpConfigUpdateResult\"`\n\tMCPDisableRequest MCPDisableRequest `json:\"McpDisableRequest\"`\n\tMCPDisableResult MCPDisableResult `json:\"McpDisableResult\"`\n\tMCPDiscoverRequest MCPDiscoverRequest `json:\"McpDiscoverRequest\"`\n\tMCPDiscoverResult MCPDiscoverResult `json:\"McpDiscoverResult\"`\n\tMCPEnableRequest MCPEnableRequest `json:\"McpEnableRequest\"`\n\tMCPEnableResult MCPEnableResult `json:\"McpEnableResult\"`\n\tMCPOauthLoginRequest MCPOauthLoginRequest `json:\"McpOauthLoginRequest\"`\n\tMCPOauthLoginResult MCPOauthLoginResult `json:\"McpOauthLoginResult\"`\n\tMCPReloadResult MCPReloadResult `json:\"McpReloadResult\"`\n\tMCPServer MCPServer `json:\"McpServer\"`\n\tMCPServerConfig MCPServerConfig `json:\"McpServerConfig\"`\n\tMCPServerConfigHTTP MCPServerConfigHTTP `json:\"McpServerConfigHttp\"`\n\tMCPServerConfigHTTPOauthGrantType MCPServerConfigHTTPOauthGrantType `json:\"McpServerConfigHttpOauthGrantType\"`\n\tMCPServerConfigHTTPType MCPServerConfigHTTPType `json:\"McpServerConfigHttpType\"`\n\tMCPServerConfigLocal MCPServerConfigLocal `json:\"McpServerConfigLocal\"`\n\tMCPServerConfigLocalType MCPServerConfigLocalType `json:\"McpServerConfigLocalType\"`\n\tMCPServerList MCPServerList `json:\"McpServerList\"`\n\tMCPServerSource MCPServerSource `json:\"McpServerSource\"`\n\tMCPServerStatus MCPServerStatus `json:\"McpServerStatus\"`\n\tModel ModelElement `json:\"Model\"`\n\tModelBilling ModelBilling `json:\"ModelBilling\"`\n\tModelCapabilities ModelCapabilities `json:\"ModelCapabilities\"`\n\tModelCapabilitiesLimits ModelCapabilitiesLimits `json:\"ModelCapabilitiesLimits\"`\n\tModelCapabilitiesLimitsVision ModelCapabilitiesLimitsVision `json:\"ModelCapabilitiesLimitsVision\"`\n\tModelCapabilitiesOverride ModelCapabilitiesOverride `json:\"ModelCapabilitiesOverride\"`\n\tModelCapabilitiesOverrideLimits ModelCapabilitiesOverrideLimits `json:\"ModelCapabilitiesOverrideLimits\"`\n\tModelCapabilitiesOverrideLimitsVision ModelCapabilitiesOverrideLimitsVision `json:\"ModelCapabilitiesOverrideLimitsVision\"`\n\tModelCapabilitiesOverrideSupports ModelCapabilitiesOverrideSupports `json:\"ModelCapabilitiesOverrideSupports\"`\n\tModelCapabilitiesSupports ModelCapabilitiesSupports `json:\"ModelCapabilitiesSupports\"`\n\tModelList ModelList `json:\"ModelList\"`\n\tModelPolicy ModelPolicy `json:\"ModelPolicy\"`\n\tModelsListRequest ModelsListRequest `json:\"ModelsListRequest\"`\n\tModelSwitchToRequest ModelSwitchToRequest `json:\"ModelSwitchToRequest\"`\n\tModelSwitchToResult ModelSwitchToResult `json:\"ModelSwitchToResult\"`\n\tModeSetRequest ModeSetRequest `json:\"ModeSetRequest\"`\n\tModeSetResult ModeSetResult `json:\"ModeSetResult\"`\n\tNameGetResult NameGetResult `json:\"NameGetResult\"`\n\tNameSetRequest NameSetRequest `json:\"NameSetRequest\"`\n\tNameSetResult NameSetResult `json:\"NameSetResult\"`\n\tPermissionDecision PermissionDecision `json:\"PermissionDecision\"`\n\tPermissionDecisionApproveForLocation PermissionDecisionApproveForLocation `json:\"PermissionDecisionApproveForLocation\"`\n\tPermissionDecisionApproveForLocationApproval PermissionDecisionApproveForLocationApproval `json:\"PermissionDecisionApproveForLocationApproval\"`\n\tPermissionDecisionApproveForLocationApprovalCommands PermissionDecisionApproveForLocationApprovalCommands `json:\"PermissionDecisionApproveForLocationApprovalCommands\"`\n\tPermissionDecisionApproveForLocationApprovalCustomTool PermissionDecisionApproveForLocationApprovalCustomTool `json:\"PermissionDecisionApproveForLocationApprovalCustomTool\"`\n\tPermissionDecisionApproveForLocationApprovalMCP PermissionDecisionApproveForLocationApprovalMCP `json:\"PermissionDecisionApproveForLocationApprovalMcp\"`\n\tPermissionDecisionApproveForLocationApprovalMCPSampling PermissionDecisionApproveForLocationApprovalMCPSampling `json:\"PermissionDecisionApproveForLocationApprovalMcpSampling\"`\n\tPermissionDecisionApproveForLocationApprovalMemory PermissionDecisionApproveForLocationApprovalMemory `json:\"PermissionDecisionApproveForLocationApprovalMemory\"`\n\tPermissionDecisionApproveForLocationApprovalRead PermissionDecisionApproveForLocationApprovalRead `json:\"PermissionDecisionApproveForLocationApprovalRead\"`\n\tPermissionDecisionApproveForLocationApprovalWrite PermissionDecisionApproveForLocationApprovalWrite `json:\"PermissionDecisionApproveForLocationApprovalWrite\"`\n\tPermissionDecisionApproveForSession PermissionDecisionApproveForSession `json:\"PermissionDecisionApproveForSession\"`\n\tPermissionDecisionApproveForSessionApproval PermissionDecisionApproveForSessionApproval `json:\"PermissionDecisionApproveForSessionApproval\"`\n\tPermissionDecisionApproveForSessionApprovalCommands PermissionDecisionApproveForSessionApprovalCommands `json:\"PermissionDecisionApproveForSessionApprovalCommands\"`\n\tPermissionDecisionApproveForSessionApprovalCustomTool PermissionDecisionApproveForSessionApprovalCustomTool `json:\"PermissionDecisionApproveForSessionApprovalCustomTool\"`\n\tPermissionDecisionApproveForSessionApprovalMCP PermissionDecisionApproveForSessionApprovalMCP `json:\"PermissionDecisionApproveForSessionApprovalMcp\"`\n\tPermissionDecisionApproveForSessionApprovalMCPSampling PermissionDecisionApproveForSessionApprovalMCPSampling `json:\"PermissionDecisionApproveForSessionApprovalMcpSampling\"`\n\tPermissionDecisionApproveForSessionApprovalMemory PermissionDecisionApproveForSessionApprovalMemory `json:\"PermissionDecisionApproveForSessionApprovalMemory\"`\n\tPermissionDecisionApproveForSessionApprovalRead PermissionDecisionApproveForSessionApprovalRead `json:\"PermissionDecisionApproveForSessionApprovalRead\"`\n\tPermissionDecisionApproveForSessionApprovalWrite PermissionDecisionApproveForSessionApprovalWrite `json:\"PermissionDecisionApproveForSessionApprovalWrite\"`\n\tPermissionDecisionApproveOnce PermissionDecisionApproveOnce `json:\"PermissionDecisionApproveOnce\"`\n\tPermissionDecisionApprovePermanently PermissionDecisionApprovePermanently `json:\"PermissionDecisionApprovePermanently\"`\n\tPermissionDecisionReject PermissionDecisionReject `json:\"PermissionDecisionReject\"`\n\tPermissionDecisionRequest PermissionDecisionRequest `json:\"PermissionDecisionRequest\"`\n\tPermissionDecisionUserNotAvailable PermissionDecisionUserNotAvailable `json:\"PermissionDecisionUserNotAvailable\"`\n\tPermissionRequestResult PermissionRequestResult `json:\"PermissionRequestResult\"`\n\tPermissionsResetSessionApprovalsRequest PermissionsResetSessionApprovalsRequest `json:\"PermissionsResetSessionApprovalsRequest\"`\n\tPermissionsResetSessionApprovalsResult PermissionsResetSessionApprovalsResult `json:\"PermissionsResetSessionApprovalsResult\"`\n\tPermissionsSetApproveAllRequest PermissionsSetApproveAllRequest `json:\"PermissionsSetApproveAllRequest\"`\n\tPermissionsSetApproveAllResult PermissionsSetApproveAllResult `json:\"PermissionsSetApproveAllResult\"`\n\tPingRequest PingRequest `json:\"PingRequest\"`\n\tPingResult PingResult `json:\"PingResult\"`\n\tPlanDeleteResult PlanDeleteResult `json:\"PlanDeleteResult\"`\n\tPlanReadResult PlanReadResult `json:\"PlanReadResult\"`\n\tPlanUpdateRequest PlanUpdateRequest `json:\"PlanUpdateRequest\"`\n\tPlanUpdateResult PlanUpdateResult `json:\"PlanUpdateResult\"`\n\tPlugin PluginElement `json:\"Plugin\"`\n\tPluginList PluginList `json:\"PluginList\"`\n\tServerSkill ServerSkill `json:\"ServerSkill\"`\n\tServerSkillList ServerSkillList `json:\"ServerSkillList\"`\n\tSessionAuthStatus SessionAuthStatus `json:\"SessionAuthStatus\"`\n\tSessionFSAppendFileRequest SessionFSAppendFileRequest `json:\"SessionFsAppendFileRequest\"`\n\tSessionFSError SessionFSError `json:\"SessionFsError\"`\n\tSessionFSErrorCode SessionFSErrorCode `json:\"SessionFsErrorCode\"`\n\tSessionFSExistsRequest SessionFSExistsRequest `json:\"SessionFsExistsRequest\"`\n\tSessionFSExistsResult SessionFSExistsResult `json:\"SessionFsExistsResult\"`\n\tSessionFSMkdirRequest SessionFSMkdirRequest `json:\"SessionFsMkdirRequest\"`\n\tSessionFSReaddirRequest SessionFSReaddirRequest `json:\"SessionFsReaddirRequest\"`\n\tSessionFSReaddirResult SessionFSReaddirResult `json:\"SessionFsReaddirResult\"`\n\tSessionFSReaddirWithTypesEntry SessionFSReaddirWithTypesEntry `json:\"SessionFsReaddirWithTypesEntry\"`\n\tSessionFSReaddirWithTypesEntryType SessionFSReaddirWithTypesEntryType `json:\"SessionFsReaddirWithTypesEntryType\"`\n\tSessionFSReaddirWithTypesRequest SessionFSReaddirWithTypesRequest `json:\"SessionFsReaddirWithTypesRequest\"`\n\tSessionFSReaddirWithTypesResult SessionFSReaddirWithTypesResult `json:\"SessionFsReaddirWithTypesResult\"`\n\tSessionFSReadFileRequest SessionFSReadFileRequest `json:\"SessionFsReadFileRequest\"`\n\tSessionFSReadFileResult SessionFSReadFileResult `json:\"SessionFsReadFileResult\"`\n\tSessionFSRenameRequest SessionFSRenameRequest `json:\"SessionFsRenameRequest\"`\n\tSessionFSRmRequest SessionFSRmRequest `json:\"SessionFsRmRequest\"`\n\tSessionFSSetProviderConventions SessionFSSetProviderConventions `json:\"SessionFsSetProviderConventions\"`\n\tSessionFSSetProviderRequest SessionFSSetProviderRequest `json:\"SessionFsSetProviderRequest\"`\n\tSessionFSSetProviderResult SessionFSSetProviderResult `json:\"SessionFsSetProviderResult\"`\n\tSessionFSStatRequest SessionFSStatRequest `json:\"SessionFsStatRequest\"`\n\tSessionFSStatResult SessionFSStatResult `json:\"SessionFsStatResult\"`\n\tSessionFSWriteFileRequest SessionFSWriteFileRequest `json:\"SessionFsWriteFileRequest\"`\n\tSessionLogLevel SessionLogLevel `json:\"SessionLogLevel\"`\n\tSessionMode SessionMode `json:\"SessionMode\"`\n\tSessionsForkRequest SessionsForkRequest `json:\"SessionsForkRequest\"`\n\tSessionsForkResult SessionsForkResult `json:\"SessionsForkResult\"`\n\tShellExecRequest ShellExecRequest `json:\"ShellExecRequest\"`\n\tShellExecResult ShellExecResult `json:\"ShellExecResult\"`\n\tShellKillRequest ShellKillRequest `json:\"ShellKillRequest\"`\n\tShellKillResult ShellKillResult `json:\"ShellKillResult\"`\n\tShellKillSignal ShellKillSignal `json:\"ShellKillSignal\"`\n\tSkill Skill `json:\"Skill\"`\n\tSkillList SkillList `json:\"SkillList\"`\n\tSkillsConfigSetDisabledSkillsRequest SkillsConfigSetDisabledSkillsRequest `json:\"SkillsConfigSetDisabledSkillsRequest\"`\n\tSkillsConfigSetDisabledSkillsResult SkillsConfigSetDisabledSkillsResult `json:\"SkillsConfigSetDisabledSkillsResult\"`\n\tSkillsDisableRequest SkillsDisableRequest `json:\"SkillsDisableRequest\"`\n\tSkillsDisableResult SkillsDisableResult `json:\"SkillsDisableResult\"`\n\tSkillsDiscoverRequest SkillsDiscoverRequest `json:\"SkillsDiscoverRequest\"`\n\tSkillsEnableRequest SkillsEnableRequest `json:\"SkillsEnableRequest\"`\n\tSkillsEnableResult SkillsEnableResult `json:\"SkillsEnableResult\"`\n\tSkillsReloadResult SkillsReloadResult `json:\"SkillsReloadResult\"`\n\tSuspendResult SuspendResult `json:\"SuspendResult\"`\n\tTaskAgentInfo TaskAgentInfo `json:\"TaskAgentInfo\"`\n\tTaskAgentInfoExecutionMode TaskInfoExecutionMode `json:\"TaskAgentInfoExecutionMode\"`\n\tTaskAgentInfoStatus TaskInfoStatus `json:\"TaskAgentInfoStatus\"`\n\tTaskInfo TaskInfo `json:\"TaskInfo\"`\n\tTaskList TaskList `json:\"TaskList\"`\n\tTasksCancelRequest TasksCancelRequest `json:\"TasksCancelRequest\"`\n\tTasksCancelResult TasksCancelResult `json:\"TasksCancelResult\"`\n\tTaskShellInfo TaskShellInfo `json:\"TaskShellInfo\"`\n\tTaskShellInfoAttachmentMode TaskShellInfoAttachmentMode `json:\"TaskShellInfoAttachmentMode\"`\n\tTaskShellInfoExecutionMode TaskInfoExecutionMode `json:\"TaskShellInfoExecutionMode\"`\n\tTaskShellInfoStatus TaskInfoStatus `json:\"TaskShellInfoStatus\"`\n\tTasksPromoteToBackgroundRequest TasksPromoteToBackgroundRequest `json:\"TasksPromoteToBackgroundRequest\"`\n\tTasksPromoteToBackgroundResult TasksPromoteToBackgroundResult `json:\"TasksPromoteToBackgroundResult\"`\n\tTasksRemoveRequest TasksRemoveRequest `json:\"TasksRemoveRequest\"`\n\tTasksRemoveResult TasksRemoveResult `json:\"TasksRemoveResult\"`\n\tTasksStartAgentRequest TasksStartAgentRequest `json:\"TasksStartAgentRequest\"`\n\tTasksStartAgentResult TasksStartAgentResult `json:\"TasksStartAgentResult\"`\n\tTool Tool `json:\"Tool\"`\n\tToolList ToolList `json:\"ToolList\"`\n\tToolsListRequest ToolsListRequest `json:\"ToolsListRequest\"`\n\tUIElicitationArrayAnyOfField UIElicitationArrayAnyOfField `json:\"UIElicitationArrayAnyOfField\"`\n\tUIElicitationArrayAnyOfFieldItems UIElicitationArrayAnyOfFieldItems `json:\"UIElicitationArrayAnyOfFieldItems\"`\n\tUIElicitationArrayAnyOfFieldItemsAnyOf UIElicitationArrayAnyOfFieldItemsAnyOf `json:\"UIElicitationArrayAnyOfFieldItemsAnyOf\"`\n\tUIElicitationArrayEnumField UIElicitationArrayEnumField `json:\"UIElicitationArrayEnumField\"`\n\tUIElicitationArrayEnumFieldItems UIElicitationArrayEnumFieldItems `json:\"UIElicitationArrayEnumFieldItems\"`\n\tUIElicitationFieldValue *UIElicitationFieldValue `json:\"UIElicitationFieldValue\"`\n\tUIElicitationRequest UIElicitationRequest `json:\"UIElicitationRequest\"`\n\tUIElicitationResponse UIElicitationResponse `json:\"UIElicitationResponse\"`\n\tUIElicitationResponseAction UIElicitationResponseAction `json:\"UIElicitationResponseAction\"`\n\tUIElicitationResponseContent map[string]*UIElicitationFieldValue `json:\"UIElicitationResponseContent\"`\n\tUIElicitationResult UIElicitationResult `json:\"UIElicitationResult\"`\n\tUIElicitationSchema UIElicitationSchema `json:\"UIElicitationSchema\"`\n\tUIElicitationSchemaProperty UIElicitationSchemaProperty `json:\"UIElicitationSchemaProperty\"`\n\tUIElicitationSchemaPropertyBoolean UIElicitationSchemaPropertyBoolean `json:\"UIElicitationSchemaPropertyBoolean\"`\n\tUIElicitationSchemaPropertyNumber UIElicitationSchemaPropertyNumber `json:\"UIElicitationSchemaPropertyNumber\"`\n\tUIElicitationSchemaPropertyNumberType UIElicitationSchemaPropertyNumberTypeEnum `json:\"UIElicitationSchemaPropertyNumberType\"`\n\tUIElicitationSchemaPropertyString UIElicitationSchemaPropertyString `json:\"UIElicitationSchemaPropertyString\"`\n\tUIElicitationSchemaPropertyStringFormat UIElicitationSchemaPropertyStringFormat `json:\"UIElicitationSchemaPropertyStringFormat\"`\n\tUIElicitationStringEnumField UIElicitationStringEnumField `json:\"UIElicitationStringEnumField\"`\n\tUIElicitationStringOneOfField UIElicitationStringOneOfField `json:\"UIElicitationStringOneOfField\"`\n\tUIElicitationStringOneOfFieldOneOf UIElicitationStringOneOfFieldOneOf `json:\"UIElicitationStringOneOfFieldOneOf\"`\n\tUIHandlePendingElicitationRequest UIHandlePendingElicitationRequest `json:\"UIHandlePendingElicitationRequest\"`\n\tUsageGetMetricsResult UsageGetMetricsResult `json:\"UsageGetMetricsResult\"`\n\tUsageMetricsCodeChanges UsageMetricsCodeChanges `json:\"UsageMetricsCodeChanges\"`\n\tUsageMetricsModelMetric UsageMetricsModelMetric `json:\"UsageMetricsModelMetric\"`\n\tUsageMetricsModelMetricRequests UsageMetricsModelMetricRequests `json:\"UsageMetricsModelMetricRequests\"`\n\tUsageMetricsModelMetricTokenDetail UsageMetricsModelMetricTokenDetail `json:\"UsageMetricsModelMetricTokenDetail\"`\n\tUsageMetricsModelMetricUsage UsageMetricsModelMetricUsage `json:\"UsageMetricsModelMetricUsage\"`\n\tUsageMetricsTokenDetail UsageMetricsTokenDetail `json:\"UsageMetricsTokenDetail\"`\n\tWorkspacesCreateFileRequest WorkspacesCreateFileRequest `json:\"WorkspacesCreateFileRequest\"`\n\tWorkspacesCreateFileResult WorkspacesCreateFileResult `json:\"WorkspacesCreateFileResult\"`\n\tWorkspacesGetWorkspaceResult WorkspacesGetWorkspaceResult `json:\"WorkspacesGetWorkspaceResult\"`\n\tWorkspacesListFilesResult WorkspacesListFilesResult `json:\"WorkspacesListFilesResult\"`\n\tWorkspacesReadFileRequest WorkspacesReadFileRequest `json:\"WorkspacesReadFileRequest\"`\n\tWorkspacesReadFileResult WorkspacesReadFileResult `json:\"WorkspacesReadFileResult\"`\n}\n\ntype AccountGetQuotaRequest struct {\n\t// GitHub token for per-user quota lookup. When provided, resolves this token to determine\n\t// the user's quota instead of using the global auth.\n\tGitHubToken *string `json:\"gitHubToken,omitempty\"`\n}\n\ntype AccountGetQuotaResult struct {\n\t// Quota snapshots keyed by type (e.g., chat, completions, premium_interactions)\n\tQuotaSnapshots map[string]AccountQuotaSnapshot `json:\"quotaSnapshots\"`\n}\n\ntype AccountQuotaSnapshot struct {\n\t// Number of requests included in the entitlement\n\tEntitlementRequests int64 `json:\"entitlementRequests\"`\n\t// Whether the user has an unlimited usage entitlement\n\tIsUnlimitedEntitlement bool `json:\"isUnlimitedEntitlement\"`\n\t// Number of overage requests made this period\n\tOverage float64 `json:\"overage\"`\n\t// Whether overage is allowed when quota is exhausted\n\tOverageAllowedWithExhaustedQuota bool `json:\"overageAllowedWithExhaustedQuota\"`\n\t// Percentage of entitlement remaining\n\tRemainingPercentage float64 `json:\"remainingPercentage\"`\n\t// Date when the quota resets (ISO 8601 string)\n\tResetDate *string `json:\"resetDate,omitempty\"`\n\t// Whether usage is still permitted after quota exhaustion\n\tUsageAllowedWithExhaustedQuota bool `json:\"usageAllowedWithExhaustedQuota\"`\n\t// Number of requests used so far this period\n\tUsedRequests int64 `json:\"usedRequests\"`\n}\n\n// Experimental: AgentDeselectResult is part of an experimental API and may change or be removed.\ntype AgentDeselectResult struct {\n}\n\n// Experimental: AgentGetCurrentResult is part of an experimental API and may change or be removed.\ntype AgentGetCurrentResult struct {\n\t// Currently selected custom agent, or null if using the default agent\n\tAgent *AgentInfo `json:\"agent,omitempty\"`\n}\n\n// The newly selected custom agent\ntype AgentInfo struct {\n\t// Description of the agent's purpose\n\tDescription string `json:\"description\"`\n\t// Human-readable display name\n\tDisplayName string `json:\"displayName\"`\n\t// Unique identifier of the custom agent\n\tName string `json:\"name\"`\n\t// Absolute local file path of the agent definition. Only set for file-based agents loaded\n\t// from disk; remote agents do not have a path.\n\tPath *string `json:\"path,omitempty\"`\n}\n\n// Experimental: AgentList is part of an experimental API and may change or be removed.\ntype AgentList struct {\n\t// Available custom agents\n\tAgents []AgentInfo `json:\"agents\"`\n}\n\n// Experimental: AgentReloadResult is part of an experimental API and may change or be removed.\ntype AgentReloadResult struct {\n\t// Reloaded custom agents\n\tAgents []AgentInfo `json:\"agents\"`\n}\n\n// Experimental: AgentSelectRequest is part of an experimental API and may change or be removed.\ntype AgentSelectRequest struct {\n\t// Name of the custom agent to select\n\tName string `json:\"name\"`\n}\n\n// Experimental: AgentSelectResult is part of an experimental API and may change or be removed.\ntype AgentSelectResult struct {\n\t// The newly selected custom agent\n\tAgent AgentInfo `json:\"agent\"`\n}\n\ntype CommandsHandlePendingCommandRequest struct {\n\t// Error message if the command handler failed\n\tError *string `json:\"error,omitempty\"`\n\t// Request ID from the command invocation event\n\tRequestID string `json:\"requestId\"`\n}\n\ntype CommandsHandlePendingCommandResult struct {\n\t// Whether the command was handled successfully\n\tSuccess bool `json:\"success\"`\n}\n\ntype CurrentModel struct {\n\t// Currently active model identifier\n\tModelID *string `json:\"modelId,omitempty\"`\n}\n\ntype DiscoveredMCPServer struct {\n\t// Whether the server is enabled (not in the disabled list)\n\tEnabled bool `json:\"enabled\"`\n\t// Server name (config key)\n\tName string `json:\"name\"`\n\t// Configuration source\n\tSource MCPServerSource `json:\"source\"`\n\t// Server transport type: stdio, http, sse, or memory (local configs are normalized to stdio)\n\tType *DiscoveredMCPServerType `json:\"type,omitempty\"`\n}\n\ntype EmbeddedBlobResourceContents struct {\n\t// Base64-encoded binary content of the resource\n\tBlob string `json:\"blob\"`\n\t// MIME type of the blob content\n\tMIMEType *string `json:\"mimeType,omitempty\"`\n\t// URI identifying the resource\n\tURI string `json:\"uri\"`\n}\n\ntype EmbeddedTextResourceContents struct {\n\t// MIME type of the text content\n\tMIMEType *string `json:\"mimeType,omitempty\"`\n\t// Text content of the resource\n\tText string `json:\"text\"`\n\t// URI identifying the resource\n\tURI string `json:\"uri\"`\n}\n\ntype Extension struct {\n\t// Source-qualified ID (e.g., 'project:my-ext', 'user:auth-helper')\n\tID string `json:\"id\"`\n\t// Extension name (directory name)\n\tName string `json:\"name\"`\n\t// Process ID if the extension is running\n\tPID *int64 `json:\"pid,omitempty\"`\n\t// Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/)\n\tSource ExtensionSource `json:\"source\"`\n\t// Current status: running, disabled, failed, or starting\n\tStatus ExtensionStatus `json:\"status\"`\n}\n\n// Experimental: ExtensionList is part of an experimental API and may change or be removed.\ntype ExtensionList struct {\n\t// Discovered extensions and their current status\n\tExtensions []Extension `json:\"extensions\"`\n}\n\n// Experimental: ExtensionsDisableRequest is part of an experimental API and may change or be removed.\ntype ExtensionsDisableRequest struct {\n\t// Source-qualified extension ID to disable\n\tID string `json:\"id\"`\n}\n\n// Experimental: ExtensionsDisableResult is part of an experimental API and may change or be removed.\ntype ExtensionsDisableResult struct {\n}\n\n// Experimental: ExtensionsEnableRequest is part of an experimental API and may change or be removed.\ntype ExtensionsEnableRequest struct {\n\t// Source-qualified extension ID to enable\n\tID string `json:\"id\"`\n}\n\n// Experimental: ExtensionsEnableResult is part of an experimental API and may change or be removed.\ntype ExtensionsEnableResult struct {\n}\n\n// Experimental: ExtensionsReloadResult is part of an experimental API and may change or be removed.\ntype ExtensionsReloadResult struct {\n}\n\n// Expanded external tool result payload\ntype ExternalToolTextResultForLlm struct {\n\t// Structured content blocks from the tool\n\tContents []ExternalToolTextResultForLlmContent `json:\"contents,omitempty\"`\n\t// Optional error message for failed executions\n\tError *string `json:\"error,omitempty\"`\n\t// Execution outcome classification. Optional for back-compat; normalized to 'success' (or\n\t// 'failure' when error is present) when missing or unrecognized.\n\tResultType *string `json:\"resultType,omitempty\"`\n\t// Detailed log content for timeline display\n\tSessionLog *string `json:\"sessionLog,omitempty\"`\n\t// Text result returned to the model\n\tTextResultForLlm string `json:\"textResultForLlm\"`\n\t// Optional tool-specific telemetry\n\tToolTelemetry map[string]any `json:\"toolTelemetry,omitempty\"`\n}\n\n// A content block within a tool result, which may be text, terminal output, image, audio,\n// or a resource\n//\n// # Plain text content block\n//\n// Terminal/shell output content block with optional exit code and working directory\n//\n// # Image content block with base64-encoded data\n//\n// # Audio content block with base64-encoded data\n//\n// # Resource link content block referencing an external resource\n//\n// Embedded resource content block with inline text or binary data\ntype ExternalToolTextResultForLlmContent struct {\n\t// The text content\n\t//\n\t// Terminal/shell output text\n\tText *string `json:\"text,omitempty\"`\n\t// Content block type discriminator\n\tType ExternalToolTextResultForLlmContentType `json:\"type\"`\n\t// Working directory where the command was executed\n\tCwd *string `json:\"cwd,omitempty\"`\n\t// Process exit code, if the command has completed\n\tExitCode *float64 `json:\"exitCode,omitempty\"`\n\t// Base64-encoded image data\n\t//\n\t// Base64-encoded audio data\n\tData *string `json:\"data,omitempty\"`\n\t// MIME type of the image (e.g., image/png, image/jpeg)\n\t//\n\t// MIME type of the audio (e.g., audio/wav, audio/mpeg)\n\t//\n\t// MIME type of the resource content\n\tMIMEType *string `json:\"mimeType,omitempty\"`\n\t// Human-readable description of the resource\n\tDescription *string `json:\"description,omitempty\"`\n\t// Icons associated with this resource\n\tIcons []ExternalToolTextResultForLlmContentResourceLinkIcon `json:\"icons,omitempty\"`\n\t// Resource name identifier\n\tName *string `json:\"name,omitempty\"`\n\t// Size of the resource in bytes\n\tSize *float64 `json:\"size,omitempty\"`\n\t// Human-readable display title for the resource\n\tTitle *string `json:\"title,omitempty\"`\n\t// URI identifying the resource\n\tURI *string `json:\"uri,omitempty\"`\n\t// The embedded resource contents, either text or base64-encoded binary\n\tResource *ExternalToolTextResultForLlmContentResourceDetails `json:\"resource,omitempty\"`\n}\n\n// Icon image for a resource\ntype ExternalToolTextResultForLlmContentResourceLinkIcon struct {\n\t// MIME type of the icon image\n\tMIMEType *string `json:\"mimeType,omitempty\"`\n\t// Available icon sizes (e.g., ['16x16', '32x32'])\n\tSizes []string `json:\"sizes,omitempty\"`\n\t// URL or path to the icon image\n\tSrc string `json:\"src\"`\n\t// Theme variant this icon is intended for\n\tTheme *ExternalToolTextResultForLlmContentResourceLinkIconTheme `json:\"theme,omitempty\"`\n}\n\n// The embedded resource contents, either text or base64-encoded binary\ntype ExternalToolTextResultForLlmContentResourceDetails struct {\n\t// MIME type of the text content\n\t//\n\t// MIME type of the blob content\n\tMIMEType *string `json:\"mimeType,omitempty\"`\n\t// Text content of the resource\n\tText *string `json:\"text,omitempty\"`\n\t// URI identifying the resource\n\tURI string `json:\"uri\"`\n\t// Base64-encoded binary content of the resource\n\tBlob *string `json:\"blob,omitempty\"`\n}\n\n// Audio content block with base64-encoded data\ntype ExternalToolTextResultForLlmContentAudio struct {\n\t// Base64-encoded audio data\n\tData string `json:\"data\"`\n\t// MIME type of the audio (e.g., audio/wav, audio/mpeg)\n\tMIMEType string `json:\"mimeType\"`\n\t// Content block type discriminator\n\tType ExternalToolTextResultForLlmContentAudioType `json:\"type\"`\n}\n\n// Image content block with base64-encoded data\ntype ExternalToolTextResultForLlmContentImage struct {\n\t// Base64-encoded image data\n\tData string `json:\"data\"`\n\t// MIME type of the image (e.g., image/png, image/jpeg)\n\tMIMEType string `json:\"mimeType\"`\n\t// Content block type discriminator\n\tType ExternalToolTextResultForLlmContentImageType `json:\"type\"`\n}\n\n// Embedded resource content block with inline text or binary data\ntype ExternalToolTextResultForLlmContentResource struct {\n\t// The embedded resource contents, either text or base64-encoded binary\n\tResource ExternalToolTextResultForLlmContentResourceDetails `json:\"resource\"`\n\t// Content block type discriminator\n\tType ExternalToolTextResultForLlmContentResourceType `json:\"type\"`\n}\n\n// Resource link content block referencing an external resource\ntype ExternalToolTextResultForLlmContentResourceLink struct {\n\t// Human-readable description of the resource\n\tDescription *string `json:\"description,omitempty\"`\n\t// Icons associated with this resource\n\tIcons []ExternalToolTextResultForLlmContentResourceLinkIcon `json:\"icons,omitempty\"`\n\t// MIME type of the resource content\n\tMIMEType *string `json:\"mimeType,omitempty\"`\n\t// Resource name identifier\n\tName string `json:\"name\"`\n\t// Size of the resource in bytes\n\tSize *float64 `json:\"size,omitempty\"`\n\t// Human-readable display title for the resource\n\tTitle *string `json:\"title,omitempty\"`\n\t// Content block type discriminator\n\tType ExternalToolTextResultForLlmContentResourceLinkType `json:\"type\"`\n\t// URI identifying the resource\n\tURI string `json:\"uri\"`\n}\n\n// Terminal/shell output content block with optional exit code and working directory\ntype ExternalToolTextResultForLlmContentTerminal struct {\n\t// Working directory where the command was executed\n\tCwd *string `json:\"cwd,omitempty\"`\n\t// Process exit code, if the command has completed\n\tExitCode *float64 `json:\"exitCode,omitempty\"`\n\t// Terminal/shell output text\n\tText string `json:\"text\"`\n\t// Content block type discriminator\n\tType ExternalToolTextResultForLlmContentTerminalType `json:\"type\"`\n}\n\n// Plain text content block\ntype ExternalToolTextResultForLlmContentText struct {\n\t// The text content\n\tText string `json:\"text\"`\n\t// Content block type discriminator\n\tType ExternalToolTextResultForLlmContentTextType `json:\"type\"`\n}\n\n// Experimental: FleetStartRequest is part of an experimental API and may change or be removed.\ntype FleetStartRequest struct {\n\t// Optional user prompt to combine with fleet instructions\n\tPrompt *string `json:\"prompt,omitempty\"`\n}\n\n// Experimental: FleetStartResult is part of an experimental API and may change or be removed.\ntype FleetStartResult struct {\n\t// Whether fleet mode was successfully activated\n\tStarted bool `json:\"started\"`\n}\n\ntype HandlePendingToolCallRequest struct {\n\t// Error message if the tool call failed\n\tError *string `json:\"error,omitempty\"`\n\t// Request ID of the pending tool call\n\tRequestID string `json:\"requestId\"`\n\t// Tool call result (string or expanded result object)\n\tResult *ExternalToolResult `json:\"result,omitempty\"`\n}\n\ntype HandlePendingToolCallResult struct {\n\t// Whether the tool call result was handled successfully\n\tSuccess bool `json:\"success\"`\n}\n\n// Post-compaction context window usage breakdown\ntype HistoryCompactContextWindow struct {\n\t// Token count from non-system messages (user, assistant, tool)\n\tConversationTokens *int64 `json:\"conversationTokens,omitempty\"`\n\t// Current total tokens in the context window (system + conversation + tool definitions)\n\tCurrentTokens int64 `json:\"currentTokens\"`\n\t// Current number of messages in the conversation\n\tMessagesLength int64 `json:\"messagesLength\"`\n\t// Token count from system message(s)\n\tSystemTokens *int64 `json:\"systemTokens,omitempty\"`\n\t// Maximum token count for the model's context window\n\tTokenLimit int64 `json:\"tokenLimit\"`\n\t// Token count from tool definitions\n\tToolDefinitionsTokens *int64 `json:\"toolDefinitionsTokens,omitempty\"`\n}\n\n// Experimental: HistoryCompactResult is part of an experimental API and may change or be removed.\ntype HistoryCompactResult struct {\n\t// Post-compaction context window usage breakdown\n\tContextWindow *HistoryCompactContextWindow `json:\"contextWindow,omitempty\"`\n\t// Number of messages removed during compaction\n\tMessagesRemoved int64 `json:\"messagesRemoved\"`\n\t// Whether compaction completed successfully\n\tSuccess bool `json:\"success\"`\n\t// Number of tokens freed by compaction\n\tTokensRemoved int64 `json:\"tokensRemoved\"`\n}\n\n// Experimental: HistoryTruncateRequest is part of an experimental API and may change or be removed.\ntype HistoryTruncateRequest struct {\n\t// Event ID to truncate to. This event and all events after it are removed from the session.\n\tEventID string `json:\"eventId\"`\n}\n\n// Experimental: HistoryTruncateResult is part of an experimental API and may change or be removed.\ntype HistoryTruncateResult struct {\n\t// Number of events that were removed\n\tEventsRemoved int64 `json:\"eventsRemoved\"`\n}\n\ntype InstructionsGetSourcesResult struct {\n\t// Instruction sources for the session\n\tSources []InstructionsSources `json:\"sources\"`\n}\n\ntype InstructionsSources struct {\n\t// Glob pattern from frontmatter — when set, this instruction applies only to matching files\n\tApplyTo *string `json:\"applyTo,omitempty\"`\n\t// Raw content of the instruction file\n\tContent string `json:\"content\"`\n\t// Short description (body after frontmatter) for use in instruction tables\n\tDescription *string `json:\"description,omitempty\"`\n\t// Unique identifier for this source (used for toggling)\n\tID string `json:\"id\"`\n\t// Human-readable label\n\tLabel string `json:\"label\"`\n\t// Where this source lives — used for UI grouping\n\tLocation InstructionsSourcesLocation `json:\"location\"`\n\t// File path relative to repo or absolute for home\n\tSourcePath string `json:\"sourcePath\"`\n\t// Category of instruction source — used for merge logic\n\tType InstructionsSourcesType `json:\"type\"`\n}\n\ntype LogRequest struct {\n\t// When true, the message is transient and not persisted to the session event log on disk\n\tEphemeral *bool `json:\"ephemeral,omitempty\"`\n\t// Log severity level. Determines how the message is displayed in the timeline. Defaults to\n\t// \"info\".\n\tLevel *SessionLogLevel `json:\"level,omitempty\"`\n\t// Human-readable message\n\tMessage string `json:\"message\"`\n\t// Optional URL the user can open in their browser for more details\n\tURL *string `json:\"url,omitempty\"`\n}\n\ntype LogResult struct {\n\t// The unique identifier of the emitted session event\n\tEventID string `json:\"eventId\"`\n}\n\ntype MCPConfigAddRequest struct {\n\t// MCP server configuration (local/stdio or remote/http)\n\tConfig MCPServerConfig `json:\"config\"`\n\t// Unique name for the MCP server\n\tName string `json:\"name\"`\n}\n\n// MCP server configuration (local/stdio or remote/http)\ntype MCPServerConfig struct {\n\tArgs []string `json:\"args,omitempty\"`\n\tCommand *string `json:\"command,omitempty\"`\n\tCwd *string `json:\"cwd,omitempty\"`\n\tEnv map[string]string `json:\"env,omitempty\"`\n\tFilterMapping *FilterMapping `json:\"filterMapping,omitempty\"`\n\tIsDefaultServer *bool `json:\"isDefaultServer,omitempty\"`\n\t// Timeout in milliseconds for tool calls to this server.\n\tTimeout *int64 `json:\"timeout,omitempty\"`\n\t// Tools to include. Defaults to all tools if not specified.\n\tTools []string `json:\"tools,omitempty\"`\n\t// Remote transport type. Defaults to \"http\" when omitted.\n\tType *MCPServerConfigType `json:\"type,omitempty\"`\n\tHeaders map[string]string `json:\"headers,omitempty\"`\n\tOauthClientID *string `json:\"oauthClientId,omitempty\"`\n\tOauthGrantType *MCPServerConfigHTTPOauthGrantType `json:\"oauthGrantType,omitempty\"`\n\tOauthPublicClient *bool `json:\"oauthPublicClient,omitempty\"`\n\tURL *string `json:\"url,omitempty\"`\n}\n\ntype MCPConfigAddResult struct {\n}\n\ntype MCPConfigDisableRequest struct {\n\t// Names of MCP servers to disable. Each server is added to the persisted disabled list so\n\t// new sessions skip it. Already-disabled names are ignored. Active sessions keep their\n\t// current connections until they end.\n\tNames []string `json:\"names\"`\n}\n\ntype MCPConfigDisableResult struct {\n}\n\ntype MCPConfigEnableRequest struct {\n\t// Names of MCP servers to enable. Each server is removed from the persisted disabled list\n\t// so new sessions spawn it. Unknown or already-enabled names are ignored.\n\tNames []string `json:\"names\"`\n}\n\ntype MCPConfigEnableResult struct {\n}\n\ntype MCPConfigList struct {\n\t// All MCP servers from user config, keyed by name\n\tServers map[string]MCPServerConfig `json:\"servers\"`\n}\n\ntype MCPConfigRemoveRequest struct {\n\t// Name of the MCP server to remove\n\tName string `json:\"name\"`\n}\n\ntype MCPConfigRemoveResult struct {\n}\n\ntype MCPConfigUpdateRequest struct {\n\t// MCP server configuration (local/stdio or remote/http)\n\tConfig MCPServerConfig `json:\"config\"`\n\t// Name of the MCP server to update\n\tName string `json:\"name\"`\n}\n\ntype MCPConfigUpdateResult struct {\n}\n\ntype MCPDisableRequest struct {\n\t// Name of the MCP server to disable\n\tServerName string `json:\"serverName\"`\n}\n\ntype MCPDisableResult struct {\n}\n\ntype MCPDiscoverRequest struct {\n\t// Working directory used as context for discovery (e.g., plugin resolution)\n\tWorkingDirectory *string `json:\"workingDirectory,omitempty\"`\n}\n\ntype MCPDiscoverResult struct {\n\t// MCP servers discovered from all sources\n\tServers []DiscoveredMCPServer `json:\"servers\"`\n}\n\ntype MCPEnableRequest struct {\n\t// Name of the MCP server to enable\n\tServerName string `json:\"serverName\"`\n}\n\ntype MCPEnableResult struct {\n}\n\ntype MCPOauthLoginRequest struct {\n\t// Optional override for the body text shown on the OAuth loopback callback success page.\n\t// When omitted, the runtime applies a neutral fallback; callers driving interactive auth\n\t// should pass surface-specific copy telling the user where to return.\n\tCallbackSuccessMessage *string `json:\"callbackSuccessMessage,omitempty\"`\n\t// Optional override for the OAuth client display name shown on the consent screen. Applies\n\t// to newly registered dynamic clients only — existing registrations keep the name they were\n\t// created with. When omitted, the runtime applies a neutral fallback; callers driving\n\t// interactive auth should pass their own surface-specific label so the consent screen\n\t// matches the product the user sees.\n\tClientName *string `json:\"clientName,omitempty\"`\n\t// When true, clears any cached OAuth token for the server and runs a full new\n\t// authorization. Use when the user explicitly wants to switch accounts or believes their\n\t// session is stuck.\n\tForceReauth *bool `json:\"forceReauth,omitempty\"`\n\t// Name of the remote MCP server to authenticate\n\tServerName string `json:\"serverName\"`\n}\n\ntype MCPOauthLoginResult struct {\n\t// URL the caller should open in a browser to complete OAuth. Omitted when cached tokens\n\t// were still valid and no browser interaction was needed — the server is already\n\t// reconnected in that case. When present, the runtime starts the callback listener before\n\t// returning and continues the flow in the background; completion is signaled via\n\t// session.mcp_server_status_changed.\n\tAuthorizationURL *string `json:\"authorizationUrl,omitempty\"`\n}\n\ntype MCPReloadResult struct {\n}\n\ntype MCPServer struct {\n\t// Error message if the server failed to connect\n\tError *string `json:\"error,omitempty\"`\n\t// Server name (config key)\n\tName string `json:\"name\"`\n\t// Configuration source: user, workspace, plugin, or builtin\n\tSource *MCPServerSource `json:\"source,omitempty\"`\n\t// Connection status: connected, failed, needs-auth, pending, disabled, or not_configured\n\tStatus MCPServerStatus `json:\"status\"`\n}\n\ntype MCPServerConfigHTTP struct {\n\tFilterMapping *FilterMapping `json:\"filterMapping,omitempty\"`\n\tHeaders map[string]string `json:\"headers,omitempty\"`\n\tIsDefaultServer *bool `json:\"isDefaultServer,omitempty\"`\n\tOauthClientID *string `json:\"oauthClientId,omitempty\"`\n\tOauthGrantType *MCPServerConfigHTTPOauthGrantType `json:\"oauthGrantType,omitempty\"`\n\tOauthPublicClient *bool `json:\"oauthPublicClient,omitempty\"`\n\t// Timeout in milliseconds for tool calls to this server.\n\tTimeout *int64 `json:\"timeout,omitempty\"`\n\t// Tools to include. Defaults to all tools if not specified.\n\tTools []string `json:\"tools,omitempty\"`\n\t// Remote transport type. Defaults to \"http\" when omitted.\n\tType *MCPServerConfigHTTPType `json:\"type,omitempty\"`\n\tURL string `json:\"url\"`\n}\n\ntype MCPServerConfigLocal struct {\n\tArgs []string `json:\"args\"`\n\tCommand string `json:\"command\"`\n\tCwd *string `json:\"cwd,omitempty\"`\n\tEnv map[string]string `json:\"env,omitempty\"`\n\tFilterMapping *FilterMapping `json:\"filterMapping,omitempty\"`\n\tIsDefaultServer *bool `json:\"isDefaultServer,omitempty\"`\n\t// Timeout in milliseconds for tool calls to this server.\n\tTimeout *int64 `json:\"timeout,omitempty\"`\n\t// Tools to include. Defaults to all tools if not specified.\n\tTools []string `json:\"tools,omitempty\"`\n\tType *MCPServerConfigLocalType `json:\"type,omitempty\"`\n}\n\ntype MCPServerList struct {\n\t// Configured MCP servers\n\tServers []MCPServer `json:\"servers\"`\n}\n\ntype ModeSetRequest struct {\n\t// The agent mode. Valid values: \"interactive\", \"plan\", \"autopilot\".\n\tMode SessionMode `json:\"mode\"`\n}\n\ntype ModeSetResult struct {\n}\n\ntype ModelElement struct {\n\t// Billing information\n\tBilling *ModelBilling `json:\"billing,omitempty\"`\n\t// Model capabilities and limits\n\tCapabilities ModelCapabilities `json:\"capabilities\"`\n\t// Default reasoning effort level (only present if model supports reasoning effort)\n\tDefaultReasoningEffort *string `json:\"defaultReasoningEffort,omitempty\"`\n\t// Model identifier (e.g., \"claude-sonnet-4.5\")\n\tID string `json:\"id\"`\n\t// Display name\n\tName string `json:\"name\"`\n\t// Policy state (if applicable)\n\tPolicy *ModelPolicy `json:\"policy,omitempty\"`\n\t// Supported reasoning effort levels (only present if model supports reasoning effort)\n\tSupportedReasoningEfforts []string `json:\"supportedReasoningEfforts,omitempty\"`\n}\n\n// Billing information\ntype ModelBilling struct {\n\t// Billing cost multiplier relative to the base rate\n\tMultiplier float64 `json:\"multiplier\"`\n}\n\n// Model capabilities and limits\ntype ModelCapabilities struct {\n\t// Token limits for prompts, outputs, and context window\n\tLimits *ModelCapabilitiesLimits `json:\"limits,omitempty\"`\n\t// Feature flags indicating what the model supports\n\tSupports *ModelCapabilitiesSupports `json:\"supports,omitempty\"`\n}\n\n// Token limits for prompts, outputs, and context window\ntype ModelCapabilitiesLimits struct {\n\t// Maximum total context window size in tokens\n\tMaxContextWindowTokens *int64 `json:\"max_context_window_tokens,omitempty\"`\n\t// Maximum number of output/completion tokens\n\tMaxOutputTokens *int64 `json:\"max_output_tokens,omitempty\"`\n\t// Maximum number of prompt/input tokens\n\tMaxPromptTokens *int64 `json:\"max_prompt_tokens,omitempty\"`\n\t// Vision-specific limits\n\tVision *ModelCapabilitiesLimitsVision `json:\"vision,omitempty\"`\n}\n\n// Vision-specific limits\ntype ModelCapabilitiesLimitsVision struct {\n\t// Maximum image size in bytes\n\tMaxPromptImageSize int64 `json:\"max_prompt_image_size\"`\n\t// Maximum number of images per prompt\n\tMaxPromptImages int64 `json:\"max_prompt_images\"`\n\t// MIME types the model accepts\n\tSupportedMediaTypes []string `json:\"supported_media_types\"`\n}\n\n// Feature flags indicating what the model supports\ntype ModelCapabilitiesSupports struct {\n\t// Whether this model supports reasoning effort configuration\n\tReasoningEffort *bool `json:\"reasoningEffort,omitempty\"`\n\t// Whether this model supports vision/image input\n\tVision *bool `json:\"vision,omitempty\"`\n}\n\n// Policy state (if applicable)\ntype ModelPolicy struct {\n\t// Current policy state for this model\n\tState string `json:\"state\"`\n\t// Usage terms or conditions for this model\n\tTerms *string `json:\"terms,omitempty\"`\n}\n\n// Override individual model capabilities resolved by the runtime\ntype ModelCapabilitiesOverride struct {\n\t// Token limits for prompts, outputs, and context window\n\tLimits *ModelCapabilitiesOverrideLimits `json:\"limits,omitempty\"`\n\t// Feature flags indicating what the model supports\n\tSupports *ModelCapabilitiesOverrideSupports `json:\"supports,omitempty\"`\n}\n\n// Token limits for prompts, outputs, and context window\ntype ModelCapabilitiesOverrideLimits struct {\n\t// Maximum total context window size in tokens\n\tMaxContextWindowTokens *int64 `json:\"max_context_window_tokens,omitempty\"`\n\tMaxOutputTokens *int64 `json:\"max_output_tokens,omitempty\"`\n\tMaxPromptTokens *int64 `json:\"max_prompt_tokens,omitempty\"`\n\tVision *ModelCapabilitiesOverrideLimitsVision `json:\"vision,omitempty\"`\n}\n\ntype ModelCapabilitiesOverrideLimitsVision struct {\n\t// Maximum image size in bytes\n\tMaxPromptImageSize *int64 `json:\"max_prompt_image_size,omitempty\"`\n\t// Maximum number of images per prompt\n\tMaxPromptImages *int64 `json:\"max_prompt_images,omitempty\"`\n\t// MIME types the model accepts\n\tSupportedMediaTypes []string `json:\"supported_media_types,omitempty\"`\n}\n\n// Feature flags indicating what the model supports\ntype ModelCapabilitiesOverrideSupports struct {\n\tReasoningEffort *bool `json:\"reasoningEffort,omitempty\"`\n\tVision *bool `json:\"vision,omitempty\"`\n}\n\ntype ModelList struct {\n\t// List of available models with full metadata\n\tModels []ModelElement `json:\"models\"`\n}\n\ntype ModelSwitchToRequest struct {\n\t// Override individual model capabilities resolved by the runtime\n\tModelCapabilities *ModelCapabilitiesOverride `json:\"modelCapabilities,omitempty\"`\n\t// Model identifier to switch to\n\tModelID string `json:\"modelId\"`\n\t// Reasoning effort level to use for the model\n\tReasoningEffort *string `json:\"reasoningEffort,omitempty\"`\n}\n\ntype ModelSwitchToResult struct {\n\t// Currently active model identifier after the switch\n\tModelID *string `json:\"modelId,omitempty\"`\n}\n\ntype ModelsListRequest struct {\n\t// GitHub token for per-user model listing. When provided, resolves this token to determine\n\t// the user's Copilot plan and available models instead of using the global auth.\n\tGitHubToken *string `json:\"gitHubToken,omitempty\"`\n}\n\ntype NameGetResult struct {\n\t// The session name (user-set or auto-generated), or null if not yet set\n\tName *string `json:\"name\"`\n}\n\ntype NameSetRequest struct {\n\t// New session name (1–100 characters, trimmed of leading/trailing whitespace)\n\tName string `json:\"name\"`\n}\n\ntype NameSetResult struct {\n}\n\ntype PermissionDecision struct {\n\t// The permission request was approved for this one instance\n\t//\n\t// Approved and remembered for the rest of the session\n\t//\n\t// Approved and persisted for this project location\n\t//\n\t// Approved and persisted across sessions\n\t//\n\t// Denied by the user during an interactive prompt\n\t//\n\t// Denied because user confirmation was unavailable\n\tKind PermissionDecisionKind `json:\"kind\"`\n\t// The approval to add as a session-scoped rule\n\t//\n\t// The approval to persist for this location\n\tApproval *PermissionDecisionApproveForLocationApproval `json:\"approval,omitempty\"`\n\t// The URL domain to approve for this session\n\t//\n\t// The URL domain to approve permanently\n\tDomain *string `json:\"domain,omitempty\"`\n\t// The location key (git root or cwd) to persist the approval to\n\tLocationKey *string `json:\"locationKey,omitempty\"`\n\t// Optional feedback from the user explaining the denial\n\tFeedback *string `json:\"feedback,omitempty\"`\n}\n\ntype PermissionDecisionApproveForLocation struct {\n\t// The approval to persist for this location\n\tApproval PermissionDecisionApproveForLocationApproval `json:\"approval\"`\n\t// Approved and persisted for this project location\n\tKind PermissionDecisionApproveForLocationKind `json:\"kind\"`\n\t// The location key (git root or cwd) to persist the approval to\n\tLocationKey string `json:\"locationKey\"`\n}\n\n// The approval to persist for this location\ntype PermissionDecisionApproveForLocationApproval struct {\n\tCommandIdentifiers []string `json:\"commandIdentifiers,omitempty\"`\n\tKind ApprovalKind `json:\"kind\"`\n\tServerName *string `json:\"serverName,omitempty\"`\n\tToolName *string `json:\"toolName,omitempty\"`\n}\n\ntype PermissionDecisionApproveForLocationApprovalCommands struct {\n\tCommandIdentifiers []string `json:\"commandIdentifiers\"`\n\tKind PermissionDecisionApproveForLocationApprovalCommandsKind `json:\"kind\"`\n}\n\ntype PermissionDecisionApproveForLocationApprovalCustomTool struct {\n\tKind PermissionDecisionApproveForLocationApprovalCustomToolKind `json:\"kind\"`\n\tToolName string `json:\"toolName\"`\n}\n\ntype PermissionDecisionApproveForLocationApprovalMCP struct {\n\tKind PermissionDecisionApproveForLocationApprovalMCPKind `json:\"kind\"`\n\tServerName string `json:\"serverName\"`\n\tToolName *string `json:\"toolName\"`\n}\n\ntype PermissionDecisionApproveForLocationApprovalMCPSampling struct {\n\tKind PermissionDecisionApproveForLocationApprovalMCPSamplingKind `json:\"kind\"`\n\tServerName string `json:\"serverName\"`\n}\n\ntype PermissionDecisionApproveForLocationApprovalMemory struct {\n\tKind PermissionDecisionApproveForLocationApprovalMemoryKind `json:\"kind\"`\n}\n\ntype PermissionDecisionApproveForLocationApprovalRead struct {\n\tKind PermissionDecisionApproveForLocationApprovalReadKind `json:\"kind\"`\n}\n\ntype PermissionDecisionApproveForLocationApprovalWrite struct {\n\tKind PermissionDecisionApproveForLocationApprovalWriteKind `json:\"kind\"`\n}\n\ntype PermissionDecisionApproveForSession struct {\n\t// The approval to add as a session-scoped rule\n\tApproval *PermissionDecisionApproveForSessionApproval `json:\"approval,omitempty\"`\n\t// The URL domain to approve for this session\n\tDomain *string `json:\"domain,omitempty\"`\n\t// Approved and remembered for the rest of the session\n\tKind PermissionDecisionApproveForSessionKind `json:\"kind\"`\n}\n\n// The approval to add as a session-scoped rule\ntype PermissionDecisionApproveForSessionApproval struct {\n\tCommandIdentifiers []string `json:\"commandIdentifiers,omitempty\"`\n\tKind ApprovalKind `json:\"kind\"`\n\tServerName *string `json:\"serverName,omitempty\"`\n\tToolName *string `json:\"toolName,omitempty\"`\n}\n\ntype PermissionDecisionApproveForSessionApprovalCommands struct {\n\tCommandIdentifiers []string `json:\"commandIdentifiers\"`\n\tKind PermissionDecisionApproveForLocationApprovalCommandsKind `json:\"kind\"`\n}\n\ntype PermissionDecisionApproveForSessionApprovalCustomTool struct {\n\tKind PermissionDecisionApproveForLocationApprovalCustomToolKind `json:\"kind\"`\n\tToolName string `json:\"toolName\"`\n}\n\ntype PermissionDecisionApproveForSessionApprovalMCP struct {\n\tKind PermissionDecisionApproveForLocationApprovalMCPKind `json:\"kind\"`\n\tServerName string `json:\"serverName\"`\n\tToolName *string `json:\"toolName\"`\n}\n\ntype PermissionDecisionApproveForSessionApprovalMCPSampling struct {\n\tKind PermissionDecisionApproveForLocationApprovalMCPSamplingKind `json:\"kind\"`\n\tServerName string `json:\"serverName\"`\n}\n\ntype PermissionDecisionApproveForSessionApprovalMemory struct {\n\tKind PermissionDecisionApproveForLocationApprovalMemoryKind `json:\"kind\"`\n}\n\ntype PermissionDecisionApproveForSessionApprovalRead struct {\n\tKind PermissionDecisionApproveForLocationApprovalReadKind `json:\"kind\"`\n}\n\ntype PermissionDecisionApproveForSessionApprovalWrite struct {\n\tKind PermissionDecisionApproveForLocationApprovalWriteKind `json:\"kind\"`\n}\n\ntype PermissionDecisionApproveOnce struct {\n\t// The permission request was approved for this one instance\n\tKind PermissionDecisionApproveOnceKind `json:\"kind\"`\n}\n\ntype PermissionDecisionApprovePermanently struct {\n\t// The URL domain to approve permanently\n\tDomain string `json:\"domain\"`\n\t// Approved and persisted across sessions\n\tKind PermissionDecisionApprovePermanentlyKind `json:\"kind\"`\n}\n\ntype PermissionDecisionReject struct {\n\t// Optional feedback from the user explaining the denial\n\tFeedback *string `json:\"feedback,omitempty\"`\n\t// Denied by the user during an interactive prompt\n\tKind PermissionDecisionRejectKind `json:\"kind\"`\n}\n\ntype PermissionDecisionRequest struct {\n\t// Request ID of the pending permission request\n\tRequestID string `json:\"requestId\"`\n\tResult PermissionDecision `json:\"result\"`\n}\n\ntype PermissionDecisionUserNotAvailable struct {\n\t// Denied because user confirmation was unavailable\n\tKind PermissionDecisionUserNotAvailableKind `json:\"kind\"`\n}\n\ntype PermissionRequestResult struct {\n\t// Whether the permission request was handled successfully\n\tSuccess bool `json:\"success\"`\n}\n\ntype PermissionsResetSessionApprovalsRequest struct {\n}\n\ntype PermissionsResetSessionApprovalsResult struct {\n\t// Whether the operation succeeded\n\tSuccess bool `json:\"success\"`\n}\n\ntype PermissionsSetApproveAllRequest struct {\n\t// Whether to auto-approve all tool permission requests\n\tEnabled bool `json:\"enabled\"`\n}\n\ntype PermissionsSetApproveAllResult struct {\n\t// Whether the operation succeeded\n\tSuccess bool `json:\"success\"`\n}\n\ntype PingRequest struct {\n\t// Optional message to echo back\n\tMessage *string `json:\"message,omitempty\"`\n}\n\ntype PingResult struct {\n\t// Echoed message (or default greeting)\n\tMessage string `json:\"message\"`\n\t// Server protocol version number\n\tProtocolVersion int64 `json:\"protocolVersion\"`\n\t// Server timestamp in milliseconds\n\tTimestamp int64 `json:\"timestamp\"`\n}\n\ntype PlanDeleteResult struct {\n}\n\ntype PlanReadResult struct {\n\t// The content of the plan file, or null if it does not exist\n\tContent *string `json:\"content\"`\n\t// Whether the plan file exists in the workspace\n\tExists bool `json:\"exists\"`\n\t// Absolute file path of the plan file, or null if workspace is not enabled\n\tPath *string `json:\"path\"`\n}\n\ntype PlanUpdateRequest struct {\n\t// The new content for the plan file\n\tContent string `json:\"content\"`\n}\n\ntype PlanUpdateResult struct {\n}\n\ntype PluginElement struct {\n\t// Whether the plugin is currently enabled\n\tEnabled bool `json:\"enabled\"`\n\t// Marketplace the plugin came from\n\tMarketplace string `json:\"marketplace\"`\n\t// Plugin name\n\tName string `json:\"name\"`\n\t// Installed version\n\tVersion *string `json:\"version,omitempty\"`\n}\n\n// Experimental: PluginList is part of an experimental API and may change or be removed.\ntype PluginList struct {\n\t// Installed plugins\n\tPlugins []PluginElement `json:\"plugins\"`\n}\n\ntype ServerSkill struct {\n\t// Description of what the skill does\n\tDescription string `json:\"description\"`\n\t// Whether the skill is currently enabled (based on global config)\n\tEnabled bool `json:\"enabled\"`\n\t// Unique identifier for the skill\n\tName string `json:\"name\"`\n\t// Absolute path to the skill file\n\tPath *string `json:\"path,omitempty\"`\n\t// The project path this skill belongs to (only for project/inherited skills)\n\tProjectPath *string `json:\"projectPath,omitempty\"`\n\t// Source location type (e.g., project, personal-copilot, plugin, builtin)\n\tSource string `json:\"source\"`\n\t// Whether the skill can be invoked by the user as a slash command\n\tUserInvocable bool `json:\"userInvocable\"`\n}\n\ntype ServerSkillList struct {\n\t// All discovered skills across all sources\n\tSkills []ServerSkill `json:\"skills\"`\n}\n\ntype SessionAuthStatus struct {\n\t// Authentication type\n\tAuthType *AuthInfoType `json:\"authType,omitempty\"`\n\t// Copilot plan tier (e.g., individual_pro, business)\n\tCopilotPlan *string `json:\"copilotPlan,omitempty\"`\n\t// Authentication host URL\n\tHost *string `json:\"host,omitempty\"`\n\t// Whether the session has resolved authentication\n\tIsAuthenticated bool `json:\"isAuthenticated\"`\n\t// Authenticated login/username, if available\n\tLogin *string `json:\"login,omitempty\"`\n\t// Human-readable authentication status description\n\tStatusMessage *string `json:\"statusMessage,omitempty\"`\n}\n\ntype SessionFSAppendFileRequest struct {\n\t// Content to append\n\tContent string `json:\"content\"`\n\t// Optional POSIX-style mode for newly created files\n\tMode *int64 `json:\"mode,omitempty\"`\n\t// Path using SessionFs conventions\n\tPath string `json:\"path\"`\n\t// Target session identifier\n\tSessionID string `json:\"sessionId\"`\n}\n\n// Describes a filesystem error.\ntype SessionFSError struct {\n\t// Error classification\n\tCode SessionFSErrorCode `json:\"code\"`\n\t// Free-form detail about the error, for logging/diagnostics\n\tMessage *string `json:\"message,omitempty\"`\n}\n\ntype SessionFSExistsRequest struct {\n\t// Path using SessionFs conventions\n\tPath string `json:\"path\"`\n\t// Target session identifier\n\tSessionID string `json:\"sessionId\"`\n}\n\ntype SessionFSExistsResult struct {\n\t// Whether the path exists\n\tExists bool `json:\"exists\"`\n}\n\ntype SessionFSMkdirRequest struct {\n\t// Optional POSIX-style mode for newly created directories\n\tMode *int64 `json:\"mode,omitempty\"`\n\t// Path using SessionFs conventions\n\tPath string `json:\"path\"`\n\t// Create parent directories as needed\n\tRecursive *bool `json:\"recursive,omitempty\"`\n\t// Target session identifier\n\tSessionID string `json:\"sessionId\"`\n}\n\ntype SessionFSReadFileRequest struct {\n\t// Path using SessionFs conventions\n\tPath string `json:\"path\"`\n\t// Target session identifier\n\tSessionID string `json:\"sessionId\"`\n}\n\ntype SessionFSReadFileResult struct {\n\t// File content as UTF-8 string\n\tContent string `json:\"content\"`\n\t// Describes a filesystem error.\n\tError *SessionFSError `json:\"error,omitempty\"`\n}\n\ntype SessionFSReaddirRequest struct {\n\t// Path using SessionFs conventions\n\tPath string `json:\"path\"`\n\t// Target session identifier\n\tSessionID string `json:\"sessionId\"`\n}\n\ntype SessionFSReaddirResult struct {\n\t// Entry names in the directory\n\tEntries []string `json:\"entries\"`\n\t// Describes a filesystem error.\n\tError *SessionFSError `json:\"error,omitempty\"`\n}\n\ntype SessionFSReaddirWithTypesEntry struct {\n\t// Entry name\n\tName string `json:\"name\"`\n\t// Entry type\n\tType SessionFSReaddirWithTypesEntryType `json:\"type\"`\n}\n\ntype SessionFSReaddirWithTypesRequest struct {\n\t// Path using SessionFs conventions\n\tPath string `json:\"path\"`\n\t// Target session identifier\n\tSessionID string `json:\"sessionId\"`\n}\n\ntype SessionFSReaddirWithTypesResult struct {\n\t// Directory entries with type information\n\tEntries []SessionFSReaddirWithTypesEntry `json:\"entries\"`\n\t// Describes a filesystem error.\n\tError *SessionFSError `json:\"error,omitempty\"`\n}\n\ntype SessionFSRenameRequest struct {\n\t// Destination path using SessionFs conventions\n\tDest string `json:\"dest\"`\n\t// Target session identifier\n\tSessionID string `json:\"sessionId\"`\n\t// Source path using SessionFs conventions\n\tSrc string `json:\"src\"`\n}\n\ntype SessionFSRmRequest struct {\n\t// Ignore errors if the path does not exist\n\tForce *bool `json:\"force,omitempty\"`\n\t// Path using SessionFs conventions\n\tPath string `json:\"path\"`\n\t// Remove directories and their contents recursively\n\tRecursive *bool `json:\"recursive,omitempty\"`\n\t// Target session identifier\n\tSessionID string `json:\"sessionId\"`\n}\n\ntype SessionFSSetProviderRequest struct {\n\t// Path conventions used by this filesystem\n\tConventions SessionFSSetProviderConventions `json:\"conventions\"`\n\t// Initial working directory for sessions\n\tInitialCwd string `json:\"initialCwd\"`\n\t// Path within each session's SessionFs where the runtime stores files for that session\n\tSessionStatePath string `json:\"sessionStatePath\"`\n}\n\ntype SessionFSSetProviderResult struct {\n\t// Whether the provider was set successfully\n\tSuccess bool `json:\"success\"`\n}\n\ntype SessionFSStatRequest struct {\n\t// Path using SessionFs conventions\n\tPath string `json:\"path\"`\n\t// Target session identifier\n\tSessionID string `json:\"sessionId\"`\n}\n\ntype SessionFSStatResult struct {\n\t// ISO 8601 timestamp of creation\n\tBirthtime time.Time `json:\"birthtime\"`\n\t// Describes a filesystem error.\n\tError *SessionFSError `json:\"error,omitempty\"`\n\t// Whether the path is a directory\n\tIsDirectory bool `json:\"isDirectory\"`\n\t// Whether the path is a file\n\tIsFile bool `json:\"isFile\"`\n\t// ISO 8601 timestamp of last modification\n\tMtime time.Time `json:\"mtime\"`\n\t// File size in bytes\n\tSize int64 `json:\"size\"`\n}\n\ntype SessionFSWriteFileRequest struct {\n\t// Content to write\n\tContent string `json:\"content\"`\n\t// Optional POSIX-style mode for newly created files\n\tMode *int64 `json:\"mode,omitempty\"`\n\t// Path using SessionFs conventions\n\tPath string `json:\"path\"`\n\t// Target session identifier\n\tSessionID string `json:\"sessionId\"`\n}\n\n// Experimental: SessionsForkRequest is part of an experimental API and may change or be removed.\ntype SessionsForkRequest struct {\n\t// Source session ID to fork from\n\tSessionID string `json:\"sessionId\"`\n\t// Optional event ID boundary. When provided, the fork includes only events before this ID\n\t// (exclusive). When omitted, all events are included.\n\tToEventID *string `json:\"toEventId,omitempty\"`\n}\n\n// Experimental: SessionsForkResult is part of an experimental API and may change or be removed.\ntype SessionsForkResult struct {\n\t// The new forked session's ID\n\tSessionID string `json:\"sessionId\"`\n}\n\ntype ShellExecRequest struct {\n\t// Shell command to execute\n\tCommand string `json:\"command\"`\n\t// Working directory (defaults to session working directory)\n\tCwd *string `json:\"cwd,omitempty\"`\n\t// Timeout in milliseconds (default: 30000)\n\tTimeout *int64 `json:\"timeout,omitempty\"`\n}\n\ntype ShellExecResult struct {\n\t// Unique identifier for tracking streamed output\n\tProcessID string `json:\"processId\"`\n}\n\ntype ShellKillRequest struct {\n\t// Process identifier returned by shell.exec\n\tProcessID string `json:\"processId\"`\n\t// Signal to send (default: SIGTERM)\n\tSignal *ShellKillSignal `json:\"signal,omitempty\"`\n}\n\ntype ShellKillResult struct {\n\t// Whether the signal was sent successfully\n\tKilled bool `json:\"killed\"`\n}\n\ntype Skill struct {\n\t// Description of what the skill does\n\tDescription string `json:\"description\"`\n\t// Whether the skill is currently enabled\n\tEnabled bool `json:\"enabled\"`\n\t// Unique identifier for the skill\n\tName string `json:\"name\"`\n\t// Absolute path to the skill file\n\tPath *string `json:\"path,omitempty\"`\n\t// Source location type (e.g., project, personal, plugin)\n\tSource string `json:\"source\"`\n\t// Whether the skill can be invoked by the user as a slash command\n\tUserInvocable bool `json:\"userInvocable\"`\n}\n\n// Experimental: SkillList is part of an experimental API and may change or be removed.\ntype SkillList struct {\n\t// Available skills\n\tSkills []Skill `json:\"skills\"`\n}\n\ntype SkillsConfigSetDisabledSkillsRequest struct {\n\t// List of skill names to disable\n\tDisabledSkills []string `json:\"disabledSkills\"`\n}\n\ntype SkillsConfigSetDisabledSkillsResult struct {\n}\n\n// Experimental: SkillsDisableRequest is part of an experimental API and may change or be removed.\ntype SkillsDisableRequest struct {\n\t// Name of the skill to disable\n\tName string `json:\"name\"`\n}\n\n// Experimental: SkillsDisableResult is part of an experimental API and may change or be removed.\ntype SkillsDisableResult struct {\n}\n\ntype SkillsDiscoverRequest struct {\n\t// Optional list of project directory paths to scan for project-scoped skills\n\tProjectPaths []string `json:\"projectPaths,omitempty\"`\n\t// Optional list of additional skill directory paths to include\n\tSkillDirectories []string `json:\"skillDirectories,omitempty\"`\n}\n\n// Experimental: SkillsEnableRequest is part of an experimental API and may change or be removed.\ntype SkillsEnableRequest struct {\n\t// Name of the skill to enable\n\tName string `json:\"name\"`\n}\n\n// Experimental: SkillsEnableResult is part of an experimental API and may change or be removed.\ntype SkillsEnableResult struct {\n}\n\n// Experimental: SkillsReloadResult is part of an experimental API and may change or be removed.\ntype SkillsReloadResult struct {\n}\n\ntype SuspendResult struct {\n}\n\ntype TaskAgentInfo struct {\n\t// ISO 8601 timestamp when the current active period began\n\tActiveStartedAt *time.Time `json:\"activeStartedAt,omitempty\"`\n\t// Accumulated active execution time in milliseconds\n\tActiveTimeMS *int64 `json:\"activeTimeMs,omitempty\"`\n\t// Type of agent running this task\n\tAgentType string `json:\"agentType\"`\n\t// Whether the task is currently in the original sync wait and can be moved to background\n\t// mode. False once it is already backgrounded, idle, finished, or no longer has a\n\t// promotable sync waiter.\n\tCanPromoteToBackground *bool `json:\"canPromoteToBackground,omitempty\"`\n\t// ISO 8601 timestamp when the task finished\n\tCompletedAt *time.Time `json:\"completedAt,omitempty\"`\n\t// Short description of the task\n\tDescription string `json:\"description\"`\n\t// Error message when the task failed\n\tError *string `json:\"error,omitempty\"`\n\t// How the agent is currently being managed by the runtime\n\tExecutionMode *TaskInfoExecutionMode `json:\"executionMode,omitempty\"`\n\t// Unique task identifier\n\tID string `json:\"id\"`\n\t// ISO 8601 timestamp when the agent entered idle state\n\tIdleSince *time.Time `json:\"idleSince,omitempty\"`\n\t// Most recent response text from the agent\n\tLatestResponse *string `json:\"latestResponse,omitempty\"`\n\t// Model used for the task when specified\n\tModel *string `json:\"model,omitempty\"`\n\t// Prompt passed to the agent\n\tPrompt string `json:\"prompt\"`\n\t// Result text from the task when available\n\tResult *string `json:\"result,omitempty\"`\n\t// ISO 8601 timestamp when the task was started\n\tStartedAt time.Time `json:\"startedAt\"`\n\t// Current lifecycle status of the task\n\tStatus TaskInfoStatus `json:\"status\"`\n\t// Tool call ID associated with this agent task\n\tToolCallID string `json:\"toolCallId\"`\n\t// Task kind\n\tType TaskAgentInfoType `json:\"type\"`\n}\n\ntype TaskInfo struct {\n\t// ISO 8601 timestamp when the current active period began\n\tActiveStartedAt *time.Time `json:\"activeStartedAt,omitempty\"`\n\t// Accumulated active execution time in milliseconds\n\tActiveTimeMS *int64 `json:\"activeTimeMs,omitempty\"`\n\t// Type of agent running this task\n\tAgentType *string `json:\"agentType,omitempty\"`\n\t// Whether the task is currently in the original sync wait and can be moved to background\n\t// mode. False once it is already backgrounded, idle, finished, or no longer has a\n\t// promotable sync waiter.\n\t//\n\t// Whether this shell task can be promoted to background mode\n\tCanPromoteToBackground *bool `json:\"canPromoteToBackground,omitempty\"`\n\t// ISO 8601 timestamp when the task finished\n\tCompletedAt *time.Time `json:\"completedAt,omitempty\"`\n\t// Short description of the task\n\tDescription string `json:\"description\"`\n\t// Error message when the task failed\n\tError *string `json:\"error,omitempty\"`\n\t// How the agent is currently being managed by the runtime\n\t//\n\t// Whether the shell command is currently sync-waited or background-managed\n\tExecutionMode *TaskInfoExecutionMode `json:\"executionMode,omitempty\"`\n\t// Unique task identifier\n\tID string `json:\"id\"`\n\t// ISO 8601 timestamp when the agent entered idle state\n\tIdleSince *time.Time `json:\"idleSince,omitempty\"`\n\t// Most recent response text from the agent\n\tLatestResponse *string `json:\"latestResponse,omitempty\"`\n\t// Model used for the task when specified\n\tModel *string `json:\"model,omitempty\"`\n\t// Prompt passed to the agent\n\tPrompt *string `json:\"prompt,omitempty\"`\n\t// Result text from the task when available\n\tResult *string `json:\"result,omitempty\"`\n\t// ISO 8601 timestamp when the task was started\n\tStartedAt time.Time `json:\"startedAt\"`\n\t// Current lifecycle status of the task\n\tStatus TaskInfoStatus `json:\"status\"`\n\t// Tool call ID associated with this agent task\n\tToolCallID *string `json:\"toolCallId,omitempty\"`\n\t// Task kind\n\tType TaskInfoType `json:\"type\"`\n\t// Whether the shell runs inside a managed PTY session or as an independent background\n\t// process\n\tAttachmentMode *TaskShellInfoAttachmentMode `json:\"attachmentMode,omitempty\"`\n\t// Command being executed\n\tCommand *string `json:\"command,omitempty\"`\n\t// Path to the detached shell log, when available\n\tLogPath *string `json:\"logPath,omitempty\"`\n\t// Process ID when available\n\tPID *int64 `json:\"pid,omitempty\"`\n}\n\n// Experimental: TaskList is part of an experimental API and may change or be removed.\ntype TaskList struct {\n\t// Currently tracked tasks\n\tTasks []TaskInfo `json:\"tasks\"`\n}\n\ntype TaskShellInfo struct {\n\t// Whether the shell runs inside a managed PTY session or as an independent background\n\t// process\n\tAttachmentMode TaskShellInfoAttachmentMode `json:\"attachmentMode\"`\n\t// Whether this shell task can be promoted to background mode\n\tCanPromoteToBackground *bool `json:\"canPromoteToBackground,omitempty\"`\n\t// Command being executed\n\tCommand string `json:\"command\"`\n\t// ISO 8601 timestamp when the task finished\n\tCompletedAt *time.Time `json:\"completedAt,omitempty\"`\n\t// Short description of the task\n\tDescription string `json:\"description\"`\n\t// Whether the shell command is currently sync-waited or background-managed\n\tExecutionMode *TaskInfoExecutionMode `json:\"executionMode,omitempty\"`\n\t// Unique task identifier\n\tID string `json:\"id\"`\n\t// Path to the detached shell log, when available\n\tLogPath *string `json:\"logPath,omitempty\"`\n\t// Process ID when available\n\tPID *int64 `json:\"pid,omitempty\"`\n\t// ISO 8601 timestamp when the task was started\n\tStartedAt time.Time `json:\"startedAt\"`\n\t// Current lifecycle status of the task\n\tStatus TaskInfoStatus `json:\"status\"`\n\t// Task kind\n\tType TaskShellInfoType `json:\"type\"`\n}\n\n// Experimental: TasksCancelRequest is part of an experimental API and may change or be removed.\ntype TasksCancelRequest struct {\n\t// Task identifier\n\tID string `json:\"id\"`\n}\n\n// Experimental: TasksCancelResult is part of an experimental API and may change or be removed.\ntype TasksCancelResult struct {\n\t// Whether the task was successfully cancelled\n\tCancelled bool `json:\"cancelled\"`\n}\n\n// Experimental: TasksPromoteToBackgroundRequest is part of an experimental API and may change or be removed.\ntype TasksPromoteToBackgroundRequest struct {\n\t// Task identifier\n\tID string `json:\"id\"`\n}\n\n// Experimental: TasksPromoteToBackgroundResult is part of an experimental API and may change or be removed.\ntype TasksPromoteToBackgroundResult struct {\n\t// Whether the task was successfully promoted to background mode\n\tPromoted bool `json:\"promoted\"`\n}\n\n// Experimental: TasksRemoveRequest is part of an experimental API and may change or be removed.\ntype TasksRemoveRequest struct {\n\t// Task identifier\n\tID string `json:\"id\"`\n}\n\n// Experimental: TasksRemoveResult is part of an experimental API and may change or be removed.\ntype TasksRemoveResult struct {\n\t// Whether the task was removed. Returns false if the task does not exist or is still\n\t// running/idle (cancel it first).\n\tRemoved bool `json:\"removed\"`\n}\n\n// Experimental: TasksStartAgentRequest is part of an experimental API and may change or be removed.\ntype TasksStartAgentRequest struct {\n\t// Type of agent to start (e.g., 'explore', 'task', 'general-purpose')\n\tAgentType string `json:\"agentType\"`\n\t// Short description of the task\n\tDescription *string `json:\"description,omitempty\"`\n\t// Optional model override\n\tModel *string `json:\"model,omitempty\"`\n\t// Short name for the agent, used to generate a human-readable ID\n\tName string `json:\"name\"`\n\t// Task prompt for the agent\n\tPrompt string `json:\"prompt\"`\n}\n\n// Experimental: TasksStartAgentResult is part of an experimental API and may change or be removed.\ntype TasksStartAgentResult struct {\n\t// Generated agent ID for the background task\n\tAgentID string `json:\"agentId\"`\n}\n\ntype Tool struct {\n\t// Description of what the tool does\n\tDescription string `json:\"description\"`\n\t// Optional instructions for how to use this tool effectively\n\tInstructions *string `json:\"instructions,omitempty\"`\n\t// Tool identifier (e.g., \"bash\", \"grep\", \"str_replace_editor\")\n\tName string `json:\"name\"`\n\t// Optional namespaced name for declarative filtering (e.g., \"playwright/navigate\" for MCP\n\t// tools)\n\tNamespacedName *string `json:\"namespacedName,omitempty\"`\n\t// JSON Schema for the tool's input parameters\n\tParameters map[string]any `json:\"parameters,omitempty\"`\n}\n\ntype ToolList struct {\n\t// List of available built-in tools with metadata\n\tTools []Tool `json:\"tools\"`\n}\n\ntype ToolsListRequest struct {\n\t// Optional model ID — when provided, the returned tool list reflects model-specific\n\t// overrides\n\tModel *string `json:\"model,omitempty\"`\n}\n\ntype UIElicitationArrayAnyOfField struct {\n\tDefault []string `json:\"default,omitempty\"`\n\tDescription *string `json:\"description,omitempty\"`\n\tItems UIElicitationArrayAnyOfFieldItems `json:\"items\"`\n\tMaxItems *float64 `json:\"maxItems,omitempty\"`\n\tMinItems *float64 `json:\"minItems,omitempty\"`\n\tTitle *string `json:\"title,omitempty\"`\n\tType UIElicitationArrayAnyOfFieldType `json:\"type\"`\n}\n\ntype UIElicitationArrayAnyOfFieldItems struct {\n\tAnyOf []UIElicitationArrayAnyOfFieldItemsAnyOf `json:\"anyOf\"`\n}\n\ntype UIElicitationArrayAnyOfFieldItemsAnyOf struct {\n\tConst string `json:\"const\"`\n\tTitle string `json:\"title\"`\n}\n\ntype UIElicitationArrayEnumField struct {\n\tDefault []string `json:\"default,omitempty\"`\n\tDescription *string `json:\"description,omitempty\"`\n\tItems UIElicitationArrayEnumFieldItems `json:\"items\"`\n\tMaxItems *float64 `json:\"maxItems,omitempty\"`\n\tMinItems *float64 `json:\"minItems,omitempty\"`\n\tTitle *string `json:\"title,omitempty\"`\n\tType UIElicitationArrayAnyOfFieldType `json:\"type\"`\n}\n\ntype UIElicitationArrayEnumFieldItems struct {\n\tEnum []string `json:\"enum\"`\n\tType UIElicitationArrayEnumFieldItemsType `json:\"type\"`\n}\n\ntype UIElicitationRequest struct {\n\t// Message describing what information is needed from the user\n\tMessage string `json:\"message\"`\n\t// JSON Schema describing the form fields to present to the user\n\tRequestedSchema UIElicitationSchema `json:\"requestedSchema\"`\n}\n\n// JSON Schema describing the form fields to present to the user\ntype UIElicitationSchema struct {\n\t// Form field definitions, keyed by field name\n\tProperties map[string]UIElicitationSchemaProperty `json:\"properties\"`\n\t// List of required field names\n\tRequired []string `json:\"required,omitempty\"`\n\t// Schema type indicator (always 'object')\n\tType UIElicitationSchemaType `json:\"type\"`\n}\n\ntype UIElicitationSchemaProperty struct {\n\tDefault *UIElicitationFieldValue `json:\"default,omitempty\"`\n\tDescription *string `json:\"description,omitempty\"`\n\tEnum []string `json:\"enum,omitempty\"`\n\tEnumNames []string `json:\"enumNames,omitempty\"`\n\tTitle *string `json:\"title,omitempty\"`\n\tType UIElicitationSchemaPropertyType `json:\"type\"`\n\tOneOf []UIElicitationStringOneOfFieldOneOf `json:\"oneOf,omitempty\"`\n\tItems *UIElicitationArrayFieldItems `json:\"items,omitempty\"`\n\tMaxItems *float64 `json:\"maxItems,omitempty\"`\n\tMinItems *float64 `json:\"minItems,omitempty\"`\n\tFormat *UIElicitationSchemaPropertyStringFormat `json:\"format,omitempty\"`\n\tMaxLength *float64 `json:\"maxLength,omitempty\"`\n\tMinLength *float64 `json:\"minLength,omitempty\"`\n\tMaximum *float64 `json:\"maximum,omitempty\"`\n\tMinimum *float64 `json:\"minimum,omitempty\"`\n}\n\ntype UIElicitationArrayFieldItems struct {\n\tEnum []string `json:\"enum,omitempty\"`\n\tType *UIElicitationArrayEnumFieldItemsType `json:\"type,omitempty\"`\n\tAnyOf []UIElicitationArrayAnyOfFieldItemsAnyOf `json:\"anyOf,omitempty\"`\n}\n\ntype UIElicitationStringOneOfFieldOneOf struct {\n\tConst string `json:\"const\"`\n\tTitle string `json:\"title\"`\n}\n\n// The elicitation response (accept with form values, decline, or cancel)\ntype UIElicitationResponse struct {\n\t// The user's response: accept (submitted), decline (rejected), or cancel (dismissed)\n\tAction UIElicitationResponseAction `json:\"action\"`\n\t// The form values submitted by the user (present when action is 'accept')\n\tContent map[string]*UIElicitationFieldValue `json:\"content,omitempty\"`\n}\n\ntype UIElicitationResult struct {\n\t// Whether the response was accepted. False if the request was already resolved by another\n\t// client.\n\tSuccess bool `json:\"success\"`\n}\n\ntype UIElicitationSchemaPropertyBoolean struct {\n\tDefault *bool `json:\"default,omitempty\"`\n\tDescription *string `json:\"description,omitempty\"`\n\tTitle *string `json:\"title,omitempty\"`\n\tType UIElicitationSchemaPropertyBooleanType `json:\"type\"`\n}\n\ntype UIElicitationSchemaPropertyNumber struct {\n\tDefault *float64 `json:\"default,omitempty\"`\n\tDescription *string `json:\"description,omitempty\"`\n\tMaximum *float64 `json:\"maximum,omitempty\"`\n\tMinimum *float64 `json:\"minimum,omitempty\"`\n\tTitle *string `json:\"title,omitempty\"`\n\tType UIElicitationSchemaPropertyNumberTypeEnum `json:\"type\"`\n}\n\ntype UIElicitationSchemaPropertyString struct {\n\tDefault *string `json:\"default,omitempty\"`\n\tDescription *string `json:\"description,omitempty\"`\n\tFormat *UIElicitationSchemaPropertyStringFormat `json:\"format,omitempty\"`\n\tMaxLength *float64 `json:\"maxLength,omitempty\"`\n\tMinLength *float64 `json:\"minLength,omitempty\"`\n\tTitle *string `json:\"title,omitempty\"`\n\tType UIElicitationArrayEnumFieldItemsType `json:\"type\"`\n}\n\ntype UIElicitationStringEnumField struct {\n\tDefault *string `json:\"default,omitempty\"`\n\tDescription *string `json:\"description,omitempty\"`\n\tEnum []string `json:\"enum\"`\n\tEnumNames []string `json:\"enumNames,omitempty\"`\n\tTitle *string `json:\"title,omitempty\"`\n\tType UIElicitationArrayEnumFieldItemsType `json:\"type\"`\n}\n\ntype UIElicitationStringOneOfField struct {\n\tDefault *string `json:\"default,omitempty\"`\n\tDescription *string `json:\"description,omitempty\"`\n\tOneOf []UIElicitationStringOneOfFieldOneOf `json:\"oneOf\"`\n\tTitle *string `json:\"title,omitempty\"`\n\tType UIElicitationArrayEnumFieldItemsType `json:\"type\"`\n}\n\ntype UIHandlePendingElicitationRequest struct {\n\t// The unique request ID from the elicitation.requested event\n\tRequestID string `json:\"requestId\"`\n\t// The elicitation response (accept with form values, decline, or cancel)\n\tResult UIElicitationResponse `json:\"result\"`\n}\n\n// Experimental: UsageGetMetricsResult is part of an experimental API and may change or be removed.\ntype UsageGetMetricsResult struct {\n\t// Aggregated code change metrics\n\tCodeChanges UsageMetricsCodeChanges `json:\"codeChanges\"`\n\t// Currently active model identifier\n\tCurrentModel *string `json:\"currentModel,omitempty\"`\n\t// Input tokens from the most recent main-agent API call\n\tLastCallInputTokens int64 `json:\"lastCallInputTokens\"`\n\t// Output tokens from the most recent main-agent API call\n\tLastCallOutputTokens int64 `json:\"lastCallOutputTokens\"`\n\t// Per-model token and request metrics, keyed by model identifier\n\tModelMetrics map[string]UsageMetricsModelMetric `json:\"modelMetrics\"`\n\t// Session start timestamp (epoch milliseconds)\n\tSessionStartTime int64 `json:\"sessionStartTime\"`\n\t// Session-wide per-token-type accumulated token counts\n\tTokenDetails map[string]UsageMetricsTokenDetail `json:\"tokenDetails,omitempty\"`\n\t// Total time spent in model API calls (milliseconds)\n\tTotalAPIDurationMS float64 `json:\"totalApiDurationMs\"`\n\t// Session-wide accumulated nano-AI units cost\n\tTotalNanoAiu *int64 `json:\"totalNanoAiu,omitempty\"`\n\t// Total user-initiated premium request cost across all models (may be fractional due to\n\t// multipliers)\n\tTotalPremiumRequestCost float64 `json:\"totalPremiumRequestCost\"`\n\t// Raw count of user-initiated API requests\n\tTotalUserRequests int64 `json:\"totalUserRequests\"`\n}\n\n// Aggregated code change metrics\ntype UsageMetricsCodeChanges struct {\n\t// Number of distinct files modified\n\tFilesModifiedCount int64 `json:\"filesModifiedCount\"`\n\t// Total lines of code added\n\tLinesAdded int64 `json:\"linesAdded\"`\n\t// Total lines of code removed\n\tLinesRemoved int64 `json:\"linesRemoved\"`\n}\n\ntype UsageMetricsModelMetric struct {\n\t// Request count and cost metrics for this model\n\tRequests UsageMetricsModelMetricRequests `json:\"requests\"`\n\t// Token count details per type\n\tTokenDetails map[string]UsageMetricsModelMetricTokenDetail `json:\"tokenDetails,omitempty\"`\n\t// Accumulated nano-AI units cost for this model\n\tTotalNanoAiu *int64 `json:\"totalNanoAiu,omitempty\"`\n\t// Token usage metrics for this model\n\tUsage UsageMetricsModelMetricUsage `json:\"usage\"`\n}\n\n// Request count and cost metrics for this model\ntype UsageMetricsModelMetricRequests struct {\n\t// User-initiated premium request cost (with multiplier applied)\n\tCost float64 `json:\"cost\"`\n\t// Number of API requests made with this model\n\tCount int64 `json:\"count\"`\n}\n\ntype UsageMetricsModelMetricTokenDetail struct {\n\t// Accumulated token count for this token type\n\tTokenCount int64 `json:\"tokenCount\"`\n}\n\n// Token usage metrics for this model\ntype UsageMetricsModelMetricUsage struct {\n\t// Total tokens read from prompt cache\n\tCacheReadTokens int64 `json:\"cacheReadTokens\"`\n\t// Total tokens written to prompt cache\n\tCacheWriteTokens int64 `json:\"cacheWriteTokens\"`\n\t// Total input tokens consumed\n\tInputTokens int64 `json:\"inputTokens\"`\n\t// Total output tokens produced\n\tOutputTokens int64 `json:\"outputTokens\"`\n\t// Total output tokens used for reasoning\n\tReasoningTokens *int64 `json:\"reasoningTokens,omitempty\"`\n}\n\ntype UsageMetricsTokenDetail struct {\n\t// Accumulated token count for this token type\n\tTokenCount int64 `json:\"tokenCount\"`\n}\n\ntype WorkspacesCreateFileRequest struct {\n\t// File content to write as a UTF-8 string\n\tContent string `json:\"content\"`\n\t// Relative path within the workspace files directory\n\tPath string `json:\"path\"`\n}\n\ntype WorkspacesCreateFileResult struct {\n}\n\ntype WorkspacesGetWorkspaceResult struct {\n\t// Current workspace metadata, or null if not available\n\tWorkspace *WorkspaceClass `json:\"workspace\"`\n}\n\ntype WorkspaceClass struct {\n\tBranch *string `json:\"branch,omitempty\"`\n\tChronicleSyncDismissed *bool `json:\"chronicle_sync_dismissed,omitempty\"`\n\tCreatedAt *time.Time `json:\"created_at,omitempty\"`\n\tCwd *string `json:\"cwd,omitempty\"`\n\tGitRoot *string `json:\"git_root,omitempty\"`\n\tHostType *HostType `json:\"host_type,omitempty\"`\n\tID string `json:\"id\"`\n\tMcLastEventID *string `json:\"mc_last_event_id,omitempty\"`\n\tMcSessionID *string `json:\"mc_session_id,omitempty\"`\n\tMcTaskID *string `json:\"mc_task_id,omitempty\"`\n\tName *string `json:\"name,omitempty\"`\n\tRemoteSteerable *bool `json:\"remote_steerable,omitempty\"`\n\tRepository *string `json:\"repository,omitempty\"`\n\tSessionSyncLevel *SessionSyncLevel `json:\"session_sync_level,omitempty\"`\n\tSummary *string `json:\"summary,omitempty\"`\n\tSummaryCount *int64 `json:\"summary_count,omitempty\"`\n\tUpdatedAt *time.Time `json:\"updated_at,omitempty\"`\n\tUserNamed *bool `json:\"user_named,omitempty\"`\n}\n\ntype WorkspacesListFilesResult struct {\n\t// Relative file paths in the workspace files directory\n\tFiles []string `json:\"files\"`\n}\n\ntype WorkspacesReadFileRequest struct {\n\t// Relative path within the workspace files directory\n\tPath string `json:\"path\"`\n}\n\ntype WorkspacesReadFileResult struct {\n\t// File content as a UTF-8 string\n\tContent string `json:\"content\"`\n}\n\n// Authentication type\ntype AuthInfoType string\n\nconst (\n\tAuthInfoTypeAPIKey AuthInfoType = \"api-key\"\n\tAuthInfoTypeUser AuthInfoType = \"user\"\n\tAuthInfoTypeCopilotAPIToken AuthInfoType = \"copilot-api-token\"\n\tAuthInfoTypeEnv AuthInfoType = \"env\"\n\tAuthInfoTypeGhCli AuthInfoType = \"gh-cli\"\n\tAuthInfoTypeHmac AuthInfoType = \"hmac\"\n\tAuthInfoTypeToken AuthInfoType = \"token\"\n)\n\n// Configuration source\n//\n// Configuration source: user, workspace, plugin, or builtin\ntype MCPServerSource string\n\nconst (\n\tMCPServerSourceBuiltin MCPServerSource = \"builtin\"\n\tMCPServerSourceUser MCPServerSource = \"user\"\n\tMCPServerSourcePlugin MCPServerSource = \"plugin\"\n\tMCPServerSourceWorkspace MCPServerSource = \"workspace\"\n)\n\n// Server transport type: stdio, http, sse, or memory (local configs are normalized to stdio)\ntype DiscoveredMCPServerType string\n\nconst (\n\tDiscoveredMCPServerTypeHTTP DiscoveredMCPServerType = \"http\"\n\tDiscoveredMCPServerTypeMemory DiscoveredMCPServerType = \"memory\"\n\tDiscoveredMCPServerTypeSSE DiscoveredMCPServerType = \"sse\"\n\tDiscoveredMCPServerTypeStdio DiscoveredMCPServerType = \"stdio\"\n)\n\n// Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/)\ntype ExtensionSource string\n\nconst (\n\tExtensionSourceUser ExtensionSource = \"user\"\n\tExtensionSourceProject ExtensionSource = \"project\"\n)\n\n// Current status: running, disabled, failed, or starting\ntype ExtensionStatus string\n\nconst (\n\tExtensionStatusDisabled ExtensionStatus = \"disabled\"\n\tExtensionStatusFailed ExtensionStatus = \"failed\"\n\tExtensionStatusRunning ExtensionStatus = \"running\"\n\tExtensionStatusStarting ExtensionStatus = \"starting\"\n)\n\n// Theme variant this icon is intended for\ntype ExternalToolTextResultForLlmContentResourceLinkIconTheme string\n\nconst (\n\tExternalToolTextResultForLlmContentResourceLinkIconThemeDark ExternalToolTextResultForLlmContentResourceLinkIconTheme = \"dark\"\n\tExternalToolTextResultForLlmContentResourceLinkIconThemeLight ExternalToolTextResultForLlmContentResourceLinkIconTheme = \"light\"\n)\n\ntype ExternalToolTextResultForLlmContentType string\n\nconst (\n\tExternalToolTextResultForLlmContentTypeAudio ExternalToolTextResultForLlmContentType = \"audio\"\n\tExternalToolTextResultForLlmContentTypeImage ExternalToolTextResultForLlmContentType = \"image\"\n\tExternalToolTextResultForLlmContentTypeResource ExternalToolTextResultForLlmContentType = \"resource\"\n\tExternalToolTextResultForLlmContentTypeResourceLink ExternalToolTextResultForLlmContentType = \"resource_link\"\n\tExternalToolTextResultForLlmContentTypeTerminal ExternalToolTextResultForLlmContentType = \"terminal\"\n\tExternalToolTextResultForLlmContentTypeText ExternalToolTextResultForLlmContentType = \"text\"\n)\n\ntype ExternalToolTextResultForLlmContentAudioType string\n\nconst (\n\tExternalToolTextResultForLlmContentAudioTypeAudio ExternalToolTextResultForLlmContentAudioType = \"audio\"\n)\n\ntype ExternalToolTextResultForLlmContentImageType string\n\nconst (\n\tExternalToolTextResultForLlmContentImageTypeImage ExternalToolTextResultForLlmContentImageType = \"image\"\n)\n\ntype ExternalToolTextResultForLlmContentResourceType string\n\nconst (\n\tExternalToolTextResultForLlmContentResourceTypeResource ExternalToolTextResultForLlmContentResourceType = \"resource\"\n)\n\ntype ExternalToolTextResultForLlmContentResourceLinkType string\n\nconst (\n\tExternalToolTextResultForLlmContentResourceLinkTypeResourceLink ExternalToolTextResultForLlmContentResourceLinkType = \"resource_link\"\n)\n\ntype ExternalToolTextResultForLlmContentTerminalType string\n\nconst (\n\tExternalToolTextResultForLlmContentTerminalTypeTerminal ExternalToolTextResultForLlmContentTerminalType = \"terminal\"\n)\n\ntype ExternalToolTextResultForLlmContentTextType string\n\nconst (\n\tExternalToolTextResultForLlmContentTextTypeText ExternalToolTextResultForLlmContentTextType = \"text\"\n)\n\ntype FilterMappingString string\n\nconst (\n\tFilterMappingStringHiddenCharacters FilterMappingString = \"hidden_characters\"\n\tFilterMappingStringMarkdown FilterMappingString = \"markdown\"\n\tFilterMappingStringNone FilterMappingString = \"none\"\n)\n\n// Where this source lives — used for UI grouping\ntype InstructionsSourcesLocation string\n\nconst (\n\tInstructionsSourcesLocationUser InstructionsSourcesLocation = \"user\"\n\tInstructionsSourcesLocationRepository InstructionsSourcesLocation = \"repository\"\n\tInstructionsSourcesLocationWorkingDirectory InstructionsSourcesLocation = \"working-directory\"\n)\n\n// Category of instruction source — used for merge logic\ntype InstructionsSourcesType string\n\nconst (\n\tInstructionsSourcesTypeChildInstructions InstructionsSourcesType = \"child-instructions\"\n\tInstructionsSourcesTypeHome InstructionsSourcesType = \"home\"\n\tInstructionsSourcesTypeModel InstructionsSourcesType = \"model\"\n\tInstructionsSourcesTypeNestedAgents InstructionsSourcesType = \"nested-agents\"\n\tInstructionsSourcesTypeRepo InstructionsSourcesType = \"repo\"\n\tInstructionsSourcesTypeVscode InstructionsSourcesType = \"vscode\"\n)\n\n// Log severity level. Determines how the message is displayed in the timeline. Defaults to\n// \"info\".\ntype SessionLogLevel string\n\nconst (\n\tSessionLogLevelError SessionLogLevel = \"error\"\n\tSessionLogLevelInfo SessionLogLevel = \"info\"\n\tSessionLogLevelWarning SessionLogLevel = \"warning\"\n)\n\ntype MCPServerConfigHTTPOauthGrantType string\n\nconst (\n\tMCPServerConfigHTTPOauthGrantTypeAuthorizationCode MCPServerConfigHTTPOauthGrantType = \"authorization_code\"\n\tMCPServerConfigHTTPOauthGrantTypeClientCredentials MCPServerConfigHTTPOauthGrantType = \"client_credentials\"\n)\n\n// Remote transport type. Defaults to \"http\" when omitted.\ntype MCPServerConfigType string\n\nconst (\n\tMCPServerConfigTypeHTTP MCPServerConfigType = \"http\"\n\tMCPServerConfigTypeLocal MCPServerConfigType = \"local\"\n\tMCPServerConfigTypeSSE MCPServerConfigType = \"sse\"\n\tMCPServerConfigTypeStdio MCPServerConfigType = \"stdio\"\n)\n\n// Connection status: connected, failed, needs-auth, pending, disabled, or not_configured\ntype MCPServerStatus string\n\nconst (\n\tMCPServerStatusConnected MCPServerStatus = \"connected\"\n\tMCPServerStatusDisabled MCPServerStatus = \"disabled\"\n\tMCPServerStatusFailed MCPServerStatus = \"failed\"\n\tMCPServerStatusNeedsAuth MCPServerStatus = \"needs-auth\"\n\tMCPServerStatusNotConfigured MCPServerStatus = \"not_configured\"\n\tMCPServerStatusPending MCPServerStatus = \"pending\"\n)\n\n// Remote transport type. Defaults to \"http\" when omitted.\ntype MCPServerConfigHTTPType string\n\nconst (\n\tMCPServerConfigHTTPTypeHTTP MCPServerConfigHTTPType = \"http\"\n\tMCPServerConfigHTTPTypeSSE MCPServerConfigHTTPType = \"sse\"\n)\n\ntype MCPServerConfigLocalType string\n\nconst (\n\tMCPServerConfigLocalTypeLocal MCPServerConfigLocalType = \"local\"\n\tMCPServerConfigLocalTypeStdio MCPServerConfigLocalType = \"stdio\"\n)\n\n// The agent mode. Valid values: \"interactive\", \"plan\", \"autopilot\".\ntype SessionMode string\n\nconst (\n\tSessionModeAutopilot SessionMode = \"autopilot\"\n\tSessionModeInteractive SessionMode = \"interactive\"\n\tSessionModePlan SessionMode = \"plan\"\n)\n\ntype ApprovalKind string\n\nconst (\n\tApprovalKindCommands ApprovalKind = \"commands\"\n\tApprovalKindCustomTool ApprovalKind = \"custom-tool\"\n\tApprovalKindMcp ApprovalKind = \"mcp\"\n\tApprovalKindMcpSampling ApprovalKind = \"mcp-sampling\"\n\tApprovalKindMemory ApprovalKind = \"memory\"\n\tApprovalKindRead ApprovalKind = \"read\"\n\tApprovalKindWrite ApprovalKind = \"write\"\n)\n\ntype PermissionDecisionKind string\n\nconst (\n\tPermissionDecisionKindApproveForLocation PermissionDecisionKind = \"approve-for-location\"\n\tPermissionDecisionKindApproveForSession PermissionDecisionKind = \"approve-for-session\"\n\tPermissionDecisionKindApproveOnce PermissionDecisionKind = \"approve-once\"\n\tPermissionDecisionKindApprovePermanently PermissionDecisionKind = \"approve-permanently\"\n\tPermissionDecisionKindReject PermissionDecisionKind = \"reject\"\n\tPermissionDecisionKindUserNotAvailable PermissionDecisionKind = \"user-not-available\"\n)\n\ntype PermissionDecisionApproveForLocationKind string\n\nconst (\n\tPermissionDecisionApproveForLocationKindApproveForLocation PermissionDecisionApproveForLocationKind = \"approve-for-location\"\n)\n\ntype PermissionDecisionApproveForLocationApprovalCommandsKind string\n\nconst (\n\tPermissionDecisionApproveForLocationApprovalCommandsKindCommands PermissionDecisionApproveForLocationApprovalCommandsKind = \"commands\"\n)\n\ntype PermissionDecisionApproveForLocationApprovalCustomToolKind string\n\nconst (\n\tPermissionDecisionApproveForLocationApprovalCustomToolKindCustomTool PermissionDecisionApproveForLocationApprovalCustomToolKind = \"custom-tool\"\n)\n\ntype PermissionDecisionApproveForLocationApprovalMCPKind string\n\nconst (\n\tPermissionDecisionApproveForLocationApprovalMCPKindMcp PermissionDecisionApproveForLocationApprovalMCPKind = \"mcp\"\n)\n\ntype PermissionDecisionApproveForLocationApprovalMCPSamplingKind string\n\nconst (\n\tPermissionDecisionApproveForLocationApprovalMCPSamplingKindMcpSampling PermissionDecisionApproveForLocationApprovalMCPSamplingKind = \"mcp-sampling\"\n)\n\ntype PermissionDecisionApproveForLocationApprovalMemoryKind string\n\nconst (\n\tPermissionDecisionApproveForLocationApprovalMemoryKindMemory PermissionDecisionApproveForLocationApprovalMemoryKind = \"memory\"\n)\n\ntype PermissionDecisionApproveForLocationApprovalReadKind string\n\nconst (\n\tPermissionDecisionApproveForLocationApprovalReadKindRead PermissionDecisionApproveForLocationApprovalReadKind = \"read\"\n)\n\ntype PermissionDecisionApproveForLocationApprovalWriteKind string\n\nconst (\n\tPermissionDecisionApproveForLocationApprovalWriteKindWrite PermissionDecisionApproveForLocationApprovalWriteKind = \"write\"\n)\n\ntype PermissionDecisionApproveForSessionKind string\n\nconst (\n\tPermissionDecisionApproveForSessionKindApproveForSession PermissionDecisionApproveForSessionKind = \"approve-for-session\"\n)\n\ntype PermissionDecisionApproveOnceKind string\n\nconst (\n\tPermissionDecisionApproveOnceKindApproveOnce PermissionDecisionApproveOnceKind = \"approve-once\"\n)\n\ntype PermissionDecisionApprovePermanentlyKind string\n\nconst (\n\tPermissionDecisionApprovePermanentlyKindApprovePermanently PermissionDecisionApprovePermanentlyKind = \"approve-permanently\"\n)\n\ntype PermissionDecisionRejectKind string\n\nconst (\n\tPermissionDecisionRejectKindReject PermissionDecisionRejectKind = \"reject\"\n)\n\ntype PermissionDecisionUserNotAvailableKind string\n\nconst (\n\tPermissionDecisionUserNotAvailableKindUserNotAvailable PermissionDecisionUserNotAvailableKind = \"user-not-available\"\n)\n\n// Error classification\ntype SessionFSErrorCode string\n\nconst (\n\tSessionFSErrorCodeENOENT SessionFSErrorCode = \"ENOENT\"\n\tSessionFSErrorCodeUNKNOWN SessionFSErrorCode = \"UNKNOWN\"\n)\n\n// Entry type\ntype SessionFSReaddirWithTypesEntryType string\n\nconst (\n\tSessionFSReaddirWithTypesEntryTypeDirectory SessionFSReaddirWithTypesEntryType = \"directory\"\n\tSessionFSReaddirWithTypesEntryTypeFile SessionFSReaddirWithTypesEntryType = \"file\"\n)\n\n// Path conventions used by this filesystem\ntype SessionFSSetProviderConventions string\n\nconst (\n\tSessionFSSetProviderConventionsPosix SessionFSSetProviderConventions = \"posix\"\n\tSessionFSSetProviderConventionsWindows SessionFSSetProviderConventions = \"windows\"\n)\n\n// Signal to send (default: SIGTERM)\ntype ShellKillSignal string\n\nconst (\n\tShellKillSignalSIGINT ShellKillSignal = \"SIGINT\"\n\tShellKillSignalSIGKILL ShellKillSignal = \"SIGKILL\"\n\tShellKillSignalSIGTERM ShellKillSignal = \"SIGTERM\"\n)\n\n// How the agent is currently being managed by the runtime\n//\n// Whether the shell command is currently sync-waited or background-managed\ntype TaskInfoExecutionMode string\n\nconst (\n\tTaskInfoExecutionModeBackground TaskInfoExecutionMode = \"background\"\n\tTaskInfoExecutionModeSync TaskInfoExecutionMode = \"sync\"\n)\n\n// Current lifecycle status of the task\ntype TaskInfoStatus string\n\nconst (\n\tTaskInfoStatusCancelled TaskInfoStatus = \"cancelled\"\n\tTaskInfoStatusCompleted TaskInfoStatus = \"completed\"\n\tTaskInfoStatusIdle TaskInfoStatus = \"idle\"\n\tTaskInfoStatusFailed TaskInfoStatus = \"failed\"\n\tTaskInfoStatusRunning TaskInfoStatus = \"running\"\n)\n\ntype TaskAgentInfoType string\n\nconst (\n\tTaskAgentInfoTypeAgent TaskAgentInfoType = \"agent\"\n)\n\n// Whether the shell runs inside a managed PTY session or as an independent background\n// process\ntype TaskShellInfoAttachmentMode string\n\nconst (\n\tTaskShellInfoAttachmentModeAttached TaskShellInfoAttachmentMode = \"attached\"\n\tTaskShellInfoAttachmentModeDetached TaskShellInfoAttachmentMode = \"detached\"\n)\n\ntype TaskInfoType string\n\nconst (\n\tTaskInfoTypeAgent TaskInfoType = \"agent\"\n\tTaskInfoTypeShell TaskInfoType = \"shell\"\n)\n\ntype TaskShellInfoType string\n\nconst (\n\tTaskShellInfoTypeShell TaskShellInfoType = \"shell\"\n)\n\ntype UIElicitationArrayAnyOfFieldType string\n\nconst (\n\tUIElicitationArrayAnyOfFieldTypeArray UIElicitationArrayAnyOfFieldType = \"array\"\n)\n\ntype UIElicitationArrayEnumFieldItemsType string\n\nconst (\n\tUIElicitationArrayEnumFieldItemsTypeString UIElicitationArrayEnumFieldItemsType = \"string\"\n)\n\ntype UIElicitationSchemaPropertyStringFormat string\n\nconst (\n\tUIElicitationSchemaPropertyStringFormatDate UIElicitationSchemaPropertyStringFormat = \"date\"\n\tUIElicitationSchemaPropertyStringFormatDateTime UIElicitationSchemaPropertyStringFormat = \"date-time\"\n\tUIElicitationSchemaPropertyStringFormatEmail UIElicitationSchemaPropertyStringFormat = \"email\"\n\tUIElicitationSchemaPropertyStringFormatURI UIElicitationSchemaPropertyStringFormat = \"uri\"\n)\n\ntype UIElicitationSchemaPropertyType string\n\nconst (\n\tUIElicitationSchemaPropertyTypeInteger UIElicitationSchemaPropertyType = \"integer\"\n\tUIElicitationSchemaPropertyTypeNumber UIElicitationSchemaPropertyType = \"number\"\n\tUIElicitationSchemaPropertyTypeArray UIElicitationSchemaPropertyType = \"array\"\n\tUIElicitationSchemaPropertyTypeBoolean UIElicitationSchemaPropertyType = \"boolean\"\n\tUIElicitationSchemaPropertyTypeString UIElicitationSchemaPropertyType = \"string\"\n)\n\ntype UIElicitationSchemaType string\n\nconst (\n\tUIElicitationSchemaTypeObject UIElicitationSchemaType = \"object\"\n)\n\n// The user's response: accept (submitted), decline (rejected), or cancel (dismissed)\ntype UIElicitationResponseAction string\n\nconst (\n\tUIElicitationResponseActionAccept UIElicitationResponseAction = \"accept\"\n\tUIElicitationResponseActionCancel UIElicitationResponseAction = \"cancel\"\n\tUIElicitationResponseActionDecline UIElicitationResponseAction = \"decline\"\n)\n\ntype UIElicitationSchemaPropertyBooleanType string\n\nconst (\n\tUIElicitationSchemaPropertyBooleanTypeBoolean UIElicitationSchemaPropertyBooleanType = \"boolean\"\n)\n\ntype UIElicitationSchemaPropertyNumberTypeEnum string\n\nconst (\n\tUIElicitationSchemaPropertyNumberTypeEnumInteger UIElicitationSchemaPropertyNumberTypeEnum = \"integer\"\n\tUIElicitationSchemaPropertyNumberTypeEnumNumber UIElicitationSchemaPropertyNumberTypeEnum = \"number\"\n)\n\ntype HostType string\n\nconst (\n\tHostTypeAdo HostType = \"ado\"\n\tHostTypeGithub HostType = \"github\"\n)\n\ntype SessionSyncLevel string\n\nconst (\n\tSessionSyncLevelRepoAndUser SessionSyncLevel = \"repo_and_user\"\n\tSessionSyncLevelLocal SessionSyncLevel = \"local\"\n\tSessionSyncLevelUser SessionSyncLevel = \"user\"\n)\n\n// Tool call result (string or expanded result object)\ntype ExternalToolResult struct {\n\tExternalToolTextResultForLlm *ExternalToolTextResultForLlm\n\tString *string\n}\n\ntype FilterMapping struct {\n\tEnum *FilterMappingString\n\tEnumMap map[string]FilterMappingString\n}\n\ntype UIElicitationFieldValue struct {\n\tBool *bool\n\tDouble *float64\n\tString *string\n\tStringArray []string\n}\n\ntype serverApi struct {\n\tclient *jsonrpc2.Client\n}\n\ntype ServerModelsApi serverApi\n\nfunc (a *ServerModelsApi) List(ctx context.Context, params *ModelsListRequest) (*ModelList, error) {\n\traw, err := a.client.Request(\"models.list\", params)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result ModelList\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\ntype ServerToolsApi serverApi\n\nfunc (a *ServerToolsApi) List(ctx context.Context, params *ToolsListRequest) (*ToolList, error) {\n\traw, err := a.client.Request(\"tools.list\", params)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result ToolList\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\ntype ServerAccountApi serverApi\n\nfunc (a *ServerAccountApi) GetQuota(ctx context.Context, params *AccountGetQuotaRequest) (*AccountGetQuotaResult, error) {\n\traw, err := a.client.Request(\"account.getQuota\", params)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result AccountGetQuotaResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\ntype ServerMcpApi serverApi\n\nfunc (a *ServerMcpApi) Discover(ctx context.Context, params *MCPDiscoverRequest) (*MCPDiscoverResult, error) {\n\traw, err := a.client.Request(\"mcp.discover\", params)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result MCPDiscoverResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\ntype ServerMcpConfigApi serverApi\n\nfunc (a *ServerMcpConfigApi) List(ctx context.Context) (*MCPConfigList, error) {\n\traw, err := a.client.Request(\"mcp.config.list\", nil)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result MCPConfigList\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *ServerMcpConfigApi) Add(ctx context.Context, params *MCPConfigAddRequest) (*MCPConfigAddResult, error) {\n\traw, err := a.client.Request(\"mcp.config.add\", params)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result MCPConfigAddResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *ServerMcpConfigApi) Update(ctx context.Context, params *MCPConfigUpdateRequest) (*MCPConfigUpdateResult, error) {\n\traw, err := a.client.Request(\"mcp.config.update\", params)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result MCPConfigUpdateResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *ServerMcpConfigApi) Remove(ctx context.Context, params *MCPConfigRemoveRequest) (*MCPConfigRemoveResult, error) {\n\traw, err := a.client.Request(\"mcp.config.remove\", params)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result MCPConfigRemoveResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *ServerMcpConfigApi) Enable(ctx context.Context, params *MCPConfigEnableRequest) (*MCPConfigEnableResult, error) {\n\traw, err := a.client.Request(\"mcp.config.enable\", params)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result MCPConfigEnableResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *ServerMcpConfigApi) Disable(ctx context.Context, params *MCPConfigDisableRequest) (*MCPConfigDisableResult, error) {\n\traw, err := a.client.Request(\"mcp.config.disable\", params)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result MCPConfigDisableResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (s *ServerMcpApi) Config() *ServerMcpConfigApi {\n\treturn (*ServerMcpConfigApi)(s)\n}\n\ntype ServerSkillsApi serverApi\n\nfunc (a *ServerSkillsApi) Discover(ctx context.Context, params *SkillsDiscoverRequest) (*ServerSkillList, error) {\n\traw, err := a.client.Request(\"skills.discover\", params)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result ServerSkillList\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\ntype ServerSkillsConfigApi serverApi\n\nfunc (a *ServerSkillsConfigApi) SetDisabledSkills(ctx context.Context, params *SkillsConfigSetDisabledSkillsRequest) (*SkillsConfigSetDisabledSkillsResult, error) {\n\traw, err := a.client.Request(\"skills.config.setDisabledSkills\", params)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result SkillsConfigSetDisabledSkillsResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (s *ServerSkillsApi) Config() *ServerSkillsConfigApi {\n\treturn (*ServerSkillsConfigApi)(s)\n}\n\ntype ServerSessionFsApi serverApi\n\nfunc (a *ServerSessionFsApi) SetProvider(ctx context.Context, params *SessionFSSetProviderRequest) (*SessionFSSetProviderResult, error) {\n\traw, err := a.client.Request(\"sessionFs.setProvider\", params)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result SessionFSSetProviderResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\n// Experimental: ServerSessionsApi contains experimental APIs that may change or be removed.\ntype ServerSessionsApi serverApi\n\nfunc (a *ServerSessionsApi) Fork(ctx context.Context, params *SessionsForkRequest) (*SessionsForkResult, error) {\n\traw, err := a.client.Request(\"sessions.fork\", params)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result SessionsForkResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\n// ServerRpc provides typed server-scoped RPC methods.\ntype ServerRpc struct {\n\tcommon serverApi // Reuse a single struct instead of allocating one for each service on the heap.\n\n\tModels *ServerModelsApi\n\tTools *ServerToolsApi\n\tAccount *ServerAccountApi\n\tMcp *ServerMcpApi\n\tSkills *ServerSkillsApi\n\tSessionFs *ServerSessionFsApi\n\tSessions *ServerSessionsApi\n}\n\nfunc (a *ServerRpc) Ping(ctx context.Context, params *PingRequest) (*PingResult, error) {\n\traw, err := a.common.client.Request(\"ping\", params)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result PingResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc NewServerRpc(client *jsonrpc2.Client) *ServerRpc {\n\tr := &ServerRpc{}\n\tr.common = serverApi{client: client}\n\tr.Models = (*ServerModelsApi)(&r.common)\n\tr.Tools = (*ServerToolsApi)(&r.common)\n\tr.Account = (*ServerAccountApi)(&r.common)\n\tr.Mcp = (*ServerMcpApi)(&r.common)\n\tr.Skills = (*ServerSkillsApi)(&r.common)\n\tr.SessionFs = (*ServerSessionFsApi)(&r.common)\n\tr.Sessions = (*ServerSessionsApi)(&r.common)\n\treturn r\n}\n\ntype sessionApi struct {\n\tclient *jsonrpc2.Client\n\tsessionID string\n}\n\ntype AuthApi sessionApi\n\nfunc (a *AuthApi) GetStatus(ctx context.Context) (*SessionAuthStatus, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.auth.getStatus\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result SessionAuthStatus\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\ntype ModelApi sessionApi\n\nfunc (a *ModelApi) GetCurrent(ctx context.Context) (*CurrentModel, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.model.getCurrent\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result CurrentModel\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *ModelApi) SwitchTo(ctx context.Context, params *ModelSwitchToRequest) (*ModelSwitchToResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"modelId\"] = params.ModelID\n\t\tif params.ReasoningEffort != nil {\n\t\t\treq[\"reasoningEffort\"] = *params.ReasoningEffort\n\t\t}\n\t\tif params.ModelCapabilities != nil {\n\t\t\treq[\"modelCapabilities\"] = *params.ModelCapabilities\n\t\t}\n\t}\n\traw, err := a.client.Request(\"session.model.switchTo\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result ModelSwitchToResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\ntype ModeApi sessionApi\n\nfunc (a *ModeApi) Get(ctx context.Context) (*SessionMode, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.mode.get\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result SessionMode\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *ModeApi) Set(ctx context.Context, params *ModeSetRequest) (*ModeSetResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"mode\"] = params.Mode\n\t}\n\traw, err := a.client.Request(\"session.mode.set\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result ModeSetResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\ntype NameApi sessionApi\n\nfunc (a *NameApi) Get(ctx context.Context) (*NameGetResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.name.get\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result NameGetResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *NameApi) Set(ctx context.Context, params *NameSetRequest) (*NameSetResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"name\"] = params.Name\n\t}\n\traw, err := a.client.Request(\"session.name.set\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result NameSetResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\ntype PlanApi sessionApi\n\nfunc (a *PlanApi) Read(ctx context.Context) (*PlanReadResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.plan.read\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result PlanReadResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *PlanApi) Update(ctx context.Context, params *PlanUpdateRequest) (*PlanUpdateResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"content\"] = params.Content\n\t}\n\traw, err := a.client.Request(\"session.plan.update\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result PlanUpdateResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *PlanApi) Delete(ctx context.Context) (*PlanDeleteResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.plan.delete\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result PlanDeleteResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\ntype WorkspacesApi sessionApi\n\nfunc (a *WorkspacesApi) GetWorkspace(ctx context.Context) (*WorkspacesGetWorkspaceResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.workspaces.getWorkspace\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result WorkspacesGetWorkspaceResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *WorkspacesApi) ListFiles(ctx context.Context) (*WorkspacesListFilesResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.workspaces.listFiles\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result WorkspacesListFilesResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *WorkspacesApi) ReadFile(ctx context.Context, params *WorkspacesReadFileRequest) (*WorkspacesReadFileResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"path\"] = params.Path\n\t}\n\traw, err := a.client.Request(\"session.workspaces.readFile\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result WorkspacesReadFileResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *WorkspacesApi) CreateFile(ctx context.Context, params *WorkspacesCreateFileRequest) (*WorkspacesCreateFileResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"path\"] = params.Path\n\t\treq[\"content\"] = params.Content\n\t}\n\traw, err := a.client.Request(\"session.workspaces.createFile\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result WorkspacesCreateFileResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\ntype InstructionsApi sessionApi\n\nfunc (a *InstructionsApi) GetSources(ctx context.Context) (*InstructionsGetSourcesResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.instructions.getSources\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result InstructionsGetSourcesResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\n// Experimental: FleetApi contains experimental APIs that may change or be removed.\ntype FleetApi sessionApi\n\nfunc (a *FleetApi) Start(ctx context.Context, params *FleetStartRequest) (*FleetStartResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\tif params.Prompt != nil {\n\t\t\treq[\"prompt\"] = *params.Prompt\n\t\t}\n\t}\n\traw, err := a.client.Request(\"session.fleet.start\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result FleetStartResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\n// Experimental: AgentApi contains experimental APIs that may change or be removed.\ntype AgentApi sessionApi\n\nfunc (a *AgentApi) List(ctx context.Context) (*AgentList, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.agent.list\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result AgentList\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *AgentApi) GetCurrent(ctx context.Context) (*AgentGetCurrentResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.agent.getCurrent\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result AgentGetCurrentResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *AgentApi) Select(ctx context.Context, params *AgentSelectRequest) (*AgentSelectResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"name\"] = params.Name\n\t}\n\traw, err := a.client.Request(\"session.agent.select\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result AgentSelectResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *AgentApi) Deselect(ctx context.Context) (*AgentDeselectResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.agent.deselect\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result AgentDeselectResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *AgentApi) Reload(ctx context.Context) (*AgentReloadResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.agent.reload\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result AgentReloadResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\n// Experimental: TasksApi contains experimental APIs that may change or be removed.\ntype TasksApi sessionApi\n\nfunc (a *TasksApi) StartAgent(ctx context.Context, params *TasksStartAgentRequest) (*TasksStartAgentResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"agentType\"] = params.AgentType\n\t\treq[\"prompt\"] = params.Prompt\n\t\treq[\"name\"] = params.Name\n\t\tif params.Description != nil {\n\t\t\treq[\"description\"] = *params.Description\n\t\t}\n\t\tif params.Model != nil {\n\t\t\treq[\"model\"] = *params.Model\n\t\t}\n\t}\n\traw, err := a.client.Request(\"session.tasks.startAgent\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result TasksStartAgentResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *TasksApi) List(ctx context.Context) (*TaskList, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.tasks.list\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result TaskList\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *TasksApi) PromoteToBackground(ctx context.Context, params *TasksPromoteToBackgroundRequest) (*TasksPromoteToBackgroundResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"id\"] = params.ID\n\t}\n\traw, err := a.client.Request(\"session.tasks.promoteToBackground\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result TasksPromoteToBackgroundResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *TasksApi) Cancel(ctx context.Context, params *TasksCancelRequest) (*TasksCancelResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"id\"] = params.ID\n\t}\n\traw, err := a.client.Request(\"session.tasks.cancel\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result TasksCancelResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *TasksApi) Remove(ctx context.Context, params *TasksRemoveRequest) (*TasksRemoveResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"id\"] = params.ID\n\t}\n\traw, err := a.client.Request(\"session.tasks.remove\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result TasksRemoveResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\n// Experimental: SkillsApi contains experimental APIs that may change or be removed.\ntype SkillsApi sessionApi\n\nfunc (a *SkillsApi) List(ctx context.Context) (*SkillList, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.skills.list\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result SkillList\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *SkillsApi) Enable(ctx context.Context, params *SkillsEnableRequest) (*SkillsEnableResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"name\"] = params.Name\n\t}\n\traw, err := a.client.Request(\"session.skills.enable\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result SkillsEnableResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *SkillsApi) Disable(ctx context.Context, params *SkillsDisableRequest) (*SkillsDisableResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"name\"] = params.Name\n\t}\n\traw, err := a.client.Request(\"session.skills.disable\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result SkillsDisableResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *SkillsApi) Reload(ctx context.Context) (*SkillsReloadResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.skills.reload\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result SkillsReloadResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\n// Experimental: McpApi contains experimental APIs that may change or be removed.\ntype McpApi sessionApi\n\nfunc (a *McpApi) List(ctx context.Context) (*MCPServerList, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.mcp.list\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result MCPServerList\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *McpApi) Enable(ctx context.Context, params *MCPEnableRequest) (*MCPEnableResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"serverName\"] = params.ServerName\n\t}\n\traw, err := a.client.Request(\"session.mcp.enable\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result MCPEnableResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *McpApi) Disable(ctx context.Context, params *MCPDisableRequest) (*MCPDisableResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"serverName\"] = params.ServerName\n\t}\n\traw, err := a.client.Request(\"session.mcp.disable\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result MCPDisableResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *McpApi) Reload(ctx context.Context) (*MCPReloadResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.mcp.reload\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result MCPReloadResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\n// Experimental: McpOauthApi contains experimental APIs that may change or be removed.\ntype McpOauthApi sessionApi\n\nfunc (a *McpOauthApi) Login(ctx context.Context, params *MCPOauthLoginRequest) (*MCPOauthLoginResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"serverName\"] = params.ServerName\n\t\tif params.ForceReauth != nil {\n\t\t\treq[\"forceReauth\"] = *params.ForceReauth\n\t\t}\n\t\tif params.ClientName != nil {\n\t\t\treq[\"clientName\"] = *params.ClientName\n\t\t}\n\t\tif params.CallbackSuccessMessage != nil {\n\t\t\treq[\"callbackSuccessMessage\"] = *params.CallbackSuccessMessage\n\t\t}\n\t}\n\traw, err := a.client.Request(\"session.mcp.oauth.login\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result MCPOauthLoginResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\n// Experimental: Oauth returns experimental APIs that may change or be removed.\nfunc (s *McpApi) Oauth() *McpOauthApi {\n\treturn (*McpOauthApi)(s)\n}\n\n// Experimental: PluginsApi contains experimental APIs that may change or be removed.\ntype PluginsApi sessionApi\n\nfunc (a *PluginsApi) List(ctx context.Context) (*PluginList, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.plugins.list\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result PluginList\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\n// Experimental: ExtensionsApi contains experimental APIs that may change or be removed.\ntype ExtensionsApi sessionApi\n\nfunc (a *ExtensionsApi) List(ctx context.Context) (*ExtensionList, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.extensions.list\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result ExtensionList\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *ExtensionsApi) Enable(ctx context.Context, params *ExtensionsEnableRequest) (*ExtensionsEnableResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"id\"] = params.ID\n\t}\n\traw, err := a.client.Request(\"session.extensions.enable\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result ExtensionsEnableResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *ExtensionsApi) Disable(ctx context.Context, params *ExtensionsDisableRequest) (*ExtensionsDisableResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"id\"] = params.ID\n\t}\n\traw, err := a.client.Request(\"session.extensions.disable\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result ExtensionsDisableResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *ExtensionsApi) Reload(ctx context.Context) (*ExtensionsReloadResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.extensions.reload\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result ExtensionsReloadResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\ntype ToolsApi sessionApi\n\nfunc (a *ToolsApi) HandlePendingToolCall(ctx context.Context, params *HandlePendingToolCallRequest) (*HandlePendingToolCallResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"requestId\"] = params.RequestID\n\t\tif params.Result != nil {\n\t\t\treq[\"result\"] = *params.Result\n\t\t}\n\t\tif params.Error != nil {\n\t\t\treq[\"error\"] = *params.Error\n\t\t}\n\t}\n\traw, err := a.client.Request(\"session.tools.handlePendingToolCall\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result HandlePendingToolCallResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\ntype CommandsApi sessionApi\n\nfunc (a *CommandsApi) HandlePendingCommand(ctx context.Context, params *CommandsHandlePendingCommandRequest) (*CommandsHandlePendingCommandResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"requestId\"] = params.RequestID\n\t\tif params.Error != nil {\n\t\t\treq[\"error\"] = *params.Error\n\t\t}\n\t}\n\traw, err := a.client.Request(\"session.commands.handlePendingCommand\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result CommandsHandlePendingCommandResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\ntype UIApi sessionApi\n\nfunc (a *UIApi) Elicitation(ctx context.Context, params *UIElicitationRequest) (*UIElicitationResponse, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"message\"] = params.Message\n\t\treq[\"requestedSchema\"] = params.RequestedSchema\n\t}\n\traw, err := a.client.Request(\"session.ui.elicitation\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result UIElicitationResponse\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *UIApi) HandlePendingElicitation(ctx context.Context, params *UIHandlePendingElicitationRequest) (*UIElicitationResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"requestId\"] = params.RequestID\n\t\treq[\"result\"] = params.Result\n\t}\n\traw, err := a.client.Request(\"session.ui.handlePendingElicitation\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result UIElicitationResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\ntype PermissionsApi sessionApi\n\nfunc (a *PermissionsApi) HandlePendingPermissionRequest(ctx context.Context, params *PermissionDecisionRequest) (*PermissionRequestResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"requestId\"] = params.RequestID\n\t\treq[\"result\"] = params.Result\n\t}\n\traw, err := a.client.Request(\"session.permissions.handlePendingPermissionRequest\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result PermissionRequestResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *PermissionsApi) SetApproveAll(ctx context.Context, params *PermissionsSetApproveAllRequest) (*PermissionsSetApproveAllResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"enabled\"] = params.Enabled\n\t}\n\traw, err := a.client.Request(\"session.permissions.setApproveAll\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result PermissionsSetApproveAllResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *PermissionsApi) ResetSessionApprovals(ctx context.Context) (*PermissionsResetSessionApprovalsResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.permissions.resetSessionApprovals\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result PermissionsResetSessionApprovalsResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\ntype ShellApi sessionApi\n\nfunc (a *ShellApi) Exec(ctx context.Context, params *ShellExecRequest) (*ShellExecResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"command\"] = params.Command\n\t\tif params.Cwd != nil {\n\t\t\treq[\"cwd\"] = *params.Cwd\n\t\t}\n\t\tif params.Timeout != nil {\n\t\t\treq[\"timeout\"] = *params.Timeout\n\t\t}\n\t}\n\traw, err := a.client.Request(\"session.shell.exec\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result ShellExecResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *ShellApi) Kill(ctx context.Context, params *ShellKillRequest) (*ShellKillResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"processId\"] = params.ProcessID\n\t\tif params.Signal != nil {\n\t\t\treq[\"signal\"] = *params.Signal\n\t\t}\n\t}\n\traw, err := a.client.Request(\"session.shell.kill\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result ShellKillResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\n// Experimental: HistoryApi contains experimental APIs that may change or be removed.\ntype HistoryApi sessionApi\n\nfunc (a *HistoryApi) Compact(ctx context.Context) (*HistoryCompactResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.history.compact\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result HistoryCompactResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *HistoryApi) Truncate(ctx context.Context, params *HistoryTruncateRequest) (*HistoryTruncateResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\tif params != nil {\n\t\treq[\"eventId\"] = params.EventID\n\t}\n\traw, err := a.client.Request(\"session.history.truncate\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result HistoryTruncateResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\n// Experimental: UsageApi contains experimental APIs that may change or be removed.\ntype UsageApi sessionApi\n\nfunc (a *UsageApi) GetMetrics(ctx context.Context) (*UsageGetMetricsResult, error) {\n\treq := map[string]any{\"sessionId\": a.sessionID}\n\traw, err := a.client.Request(\"session.usage.getMetrics\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result UsageGetMetricsResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\n// SessionRpc provides typed session-scoped RPC methods.\ntype SessionRpc struct {\n\tcommon sessionApi // Reuse a single struct instead of allocating one for each service on the heap.\n\n\tAuth *AuthApi\n\tModel *ModelApi\n\tMode *ModeApi\n\tName *NameApi\n\tPlan *PlanApi\n\tWorkspaces *WorkspacesApi\n\tInstructions *InstructionsApi\n\tFleet *FleetApi\n\tAgent *AgentApi\n\tTasks *TasksApi\n\tSkills *SkillsApi\n\tMcp *McpApi\n\tPlugins *PluginsApi\n\tExtensions *ExtensionsApi\n\tTools *ToolsApi\n\tCommands *CommandsApi\n\tUI *UIApi\n\tPermissions *PermissionsApi\n\tShell *ShellApi\n\tHistory *HistoryApi\n\tUsage *UsageApi\n}\n\nfunc (a *SessionRpc) Suspend(ctx context.Context) (*SuspendResult, error) {\n\treq := map[string]any{\"sessionId\": a.common.sessionID}\n\traw, err := a.common.client.Request(\"session.suspend\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result SuspendResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc (a *SessionRpc) Log(ctx context.Context, params *LogRequest) (*LogResult, error) {\n\treq := map[string]any{\"sessionId\": a.common.sessionID}\n\tif params != nil {\n\t\treq[\"message\"] = params.Message\n\t\tif params.Level != nil {\n\t\t\treq[\"level\"] = *params.Level\n\t\t}\n\t\tif params.Ephemeral != nil {\n\t\t\treq[\"ephemeral\"] = *params.Ephemeral\n\t\t}\n\t\tif params.URL != nil {\n\t\t\treq[\"url\"] = *params.URL\n\t\t}\n\t}\n\traw, err := a.common.client.Request(\"session.log\", req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar result LogResult\n\tif err := json.Unmarshal(raw, &result); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &result, nil\n}\n\nfunc NewSessionRpc(client *jsonrpc2.Client, sessionID string) *SessionRpc {\n\tr := &SessionRpc{}\n\tr.common = sessionApi{client: client, sessionID: sessionID}\n\tr.Auth = (*AuthApi)(&r.common)\n\tr.Model = (*ModelApi)(&r.common)\n\tr.Mode = (*ModeApi)(&r.common)\n\tr.Name = (*NameApi)(&r.common)\n\tr.Plan = (*PlanApi)(&r.common)\n\tr.Workspaces = (*WorkspacesApi)(&r.common)\n\tr.Instructions = (*InstructionsApi)(&r.common)\n\tr.Fleet = (*FleetApi)(&r.common)\n\tr.Agent = (*AgentApi)(&r.common)\n\tr.Tasks = (*TasksApi)(&r.common)\n\tr.Skills = (*SkillsApi)(&r.common)\n\tr.Mcp = (*McpApi)(&r.common)\n\tr.Plugins = (*PluginsApi)(&r.common)\n\tr.Extensions = (*ExtensionsApi)(&r.common)\n\tr.Tools = (*ToolsApi)(&r.common)\n\tr.Commands = (*CommandsApi)(&r.common)\n\tr.UI = (*UIApi)(&r.common)\n\tr.Permissions = (*PermissionsApi)(&r.common)\n\tr.Shell = (*ShellApi)(&r.common)\n\tr.History = (*HistoryApi)(&r.common)\n\tr.Usage = (*UsageApi)(&r.common)\n\treturn r\n}\n\ntype SessionFsHandler interface {\n\tReadFile(request *SessionFSReadFileRequest) (*SessionFSReadFileResult, error)\n\tWriteFile(request *SessionFSWriteFileRequest) (*SessionFSError, error)\n\tAppendFile(request *SessionFSAppendFileRequest) (*SessionFSError, error)\n\tExists(request *SessionFSExistsRequest) (*SessionFSExistsResult, error)\n\tStat(request *SessionFSStatRequest) (*SessionFSStatResult, error)\n\tMkdir(request *SessionFSMkdirRequest) (*SessionFSError, error)\n\tReaddir(request *SessionFSReaddirRequest) (*SessionFSReaddirResult, error)\n\tReaddirWithTypes(request *SessionFSReaddirWithTypesRequest) (*SessionFSReaddirWithTypesResult, error)\n\tRm(request *SessionFSRmRequest) (*SessionFSError, error)\n\tRename(request *SessionFSRenameRequest) (*SessionFSError, error)\n}\n\n// ClientSessionApiHandlers provides all client session API handler groups for a session.\ntype ClientSessionApiHandlers struct {\n\tSessionFs SessionFsHandler\n}\n\nfunc clientSessionHandlerError(err error) *jsonrpc2.Error {\n\tif err == nil {\n\t\treturn nil\n\t}\n\tvar rpcErr *jsonrpc2.Error\n\tif errors.As(err, &rpcErr) {\n\t\treturn rpcErr\n\t}\n\treturn &jsonrpc2.Error{Code: -32603, Message: err.Error()}\n}\n\n// RegisterClientSessionApiHandlers registers handlers for server-to-client session API calls.\nfunc RegisterClientSessionApiHandlers(client *jsonrpc2.Client, getHandlers func(sessionID string) *ClientSessionApiHandlers) {\n\tclient.SetRequestHandler(\"sessionFs.readFile\", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) {\n\t\tvar request SessionFSReadFileRequest\n\t\tif err := json.Unmarshal(params, &request); err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf(\"Invalid params: %v\", err)}\n\t\t}\n\t\thandlers := getHandlers(request.SessionID)\n\t\tif handlers == nil || handlers.SessionFs == nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"No sessionFs handler registered for session: %s\", request.SessionID)}\n\t\t}\n\t\tresult, err := handlers.SessionFs.ReadFile(&request)\n\t\tif err != nil {\n\t\t\treturn nil, clientSessionHandlerError(err)\n\t\t}\n\t\traw, err := json.Marshal(result)\n\t\tif err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"Failed to marshal response: %v\", err)}\n\t\t}\n\t\treturn raw, nil\n\t})\n\tclient.SetRequestHandler(\"sessionFs.writeFile\", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) {\n\t\tvar request SessionFSWriteFileRequest\n\t\tif err := json.Unmarshal(params, &request); err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf(\"Invalid params: %v\", err)}\n\t\t}\n\t\thandlers := getHandlers(request.SessionID)\n\t\tif handlers == nil || handlers.SessionFs == nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"No sessionFs handler registered for session: %s\", request.SessionID)}\n\t\t}\n\t\tresult, err := handlers.SessionFs.WriteFile(&request)\n\t\tif err != nil {\n\t\t\treturn nil, clientSessionHandlerError(err)\n\t\t}\n\t\traw, err := json.Marshal(result)\n\t\tif err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"Failed to marshal response: %v\", err)}\n\t\t}\n\t\treturn raw, nil\n\t})\n\tclient.SetRequestHandler(\"sessionFs.appendFile\", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) {\n\t\tvar request SessionFSAppendFileRequest\n\t\tif err := json.Unmarshal(params, &request); err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf(\"Invalid params: %v\", err)}\n\t\t}\n\t\thandlers := getHandlers(request.SessionID)\n\t\tif handlers == nil || handlers.SessionFs == nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"No sessionFs handler registered for session: %s\", request.SessionID)}\n\t\t}\n\t\tresult, err := handlers.SessionFs.AppendFile(&request)\n\t\tif err != nil {\n\t\t\treturn nil, clientSessionHandlerError(err)\n\t\t}\n\t\traw, err := json.Marshal(result)\n\t\tif err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"Failed to marshal response: %v\", err)}\n\t\t}\n\t\treturn raw, nil\n\t})\n\tclient.SetRequestHandler(\"sessionFs.exists\", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) {\n\t\tvar request SessionFSExistsRequest\n\t\tif err := json.Unmarshal(params, &request); err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf(\"Invalid params: %v\", err)}\n\t\t}\n\t\thandlers := getHandlers(request.SessionID)\n\t\tif handlers == nil || handlers.SessionFs == nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"No sessionFs handler registered for session: %s\", request.SessionID)}\n\t\t}\n\t\tresult, err := handlers.SessionFs.Exists(&request)\n\t\tif err != nil {\n\t\t\treturn nil, clientSessionHandlerError(err)\n\t\t}\n\t\traw, err := json.Marshal(result)\n\t\tif err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"Failed to marshal response: %v\", err)}\n\t\t}\n\t\treturn raw, nil\n\t})\n\tclient.SetRequestHandler(\"sessionFs.stat\", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) {\n\t\tvar request SessionFSStatRequest\n\t\tif err := json.Unmarshal(params, &request); err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf(\"Invalid params: %v\", err)}\n\t\t}\n\t\thandlers := getHandlers(request.SessionID)\n\t\tif handlers == nil || handlers.SessionFs == nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"No sessionFs handler registered for session: %s\", request.SessionID)}\n\t\t}\n\t\tresult, err := handlers.SessionFs.Stat(&request)\n\t\tif err != nil {\n\t\t\treturn nil, clientSessionHandlerError(err)\n\t\t}\n\t\traw, err := json.Marshal(result)\n\t\tif err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"Failed to marshal response: %v\", err)}\n\t\t}\n\t\treturn raw, nil\n\t})\n\tclient.SetRequestHandler(\"sessionFs.mkdir\", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) {\n\t\tvar request SessionFSMkdirRequest\n\t\tif err := json.Unmarshal(params, &request); err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf(\"Invalid params: %v\", err)}\n\t\t}\n\t\thandlers := getHandlers(request.SessionID)\n\t\tif handlers == nil || handlers.SessionFs == nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"No sessionFs handler registered for session: %s\", request.SessionID)}\n\t\t}\n\t\tresult, err := handlers.SessionFs.Mkdir(&request)\n\t\tif err != nil {\n\t\t\treturn nil, clientSessionHandlerError(err)\n\t\t}\n\t\traw, err := json.Marshal(result)\n\t\tif err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"Failed to marshal response: %v\", err)}\n\t\t}\n\t\treturn raw, nil\n\t})\n\tclient.SetRequestHandler(\"sessionFs.readdir\", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) {\n\t\tvar request SessionFSReaddirRequest\n\t\tif err := json.Unmarshal(params, &request); err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf(\"Invalid params: %v\", err)}\n\t\t}\n\t\thandlers := getHandlers(request.SessionID)\n\t\tif handlers == nil || handlers.SessionFs == nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"No sessionFs handler registered for session: %s\", request.SessionID)}\n\t\t}\n\t\tresult, err := handlers.SessionFs.Readdir(&request)\n\t\tif err != nil {\n\t\t\treturn nil, clientSessionHandlerError(err)\n\t\t}\n\t\traw, err := json.Marshal(result)\n\t\tif err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"Failed to marshal response: %v\", err)}\n\t\t}\n\t\treturn raw, nil\n\t})\n\tclient.SetRequestHandler(\"sessionFs.readdirWithTypes\", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) {\n\t\tvar request SessionFSReaddirWithTypesRequest\n\t\tif err := json.Unmarshal(params, &request); err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf(\"Invalid params: %v\", err)}\n\t\t}\n\t\thandlers := getHandlers(request.SessionID)\n\t\tif handlers == nil || handlers.SessionFs == nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"No sessionFs handler registered for session: %s\", request.SessionID)}\n\t\t}\n\t\tresult, err := handlers.SessionFs.ReaddirWithTypes(&request)\n\t\tif err != nil {\n\t\t\treturn nil, clientSessionHandlerError(err)\n\t\t}\n\t\traw, err := json.Marshal(result)\n\t\tif err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"Failed to marshal response: %v\", err)}\n\t\t}\n\t\treturn raw, nil\n\t})\n\tclient.SetRequestHandler(\"sessionFs.rm\", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) {\n\t\tvar request SessionFSRmRequest\n\t\tif err := json.Unmarshal(params, &request); err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf(\"Invalid params: %v\", err)}\n\t\t}\n\t\thandlers := getHandlers(request.SessionID)\n\t\tif handlers == nil || handlers.SessionFs == nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"No sessionFs handler registered for session: %s\", request.SessionID)}\n\t\t}\n\t\tresult, err := handlers.SessionFs.Rm(&request)\n\t\tif err != nil {\n\t\t\treturn nil, clientSessionHandlerError(err)\n\t\t}\n\t\traw, err := json.Marshal(result)\n\t\tif err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"Failed to marshal response: %v\", err)}\n\t\t}\n\t\treturn raw, nil\n\t})\n\tclient.SetRequestHandler(\"sessionFs.rename\", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) {\n\t\tvar request SessionFSRenameRequest\n\t\tif err := json.Unmarshal(params, &request); err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf(\"Invalid params: %v\", err)}\n\t\t}\n\t\thandlers := getHandlers(request.SessionID)\n\t\tif handlers == nil || handlers.SessionFs == nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"No sessionFs handler registered for session: %s\", request.SessionID)}\n\t\t}\n\t\tresult, err := handlers.SessionFs.Rename(&request)\n\t\tif err != nil {\n\t\t\treturn nil, clientSessionHandlerError(err)\n\t\t}\n\t\traw, err := json.Marshal(result)\n\t\tif err != nil {\n\t\t\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"Failed to marshal response: %v\", err)}\n\t\t}\n\t\treturn raw, nil\n\t})\n}\n" }, { "path": "go/rpc/result_union.go", "content": "package rpc\n\nimport \"encoding/json\"\n\n// MarshalJSON serializes ExternalToolResult as the appropriate JSON variant:\n// a plain string when String is set, or the ExternalToolTextResultForLlm object otherwise.\n// The generated struct has no custom marshaler, so without this the Go\n// struct fields would serialize as {\"ExternalToolTextResultForLlm\":...,\"String\":...}\n// instead of the union the server expects.\nfunc (r ExternalToolResult) MarshalJSON() ([]byte, error) {\n\tif r.String != nil {\n\t\treturn json.Marshal(*r.String)\n\t}\n\tif r.ExternalToolTextResultForLlm != nil {\n\t\treturn json.Marshal(*r.ExternalToolTextResultForLlm)\n\t}\n\treturn []byte(\"null\"), nil\n}\n\n// UnmarshalJSON deserializes a JSON value into the appropriate ExternalToolResult variant.\nfunc (r *ExternalToolResult) UnmarshalJSON(data []byte) error {\n\t// Try string first\n\tvar s string\n\tif err := json.Unmarshal(data, &s); err == nil {\n\t\tr.String = &s\n\t\treturn nil\n\t}\n\t// Try ExternalToolTextResultForLlm object\n\tvar rr ExternalToolTextResultForLlm\n\tif err := json.Unmarshal(data, &rr); err == nil {\n\t\tr.ExternalToolTextResultForLlm = &rr\n\t\treturn nil\n\t}\n\treturn nil\n}\n" }, { "path": "go/samples/chat.go", "content": "package main\n\nimport (\n\t\"bufio\"\n\t\"context\"\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\n\t\"github.com/github/copilot-sdk/go\"\n)\n\nconst blue = \"\\033[34m\"\nconst reset = \"\\033[0m\"\n\nfunc main() {\n\tctx := context.Background()\n\tcliPath := filepath.Join(\"..\", \"..\", \"nodejs\", \"node_modules\", \"@github\", \"copilot\", \"index.js\")\n\tclient := copilot.NewClient(&copilot.ClientOptions{CLIPath: cliPath})\n\tif err := client.Start(ctx); err != nil {\n\t\tpanic(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tCLIPath: cliPath,\n\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t})\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer session.Disconnect()\n\n\tsession.On(func(event copilot.SessionEvent) {\n\t\tvar output string\n\t\tswitch d := event.Data.(type) {\n\t\tcase *copilot.AssistantReasoningData:\n\t\t\toutput = fmt.Sprintf(\"[reasoning: %s]\", d.Content)\n\t\tcase *copilot.ToolExecutionStartData:\n\t\t\toutput = fmt.Sprintf(\"[tool: %s]\", d.ToolName)\n\t\t}\n\t\tif output != \"\" {\n\t\t\tfmt.Printf(\"%s%s%s\\n\", blue, output, reset)\n\t\t}\n\t})\n\n\tfmt.Println(\"Chat with Copilot (Ctrl+C to exit)\\n\")\n\tscanner := bufio.NewScanner(os.Stdin)\n\n\tfor {\n\t\tfmt.Print(\"You: \")\n\t\tif !scanner.Scan() {\n\t\t\tbreak\n\t\t}\n\t\tinput := strings.TrimSpace(scanner.Text())\n\t\tif input == \"\" {\n\t\t\tcontinue\n\t\t}\n\t\tfmt.Println()\n\n\t\treply, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: input})\n\t\tcontent := \"\"\n\t\tif reply != nil {\n\t\t\tif d, ok := reply.Data.(*copilot.AssistantMessageData); ok {\n\t\t\t\tcontent = d.Content\n\t\t\t}\n\t\t}\n\t\tfmt.Printf(\"\\nAssistant: %s\\n\\n\", content)\n\t}\n}\n" }, { "path": "go/samples/go.mod", "content": "module github.com/github/copilot-sdk/go/samples\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire github.com/google/jsonschema-go v0.4.2 // indirect\n\nreplace github.com/github/copilot-sdk/go => ../\n" }, { "path": "go/samples/go.sum", "content": "github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\n" }, { "path": "go/sdk_protocol_version.go", "content": "// Code generated by update-protocol-version.ts. DO NOT EDIT.\n\npackage copilot\n\n// SdkProtocolVersion is the SDK protocol version.\n// This must match the version expected by the copilot-agent-runtime server.\nconst SdkProtocolVersion = 3\n\n// GetSdkProtocolVersion returns the SDK protocol version.\nfunc GetSdkProtocolVersion() int {\n\treturn SdkProtocolVersion\n}\n" }, { "path": "go/session.go", "content": "// Package copilot provides a Go SDK for interacting with the GitHub Copilot CLI.\npackage copilot\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"sync\"\n\t\"time\"\n\n\t\"github.com/github/copilot-sdk/go/internal/jsonrpc2\"\n\t\"github.com/github/copilot-sdk/go/rpc\"\n)\n\ntype sessionHandler struct {\n\tid uint64\n\tfn SessionEventHandler\n}\n\n// Session represents a single conversation session with the Copilot CLI.\n//\n// A session maintains conversation state, handles events, and manages tool execution.\n// Sessions are created via [Client.CreateSession] or resumed via [Client.ResumeSession].\n//\n// The session provides methods to send messages, subscribe to events, retrieve\n// conversation history, and manage the session lifecycle. All methods are safe\n// for concurrent use.\n//\n// Example usage:\n//\n//\tsession, err := client.CreateSession(copilot.SessionConfig{\n//\t Model: \"gpt-4\",\n//\t})\n//\tif err != nil {\n//\t log.Fatal(err)\n//\t}\n//\tdefer session.Disconnect()\n//\n//\t// Subscribe to events\n//\tunsubscribe := session.On(func(event copilot.SessionEvent) {\n//\t if d, ok := event.Data.(*copilot.AssistantMessageData); ok {\n//\t fmt.Println(\"Assistant:\", d.Content)\n//\t }\n//\t})\n//\tdefer unsubscribe()\n//\n//\t// Send a message\n//\tmessageID, err := session.Send(copilot.MessageOptions{\n//\t Prompt: \"Hello, world!\",\n//\t})\ntype Session struct {\n\t// SessionID is the unique identifier for this session.\n\tSessionID string\n\tworkspacePath string\n\tclient *jsonrpc2.Client\n\tclientSessionApis *rpc.ClientSessionApiHandlers\n\thandlers []sessionHandler\n\tnextHandlerID uint64\n\thandlerMutex sync.RWMutex\n\ttoolHandlers map[string]ToolHandler\n\ttoolHandlersM sync.RWMutex\n\tpermissionHandler PermissionHandlerFunc\n\tpermissionMux sync.RWMutex\n\tuserInputHandler UserInputHandler\n\tuserInputMux sync.RWMutex\n\thooks *SessionHooks\n\thooksMux sync.RWMutex\n\ttransformCallbacks map[string]SectionTransformFn\n\ttransformMu sync.Mutex\n\tcommandHandlers map[string]CommandHandler\n\tcommandHandlersMu sync.RWMutex\n\telicitationHandler ElicitationHandler\n\telicitationMu sync.RWMutex\n\tcapabilities SessionCapabilities\n\tcapabilitiesMu sync.RWMutex\n\n\t// eventCh serializes user event handler dispatch. dispatchEvent enqueues;\n\t// a single goroutine (processEvents) dequeues and invokes handlers in FIFO order.\n\teventCh chan SessionEvent\n\tcloseOnce sync.Once // guards eventCh close so Disconnect is safe to call more than once\n\n\t// RPC provides typed session-scoped RPC methods.\n\tRPC *rpc.SessionRpc\n}\n\n// WorkspacePath returns the path to the session workspace directory when infinite\n// sessions are enabled. Contains checkpoints/, plan.md, and files/ subdirectories.\n// Returns empty string if infinite sessions are disabled.\nfunc (s *Session) WorkspacePath() string {\n\treturn s.workspacePath\n}\n\n// newSession creates a new session wrapper with the given session ID and client.\nfunc newSession(sessionID string, client *jsonrpc2.Client, workspacePath string) *Session {\n\ts := &Session{\n\t\tSessionID: sessionID,\n\t\tworkspacePath: workspacePath,\n\t\tclient: client,\n\t\tclientSessionApis: &rpc.ClientSessionApiHandlers{},\n\t\thandlers: make([]sessionHandler, 0),\n\t\ttoolHandlers: make(map[string]ToolHandler),\n\t\tcommandHandlers: make(map[string]CommandHandler),\n\t\teventCh: make(chan SessionEvent, 128),\n\t\tRPC: rpc.NewSessionRpc(client, sessionID),\n\t}\n\tgo s.processEvents()\n\treturn s\n}\n\n// Send sends a message to this session and waits for the response.\n//\n// The message is processed asynchronously. Subscribe to events via [Session.On]\n// to receive streaming responses and other session events.\n//\n// Parameters:\n// - options: The message options including the prompt and optional attachments.\n//\n// Returns the message ID of the response, which can be used to correlate events,\n// or an error if the session has been disconnected or the connection fails.\n//\n// Example:\n//\n//\tmessageID, err := session.Send(context.Background(), copilot.MessageOptions{\n//\t Prompt: \"Explain this code\",\n//\t Attachments: []copilot.Attachment{\n//\t {Type: \"file\", Path: \"./main.go\"},\n//\t },\n//\t})\n//\tif err != nil {\n//\t log.Printf(\"Failed to send message: %v\", err)\n//\t}\nfunc (s *Session) Send(ctx context.Context, options MessageOptions) (string, error) {\n\ttraceparent, tracestate := getTraceContext(ctx)\n\treq := sessionSendRequest{\n\t\tSessionID: s.SessionID,\n\t\tPrompt: options.Prompt,\n\t\tAttachments: options.Attachments,\n\t\tMode: options.Mode,\n\t\tTraceparent: traceparent,\n\t\tTracestate: tracestate,\n\t\tRequestHeaders: options.RequestHeaders,\n\t}\n\n\tresult, err := s.client.Request(\"session.send\", req)\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to send message: %w\", err)\n\t}\n\n\tvar response sessionSendResponse\n\tif err := json.Unmarshal(result, &response); err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to unmarshal send response: %w\", err)\n\t}\n\treturn response.MessageID, nil\n}\n\n// SendAndWait sends a message to this session and waits until the session becomes idle.\n//\n// This is a convenience method that combines [Session.Send] with waiting for\n// the session.idle event. Use this when you want to block until the assistant\n// has finished processing the message.\n//\n// Events are still delivered to handlers registered via [Session.On] while waiting.\n//\n// Parameters:\n// - options: The message options including the prompt and optional attachments.\n// - timeout: How long to wait for completion. Defaults to 60 seconds if zero.\n// Controls how long to wait; does not abort in-flight agent work.\n//\n// Returns the final assistant message event, or nil if none was received.\n// Returns an error if the timeout is reached or the connection fails.\n//\n// Example:\n//\n//\tresponse, err := session.SendAndWait(context.Background(), copilot.MessageOptions{\n//\t Prompt: \"What is 2+2?\",\n//\t}) // Use default 60s timeout\n//\tif err != nil {\n//\t log.Printf(\"Failed: %v\", err)\n//\t}\n//\tif response != nil {\n//\t if d, ok := response.Data.(*AssistantMessageData); ok {\n//\t fmt.Println(d.Content)\n//\t }\n//\t}\nfunc (s *Session) SendAndWait(ctx context.Context, options MessageOptions) (*SessionEvent, error) {\n\tif _, ok := ctx.Deadline(); !ok {\n\t\tvar cancel context.CancelFunc\n\t\tctx, cancel = context.WithTimeout(ctx, 60*time.Second)\n\t\tdefer cancel()\n\t}\n\n\tidleCh := make(chan struct{}, 1)\n\terrCh := make(chan error, 1)\n\tvar lastAssistantMessage *SessionEvent\n\tvar mu sync.Mutex\n\n\tunsubscribe := s.On(func(event SessionEvent) {\n\t\tswitch d := event.Data.(type) {\n\t\tcase *AssistantMessageData:\n\t\t\tmu.Lock()\n\t\t\teventCopy := event\n\t\t\tlastAssistantMessage = &eventCopy\n\t\t\tmu.Unlock()\n\t\tcase *SessionIdleData:\n\t\t\tselect {\n\t\t\tcase idleCh <- struct{}{}:\n\t\t\tdefault:\n\t\t\t}\n\t\tcase *SessionErrorData:\n\t\t\tselect {\n\t\t\tcase errCh <- fmt.Errorf(\"session error: %s\", d.Message):\n\t\t\tdefault:\n\t\t\t}\n\t\t}\n\t})\n\tdefer unsubscribe()\n\n\t_, err := s.Send(ctx, options)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tselect {\n\tcase <-idleCh:\n\t\tmu.Lock()\n\t\tresult := lastAssistantMessage\n\t\tmu.Unlock()\n\t\treturn result, nil\n\tcase err := <-errCh:\n\t\treturn nil, err\n\tcase <-ctx.Done(): // TODO: remove once session.Send honors the context\n\t\treturn nil, fmt.Errorf(\"waiting for session.idle: %w\", ctx.Err())\n\t}\n}\n\n// On subscribes to events from this session.\n//\n// Events include assistant messages, tool executions, errors, and session state\n// changes. Multiple handlers can be registered and will all receive events.\n// Handlers are called synchronously in the order they were registered.\n//\n// The returned function can be called to unsubscribe the handler. It is safe\n// to call the unsubscribe function multiple times.\n//\n// Example:\n//\n//\tunsubscribe := session.On(func(event copilot.SessionEvent) {\n//\t switch d := event.Data.(type) {\n//\t case *copilot.AssistantMessageData:\n//\t fmt.Println(\"Assistant:\", d.Content)\n//\t case *copilot.SessionErrorData:\n//\t fmt.Println(\"Error:\", d.Message)\n//\t }\n//\t})\n//\n//\t// Later, to stop receiving events:\n//\tunsubscribe()\nfunc (s *Session) On(handler SessionEventHandler) func() {\n\ts.handlerMutex.Lock()\n\tdefer s.handlerMutex.Unlock()\n\n\tid := s.nextHandlerID\n\ts.nextHandlerID++\n\ts.handlers = append(s.handlers, sessionHandler{id: id, fn: handler})\n\n\t// Return unsubscribe function\n\treturn func() {\n\t\ts.handlerMutex.Lock()\n\t\tdefer s.handlerMutex.Unlock()\n\n\t\tfor i, h := range s.handlers {\n\t\t\tif h.id == id {\n\t\t\t\ts.handlers = append(s.handlers[:i], s.handlers[i+1:]...)\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t}\n}\n\n// registerTools registers tool handlers for this session.\n//\n// Tools allow the assistant to execute custom functions. When the assistant\n// invokes a tool, the corresponding handler is called with the tool arguments.\n//\n// This method is internal and typically called when creating a session with tools.\nfunc (s *Session) registerTools(tools []Tool) {\n\ts.toolHandlersM.Lock()\n\tdefer s.toolHandlersM.Unlock()\n\n\ts.toolHandlers = make(map[string]ToolHandler)\n\tfor _, tool := range tools {\n\t\tif tool.Name == \"\" || tool.Handler == nil {\n\t\t\tcontinue\n\t\t}\n\t\ts.toolHandlers[tool.Name] = tool.Handler\n\t}\n}\n\n// getToolHandler retrieves a registered tool handler by name.\n// Returns the handler and true if found, or nil and false if not registered.\nfunc (s *Session) getToolHandler(name string) (ToolHandler, bool) {\n\ts.toolHandlersM.RLock()\n\thandler, ok := s.toolHandlers[name]\n\ts.toolHandlersM.RUnlock()\n\treturn handler, ok\n}\n\n// registerPermissionHandler registers a permission handler for this session.\n//\n// When the assistant needs permission to perform certain actions (e.g., file\n// operations), this handler is called to approve or deny the request.\n//\n// This method is internal and typically called when creating a session.\nfunc (s *Session) registerPermissionHandler(handler PermissionHandlerFunc) {\n\ts.permissionMux.Lock()\n\tdefer s.permissionMux.Unlock()\n\ts.permissionHandler = handler\n}\n\n// getPermissionHandler returns the currently registered permission handler, or nil.\nfunc (s *Session) getPermissionHandler() PermissionHandlerFunc {\n\ts.permissionMux.RLock()\n\tdefer s.permissionMux.RUnlock()\n\treturn s.permissionHandler\n}\n\n// registerUserInputHandler registers a user input handler for this session.\n//\n// When the assistant needs to ask the user a question (e.g., via ask_user tool),\n// this handler is called to get the user's response.\n//\n// This method is internal and typically called when creating a session.\nfunc (s *Session) registerUserInputHandler(handler UserInputHandler) {\n\ts.userInputMux.Lock()\n\tdefer s.userInputMux.Unlock()\n\ts.userInputHandler = handler\n}\n\n// getUserInputHandler returns the currently registered user input handler, or nil.\nfunc (s *Session) getUserInputHandler() UserInputHandler {\n\ts.userInputMux.RLock()\n\tdefer s.userInputMux.RUnlock()\n\treturn s.userInputHandler\n}\n\n// handleUserInputRequest handles a user input request from the Copilot CLI.\n// This is an internal method called by the SDK when the CLI requests user input.\nfunc (s *Session) handleUserInputRequest(request UserInputRequest) (UserInputResponse, error) {\n\thandler := s.getUserInputHandler()\n\n\tif handler == nil {\n\t\treturn UserInputResponse{}, fmt.Errorf(\"no user input handler registered\")\n\t}\n\n\tinvocation := UserInputInvocation{\n\t\tSessionID: s.SessionID,\n\t}\n\n\treturn handler(request, invocation)\n}\n\n// registerHooks registers hook handlers for this session.\n//\n// Hooks are called at various points during session execution to allow\n// customization and observation of the session lifecycle.\n//\n// This method is internal and typically called when creating a session.\nfunc (s *Session) registerHooks(hooks *SessionHooks) {\n\ts.hooksMux.Lock()\n\tdefer s.hooksMux.Unlock()\n\ts.hooks = hooks\n}\n\n// getHooks returns the currently registered hooks, or nil.\nfunc (s *Session) getHooks() *SessionHooks {\n\ts.hooksMux.RLock()\n\tdefer s.hooksMux.RUnlock()\n\treturn s.hooks\n}\n\n// handleHooksInvoke handles a hook invocation from the Copilot CLI.\n// This is an internal method called by the SDK when the CLI invokes a hook.\nfunc (s *Session) handleHooksInvoke(hookType string, rawInput json.RawMessage) (any, error) {\n\thooks := s.getHooks()\n\n\tif hooks == nil {\n\t\treturn nil, nil\n\t}\n\n\tinvocation := HookInvocation{\n\t\tSessionID: s.SessionID,\n\t}\n\n\tswitch hookType {\n\tcase \"preToolUse\":\n\t\tif hooks.OnPreToolUse == nil {\n\t\t\treturn nil, nil\n\t\t}\n\t\tvar input PreToolUseHookInput\n\t\tif err := json.Unmarshal(rawInput, &input); err != nil {\n\t\t\treturn nil, fmt.Errorf(\"invalid hook input: %w\", err)\n\t\t}\n\t\treturn hooks.OnPreToolUse(input, invocation)\n\n\tcase \"postToolUse\":\n\t\tif hooks.OnPostToolUse == nil {\n\t\t\treturn nil, nil\n\t\t}\n\t\tvar input PostToolUseHookInput\n\t\tif err := json.Unmarshal(rawInput, &input); err != nil {\n\t\t\treturn nil, fmt.Errorf(\"invalid hook input: %w\", err)\n\t\t}\n\t\treturn hooks.OnPostToolUse(input, invocation)\n\n\tcase \"userPromptSubmitted\":\n\t\tif hooks.OnUserPromptSubmitted == nil {\n\t\t\treturn nil, nil\n\t\t}\n\t\tvar input UserPromptSubmittedHookInput\n\t\tif err := json.Unmarshal(rawInput, &input); err != nil {\n\t\t\treturn nil, fmt.Errorf(\"invalid hook input: %w\", err)\n\t\t}\n\t\treturn hooks.OnUserPromptSubmitted(input, invocation)\n\n\tcase \"sessionStart\":\n\t\tif hooks.OnSessionStart == nil {\n\t\t\treturn nil, nil\n\t\t}\n\t\tvar input SessionStartHookInput\n\t\tif err := json.Unmarshal(rawInput, &input); err != nil {\n\t\t\treturn nil, fmt.Errorf(\"invalid hook input: %w\", err)\n\t\t}\n\t\treturn hooks.OnSessionStart(input, invocation)\n\n\tcase \"sessionEnd\":\n\t\tif hooks.OnSessionEnd == nil {\n\t\t\treturn nil, nil\n\t\t}\n\t\tvar input SessionEndHookInput\n\t\tif err := json.Unmarshal(rawInput, &input); err != nil {\n\t\t\treturn nil, fmt.Errorf(\"invalid hook input: %w\", err)\n\t\t}\n\t\treturn hooks.OnSessionEnd(input, invocation)\n\n\tcase \"errorOccurred\":\n\t\tif hooks.OnErrorOccurred == nil {\n\t\t\treturn nil, nil\n\t\t}\n\t\tvar input ErrorOccurredHookInput\n\t\tif err := json.Unmarshal(rawInput, &input); err != nil {\n\t\t\treturn nil, fmt.Errorf(\"invalid hook input: %w\", err)\n\t\t}\n\t\treturn hooks.OnErrorOccurred(input, invocation)\n\tdefault:\n\t\treturn nil, nil\n\t}\n}\n\n// registerTransformCallbacks registers transform callbacks for this session.\n//\n// Transform callbacks are invoked when the CLI requests system message section\n// transforms. This method is internal and typically called when creating a session.\nfunc (s *Session) registerTransformCallbacks(callbacks map[string]SectionTransformFn) {\n\ts.transformMu.Lock()\n\tdefer s.transformMu.Unlock()\n\ts.transformCallbacks = callbacks\n}\n\ntype systemMessageTransformSection struct {\n\tContent string `json:\"content\"`\n}\n\ntype systemMessageTransformRequest struct {\n\tSessionID string `json:\"sessionId\"`\n\tSections map[string]systemMessageTransformSection `json:\"sections\"`\n}\n\ntype systemMessageTransformResponse struct {\n\tSections map[string]systemMessageTransformSection `json:\"sections\"`\n}\n\n// handleSystemMessageTransform handles a system message transform request from the Copilot CLI.\n// This is an internal method called by the SDK when the CLI requests section transforms.\nfunc (s *Session) handleSystemMessageTransform(sections map[string]systemMessageTransformSection) (systemMessageTransformResponse, error) {\n\ts.transformMu.Lock()\n\tcallbacks := s.transformCallbacks\n\ts.transformMu.Unlock()\n\n\tresult := make(map[string]systemMessageTransformSection)\n\tfor sectionID, data := range sections {\n\t\tvar callback SectionTransformFn\n\t\tif callbacks != nil {\n\t\t\tcallback = callbacks[sectionID]\n\t\t}\n\t\tif callback != nil {\n\t\t\ttransformed, err := callback(data.Content)\n\t\t\tif err != nil {\n\t\t\t\tresult[sectionID] = systemMessageTransformSection{Content: data.Content}\n\t\t\t} else {\n\t\t\t\tresult[sectionID] = systemMessageTransformSection{Content: transformed}\n\t\t\t}\n\t\t} else {\n\t\t\tresult[sectionID] = systemMessageTransformSection{Content: data.Content}\n\t\t}\n\t}\n\treturn systemMessageTransformResponse{Sections: result}, nil\n}\n\n// registerCommands registers command handlers for this session.\nfunc (s *Session) registerCommands(commands []CommandDefinition) {\n\ts.commandHandlersMu.Lock()\n\tdefer s.commandHandlersMu.Unlock()\n\ts.commandHandlers = make(map[string]CommandHandler)\n\tfor _, cmd := range commands {\n\t\tif cmd.Name == \"\" || cmd.Handler == nil {\n\t\t\tcontinue\n\t\t}\n\t\ts.commandHandlers[cmd.Name] = cmd.Handler\n\t}\n}\n\n// getCommandHandler retrieves a registered command handler by name.\nfunc (s *Session) getCommandHandler(name string) (CommandHandler, bool) {\n\ts.commandHandlersMu.RLock()\n\thandler, ok := s.commandHandlers[name]\n\ts.commandHandlersMu.RUnlock()\n\treturn handler, ok\n}\n\n// executeCommandAndRespond dispatches a command.execute event to the registered handler\n// and sends the result (or error) back via the RPC layer.\nfunc (s *Session) executeCommandAndRespond(requestID, commandName, command, args string) {\n\tctx := context.Background()\n\thandler, ok := s.getCommandHandler(commandName)\n\tif !ok {\n\t\terrMsg := fmt.Sprintf(\"Unknown command: %s\", commandName)\n\t\ts.RPC.Commands.HandlePendingCommand(ctx, &rpc.CommandsHandlePendingCommandRequest{\n\t\t\tRequestID: requestID,\n\t\t\tError: &errMsg,\n\t\t})\n\t\treturn\n\t}\n\n\tcmdCtx := CommandContext{\n\t\tSessionID: s.SessionID,\n\t\tCommand: command,\n\t\tCommandName: commandName,\n\t\tArgs: args,\n\t}\n\n\tif err := handler(cmdCtx); err != nil {\n\t\terrMsg := err.Error()\n\t\ts.RPC.Commands.HandlePendingCommand(ctx, &rpc.CommandsHandlePendingCommandRequest{\n\t\t\tRequestID: requestID,\n\t\t\tError: &errMsg,\n\t\t})\n\t\treturn\n\t}\n\n\ts.RPC.Commands.HandlePendingCommand(ctx, &rpc.CommandsHandlePendingCommandRequest{\n\t\tRequestID: requestID,\n\t})\n}\n\n// registerElicitationHandler registers an elicitation handler for this session.\nfunc (s *Session) registerElicitationHandler(handler ElicitationHandler) {\n\ts.elicitationMu.Lock()\n\tdefer s.elicitationMu.Unlock()\n\ts.elicitationHandler = handler\n}\n\n// getElicitationHandler returns the currently registered elicitation handler, or nil.\nfunc (s *Session) getElicitationHandler() ElicitationHandler {\n\ts.elicitationMu.RLock()\n\tdefer s.elicitationMu.RUnlock()\n\treturn s.elicitationHandler\n}\n\n// handleElicitationRequest dispatches an elicitation.requested event to the registered handler\n// and sends the result back via the RPC layer. Auto-cancels on error.\nfunc (s *Session) handleElicitationRequest(elicitCtx ElicitationContext, requestID string) {\n\thandler := s.getElicitationHandler()\n\tif handler == nil {\n\t\treturn\n\t}\n\n\tctx := context.Background()\n\n\tresult, err := handler(elicitCtx)\n\tif err != nil {\n\t\t// Handler failed — attempt to cancel so the request doesn't hang.\n\t\ts.RPC.UI.HandlePendingElicitation(ctx, &rpc.UIHandlePendingElicitationRequest{\n\t\t\tRequestID: requestID,\n\t\t\tResult: rpc.UIElicitationResponse{\n\t\t\t\tAction: rpc.UIElicitationResponseActionCancel,\n\t\t\t},\n\t\t})\n\t\treturn\n\t}\n\n\trpcContent := make(map[string]*rpc.UIElicitationFieldValue)\n\tfor k, v := range result.Content {\n\t\trpcContent[k] = toRPCContent(v)\n\t}\n\n\ts.RPC.UI.HandlePendingElicitation(ctx, &rpc.UIHandlePendingElicitationRequest{\n\t\tRequestID: requestID,\n\t\tResult: rpc.UIElicitationResponse{\n\t\t\tAction: rpc.UIElicitationResponseAction(result.Action),\n\t\t\tContent: rpcContent,\n\t\t},\n\t})\n}\n\n// toRPCContent converts an arbitrary value to a *rpc.UIElicitationFieldValue for elicitation responses.\nfunc toRPCContent(v any) *rpc.UIElicitationFieldValue {\n\tif v == nil {\n\t\treturn nil\n\t}\n\tc := &rpc.UIElicitationFieldValue{}\n\tswitch val := v.(type) {\n\tcase bool:\n\t\tc.Bool = &val\n\tcase float64:\n\t\tc.Double = &val\n\tcase int:\n\t\tf := float64(val)\n\t\tc.Double = &f\n\tcase string:\n\t\tc.String = &val\n\tcase []string:\n\t\tc.StringArray = val\n\tcase []any:\n\t\tstrs := make([]string, 0, len(val))\n\t\tfor _, item := range val {\n\t\t\tif s, ok := item.(string); ok {\n\t\t\t\tstrs = append(strs, s)\n\t\t\t}\n\t\t}\n\t\tc.StringArray = strs\n\tdefault:\n\t\ts := fmt.Sprintf(\"%v\", val)\n\t\tc.String = &s\n\t}\n\treturn c\n}\n\n// Capabilities returns the session capabilities reported by the server.\nfunc (s *Session) Capabilities() SessionCapabilities {\n\ts.capabilitiesMu.RLock()\n\tdefer s.capabilitiesMu.RUnlock()\n\treturn s.capabilities\n}\n\n// setCapabilities updates the session capabilities.\nfunc (s *Session) setCapabilities(caps *SessionCapabilities) {\n\ts.capabilitiesMu.Lock()\n\tdefer s.capabilitiesMu.Unlock()\n\tif caps != nil {\n\t\ts.capabilities = *caps\n\t} else {\n\t\ts.capabilities = SessionCapabilities{}\n\t}\n}\n\n// UI returns the interactive UI API for showing elicitation dialogs.\n// Methods on the returned SessionUI will error if the host does not support\n// elicitation (check Capabilities().UI.Elicitation first).\nfunc (s *Session) UI() *SessionUI {\n\treturn &SessionUI{session: s}\n}\n\n// assertElicitation checks that the host supports elicitation and returns an error if not.\nfunc (s *Session) assertElicitation() error {\n\tcaps := s.Capabilities()\n\tif caps.UI == nil || !caps.UI.Elicitation {\n\t\treturn fmt.Errorf(\"elicitation is not supported by the host; check session.Capabilities().UI.Elicitation before calling UI methods\")\n\t}\n\treturn nil\n}\n\n// Elicitation shows a generic elicitation dialog with a custom schema.\nfunc (ui *SessionUI) Elicitation(ctx context.Context, message string, requestedSchema rpc.UIElicitationSchema) (*ElicitationResult, error) {\n\tif err := ui.session.assertElicitation(); err != nil {\n\t\treturn nil, err\n\t}\n\trpcResult, err := ui.session.RPC.UI.Elicitation(ctx, &rpc.UIElicitationRequest{\n\t\tMessage: message,\n\t\tRequestedSchema: requestedSchema,\n\t})\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn fromRPCElicitationResult(rpcResult), nil\n}\n\n// Confirm shows a confirmation dialog and returns the user's boolean answer.\n// Returns false if the user declines or cancels.\nfunc (ui *SessionUI) Confirm(ctx context.Context, message string) (bool, error) {\n\tif err := ui.session.assertElicitation(); err != nil {\n\t\treturn false, err\n\t}\n\tdefaultTrue := &rpc.UIElicitationFieldValue{Bool: Bool(true)}\n\trpcResult, err := ui.session.RPC.UI.Elicitation(ctx, &rpc.UIElicitationRequest{\n\t\tMessage: message,\n\t\tRequestedSchema: rpc.UIElicitationSchema{\n\t\t\tType: rpc.UIElicitationSchemaTypeObject,\n\t\t\tProperties: map[string]rpc.UIElicitationSchemaProperty{\n\t\t\t\t\"confirmed\": {\n\t\t\t\t\tType: rpc.UIElicitationSchemaPropertyTypeBoolean,\n\t\t\t\t\tDefault: defaultTrue,\n\t\t\t\t},\n\t\t\t},\n\t\t\tRequired: []string{\"confirmed\"},\n\t\t},\n\t})\n\tif err != nil {\n\t\treturn false, err\n\t}\n\tif rpcResult.Action == rpc.UIElicitationResponseActionAccept {\n\t\tif c, ok := rpcResult.Content[\"confirmed\"]; ok && c != nil && c.Bool != nil {\n\t\t\treturn *c.Bool, nil\n\t\t}\n\t}\n\treturn false, nil\n}\n\n// Select shows a selection dialog with the given options.\n// Returns the selected string, or empty string and false if the user declines/cancels.\nfunc (ui *SessionUI) Select(ctx context.Context, message string, options []string) (string, bool, error) {\n\tif err := ui.session.assertElicitation(); err != nil {\n\t\treturn \"\", false, err\n\t}\n\trpcResult, err := ui.session.RPC.UI.Elicitation(ctx, &rpc.UIElicitationRequest{\n\t\tMessage: message,\n\t\tRequestedSchema: rpc.UIElicitationSchema{\n\t\t\tType: rpc.UIElicitationSchemaTypeObject,\n\t\t\tProperties: map[string]rpc.UIElicitationSchemaProperty{\n\t\t\t\t\"selection\": {\n\t\t\t\t\tType: rpc.UIElicitationSchemaPropertyTypeString,\n\t\t\t\t\tEnum: options,\n\t\t\t\t},\n\t\t\t},\n\t\t\tRequired: []string{\"selection\"},\n\t\t},\n\t})\n\tif err != nil {\n\t\treturn \"\", false, err\n\t}\n\tif rpcResult.Action == rpc.UIElicitationResponseActionAccept {\n\t\tif c, ok := rpcResult.Content[\"selection\"]; ok && c != nil && c.String != nil {\n\t\t\treturn *c.String, true, nil\n\t\t}\n\t}\n\treturn \"\", false, nil\n}\n\n// Input shows a text input dialog. Returns the entered text, or empty string and\n// false if the user declines/cancels.\nfunc (ui *SessionUI) Input(ctx context.Context, message string, opts *InputOptions) (string, bool, error) {\n\tif err := ui.session.assertElicitation(); err != nil {\n\t\treturn \"\", false, err\n\t}\n\tprop := rpc.UIElicitationSchemaProperty{Type: rpc.UIElicitationSchemaPropertyTypeString}\n\tif opts != nil {\n\t\tif opts.Title != \"\" {\n\t\t\tprop.Title = &opts.Title\n\t\t}\n\t\tif opts.Description != \"\" {\n\t\t\tprop.Description = &opts.Description\n\t\t}\n\t\tif opts.MinLength != nil {\n\t\t\tf := float64(*opts.MinLength)\n\t\t\tprop.MinLength = &f\n\t\t}\n\t\tif opts.MaxLength != nil {\n\t\t\tf := float64(*opts.MaxLength)\n\t\t\tprop.MaxLength = &f\n\t\t}\n\t\tif opts.Format != \"\" {\n\t\t\tformat := rpc.UIElicitationSchemaPropertyStringFormat(opts.Format)\n\t\t\tprop.Format = &format\n\t\t}\n\t\tif opts.Default != \"\" {\n\t\t\tprop.Default = &rpc.UIElicitationFieldValue{String: &opts.Default}\n\t\t}\n\t}\n\trpcResult, err := ui.session.RPC.UI.Elicitation(ctx, &rpc.UIElicitationRequest{\n\t\tMessage: message,\n\t\tRequestedSchema: rpc.UIElicitationSchema{\n\t\t\tType: rpc.UIElicitationSchemaTypeObject,\n\t\t\tProperties: map[string]rpc.UIElicitationSchemaProperty{\n\t\t\t\t\"value\": prop,\n\t\t\t},\n\t\t\tRequired: []string{\"value\"},\n\t\t},\n\t})\n\tif err != nil {\n\t\treturn \"\", false, err\n\t}\n\tif rpcResult.Action == rpc.UIElicitationResponseActionAccept {\n\t\tif c, ok := rpcResult.Content[\"value\"]; ok && c != nil && c.String != nil {\n\t\t\treturn *c.String, true, nil\n\t\t}\n\t}\n\treturn \"\", false, nil\n}\n\n// fromRPCElicitationResult converts the RPC result to the SDK ElicitationResult.\nfunc fromRPCElicitationResult(r *rpc.UIElicitationResponse) *ElicitationResult {\n\tif r == nil {\n\t\treturn nil\n\t}\n\tcontent := make(map[string]any)\n\tfor k, v := range r.Content {\n\t\tif v == nil {\n\t\t\tcontent[k] = nil\n\t\t\tcontinue\n\t\t}\n\t\tif v.Bool != nil {\n\t\t\tcontent[k] = *v.Bool\n\t\t} else if v.Double != nil {\n\t\t\tcontent[k] = *v.Double\n\t\t} else if v.String != nil {\n\t\t\tcontent[k] = *v.String\n\t\t} else if v.StringArray != nil {\n\t\t\tcontent[k] = v.StringArray\n\t\t}\n\t}\n\treturn &ElicitationResult{\n\t\tAction: string(r.Action),\n\t\tContent: content,\n\t}\n}\n\n// dispatchEvent enqueues an event for delivery to user handlers and fires\n// broadcast handlers concurrently.\n//\n// Broadcast work (tool calls, permission requests) is fired in a separate\n// goroutine so it does not block the JSON-RPC read loop. User event handlers\n// are delivered by a single consumer goroutine (processEvents), guaranteeing\n// serial, FIFO dispatch without blocking the read loop.\nfunc (s *Session) dispatchEvent(event SessionEvent) {\n\tgo s.handleBroadcastEvent(event)\n\n\t// Send to the event channel in a closure with a recover guard.\n\t// Disconnect closes eventCh, and in Go sending on a closed channel\n\t// panics — there is no non-panicking send primitive. We only want\n\t// to suppress that specific panic; other panics are not expected here.\n\tfunc() {\n\t\tdefer func() { recover() }()\n\t\ts.eventCh <- event\n\t}()\n}\n\n// processEvents is the single consumer goroutine for the event channel.\n// It invokes user handlers serially, in arrival order. Panics in individual\n// handlers are recovered so that one misbehaving handler does not prevent\n// others from receiving the event.\nfunc (s *Session) processEvents() {\n\tfor event := range s.eventCh {\n\t\ts.handlerMutex.RLock()\n\t\thandlers := make([]SessionEventHandler, 0, len(s.handlers))\n\t\tfor _, h := range s.handlers {\n\t\t\thandlers = append(handlers, h.fn)\n\t\t}\n\t\ts.handlerMutex.RUnlock()\n\n\t\tfor _, handler := range handlers {\n\t\t\tfunc() {\n\t\t\t\tdefer func() {\n\t\t\t\t\tif r := recover(); r != nil {\n\t\t\t\t\t\tfmt.Printf(\"Error in session event handler: %v\\n\", r)\n\t\t\t\t\t}\n\t\t\t\t}()\n\t\t\t\thandler(event)\n\t\t\t}()\n\t\t}\n\t}\n}\n\n// handleBroadcastEvent handles broadcast request events by executing local handlers\n// and responding via RPC. This implements the protocol v3 broadcast model where tool\n// calls and permission requests are broadcast as session events to all clients.\n//\n// Handlers are executed in their own goroutine (not the JSON-RPC read loop or the\n// event consumer loop) so that a stalled handler does not block event delivery or\n// cause RPC deadlocks.\nfunc (s *Session) handleBroadcastEvent(event SessionEvent) {\n\tswitch d := event.Data.(type) {\n\tcase *ExternalToolRequestedData:\n\t\thandler, ok := s.getToolHandler(d.ToolName)\n\t\tif !ok {\n\t\t\treturn\n\t\t}\n\t\tvar tp, ts string\n\t\tif d.Traceparent != nil {\n\t\t\ttp = *d.Traceparent\n\t\t}\n\t\tif d.Tracestate != nil {\n\t\t\tts = *d.Tracestate\n\t\t}\n\t\ts.executeToolAndRespond(d.RequestID, d.ToolName, d.ToolCallID, d.Arguments, handler, tp, ts)\n\n\tcase *PermissionRequestedData:\n\t\tif d.ResolvedByHook != nil && *d.ResolvedByHook {\n\t\t\treturn // Already resolved by a permissionRequest hook; no client action needed.\n\t\t}\n\t\thandler := s.getPermissionHandler()\n\t\tif handler == nil {\n\t\t\treturn\n\t\t}\n\t\ts.executePermissionAndRespond(d.RequestID, d.PermissionRequest, handler)\n\n\tcase *CommandExecuteData:\n\t\ts.executeCommandAndRespond(d.RequestID, d.CommandName, d.Command, d.Args)\n\n\tcase *ElicitationRequestedData:\n\t\thandler := s.getElicitationHandler()\n\t\tif handler == nil {\n\t\t\treturn\n\t\t}\n\t\tvar requestedSchema map[string]any\n\t\tif d.RequestedSchema != nil {\n\t\t\trequestedSchema = map[string]any{\n\t\t\t\t\"type\": string(d.RequestedSchema.Type),\n\t\t\t\t\"properties\": d.RequestedSchema.Properties,\n\t\t\t}\n\t\t\tif len(d.RequestedSchema.Required) > 0 {\n\t\t\t\trequestedSchema[\"required\"] = d.RequestedSchema.Required\n\t\t\t}\n\t\t}\n\t\tmode := \"\"\n\t\tif d.Mode != nil {\n\t\t\tmode = string(*d.Mode)\n\t\t}\n\t\telicitationSource := \"\"\n\t\tif d.ElicitationSource != nil {\n\t\t\telicitationSource = *d.ElicitationSource\n\t\t}\n\t\turl := \"\"\n\t\tif d.URL != nil {\n\t\t\turl = *d.URL\n\t\t}\n\t\ts.handleElicitationRequest(ElicitationContext{\n\t\t\tSessionID: s.SessionID,\n\t\t\tMessage: d.Message,\n\t\t\tRequestedSchema: requestedSchema,\n\t\t\tMode: mode,\n\t\t\tElicitationSource: elicitationSource,\n\t\t\tURL: url,\n\t\t}, d.RequestID)\n\n\tcase *CapabilitiesChangedData:\n\t\tif d.UI != nil && d.UI.Elicitation != nil {\n\t\t\ts.setCapabilities(&SessionCapabilities{\n\t\t\t\tUI: &UICapabilities{Elicitation: *d.UI.Elicitation},\n\t\t\t})\n\t\t}\n\t}\n}\n\n// executeToolAndRespond executes a tool handler and sends the result back via RPC.\nfunc (s *Session) executeToolAndRespond(requestID, toolName, toolCallID string, arguments any, handler ToolHandler, traceparent, tracestate string) {\n\tctx := contextWithTraceParent(context.Background(), traceparent, tracestate)\n\tdefer func() {\n\t\tif r := recover(); r != nil {\n\t\t\terrMsg := fmt.Sprintf(\"tool panic: %v\", r)\n\t\t\ts.RPC.Tools.HandlePendingToolCall(ctx, &rpc.HandlePendingToolCallRequest{\n\t\t\t\tRequestID: requestID,\n\t\t\t\tError: &errMsg,\n\t\t\t})\n\t\t}\n\t}()\n\n\tinvocation := ToolInvocation{\n\t\tSessionID: s.SessionID,\n\t\tToolCallID: toolCallID,\n\t\tToolName: toolName,\n\t\tArguments: arguments,\n\t\tTraceContext: ctx,\n\t}\n\n\tresult, err := handler(invocation)\n\tif err != nil {\n\t\terrMsg := err.Error()\n\t\ts.RPC.Tools.HandlePendingToolCall(ctx, &rpc.HandlePendingToolCallRequest{\n\t\t\tRequestID: requestID,\n\t\t\tError: &errMsg,\n\t\t})\n\t\treturn\n\t}\n\n\ttextResultForLLM := result.TextResultForLLM\n\tif textResultForLLM == \"\" {\n\t\ttextResultForLLM = fmt.Sprintf(\"%v\", result)\n\t}\n\n\t// Default ResultType to \"success\" when unset, or \"failure\" when there's an error.\n\teffectiveResultType := result.ResultType\n\tif effectiveResultType == \"\" {\n\t\tif result.Error != \"\" {\n\t\t\teffectiveResultType = \"failure\"\n\t\t} else {\n\t\t\teffectiveResultType = \"success\"\n\t\t}\n\t}\n\n\trpcResult := rpc.ExternalToolResult{\n\t\tExternalToolTextResultForLlm: &rpc.ExternalToolTextResultForLlm{\n\t\t\tTextResultForLlm: textResultForLLM,\n\t\t\tToolTelemetry: result.ToolTelemetry,\n\t\t\tResultType: &effectiveResultType,\n\t\t},\n\t}\n\tif result.Error != \"\" {\n\t\trpcResult.ExternalToolTextResultForLlm.Error = &result.Error\n\t}\n\ts.RPC.Tools.HandlePendingToolCall(ctx, &rpc.HandlePendingToolCallRequest{\n\t\tRequestID: requestID,\n\t\tResult: &rpcResult,\n\t})\n}\n\n// executePermissionAndRespond executes a permission handler and sends the result back via RPC.\nfunc (s *Session) executePermissionAndRespond(requestID string, permissionRequest PermissionRequest, handler PermissionHandlerFunc) {\n\tdefer func() {\n\t\tif r := recover(); r != nil {\n\t\t\ts.RPC.Permissions.HandlePendingPermissionRequest(context.Background(), &rpc.PermissionDecisionRequest{\n\t\t\t\tRequestID: requestID,\n\t\t\t\tResult: rpc.PermissionDecision{\n\t\t\t\t\tKind: rpc.PermissionDecisionKindUserNotAvailable,\n\t\t\t\t},\n\t\t\t})\n\t\t}\n\t}()\n\n\tinvocation := PermissionInvocation{\n\t\tSessionID: s.SessionID,\n\t}\n\n\tresult, err := handler(permissionRequest, invocation)\n\tif err != nil {\n\t\ts.RPC.Permissions.HandlePendingPermissionRequest(context.Background(), &rpc.PermissionDecisionRequest{\n\t\t\tRequestID: requestID,\n\t\t\tResult: rpc.PermissionDecision{\n\t\t\t\tKind: rpc.PermissionDecisionKindUserNotAvailable,\n\t\t\t},\n\t\t})\n\t\treturn\n\t}\n\tif result.Kind == \"no-result\" {\n\t\treturn\n\t}\n\n\ts.RPC.Permissions.HandlePendingPermissionRequest(context.Background(), &rpc.PermissionDecisionRequest{\n\t\tRequestID: requestID,\n\t\tResult: rpc.PermissionDecision{\n\t\t\tKind: rpc.PermissionDecisionKind(result.Kind),\n\t\t},\n\t})\n}\n\n// GetMessages retrieves all events and messages from this session's history.\n//\n// This returns the complete conversation history including user messages,\n// assistant responses, tool executions, and other session events in\n// chronological order.\n//\n// Returns an error if the session has been disconnected or the connection fails.\n//\n// Example:\n//\n//\tevents, err := session.GetMessages(context.Background())\n//\tif err != nil {\n//\t log.Printf(\"Failed to get messages: %v\", err)\n//\t return\n//\t}\n//\tfor _, event := range events {\n//\t if d, ok := event.Data.(*copilot.AssistantMessageData); ok {\n//\t fmt.Println(\"Assistant:\", d.Content)\n//\t }\n//\t}\nfunc (s *Session) GetMessages(ctx context.Context) ([]SessionEvent, error) {\n\n\tresult, err := s.client.Request(\"session.getMessages\", sessionGetMessagesRequest{SessionID: s.SessionID})\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get messages: %w\", err)\n\t}\n\n\tvar response sessionGetMessagesResponse\n\tif err := json.Unmarshal(result, &response); err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to unmarshal get messages response: %w\", err)\n\t}\n\treturn response.Events, nil\n}\n\n// Disconnect closes this session and releases all in-memory resources (event\n// handlers, tool handlers, permission handlers).\n//\n// The caller should ensure the session is idle (e.g., [Session.SendAndWait] has\n// returned) before disconnecting. If the session is not idle, in-flight event\n// handlers or tool handlers may observe failures.\n//\n// Session state on disk (conversation history, planning state, artifacts) is\n// preserved, so the conversation can be resumed later by calling\n// [Client.ResumeSession] with the session ID. To permanently remove all\n// session data including files on disk, use [Client.DeleteSession] instead.\n//\n// After calling this method, the session object can no longer be used.\n//\n// Returns an error if the connection fails.\n//\n// Example:\n//\n//\t// Clean up when done — session can still be resumed later\n//\tif err := session.Disconnect(); err != nil {\n//\t log.Printf(\"Failed to disconnect session: %v\", err)\n//\t}\nfunc (s *Session) Disconnect() error {\n\t_, err := s.client.Request(\"session.destroy\", sessionDestroyRequest{SessionID: s.SessionID})\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to disconnect session: %w\", err)\n\t}\n\n\ts.closeOnce.Do(func() { close(s.eventCh) })\n\n\t// Clear handlers\n\ts.handlerMutex.Lock()\n\ts.handlers = nil\n\ts.handlerMutex.Unlock()\n\n\ts.toolHandlersM.Lock()\n\ts.toolHandlers = nil\n\ts.toolHandlersM.Unlock()\n\n\ts.permissionMux.Lock()\n\ts.permissionHandler = nil\n\ts.permissionMux.Unlock()\n\n\ts.commandHandlersMu.Lock()\n\ts.commandHandlers = nil\n\ts.commandHandlersMu.Unlock()\n\n\ts.elicitationMu.Lock()\n\ts.elicitationHandler = nil\n\ts.elicitationMu.Unlock()\n\n\treturn nil\n}\n\n// Deprecated: Use [Session.Disconnect] instead. Destroy will be removed in a future release.\n//\n// Destroy closes this session and releases all in-memory resources.\n// Session data on disk is preserved for later resumption.\nfunc (s *Session) Destroy() error {\n\treturn s.Disconnect()\n}\n\n// Abort aborts the currently processing message in this session.\n//\n// Use this to cancel a long-running request. The session remains valid\n// and can continue to be used for new messages.\n//\n// Returns an error if the session has been disconnected or the connection fails.\n//\n// Example:\n//\n//\t// Start a long-running request in a goroutine\n//\tgo func() {\n//\t session.Send(context.Background(), copilot.MessageOptions{\n//\t Prompt: \"Write a very long story...\",\n//\t })\n//\t}()\n//\n//\t// Abort after 5 seconds\n//\ttime.Sleep(5 * time.Second)\n//\tif err := session.Abort(context.Background()); err != nil {\n//\t log.Printf(\"Failed to abort: %v\", err)\n//\t}\nfunc (s *Session) Abort(ctx context.Context) error {\n\t_, err := s.client.Request(\"session.abort\", sessionAbortRequest{SessionID: s.SessionID})\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to abort session: %w\", err)\n\t}\n\n\treturn nil\n}\n\n// SetModelOptions configures optional parameters for SetModel.\ntype SetModelOptions struct {\n\t// ReasoningEffort sets the reasoning effort level for the new model (e.g., \"low\", \"medium\", \"high\", \"xhigh\").\n\tReasoningEffort *string\n\t// ModelCapabilities overrides individual model capabilities resolved by the runtime.\n\t// Only non-nil fields are applied over the runtime-resolved capabilities.\n\tModelCapabilities *rpc.ModelCapabilitiesOverride\n}\n\n// SetModel changes the model for this session.\n// The new model takes effect for the next message. Conversation history is preserved.\n//\n// Example:\n//\n//\tif err := session.SetModel(context.Background(), \"gpt-4.1\", nil); err != nil {\n//\t log.Printf(\"Failed to set model: %v\", err)\n//\t}\n//\tif err := session.SetModel(context.Background(), \"claude-sonnet-4.6\", &SetModelOptions{ReasoningEffort: new(\"high\")}); err != nil {\n//\t log.Printf(\"Failed to set model: %v\", err)\n//\t}\nfunc (s *Session) SetModel(ctx context.Context, model string, opts *SetModelOptions) error {\n\tparams := &rpc.ModelSwitchToRequest{ModelID: model}\n\tif opts != nil {\n\t\tparams.ReasoningEffort = opts.ReasoningEffort\n\t\tparams.ModelCapabilities = opts.ModelCapabilities\n\t}\n\t_, err := s.RPC.Model.SwitchTo(ctx, params)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to set model: %w\", err)\n\t}\n\n\treturn nil\n}\n\ntype LogOptions struct {\n\t// Level sets the log severity. Valid values are [rpc.SessionLogLevelInfo] (default),\n\t// [rpc.SessionLogLevelWarning], and [rpc.SessionLogLevelError].\n\tLevel rpc.SessionLogLevel\n\t// Ephemeral marks the message as transient so it is not persisted\n\t// to the session event log on disk. When nil the server decides the\n\t// default; set to a non-nil value to explicitly control persistence.\n\tEphemeral *bool\n}\n\n// Log sends a log message to the session timeline.\n// The message appears in the session event stream and is visible to SDK consumers\n// and (for non-ephemeral messages) persisted to the session event log on disk.\n//\n// Pass nil for opts to use defaults (info level, non-ephemeral).\n//\n// Example:\n//\n//\t// Simple info message\n//\tsession.Log(ctx, \"Processing started\")\n//\n//\t// Warning with options\n//\tsession.Log(ctx, \"Rate limit approaching\", &copilot.LogOptions{Level: rpc.SessionLogLevelWarning})\n//\n//\t// Ephemeral message (not persisted)\n//\tsession.Log(ctx, \"Working...\", &copilot.LogOptions{Ephemeral: copilot.Bool(true)})\nfunc (s *Session) Log(ctx context.Context, message string, opts *LogOptions) error {\n\tparams := &rpc.LogRequest{Message: message}\n\n\tif opts != nil {\n\t\tif opts.Level != \"\" {\n\t\t\tparams.Level = &opts.Level\n\t\t}\n\t\tif opts.Ephemeral != nil {\n\t\t\tparams.Ephemeral = opts.Ephemeral\n\t\t}\n\t}\n\n\t_, err := s.RPC.Log(ctx, params)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to log message: %w\", err)\n\t}\n\n\treturn nil\n}\n" }, { "path": "go/session_event_serialization_test.go", "content": "package copilot\n\nimport (\n\t\"encoding/json\"\n\t\"testing\"\n)\n\nfunc TestSessionEventAgentIDRoundTripsKnownEvent(t *testing.T) {\n\tevent, err := UnmarshalSessionEvent([]byte(`{\n\t\t\"id\": \"00000000-0000-0000-0000-000000000001\",\n\t\t\"timestamp\": \"2026-01-01T00:00:00Z\",\n\t\t\"parentId\": null,\n\t\t\"agentId\": \"agent-1\",\n\t\t\"type\": \"user.message\",\n\t\t\"data\": {\n\t\t\t\"content\": \"Hello\"\n\t\t}\n\t}`))\n\tif err != nil {\n\t\tt.Fatalf(\"failed to unmarshal session event: %v\", err)\n\t}\n\n\tif event.AgentID == nil || *event.AgentID != \"agent-1\" {\n\t\tt.Fatalf(\"expected agent ID to round-trip, got %v\", event.AgentID)\n\t}\n\tif _, ok := event.Data.(*UserMessageData); !ok {\n\t\tt.Fatalf(\"expected user message data, got %T\", event.Data)\n\t}\n\n\tdata, err := event.Marshal()\n\tif err != nil {\n\t\tt.Fatalf(\"failed to marshal session event: %v\", err)\n\t}\n\n\tvar serialized map[string]any\n\tif err := json.Unmarshal(data, &serialized); err != nil {\n\t\tt.Fatalf(\"failed to unmarshal serialized session event: %v\", err)\n\t}\n\tif serialized[\"agentId\"] != \"agent-1\" {\n\t\tt.Fatalf(\"expected serialized agentId to round-trip, got %v\", serialized[\"agentId\"])\n\t}\n}\n\nfunc TestSessionEventAgentIDRoundTripsUnknownEvent(t *testing.T) {\n\tevent, err := UnmarshalSessionEvent([]byte(`{\n\t\t\"id\": \"00000000-0000-0000-0000-000000000002\",\n\t\t\"timestamp\": \"2026-01-01T00:00:00Z\",\n\t\t\"parentId\": null,\n\t\t\"agentId\": \"future-agent\",\n\t\t\"type\": \"future.feature_from_server\",\n\t\t\"data\": {\n\t\t\t\"key\": \"value\"\n\t\t}\n\t}`))\n\tif err != nil {\n\t\tt.Fatalf(\"failed to unmarshal session event: %v\", err)\n\t}\n\n\tif event.AgentID == nil || *event.AgentID != \"future-agent\" {\n\t\tt.Fatalf(\"expected agent ID to round-trip, got %v\", event.AgentID)\n\t}\n\tif _, ok := event.Data.(*RawSessionEventData); !ok {\n\t\tt.Fatalf(\"expected raw session event data, got %T\", event.Data)\n\t}\n\n\tdata, err := event.Marshal()\n\tif err != nil {\n\t\tt.Fatalf(\"failed to marshal session event: %v\", err)\n\t}\n\n\tvar serialized map[string]any\n\tif err := json.Unmarshal(data, &serialized); err != nil {\n\t\tt.Fatalf(\"failed to unmarshal serialized session event: %v\", err)\n\t}\n\tif serialized[\"agentId\"] != \"future-agent\" {\n\t\tt.Fatalf(\"expected serialized agentId to round-trip, got %v\", serialized[\"agentId\"])\n\t}\n}\n" }, { "path": "go/session_fs_provider.go", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\npackage copilot\n\nimport (\n\t\"errors\"\n\t\"os\"\n\t\"time\"\n\n\t\"github.com/github/copilot-sdk/go/rpc\"\n)\n\n// SessionFsProvider is the interface that SDK users implement to provide\n// a session filesystem. Methods use idiomatic Go error handling: return an\n// error for failures (the adapter maps os.ErrNotExist → ENOENT automatically).\ntype SessionFsProvider interface {\n\t// ReadFile reads the full content of a file. Return os.ErrNotExist (or wrap it)\n\t// if the file does not exist.\n\tReadFile(path string) (string, error)\n\t// WriteFile writes content to a file, creating it and parent directories if needed.\n\t// mode is an optional POSIX-style permission mode. Pass nil to use the OS default.\n\tWriteFile(path string, content string, mode *int) error\n\t// AppendFile appends content to a file, creating it and parent directories if needed.\n\t// mode is an optional POSIX-style permission mode. Pass nil to use the OS default.\n\tAppendFile(path string, content string, mode *int) error\n\t// Exists checks whether the given path exists.\n\tExists(path string) (bool, error)\n\t// Stat returns metadata about a file or directory.\n\t// Return os.ErrNotExist if the path does not exist.\n\tStat(path string) (*SessionFsFileInfo, error)\n\t// Mkdir creates a directory. If recursive is true, create parent directories as needed.\n\t// mode is an optional POSIX-style permission mode (e.g., 0o755). Pass nil to use the OS default.\n\tMkdir(path string, recursive bool, mode *int) error\n\t// Readdir lists the names of entries in a directory.\n\t// Return os.ErrNotExist if the directory does not exist.\n\tReaddir(path string) ([]string, error)\n\t// ReaddirWithTypes lists entries with type information.\n\t// Return os.ErrNotExist if the directory does not exist.\n\tReaddirWithTypes(path string) ([]rpc.SessionFSReaddirWithTypesEntry, error)\n\t// Rm removes a file or directory. If recursive is true, remove contents too.\n\t// If force is true, do not return an error when the path does not exist.\n\tRm(path string, recursive bool, force bool) error\n\t// Rename moves/renames a file or directory.\n\tRename(src string, dest string) error\n}\n\n// SessionFsFileInfo holds file metadata returned by SessionFsProvider.Stat.\ntype SessionFsFileInfo struct {\n\tIsFile bool\n\tIsDirectory bool\n\tSize int64\n\tMtime time.Time\n\tBirthtime time.Time\n}\n\n// sessionFsAdapter wraps a SessionFsProvider to implement rpc.SessionFsHandler,\n// converting idiomatic Go errors into SessionFSError results.\ntype sessionFsAdapter struct {\n\tprovider SessionFsProvider\n}\n\nfunc newSessionFsAdapter(provider SessionFsProvider) rpc.SessionFsHandler {\n\treturn &sessionFsAdapter{provider: provider}\n}\n\nfunc (a *sessionFsAdapter) ReadFile(request *rpc.SessionFSReadFileRequest) (*rpc.SessionFSReadFileResult, error) {\n\tcontent, err := a.provider.ReadFile(request.Path)\n\tif err != nil {\n\t\treturn &rpc.SessionFSReadFileResult{Error: toSessionFsError(err)}, nil\n\t}\n\treturn &rpc.SessionFSReadFileResult{Content: content}, nil\n}\n\nfunc (a *sessionFsAdapter) WriteFile(request *rpc.SessionFSWriteFileRequest) (*rpc.SessionFSError, error) {\n\tvar mode *int\n\tif request.Mode != nil {\n\t\tm := int(*request.Mode)\n\t\tmode = &m\n\t}\n\tif err := a.provider.WriteFile(request.Path, request.Content, mode); err != nil {\n\t\treturn toSessionFsError(err), nil\n\t}\n\treturn nil, nil\n}\n\nfunc (a *sessionFsAdapter) AppendFile(request *rpc.SessionFSAppendFileRequest) (*rpc.SessionFSError, error) {\n\tvar mode *int\n\tif request.Mode != nil {\n\t\tm := int(*request.Mode)\n\t\tmode = &m\n\t}\n\tif err := a.provider.AppendFile(request.Path, request.Content, mode); err != nil {\n\t\treturn toSessionFsError(err), nil\n\t}\n\treturn nil, nil\n}\n\nfunc (a *sessionFsAdapter) Exists(request *rpc.SessionFSExistsRequest) (*rpc.SessionFSExistsResult, error) {\n\texists, err := a.provider.Exists(request.Path)\n\tif err != nil {\n\t\treturn &rpc.SessionFSExistsResult{Exists: false}, nil\n\t}\n\treturn &rpc.SessionFSExistsResult{Exists: exists}, nil\n}\n\nfunc (a *sessionFsAdapter) Stat(request *rpc.SessionFSStatRequest) (*rpc.SessionFSStatResult, error) {\n\tinfo, err := a.provider.Stat(request.Path)\n\tif err != nil {\n\t\treturn &rpc.SessionFSStatResult{Error: toSessionFsError(err)}, nil\n\t}\n\treturn &rpc.SessionFSStatResult{\n\t\tIsFile: info.IsFile,\n\t\tIsDirectory: info.IsDirectory,\n\t\tSize: info.Size,\n\t\tMtime: info.Mtime,\n\t\tBirthtime: info.Birthtime,\n\t}, nil\n}\n\nfunc (a *sessionFsAdapter) Mkdir(request *rpc.SessionFSMkdirRequest) (*rpc.SessionFSError, error) {\n\trecursive := request.Recursive != nil && *request.Recursive\n\tvar mode *int\n\tif request.Mode != nil {\n\t\tm := int(*request.Mode)\n\t\tmode = &m\n\t}\n\tif err := a.provider.Mkdir(request.Path, recursive, mode); err != nil {\n\t\treturn toSessionFsError(err), nil\n\t}\n\treturn nil, nil\n}\n\nfunc (a *sessionFsAdapter) Readdir(request *rpc.SessionFSReaddirRequest) (*rpc.SessionFSReaddirResult, error) {\n\tentries, err := a.provider.Readdir(request.Path)\n\tif err != nil {\n\t\treturn &rpc.SessionFSReaddirResult{Error: toSessionFsError(err)}, nil\n\t}\n\treturn &rpc.SessionFSReaddirResult{Entries: entries}, nil\n}\n\nfunc (a *sessionFsAdapter) ReaddirWithTypes(request *rpc.SessionFSReaddirWithTypesRequest) (*rpc.SessionFSReaddirWithTypesResult, error) {\n\tentries, err := a.provider.ReaddirWithTypes(request.Path)\n\tif err != nil {\n\t\treturn &rpc.SessionFSReaddirWithTypesResult{Error: toSessionFsError(err)}, nil\n\t}\n\treturn &rpc.SessionFSReaddirWithTypesResult{Entries: entries}, nil\n}\n\nfunc (a *sessionFsAdapter) Rm(request *rpc.SessionFSRmRequest) (*rpc.SessionFSError, error) {\n\trecursive := request.Recursive != nil && *request.Recursive\n\tforce := request.Force != nil && *request.Force\n\tif err := a.provider.Rm(request.Path, recursive, force); err != nil {\n\t\treturn toSessionFsError(err), nil\n\t}\n\treturn nil, nil\n}\n\nfunc (a *sessionFsAdapter) Rename(request *rpc.SessionFSRenameRequest) (*rpc.SessionFSError, error) {\n\tif err := a.provider.Rename(request.Src, request.Dest); err != nil {\n\t\treturn toSessionFsError(err), nil\n\t}\n\treturn nil, nil\n}\n\nfunc toSessionFsError(err error) *rpc.SessionFSError {\n\tcode := rpc.SessionFSErrorCodeUNKNOWN\n\tif errors.Is(err, os.ErrNotExist) {\n\t\tcode = rpc.SessionFSErrorCodeENOENT\n\t}\n\tmsg := err.Error()\n\treturn &rpc.SessionFSError{Code: code, Message: &msg}\n}\n" }, { "path": "go/session_test.go", "content": "package copilot\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"strings\"\n\t\"sync\"\n\t\"sync/atomic\"\n\t\"testing\"\n\t\"time\"\n)\n\n// newTestSession creates a session with an event channel and starts the consumer goroutine.\n// Returns a cleanup function that closes the channel (stopping the consumer).\nfunc newTestSession() (*Session, func()) {\n\ts := &Session{\n\t\thandlers: make([]sessionHandler, 0),\n\t\tcommandHandlers: make(map[string]CommandHandler),\n\t\teventCh: make(chan SessionEvent, 128),\n\t}\n\tgo s.processEvents()\n\treturn s, func() { close(s.eventCh) }\n}\n\nfunc TestSession_On(t *testing.T) {\n\tt.Run(\"multiple handlers all receive events\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\tvar wg sync.WaitGroup\n\t\twg.Add(3)\n\t\tvar received1, received2, received3 bool\n\t\tsession.On(func(event SessionEvent) { received1 = true; wg.Done() })\n\t\tsession.On(func(event SessionEvent) { received2 = true; wg.Done() })\n\t\tsession.On(func(event SessionEvent) { received3 = true; wg.Done() })\n\n\t\tsession.dispatchEvent(SessionEvent{Type: \"test\"})\n\t\twg.Wait()\n\n\t\tif !received1 || !received2 || !received3 {\n\t\t\tt.Errorf(\"Expected all handlers to receive event, got received1=%v, received2=%v, received3=%v\",\n\t\t\t\treceived1, received2, received3)\n\t\t}\n\t})\n\n\tt.Run(\"unsubscribing one handler does not affect others\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\tvar count1, count2, count3 atomic.Int32\n\t\tvar wg sync.WaitGroup\n\n\t\twg.Add(3)\n\t\tsession.On(func(event SessionEvent) { count1.Add(1); wg.Done() })\n\t\tunsub2 := session.On(func(event SessionEvent) { count2.Add(1); wg.Done() })\n\t\tsession.On(func(event SessionEvent) { count3.Add(1); wg.Done() })\n\n\t\t// First event - all handlers receive it\n\t\tsession.dispatchEvent(SessionEvent{Type: \"test\"})\n\t\twg.Wait()\n\n\t\t// Unsubscribe handler 2\n\t\tunsub2()\n\n\t\t// Second event - only handlers 1 and 3 should receive it\n\t\twg.Add(2)\n\t\tsession.dispatchEvent(SessionEvent{Type: \"test\"})\n\t\twg.Wait()\n\n\t\tif count1.Load() != 2 {\n\t\t\tt.Errorf(\"Expected handler 1 to receive 2 events, got %d\", count1.Load())\n\t\t}\n\t\tif count2.Load() != 1 {\n\t\t\tt.Errorf(\"Expected handler 2 to receive 1 event (before unsubscribe), got %d\", count2.Load())\n\t\t}\n\t\tif count3.Load() != 2 {\n\t\t\tt.Errorf(\"Expected handler 3 to receive 2 events, got %d\", count3.Load())\n\t\t}\n\t})\n\n\tt.Run(\"calling unsubscribe multiple times is safe\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\tvar count atomic.Int32\n\t\tvar wg sync.WaitGroup\n\n\t\twg.Add(1)\n\t\tunsub := session.On(func(event SessionEvent) { count.Add(1); wg.Done() })\n\n\t\tsession.dispatchEvent(SessionEvent{Type: \"test\"})\n\t\twg.Wait()\n\n\t\tunsub()\n\t\tunsub()\n\t\tunsub()\n\n\t\t// Dispatch again and wait for it to be processed via a sentinel handler\n\t\twg.Add(1)\n\t\tsession.On(func(event SessionEvent) { wg.Done() })\n\t\tsession.dispatchEvent(SessionEvent{Type: \"test\"})\n\t\twg.Wait()\n\n\t\tif count.Load() != 1 {\n\t\t\tt.Errorf(\"Expected handler to receive 1 event, got %d\", count.Load())\n\t\t}\n\t})\n\n\tt.Run(\"handlers are called in registration order\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\tvar order []int\n\t\tvar wg sync.WaitGroup\n\t\twg.Add(3)\n\t\tsession.On(func(event SessionEvent) { order = append(order, 1); wg.Done() })\n\t\tsession.On(func(event SessionEvent) { order = append(order, 2); wg.Done() })\n\t\tsession.On(func(event SessionEvent) { order = append(order, 3); wg.Done() })\n\n\t\tsession.dispatchEvent(SessionEvent{Type: \"test\"})\n\t\twg.Wait()\n\n\t\tif len(order) != 3 || order[0] != 1 || order[1] != 2 || order[2] != 3 {\n\t\t\tt.Errorf(\"Expected handlers to be called in order [1,2,3], got %v\", order)\n\t\t}\n\t})\n\n\tt.Run(\"concurrent subscribe and unsubscribe is safe\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\tvar wg sync.WaitGroup\n\t\tfor i := 0; i < 100; i++ {\n\t\t\twg.Add(1)\n\t\t\tgo func() {\n\t\t\t\tdefer wg.Done()\n\t\t\t\tunsub := session.On(func(event SessionEvent) {})\n\t\t\t\tunsub()\n\t\t\t}()\n\t\t}\n\t\twg.Wait()\n\n\t\tsession.handlerMutex.RLock()\n\t\tcount := len(session.handlers)\n\t\tsession.handlerMutex.RUnlock()\n\n\t\tif count != 0 {\n\t\t\tt.Errorf(\"Expected 0 handlers after all unsubscribes, got %d\", count)\n\t\t}\n\t})\n\n\tt.Run(\"events are dispatched serially\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\tvar concurrentCount atomic.Int32\n\t\tvar maxConcurrent atomic.Int32\n\t\tvar done sync.WaitGroup\n\t\tconst totalEvents = 5\n\t\tdone.Add(totalEvents)\n\n\t\tsession.On(func(event SessionEvent) {\n\t\t\tcurrent := concurrentCount.Add(1)\n\t\t\tif current > maxConcurrent.Load() {\n\t\t\t\tmaxConcurrent.Store(current)\n\t\t\t}\n\n\t\t\ttime.Sleep(10 * time.Millisecond)\n\n\t\t\tconcurrentCount.Add(-1)\n\t\t\tdone.Done()\n\t\t})\n\n\t\tfor i := 0; i < totalEvents; i++ {\n\t\t\tsession.dispatchEvent(SessionEvent{Type: \"test\"})\n\t\t}\n\n\t\tdone.Wait()\n\n\t\tif max := maxConcurrent.Load(); max != 1 {\n\t\t\tt.Errorf(\"Expected max concurrent count of 1, got %d\", max)\n\t\t}\n\t})\n\n\tt.Run(\"handler panic does not halt delivery\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\tvar eventCount atomic.Int32\n\t\tvar done sync.WaitGroup\n\t\tdone.Add(2)\n\n\t\tsession.On(func(event SessionEvent) {\n\t\t\tcount := eventCount.Add(1)\n\t\t\tdefer done.Done()\n\t\t\tif count == 1 {\n\t\t\t\tpanic(\"boom\")\n\t\t\t}\n\t\t})\n\n\t\tsession.dispatchEvent(SessionEvent{Type: \"test\"})\n\t\tsession.dispatchEvent(SessionEvent{Type: \"test\"})\n\n\t\tdone.Wait()\n\n\t\tif eventCount.Load() != 2 {\n\t\t\tt.Errorf(\"Expected 2 events dispatched, got %d\", eventCount.Load())\n\t\t}\n\t})\n}\n\nfunc TestSession_CommandRouting(t *testing.T) {\n\tt.Run(\"routes command.execute event to the correct handler\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\tvar receivedCtx CommandContext\n\t\tsession.registerCommands([]CommandDefinition{\n\t\t\t{\n\t\t\t\tName: \"deploy\",\n\t\t\t\tDescription: \"Deploy the app\",\n\t\t\t\tHandler: func(ctx CommandContext) error {\n\t\t\t\t\treceivedCtx = ctx\n\t\t\t\t\treturn nil\n\t\t\t\t},\n\t\t\t},\n\t\t\t{\n\t\t\t\tName: \"rollback\",\n\t\t\t\tDescription: \"Rollback\",\n\t\t\t\tHandler: func(ctx CommandContext) error {\n\t\t\t\t\treturn nil\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\n\t\t// Simulate the dispatch — executeCommandAndRespond will fail on RPC (nil client)\n\t\t// but the handler will still be invoked. We test routing only.\n\t\t_, ok := session.getCommandHandler(\"deploy\")\n\t\tif !ok {\n\t\t\tt.Fatal(\"Expected 'deploy' handler to be registered\")\n\t\t}\n\t\t_, ok = session.getCommandHandler(\"rollback\")\n\t\tif !ok {\n\t\t\tt.Fatal(\"Expected 'rollback' handler to be registered\")\n\t\t}\n\t\t_, ok = session.getCommandHandler(\"nonexistent\")\n\t\tif ok {\n\t\t\tt.Fatal(\"Expected 'nonexistent' handler to NOT be registered\")\n\t\t}\n\n\t\t// Directly invoke handler to verify context is correct\n\t\thandler, _ := session.getCommandHandler(\"deploy\")\n\t\terr := handler(CommandContext{\n\t\t\tSessionID: \"test-session\",\n\t\t\tCommand: \"/deploy production\",\n\t\t\tCommandName: \"deploy\",\n\t\t\tArgs: \"production\",\n\t\t})\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Handler returned error: %v\", err)\n\t\t}\n\t\tif receivedCtx.SessionID != \"test-session\" {\n\t\t\tt.Errorf(\"Expected sessionID 'test-session', got %q\", receivedCtx.SessionID)\n\t\t}\n\t\tif receivedCtx.CommandName != \"deploy\" {\n\t\t\tt.Errorf(\"Expected commandName 'deploy', got %q\", receivedCtx.CommandName)\n\t\t}\n\t\tif receivedCtx.Command != \"/deploy production\" {\n\t\t\tt.Errorf(\"Expected command '/deploy production', got %q\", receivedCtx.Command)\n\t\t}\n\t\tif receivedCtx.Args != \"production\" {\n\t\t\tt.Errorf(\"Expected args 'production', got %q\", receivedCtx.Args)\n\t\t}\n\t})\n\n\tt.Run(\"skips commands with empty name or nil handler\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\tsession.registerCommands([]CommandDefinition{\n\t\t\t{Name: \"\", Handler: func(ctx CommandContext) error { return nil }},\n\t\t\t{Name: \"valid\", Handler: nil},\n\t\t\t{Name: \"good\", Handler: func(ctx CommandContext) error { return nil }},\n\t\t})\n\n\t\t_, ok := session.getCommandHandler(\"\")\n\t\tif ok {\n\t\t\tt.Error(\"Empty name should not be registered\")\n\t\t}\n\t\t_, ok = session.getCommandHandler(\"valid\")\n\t\tif ok {\n\t\t\tt.Error(\"Nil handler should not be registered\")\n\t\t}\n\t\t_, ok = session.getCommandHandler(\"good\")\n\t\tif !ok {\n\t\t\tt.Error(\"Expected 'good' handler to be registered\")\n\t\t}\n\t})\n\n\tt.Run(\"handler error is propagated\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\thandlerCalled := false\n\t\tsession.registerCommands([]CommandDefinition{\n\t\t\t{\n\t\t\t\tName: \"fail\",\n\t\t\t\tHandler: func(ctx CommandContext) error {\n\t\t\t\t\thandlerCalled = true\n\t\t\t\t\treturn fmt.Errorf(\"deploy failed\")\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\n\t\thandler, ok := session.getCommandHandler(\"fail\")\n\t\tif !ok {\n\t\t\tt.Fatal(\"Expected 'fail' handler to be registered\")\n\t\t}\n\n\t\terr := handler(CommandContext{\n\t\t\tSessionID: \"test-session\",\n\t\t\tCommandName: \"fail\",\n\t\t\tCommand: \"/fail\",\n\t\t\tArgs: \"\",\n\t\t})\n\n\t\tif !handlerCalled {\n\t\t\tt.Error(\"Expected handler to be called\")\n\t\t}\n\t\tif err == nil {\n\t\t\tt.Fatal(\"Expected error from handler\")\n\t\t}\n\t\tif !strings.Contains(err.Error(), \"deploy failed\") {\n\t\t\tt.Errorf(\"Expected error to contain 'deploy failed', got %q\", err.Error())\n\t\t}\n\t})\n\n\tt.Run(\"unknown command returns no handler\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\tsession.registerCommands([]CommandDefinition{\n\t\t\t{Name: \"deploy\", Handler: func(ctx CommandContext) error { return nil }},\n\t\t})\n\n\t\t_, ok := session.getCommandHandler(\"unknown\")\n\t\tif ok {\n\t\t\tt.Error(\"Expected no handler for unknown command\")\n\t\t}\n\t})\n}\n\nfunc TestSession_Capabilities(t *testing.T) {\n\tt.Run(\"defaults capabilities when not injected\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\tcaps := session.Capabilities()\n\t\tif caps.UI != nil {\n\t\t\tt.Errorf(\"Expected UI to be nil by default, got %+v\", caps.UI)\n\t\t}\n\t})\n\n\tt.Run(\"setCapabilities stores and retrieves capabilities\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\tsession.setCapabilities(&SessionCapabilities{\n\t\t\tUI: &UICapabilities{Elicitation: true},\n\t\t})\n\t\tcaps := session.Capabilities()\n\t\tif caps.UI == nil || !caps.UI.Elicitation {\n\t\t\tt.Errorf(\"Expected UI.Elicitation to be true\")\n\t\t}\n\t})\n\n\tt.Run(\"setCapabilities with nil resets to empty\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\tsession.setCapabilities(&SessionCapabilities{\n\t\t\tUI: &UICapabilities{Elicitation: true},\n\t\t})\n\t\tsession.setCapabilities(nil)\n\t\tcaps := session.Capabilities()\n\t\tif caps.UI != nil {\n\t\t\tt.Errorf(\"Expected UI to be nil after reset, got %+v\", caps.UI)\n\t\t}\n\t})\n\n\tt.Run(\"capabilities.changed event updates session capabilities\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\t// Initially no capabilities\n\t\tcaps := session.Capabilities()\n\t\tif caps.UI != nil {\n\t\t\tt.Fatal(\"Expected UI to be nil initially\")\n\t\t}\n\n\t\t// Dispatch a capabilities.changed event with elicitation=true\n\t\telicitTrue := true\n\t\tsession.dispatchEvent(SessionEvent{\n\t\t\tType: SessionEventTypeCapabilitiesChanged,\n\t\t\tData: &CapabilitiesChangedData{\n\t\t\t\tUI: &CapabilitiesChangedUI{Elicitation: &elicitTrue},\n\t\t\t},\n\t\t})\n\n\t\t// Capabilities are updated by handleBroadcastEvent which runs in a goroutine.\n\t\t// Poll instead of sleep so the test is bound by event processing, not arbitrary\n\t\t// timing — fast machines exit immediately, slow ones still get 2s.\n\t\tcaps = waitForCapability(t, session, func(c SessionCapabilities) bool {\n\t\t\treturn c.UI != nil && c.UI.Elicitation\n\t\t}, 2*time.Second)\n\t\tif caps.UI == nil || !caps.UI.Elicitation {\n\t\t\tt.Error(\"Expected UI.Elicitation to be true after capabilities.changed event\")\n\t\t}\n\n\t\t// Dispatch with elicitation=false\n\t\telicitFalse := false\n\t\tsession.dispatchEvent(SessionEvent{\n\t\t\tType: SessionEventTypeCapabilitiesChanged,\n\t\t\tData: &CapabilitiesChangedData{\n\t\t\t\tUI: &CapabilitiesChangedUI{Elicitation: &elicitFalse},\n\t\t\t},\n\t\t})\n\n\t\tcaps = waitForCapability(t, session, func(c SessionCapabilities) bool {\n\t\t\treturn c.UI != nil && !c.UI.Elicitation\n\t\t}, 2*time.Second)\n\t\tif caps.UI == nil || caps.UI.Elicitation {\n\t\t\tt.Error(\"Expected UI.Elicitation to be false after second capabilities.changed event\")\n\t\t}\n\t})\n}\n\n// waitForCapability polls Session.Capabilities() until predicate matches or timeout.\n// Returns the last observed capabilities. Avoids time.Sleep in tests.\nfunc waitForCapability(t *testing.T, session *Session, predicate func(SessionCapabilities) bool, timeout time.Duration) SessionCapabilities {\n\tt.Helper()\n\tdeadline := time.Now().Add(timeout)\n\tvar last SessionCapabilities\n\tfor {\n\t\tlast = session.Capabilities()\n\t\tif predicate(last) {\n\t\t\treturn last\n\t\t}\n\t\tif time.Now().After(deadline) {\n\t\t\treturn last\n\t\t}\n\t\ttime.Sleep(5 * time.Millisecond)\n\t}\n}\n\nfunc TestSession_ElicitationCapabilityGating(t *testing.T) {\n\tt.Run(\"elicitation errors when capability is missing\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\terr := session.assertElicitation()\n\t\tif err == nil {\n\t\t\tt.Fatal(\"Expected error when elicitation capability is missing\")\n\t\t}\n\t\texpected := \"elicitation is not supported\"\n\t\tif !strings.Contains(err.Error(), expected) {\n\t\t\tt.Errorf(\"Expected error to contain %q, got %q\", expected, err.Error())\n\t\t}\n\t})\n\n\tt.Run(\"elicitation succeeds when capability is present\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\tsession.setCapabilities(&SessionCapabilities{\n\t\t\tUI: &UICapabilities{Elicitation: true},\n\t\t})\n\t\terr := session.assertElicitation()\n\t\tif err != nil {\n\t\t\tt.Errorf(\"Expected no error when elicitation capability is present, got %v\", err)\n\t\t}\n\t})\n}\n\nfunc TestSession_ElicitationHandler(t *testing.T) {\n\tt.Run(\"registerElicitationHandler stores handler\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\tif session.getElicitationHandler() != nil {\n\t\t\tt.Error(\"Expected nil handler before registration\")\n\t\t}\n\n\t\tsession.registerElicitationHandler(func(ctx ElicitationContext) (ElicitationResult, error) {\n\t\t\treturn ElicitationResult{Action: \"accept\"}, nil\n\t\t})\n\n\t\tif session.getElicitationHandler() == nil {\n\t\t\tt.Error(\"Expected non-nil handler after registration\")\n\t\t}\n\t})\n\n\tt.Run(\"handler error is returned correctly\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\tsession.registerElicitationHandler(func(ctx ElicitationContext) (ElicitationResult, error) {\n\t\t\treturn ElicitationResult{}, fmt.Errorf(\"handler exploded\")\n\t\t})\n\n\t\thandler := session.getElicitationHandler()\n\t\tif handler == nil {\n\t\t\tt.Fatal(\"Expected non-nil handler\")\n\t\t}\n\n\t\t_, err := handler(\n\t\t\tElicitationContext{SessionID: \"test-session\", Message: \"Pick a color\"},\n\t\t)\n\t\tif err == nil {\n\t\t\tt.Fatal(\"Expected error from handler\")\n\t\t}\n\t\tif !strings.Contains(err.Error(), \"handler exploded\") {\n\t\t\tt.Errorf(\"Expected error to contain 'handler exploded', got %q\", err.Error())\n\t\t}\n\t})\n\n\tt.Run(\"handler success returns result\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\tsession.registerElicitationHandler(func(ctx ElicitationContext) (ElicitationResult, error) {\n\t\t\treturn ElicitationResult{\n\t\t\t\tAction: \"accept\",\n\t\t\t\tContent: map[string]any{\"color\": \"blue\"},\n\t\t\t}, nil\n\t\t})\n\n\t\thandler := session.getElicitationHandler()\n\t\tresult, err := handler(\n\t\t\tElicitationContext{SessionID: \"test-session\", Message: \"Pick a color\"},\n\t\t)\n\t\tif err != nil {\n\t\t\tt.Fatalf(\"Expected no error, got %v\", err)\n\t\t}\n\t\tif result.Action != \"accept\" {\n\t\t\tt.Errorf(\"Expected action 'accept', got %q\", result.Action)\n\t\t}\n\t\tif result.Content[\"color\"] != \"blue\" {\n\t\t\tt.Errorf(\"Expected content color 'blue', got %v\", result.Content[\"color\"])\n\t\t}\n\t})\n}\n\nfunc TestSession_HookForwardCompatibility(t *testing.T) {\n\tt.Run(\"unknown hook type returns nil without error when known hooks are registered\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\t// Register known hook handlers to simulate a real session configuration.\n\t\t// The handler itself does nothing; it only exists to confirm that even\n\t\t// when other hooks are active, an unknown hook type is still ignored.\n\t\tsession.registerHooks(&SessionHooks{\n\t\t\tOnPostToolUse: func(input PostToolUseHookInput, invocation HookInvocation) (*PostToolUseHookOutput, error) {\n\t\t\t\treturn nil, nil\n\t\t\t},\n\t\t})\n\n\t\t// \"postToolUseFailure\" is an example of a hook type introduced by a newer\n\t\t// CLI version that the SDK does not yet know about.\n\t\toutput, err := session.handleHooksInvoke(\"postToolUseFailure\", json.RawMessage(`{}`))\n\t\tif err != nil {\n\t\t\tt.Errorf(\"Expected no error for unknown hook type, got: %v\", err)\n\t\t}\n\t\tif output != nil {\n\t\t\tt.Errorf(\"Expected nil output for unknown hook type, got: %v\", output)\n\t\t}\n\t})\n\n\tt.Run(\"unknown hook type with no hooks registered returns nil without error\", func(t *testing.T) {\n\t\tsession, cleanup := newTestSession()\n\t\tdefer cleanup()\n\n\t\toutput, err := session.handleHooksInvoke(\"futureHookType\", json.RawMessage(`{\"someField\":\"value\"}`))\n\t\tif err != nil {\n\t\t\tt.Errorf(\"Expected no error for unknown hook type with no hooks, got: %v\", err)\n\t\t}\n\t\tif output != nil {\n\t\t\tt.Errorf(\"Expected nil output for unknown hook type with no hooks, got: %v\", output)\n\t\t}\n\t})\n}\n\nfunc TestSession_ElicitationRequestSchema(t *testing.T) {\n\tt.Run(\"elicitation.requested passes full schema to handler\", func(t *testing.T) {\n\t\t// Verify the schema extraction logic from handleBroadcastEvent\n\t\t// preserves type, properties, and required.\n\t\tproperties := map[string]any{\n\t\t\t\"name\": map[string]any{\"type\": \"string\"},\n\t\t\t\"age\": map[string]any{\"type\": \"number\"},\n\t\t}\n\t\trequired := []string{\"name\", \"age\"}\n\n\t\t// Replicate the schema extraction logic from handleBroadcastEvent\n\t\trequestedSchema := map[string]any{\n\t\t\t\"type\": \"object\",\n\t\t\t\"properties\": properties,\n\t\t}\n\t\tif len(required) > 0 {\n\t\t\trequestedSchema[\"required\"] = required\n\t\t}\n\n\t\tif requestedSchema[\"type\"] != \"object\" {\n\t\t\tt.Errorf(\"Expected schema type 'object', got %v\", requestedSchema[\"type\"])\n\t\t}\n\t\tprops, ok := requestedSchema[\"properties\"].(map[string]any)\n\t\tif !ok || props == nil {\n\t\t\tt.Fatal(\"Expected schema properties map\")\n\t\t}\n\t\tif len(props) != 2 {\n\t\t\tt.Errorf(\"Expected 2 properties, got %d\", len(props))\n\t\t}\n\t\treq, ok := requestedSchema[\"required\"].([]string)\n\t\tif !ok || len(req) != 2 {\n\t\t\tt.Errorf(\"Expected required [name, age], got %v\", requestedSchema[\"required\"])\n\t\t}\n\t})\n\n\tt.Run(\"schema without required omits required key\", func(t *testing.T) {\n\t\tproperties := map[string]any{\n\t\t\t\"optional_field\": map[string]any{\"type\": \"string\"},\n\t\t}\n\n\t\trequestedSchema := map[string]any{\n\t\t\t\"type\": \"object\",\n\t\t\t\"properties\": properties,\n\t\t}\n\t\t// Simulate: if len(schema.Required) > 0 { ... } — with empty required\n\t\tvar required []string\n\t\tif len(required) > 0 {\n\t\t\trequestedSchema[\"required\"] = required\n\t\t}\n\n\t\tif _, exists := requestedSchema[\"required\"]; exists {\n\t\t\tt.Error(\"Expected no 'required' key when Required is empty\")\n\t\t}\n\t})\n}\n" }, { "path": "go/telemetry.go", "content": "package copilot\n\nimport (\n\t\"context\"\n\n\t\"go.opentelemetry.io/otel\"\n\t\"go.opentelemetry.io/otel/propagation\"\n)\n\n// getTraceContext extracts the current W3C Trace Context (traceparent/tracestate)\n// from the Go context using the global OTel propagator.\nfunc getTraceContext(ctx context.Context) (traceparent, tracestate string) {\n\tcarrier := propagation.MapCarrier{}\n\totel.GetTextMapPropagator().Inject(ctx, carrier)\n\treturn carrier.Get(\"traceparent\"), carrier.Get(\"tracestate\")\n}\n\n// contextWithTraceParent returns a new context with trace context extracted from\n// the provided W3C traceparent and tracestate headers.\nfunc contextWithTraceParent(ctx context.Context, traceparent, tracestate string) context.Context {\n\tif traceparent == \"\" {\n\t\treturn ctx\n\t}\n\tcarrier := propagation.MapCarrier{\n\t\t\"traceparent\": traceparent,\n\t}\n\tif tracestate != \"\" {\n\t\tcarrier[\"tracestate\"] = tracestate\n\t}\n\treturn otel.GetTextMapPropagator().Extract(ctx, carrier)\n}\n" }, { "path": "go/telemetry_test.go", "content": "package copilot\n\nimport (\n\t\"context\"\n\t\"testing\"\n\n\t\"go.opentelemetry.io/otel\"\n\t\"go.opentelemetry.io/otel/propagation\"\n\t\"go.opentelemetry.io/otel/trace\"\n)\n\nfunc TestGetTraceContextEmpty(t *testing.T) {\n\t// Without any propagator configured, should return empty strings\n\ttp, ts := getTraceContext(context.Background())\n\tif tp != \"\" || ts != \"\" {\n\t\tt.Errorf(\"expected empty trace context, got traceparent=%q tracestate=%q\", tp, ts)\n\t}\n}\n\nfunc TestGetTraceContextWithPropagator(t *testing.T) {\n\t// Set up W3C propagator\n\totel.SetTextMapPropagator(propagation.TraceContext{})\n\tdefer otel.SetTextMapPropagator(propagation.NewCompositeTextMapPropagator())\n\n\t// Inject known trace context\n\tcarrier := propagation.MapCarrier{\n\t\t\"traceparent\": \"00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01\",\n\t}\n\tctx := otel.GetTextMapPropagator().Extract(context.Background(), carrier)\n\n\ttp, ts := getTraceContext(ctx)\n\tif tp == \"\" {\n\t\tt.Error(\"expected non-empty traceparent\")\n\t}\n\t_ = ts // tracestate may be empty\n}\n\nfunc TestContextWithTraceParentEmpty(t *testing.T) {\n\tctx := contextWithTraceParent(context.Background(), \"\", \"\")\n\tif ctx == nil {\n\t\tt.Error(\"expected non-nil context\")\n\t}\n}\n\nfunc TestContextWithTraceParentValid(t *testing.T) {\n\totel.SetTextMapPropagator(propagation.TraceContext{})\n\tdefer otel.SetTextMapPropagator(propagation.NewCompositeTextMapPropagator())\n\n\tctx := contextWithTraceParent(context.Background(),\n\t\t\"00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01\", \"\")\n\n\t// Verify the context has trace info by extracting it back\n\tcarrier := propagation.MapCarrier{}\n\totel.GetTextMapPropagator().Inject(ctx, carrier)\n\tif carrier.Get(\"traceparent\") == \"\" {\n\t\tt.Error(\"expected traceparent to be set in context\")\n\t}\n}\n\nfunc TestToolInvocationTraceContext(t *testing.T) {\n\totel.SetTextMapPropagator(propagation.TraceContext{})\n\tdefer otel.SetTextMapPropagator(propagation.NewCompositeTextMapPropagator())\n\n\ttraceparent := \"00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01\"\n\tctx := contextWithTraceParent(context.Background(), traceparent, \"\")\n\n\tinv := ToolInvocation{\n\t\tSessionID: \"sess-1\",\n\t\tToolCallID: \"call-1\",\n\t\tToolName: \"my_tool\",\n\t\tArguments: nil,\n\t\tTraceContext: ctx,\n\t}\n\n\t// The TraceContext should carry the remote span context\n\tsc := trace.SpanContextFromContext(inv.TraceContext)\n\tif !sc.IsValid() {\n\t\tt.Fatal(\"expected valid span context on ToolInvocation.TraceContext\")\n\t}\n\tif sc.TraceID().String() != \"4bf92f3577b34da6a3ce929d0e0e4736\" {\n\t\tt.Errorf(\"unexpected trace ID: %s\", sc.TraceID())\n\t}\n\tif sc.SpanID().String() != \"00f067aa0ba902b7\" {\n\t\tt.Errorf(\"unexpected span ID: %s\", sc.SpanID())\n\t}\n}\n" }, { "path": "go/test.sh", "content": "#!/bin/bash\n# Test script for Go SDK (when Go is available)\n\nset -e\n\necho \"=== Testing Go SDK ===\"\necho\n\n# Check prerequisites\nif ! command -v go &> /dev/null; then\n echo \"❌ Go is not installed. Please install Go 1.24 or later.\"\n echo \" Visit: https://golang.org/dl/\"\n exit 1\nfi\n\n# Determine COPILOT_CLI_PATH\nif [ -z \"$COPILOT_CLI_PATH\" ]; then\n # Try to find it relative to the SDK\n SCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\n POTENTIAL_PATH=\"$SCRIPT_DIR/../nodejs/node_modules/@github/copilot/index.js\"\n if [ -f \"$POTENTIAL_PATH\" ]; then\n export COPILOT_CLI_PATH=\"$POTENTIAL_PATH\"\n echo \"📍 Auto-detected CLI path: $COPILOT_CLI_PATH\"\n else\n echo \"❌ COPILOT_CLI_PATH environment variable not set\"\n echo \" Run: export COPILOT_CLI_PATH=/path/to/dist-cli/index.js\"\n exit 1\n fi\nfi\n\nif [ ! -f \"$COPILOT_CLI_PATH\" ]; then\n echo \"❌ CLI not found at: $COPILOT_CLI_PATH\"\n exit 1\nfi\n\necho \"✅ Go version: $(go version)\"\necho \"✅ CLI path: $COPILOT_CLI_PATH\"\necho\n\n# Run Go tests\ncd \"$(dirname \"$0\")\"\n\necho \"=== Running Go SDK E2E Tests ===\"\necho\n\ngo test -v ./... -race\n\necho\necho \"✅ All tests passed!\"\n" }, { "path": "go/types.go", "content": "package copilot\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\n\t\"github.com/github/copilot-sdk/go/rpc\"\n)\n\n// ConnectionState represents the client connection state\ntype ConnectionState string\n\nconst (\n\tStateDisconnected ConnectionState = \"disconnected\"\n\tStateConnecting ConnectionState = \"connecting\"\n\tStateConnected ConnectionState = \"connected\"\n\tStateError ConnectionState = \"error\"\n)\n\n// ClientOptions configures the CopilotClient\ntype ClientOptions struct {\n\t// CLIPath is the path to the Copilot CLI executable (default: \"copilot\")\n\tCLIPath string\n\t// CLIArgs are extra arguments to pass to the CLI executable (inserted before SDK-managed args)\n\tCLIArgs []string\n\t// Cwd is the working directory for the CLI process (default: \"\" = inherit from current process)\n\tCwd string\n\t// Port for TCP transport (default: 0 = random port)\n\tPort int\n\t// UseStdio controls whether to use stdio transport instead of TCP.\n\t// Default: nil (use default = true, i.e. stdio). Use Bool(false) to explicitly select TCP.\n\tUseStdio *bool\n\t// CLIUrl is the URL of an existing Copilot CLI server to connect to over TCP\n\t// Format: \"host:port\", \"http://host:port\", or just \"port\" (defaults to localhost)\n\t// Examples: \"localhost:8080\", \"http://127.0.0.1:9000\", \"8080\"\n\t// Mutually exclusive with CLIPath, UseStdio\n\tCLIUrl string\n\t// LogLevel for the CLI server\n\tLogLevel string\n\t// AutoStart automatically starts the CLI server on first use (default: true).\n\t// Use Bool(false) to disable.\n\tAutoStart *bool\n\t// Deprecated: AutoRestart has no effect and will be removed in a future release.\n\tAutoRestart *bool\n\t// Env is the environment variables for the CLI process (default: inherits from current process).\n\t// Each entry is of the form \"key=value\".\n\t// If Env is nil, the new process uses the current process's environment.\n\t// If Env contains duplicate environment keys, only the last value in the\n\t// slice for each duplicate key is used.\n\tEnv []string\n\t// GitHubToken is the GitHub token to use for authentication.\n\t// When provided, the token is passed to the CLI server via environment variable.\n\t// This takes priority over other authentication methods.\n\tGitHubToken string\n\t// UseLoggedInUser controls whether to use the logged-in user for authentication.\n\t// When true, the CLI server will attempt to use stored OAuth tokens or gh CLI auth.\n\t// When false, only explicit tokens (GitHubToken or environment variables) are used.\n\t// Default: true (but defaults to false when GitHubToken is provided).\n\t// Use Bool(false) to explicitly disable.\n\tUseLoggedInUser *bool\n\t// OnListModels is a custom handler for listing available models.\n\t// When provided, client.ListModels() calls this handler instead of\n\t// querying the CLI server. Useful in BYOK mode to return models\n\t// available from your custom provider.\n\tOnListModels func(ctx context.Context) ([]ModelInfo, error)\n\t// SessionFs configures a custom session filesystem provider.\n\t// When provided, the client registers as the session filesystem provider\n\t// on connection, routing session-scoped file I/O through per-session handlers.\n\tSessionFs *SessionFsConfig\n\t// Telemetry configures OpenTelemetry integration for the Copilot CLI process.\n\t// When non-nil, COPILOT_OTEL_ENABLED=true is set and any populated fields\n\t// are mapped to the corresponding environment variables.\n\tTelemetry *TelemetryConfig\n\t// SessionIdleTimeoutSeconds configures the server-wide session idle timeout in seconds.\n\t// Sessions without activity for this duration are automatically cleaned up.\n\t// Set to 0 or leave unset to disable (sessions live indefinitely).\n\t// This option is only used when the SDK spawns the CLI process; it is ignored\n\t// when connecting to an external server via CLIUrl.\n\tSessionIdleTimeoutSeconds int\n}\n\n// TelemetryConfig configures OpenTelemetry integration for the Copilot CLI process.\ntype TelemetryConfig struct {\n\t// OTLPEndpoint is the OTLP HTTP endpoint URL for trace/metric export.\n\t// Sets OTEL_EXPORTER_OTLP_ENDPOINT.\n\tOTLPEndpoint string\n\n\t// FilePath is the file path for JSON-lines trace output.\n\t// Sets COPILOT_OTEL_FILE_EXPORTER_PATH.\n\tFilePath string\n\n\t// ExporterType is the exporter backend type: \"otlp-http\" or \"file\".\n\t// Sets COPILOT_OTEL_EXPORTER_TYPE.\n\tExporterType string\n\n\t// SourceName is the instrumentation scope name.\n\t// Sets COPILOT_OTEL_SOURCE_NAME.\n\tSourceName string\n\n\t// CaptureContent controls whether to capture message content (prompts, responses).\n\t// Sets OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT.\n\tCaptureContent *bool\n}\n\n// Bool returns a pointer to the given bool value.\n// Use for option fields such as AutoStart, AutoRestart, or LogOptions.Ephemeral:\n//\n//\tAutoStart: Bool(false)\n//\tEphemeral: Bool(true)\nfunc Bool(v bool) *bool {\n\treturn &v\n}\n\n// String returns a pointer to the given string value.\n// Use for setting optional string parameters in RPC calls.\nfunc String(v string) *string {\n\treturn &v\n}\n\n// Float64 returns a pointer to the given float64 value.\n// Use for setting thresholds: BackgroundCompactionThreshold: Float64(0.80)\nfunc Float64(v float64) *float64 {\n\treturn &v\n}\n\n// Int returns a pointer to the given int value.\n// Use for setting optional int parameters: MinLength: Int(1)\nfunc Int(v int) *int {\n\treturn &v\n}\n\n// Known system prompt section identifiers for the \"customize\" mode.\nconst (\n\tSectionIdentity = \"identity\"\n\tSectionTone = \"tone\"\n\tSectionToolEfficiency = \"tool_efficiency\"\n\tSectionEnvironmentContext = \"environment_context\"\n\tSectionCodeChangeRules = \"code_change_rules\"\n\tSectionGuidelines = \"guidelines\"\n\tSectionSafety = \"safety\"\n\tSectionToolInstructions = \"tool_instructions\"\n\tSectionCustomInstructions = \"custom_instructions\"\n\tSectionLastInstructions = \"last_instructions\"\n)\n\n// SectionOverrideAction represents the action to perform on a system prompt section.\ntype SectionOverrideAction string\n\nconst (\n\t// SectionActionReplace replaces section content entirely.\n\tSectionActionReplace SectionOverrideAction = \"replace\"\n\t// SectionActionRemove removes the section.\n\tSectionActionRemove SectionOverrideAction = \"remove\"\n\t// SectionActionAppend appends to existing section content.\n\tSectionActionAppend SectionOverrideAction = \"append\"\n\t// SectionActionPrepend prepends to existing section content.\n\tSectionActionPrepend SectionOverrideAction = \"prepend\"\n)\n\n// SectionTransformFn is a callback that receives the current content of a system prompt section\n// and returns the transformed content. Used with the \"transform\" action to read-then-write\n// modify sections at runtime.\ntype SectionTransformFn func(currentContent string) (string, error)\n\n// SectionOverride defines an override operation for a single system prompt section.\ntype SectionOverride struct {\n\t// Action is the operation to perform: \"replace\", \"remove\", \"append\", \"prepend\", or \"transform\".\n\tAction SectionOverrideAction `json:\"action,omitempty\"`\n\t// Content for the override. Optional for all actions. Ignored for \"remove\".\n\tContent string `json:\"content,omitempty\"`\n\t// Transform is a callback invoked when Action is \"transform\".\n\t// The runtime calls this with the current section content and uses the returned string.\n\t// Excluded from JSON serialization; the SDK registers it as an RPC callback internally.\n\tTransform SectionTransformFn `json:\"-\"`\n}\n\n// SystemMessageAppendConfig is append mode: use CLI foundation with optional appended content.\ntype SystemMessageAppendConfig struct {\n\t// Mode is optional, defaults to \"append\"\n\tMode string `json:\"mode,omitempty\"`\n\t// Content provides additional instructions appended after SDK-managed sections\n\tContent string `json:\"content,omitempty\"`\n}\n\n// SystemMessageReplaceConfig is replace mode: use caller-provided system message entirely.\n// Removes all SDK guardrails including security restrictions.\ntype SystemMessageReplaceConfig struct {\n\t// Mode must be \"replace\"\n\tMode string `json:\"mode\"`\n\t// Content is the complete system message (required)\n\tContent string `json:\"content\"`\n}\n\n// SystemMessageConfig represents system message configuration for session creation.\n// - Append mode (default): SDK foundation + optional custom content\n// - Replace mode: Full control, caller provides entire system message\n// - Customize mode: Section-level overrides with graceful fallback\n//\n// In Go, use one struct and set fields appropriate for the desired mode.\ntype SystemMessageConfig struct {\n\tMode string `json:\"mode,omitempty\"`\n\tContent string `json:\"content,omitempty\"`\n\tSections map[string]SectionOverride `json:\"sections,omitempty\"`\n}\n\n// PermissionRequestResultKind represents the kind of a permission request result.\ntype PermissionRequestResultKind string\n\nconst (\n\t// PermissionRequestResultKindApproved indicates the permission was approved for this one instance.\n\tPermissionRequestResultKindApproved PermissionRequestResultKind = \"approve-once\"\n\n\t// PermissionRequestResultKindRejected indicates the permission was denied interactively by the user.\n\tPermissionRequestResultKindRejected PermissionRequestResultKind = \"reject\"\n\n\t// PermissionRequestResultKindUserNotAvailable indicates the permission was denied because\n\t// user confirmation was unavailable.\n\tPermissionRequestResultKindUserNotAvailable PermissionRequestResultKind = \"user-not-available\"\n\n\t// PermissionRequestResultKindNoResult indicates no permission decision was made.\n\tPermissionRequestResultKindNoResult PermissionRequestResultKind = \"no-result\"\n\n\t// Deprecated: Use PermissionRequestResultKindRejected instead.\n\tPermissionRequestResultKindDeniedInteractivelyByUser = PermissionRequestResultKindRejected\n\n\t// Deprecated: Use PermissionRequestResultKindUserNotAvailable instead.\n\tPermissionRequestResultKindDeniedCouldNotRequestFromUser = PermissionRequestResultKindUserNotAvailable\n\n\t// Deprecated: Use PermissionRequestResultKindUserNotAvailable instead.\n\tPermissionRequestResultKindDeniedByRules = PermissionRequestResultKindUserNotAvailable\n)\n\n// PermissionRequestResult represents the result of a permission request\ntype PermissionRequestResult struct {\n\tKind PermissionRequestResultKind `json:\"kind\"`\n\tRules []any `json:\"rules,omitempty\"`\n}\n\n// PermissionHandlerFunc executes a permission request\n// The handler should return a PermissionRequestResult. Returning an error denies the permission.\ntype PermissionHandlerFunc func(request PermissionRequest, invocation PermissionInvocation) (PermissionRequestResult, error)\n\n// PermissionInvocation provides context about a permission request\ntype PermissionInvocation struct {\n\tSessionID string\n}\n\n// UserInputRequest represents a request for user input from the agent\ntype UserInputRequest struct {\n\tQuestion string\n\tChoices []string\n\tAllowFreeform *bool\n}\n\n// UserInputResponse represents the user's response to an input request\ntype UserInputResponse struct {\n\tAnswer string\n\tWasFreeform bool\n}\n\n// UserInputHandler handles user input requests from the agent\n// The handler should return a UserInputResponse. Returning an error fails the request.\ntype UserInputHandler func(request UserInputRequest, invocation UserInputInvocation) (UserInputResponse, error)\n\n// UserInputInvocation provides context about a user input request\ntype UserInputInvocation struct {\n\tSessionID string\n}\n\n// PreToolUseHookInput is the input for a pre-tool-use hook\ntype PreToolUseHookInput struct {\n\tTimestamp int64 `json:\"timestamp\"`\n\tCwd string `json:\"cwd\"`\n\tToolName string `json:\"toolName\"`\n\tToolArgs any `json:\"toolArgs\"`\n}\n\n// PreToolUseHookOutput is the output for a pre-tool-use hook\ntype PreToolUseHookOutput struct {\n\tPermissionDecision string `json:\"permissionDecision,omitempty\"` // \"allow\", \"deny\", \"ask\"\n\tPermissionDecisionReason string `json:\"permissionDecisionReason,omitempty\"`\n\tModifiedArgs any `json:\"modifiedArgs,omitempty\"`\n\tAdditionalContext string `json:\"additionalContext,omitempty\"`\n\tSuppressOutput bool `json:\"suppressOutput,omitempty\"`\n}\n\n// PreToolUseHandler handles pre-tool-use hook invocations\ntype PreToolUseHandler func(input PreToolUseHookInput, invocation HookInvocation) (*PreToolUseHookOutput, error)\n\n// PostToolUseHookInput is the input for a post-tool-use hook\ntype PostToolUseHookInput struct {\n\tTimestamp int64 `json:\"timestamp\"`\n\tCwd string `json:\"cwd\"`\n\tToolName string `json:\"toolName\"`\n\tToolArgs any `json:\"toolArgs\"`\n\tToolResult any `json:\"toolResult\"`\n}\n\n// PostToolUseHookOutput is the output for a post-tool-use hook\ntype PostToolUseHookOutput struct {\n\tModifiedResult any `json:\"modifiedResult,omitempty\"`\n\tAdditionalContext string `json:\"additionalContext,omitempty\"`\n\tSuppressOutput bool `json:\"suppressOutput,omitempty\"`\n}\n\n// PostToolUseHandler handles post-tool-use hook invocations\ntype PostToolUseHandler func(input PostToolUseHookInput, invocation HookInvocation) (*PostToolUseHookOutput, error)\n\n// UserPromptSubmittedHookInput is the input for a user-prompt-submitted hook\ntype UserPromptSubmittedHookInput struct {\n\tTimestamp int64 `json:\"timestamp\"`\n\tCwd string `json:\"cwd\"`\n\tPrompt string `json:\"prompt\"`\n}\n\n// UserPromptSubmittedHookOutput is the output for a user-prompt-submitted hook\ntype UserPromptSubmittedHookOutput struct {\n\tModifiedPrompt string `json:\"modifiedPrompt,omitempty\"`\n\tAdditionalContext string `json:\"additionalContext,omitempty\"`\n\tSuppressOutput bool `json:\"suppressOutput,omitempty\"`\n}\n\n// UserPromptSubmittedHandler handles user-prompt-submitted hook invocations\ntype UserPromptSubmittedHandler func(input UserPromptSubmittedHookInput, invocation HookInvocation) (*UserPromptSubmittedHookOutput, error)\n\n// SessionStartHookInput is the input for a session-start hook\ntype SessionStartHookInput struct {\n\tTimestamp int64 `json:\"timestamp\"`\n\tCwd string `json:\"cwd\"`\n\tSource string `json:\"source\"` // \"startup\", \"resume\", \"new\"\n\tInitialPrompt string `json:\"initialPrompt,omitempty\"`\n}\n\n// SessionStartHookOutput is the output for a session-start hook\ntype SessionStartHookOutput struct {\n\tAdditionalContext string `json:\"additionalContext,omitempty\"`\n\tModifiedConfig map[string]any `json:\"modifiedConfig,omitempty\"`\n}\n\n// SessionStartHandler handles session-start hook invocations\ntype SessionStartHandler func(input SessionStartHookInput, invocation HookInvocation) (*SessionStartHookOutput, error)\n\n// SessionEndHookInput is the input for a session-end hook\ntype SessionEndHookInput struct {\n\tTimestamp int64 `json:\"timestamp\"`\n\tCwd string `json:\"cwd\"`\n\tReason string `json:\"reason\"` // \"complete\", \"error\", \"abort\", \"timeout\", \"user_exit\"\n\tFinalMessage string `json:\"finalMessage,omitempty\"`\n\tError string `json:\"error,omitempty\"`\n}\n\n// SessionEndHookOutput is the output for a session-end hook\ntype SessionEndHookOutput struct {\n\tSuppressOutput bool `json:\"suppressOutput,omitempty\"`\n\tCleanupActions []string `json:\"cleanupActions,omitempty\"`\n\tSessionSummary string `json:\"sessionSummary,omitempty\"`\n}\n\n// SessionEndHandler handles session-end hook invocations\ntype SessionEndHandler func(input SessionEndHookInput, invocation HookInvocation) (*SessionEndHookOutput, error)\n\n// ErrorOccurredHookInput is the input for an error-occurred hook\ntype ErrorOccurredHookInput struct {\n\tTimestamp int64 `json:\"timestamp\"`\n\tCwd string `json:\"cwd\"`\n\tError string `json:\"error\"`\n\tErrorContext string `json:\"errorContext\"` // \"model_call\", \"tool_execution\", \"system\", \"user_input\"\n\tRecoverable bool `json:\"recoverable\"`\n}\n\n// ErrorOccurredHookOutput is the output for an error-occurred hook\ntype ErrorOccurredHookOutput struct {\n\tSuppressOutput bool `json:\"suppressOutput,omitempty\"`\n\tErrorHandling string `json:\"errorHandling,omitempty\"` // \"retry\", \"skip\", \"abort\"\n\tRetryCount int `json:\"retryCount,omitempty\"`\n\tUserNotification string `json:\"userNotification,omitempty\"`\n}\n\n// ErrorOccurredHandler handles error-occurred hook invocations\ntype ErrorOccurredHandler func(input ErrorOccurredHookInput, invocation HookInvocation) (*ErrorOccurredHookOutput, error)\n\n// HookInvocation provides context about a hook invocation\ntype HookInvocation struct {\n\tSessionID string\n}\n\n// SessionHooks configures hook handlers for a session\ntype SessionHooks struct {\n\tOnPreToolUse PreToolUseHandler\n\tOnPostToolUse PostToolUseHandler\n\tOnUserPromptSubmitted UserPromptSubmittedHandler\n\tOnSessionStart SessionStartHandler\n\tOnSessionEnd SessionEndHandler\n\tOnErrorOccurred ErrorOccurredHandler\n}\n\n// MCPServerConfig is implemented by MCP server configuration types.\n// Only MCPStdioServerConfig and MCPHTTPServerConfig implement this interface.\ntype MCPServerConfig interface {\n\tmcpServerConfig()\n}\n\n// MCPStdioServerConfig configures a local/stdio MCP server.\ntype MCPStdioServerConfig struct {\n\tTools []string `json:\"tools\"`\n\tTimeout int `json:\"timeout,omitempty\"`\n\tCommand string `json:\"command\"`\n\tArgs []string `json:\"args\"`\n\tEnv map[string]string `json:\"env,omitempty\"`\n\tCwd string `json:\"cwd,omitempty\"`\n}\n\nfunc (MCPStdioServerConfig) mcpServerConfig() {}\n\n// MarshalJSON implements json.Marshaler, injecting the \"type\" discriminator.\nfunc (c MCPStdioServerConfig) MarshalJSON() ([]byte, error) {\n\ttype alias MCPStdioServerConfig\n\treturn json.Marshal(struct {\n\t\tType string `json:\"type\"`\n\t\talias\n\t}{\n\t\tType: \"stdio\",\n\t\talias: alias(c),\n\t})\n}\n\n// MCPHTTPServerConfig configures a remote MCP server (HTTP or SSE).\ntype MCPHTTPServerConfig struct {\n\tTools []string `json:\"tools\"`\n\tTimeout int `json:\"timeout,omitempty\"`\n\tURL string `json:\"url\"`\n\tHeaders map[string]string `json:\"headers,omitempty\"`\n}\n\nfunc (MCPHTTPServerConfig) mcpServerConfig() {}\n\n// MarshalJSON implements json.Marshaler, injecting the \"type\" discriminator.\nfunc (c MCPHTTPServerConfig) MarshalJSON() ([]byte, error) {\n\ttype alias MCPHTTPServerConfig\n\treturn json.Marshal(struct {\n\t\tType string `json:\"type\"`\n\t\talias\n\t}{\n\t\tType: \"http\",\n\t\talias: alias(c),\n\t})\n}\n\n// CustomAgentConfig configures a custom agent\ntype CustomAgentConfig struct {\n\t// Name is the unique name of the custom agent\n\tName string `json:\"name\"`\n\t// DisplayName is the display name for UI purposes\n\tDisplayName string `json:\"displayName,omitempty\"`\n\t// Description of what the agent does\n\tDescription string `json:\"description,omitempty\"`\n\t// Tools is the list of tool names the agent can use (nil for all tools)\n\tTools []string `json:\"tools,omitempty\"`\n\t// Prompt is the prompt content for the agent\n\tPrompt string `json:\"prompt\"`\n\t// MCPServers are MCP servers specific to this agent\n\tMCPServers map[string]MCPServerConfig `json:\"mcpServers,omitempty\"`\n\t// Infer indicates whether the agent should be available for model inference\n\tInfer *bool `json:\"infer,omitempty\"`\n\t// Skills is the list of skill names to preload into this agent's context at startup (opt-in; omit for none)\n\tSkills []string `json:\"skills,omitempty\"`\n}\n\n// DefaultAgentConfig configures the default agent (the built-in agent that handles turns when no custom agent is selected).\n// Use ExcludedTools to hide specific tools from the default agent while keeping\n// them available to custom sub-agents.\ntype DefaultAgentConfig struct {\n\t// ExcludedTools is a list of tool names to exclude from the default agent.\n\t// These tools remain available to custom sub-agents that reference them in their Tools list.\n\tExcludedTools []string `json:\"excludedTools,omitempty\"`\n}\n\n// InfiniteSessionConfig configures infinite sessions with automatic context compaction\n// and workspace persistence. When enabled, sessions automatically manage context window\n// limits through background compaction and persist state to a workspace directory.\ntype InfiniteSessionConfig struct {\n\t// Enabled controls whether infinite sessions are enabled (default: true)\n\tEnabled *bool `json:\"enabled,omitempty\"`\n\t// BackgroundCompactionThreshold is the context utilization (0.0-1.0) at which\n\t// background compaction starts. Default: 0.80\n\tBackgroundCompactionThreshold *float64 `json:\"backgroundCompactionThreshold,omitempty\"`\n\t// BufferExhaustionThreshold is the context utilization (0.0-1.0) at which\n\t// the session blocks until compaction completes. Default: 0.95\n\tBufferExhaustionThreshold *float64 `json:\"bufferExhaustionThreshold,omitempty\"`\n}\n\n// SessionFsConfig configures a custom session filesystem provider.\ntype SessionFsConfig struct {\n\t// InitialCwd is the initial working directory for sessions.\n\tInitialCwd string\n\t// SessionStatePath is the path within each session's filesystem where the runtime stores\n\t// session-scoped files such as events, checkpoints, and temp files.\n\tSessionStatePath string\n\t// Conventions identifies the path conventions used by this filesystem provider.\n\tConventions rpc.SessionFSSetProviderConventions\n}\n\n// SessionConfig configures a new session\ntype SessionConfig struct {\n\t// SessionID is an optional custom session ID\n\tSessionID string\n\t// ClientName identifies the application using the SDK.\n\t// Included in the User-Agent header for API requests.\n\tClientName string\n\t// Model to use for this session\n\tModel string\n\t// ReasoningEffort level for models that support it.\n\t// Valid values: \"low\", \"medium\", \"high\", \"xhigh\"\n\t// Only applies to models where capabilities.supports.reasoningEffort is true.\n\tReasoningEffort string\n\t// ConfigDir overrides the default configuration directory location.\n\t// When specified, the session will use this directory for storing config and state.\n\tConfigDir string\n\t// EnableConfigDiscovery, when true, automatically discovers MCP server configurations\n\t// (e.g. .mcp.json, .vscode/mcp.json) and skill directories from the working directory\n\t// and merges them with any explicitly provided MCPServers and SkillDirectories, with\n\t// explicit values taking precedence on name collision.\n\t// Custom instruction files (.github/copilot-instructions.md, AGENTS.md, etc.) are\n\t// always loaded from the working directory regardless of this setting.\n\tEnableConfigDiscovery bool\n\t// Tools exposes caller-implemented tools to the CLI\n\tTools []Tool\n\t// SystemMessage configures system message customization\n\tSystemMessage *SystemMessageConfig\n\t// AvailableTools is a list of tool names to allow. When specified, only these tools will be available.\n\t// Takes precedence over ExcludedTools.\n\tAvailableTools []string\n\t// ExcludedTools is a list of tool names to disable. All other tools remain available.\n\t// Ignored if AvailableTools is specified.\n\tExcludedTools []string\n\t// OnPermissionRequest is a handler for permission requests from the server.\n\t// If nil, all permission requests are denied by default.\n\t// Provide a handler to approve operations (file writes, shell commands, URL fetches, etc.).\n\tOnPermissionRequest PermissionHandlerFunc\n\t// OnUserInputRequest is a handler for user input requests from the agent (enables ask_user tool)\n\tOnUserInputRequest UserInputHandler\n\t// Hooks configures hook handlers for session lifecycle events\n\tHooks *SessionHooks\n\t// WorkingDirectory is the working directory for the session.\n\t// Tool operations will be relative to this directory.\n\tWorkingDirectory string\n\t// Streaming enables streaming of assistant message and reasoning chunks.\n\t// When true, assistant.message_delta and assistant.reasoning_delta events\n\t// with deltaContent are sent as the response is generated.\n\tStreaming bool\n\t// IncludeSubAgentStreamingEvents includes sub-agent streaming events in the\n\t// event stream. When true, streaming delta events from sub-agents (e.g.,\n\t// assistant.message_delta, assistant.reasoning_delta, assistant.streaming_delta\n\t// with agentId set) are forwarded to this connection. When false, only\n\t// non-streaming sub-agent events and subagent.* lifecycle events are forwarded;\n\t// streaming deltas from sub-agents are suppressed. When nil, defaults to true.\n\tIncludeSubAgentStreamingEvents *bool\n\t// Provider configures a custom model provider (BYOK)\n\tProvider *ProviderConfig\n\t// ModelCapabilities overrides individual model capabilities resolved by the runtime.\n\t// Only non-nil fields are applied over the runtime-resolved capabilities.\n\tModelCapabilities *rpc.ModelCapabilitiesOverride\n\t// MCPServers configures MCP servers for the session\n\tMCPServers map[string]MCPServerConfig\n\t// CustomAgents configures custom agents for the session\n\tCustomAgents []CustomAgentConfig\n\t// DefaultAgent configures the default agent (the built-in agent that handles turns when no custom agent is selected).\n\t// Use ExcludedTools to hide tools from the default agent while keeping them available to sub-agents.\n\tDefaultAgent *DefaultAgentConfig\n\t// Agent is the name of the custom agent to activate when the session starts.\n\t// Must match the Name of one of the agents in CustomAgents.\n\tAgent string\n\t// SkillDirectories is a list of directories to load skills from\n\tSkillDirectories []string\n\t// DisabledSkills is a list of skill names to disable\n\tDisabledSkills []string\n\t// InfiniteSessions configures infinite sessions for persistent workspaces and automatic compaction.\n\t// When enabled (default), sessions automatically manage context limits and persist state.\n\tInfiniteSessions *InfiniteSessionConfig\n\t// OnEvent is an optional event handler that is registered on the session before\n\t// the session.create RPC is issued. This guarantees that early events emitted\n\t// by the CLI during session creation (e.g. session.start) are delivered to the\n\t// handler. Equivalent to calling session.On(handler) immediately after creation,\n\t// but executes earlier in the lifecycle so no events are missed.\n\tOnEvent SessionEventHandler\n\t// CreateSessionFsHandler supplies a handler for session filesystem operations.\n\t// This takes effect only when ClientOptions.SessionFs is configured.\n\tCreateSessionFsHandler func(session *Session) SessionFsProvider\n\t// Commands registers slash-commands for this session. Each command appears as\n\t// /name in the CLI TUI for the user to invoke. The Handler is called when the\n\t// command is executed.\n\tCommands []CommandDefinition\n\t// OnElicitationRequest is a handler for elicitation requests from the server.\n\t// When provided, the server may call back to this client for form-based UI dialogs\n\t// (e.g. from MCP tools). Also enables the elicitation capability on the session.\n\tOnElicitationRequest ElicitationHandler\n\t// GitHubToken is an optional per-session GitHub token used for authentication.\n\t// When provided, the session authenticates as the token's owner instead of\n\t// using the global client-level auth.\n\tGitHubToken string `json:\"-\"`\n}\ntype Tool struct {\n\tName string `json:\"name\"`\n\tDescription string `json:\"description,omitempty\"`\n\tParameters map[string]any `json:\"parameters,omitempty\"`\n\tOverridesBuiltInTool bool `json:\"overridesBuiltInTool,omitempty\"`\n\tSkipPermission bool `json:\"skipPermission,omitempty\"`\n\tHandler ToolHandler `json:\"-\"`\n}\n\n// ToolInvocation describes a tool call initiated by Copilot\ntype ToolInvocation struct {\n\tSessionID string\n\tToolCallID string\n\tToolName string\n\tArguments any\n\n\t// TraceContext carries the W3C Trace Context propagated from the CLI's\n\t// execute_tool span. Pass this to OpenTelemetry-aware code so that\n\t// child spans created inside the handler are parented to the CLI span.\n\t// When no trace context is available this will be context.Background().\n\tTraceContext context.Context\n}\n\n// ToolHandler executes a tool invocation.\n// The handler should return a ToolResult. Returning an error marks the tool execution as a failure.\ntype ToolHandler func(invocation ToolInvocation) (ToolResult, error)\n\n// ToolResult represents the result of a tool invocation.\ntype ToolResult struct {\n\tTextResultForLLM string `json:\"textResultForLlm\"`\n\tBinaryResultsForLLM []ToolBinaryResult `json:\"binaryResultsForLlm,omitempty\"`\n\tResultType string `json:\"resultType\"`\n\tError string `json:\"error,omitempty\"`\n\tSessionLog string `json:\"sessionLog,omitempty\"`\n\tToolTelemetry map[string]any `json:\"toolTelemetry,omitempty\"`\n}\n\n// CommandContext provides context about a slash-command invocation.\ntype CommandContext struct {\n\t// SessionID is the session where the command was invoked.\n\tSessionID string\n\t// Command is the full command text (e.g. \"/deploy production\").\n\tCommand string\n\t// CommandName is the command name without the leading / (e.g. \"deploy\").\n\tCommandName string\n\t// Args is the raw argument string after the command name.\n\tArgs string\n}\n\n// CommandHandler is invoked when a registered slash-command is executed.\ntype CommandHandler func(ctx CommandContext) error\n\n// CommandDefinition registers a slash-command. Name is shown in the CLI TUI\n// as /name for the user to invoke.\ntype CommandDefinition struct {\n\t// Name is the command name (without leading /).\n\tName string\n\t// Description is a human-readable description shown in command completion UI.\n\tDescription string\n\t// Handler is invoked when the command is executed.\n\tHandler CommandHandler\n}\n\n// SessionCapabilities describes what features the host supports.\ntype SessionCapabilities struct {\n\tUI *UICapabilities `json:\"ui,omitempty\"`\n}\n\n// UICapabilities describes host UI feature support.\ntype UICapabilities struct {\n\t// Elicitation indicates whether the host supports interactive elicitation dialogs.\n\tElicitation bool `json:\"elicitation,omitempty\"`\n}\n\n// ElicitationResult is the user's response to an elicitation dialog.\ntype ElicitationResult struct {\n\t// Action is the user response: \"accept\" (submitted), \"decline\" (rejected), or \"cancel\" (dismissed).\n\tAction string `json:\"action\"`\n\t// Content holds form values submitted by the user (present when Action is \"accept\").\n\tContent map[string]any `json:\"content,omitempty\"`\n}\n\n// ElicitationContext describes an elicitation request from the server,\n// combining the request data with session context. Mirrors the\n// single-argument pattern of CommandContext.\ntype ElicitationContext struct {\n\t// SessionID is the identifier of the session that triggered the request.\n\tSessionID string\n\t// Message describes what information is needed from the user.\n\tMessage string\n\t// RequestedSchema is a JSON Schema describing the form fields (form mode only).\n\tRequestedSchema map[string]any\n\t// Mode is \"form\" for structured input, \"url\" for browser redirect.\n\tMode string\n\t// ElicitationSource is the source that initiated the request (e.g. MCP server name).\n\tElicitationSource string\n\t// URL to open in the user's browser (url mode only).\n\tURL string\n}\n\n// ElicitationHandler handles elicitation requests from the server (e.g. from MCP tools).\n// It receives an ElicitationContext and must return an ElicitationResult.\n// If the handler returns an error the SDK auto-cancels the request.\ntype ElicitationHandler func(ctx ElicitationContext) (ElicitationResult, error)\n\n// InputOptions configures a text input field for the Input convenience method.\ntype InputOptions struct {\n\t// Title label for the input field.\n\tTitle string\n\t// Description text shown below the field.\n\tDescription string\n\t// MinLength is the minimum character length.\n\tMinLength *int\n\t// MaxLength is the maximum character length.\n\tMaxLength *int\n\t// Format is a semantic format hint: \"email\", \"uri\", \"date\", or \"date-time\".\n\tFormat string\n\t// Default is the pre-populated value.\n\tDefault string\n}\n\n// SessionUI provides convenience methods for showing elicitation dialogs to the user.\n// Obtained via [Session.UI]. Methods error if the host does not support elicitation.\ntype SessionUI struct {\n\tsession *Session\n}\n\n// ResumeSessionConfig configures options when resuming a session\ntype ResumeSessionConfig struct {\n\t// ClientName identifies the application using the SDK.\n\t// Included in the User-Agent header for API requests.\n\tClientName string\n\t// Model to use for this session. Can change the model when resuming.\n\tModel string\n\t// Tools exposes caller-implemented tools to the CLI\n\tTools []Tool\n\t// SystemMessage configures system message customization\n\tSystemMessage *SystemMessageConfig\n\t// AvailableTools is a list of tool names to allow. When specified, only these tools will be available.\n\t// Takes precedence over ExcludedTools.\n\tAvailableTools []string\n\t// ExcludedTools is a list of tool names to disable. All other tools remain available.\n\t// Ignored if AvailableTools is specified.\n\tExcludedTools []string\n\t// Provider configures a custom model provider\n\tProvider *ProviderConfig\n\t// ModelCapabilities overrides individual model capabilities resolved by the runtime.\n\t// Only non-nil fields are applied over the runtime-resolved capabilities.\n\tModelCapabilities *rpc.ModelCapabilitiesOverride\n\t// ReasoningEffort level for models that support it.\n\t// Valid values: \"low\", \"medium\", \"high\", \"xhigh\"\n\tReasoningEffort string\n\t// OnPermissionRequest is a handler for permission requests from the server.\n\t// If nil, all permission requests are denied by default.\n\t// Provide a handler to approve operations (file writes, shell commands, URL fetches, etc.).\n\tOnPermissionRequest PermissionHandlerFunc\n\t// OnUserInputRequest is a handler for user input requests from the agent (enables ask_user tool)\n\tOnUserInputRequest UserInputHandler\n\t// Hooks configures hook handlers for session lifecycle events\n\tHooks *SessionHooks\n\t// WorkingDirectory is the working directory for the session.\n\t// Tool operations will be relative to this directory.\n\tWorkingDirectory string\n\t// ConfigDir overrides the default configuration directory location.\n\tConfigDir string\n\t// EnableConfigDiscovery, when true, automatically discovers MCP server configurations\n\t// (e.g. .mcp.json, .vscode/mcp.json) and skill directories from the working directory\n\t// and merges them with any explicitly provided MCPServers and SkillDirectories, with\n\t// explicit values taking precedence on name collision.\n\t// Custom instruction files (.github/copilot-instructions.md, AGENTS.md, etc.) are\n\t// always loaded from the working directory regardless of this setting.\n\tEnableConfigDiscovery bool\n\t// Streaming enables streaming of assistant message and reasoning chunks.\n\t// When true, assistant.message_delta and assistant.reasoning_delta events\n\t// with deltaContent are sent as the response is generated.\n\tStreaming bool\n\t// IncludeSubAgentStreamingEvents includes sub-agent streaming events in the\n\t// event stream. When true, streaming delta events from sub-agents (e.g.,\n\t// assistant.message_delta, assistant.reasoning_delta, assistant.streaming_delta\n\t// with agentId set) are forwarded to this connection. When false, only\n\t// non-streaming sub-agent events and subagent.* lifecycle events are forwarded;\n\t// streaming deltas from sub-agents are suppressed. When nil, defaults to true.\n\tIncludeSubAgentStreamingEvents *bool\n\t// MCPServers configures MCP servers for the session\n\tMCPServers map[string]MCPServerConfig\n\t// CustomAgents configures custom agents for the session\n\tCustomAgents []CustomAgentConfig\n\t// DefaultAgent configures the default agent (the built-in agent that handles turns when no custom agent is selected).\n\tDefaultAgent *DefaultAgentConfig\n\t// Agent is the name of the custom agent to activate when the session starts.\n\t// Must match the Name of one of the agents in CustomAgents.\n\tAgent string\n\t// SkillDirectories is a list of directories to load skills from\n\tSkillDirectories []string\n\t// DisabledSkills is a list of skill names to disable\n\tDisabledSkills []string\n\t// InfiniteSessions configures infinite sessions for persistent workspaces and automatic compaction.\n\tInfiniteSessions *InfiniteSessionConfig\n\t// GitHubToken is an optional per-session GitHub token used for authentication.\n\t// When provided, the session authenticates as the token's owner instead of\n\t// using the global client-level auth.\n\tGitHubToken string `json:\"-\"`\n\t// DisableResume, when true, skips emitting the session.resume event.\n\t// Useful for reconnecting to a session without triggering resume-related side effects.\n\tDisableResume bool\n\t// ContinuePendingWork, when true, instructs the runtime to continue any tool calls\n\t// or permission prompts that were still pending when the session was last suspended.\n\t// When false (the default), the runtime treats pending work as interrupted on resume.\n\t//\n\t// For permission requests, the runtime re-emits permission.requested so the\n\t// registered OnPermissionRequest handler can re-prompt; for external tool calls,\n\t// the consumer is expected to supply the result via the corresponding low-level\n\t// RPC method.\n\tContinuePendingWork bool\n\t// OnEvent is an optional event handler registered before the session.resume RPC\n\t// is issued, ensuring early events are delivered. See SessionConfig.OnEvent.\n\tOnEvent SessionEventHandler\n\t// CreateSessionFsHandler supplies a handler for session filesystem operations.\n\t// This takes effect only when ClientOptions.SessionFs is configured.\n\tCreateSessionFsHandler func(session *Session) SessionFsProvider\n\t// Commands registers slash-commands for this session. See SessionConfig.Commands.\n\tCommands []CommandDefinition\n\t// OnElicitationRequest is a handler for elicitation requests from the server.\n\t// See SessionConfig.OnElicitationRequest.\n\tOnElicitationRequest ElicitationHandler\n}\ntype ProviderConfig struct {\n\t// Type is the provider type: \"openai\", \"azure\", or \"anthropic\". Defaults to \"openai\".\n\tType string `json:\"type,omitempty\"`\n\t// WireApi is the API format (openai/azure only): \"completions\" or \"responses\". Defaults to \"completions\".\n\tWireApi string `json:\"wireApi,omitempty\"`\n\t// BaseURL is the API endpoint URL\n\tBaseURL string `json:\"baseUrl\"`\n\t// APIKey is the API key. Optional for local providers like Ollama.\n\tAPIKey string `json:\"apiKey,omitempty\"`\n\t// BearerToken for authentication. Sets the Authorization header directly.\n\t// Use this for services requiring bearer token auth instead of API key.\n\t// Takes precedence over APIKey when both are set.\n\tBearerToken string `json:\"bearerToken,omitempty\"`\n\t// Azure contains Azure-specific options\n\tAzure *AzureProviderOptions `json:\"azure,omitempty\"`\n\t// Headers are custom HTTP headers included in outbound provider requests.\n\tHeaders map[string]string `json:\"headers,omitempty\"`\n}\n\n// AzureProviderOptions contains Azure-specific provider configuration\ntype AzureProviderOptions struct {\n\t// APIVersion is the Azure API version. Defaults to \"2024-10-21\".\n\tAPIVersion string `json:\"apiVersion,omitempty\"`\n}\n\n// ToolBinaryResult represents binary payloads returned by tools.\ntype ToolBinaryResult struct {\n\tData string `json:\"data\"`\n\tMimeType string `json:\"mimeType\"`\n\tType string `json:\"type\"`\n\tDescription string `json:\"description,omitempty\"`\n}\n\n// MessageOptions configures a message to send\ntype MessageOptions struct {\n\t// Prompt is the message to send\n\tPrompt string\n\t// Attachments are file or directory attachments\n\tAttachments []Attachment\n\t// Mode is the message delivery mode (default: \"enqueue\")\n\tMode string\n\t// RequestHeaders are custom per-turn HTTP headers for outbound model requests.\n\tRequestHeaders map[string]string\n}\n\n// SessionEventHandler is a callback for session events\ntype SessionEventHandler func(event SessionEvent)\n\n// ModelVisionLimits contains vision-specific limits\ntype ModelVisionLimits struct {\n\tSupportedMediaTypes []string `json:\"supported_media_types\"`\n\tMaxPromptImages int `json:\"max_prompt_images\"`\n\tMaxPromptImageSize int `json:\"max_prompt_image_size\"`\n}\n\n// ModelLimits contains model limits\ntype ModelLimits struct {\n\tMaxPromptTokens *int `json:\"max_prompt_tokens,omitempty\"`\n\tMaxContextWindowTokens int `json:\"max_context_window_tokens\"`\n\tVision *ModelVisionLimits `json:\"vision,omitempty\"`\n}\n\n// ModelSupports contains model support flags\ntype ModelSupports struct {\n\tVision bool `json:\"vision\"`\n\tReasoningEffort bool `json:\"reasoningEffort\"`\n}\n\n// ModelCapabilities contains model capabilities and limits\ntype ModelCapabilities struct {\n\tSupports ModelSupports `json:\"supports\"`\n\tLimits ModelLimits `json:\"limits\"`\n}\n\n// Type aliases for model capabilities overrides, re-exported from the rpc\n// package for ergonomic use without requiring a separate rpc import.\ntype (\n\tModelCapabilitiesOverride = rpc.ModelCapabilitiesOverride\n\tModelCapabilitiesOverrideSupports = rpc.ModelCapabilitiesOverrideSupports\n\tModelCapabilitiesOverrideLimits = rpc.ModelCapabilitiesOverrideLimits\n\tModelCapabilitiesOverrideLimitsVision = rpc.ModelCapabilitiesOverrideLimitsVision\n)\n\n// ModelPolicy contains model policy state\ntype ModelPolicy struct {\n\tState string `json:\"state\"`\n\tTerms string `json:\"terms\"`\n}\n\n// ModelBilling contains model billing information\ntype ModelBilling struct {\n\tMultiplier float64 `json:\"multiplier\"`\n}\n\n// ModelInfo contains information about an available model\ntype ModelInfo struct {\n\tID string `json:\"id\"`\n\tName string `json:\"name\"`\n\tCapabilities ModelCapabilities `json:\"capabilities\"`\n\tPolicy *ModelPolicy `json:\"policy,omitempty\"`\n\tBilling *ModelBilling `json:\"billing,omitempty\"`\n\tSupportedReasoningEfforts []string `json:\"supportedReasoningEfforts,omitempty\"`\n\tDefaultReasoningEffort string `json:\"defaultReasoningEffort,omitempty\"`\n}\n\n// SessionContext contains working directory context for a session\ntype SessionContext struct {\n\t// Cwd is the working directory where the session was created\n\tCwd string `json:\"cwd\"`\n\t// GitRoot is the git repository root (if in a git repo)\n\tGitRoot string `json:\"gitRoot,omitempty\"`\n\t// Repository is the GitHub repository in \"owner/repo\" format\n\tRepository string `json:\"repository,omitempty\"`\n\t// Branch is the current git branch\n\tBranch string `json:\"branch,omitempty\"`\n}\n\n// SessionListFilter contains filter options for listing sessions\ntype SessionListFilter struct {\n\t// Cwd filters by exact working directory match\n\tCwd string `json:\"cwd,omitempty\"`\n\t// GitRoot filters by git root\n\tGitRoot string `json:\"gitRoot,omitempty\"`\n\t// Repository filters by repository (owner/repo format)\n\tRepository string `json:\"repository,omitempty\"`\n\t// Branch filters by branch\n\tBranch string `json:\"branch,omitempty\"`\n}\n\n// SessionMetadata contains metadata about a session\ntype SessionMetadata struct {\n\tSessionID string `json:\"sessionId\"`\n\tStartTime string `json:\"startTime\"`\n\tModifiedTime string `json:\"modifiedTime\"`\n\tSummary *string `json:\"summary,omitempty\"`\n\tIsRemote bool `json:\"isRemote\"`\n\tContext *SessionContext `json:\"context,omitempty\"`\n}\n\n// SessionLifecycleEventType represents the type of session lifecycle event\ntype SessionLifecycleEventType string\n\nconst (\n\tSessionLifecycleCreated SessionLifecycleEventType = \"session.created\"\n\tSessionLifecycleDeleted SessionLifecycleEventType = \"session.deleted\"\n\tSessionLifecycleUpdated SessionLifecycleEventType = \"session.updated\"\n\tSessionLifecycleForeground SessionLifecycleEventType = \"session.foreground\"\n\tSessionLifecycleBackground SessionLifecycleEventType = \"session.background\"\n)\n\n// SessionLifecycleEvent represents a session lifecycle notification\ntype SessionLifecycleEvent struct {\n\tType SessionLifecycleEventType `json:\"type\"`\n\tSessionID string `json:\"sessionId\"`\n\tMetadata *SessionLifecycleEventMetadata `json:\"metadata,omitempty\"`\n}\n\n// SessionLifecycleEventMetadata contains optional metadata for lifecycle events\ntype SessionLifecycleEventMetadata struct {\n\tStartTime string `json:\"startTime\"`\n\tModifiedTime string `json:\"modifiedTime\"`\n\tSummary *string `json:\"summary,omitempty\"`\n}\n\n// SessionLifecycleHandler is a callback for session lifecycle events\ntype SessionLifecycleHandler func(event SessionLifecycleEvent)\n\n// createSessionRequest is the request for session.create\ntype createSessionRequest struct {\n\tModel string `json:\"model,omitempty\"`\n\tSessionID string `json:\"sessionId,omitempty\"`\n\tClientName string `json:\"clientName,omitempty\"`\n\tReasoningEffort string `json:\"reasoningEffort,omitempty\"`\n\tTools []Tool `json:\"tools,omitempty\"`\n\tSystemMessage *SystemMessageConfig `json:\"systemMessage,omitempty\"`\n\tAvailableTools []string `json:\"availableTools\"`\n\tExcludedTools []string `json:\"excludedTools,omitempty\"`\n\tProvider *ProviderConfig `json:\"provider,omitempty\"`\n\tModelCapabilities *rpc.ModelCapabilitiesOverride `json:\"modelCapabilities,omitempty\"`\n\tRequestPermission *bool `json:\"requestPermission,omitempty\"`\n\tRequestUserInput *bool `json:\"requestUserInput,omitempty\"`\n\tHooks *bool `json:\"hooks,omitempty\"`\n\tWorkingDirectory string `json:\"workingDirectory,omitempty\"`\n\tStreaming *bool `json:\"streaming,omitempty\"`\n\tIncludeSubAgentStreamingEvents *bool `json:\"includeSubAgentStreamingEvents,omitempty\"`\n\tMCPServers map[string]MCPServerConfig `json:\"mcpServers,omitempty\"`\n\tEnvValueMode string `json:\"envValueMode,omitempty\"`\n\tCustomAgents []CustomAgentConfig `json:\"customAgents,omitempty\"`\n\tDefaultAgent *DefaultAgentConfig `json:\"defaultAgent,omitempty\"`\n\tAgent string `json:\"agent,omitempty\"`\n\tConfigDir string `json:\"configDir,omitempty\"`\n\tEnableConfigDiscovery *bool `json:\"enableConfigDiscovery,omitempty\"`\n\tSkillDirectories []string `json:\"skillDirectories,omitempty\"`\n\tDisabledSkills []string `json:\"disabledSkills,omitempty\"`\n\tInfiniteSessions *InfiniteSessionConfig `json:\"infiniteSessions,omitempty\"`\n\tCommands []wireCommand `json:\"commands,omitempty\"`\n\tRequestElicitation *bool `json:\"requestElicitation,omitempty\"`\n\tGitHubToken string `json:\"gitHubToken,omitempty\"`\n\tTraceparent string `json:\"traceparent,omitempty\"`\n\tTracestate string `json:\"tracestate,omitempty\"`\n}\n\n// wireCommand is the wire representation of a command (name + description only, no handler).\ntype wireCommand struct {\n\tName string `json:\"name\"`\n\tDescription string `json:\"description,omitempty\"`\n}\n\n// createSessionResponse is the response from session.create\ntype createSessionResponse struct {\n\tSessionID string `json:\"sessionId\"`\n\tWorkspacePath string `json:\"workspacePath\"`\n\tCapabilities *SessionCapabilities `json:\"capabilities,omitempty\"`\n}\n\n// resumeSessionRequest is the request for session.resume\ntype resumeSessionRequest struct {\n\tSessionID string `json:\"sessionId\"`\n\tClientName string `json:\"clientName,omitempty\"`\n\tModel string `json:\"model,omitempty\"`\n\tReasoningEffort string `json:\"reasoningEffort,omitempty\"`\n\tTools []Tool `json:\"tools,omitempty\"`\n\tSystemMessage *SystemMessageConfig `json:\"systemMessage,omitempty\"`\n\tAvailableTools []string `json:\"availableTools\"`\n\tExcludedTools []string `json:\"excludedTools,omitempty\"`\n\tProvider *ProviderConfig `json:\"provider,omitempty\"`\n\tModelCapabilities *rpc.ModelCapabilitiesOverride `json:\"modelCapabilities,omitempty\"`\n\tRequestPermission *bool `json:\"requestPermission,omitempty\"`\n\tRequestUserInput *bool `json:\"requestUserInput,omitempty\"`\n\tHooks *bool `json:\"hooks,omitempty\"`\n\tWorkingDirectory string `json:\"workingDirectory,omitempty\"`\n\tConfigDir string `json:\"configDir,omitempty\"`\n\tEnableConfigDiscovery *bool `json:\"enableConfigDiscovery,omitempty\"`\n\tDisableResume *bool `json:\"disableResume,omitempty\"`\n\tContinuePendingWork *bool `json:\"continuePendingWork,omitempty\"`\n\tStreaming *bool `json:\"streaming,omitempty\"`\n\tIncludeSubAgentStreamingEvents *bool `json:\"includeSubAgentStreamingEvents,omitempty\"`\n\tMCPServers map[string]MCPServerConfig `json:\"mcpServers,omitempty\"`\n\tEnvValueMode string `json:\"envValueMode,omitempty\"`\n\tCustomAgents []CustomAgentConfig `json:\"customAgents,omitempty\"`\n\tDefaultAgent *DefaultAgentConfig `json:\"defaultAgent,omitempty\"`\n\tAgent string `json:\"agent,omitempty\"`\n\tSkillDirectories []string `json:\"skillDirectories,omitempty\"`\n\tDisabledSkills []string `json:\"disabledSkills,omitempty\"`\n\tInfiniteSessions *InfiniteSessionConfig `json:\"infiniteSessions,omitempty\"`\n\tCommands []wireCommand `json:\"commands,omitempty\"`\n\tRequestElicitation *bool `json:\"requestElicitation,omitempty\"`\n\tGitHubToken string `json:\"gitHubToken,omitempty\"`\n\tTraceparent string `json:\"traceparent,omitempty\"`\n\tTracestate string `json:\"tracestate,omitempty\"`\n}\n\n// resumeSessionResponse is the response from session.resume\ntype resumeSessionResponse struct {\n\tSessionID string `json:\"sessionId\"`\n\tWorkspacePath string `json:\"workspacePath\"`\n\tCapabilities *SessionCapabilities `json:\"capabilities,omitempty\"`\n}\n\ntype hooksInvokeRequest struct {\n\tSessionID string `json:\"sessionId\"`\n\tType string `json:\"hookType\"`\n\tInput json.RawMessage `json:\"input\"`\n}\n\n// listSessionsRequest is the request for session.list\ntype listSessionsRequest struct {\n\tFilter *SessionListFilter `json:\"filter,omitempty\"`\n}\n\n// listSessionsResponse is the response from session.list\ntype listSessionsResponse struct {\n\tSessions []SessionMetadata `json:\"sessions\"`\n}\n\n// getSessionMetadataRequest is the request for session.getMetadata\ntype getSessionMetadataRequest struct {\n\tSessionID string `json:\"sessionId\"`\n}\n\n// getSessionMetadataResponse is the response from session.getMetadata\ntype getSessionMetadataResponse struct {\n\tSession *SessionMetadata `json:\"session,omitempty\"`\n}\n\n// deleteSessionRequest is the request for session.delete\ntype deleteSessionRequest struct {\n\tSessionID string `json:\"sessionId\"`\n}\n\n// deleteSessionResponse is the response from session.delete\ntype deleteSessionResponse struct {\n\tSuccess bool `json:\"success\"`\n\tError *string `json:\"error,omitempty\"`\n}\n\n// getLastSessionIDRequest is the request for session.getLastId\ntype getLastSessionIDRequest struct{}\n\n// getLastSessionIDResponse is the response from session.getLastId\ntype getLastSessionIDResponse struct {\n\tSessionID *string `json:\"sessionId,omitempty\"`\n}\n\n// getForegroundSessionRequest is the request for session.getForeground\ntype getForegroundSessionRequest struct{}\n\n// getForegroundSessionResponse is the response from session.getForeground\ntype getForegroundSessionResponse struct {\n\tSessionID *string `json:\"sessionId,omitempty\"`\n\tWorkspacePath *string `json:\"workspacePath,omitempty\"`\n}\n\n// setForegroundSessionRequest is the request for session.setForeground\ntype setForegroundSessionRequest struct {\n\tSessionID string `json:\"sessionId\"`\n}\n\n// setForegroundSessionResponse is the response from session.setForeground\ntype setForegroundSessionResponse struct {\n\tSuccess bool `json:\"success\"`\n\tError *string `json:\"error,omitempty\"`\n}\n\ntype pingRequest struct {\n\tMessage string `json:\"message,omitempty\"`\n}\n\n// PingResponse is the response from a ping request\ntype PingResponse struct {\n\tMessage string `json:\"message\"`\n\tTimestamp int64 `json:\"timestamp\"`\n\tProtocolVersion *int `json:\"protocolVersion,omitempty\"`\n}\n\n// getStatusRequest is the request for status.get\ntype getStatusRequest struct{}\n\n// GetStatusResponse is the response from status.get\ntype GetStatusResponse struct {\n\tVersion string `json:\"version\"`\n\tProtocolVersion int `json:\"protocolVersion\"`\n}\n\n// getAuthStatusRequest is the request for auth.getStatus\ntype getAuthStatusRequest struct{}\n\n// GetAuthStatusResponse is the response from auth.getStatus\ntype GetAuthStatusResponse struct {\n\tIsAuthenticated bool `json:\"isAuthenticated\"`\n\tAuthType *string `json:\"authType,omitempty\"`\n\tHost *string `json:\"host,omitempty\"`\n\tLogin *string `json:\"login,omitempty\"`\n\tStatusMessage *string `json:\"statusMessage,omitempty\"`\n}\n\n// listModelsRequest is the request for models.list\ntype listModelsRequest struct{}\n\n// listModelsResponse is the response from models.list\ntype listModelsResponse struct {\n\tModels []ModelInfo `json:\"models\"`\n}\n\n// sessionGetMessagesRequest is the request for session.getMessages\ntype sessionGetMessagesRequest struct {\n\tSessionID string `json:\"sessionId\"`\n}\n\n// sessionGetMessagesResponse is the response from session.getMessages\ntype sessionGetMessagesResponse struct {\n\tEvents []SessionEvent `json:\"events\"`\n}\n\n// sessionDestroyRequest is the request for session.destroy\ntype sessionDestroyRequest struct {\n\tSessionID string `json:\"sessionId\"`\n}\n\n// sessionAbortRequest is the request for session.abort\ntype sessionAbortRequest struct {\n\tSessionID string `json:\"sessionId\"`\n}\n\ntype sessionSendRequest struct {\n\tSessionID string `json:\"sessionId\"`\n\tPrompt string `json:\"prompt\"`\n\tAttachments []Attachment `json:\"attachments,omitempty\"`\n\tMode string `json:\"mode,omitempty\"`\n\tTraceparent string `json:\"traceparent,omitempty\"`\n\tTracestate string `json:\"tracestate,omitempty\"`\n\tRequestHeaders map[string]string `json:\"requestHeaders,omitempty\"`\n}\n\n// sessionSendResponse is the response from session.send\ntype sessionSendResponse struct {\n\tMessageID string `json:\"messageId\"`\n}\n\n// sessionEventRequest is the request for session event notifications\ntype sessionEventRequest struct {\n\tSessionID string `json:\"sessionId\"`\n\tEvent SessionEvent `json:\"event\"`\n}\n\n// userInputRequest represents a request for user input from the agent\ntype userInputRequest struct {\n\tSessionID string `json:\"sessionId\"`\n\tQuestion string `json:\"question\"`\n\tChoices []string `json:\"choices,omitempty\"`\n\tAllowFreeform *bool `json:\"allowFreeform,omitempty\"`\n}\n\n// userInputResponse represents the user's response to an input request\ntype userInputResponse struct {\n\tAnswer string `json:\"answer\"`\n\tWasFreeform bool `json:\"wasFreeform\"`\n}\n" }, { "path": "go/types_test.go", "content": "package copilot\n\nimport (\n\t\"encoding/json\"\n\t\"testing\"\n)\n\nfunc TestPermissionRequestResultKind_Constants(t *testing.T) {\n\ttests := []struct {\n\t\tname string\n\t\tkind PermissionRequestResultKind\n\t\texpected string\n\t}{\n\t\t{\"Approved\", PermissionRequestResultKindApproved, \"approve-once\"},\n\t\t{\"Rejected\", PermissionRequestResultKindRejected, \"reject\"},\n\t\t{\"UserNotAvailable\", PermissionRequestResultKindUserNotAvailable, \"user-not-available\"},\n\t\t{\"NoResult\", PermissionRequestResultKindNoResult, \"no-result\"},\n\t\t// Deprecated aliases\n\t\t{\"DeprecatedDeniedInteractivelyByUser\", PermissionRequestResultKindDeniedInteractivelyByUser, \"reject\"},\n\t\t{\"DeprecatedDeniedCouldNotRequestFromUser\", PermissionRequestResultKindDeniedCouldNotRequestFromUser, \"user-not-available\"},\n\t\t{\"DeprecatedDeniedByRules\", PermissionRequestResultKindDeniedByRules, \"user-not-available\"},\n\t}\n\n\tfor _, tt := range tests {\n\t\tt.Run(tt.name, func(t *testing.T) {\n\t\t\tif string(tt.kind) != tt.expected {\n\t\t\t\tt.Errorf(\"expected %q, got %q\", tt.expected, string(tt.kind))\n\t\t\t}\n\t\t})\n\t}\n}\n\nfunc TestPermissionRequestResultKind_CustomValue(t *testing.T) {\n\tcustom := PermissionRequestResultKind(\"custom-kind\")\n\tif string(custom) != \"custom-kind\" {\n\t\tt.Errorf(\"expected %q, got %q\", \"custom-kind\", string(custom))\n\t}\n}\n\nfunc TestPermissionRequestResult_JSONRoundTrip(t *testing.T) {\n\ttests := []struct {\n\t\tname string\n\t\tkind PermissionRequestResultKind\n\t}{\n\t\t{\"Approved\", PermissionRequestResultKindApproved},\n\t\t{\"DeniedByRules\", PermissionRequestResultKindDeniedByRules},\n\t\t{\"DeniedCouldNotRequestFromUser\", PermissionRequestResultKindDeniedCouldNotRequestFromUser},\n\t\t{\"DeniedInteractivelyByUser\", PermissionRequestResultKindDeniedInteractivelyByUser},\n\t\t{\"NoResult\", PermissionRequestResultKind(\"no-result\")},\n\t\t{\"Custom\", PermissionRequestResultKind(\"custom\")},\n\t}\n\n\tfor _, tt := range tests {\n\t\tt.Run(tt.name, func(t *testing.T) {\n\t\t\toriginal := PermissionRequestResult{Kind: tt.kind}\n\t\t\tdata, err := json.Marshal(original)\n\t\t\tif err != nil {\n\t\t\t\tt.Fatalf(\"failed to marshal: %v\", err)\n\t\t\t}\n\n\t\t\tvar decoded PermissionRequestResult\n\t\t\tif err := json.Unmarshal(data, &decoded); err != nil {\n\t\t\t\tt.Fatalf(\"failed to unmarshal: %v\", err)\n\t\t\t}\n\n\t\t\tif decoded.Kind != tt.kind {\n\t\t\t\tt.Errorf(\"expected kind %q, got %q\", tt.kind, decoded.Kind)\n\t\t\t}\n\t\t})\n\t}\n}\n\nfunc TestPermissionRequestResult_JSONDeserialize(t *testing.T) {\n\tjsonStr := `{\"kind\":\"reject\"}`\n\tvar result PermissionRequestResult\n\tif err := json.Unmarshal([]byte(jsonStr), &result); err != nil {\n\t\tt.Fatalf(\"failed to unmarshal: %v\", err)\n\t}\n\n\tif result.Kind != PermissionRequestResultKindRejected {\n\t\tt.Errorf(\"expected %q, got %q\", PermissionRequestResultKindRejected, result.Kind)\n\t}\n}\n\nfunc TestPermissionRequestResult_JSONSerialize(t *testing.T) {\n\tresult := PermissionRequestResult{Kind: PermissionRequestResultKindApproved}\n\tdata, err := json.Marshal(result)\n\tif err != nil {\n\t\tt.Fatalf(\"failed to marshal: %v\", err)\n\t}\n\n\texpected := `{\"kind\":\"approve-once\"}`\n\tif string(data) != expected {\n\t\tt.Errorf(\"expected %s, got %s\", expected, string(data))\n\t}\n}\n\nfunc TestProviderConfig_JSONIncludesHeaders(t *testing.T) {\n\tconfig := ProviderConfig{\n\t\tBaseURL: \"https://example.com/provider\",\n\t\tHeaders: map[string]string{\"Authorization\": \"Bearer provider-token\"},\n\t}\n\n\tdata, err := json.Marshal(config)\n\tif err != nil {\n\t\tt.Fatalf(\"failed to marshal provider config: %v\", err)\n\t}\n\n\tvar decoded map[string]any\n\tif err := json.Unmarshal(data, &decoded); err != nil {\n\t\tt.Fatalf(\"failed to unmarshal provider config: %v\", err)\n\t}\n\n\tif decoded[\"baseUrl\"] != \"https://example.com/provider\" {\n\t\tt.Fatalf(\"expected baseUrl to round-trip, got %v\", decoded[\"baseUrl\"])\n\t}\n\theaders, ok := decoded[\"headers\"].(map[string]any)\n\tif !ok {\n\t\tt.Fatalf(\"expected headers object, got %T\", decoded[\"headers\"])\n\t}\n\tif headers[\"Authorization\"] != \"Bearer provider-token\" {\n\t\tt.Fatalf(\"expected Authorization header, got %v\", headers[\"Authorization\"])\n\t}\n}\n\nfunc TestSessionSendRequest_JSONIncludesRequestHeaders(t *testing.T) {\n\treq := sessionSendRequest{\n\t\tSessionID: \"session-1\",\n\t\tPrompt: \"hello\",\n\t\tRequestHeaders: map[string]string{\"Authorization\": \"Bearer turn-token\"},\n\t}\n\n\tdata, err := json.Marshal(req)\n\tif err != nil {\n\t\tt.Fatalf(\"failed to marshal session send request: %v\", err)\n\t}\n\n\tvar decoded map[string]any\n\tif err := json.Unmarshal(data, &decoded); err != nil {\n\t\tt.Fatalf(\"failed to unmarshal session send request: %v\", err)\n\t}\n\n\tif decoded[\"prompt\"] != \"hello\" {\n\t\tt.Fatalf(\"expected prompt to round-trip, got %v\", decoded[\"prompt\"])\n\t}\n\theaders, ok := decoded[\"requestHeaders\"].(map[string]any)\n\tif !ok {\n\t\tt.Fatalf(\"expected requestHeaders object, got %T\", decoded[\"requestHeaders\"])\n\t}\n\tif headers[\"Authorization\"] != \"Bearer turn-token\" {\n\t\tt.Fatalf(\"expected Authorization header, got %v\", headers[\"Authorization\"])\n\t}\n}\n" }, { "path": "java/README.md", "content": "# GitHub Copilot SDK for Java\n\nJava SDK for programmatic control of GitHub Copilot CLI via JSON-RPC.\n\n[![Build](https://github.com/github/copilot-sdk-java/actions/workflows/build-test.yml/badge.svg)](https://github.com/github/copilot-sdk-java/actions/workflows/build-test.yml)\n[![Maven Central](https://img.shields.io/maven-central/v/com.github/copilot-sdk-java)](https://central.sonatype.com/artifact/com.github/copilot-sdk-java)\n[![Java 17+](https://img.shields.io/badge/Java-17%2B-blue?logo=openjdk&logoColor=white)](https://openjdk.org/)\n[![Documentation](https://img.shields.io/badge/docs-online-brightgreen)](https://github.github.io/copilot-sdk-java/)\n[![Javadoc](https://javadoc.io/badge2/com.github/copilot-sdk-java/javadoc.svg)](https://javadoc.io/doc/com.github/copilot-sdk-java/latest/index.html)\n\n## Quick Start\n\n**📦 The Java SDK is maintained in a separate repository: [`github/copilot-sdk-java`](https://github.com/github/copilot-sdk-java)**\n\n> **Note:** This SDK is in public preview and may change in breaking ways.\n\n```java\nimport com.github.copilot.sdk.CopilotClient;\nimport com.github.copilot.sdk.events.AssistantMessageEvent;\nimport com.github.copilot.sdk.events.SessionIdleEvent;\nimport com.github.copilot.sdk.json.MessageOptions;\nimport com.github.copilot.sdk.json.PermissionHandler;\nimport com.github.copilot.sdk.json.SessionConfig;\n\npublic class QuickStart {\n public static void main(String[] args) throws Exception {\n // Create and start client\n try (var client = new CopilotClient()) {\n client.start().get();\n\n // Create a session (onPermissionRequest is required)\n var session = client.createSession(\n new SessionConfig()\n .setModel(\"gpt-5\")\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n ).get();\n\n var done = new java.util.concurrent.CompletableFuture();\n\n // Handle events\n session.on(AssistantMessageEvent.class, msg ->\n System.out.println(msg.getData().content()));\n session.on(SessionIdleEvent.class, idle ->\n done.complete(null));\n\n // Send a message and wait for completion\n session.send(new MessageOptions().setPrompt(\"What is 2+2?\"));\n done.get();\n }\n }\n}\n```\n\n## Try it with JBang\n\nRun the SDK without setting up a full project using [JBang](https://www.jbang.dev/):\n\n```bash\njbang https://github.com/github/copilot-sdk-java/blob/main/jbang-example.java\n```\n\n## Documentation & Resources\n\n| Resource | Link |\n| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |\n| **Full Documentation** | [github.github.io/copilot-sdk-java](https://github.github.io/copilot-sdk-java/) |\n| **Getting Started Guide** | [Documentation](https://github.github.io/copilot-sdk-java/latest/documentation.html) |\n| **API Reference (Javadoc)** | [javadoc.io](https://javadoc.io/doc/com.github/copilot-sdk-java/latest/index.html) |\n| **MCP Servers Integration** | [MCP Guide](https://github.github.io/copilot-sdk-java/latest/mcp.html) |\n| **Cookbook** | [Recipes](https://github.com/github/copilot-sdk-java/tree/main/src/site/markdown/cookbook) |\n| **Source Code** | [github/copilot-sdk-java](https://github.com/github/copilot-sdk-java) |\n| **Issues & Feature Requests** | [GitHub Issues](https://github.com/github/copilot-sdk-java/issues) |\n| **Releases** | [GitHub Releases](https://github.com/github/copilot-sdk-java/releases) |\n| **Copilot Instructions** | [copilot-sdk-java.instructions.md](https://github.com/github/copilot-sdk-java/blob/main/instructions/copilot-sdk-java.instructions.md) |\n\n## Contributing\n\nContributions are welcome! Please see the [Contributing Guide](https://github.com/github/copilot-sdk-java/blob/main/CONTRIBUTING.md) in the GitHub Copilot SDK for Java repository.\n\n## License\n\nMIT — see [LICENSE](https://github.com/github/copilot-sdk-java/blob/main/LICENSE) for details.\n" }, { "path": "justfile", "content": "# Default recipe to display help\ndefault:\n @just --list\n\n# Format all code across all languages\nformat: format-go format-python format-nodejs format-dotnet\n\n# Lint all code across all languages\nlint: lint-go lint-python lint-nodejs lint-dotnet\n\n# Run tests for all languages\ntest: test-go test-python test-nodejs test-dotnet test-corrections\n\n# Format Go code\nformat-go:\n @echo \"=== Formatting Go code ===\"\n @cd go && find . -name \"*.go\" -not -path \"*/generated/*\" -exec gofmt -w {} +\n\n# Format Python code\nformat-python:\n @echo \"=== Formatting Python code ===\"\n @cd python && uv run ruff format .\n\n# Format Node.js code\nformat-nodejs:\n @echo \"=== Formatting Node.js code ===\"\n @cd nodejs && npm run format\n\n# Format .NET code\nformat-dotnet:\n @echo \"=== Formatting .NET code ===\"\n @cd dotnet && dotnet format src/GitHub.Copilot.SDK.csproj\n\n# Lint Go code\nlint-go:\n @echo \"=== Linting Go code ===\"\n @cd go && golangci-lint run ./...\n\n# Lint Python code\nlint-python:\n @echo \"=== Linting Python code ===\"\n @cd python && uv run ruff check . && uv run ty check copilot\n\n# Lint Node.js code\nlint-nodejs:\n @echo \"=== Linting Node.js code ===\"\n @cd nodejs && npm run format:check && npm run lint && npm run typecheck\n\n# Lint .NET code\nlint-dotnet:\n @echo \"=== Linting .NET code ===\"\n @cd dotnet && dotnet format src/GitHub.Copilot.SDK.csproj --verify-no-changes\n\n# Test Go code\ntest-go:\n @echo \"=== Testing Go code ===\"\n @cd go && go test ./...\n\n# Test Python code\ntest-python:\n @echo \"=== Testing Python code ===\"\n @cd python && uv run pytest\n\n# Test Node.js code\ntest-nodejs:\n @echo \"=== Testing Node.js code ===\"\n @cd nodejs && npm test\n\n# Test .NET code\ntest-dotnet:\n @echo \"=== Testing .NET code ===\"\n @cd dotnet && dotnet test test/GitHub.Copilot.SDK.Test.csproj\n\n# Test correction collection scripts\ntest-corrections:\n @echo \"=== Testing correction scripts ===\"\n @cd scripts/corrections && npm test\n\n# Install all dependencies across all languages\ninstall: install-go install-python install-nodejs install-dotnet install-corrections\n @echo \"✅ All dependencies installed\"\n\n# Install Go dependencies and prerequisites for tests\ninstall-go: install-nodejs install-test-harness\n @echo \"=== Installing Go dependencies ===\"\n @cd go && go mod download\n\n# Install Python dependencies and prerequisites for tests\ninstall-python: install-nodejs install-test-harness\n @echo \"=== Installing Python dependencies ===\"\n @cd python && uv pip install -e \".[dev]\"\n\n# Install .NET dependencies and prerequisites for tests\ninstall-dotnet: install-nodejs install-test-harness\n @echo \"=== Installing .NET dependencies ===\"\n @cd dotnet && dotnet restore\n\n# Install Node.js dependencies\ninstall-nodejs:\n @echo \"=== Installing Node.js dependencies ===\"\n @cd nodejs && npm ci\n\n# Install test harness dependencies (used by E2E tests in all languages)\ninstall-test-harness:\n @echo \"=== Installing test harness dependencies ===\"\n @cd test/harness && npm ci --ignore-scripts\n\n# Install correction collection script dependencies\ninstall-corrections:\n @echo \"=== Installing correction script dependencies ===\"\n @cd scripts/corrections && npm ci\n\n# Run interactive SDK playground\nplayground:\n @echo \"=== Starting SDK Playground ===\"\n @cd demos/playground && npm install && npm start\n\n# Validate documentation code examples\nvalidate-docs: validate-docs-extract validate-docs-check\n\n# Extract code blocks from documentation\nvalidate-docs-extract:\n @echo \"=== Extracting documentation code blocks ===\"\n @cd scripts/docs-validation && npm ci --silent && npm run extract\n\n# Validate all extracted code blocks\nvalidate-docs-check:\n @echo \"=== Validating documentation code blocks ===\"\n @cd scripts/docs-validation && npm run validate\n\n# Validate only TypeScript documentation examples\nvalidate-docs-ts:\n @echo \"=== Validating TypeScript documentation ===\"\n @cd scripts/docs-validation && npm run validate:ts\n\n# Validate only Python documentation examples\nvalidate-docs-py:\n @echo \"=== Validating Python documentation ===\"\n @cd scripts/docs-validation && npm run validate:py\n\n# Validate only Go documentation examples\nvalidate-docs-go:\n @echo \"=== Validating Go documentation ===\"\n @cd scripts/docs-validation && npm run validate:go\n\n# Validate only C# documentation examples\nvalidate-docs-cs:\n @echo \"=== Validating C# documentation ===\"\n @cd scripts/docs-validation && npm run validate:cs\n\n# Build all scenario samples (all languages)\nscenario-build:\n #!/usr/bin/env bash\n set -euo pipefail\n echo \"=== Building all scenario samples ===\"\n TOTAL=0; PASS=0; FAIL=0\n\n build_lang() {\n local lang=\"$1\" find_expr=\"$2\" build_cmd=\"$3\"\n echo \"\"\n echo \"── $lang ──\"\n while IFS= read -r target; do\n [ -z \"$target\" ] && continue\n dir=$(dirname \"$target\")\n scenario=\"${dir#test/scenarios/}\"\n TOTAL=$((TOTAL + 1))\n if (cd \"$dir\" && eval \"$build_cmd\" >/dev/null 2>&1); then\n printf \" ✅ %s\\n\" \"$scenario\"\n PASS=$((PASS + 1))\n else\n printf \" ❌ %s\\n\" \"$scenario\"\n FAIL=$((FAIL + 1))\n fi\n done < <(find test/scenarios $find_expr | sort)\n }\n\n # TypeScript: npm install\n (cd nodejs && npm ci --ignore-scripts --silent 2>/dev/null) || true\n build_lang \"TypeScript\" \"-path '*/typescript/package.json'\" \"npm install --ignore-scripts\"\n\n # Python: syntax check\n build_lang \"Python\" \"-path '*/python/main.py'\" \"python3 -c \\\"import ast; ast.parse(open('main.py').read())\\\"\"\n\n # Go: go build\n build_lang \"Go\" \"-path '*/go/go.mod'\" \"go build ./...\"\n\n # C#: dotnet build\n build_lang \"C#\" \"-name '*.csproj' -path '*/csharp/*'\" \"dotnet build --nologo -v quiet\"\n\n echo \"\"\n echo \"══════════════════════════════════════\"\n echo \" Scenario build summary: $PASS passed, $FAIL failed (of $TOTAL)\"\n echo \"══════════════════════════════════════\"\n [ \"$FAIL\" -eq 0 ]\n\n# Run the full scenario verify orchestrator (build + E2E, needs real CLI)\nscenario-verify:\n @echo \"=== Running scenario verification ===\"\n @bash test/scenarios/verify.sh\n\n# Build scenarios for a single language (typescript, python, go, csharp)\nscenario-build-lang LANG:\n #!/usr/bin/env bash\n set -euo pipefail\n echo \"=== Building {{LANG}} scenarios ===\"\n PASS=0; FAIL=0\n\n case \"{{LANG}}\" in\n typescript)\n (cd nodejs && npm ci --ignore-scripts --silent 2>/dev/null) || true\n for target in $(find test/scenarios -path '*/typescript/package.json' | sort); do\n dir=$(dirname \"$target\"); scenario=\"${dir#test/scenarios/}\"\n if (cd \"$dir\" && npm install --ignore-scripts >/dev/null 2>&1); then\n printf \" ✅ %s\\n\" \"$scenario\"; PASS=$((PASS + 1))\n else\n printf \" ❌ %s\\n\" \"$scenario\"; FAIL=$((FAIL + 1))\n fi\n done\n ;;\n python)\n for target in $(find test/scenarios -path '*/python/main.py' | sort); do\n dir=$(dirname \"$target\"); scenario=\"${dir#test/scenarios/}\"\n if python3 -c \"import ast; ast.parse(open('$target').read())\" 2>/dev/null; then\n printf \" ✅ %s\\n\" \"$scenario\"; PASS=$((PASS + 1))\n else\n printf \" ❌ %s\\n\" \"$scenario\"; FAIL=$((FAIL + 1))\n fi\n done\n ;;\n go)\n for target in $(find test/scenarios -path '*/go/go.mod' | sort); do\n dir=$(dirname \"$target\"); scenario=\"${dir#test/scenarios/}\"\n if (cd \"$dir\" && go build ./... >/dev/null 2>&1); then\n printf \" ✅ %s\\n\" \"$scenario\"; PASS=$((PASS + 1))\n else\n printf \" ❌ %s\\n\" \"$scenario\"; FAIL=$((FAIL + 1))\n fi\n done\n ;;\n csharp)\n for target in $(find test/scenarios -name '*.csproj' -path '*/csharp/*' | sort); do\n dir=$(dirname \"$target\"); scenario=\"${dir#test/scenarios/}\"\n if (cd \"$dir\" && dotnet build --nologo -v quiet >/dev/null 2>&1); then\n printf \" ✅ %s\\n\" \"$scenario\"; PASS=$((PASS + 1))\n else\n printf \" ❌ %s\\n\" \"$scenario\"; FAIL=$((FAIL + 1))\n fi\n done\n ;;\n *)\n echo \"Unknown language: {{LANG}}. Use: typescript, python, go, csharp\"\n exit 1\n ;;\n esac\n\n echo \"\"\n echo \"{{LANG}} scenarios: $PASS passed, $FAIL failed\"\n [ \"$FAIL\" -eq 0 ]\n" }, { "path": "nodejs/.gitignore", "content": "# Logs\nlogs\n*.log\nnpm-debug.log*\nyarn-debug.log*\nyarn-error.log*\nlerna-debug.log*\n.pnpm-debug.log*\n\n# Diagnostic reports (https://nodejs.org/api/report.html)\nreport.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json\n\n# Runtime data\npids\n*.pid\n*.seed\n*.pid.lock\n\n# Directory for instrumented libs generated by jscoverage/JSCover\nlib-cov\n\n# Coverage directory used by tools like istanbul\ncoverage\n*.lcov\n\n# nyc test coverage\n.nyc_output\n\n# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)\n.grunt\n\n# Bower dependency directory (https://bower.io/)\nbower_components\n\n# node-waf configuration\n.lock-wscript\n\n# Compiled binary addons (https://nodejs.org/api/addons.html)\nbuild/Release\n\n# Dependency directories\nnode_modules/\njspm_packages/\n\n# Snowpack dependency directory (https://snowpack.dev/)\nweb_modules/\n\n# TypeScript cache\n*.tsbuildinfo\n\n# Optional npm cache directory\n.npm\n\n# Optional eslint cache\n.eslintcache\n\n# Optional stylelint cache\n.stylelintcache\n\n# Microbundle cache\n.rpt2_cache/\n.rts2_cache_cjs/\n.rts2_cache_es/\n.rts2_cache_umd/\n\n# Optional REPL history\n.node_repl_history\n\n# Output of 'npm pack'\n*.tgz\n\n# Yarn Integrity file\n.yarn-integrity\n\n# dotenv environment variable files\n.env\n.env.development.local\n.env.test.local\n.env.production.local\n.env.local\n\n# parcel-bundler cache (https://parceljs.org/)\n.cache\n.parcel-cache\n\n# Next.js build output\n.next\nout\n\n# Nuxt.js build / generate output\n.nuxt\ndist\n\n# Gatsby files\n.cache/\n# Comment in the public line in if your project uses Gatsby and not Next.js\n# https://nextjs.org/blog/next-9-1#public-directory-support\n# public\n\n# vuepress build output\n.vuepress/dist\n\n# vuepress v2.x temp and cache directory\n.temp\n.cache\n\n# Docusaurus cache and generated files\n.docusaurus\n\n# Serverless directories\n.serverless/\n\n# FuseBox cache\n.fusebox/\n\n# DynamoDB Local files\n.dynamodb/\n\n# TernJS port file\n.tern-port\n\n# Stores VSCode versions used for testing VSCode extensions\n.vscode-test\n\n# yarn v2\n.yarn/cache\n.yarn/unplugged\n.yarn/build-state.yml\n.yarn/install-state.gz\n.pnp.*\n\n# Build output\ndist/\nbuild/\n\n# macOS\n.DS_Store\n" }, { "path": "nodejs/.npmignore", "content": "src/\ntest/\nexamples/\n*.ts\n!*.d.ts\ntsconfig.json\nvitest.config.ts\n.gitignore\n*.log\n" }, { "path": "nodejs/.prettierignore", "content": "node_modules\ndist\n**/generated/**\n*.config.ts\n" }, { "path": "nodejs/.prettierrc.json", "content": "{\n \"semi\": true,\n \"trailingComma\": \"es5\",\n \"singleQuote\": false,\n \"printWidth\": 100,\n \"tabWidth\": 4,\n \"useTabs\": false,\n \"arrowParens\": \"always\",\n \"endOfLine\": \"lf\"\n}\n" }, { "path": "nodejs/README.md", "content": "# Copilot SDK for Node.js/TypeScript\n\nTypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC.\n\n> **Note:** This SDK is in public preview and may change in breaking ways.\n\n## Installation\n\n```bash\nnpm install @github/copilot-sdk\n```\n\n## Run the Sample\n\nTry the interactive chat sample (from the repo root):\n\n```bash\ncd nodejs\nnpm ci\nnpm run build\ncd samples\nnpm install\nnpm start\n```\n\n## Quick Start\n\n```typescript\nimport { CopilotClient, approveAll } from \"@github/copilot-sdk\";\n\n// Create and start client\nconst client = new CopilotClient();\nawait client.start();\n\n// Create a session (onPermissionRequest is required)\nconst session = await client.createSession({\n model: \"gpt-5\",\n onPermissionRequest: approveAll,\n});\n\n// Wait for response using typed event handlers\nconst done = new Promise((resolve) => {\n session.on(\"assistant.message\", (event) => {\n console.log(event.data.content);\n });\n session.on(\"session.idle\", () => {\n resolve();\n });\n});\n\n// Send a message and wait for completion\nawait session.send({ prompt: \"What is 2+2?\" });\nawait done;\n\n// Clean up\nawait session.disconnect();\nawait client.stop();\n```\n\nSessions also support `Symbol.asyncDispose` for use with [`await using`](https://github.com/tc39/proposal-explicit-resource-management) (TypeScript 5.2+/Node.js 18.0+):\n\n```typescript\nawait using session = await client.createSession({\n model: \"gpt-5\",\n onPermissionRequest: approveAll,\n});\n// session is automatically disconnected when leaving scope\n```\n\n## API Reference\n\n### CopilotClient\n\n#### Constructor\n\n```typescript\nnew CopilotClient(options?: CopilotClientOptions)\n```\n\n**Options:**\n\n- `cliPath?: string` - Path to CLI executable (default: uses COPILOT_CLI_PATH env var or bundled instance)\n- `cliArgs?: string[]` - Extra arguments prepended before SDK-managed flags (e.g. `[\"./dist-cli/index.js\"]` when using `node`)\n- `cliUrl?: string` - URL of existing CLI server to connect to (e.g., `\"localhost:8080\"`, `\"http://127.0.0.1:9000\"`, or just `\"8080\"`). When provided, the client will not spawn a CLI process.\n- `port?: number` - Server port (default: 0 for random)\n- `useStdio?: boolean` - Use stdio transport instead of TCP (default: true)\n- `logLevel?: string` - Log level (default: \"info\")\n- `autoStart?: boolean` - Auto-start server (default: true)\n- `gitHubToken?: string` - GitHub token for authentication. When provided, takes priority over other auth methods.\n- `useLoggedInUser?: boolean` - Whether to use logged-in user for authentication (default: true, but false when `gitHubToken` is provided). Cannot be used with `cliUrl`.\n- `telemetry?: TelemetryConfig` - OpenTelemetry configuration for the CLI process. Providing this object enables telemetry — no separate flag needed. See [Telemetry](#telemetry) below.\n- `onGetTraceContext?: TraceContextProvider` - Advanced: callback for linking your application's own OpenTelemetry spans into the same distributed trace as the CLI's spans. Not needed for normal telemetry collection. See [Telemetry](#telemetry) below.\n\n#### Methods\n\n##### `start(): Promise`\n\nStart the CLI server and establish connection.\n\n##### `stop(): Promise`\n\nStop the server and close all sessions. Returns a list of any errors encountered during cleanup.\n\n##### `forceStop(): Promise`\n\nForce stop the CLI server without graceful cleanup. Use when `stop()` takes too long.\n\n##### `createSession(config?: SessionConfig): Promise`\n\nCreate a new conversation session.\n\n**Config:**\n\n- `sessionId?: string` - Custom session ID.\n- `model?: string` - Model to use (\"gpt-5\", \"claude-sonnet-4.5\", etc.). **Required when using custom provider.**\n- `reasoningEffort?: \"low\" | \"medium\" | \"high\" | \"xhigh\"` - Reasoning effort level for models that support it. Use `listModels()` to check which models support this option.\n- `tools?: Tool[]` - Custom tools exposed to the CLI\n- `systemMessage?: SystemMessageConfig` - System message customization (see below)\n- `infiniteSessions?: InfiniteSessionConfig` - Configure automatic context compaction (see below)\n- `provider?: ProviderConfig` - Custom API provider configuration (BYOK - Bring Your Own Key). See [Custom Providers](#custom-providers) section.\n- `onPermissionRequest: PermissionHandler` - **Required.** Handler called before each tool execution to approve or deny it. Use `approveAll` to allow everything, or provide a custom function for fine-grained control. See [Permission Handling](#permission-handling) section.\n- `onUserInputRequest?: UserInputHandler` - Handler for user input requests from the agent. Enables the `ask_user` tool. See [User Input Requests](#user-input-requests) section.\n- `onElicitationRequest?: ElicitationHandler` - Handler for elicitation requests dispatched by the server. Enables this client to present form-based UI dialogs on behalf of the agent or other session participants. See [Elicitation Requests](#elicitation-requests) section.\n- `hooks?: SessionHooks` - Hook handlers for session lifecycle events. See [Session Hooks](#session-hooks) section.\n\n##### `resumeSession(sessionId: string, config?: ResumeSessionConfig): Promise`\n\nResume an existing session. Returns the session with `workspacePath` populated if infinite sessions were enabled.\n\n##### `ping(message?: string): Promise<{ message: string; timestamp: number }>`\n\nPing the server to check connectivity.\n\n##### `getState(): ConnectionState`\n\nGet current connection state.\n\n##### `listSessions(filter?: SessionListFilter): Promise`\n\nList all available sessions. Optionally filter by working directory context.\n\n**SessionMetadata:**\n\n- `sessionId: string` - Unique session identifier\n- `startTime: Date` - When the session was created\n- `modifiedTime: Date` - When the session was last modified\n- `summary?: string` - Optional session summary\n- `isRemote: boolean` - Whether the session is remote\n- `context?: SessionContext` - Working directory context from session creation\n\n**SessionContext:**\n\n- `cwd: string` - Working directory where the session was created\n- `gitRoot?: string` - Git repository root (if in a git repo)\n- `repository?: string` - GitHub repository in \"owner/repo\" format\n- `branch?: string` - Current git branch\n\n##### `deleteSession(sessionId: string): Promise`\n\nDelete a session and its data from disk.\n\n##### `getForegroundSessionId(): Promise`\n\nGet the ID of the session currently displayed in the TUI. Only available when connecting to a server running in TUI+server mode (`--ui-server`).\n\n##### `setForegroundSessionId(sessionId: string): Promise`\n\nRequest the TUI to switch to displaying the specified session. Only available in TUI+server mode.\n\n##### `on(eventType: SessionLifecycleEventType, handler): () => void`\n\nSubscribe to a specific session lifecycle event type. Returns an unsubscribe function.\n\n```typescript\nconst unsubscribe = client.on(\"session.foreground\", (event) => {\n console.log(`Session ${event.sessionId} is now in foreground`);\n});\n```\n\n##### `on(handler: SessionLifecycleHandler): () => void`\n\nSubscribe to all session lifecycle events. Returns an unsubscribe function.\n\n```typescript\nconst unsubscribe = client.on((event) => {\n console.log(`${event.type}: ${event.sessionId}`);\n});\n```\n\n**Lifecycle Event Types:**\n\n- `session.created` - A new session was created\n- `session.deleted` - A session was deleted\n- `session.updated` - A session was updated (e.g., new messages)\n- `session.foreground` - A session became the foreground session in TUI\n- `session.background` - A session is no longer the foreground session\n\n---\n\n### CopilotSession\n\nRepresents a single conversation session.\n\n#### Properties\n\n##### `sessionId: string`\n\nThe unique identifier for this session.\n\n##### `workspacePath?: string`\n\nPath to the session workspace directory when infinite sessions are enabled. Contains `checkpoints/`, `plan.md`, and `files/` subdirectories. Undefined if infinite sessions are disabled.\n\n#### Methods\n\n##### `send(options: MessageOptions): Promise`\n\nSend a message to the session. Returns immediately after the message is queued; use event handlers or `sendAndWait()` to wait for completion.\n\n**Options:**\n\n- `prompt: string` - The message/prompt to send\n- `attachments?: Array<{type, path, displayName}>` - File attachments\n- `mode?: \"enqueue\" | \"immediate\"` - Delivery mode\n\nReturns the message ID.\n\n##### `sendAndWait(options: MessageOptions, timeout?: number): Promise`\n\nSend a message and wait until the session becomes idle.\n\n**Options:**\n\n- `prompt: string` - The message/prompt to send\n- `attachments?: Array<{type, path, displayName}>` - File attachments\n- `mode?: \"enqueue\" | \"immediate\"` - Delivery mode\n- `timeout?: number` - Optional timeout in milliseconds\n\nReturns the final assistant message event, or undefined if none was received.\n\n##### `on(eventType: string, handler: TypedSessionEventHandler): () => void`\n\nSubscribe to a specific event type. The handler receives properly typed events.\n\n```typescript\n// Listen for specific event types with full type inference\nsession.on(\"assistant.message\", (event) => {\n console.log(event.data.content); // TypeScript knows about event.data.content\n});\n\nsession.on(\"session.idle\", () => {\n console.log(\"Session is idle\");\n});\n\n// Listen to streaming events\nsession.on(\"assistant.message_delta\", (event) => {\n process.stdout.write(event.data.deltaContent);\n});\n```\n\n##### `on(handler: SessionEventHandler): () => void`\n\nSubscribe to all session events. Returns an unsubscribe function.\n\n```typescript\nconst unsubscribe = session.on((event) => {\n // Handle any event type\n console.log(event.type, event);\n});\n\n// Later...\nunsubscribe();\n```\n\n##### `abort(): Promise`\n\nAbort the currently processing message in this session.\n\n##### `getMessages(): Promise`\n\nGet all events/messages from this session.\n\n##### `disconnect(): Promise`\n\nDisconnect the session and free resources. Session data on disk is preserved for later resumption.\n\n##### `capabilities: SessionCapabilities`\n\nHost capabilities reported when the session was created or resumed. Use this to check feature support before calling capability-gated APIs.\n\n```typescript\nif (session.capabilities.ui?.elicitation) {\n const ok = await session.ui.confirm(\"Deploy?\");\n}\n```\n\nCapabilities may update during the session. For example, when another client joins or disconnects with an elicitation handler. The SDK automatically applies `capabilities.changed` events, so this property always reflects the current state.\n\n##### `ui: SessionUiApi`\n\nInteractive UI methods for showing dialogs to the user. Only available when the CLI host supports elicitation (`session.capabilities.ui?.elicitation === true`). See [UI Elicitation](#ui-elicitation) for full details.\n\n##### `destroy(): Promise` _(deprecated)_\n\nDeprecated — use `disconnect()` instead.\n\n---\n\n## Event Types\n\nSessions emit various events during processing:\n\n- `user.message` - User message added\n- `assistant.message` - Assistant response\n- `assistant.message_delta` - Streaming response chunk\n- `tool.execution_start` - Tool execution started\n- `tool.execution_complete` - Tool execution completed\n- `command.execute` - Command dispatch request (handled internally by the SDK)\n- `commands.changed` - Command registration changed\n- And more...\n\nSee `SessionEvent` type in the source for full details.\n\n## Image Support\n\nThe SDK supports image attachments via the `attachments` parameter. You can attach images by providing their file path, or by passing base64-encoded data directly using a blob attachment:\n\n```typescript\n// File attachment — runtime reads from disk\nawait session.send({\n prompt: \"What's in this image?\",\n attachments: [\n {\n type: \"file\",\n path: \"/path/to/image.jpg\",\n },\n ],\n});\n\n// Blob attachment — provide base64 data directly\nawait session.send({\n prompt: \"What's in this image?\",\n attachments: [\n {\n type: \"blob\",\n data: base64ImageData,\n mimeType: \"image/png\",\n },\n ],\n});\n```\n\nSupported image formats include JPG, PNG, GIF, and other common image types. The agent's `view` tool can also read images directly from the filesystem, so you can also ask questions like:\n\n```typescript\nawait session.send({ prompt: \"What does the most recent jpg in this directory portray?\" });\n```\n\n## Streaming\n\nEnable streaming to receive assistant response chunks as they're generated:\n\n```typescript\nconst session = await client.createSession({\n model: \"gpt-5\",\n streaming: true,\n});\n\n// Wait for completion using typed event handlers\nconst done = new Promise((resolve) => {\n session.on(\"assistant.message_delta\", (event) => {\n // Streaming message chunk - print incrementally\n process.stdout.write(event.data.deltaContent);\n });\n\n session.on(\"assistant.reasoning_delta\", (event) => {\n // Streaming reasoning chunk (if model supports reasoning)\n process.stdout.write(event.data.deltaContent);\n });\n\n session.on(\"assistant.message\", (event) => {\n // Final message - complete content\n console.log(\"\\n--- Final message ---\");\n console.log(event.data.content);\n });\n\n session.on(\"assistant.reasoning\", (event) => {\n // Final reasoning content (if model supports reasoning)\n console.log(\"--- Reasoning ---\");\n console.log(event.data.content);\n });\n\n session.on(\"session.idle\", () => {\n // Session finished processing\n resolve();\n });\n});\n\nawait session.send({ prompt: \"Tell me a short story\" });\nawait done; // Wait for streaming to complete\n```\n\nWhen `streaming: true`:\n\n- `assistant.message_delta` events are sent with `deltaContent` containing incremental text\n- `assistant.reasoning_delta` events are sent with `deltaContent` for reasoning/chain-of-thought (model-dependent)\n- Accumulate `deltaContent` values to build the full response progressively\n- The final `assistant.message` and `assistant.reasoning` events contain the complete content\n\nNote: `assistant.message` and `assistant.reasoning` (final events) are always sent regardless of streaming setting.\n\n## Advanced Usage\n\n### Manual Server Control\n\n```typescript\nconst client = new CopilotClient({ autoStart: false });\n\n// Start manually\nawait client.start();\n\n// Use client...\n\n// Stop manually\nawait client.stop();\n```\n\n### Tools\n\nYou can let the CLI call back into your process when the model needs capabilities you own. Use `defineTool` with Zod schemas for type-safe tool definitions:\n\n```ts\nimport { z } from \"zod\";\nimport { CopilotClient, defineTool } from \"@github/copilot-sdk\";\n\nconst session = await client.createSession({\n model: \"gpt-5\",\n tools: [\n defineTool(\"lookup_issue\", {\n description: \"Fetch issue details from our tracker\",\n parameters: z.object({\n id: z.string().describe(\"Issue identifier\"),\n }),\n handler: async ({ id }) => {\n const issue = await fetchIssue(id);\n return issue;\n },\n }),\n ],\n});\n```\n\nWhen Copilot invokes `lookup_issue`, the client automatically runs your handler and responds to the CLI. Handlers can return any JSON-serializable value (automatically wrapped), a simple string, or a `ToolResultObject` for full control over result metadata. Raw JSON schemas are also supported if Zod isn't desired.\n\n#### Overriding Built-in Tools\n\nIf you register a tool with the same name as a built-in CLI tool (e.g. `edit_file`, `read_file`), the SDK will throw an error unless you explicitly opt in by setting `overridesBuiltInTool: true`. This flag signals that you intend to replace the built-in tool with your custom implementation.\n\n```ts\ndefineTool(\"edit_file\", {\n description: \"Custom file editor with project-specific validation\",\n parameters: z.object({ path: z.string(), content: z.string() }),\n overridesBuiltInTool: true,\n handler: async ({ path, content }) => {\n /* your logic */\n },\n});\n```\n\n#### Skipping Permission Prompts\n\nSet `skipPermission: true` on a tool definition to allow it to execute without triggering a permission prompt:\n\n```ts\ndefineTool(\"safe_lookup\", {\n description: \"A read-only lookup that needs no confirmation\",\n parameters: z.object({ id: z.string() }),\n skipPermission: true,\n handler: async ({ id }) => {\n /* your logic */\n },\n});\n```\n\n### Commands\n\nRegister slash commands so that users of the CLI's TUI can invoke custom actions via `/commandName`. Each command has a `name`, optional `description`, and a `handler` called when the user executes it.\n\n```ts\nconst session = await client.createSession({\n onPermissionRequest: approveAll,\n commands: [\n {\n name: \"deploy\",\n description: \"Deploy the app to production\",\n handler: async ({ commandName, args }) => {\n console.log(`Deploying with args: ${args}`);\n // Do work here — any thrown error is reported back to the CLI\n },\n },\n ],\n});\n```\n\nWhen the user types `/deploy staging` in the CLI, the SDK receives a `command.execute` event, routes it to your handler, and automatically responds to the CLI. If the handler throws, the error message is forwarded.\n\nCommands are sent to the CLI on both `createSession` and `resumeSession`, so you can update the command set when resuming.\n\n### UI Elicitation\n\nWhen the session has elicitation support — either from the CLI's TUI or from another client that registered an `onElicitationRequest` handler (see [Elicitation Requests](#elicitation-requests)) — the SDK can request interactive form dialogs from the user. The `session.ui` object provides convenience methods built on a single generic `elicitation` RPC.\n\n> **Capability check:** Elicitation is only available when at least one connected participant advertises support. Always check `session.capabilities.ui?.elicitation` before calling UI methods — this property updates automatically as participants join and leave.\n\n```ts\nconst session = await client.createSession({ onPermissionRequest: approveAll });\n\nif (session.capabilities.ui?.elicitation) {\n // Confirm dialog — returns boolean\n const ok = await session.ui.confirm(\"Deploy to production?\");\n\n // Selection dialog — returns selected value or null\n const env = await session.ui.select(\"Pick environment\", [\"production\", \"staging\", \"dev\"]);\n\n // Text input — returns string or null\n const name = await session.ui.input(\"Project name:\", {\n title: \"Name\",\n minLength: 1,\n maxLength: 50,\n });\n\n // Generic elicitation with full schema control\n const result = await session.ui.elicitation({\n message: \"Configure deployment\",\n requestedSchema: {\n type: \"object\",\n properties: {\n region: { type: \"string\", enum: [\"us-east\", \"eu-west\"] },\n dryRun: { type: \"boolean\", default: true },\n },\n required: [\"region\"],\n },\n });\n // result.action: \"accept\" | \"decline\" | \"cancel\"\n // result.content: { region: \"us-east\", dryRun: true } (when accepted)\n}\n```\n\nAll UI methods throw if elicitation is not supported by the host.\n\n### System Message Customization\n\nControl the system prompt using `systemMessage` in session config:\n\n```typescript\nconst session = await client.createSession({\n model: \"gpt-5\",\n systemMessage: {\n content: `\n\n- Always check for security vulnerabilities\n- Suggest performance improvements when applicable\n\n`,\n },\n});\n```\n\nThe SDK auto-injects environment context, tool instructions, and security guardrails. The default CLI persona is preserved, and your `content` is appended after SDK-managed sections. To change the persona or fully redefine the prompt, use `mode: \"replace\"` or `mode: \"customize\"`.\n\n#### Customize Mode\n\nUse `mode: \"customize\"` to selectively override individual sections of the prompt while preserving the rest:\n\n```typescript\nimport { SYSTEM_PROMPT_SECTIONS } from \"@github/copilot-sdk\";\nimport type { SectionOverride, SystemPromptSection } from \"@github/copilot-sdk\";\n\nconst session = await client.createSession({\n model: \"gpt-5\",\n systemMessage: {\n mode: \"customize\",\n sections: {\n // Replace the tone/style section\n tone: {\n action: \"replace\",\n content: \"Respond in a warm, professional tone. Be thorough in explanations.\",\n },\n // Remove coding-specific rules\n code_change_rules: { action: \"remove\" },\n // Append to existing guidelines\n guidelines: { action: \"append\", content: \"\\n* Always cite data sources\" },\n },\n // Additional instructions appended after all sections\n content: \"Focus on financial analysis and reporting.\",\n },\n});\n```\n\nAvailable section IDs: `identity`, `tone`, `tool_efficiency`, `environment_context`, `code_change_rules`, `guidelines`, `safety`, `tool_instructions`, `custom_instructions`, `last_instructions`. Use the `SYSTEM_PROMPT_SECTIONS` constant for descriptions of each section.\n\nEach section override supports four actions:\n\n- **`replace`** — Replace the section content entirely\n- **`remove`** — Remove the section from the prompt\n- **`append`** — Add content after the existing section\n- **`prepend`** — Add content before the existing section\n\nUnknown section IDs are handled gracefully: content from `replace`/`append`/`prepend` overrides is appended to additional instructions, and `remove` overrides are silently ignored.\n\n#### Replace Mode\n\nFor full control (removes all guardrails), use `mode: \"replace\"`:\n\n```typescript\nconst session = await client.createSession({\n model: \"gpt-5\",\n systemMessage: {\n mode: \"replace\",\n content: \"You are a helpful assistant.\",\n },\n});\n```\n\n### Infinite Sessions\n\nBy default, sessions use **infinite sessions** which automatically manage context window limits through background compaction and persist state to a workspace directory.\n\n```typescript\n// Default: infinite sessions enabled with default thresholds\nconst session = await client.createSession({ model: \"gpt-5\" });\n\n// Access the workspace path for checkpoints and files\nconsole.log(session.workspacePath);\n// => ~/.copilot/session-state/{sessionId}/\n\n// Custom thresholds\nconst session = await client.createSession({\n model: \"gpt-5\",\n infiniteSessions: {\n enabled: true,\n backgroundCompactionThreshold: 0.8, // Start compacting at 80% context usage\n bufferExhaustionThreshold: 0.95, // Block at 95% until compaction completes\n },\n});\n\n// Disable infinite sessions\nconst session = await client.createSession({\n model: \"gpt-5\",\n infiniteSessions: { enabled: false },\n});\n```\n\nWhen enabled, sessions emit compaction events:\n\n- `session.compaction_start` - Background compaction started\n- `session.compaction_complete` - Compaction finished (includes token counts)\n\n### Multiple Sessions\n\n```typescript\nconst session1 = await client.createSession({ model: \"gpt-5\" });\nconst session2 = await client.createSession({ model: \"claude-sonnet-4.5\" });\n\n// Both sessions are independent\nawait session1.sendAndWait({ prompt: \"Hello from session 1\" });\nawait session2.sendAndWait({ prompt: \"Hello from session 2\" });\n```\n\n### Custom Session IDs\n\n```typescript\nconst session = await client.createSession({\n sessionId: \"my-custom-session-id\",\n model: \"gpt-5\",\n});\n```\n\n### File Attachments\n\n```typescript\nawait session.send({\n prompt: \"Analyze this file\",\n attachments: [\n {\n type: \"file\",\n path: \"/path/to/file.js\",\n displayName: \"My File\",\n },\n ],\n});\n```\n\n### Custom Providers\n\nThe SDK supports custom OpenAI-compatible API providers (BYOK - Bring Your Own Key), including local providers like Ollama. When using a custom provider, you must specify the `model` explicitly.\n\n**ProviderConfig:**\n\n- `type?: \"openai\" | \"azure\" | \"anthropic\"` - Provider type (default: \"openai\")\n- `baseUrl: string` - API endpoint URL (required)\n- `apiKey?: string` - API key (optional for local providers like Ollama)\n- `bearerToken?: string` - Bearer token for authentication (takes precedence over apiKey)\n- `wireApi?: \"completions\" | \"responses\"` - API format for OpenAI/Azure (default: \"completions\")\n- `azure?.apiVersion?: string` - Azure API version (default: \"2024-10-21\")\n\n**Example with Ollama:**\n\n```typescript\nconst session = await client.createSession({\n model: \"deepseek-coder-v2:16b\", // Required when using custom provider\n provider: {\n type: \"openai\",\n baseUrl: \"http://localhost:11434/v1\", // Ollama endpoint\n // apiKey not required for Ollama\n },\n});\n\nawait session.sendAndWait({ prompt: \"Hello!\" });\n```\n\n**Example with custom OpenAI-compatible API:**\n\n```typescript\nconst session = await client.createSession({\n model: \"gpt-4\",\n provider: {\n type: \"openai\",\n baseUrl: \"https://my-api.example.com/v1\",\n apiKey: process.env.MY_API_KEY,\n },\n});\n```\n\n**Example with Azure OpenAI:**\n\n```typescript\nconst session = await client.createSession({\n model: \"gpt-4\",\n provider: {\n type: \"azure\", // Must be \"azure\" for Azure endpoints, NOT \"openai\"\n baseUrl: \"https://my-resource.openai.azure.com\", // Just the host, no path\n apiKey: process.env.AZURE_OPENAI_KEY,\n azure: {\n apiVersion: \"2024-10-21\",\n },\n },\n});\n```\n\n> **Important notes:**\n>\n> - When using a custom provider, the `model` parameter is **required**. The SDK will throw an error if no model is specified.\n> - For Azure OpenAI endpoints (`*.openai.azure.com`), you **must** use `type: \"azure\"`, not `type: \"openai\"`.\n> - The `baseUrl` should be just the host (e.g., `https://my-resource.openai.azure.com`). Do **not** include `/openai/v1` in the URL - the SDK handles path construction automatically.\n\n## Telemetry\n\nThe SDK supports OpenTelemetry for distributed tracing. Provide a `telemetry` config to enable trace export from the CLI process — this is all most users need:\n\n```typescript\nconst client = new CopilotClient({\n telemetry: {\n otlpEndpoint: \"http://localhost:4318\",\n },\n});\n```\n\nWith just this configuration, the CLI emits spans for every session, message, and tool call to your collector. No additional dependencies or setup required.\n\n**TelemetryConfig options:**\n\n- `otlpEndpoint?: string` - OTLP HTTP endpoint URL\n- `filePath?: string` - File path for JSON-lines trace output\n- `exporterType?: string` - `\"otlp-http\"` or `\"file\"`\n- `sourceName?: string` - Instrumentation scope name\n- `captureContent?: boolean` - Whether to capture message content\n\n### Advanced: Trace Context Propagation\n\n> **You don't need this for normal telemetry collection.** The `telemetry` config above is sufficient to get full traces from the CLI.\n\n`onGetTraceContext` is only needed if your application creates its own OpenTelemetry spans and you want them to appear in the **same distributed trace** as the CLI's spans — for example, to nest a \"handle tool call\" span inside the CLI's \"execute tool\" span, or to show the SDK call as a child of your application's request-handling span.\n\nIf you're already using `@opentelemetry/api` in your app and want this linkage, provide a callback:\n\n```typescript\nimport { propagation, context } from \"@opentelemetry/api\";\n\nconst client = new CopilotClient({\n telemetry: { otlpEndpoint: \"http://localhost:4318\" },\n onGetTraceContext: () => {\n const carrier: Record = {};\n propagation.inject(context.active(), carrier);\n return carrier;\n },\n});\n```\n\nInbound trace context from the CLI is available on the `ToolInvocation` object passed to tool handlers as `traceparent` and `tracestate` fields. See the [OpenTelemetry guide](../docs/observability/opentelemetry.md) for a full wire-up example.\n\n## Permission Handling\n\nAn `onPermissionRequest` handler is **required** whenever you create or resume a session. The handler is called before the agent executes each tool (file writes, shell commands, custom tools, etc.) and must return a decision.\n\n### Approve All (simplest)\n\nUse the built-in `approveAll` helper to allow every tool call without any checks:\n\n```typescript\nimport { CopilotClient, approveAll } from \"@github/copilot-sdk\";\n\nconst session = await client.createSession({\n model: \"gpt-5\",\n onPermissionRequest: approveAll,\n});\n```\n\n### Custom Permission Handler\n\nProvide your own function to inspect each request and apply custom logic:\n\n```typescript\nimport type { PermissionRequest, PermissionRequestResult } from \"@github/copilot-sdk\";\n\nconst session = await client.createSession({\n model: \"gpt-5\",\n onPermissionRequest: (request: PermissionRequest, invocation): PermissionRequestResult => {\n // request.kind — what type of operation is being requested:\n // \"shell\" — executing a shell command\n // \"write\" — writing or editing a file\n // \"read\" — reading a file\n // \"mcp\" — calling an MCP tool\n // \"custom-tool\" — calling one of your registered tools\n // \"url\" — fetching a URL\n // \"memory\" — storing or retrieving persistent session memory\n // \"hook\" — invoking a server-side hook or integration\n // (additional kinds may be added; include a default case in handlers)\n // request.toolCallId — the tool call that triggered this request\n // request.toolName — name of the tool (for custom-tool / mcp)\n // request.fileName — file being written (for write)\n // request.fullCommandText — full shell command (for shell)\n\n if (request.kind === \"shell\") {\n // Deny shell commands\n return { kind: \"denied-interactively-by-user\" };\n }\n\n return { kind: \"approved\" };\n },\n});\n```\n\n### Permission Result Kinds\n\n| Kind | Meaning |\n| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------- |\n| `\"approved\"` | Allow the tool to run |\n| `\"denied-interactively-by-user\"` | User explicitly denied the request |\n| `\"denied-no-approval-rule-and-could-not-request-from-user\"` | No approval rule matched and user could not be asked |\n| `\"denied-by-rules\"` | Denied by a policy rule |\n| `\"denied-by-content-exclusion-policy\"` | Denied due to a content exclusion policy |\n| `\"no-result\"` | Leave the request unanswered (only valid with protocol v1; rejected by protocol v2 servers) |\n\n### Resuming Sessions\n\nPass `onPermissionRequest` when resuming a session too — it is required:\n\n```typescript\nconst session = await client.resumeSession(\"session-id\", {\n onPermissionRequest: approveAll,\n});\n```\n\n### Per-Tool Skip Permission\n\nTo let a specific custom tool bypass the permission prompt entirely, set `skipPermission: true` on the tool definition. See [Skipping Permission Prompts](#skipping-permission-prompts) under Tools.\n\n## User Input Requests\n\nEnable the agent to ask questions to the user using the `ask_user` tool by providing an `onUserInputRequest` handler:\n\n```typescript\nconst session = await client.createSession({\n model: \"gpt-5\",\n onUserInputRequest: async (request, invocation) => {\n // request.question - The question to ask\n // request.choices - Optional array of choices for multiple choice\n // request.allowFreeform - Whether freeform input is allowed (default: true)\n\n console.log(`Agent asks: ${request.question}`);\n if (request.choices) {\n console.log(`Choices: ${request.choices.join(\", \")}`);\n }\n\n // Return the user's response\n return {\n answer: \"User's answer here\",\n wasFreeform: true, // Whether the answer was freeform (not from choices)\n };\n },\n});\n```\n\n## Elicitation Requests\n\nRegister an `onElicitationRequest` handler to let your client act as an elicitation provider — presenting form-based UI dialogs on behalf of the agent. When provided, the server notifies your client whenever a tool or MCP server needs structured user input.\n\n```typescript\nconst session = await client.createSession({\n model: \"gpt-5\",\n onPermissionRequest: approveAll,\n onElicitationRequest: async (context) => {\n // context.sessionId - Session that triggered the request\n // context.message - Description of what information is needed\n // context.requestedSchema - JSON Schema describing the form fields\n // context.mode - \"form\" (structured input) or \"url\" (browser redirect)\n // context.elicitationSource - Origin of the request (e.g. MCP server name)\n\n console.log(`Elicitation from ${context.elicitationSource}: ${context.message}`);\n\n // Present UI to the user and collect their response...\n return {\n action: \"accept\", // \"accept\", \"decline\", or \"cancel\"\n content: { region: \"us-east\", dryRun: true },\n };\n },\n});\n\n// The session now reports elicitation capability\nconsole.log(session.capabilities.ui?.elicitation); // true\n```\n\nWhen `onElicitationRequest` is provided, the SDK sends `requestElicitation: true` during session create/resume, which enables `session.capabilities.ui.elicitation` on the session.\n\nIn multi-client scenarios:\n\n- If no connected client was previously providing an elicitation capability, but a new client joins that can, all clients will receive a `capabilities.changed` event to notify them that elicitation is now possible. The SDK automatically updates `session.capabilities` when these events arrive.\n- Similarly, if the last elicitation provider disconnects, all clients receive a `capabilities.changed` event indicating elicitation is no longer available.\n- The server fans out elicitation requests to **all** connected clients that registered a handler — the first response wins.\n\n## Session Hooks\n\nHook into session lifecycle events by providing handlers in the `hooks` configuration:\n\n```typescript\nconst session = await client.createSession({\n model: \"gpt-5\",\n hooks: {\n // Called before each tool execution\n onPreToolUse: async (input, invocation) => {\n console.log(`About to run tool: ${input.toolName}`);\n // Return permission decision and optionally modify args\n return {\n permissionDecision: \"allow\", // \"allow\", \"deny\", or \"ask\"\n modifiedArgs: input.toolArgs, // Optionally modify tool arguments\n additionalContext: \"Extra context for the model\",\n };\n },\n\n // Called after each tool execution\n onPostToolUse: async (input, invocation) => {\n console.log(`Tool ${input.toolName} completed`);\n // Optionally modify the result or add context\n return {\n additionalContext: \"Post-execution notes\",\n };\n },\n\n // Called when user submits a prompt\n onUserPromptSubmitted: async (input, invocation) => {\n console.log(`User prompt: ${input.prompt}`);\n return {\n modifiedPrompt: input.prompt, // Optionally modify the prompt\n };\n },\n\n // Called when session starts\n onSessionStart: async (input, invocation) => {\n console.log(`Session started from: ${input.source}`); // \"startup\", \"resume\", \"new\"\n return {\n additionalContext: \"Session initialization context\",\n };\n },\n\n // Called when session ends\n onSessionEnd: async (input, invocation) => {\n console.log(`Session ended: ${input.reason}`);\n },\n\n // Called when an error occurs\n onErrorOccurred: async (input, invocation) => {\n console.error(`Error in ${input.errorContext}: ${input.error}`);\n return {\n errorHandling: \"retry\", // \"retry\", \"skip\", or \"abort\"\n };\n },\n },\n});\n```\n\n**Available hooks:**\n\n- `onPreToolUse` - Intercept tool calls before execution. Can allow/deny or modify arguments.\n- `onPostToolUse` - Process tool results after execution. Can modify results or add context.\n- `onUserPromptSubmitted` - Intercept user prompts. Can modify the prompt before processing.\n- `onSessionStart` - Run logic when a session starts or resumes.\n- `onSessionEnd` - Cleanup or logging when session ends.\n- `onErrorOccurred` - Handle errors with retry/skip/abort strategies.\n\n## Error Handling\n\n```typescript\ntry {\n const session = await client.createSession();\n await session.send({ prompt: \"Hello\" });\n} catch (error) {\n console.error(\"Error:\", error.message);\n}\n```\n\n## Requirements\n\n- Node.js >= 18.0.0\n- GitHub Copilot CLI installed and in PATH (or provide custom `cliPath`)\n\n## License\n\nMIT\n" }, { "path": "nodejs/docs/agent-author.md", "content": "# Agent Extension Authoring Guide\n\nA precise, step-by-step reference for agents writing Copilot CLI extensions programmatically.\n\n## Workflow\n\n### Step 1: Scaffold the extension\n\nUse the `extensions_manage` tool with `operation: \"scaffold\"`:\n\n```\nextensions_manage({ operation: \"scaffold\", name: \"my-extension\" })\n```\n\nThis creates `.github/extensions/my-extension/extension.mjs` with a working skeleton.\nFor user-scoped extensions (persist across all repos), add `location: \"user\"`.\n\n### Step 2: Edit the extension file\n\nModify the generated `extension.mjs` using `edit` or `create` tools. The file must:\n\n- Be named `extension.mjs` (only `.mjs` is supported)\n- Use ES module syntax (`import`/`export`)\n- Call `joinSession({ ... })`\n\n### Step 3: Reload extensions\n\n```\nextensions_reload({})\n```\n\nThis stops all running extensions and re-discovers/re-launches them. New tools are available immediately in the same turn (mid-turn refresh).\n\n### Step 4: Verify\n\n```\nextensions_manage({ operation: \"list\" })\nextensions_manage({ operation: \"inspect\", name: \"my-extension\" })\n```\n\nCheck that the extension loaded successfully and isn't marked as \"failed\".\n\n---\n\n## File Structure\n\n```\n.github/extensions//extension.mjs\n```\n\nDiscovery rules:\n\n- The CLI scans `.github/extensions/` relative to the git root\n- It also scans the user's copilot config extensions directory\n- Only immediate subdirectories are checked (not recursive)\n- Each subdirectory must contain a file named `extension.mjs`\n- Project extensions shadow user extensions on name collision\n\n---\n\n## Minimal Skeleton\n\n```js\nimport { joinSession } from \"@github/copilot-sdk/extension\";\n\nawait joinSession({\n tools: [], // Optional — custom tools\n hooks: {}, // Optional — lifecycle hooks\n});\n```\n\n---\n\n## Registering Tools\n\n```js\ntools: [\n {\n name: \"tool_name\", // Required. Must be globally unique across all extensions.\n description: \"What it does\", // Required. Shown to the agent in tool descriptions.\n parameters: {\n // Optional. JSON Schema for the arguments.\n type: \"object\",\n properties: {\n arg1: { type: \"string\", description: \"...\" },\n },\n required: [\"arg1\"],\n },\n handler: async (args, invocation) => {\n // args: parsed arguments matching the schema\n // invocation.sessionId: current session ID\n // invocation.toolCallId: unique call ID\n // invocation.toolName: this tool's name\n //\n // Return value: string or ToolResultObject\n // string → treated as success\n // { textResultForLlm, resultType } → structured result\n // resultType: \"success\" | \"failure\" | \"rejected\" | \"denied\"\n return `Result: ${args.arg1}`;\n },\n },\n];\n```\n\n**Constraints:**\n\n- Tool names must be unique across ALL loaded extensions. Collisions cause the second extension to fail to load.\n- Handler must return a string or `{ textResultForLlm: string, resultType?: string }`.\n- Handler receives `(args, invocation)` — the second argument has `sessionId`, `toolCallId`, `toolName`.\n- Use `session.log()` to surface messages to the user. Don't use `console.log()` (stdout is reserved for JSON-RPC).\n\n---\n\n## Registering Hooks\n\n```js\nhooks: {\n onUserPromptSubmitted: async (input, invocation) => { ... },\n onPreToolUse: async (input, invocation) => { ... },\n onPostToolUse: async (input, invocation) => { ... },\n onSessionStart: async (input, invocation) => { ... },\n onSessionEnd: async (input, invocation) => { ... },\n onErrorOccurred: async (input, invocation) => { ... },\n}\n```\n\nAll hook inputs include `timestamp` (unix ms) and `cwd` (working directory).\nAll handlers receive `invocation: { sessionId: string }` as the second argument.\nAll handlers may return `void`/`undefined` (no-op) or an output object.\n\n### onUserPromptSubmitted\n\n**Input:** `{ prompt: string, timestamp, cwd }`\n\n**Output (all fields optional):**\n| Field | Type | Effect |\n|-------|------|--------|\n| `modifiedPrompt` | `string` | Replaces the user's prompt |\n| `additionalContext` | `string` | Appended as hidden context the agent sees |\n\n### onPreToolUse\n\n**Input:** `{ toolName: string, toolArgs: unknown, timestamp, cwd }`\n\n**Output (all fields optional):**\n| Field | Type | Effect |\n|-------|------|--------|\n| `permissionDecision` | `\"allow\" \\| \"deny\" \\| \"ask\"` | Override the permission check |\n| `permissionDecisionReason` | `string` | Shown to user if denied |\n| `modifiedArgs` | `unknown` | Replaces the tool arguments |\n| `additionalContext` | `string` | Injected into the conversation |\n\n### onPostToolUse\n\n**Input:** `{ toolName: string, toolArgs: unknown, toolResult: ToolResultObject, timestamp, cwd }`\n\n**Output (all fields optional):**\n| Field | Type | Effect |\n|-------|------|--------|\n| `modifiedResult` | `ToolResultObject` | Replaces the tool result |\n| `additionalContext` | `string` | Injected into the conversation |\n\n### onSessionStart\n\n**Input:** `{ source: \"startup\" \\| \"resume\" \\| \"new\", initialPrompt?: string, timestamp, cwd }`\n\n**Output (all fields optional):**\n| Field | Type | Effect |\n|-------|------|--------|\n| `additionalContext` | `string` | Injected as initial context |\n\n### onSessionEnd\n\n**Input:** `{ reason: \"complete\" \\| \"error\" \\| \"abort\" \\| \"timeout\" \\| \"user_exit\", finalMessage?: string, error?: string, timestamp, cwd }`\n\n**Output (all fields optional):**\n| Field | Type | Effect |\n|-------|------|--------|\n| `sessionSummary` | `string` | Summary for session persistence |\n| `cleanupActions` | `string[]` | Cleanup descriptions |\n\n### onErrorOccurred\n\n**Input:** `{ error: string, errorContext: \"model_call\" \\| \"tool_execution\" \\| \"system\" \\| \"user_input\", recoverable: boolean, timestamp, cwd }`\n\n**Output (all fields optional):**\n| Field | Type | Effect |\n|-------|------|--------|\n| `errorHandling` | `\"retry\" \\| \"skip\" \\| \"abort\"` | How to handle the error |\n| `retryCount` | `number` | Max retries (when errorHandling is \"retry\") |\n| `userNotification` | `string` | Message shown to the user |\n\n---\n\n## Session Object\n\nAfter `joinSession()`, the returned `session` provides:\n\n### session.send(options)\n\nSend a message programmatically:\n\n```js\nawait session.send({ prompt: \"Analyze the test results.\" });\nawait session.send({\n prompt: \"Review this file\",\n attachments: [{ type: \"file\", path: \"./src/index.ts\" }],\n});\n```\n\n### session.sendAndWait(options, timeout?)\n\nSend and block until the agent finishes (resolves on `session.idle`):\n\n```js\nconst response = await session.sendAndWait({ prompt: \"What is 2+2?\" });\n// response?.data.content contains the agent's reply\n```\n\n### session.log(message, options?)\n\nLog to the CLI timeline:\n\n```js\nawait session.log(\"Extension ready\");\nawait session.log(\"Rate limit approaching\", { level: \"warning\" });\nawait session.log(\"Connection failed\", { level: \"error\" });\nawait session.log(\"Processing...\", { ephemeral: true }); // transient, not persisted\n```\n\n### session.on(eventType, handler)\n\nSubscribe to session events. Returns an unsubscribe function.\n\n```js\nconst unsub = session.on(\"tool.execution_complete\", (event) => {\n // event.data.toolName, event.data.success, event.data.result\n});\n```\n\n### Key Event Types\n\n| Event | Key Data Fields |\n| ------------------------- | ------------------------------------------------------ |\n| `assistant.message` | `content`, `messageId` |\n| `tool.execution_start` | `toolCallId`, `toolName`, `arguments` |\n| `tool.execution_complete` | `toolCallId`, `toolName`, `success`, `result`, `error` |\n| `user.message` | `content`, `attachments`, `source` |\n| `session.idle` | `backgroundTasks` |\n| `session.error` | `errorType`, `message`, `stack` |\n| `permission.requested` | `requestId`, `permissionRequest.kind` |\n| `session.shutdown` | `shutdownType`, `totalPremiumRequests` |\n\n### session.workspacePath\n\nPath to the session workspace directory (checkpoints, plan.md, files/). `undefined` if infinite sessions disabled.\n\n### session.rpc\n\nLow-level typed RPC access to all session APIs (model, mode, plan, workspace, etc.).\n\n---\n\n## Gotchas\n\n- **stdout is reserved for JSON-RPC.** Don't use `console.log()` — it will corrupt the protocol. Use `session.log()` to surface messages to the user.\n- **Tool name collisions are fatal.** If two extensions register the same tool name, the second extension fails to initialize.\n- **Don't call `session.send()` synchronously from `onUserPromptSubmitted`.** Use `setTimeout(() => session.send(...), 0)` to avoid infinite loops.\n- **Extensions are reloaded on `/clear`.** Any in-memory state is lost between sessions.\n- **Only `.mjs` is supported.** TypeScript (`.ts`) is not yet supported.\n- **The handler's return value is the tool result.** Returning `undefined` sends an empty success. Throwing sends a failure with the error message.\n" }, { "path": "nodejs/docs/examples.md", "content": "# Copilot CLI Extension Examples\n\nA practical guide to writing extensions using the `@github/copilot-sdk` extension API.\n\n## Extension Skeleton\n\nEvery extension starts with the same boilerplate:\n\n```js\nimport { joinSession } from \"@github/copilot-sdk/extension\";\n\nconst session = await joinSession({\n hooks: {\n /* ... */\n },\n tools: [\n /* ... */\n ],\n});\n```\n\n`joinSession` returns a `CopilotSession` object you can use to send messages and subscribe to events.\n\n> **Platform notes (Windows vs macOS/Linux):**\n>\n> - Use `process.platform === \"win32\"` to detect Windows at runtime.\n> - Clipboard: `pbcopy` on macOS, `clip` on Windows.\n> - Use `exec()` instead of `execFile()` for `.cmd` scripts like `code`, `npx`, `npm` on Windows.\n> - PowerShell stderr redirection uses `*>&1` instead of `2>&1`.\n\n---\n\n## Logging to the Timeline\n\nUse `session.log()` to surface messages to the user in the CLI timeline:\n\n```js\nconst session = await joinSession({\n hooks: {\n onSessionStart: async () => {\n await session.log(\"My extension loaded\");\n },\n onPreToolUse: async (input) => {\n if (input.toolName === \"bash\") {\n await session.log(`Running: ${input.toolArgs?.command}`, { ephemeral: true });\n }\n },\n },\n tools: [],\n});\n```\n\nLevels: `\"info\"` (default), `\"warning\"`, `\"error\"`. Set `ephemeral: true` for transient messages that aren't persisted.\n\n---\n\n## Registering Custom Tools\n\nTools are functions the agent can call. Define them with a name, description, JSON Schema parameters, and a handler.\n\n### Basic tool\n\n```js\ntools: [\n {\n name: \"my_tool\",\n description: \"Does something useful\",\n parameters: {\n type: \"object\",\n properties: {\n input: { type: \"string\", description: \"The input value\" },\n },\n required: [\"input\"],\n },\n handler: async (args) => {\n return `Processed: ${args.input}`;\n },\n },\n];\n```\n\n### Tool that invokes an external shell command\n\n```js\nimport { execFile } from \"node:child_process\";\n\n{\n name: \"run_command\",\n description: \"Runs a shell command and returns its output\",\n parameters: {\n type: \"object\",\n properties: {\n command: { type: \"string\", description: \"The command to run\" },\n },\n required: [\"command\"],\n },\n handler: async (args) => {\n const isWindows = process.platform === \"win32\";\n const shell = isWindows ? \"powershell\" : \"bash\";\n const shellArgs = isWindows\n ? [\"-NoProfile\", \"-Command\", args.command]\n : [\"-c\", args.command];\n return new Promise((resolve) => {\n execFile(shell, shellArgs, (err, stdout, stderr) => {\n if (err) resolve(`Error: ${stderr || err.message}`);\n else resolve(stdout);\n });\n });\n },\n}\n```\n\n### Tool that calls an external API\n\n```js\n{\n name: \"fetch_data\",\n description: \"Fetches data from an API endpoint\",\n parameters: {\n type: \"object\",\n properties: {\n url: { type: \"string\", description: \"The URL to fetch\" },\n },\n required: [\"url\"],\n },\n handler: async (args) => {\n const res = await fetch(args.url);\n if (!res.ok) return `Error: HTTP ${res.status}`;\n return await res.text();\n },\n}\n```\n\n### Tool handler invocation context\n\nThe handler receives a second argument with invocation metadata:\n\n```js\nhandler: async (args, invocation) => {\n // invocation.sessionId — current session ID\n // invocation.toolCallId — unique ID for this tool call\n // invocation.toolName — name of the tool being called\n return \"done\";\n};\n```\n\n---\n\n## Hooks\n\nHooks intercept and modify behavior at key lifecycle points. Register them in the `hooks` option.\n\n### Available Hooks\n\n| Hook | Fires When | Can Modify |\n| ----------------------- | ------------------------- | ------------------------------------------- |\n| `onUserPromptSubmitted` | User sends a message | The prompt text, add context |\n| `onPreToolUse` | Before a tool executes | Tool args, permission decision, add context |\n| `onPostToolUse` | After a tool executes | Tool result, add context |\n| `onSessionStart` | Session starts or resumes | Add context, modify config |\n| `onSessionEnd` | Session ends | Cleanup actions, summary |\n| `onErrorOccurred` | An error occurs | Error handling strategy (retry/skip/abort) |\n\nAll hook inputs include `timestamp` (unix ms) and `cwd` (working directory).\n\n### Modifying the user's message\n\nUse `onUserPromptSubmitted` to rewrite or augment what the user typed before the agent sees it.\n\n```js\nhooks: {\n onUserPromptSubmitted: async (input) => {\n // Rewrite the prompt\n return { modifiedPrompt: input.prompt.toUpperCase() };\n },\n}\n```\n\n### Injecting additional context into every message\n\nReturn `additionalContext` to silently append instructions the agent will follow.\n\n```js\nhooks: {\n onUserPromptSubmitted: async (input) => {\n return {\n additionalContext: \"Always respond in bullet points. Follow our team coding standards.\",\n };\n },\n}\n```\n\n### Sending a follow-up message based on a keyword\n\nUse `session.send()` to programmatically inject a new user message.\n\n```js\nhooks: {\n onUserPromptSubmitted: async (input) => {\n if (/\\\\burgent\\\\b/i.test(input.prompt)) {\n // Fire-and-forget a follow-up message\n setTimeout(() => session.send({ prompt: \"Please prioritize this.\" }), 0);\n }\n },\n}\n```\n\n> **Tip:** Guard against infinite loops if your follow-up message could re-trigger the same hook.\n\n### Blocking dangerous tool calls\n\nUse `onPreToolUse` to inspect and optionally deny tool execution.\n\n```js\nhooks: {\n onPreToolUse: async (input) => {\n if (input.toolName === \"bash\") {\n const cmd = String(input.toolArgs?.command || \"\");\n if (/rm\\\\s+-rf/i.test(cmd) || /Remove-Item\\\\s+.*-Recurse/i.test(cmd)) {\n return {\n permissionDecision: \"deny\",\n permissionDecisionReason: \"Destructive commands are not allowed.\",\n };\n }\n }\n // Allow everything else\n return { permissionDecision: \"allow\" };\n },\n}\n```\n\n### Modifying tool arguments before execution\n\n```js\nhooks: {\n onPreToolUse: async (input) => {\n if (input.toolName === \"bash\") {\n const redirect = process.platform === \"win32\" ? \"*>&1\" : \"2>&1\";\n return {\n modifiedArgs: {\n ...input.toolArgs,\n command: `${input.toolArgs.command} ${redirect}`,\n },\n };\n }\n },\n}\n```\n\n### Reacting when the agent creates or edits a file\n\nUse `onPostToolUse` to run side effects after a tool completes.\n\n```js\nimport { exec } from \"node:child_process\";\n\nhooks: {\n onPostToolUse: async (input) => {\n if (input.toolName === \"create\" || input.toolName === \"edit\") {\n const filePath = input.toolArgs?.path;\n if (filePath) {\n // Open the file in VS Code\n exec(`code \"${filePath}\"`, () => {});\n }\n }\n },\n}\n```\n\n### Augmenting tool results with extra context\n\n```js\nhooks: {\n onPostToolUse: async (input) => {\n if (input.toolName === \"bash\" && input.toolResult?.resultType === \"failure\") {\n return {\n additionalContext: \"The command failed. Try a different approach.\",\n };\n }\n },\n}\n```\n\n### Running a linter after every file edit\n\n```js\nimport { exec } from \"node:child_process\";\n\nhooks: {\n onPostToolUse: async (input) => {\n if (input.toolName === \"edit\") {\n const filePath = input.toolArgs?.path;\n if (filePath?.endsWith(\".ts\")) {\n const result = await new Promise((resolve) => {\n exec(`npx eslint \"${filePath}\"`, (err, stdout) => {\n resolve(err ? stdout : \"No lint errors.\");\n });\n });\n return { additionalContext: `Lint result: ${result}` };\n }\n }\n },\n}\n```\n\n### Handling errors with retry logic\n\n```js\nhooks: {\n onErrorOccurred: async (input) => {\n if (input.recoverable && input.errorContext === \"model_call\") {\n return { errorHandling: \"retry\", retryCount: 2 };\n }\n return {\n errorHandling: \"abort\",\n userNotification: `An error occurred: ${input.error}`,\n };\n },\n}\n```\n\n### Session lifecycle hooks\n\n```js\nhooks: {\n onSessionStart: async (input) => {\n // input.source is \"startup\", \"resume\", or \"new\"\n return { additionalContext: \"Remember to write tests for all changes.\" };\n },\n onSessionEnd: async (input) => {\n // input.reason is \"complete\", \"error\", \"abort\", \"timeout\", or \"user_exit\"\n },\n}\n```\n\n---\n\n## Session Events\n\nAfter calling `joinSession`, use `session.on()` to react to events in real time.\n\n### Listening to a specific event type\n\n```js\nsession.on(\"assistant.message\", (event) => {\n // event.data.content has the agent's response text\n});\n```\n\n### Listening to all events\n\n```js\nsession.on((event) => {\n // event.type and event.data are available for all events\n});\n```\n\n### Unsubscribing from events\n\n`session.on()` returns an unsubscribe function:\n\n```js\nconst unsubscribe = session.on(\"tool.execution_complete\", (event) => {\n // event.data.toolName, event.data.success, event.data.result, event.data.error\n});\n\n// Later, stop listening\nunsubscribe();\n```\n\n### Example: Auto-copy agent responses to clipboard\n\nCombine a hook (to detect a keyword) with a session event (to capture the response):\n\n```js\nimport { execFile } from \"node:child_process\";\n\nlet copyNextResponse = false;\n\nfunction copyToClipboard(text) {\n const cmd = process.platform === \"win32\" ? \"clip\" : \"pbcopy\";\n const proc = execFile(cmd, [], () => {});\n proc.stdin.write(text);\n proc.stdin.end();\n}\n\nconst session = await joinSession({\n hooks: {\n onUserPromptSubmitted: async (input) => {\n if (/\\\\bcopy\\\\b/i.test(input.prompt)) {\n copyNextResponse = true;\n }\n },\n },\n tools: [],\n});\n\nsession.on(\"assistant.message\", (event) => {\n if (copyNextResponse) {\n copyNextResponse = false;\n copyToClipboard(event.data.content);\n }\n});\n```\n\n### Top 10 Most Useful Event Types\n\n| Event Type | Description | Key Data Fields |\n| --------------------------- | ------------------------------------------------ | ------------------------------------------------------ |\n| `assistant.message` | Agent's final response | `content`, `messageId`, `toolRequests` |\n| `assistant.streaming_delta` | Token-by-token streaming (ephemeral) | `totalResponseSizeBytes` |\n| `tool.execution_start` | A tool is about to run | `toolCallId`, `toolName`, `arguments` |\n| `tool.execution_complete` | A tool finished running | `toolCallId`, `toolName`, `success`, `result`, `error` |\n| `user.message` | User sent a message | `content`, `attachments`, `source` |\n| `session.idle` | Session finished processing a turn | `backgroundTasks` |\n| `session.error` | An error occurred | `errorType`, `message`, `stack` |\n| `permission.requested` | Agent needs permission (shell, file write, etc.) | `requestId`, `permissionRequest.kind` |\n| `session.shutdown` | Session is ending | `shutdownType`, `totalPremiumRequests`, `codeChanges` |\n| `assistant.turn_start` | Agent begins a new thinking/response cycle | `turnId` |\n\n### Example: Detecting when the plan file is created or edited\n\nUse `session.workspacePath` to locate the session's `plan.md`, then `fs.watchFile` to detect changes.\nCorrelate `tool.execution_start` / `tool.execution_complete` events by `toolCallId` to distinguish agent edits from user edits.\n\n```js\nimport { existsSync, watchFile, readFileSync } from \"node:fs\";\nimport { join } from \"node:path\";\nimport { joinSession } from \"@github/copilot-sdk/extension\";\n\nconst agentEdits = new Set(); // toolCallIds for in-flight agent edits\nconst recentAgentPaths = new Set(); // paths recently written by the agent\n\nconst session = await joinSession();\n\nconst workspace = session.workspacePath; // e.g. ~/.copilot/session-state/\nif (workspace) {\n const planPath = join(workspace, \"plan.md\");\n let lastContent = existsSync(planPath) ? readFileSync(planPath, \"utf-8\") : null;\n\n // Track agent edits to suppress false triggers\n session.on(\"tool.execution_start\", (event) => {\n if (\n (event.data.toolName === \"edit\" || event.data.toolName === \"create\") &&\n String(event.data.arguments?.path || \"\").endsWith(\"plan.md\")\n ) {\n agentEdits.add(event.data.toolCallId);\n recentAgentPaths.add(planPath);\n }\n });\n session.on(\"tool.execution_complete\", (event) => {\n if (agentEdits.delete(event.data.toolCallId)) {\n setTimeout(() => {\n recentAgentPaths.delete(planPath);\n lastContent = existsSync(planPath) ? readFileSync(planPath, \"utf-8\") : null;\n }, 2000);\n }\n });\n\n watchFile(planPath, { interval: 1000 }, () => {\n if (recentAgentPaths.has(planPath) || agentEdits.size > 0) return;\n const content = existsSync(planPath) ? readFileSync(planPath, \"utf-8\") : null;\n if (content === lastContent) return;\n const wasCreated = lastContent === null && content !== null;\n lastContent = content;\n if (content !== null) {\n session.send({\n prompt: `The plan was ${wasCreated ? \"created\" : \"edited\"} by the user.`,\n });\n }\n });\n}\n```\n\n### Example: Reacting when the user manually edits any file in the repo\n\nUse `fs.watch` with `recursive: true` on `process.cwd()` to detect file changes.\nFilter out agent edits by tracking `tool.execution_start` / `tool.execution_complete` events.\n\n```js\nimport { watch, readFileSync, statSync } from \"node:fs\";\nimport { join, relative, resolve } from \"node:path\";\nimport { joinSession } from \"@github/copilot-sdk/extension\";\n\nconst agentEditPaths = new Set();\n\nconst session = await joinSession();\n\nconst cwd = process.cwd();\nconst IGNORE = new Set([\"node_modules\", \".git\", \"dist\"]);\n\n// Track agent file edits\nsession.on(\"tool.execution_start\", (event) => {\n if (event.data.toolName === \"edit\" || event.data.toolName === \"create\") {\n const p = String(event.data.arguments?.path || \"\");\n if (p) agentEditPaths.add(resolve(p));\n }\n});\nsession.on(\"tool.execution_complete\", (event) => {\n // Clear after a delay to avoid race with fs.watch\n const p = [...agentEditPaths].find((x) => x); // any tracked path\n setTimeout(() => agentEditPaths.clear(), 3000);\n});\n\nconst debounce = new Map();\n\nwatch(cwd, { recursive: true }, (eventType, filename) => {\n if (!filename || eventType !== \"change\") return;\n if (filename.split(/[\\\\\\\\\\\\/]/).some((p) => IGNORE.has(p))) return;\n\n if (debounce.has(filename)) clearTimeout(debounce.get(filename));\n debounce.set(filename, setTimeout(() => {\n debounce.delete(filename);\n const fullPath = join(cwd, filename);\n if (agentEditPaths.has(resolve(fullPath))) return;\n\n try { if (!statSync(fullPath).isFile()) return; } catch { return; }\n const relPath = relative(cwd, fullPath);\n session.send({\n prompt: `The user edited \\\\`${relPath}\\\\`.`,\n attachments: [{ type: \"file\", path: fullPath }],\n });\n }, 500));\n});\n```\n\n---\n\n## Sending Messages Programmatically\n\n### Fire-and-forget\n\n```js\nawait session.send({ prompt: \"Analyze the test results.\" });\n```\n\n### Send and wait for the response\n\n```js\nconst response = await session.sendAndWait({ prompt: \"What is 2 + 2?\" });\n// response?.data.content contains the agent's reply\n```\n\n### Send with file attachments\n\n```js\nawait session.send({\n prompt: \"Review this file\",\n attachments: [{ type: \"file\", path: \"./src/index.ts\" }],\n});\n```\n\n---\n\n## Permission and User Input Handlers\n\n### Custom permission logic\n\n```js\nconst session = await joinSession({\n onPermissionRequest: async (request) => {\n if (request.kind === \"shell\") {\n // request.fullCommandText has the shell command\n return { kind: \"approved\" };\n }\n if (request.kind === \"write\") {\n return { kind: \"approved\" };\n }\n return { kind: \"denied-by-rules\" };\n },\n});\n```\n\n### Handling agent questions (ask_user)\n\nRegister `onUserInputRequest` to enable the agent's `ask_user` tool:\n\n```js\nconst session = await joinSession({\n onUserInputRequest: async (request) => {\n // request.question has the agent's question\n // request.choices has the options (if multiple choice)\n return { answer: \"yes\", wasFreeform: false };\n },\n});\n```\n\n---\n\n## Complete Example: Multi-Feature Extension\n\nAn extension that combines tools, hooks, and events.\n\n```js\nimport { execFile, exec } from \"node:child_process\";\nimport { joinSession } from \"@github/copilot-sdk/extension\";\n\nconst isWindows = process.platform === \"win32\";\nlet copyNextResponse = false;\n\nfunction copyToClipboard(text) {\n const proc = execFile(isWindows ? \"clip\" : \"pbcopy\", [], () => {});\n proc.stdin.write(text);\n proc.stdin.end();\n}\n\nfunction openInEditor(filePath) {\n if (isWindows) exec(`code \"${filePath}\"`, () => {});\n else execFile(\"code\", [filePath], () => {});\n}\n\nconst session = await joinSession({\n hooks: {\n onUserPromptSubmitted: async (input) => {\n if (/\\\\bcopy this\\\\b/i.test(input.prompt)) {\n copyNextResponse = true;\n }\n return {\n additionalContext: \"Follow our team style guide. Use 4-space indentation.\",\n };\n },\n onPreToolUse: async (input) => {\n if (input.toolName === \"bash\") {\n const cmd = String(input.toolArgs?.command || \"\");\n if (/rm\\\\s+-rf\\\\s+\\\\/ / i.test(cmd) || /Remove-Item\\\\s+.*-Recurse/i.test(cmd)) {\n return { permissionDecision: \"deny\" };\n }\n }\n },\n onPostToolUse: async (input) => {\n if (input.toolName === \"create\" || input.toolName === \"edit\") {\n const filePath = input.toolArgs?.path;\n if (filePath) openInEditor(filePath);\n }\n },\n },\n tools: [\n {\n name: \"copy_to_clipboard\",\n description: \"Copies text to the system clipboard.\",\n parameters: {\n type: \"object\",\n properties: {\n text: { type: \"string\", description: \"Text to copy\" },\n },\n required: [\"text\"],\n },\n handler: async (args) => {\n return new Promise((resolve) => {\n const proc = execFile(isWindows ? \"clip\" : \"pbcopy\", [], (err) => {\n if (err) resolve(`Error: ${err.message}`);\n else resolve(\"Copied to clipboard.\");\n });\n proc.stdin.write(args.text);\n proc.stdin.end();\n });\n },\n },\n ],\n});\n\nsession.on(\"assistant.message\", (event) => {\n if (copyNextResponse) {\n copyNextResponse = false;\n copyToClipboard(event.data.content);\n }\n});\n\nsession.on(\"tool.execution_complete\", (event) => {\n // event.data.success, event.data.toolName, event.data.result\n});\n```\n" }, { "path": "nodejs/docs/extensions.md", "content": "# Copilot CLI Extensions\n\nExtensions add custom tools, hooks, and behaviors to the Copilot CLI. They run as separate Node.js processes that communicate with the CLI over JSON-RPC via stdio.\n\n## How Extensions Work\n\n```\n┌─────────────────────┐ JSON-RPC / stdio ┌──────────────────────┐\n│ Copilot CLI │ ◄──────────────────────────────────► │ Extension Process │\n│ (parent process) │ tool calls, events, hooks │ (forked child) │\n│ │ │ │\n│ • Discovers exts │ │ • Registers tools │\n│ • Forks processes │ │ • Registers hooks │\n│ • Routes tool calls │ │ • Listens to events │\n│ • Manages lifecycle │ │ • Uses SDK APIs │\n└─────────────────────┘ └──────────────────────┘\n```\n\n1. **Discovery**: The CLI scans `.github/extensions/` (project) and the user's copilot config extensions directory for subdirectories containing `extension.mjs`.\n2. **Launch**: Each extension is forked as a child process with `@github/copilot-sdk` available via an automatic module resolver.\n3. **Connection**: The extension calls `joinSession()` which establishes a JSON-RPC connection over stdio to the CLI and attaches to the user's current foreground session.\n4. **Registration**: Tools and hooks declared in the session options are registered with the CLI and become available to the agent.\n5. **Lifecycle**: Extensions are reloaded on `/clear` (or if the foreground session is replaced) and stopped on CLI exit (SIGTERM, then SIGKILL after 5s).\n\n## File Structure\n\n```\n.github/extensions/\n my-extension/\n extension.mjs ← Entry point (required, must be .mjs)\n```\n\n- Only `.mjs` files are supported (ES modules). The file must be named `extension.mjs`.\n- Each extension lives in its own subdirectory.\n- The `@github/copilot-sdk` import is resolved automatically — you don't install it.\n\n## The SDK\n\nExtensions use `@github/copilot-sdk` for all interactions with the CLI:\n\n```js\nimport { joinSession } from \"@github/copilot-sdk/extension\";\n\nconst session = await joinSession({\n tools: [\n /* ... */\n ],\n hooks: {\n /* ... */\n },\n});\n```\n\nThe `session` object provides methods for sending messages, logging to the timeline, listening to events, and accessing the RPC API. See the `.d.ts` files in the SDK package for full type information.\n\n## Further Reading\n\n- `examples.md` — Practical code examples for tools, hooks, events, and complete extensions\n- `agent-author.md` — Step-by-step workflow for agents authoring extensions programmatically\n" }, { "path": "nodejs/esbuild-copilotsdk-nodejs.ts", "content": "import * as esbuild from \"esbuild\";\nimport { globSync } from \"glob\";\nimport { execSync } from \"child_process\";\n\nconst entryPoints = globSync(\"src/**/*.ts\");\n\n// ESM build\nawait esbuild.build({\n entryPoints,\n outbase: \"src\",\n outdir: \"dist\",\n format: \"esm\",\n platform: \"node\",\n target: \"es2022\",\n sourcemap: false,\n outExtension: { \".js\": \".js\" },\n});\n\n// CJS build — uses .js extension with a \"type\":\"commonjs\" package.json marker\nawait esbuild.build({\n entryPoints,\n outbase: \"src\",\n outdir: \"dist/cjs\",\n format: \"cjs\",\n platform: \"node\",\n target: \"es2022\",\n sourcemap: false,\n outExtension: { \".js\": \".js\" },\n logOverride: { \"empty-import-meta\": \"silent\" },\n});\n\n// Mark the CJS directory so Node treats .js files as CommonJS\nimport { writeFileSync } from \"fs\";\nwriteFileSync(\"dist/cjs/package.json\", JSON.stringify({ type: \"commonjs\" }) + \"\\n\");\n\n// Generate .d.ts files\nexecSync(\"tsc\", { stdio: \"inherit\" });\n" }, { "path": "nodejs/eslint.config.js", "content": "import tseslint from \"@typescript-eslint/eslint-plugin\";\nimport parser from \"@typescript-eslint/parser\";\n\nexport default [\n {\n files: [\"**/*.ts\"],\n languageOptions: {\n parser: parser,\n parserOptions: {\n ecmaVersion: 2022,\n sourceType: \"module\",\n },\n },\n plugins: {\n \"@typescript-eslint\": tseslint,\n },\n rules: {\n \"@typescript-eslint/no-unused-vars\": [\n \"error\",\n {\n args: \"all\",\n argsIgnorePattern: \"^_\",\n caughtErrors: \"all\",\n caughtErrorsIgnorePattern: \"^_\",\n destructuredArrayIgnorePattern: \"^_\",\n varsIgnorePattern: \"^_\",\n ignoreRestSiblings: true,\n },\n ],\n \"@typescript-eslint/no-explicit-any\": \"warn\",\n \"no-console\": \"off\",\n },\n },\n {\n ignores: [\"dist/**\", \"node_modules/**\", \"*.config.ts\", \"**/generated/**\"],\n },\n];\n" }, { "path": "nodejs/examples/basic-example.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { z } from \"zod\";\nimport { CopilotClient, defineTool } from \"../src/index.js\";\n\nconsole.log(\"🚀 Starting Copilot SDK Example\\n\");\n\nconst facts: Record = {\n javascript: \"JavaScript was created in 10 days by Brendan Eich in 1995.\",\n node: \"Node.js lets you run JavaScript outside the browser using the V8 engine.\",\n};\n\nconst lookupFactTool = defineTool(\"lookup_fact\", {\n description: \"Returns a fun fact about a given topic.\",\n parameters: z.object({\n topic: z.string().describe(\"Topic to look up (e.g. 'javascript', 'node')\"),\n }),\n handler: ({ topic }) => facts[topic.toLowerCase()] ?? `No fact stored for ${topic}.`,\n});\n\n// Create client - will auto-start CLI server (searches PATH for \"copilot\")\nconst client = new CopilotClient({ logLevel: \"info\" });\nconst session = await client.createSession({ tools: [lookupFactTool] });\nconsole.log(`✅ Session created: ${session.sessionId}\\n`);\n\n// Listen to events\nsession.on((event) => {\n console.log(`📢 Event [${event.type}]:`, JSON.stringify(event.data, null, 2));\n});\n\n// Send a simple message\nconsole.log(\"💬 Sending message...\");\nconst result1 = await session.sendAndWait({ prompt: \"Tell me 2+2\" });\nconsole.log(\"📝 Response:\", result1?.data.content);\n\n// Send another message that uses the tool\nconsole.log(\"💬 Sending follow-up message...\");\nconst result2 = await session.sendAndWait({ prompt: \"Use lookup_fact to tell me about 'node'\" });\nconsole.log(\"📝 Response:\", result2?.data.content);\n\n// Clean up\nawait session.disconnect();\nawait client.stop();\nconsole.log(\"✅ Done!\");\n" }, { "path": "nodejs/package.json", "content": "{\n \"name\": \"@github/copilot-sdk\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/github/copilot-sdk.git\"\n },\n \"version\": \"0.1.8\",\n \"description\": \"TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC\",\n \"main\": \"./dist/cjs/index.js\",\n \"types\": \"./dist/index.d.ts\",\n \"exports\": {\n \".\": {\n \"import\": {\n \"types\": \"./dist/index.d.ts\",\n \"default\": \"./dist/index.js\"\n },\n \"require\": {\n \"types\": \"./dist/index.d.ts\",\n \"default\": \"./dist/cjs/index.js\"\n }\n },\n \"./extension\": {\n \"import\": {\n \"types\": \"./dist/extension.d.ts\",\n \"default\": \"./dist/extension.js\"\n },\n \"require\": {\n \"types\": \"./dist/extension.d.ts\",\n \"default\": \"./dist/cjs/extension.js\"\n }\n }\n },\n \"type\": \"module\",\n \"scripts\": {\n \"clean\": \"rimraf --glob dist *.tgz\",\n \"build\": \"tsx esbuild-copilotsdk-nodejs.ts\",\n \"test\": \"vitest run\",\n \"test:watch\": \"vitest\",\n \"format\": \"prettier --write \\\"src/**/*.ts\\\" \\\"test/**/*.ts\\\" --ignore-path .prettierignore\",\n \"format:check\": \"prettier --check \\\"src/**/*.ts\\\" \\\"test/**/*.ts\\\" --ignore-path .prettierignore\",\n \"lint\": \"eslint \\\"src/**/*.ts\\\" \\\"test/**/*.ts\\\"\",\n \"lint:fix\": \"eslint --fix \\\"src/**/*.ts\\\" \\\"test/**/*.ts\\\"\",\n \"typecheck\": \"tsc --noEmit\",\n \"generate\": \"cd ../scripts/codegen && npm run generate\",\n \"update:protocol-version\": \"tsx scripts/update-protocol-version.ts\",\n \"prepublishOnly\": \"npm run build\",\n \"package\": \"npm run clean && npm run build && node scripts/set-version.js && npm pack && npm version 0.1.0 --no-git-tag-version --allow-same-version\"\n },\n \"keywords\": [\n \"github\",\n \"copilot\",\n \"sdk\",\n \"jsonrpc\",\n \"agent\"\n ],\n \"author\": \"GitHub\",\n \"license\": \"MIT\",\n \"dependencies\": {\n \"@github/copilot\": \"^1.0.40\",\n \"vscode-jsonrpc\": \"^8.2.1\",\n \"zod\": \"^4.3.6\"\n },\n \"devDependencies\": {\n \"@platformatic/vfs\": \"^0.3.0\",\n \"@types/node\": \"^25.2.0\",\n \"@typescript-eslint/eslint-plugin\": \"^8.54.0\",\n \"@typescript-eslint/parser\": \"^8.54.0\",\n \"esbuild\": \"^0.27.2\",\n \"eslint\": \"^9.0.0\",\n \"glob\": \"^13.0.1\",\n \"json-schema\": \"^0.4.0\",\n \"json-schema-to-typescript\": \"^15.0.4\",\n \"prettier\": \"^3.8.1\",\n \"quicktype-core\": \"^23.2.6\",\n \"rimraf\": \"^6.1.2\",\n \"semver\": \"^7.7.3\",\n \"tsx\": \"^4.20.6\",\n \"typescript\": \"^5.0.0\",\n \"vitest\": \"^4.0.18\"\n },\n \"engines\": {\n \"node\": \">=20.0.0\"\n },\n \"files\": [\n \"dist/**/*\",\n \"docs/**/*\",\n \"README.md\"\n ]\n}\n" }, { "path": "nodejs/samples/chat.ts", "content": "import { CopilotClient, approveAll, type SessionEvent } from \"@github/copilot-sdk\";\nimport * as readline from \"node:readline\";\n\nasync function main() {\n const client = new CopilotClient();\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n });\n\n session.on((event: SessionEvent) => {\n let output: string | null = null;\n if (event.type === \"assistant.reasoning\") {\n output = `[reasoning: ${event.data.content}]`;\n } else if (event.type === \"tool.execution_start\") {\n output = `[tool: ${event.data.toolName}]`;\n }\n if (output) console.log(`\\x1b[34m${output}\\x1b[0m`);\n });\n\n const rl = readline.createInterface({ input: process.stdin, output: process.stdout });\n const prompt = (q: string) => new Promise((r) => rl.question(q, r));\n\n console.log(\"Chat with Copilot (Ctrl+C to exit)\\n\");\n\n while (true) {\n const input = await prompt(\"You: \");\n if (!input.trim()) continue;\n console.log();\n\n const reply = await session.sendAndWait({ prompt: input });\n console.log(`\\nAssistant: ${reply?.data.content}\\n`);\n }\n}\n\nmain().catch(console.error);\n" }, { "path": "nodejs/samples/package.json", "content": "{\n \"name\": \"copilot-sdk-sample\",\n \"type\": \"module\",\n \"scripts\": {\n \"start\": \"npx tsx chat.ts\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:..\"\n },\n \"devDependencies\": {\n \"tsx\": \"^4.20.6\",\n \"@types/node\": \"^22.0.0\"\n }\n}\n" }, { "path": "nodejs/scripts/get-version.js", "content": "#!/usr/bin/env node\n/**\n * Outputs the next or current version of the SDK package based on the latest\n * published version and provided version increment type.\n *\n * Usage:\n *\n * node scripts/get-version.js [current|current-prerelease|latest|prerelease|unstable]\n *\n * Outputs the version to stdout.\n */\nimport { execSync } from \"child_process\";\nimport * as semver from \"semver\";\n\nasync function getLatestVersion(tag) {\n try {\n const result = execSync(\n `npm view @github/copilot-sdk@${tag} version --registry=https://registry.npmjs.org`,\n { encoding: \"utf-8\", stdio: [\"pipe\", \"pipe\", \"pipe\"] }\n );\n const version = result.trim();\n if (!semver.valid(version)) {\n console.error(`Invalid version returned from npm for tag \"${tag}\": \"${version}\"`);\n process.exit(1);\n }\n return version;\n } catch {\n // Tag doesn't exist yet\n return null;\n }\n}\n\nasync function main() {\n const command = process.argv[2];\n const validCommands = [\"current\", \"current-prerelease\", \"latest\", \"prerelease\", \"unstable\"];\n if (!validCommands.includes(command)) {\n console.error(\n `Invalid argument, must be one of: ${validCommands.join(\", \")}, got: \"${command}\"`\n );\n process.exit(1);\n }\n\n const latest = await getLatestVersion(\"latest\");\n if (!latest) {\n console.error(\"No latest version found. Publish an initial version first.\");\n process.exit(1);\n }\n\n // Output the current latest version to stdout\n if (command === \"current\") {\n console.log(latest);\n return;\n }\n\n const prerelease = await getLatestVersion(\"prerelease\");\n\n // Use latest if no prerelease exists, or compare to find higher\n let higherVersion;\n if (!prerelease) {\n higherVersion = latest;\n } else {\n try {\n higherVersion = semver.gt(latest, prerelease) ? latest : prerelease;\n } catch (err) {\n console.error(\n `Failed to compare versions \"${latest}\" and \"${prerelease}\": ${err.message}`\n );\n process.exit(1);\n }\n }\n\n // Output the most recent version including prerelease versions to stdout\n if (command === \"current-prerelease\") {\n console.log(higherVersion);\n return;\n }\n\n if (command === \"unstable\") {\n const unstable = await getLatestVersion(\"unstable\");\n if (unstable && semver.gt(unstable, higherVersion)) {\n higherVersion = unstable;\n }\n }\n\n const increment = command === \"latest\" ? \"patch\" : \"prerelease\";\n const prereleaseIdentifier =\n command === \"prerelease\" ? \"preview\" : command === \"unstable\" ? \"unstable\" : undefined;\n const nextVersion = semver.inc(higherVersion, increment, prereleaseIdentifier);\n if (!nextVersion) {\n console.error(`Failed to increment version \"${higherVersion}\" with \"${increment}\"`);\n process.exit(1);\n }\n\n // Output the next version to stdout\n console.log(nextVersion);\n}\n\nvoid main();\n" }, { "path": "nodejs/scripts/set-version.js", "content": "#!/usr/bin/env node\nimport { readFileSync, writeFileSync } from \"fs\";\nimport { dirname, join } from \"path\";\nimport { fileURLToPath } from \"url\";\n\nconst version = process.env.VERSION || \"0.1.0-dev\";\nconst packageJsonPath = join(dirname(fileURLToPath(import.meta.url)), \"..\", \"package.json\");\n\nconst packageJson = JSON.parse(readFileSync(packageJsonPath, \"utf8\"));\npackageJson.version = version;\nwriteFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2) + \"\\n\");\n" }, { "path": "nodejs/scripts/update-protocol-version.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\n/**\n * Generates SDK protocol version constants for all SDK languages.\n *\n * Reads from sdk-protocol-version.json and generates:\n * - nodejs/src/sdkProtocolVersion.ts\n * - go/sdk_protocol_version.go\n * - python/copilot/_sdk_protocol_version.py\n * - dotnet/src/SdkProtocolVersion.cs\n *\n * Run this script whenever the protocol version changes.\n */\n\nimport fs from \"node:fs\";\nimport path from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\nimport versionFile from \"../../sdk-protocol-version.json\" with { type: \"json\" };\n\nconst __filename = fileURLToPath(import.meta.url);\nconst __dirname = path.dirname(__filename);\nconst rootDir = path.join(__dirname, \"..\", \"..\");\n\nconst version = versionFile.version;\n\nconsole.log(`Generating SDK protocol version constants for version ${version}...`);\n\n// Generate TypeScript\nconst tsCode = `/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\n// Code generated by update-protocol-version.ts. DO NOT EDIT.\n\n/**\n * The SDK protocol version.\n * This must match the version expected by the copilot-agent-runtime server.\n */\nexport const SDK_PROTOCOL_VERSION = ${version};\n\n/**\n * Gets the SDK protocol version.\n * @returns The protocol version number\n */\nexport function getSdkProtocolVersion(): number {\n return SDK_PROTOCOL_VERSION;\n}\n`;\nfs.writeFileSync(path.join(rootDir, \"nodejs\", \"src\", \"sdkProtocolVersion.ts\"), tsCode);\nconsole.log(\" ✓ nodejs/src/sdkProtocolVersion.ts\");\n\n// Generate Go\nconst goCode = `// Code generated by update-protocol-version.ts. DO NOT EDIT.\n\npackage copilot\n\n// SdkProtocolVersion is the SDK protocol version.\n// This must match the version expected by the copilot-agent-runtime server.\nconst SdkProtocolVersion = ${version}\n\n// GetSdkProtocolVersion returns the SDK protocol version.\nfunc GetSdkProtocolVersion() int {\n\treturn SdkProtocolVersion\n}\n`;\nfs.writeFileSync(path.join(rootDir, \"go\", \"sdk_protocol_version.go\"), goCode);\nconsole.log(\" ✓ go/sdk_protocol_version.go\");\n\n// Generate Python\nconst pythonCode = `# Code generated by update-protocol-version.ts. DO NOT EDIT.\n\n\"\"\"\nSDK Protocol Version for the Copilot SDK.\n\nThis must match the version expected by the copilot-agent-runtime server.\n\"\"\"\n\nSDK_PROTOCOL_VERSION = ${version}\n\n\ndef get_sdk_protocol_version() -> int:\n \"\"\"\n Gets the SDK protocol version.\n\n Returns:\n The protocol version number\n \"\"\"\n return SDK_PROTOCOL_VERSION\n`;\nfs.writeFileSync(path.join(rootDir, \"python\", \"copilot\", \"_sdk_protocol_version.py\"), pythonCode);\nconsole.log(\" ✓ python/copilot/_sdk_protocol_version.py\");\n\n// Generate C#\nconst csharpCode = `// Code generated by update-protocol-version.ts. DO NOT EDIT.\n\nnamespace GitHub.Copilot.SDK;\n\n/// \n/// Provides the SDK protocol version.\n/// This must match the version expected by the copilot-agent-runtime server.\n/// \ninternal static class SdkProtocolVersion\n{\n /// \n /// The SDK protocol version.\n /// \n private const int Version = ${version};\n\n /// \n /// Gets the SDK protocol version.\n /// \n public static int GetVersion() => Version;\n}\n`;\nfs.writeFileSync(path.join(rootDir, \"dotnet\", \"src\", \"SdkProtocolVersion.cs\"), csharpCode);\nconsole.log(\" ✓ dotnet/src/SdkProtocolVersion.cs\");\n\nconsole.log(\"Done!\");\n" }, { "path": "nodejs/src/client.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\n/**\n * Copilot CLI SDK Client - Main entry point for the Copilot SDK.\n *\n * This module provides the {@link CopilotClient} class, which manages the connection\n * to the Copilot CLI server and provides session management capabilities.\n *\n * @module client\n */\n\nimport { spawn, type ChildProcess } from \"node:child_process\";\nimport { randomUUID } from \"node:crypto\";\nimport { existsSync } from \"node:fs\";\nimport { createRequire } from \"node:module\";\nimport { Socket } from \"node:net\";\nimport { dirname, join } from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\nimport {\n createMessageConnection,\n MessageConnection,\n StreamMessageReader,\n StreamMessageWriter,\n} from \"vscode-jsonrpc/node.js\";\nimport { createServerRpc, registerClientSessionApiHandlers } from \"./generated/rpc.js\";\nimport { getSdkProtocolVersion } from \"./sdkProtocolVersion.js\";\nimport { CopilotSession, NO_RESULT_PERMISSION_V2_ERROR } from \"./session.js\";\nimport { createSessionFsAdapter } from \"./sessionFsProvider.js\";\nimport { getTraceContext } from \"./telemetry.js\";\nimport type {\n ConnectionState,\n CopilotClientOptions,\n ForegroundSessionInfo,\n GetAuthStatusResponse,\n GetStatusResponse,\n ModelInfo,\n ResumeSessionConfig,\n SectionTransformFn,\n SessionConfig,\n SessionContext,\n SessionEvent,\n SessionFsConfig,\n SessionLifecycleEvent,\n SessionLifecycleEventType,\n SessionLifecycleHandler,\n SessionListFilter,\n SessionMetadata,\n SystemMessageCustomizeConfig,\n TelemetryConfig,\n Tool,\n ToolCallRequestPayload,\n ToolCallResponsePayload,\n ToolResultObject,\n TraceContextProvider,\n TypedSessionLifecycleHandler,\n} from \"./types.js\";\nimport { defaultJoinSessionPermissionHandler } from \"./types.js\";\n\n/**\n * Minimum protocol version this SDK can communicate with.\n * Servers reporting a version below this are rejected.\n */\nconst MIN_PROTOCOL_VERSION = 2;\n\n/**\n * Check if value is a Zod schema (has toJSONSchema method)\n */\nfunction isZodSchema(value: unknown): value is { toJSONSchema(): Record } {\n return (\n value != null &&\n typeof value === \"object\" &&\n \"toJSONSchema\" in value &&\n typeof (value as { toJSONSchema: unknown }).toJSONSchema === \"function\"\n );\n}\n\n/**\n * Convert tool parameters to JSON schema format for sending to CLI\n */\nfunction toJsonSchema(parameters: Tool[\"parameters\"]): Record | undefined {\n if (!parameters) return undefined;\n if (isZodSchema(parameters)) {\n return parameters.toJSONSchema();\n }\n return parameters;\n}\n\n/**\n * Extract transform callbacks from a system message config and prepare the wire payload.\n * Function-valued actions are replaced with `{ action: \"transform\" }` for serialization,\n * and the original callbacks are returned in a separate map.\n */\nfunction extractTransformCallbacks(systemMessage: SessionConfig[\"systemMessage\"]): {\n wirePayload: SessionConfig[\"systemMessage\"];\n transformCallbacks: Map | undefined;\n} {\n if (!systemMessage || systemMessage.mode !== \"customize\" || !systemMessage.sections) {\n return { wirePayload: systemMessage, transformCallbacks: undefined };\n }\n\n const transformCallbacks = new Map();\n const wireSections: Record = {};\n\n for (const [sectionId, override] of Object.entries(systemMessage.sections)) {\n if (!override) continue;\n\n if (typeof override.action === \"function\") {\n transformCallbacks.set(sectionId, override.action);\n wireSections[sectionId] = { action: \"transform\" };\n } else {\n wireSections[sectionId] = { action: override.action, content: override.content };\n }\n }\n\n if (transformCallbacks.size === 0) {\n return { wirePayload: systemMessage, transformCallbacks: undefined };\n }\n\n const wirePayload: SystemMessageCustomizeConfig = {\n ...systemMessage,\n sections: wireSections as SystemMessageCustomizeConfig[\"sections\"],\n };\n\n return { wirePayload, transformCallbacks };\n}\n\nfunction getNodeExecPath(): string {\n if (process.versions.bun) {\n return \"node\";\n }\n return process.execPath;\n}\n\n/**\n * Gets the path to the bundled CLI from the @github/copilot package.\n * Uses index.js directly rather than npm-loader.js (which spawns the native binary).\n *\n * In ESM, uses import.meta.resolve directly. In CJS (e.g., VS Code extensions\n * bundled with esbuild format:\"cjs\"), import.meta is empty so we fall back to\n * walking node_modules to find the package.\n */\nfunction getBundledCliPath(): string {\n if (typeof import.meta.resolve === \"function\") {\n // ESM: resolve via import.meta.resolve\n const sdkUrl = import.meta.resolve(\"@github/copilot/sdk\");\n const sdkPath = fileURLToPath(sdkUrl);\n // sdkPath is like .../node_modules/@github/copilot/sdk/index.js\n // Go up two levels to get the package root, then append index.js\n return join(dirname(dirname(sdkPath)), \"index.js\");\n }\n\n // CJS fallback: the @github/copilot package has ESM-only exports so\n // require.resolve cannot reach it. Walk the module search paths instead.\n const req = createRequire(__filename);\n const searchPaths = req.resolve.paths(\"@github/copilot\") ?? [];\n for (const base of searchPaths) {\n const candidate = join(base, \"@github\", \"copilot\", \"index.js\");\n if (existsSync(candidate)) {\n return candidate;\n }\n }\n throw new Error(\n `Could not find @github/copilot package. Searched ${searchPaths.length} paths. ` +\n `Ensure it is installed, or pass cliPath/cliUrl to CopilotClient.`\n );\n}\n\n/**\n * Main client for interacting with the Copilot CLI.\n *\n * The CopilotClient manages the connection to the Copilot CLI server and provides\n * methods to create and manage conversation sessions. It can either spawn a CLI\n * server process or connect to an existing server.\n *\n * @example\n * ```typescript\n * import { CopilotClient } from \"@github/copilot-sdk\";\n *\n * // Create a client with default options (spawns CLI server)\n * const client = new CopilotClient();\n *\n * // Or connect to an existing server\n * const client = new CopilotClient({ cliUrl: \"localhost:3000\" });\n *\n * // Create a session\n * const session = await client.createSession({ onPermissionRequest: approveAll, model: \"gpt-4\" });\n *\n * // Send messages and handle responses\n * session.on((event) => {\n * if (event.type === \"assistant.message\") {\n * console.log(event.data.content);\n * }\n * });\n * await session.send({ prompt: \"Hello!\" });\n *\n * // Clean up\n * await session.disconnect();\n * await client.stop();\n * ```\n */\nexport class CopilotClient {\n private cliStartTimeout: ReturnType | null = null;\n private cliProcess: ChildProcess | null = null;\n private connection: MessageConnection | null = null;\n private socket: Socket | null = null;\n private actualPort: number | null = null;\n private actualHost: string = \"localhost\";\n private state: ConnectionState = \"disconnected\";\n private sessions: Map = new Map();\n private stderrBuffer: string = \"\"; // Captures CLI stderr for error messages\n private options: Required<\n Omit<\n CopilotClientOptions,\n | \"cliPath\"\n | \"cliUrl\"\n | \"gitHubToken\"\n | \"useLoggedInUser\"\n | \"onListModels\"\n | \"telemetry\"\n | \"onGetTraceContext\"\n | \"sessionFs\"\n >\n > & {\n cliPath?: string;\n cliUrl?: string;\n gitHubToken?: string;\n useLoggedInUser?: boolean;\n telemetry?: TelemetryConfig;\n };\n private isExternalServer: boolean = false;\n private forceStopping: boolean = false;\n private onListModels?: () => Promise | ModelInfo[];\n private onGetTraceContext?: TraceContextProvider;\n private modelsCache: ModelInfo[] | null = null;\n private modelsCacheLock: Promise = Promise.resolve();\n private sessionLifecycleHandlers: Set = new Set();\n private typedLifecycleHandlers: Map<\n SessionLifecycleEventType,\n Set<(event: SessionLifecycleEvent) => void>\n > = new Map();\n private _rpc: ReturnType | null = null;\n private processExitPromise: Promise | null = null; // Rejects when CLI process exits\n private negotiatedProtocolVersion: number | null = null;\n /** Connection-level session filesystem config, set via constructor option. */\n private sessionFsConfig: SessionFsConfig | null = null;\n\n /**\n * Typed server-scoped RPC methods.\n * @throws Error if the client is not connected\n */\n get rpc(): ReturnType {\n if (!this.connection) {\n throw new Error(\"Client is not connected. Call start() first.\");\n }\n if (!this._rpc) {\n this._rpc = createServerRpc(this.connection);\n }\n return this._rpc;\n }\n\n /**\n * Creates a new CopilotClient instance.\n *\n * @param options - Configuration options for the client\n * @throws Error if mutually exclusive options are provided (e.g., cliUrl with useStdio or cliPath)\n *\n * @example\n * ```typescript\n * // Default options - spawns CLI server using stdio\n * const client = new CopilotClient();\n *\n * // Connect to an existing server\n * const client = new CopilotClient({ cliUrl: \"localhost:3000\" });\n *\n * // Custom CLI path with specific log level\n * const client = new CopilotClient({\n * cliPath: \"/usr/local/bin/copilot\",\n * logLevel: \"debug\"\n * });\n * ```\n */\n constructor(options: CopilotClientOptions = {}) {\n // Validate mutually exclusive options\n if (options.cliUrl && (options.useStdio === true || options.cliPath)) {\n throw new Error(\"cliUrl is mutually exclusive with useStdio and cliPath\");\n }\n\n if (options.isChildProcess && (options.cliUrl || options.useStdio === false)) {\n throw new Error(\n \"isChildProcess must be used in conjunction with useStdio and not with cliUrl\"\n );\n }\n\n // Validate auth options with external server\n if (options.cliUrl && (options.gitHubToken || options.useLoggedInUser !== undefined)) {\n throw new Error(\n \"gitHubToken and useLoggedInUser cannot be used with cliUrl (external server manages its own auth)\"\n );\n }\n\n if (options.sessionFs) {\n this.validateSessionFsConfig(options.sessionFs);\n }\n\n // Parse cliUrl if provided\n if (options.cliUrl) {\n const { host, port } = this.parseCliUrl(options.cliUrl);\n this.actualHost = host;\n this.actualPort = port;\n this.isExternalServer = true;\n }\n\n if (options.isChildProcess) {\n this.isExternalServer = true;\n }\n\n this.onListModels = options.onListModels;\n this.onGetTraceContext = options.onGetTraceContext;\n this.sessionFsConfig = options.sessionFs ?? null;\n\n const effectiveEnv = options.env ?? process.env;\n this.options = {\n cliPath: options.cliUrl\n ? undefined\n : options.cliPath || effectiveEnv.COPILOT_CLI_PATH || getBundledCliPath(),\n cliArgs: options.cliArgs ?? [],\n cwd: options.cwd ?? process.cwd(),\n port: options.port || 0,\n useStdio: options.cliUrl ? false : (options.useStdio ?? true), // Default to stdio unless cliUrl is provided\n isChildProcess: options.isChildProcess ?? false,\n cliUrl: options.cliUrl,\n logLevel: options.logLevel || \"debug\",\n autoStart: options.autoStart ?? true,\n autoRestart: false,\n\n env: effectiveEnv,\n gitHubToken: options.gitHubToken,\n // Default useLoggedInUser to false when gitHubToken is provided, otherwise true\n useLoggedInUser: options.useLoggedInUser ?? (options.gitHubToken ? false : true),\n telemetry: options.telemetry,\n sessionIdleTimeoutSeconds: options.sessionIdleTimeoutSeconds ?? 0,\n };\n }\n\n /**\n * Parse CLI URL into host and port\n * Supports formats: \"host:port\", \"http://host:port\", \"https://host:port\", or just \"port\"\n */\n private parseCliUrl(url: string): { host: string; port: number } {\n // Remove protocol if present\n let cleanUrl = url.replace(/^https?:\\/\\//, \"\");\n\n // Check if it's just a port number\n if (/^\\d+$/.test(cleanUrl)) {\n return { host: \"localhost\", port: parseInt(cleanUrl, 10) };\n }\n\n // Parse host:port format\n const parts = cleanUrl.split(\":\");\n if (parts.length !== 2) {\n throw new Error(\n `Invalid cliUrl format: ${url}. Expected \"host:port\", \"http://host:port\", or \"port\"`\n );\n }\n\n const host = parts[0] || \"localhost\";\n const port = parseInt(parts[1], 10);\n\n if (isNaN(port) || port <= 0 || port > 65535) {\n throw new Error(`Invalid port in cliUrl: ${url}`);\n }\n\n return { host, port };\n }\n\n private validateSessionFsConfig(config: SessionFsConfig): void {\n if (!config.initialCwd) {\n throw new Error(\"sessionFs.initialCwd is required\");\n }\n\n if (!config.sessionStatePath) {\n throw new Error(\"sessionFs.sessionStatePath is required\");\n }\n\n if (config.conventions !== \"windows\" && config.conventions !== \"posix\") {\n throw new Error(\"sessionFs.conventions must be either 'windows' or 'posix'\");\n }\n }\n\n /**\n * Starts the CLI server and establishes a connection.\n *\n * If connecting to an external server (via cliUrl), only establishes the connection.\n * Otherwise, spawns the CLI server process and then connects.\n *\n * This method is called automatically when creating a session if `autoStart` is true (default).\n *\n * @returns A promise that resolves when the connection is established\n * @throws Error if the server fails to start or the connection fails\n *\n * @example\n * ```typescript\n * const client = new CopilotClient({ autoStart: false });\n * await client.start();\n * // Now ready to create sessions\n * ```\n */\n async start(): Promise {\n if (this.state === \"connected\") {\n return;\n }\n\n this.state = \"connecting\";\n\n try {\n // Only start CLI server process if not connecting to external server\n if (!this.isExternalServer) {\n await this.startCLIServer();\n }\n\n // Connect to the server\n await this.connectToServer();\n\n // Verify protocol version compatibility\n await this.verifyProtocolVersion();\n\n // If a session filesystem provider was configured, register it\n if (this.sessionFsConfig) {\n await this.connection!.sendRequest(\"sessionFs.setProvider\", {\n initialCwd: this.sessionFsConfig.initialCwd,\n sessionStatePath: this.sessionFsConfig.sessionStatePath,\n conventions: this.sessionFsConfig.conventions,\n });\n }\n\n this.state = \"connected\";\n } catch (error) {\n this.state = \"error\";\n throw error;\n }\n }\n\n /**\n * Stops the CLI server and closes all active sessions.\n *\n * This method performs graceful cleanup:\n * 1. Closes all active sessions (releases in-memory resources)\n * 2. Closes the JSON-RPC connection\n * 3. Terminates the CLI server process (if spawned by this client)\n *\n * Note: session data on disk is preserved, so sessions can be resumed later.\n * To permanently remove session data before stopping, call\n * {@link deleteSession} for each session first.\n *\n * @returns A promise that resolves with an array of errors encountered during cleanup.\n * An empty array indicates all cleanup succeeded.\n *\n * @example\n * ```typescript\n * const errors = await client.stop();\n * if (errors.length > 0) {\n * console.error(\"Cleanup errors:\", errors);\n * }\n * ```\n */\n async stop(): Promise {\n const errors: Error[] = [];\n\n // Disconnect all active sessions with retry logic\n for (const session of this.sessions.values()) {\n const sessionId = session.sessionId;\n let lastError: Error | null = null;\n\n // Try up to 3 times with exponential backoff\n for (let attempt = 1; attempt <= 3; attempt++) {\n try {\n await session.disconnect();\n lastError = null;\n break; // Success\n } catch (error) {\n lastError = error instanceof Error ? error : new Error(String(error));\n\n if (attempt < 3) {\n // Exponential backoff: 100ms, 200ms\n const delay = 100 * Math.pow(2, attempt - 1);\n await new Promise((resolve) => setTimeout(resolve, delay));\n }\n }\n }\n\n if (lastError) {\n errors.push(\n new Error(\n `Failed to disconnect session ${sessionId} after 3 attempts: ${lastError.message}`\n )\n );\n }\n }\n this.sessions.clear();\n\n // Close connection\n if (this.connection) {\n try {\n this.connection.dispose();\n } catch (error) {\n errors.push(\n new Error(\n `Failed to dispose connection: ${error instanceof Error ? error.message : String(error)}`\n )\n );\n }\n this.connection = null;\n this._rpc = null;\n }\n\n // Clear models cache\n this.modelsCache = null;\n\n if (this.socket) {\n try {\n this.socket.end();\n } catch (error) {\n errors.push(\n new Error(\n `Failed to close socket: ${error instanceof Error ? error.message : String(error)}`\n )\n );\n }\n this.socket = null;\n }\n\n // Kill CLI process (only if we spawned it)\n if (this.cliProcess && !this.isExternalServer) {\n try {\n this.cliProcess.kill();\n } catch (error) {\n errors.push(\n new Error(\n `Failed to kill CLI process: ${error instanceof Error ? error.message : String(error)}`\n )\n );\n }\n this.cliProcess = null;\n }\n if (this.cliStartTimeout) {\n clearTimeout(this.cliStartTimeout);\n this.cliStartTimeout = null;\n }\n\n this.state = \"disconnected\";\n this.actualPort = null;\n this.stderrBuffer = \"\";\n this.processExitPromise = null;\n\n return errors;\n }\n\n /**\n * Forcefully stops the CLI server without graceful cleanup.\n *\n * Use this when {@link stop} fails or takes too long. This method:\n * - Clears all sessions immediately without destroying them\n * - Force closes the connection\n * - Sends SIGKILL to the CLI process (if spawned by this client)\n *\n * @returns A promise that resolves when the force stop is complete\n *\n * @example\n * ```typescript\n * // If normal stop hangs, force stop\n * const stopPromise = client.stop();\n * const timeout = new Promise((_, reject) =>\n * setTimeout(() => reject(new Error(\"Timeout\")), 5000)\n * );\n *\n * try {\n * await Promise.race([stopPromise, timeout]);\n * } catch {\n * await client.forceStop();\n * }\n * ```\n */\n async forceStop(): Promise {\n this.forceStopping = true;\n\n // Clear sessions immediately without trying to destroy them\n this.sessions.clear();\n\n // Force close connection\n if (this.connection) {\n try {\n this.connection.dispose();\n } catch {\n // Ignore errors during force stop\n }\n this.connection = null;\n this._rpc = null;\n }\n\n // Clear models cache\n this.modelsCache = null;\n\n if (this.socket) {\n try {\n this.socket.destroy(); // destroy() is more forceful than end()\n } catch {\n // Ignore errors\n }\n this.socket = null;\n }\n\n // Force kill CLI process (only if we spawned it)\n if (this.cliProcess && !this.isExternalServer) {\n try {\n this.cliProcess.kill(\"SIGKILL\");\n } catch {\n // Ignore errors\n }\n this.cliProcess = null;\n }\n\n if (this.cliStartTimeout) {\n clearTimeout(this.cliStartTimeout);\n this.cliStartTimeout = null;\n }\n\n this.state = \"disconnected\";\n this.actualPort = null;\n this.stderrBuffer = \"\";\n this.processExitPromise = null;\n }\n\n /**\n * Creates a new conversation session with the Copilot CLI.\n *\n * Sessions maintain conversation state, handle events, and manage tool execution.\n * If the client is not connected and `autoStart` is enabled, this will automatically\n * start the connection.\n *\n * @param config - Optional configuration for the session\n * @returns A promise that resolves with the created session\n * @throws Error if the client is not connected and autoStart is disabled\n *\n * @example\n * ```typescript\n * // Basic session\n * const session = await client.createSession({ onPermissionRequest: approveAll });\n *\n * // Session with model and tools\n * const session = await client.createSession({\n * onPermissionRequest: approveAll,\n * model: \"gpt-4\",\n * tools: [{\n * name: \"get_weather\",\n * description: \"Get weather for a location\",\n * parameters: { type: \"object\", properties: { location: { type: \"string\" } } },\n * handler: async (args) => ({ temperature: 72 })\n * }]\n * });\n * ```\n */\n async createSession(config: SessionConfig): Promise {\n if (!config?.onPermissionRequest) {\n throw new Error(\n \"An onPermissionRequest handler is required when creating a session. For example, to allow all permissions, use { onPermissionRequest: approveAll }.\"\n );\n }\n\n if (!this.connection) {\n if (this.options.autoStart) {\n await this.start();\n } else {\n throw new Error(\"Client not connected. Call start() first.\");\n }\n }\n\n const sessionId = config.sessionId ?? randomUUID();\n\n // Create and register the session before issuing the RPC so that\n // events emitted by the CLI (e.g. session.start) are not dropped.\n const session = new CopilotSession(\n sessionId,\n this.connection!,\n undefined,\n this.onGetTraceContext\n );\n session.registerTools(config.tools);\n session.registerCommands(config.commands);\n session.registerPermissionHandler(config.onPermissionRequest);\n if (config.onUserInputRequest) {\n session.registerUserInputHandler(config.onUserInputRequest);\n }\n if (config.onElicitationRequest) {\n session.registerElicitationHandler(config.onElicitationRequest);\n }\n if (config.hooks) {\n session.registerHooks(config.hooks);\n }\n\n // Extract transform callbacks from system message config before serialization.\n const { wirePayload: wireSystemMessage, transformCallbacks } = extractTransformCallbacks(\n config.systemMessage\n );\n if (transformCallbacks) {\n session.registerTransformCallbacks(transformCallbacks);\n }\n\n if (config.onEvent) {\n session.on(config.onEvent);\n }\n this.sessions.set(sessionId, session);\n if (this.sessionFsConfig) {\n if (config.createSessionFsHandler) {\n session.clientSessionApis.sessionFs = createSessionFsAdapter(\n config.createSessionFsHandler(session)\n );\n } else {\n throw new Error(\n \"createSessionFsHandler is required in session config when sessionFs is enabled in client options.\"\n );\n }\n }\n\n try {\n const response = await this.connection!.sendRequest(\"session.create\", {\n ...(await getTraceContext(this.onGetTraceContext)),\n model: config.model,\n sessionId,\n clientName: config.clientName,\n reasoningEffort: config.reasoningEffort,\n tools: config.tools?.map((tool) => ({\n name: tool.name,\n description: tool.description,\n parameters: toJsonSchema(tool.parameters),\n overridesBuiltInTool: tool.overridesBuiltInTool,\n skipPermission: tool.skipPermission,\n })),\n commands: config.commands?.map((cmd) => ({\n name: cmd.name,\n description: cmd.description,\n })),\n systemMessage: wireSystemMessage,\n availableTools: config.availableTools,\n excludedTools: config.excludedTools,\n provider: config.provider,\n modelCapabilities: config.modelCapabilities,\n requestPermission: true,\n requestUserInput: !!config.onUserInputRequest,\n requestElicitation: !!config.onElicitationRequest,\n hooks: !!(config.hooks && Object.values(config.hooks).some(Boolean)),\n workingDirectory: config.workingDirectory,\n streaming: config.streaming,\n includeSubAgentStreamingEvents: config.includeSubAgentStreamingEvents ?? true,\n mcpServers: config.mcpServers,\n envValueMode: \"direct\",\n customAgents: config.customAgents,\n defaultAgent: config.defaultAgent,\n agent: config.agent,\n configDir: config.configDir,\n enableConfigDiscovery: config.enableConfigDiscovery,\n skillDirectories: config.skillDirectories,\n disabledSkills: config.disabledSkills,\n infiniteSessions: config.infiniteSessions,\n gitHubToken: config.gitHubToken,\n });\n\n const { workspacePath, capabilities } = response as {\n sessionId: string;\n workspacePath?: string;\n capabilities?: { ui?: { elicitation?: boolean } };\n };\n session[\"_workspacePath\"] = workspacePath;\n session.setCapabilities(capabilities);\n } catch (e) {\n this.sessions.delete(sessionId);\n throw e;\n }\n\n return session;\n }\n\n /**\n * Resumes an existing conversation session by its ID.\n *\n * This allows you to continue a previous conversation, maintaining all\n * conversation history. The session must have been previously created\n * and not deleted.\n *\n * @param sessionId - The ID of the session to resume\n * @param config - Optional configuration for the resumed session\n * @returns A promise that resolves with the resumed session\n * @throws Error if the session does not exist or the client is not connected\n *\n * @example\n * ```typescript\n * // Resume a previous session\n * const session = await client.resumeSession(\"session-123\", { onPermissionRequest: approveAll });\n *\n * // Resume with new tools\n * const session = await client.resumeSession(\"session-123\", {\n * onPermissionRequest: approveAll,\n * tools: [myNewTool]\n * });\n * ```\n */\n async resumeSession(sessionId: string, config: ResumeSessionConfig): Promise {\n if (!config?.onPermissionRequest) {\n throw new Error(\n \"An onPermissionRequest handler is required when resuming a session. For example, to allow all permissions, use { onPermissionRequest: approveAll }.\"\n );\n }\n\n if (!this.connection) {\n if (this.options.autoStart) {\n await this.start();\n } else {\n throw new Error(\"Client not connected. Call start() first.\");\n }\n }\n\n // Create and register the session before issuing the RPC so that\n // events emitted by the CLI (e.g. session.start) are not dropped.\n const session = new CopilotSession(\n sessionId,\n this.connection!,\n undefined,\n this.onGetTraceContext\n );\n session.registerTools(config.tools);\n session.registerCommands(config.commands);\n session.registerPermissionHandler(config.onPermissionRequest);\n if (config.onUserInputRequest) {\n session.registerUserInputHandler(config.onUserInputRequest);\n }\n if (config.onElicitationRequest) {\n session.registerElicitationHandler(config.onElicitationRequest);\n }\n if (config.hooks) {\n session.registerHooks(config.hooks);\n }\n\n // Extract transform callbacks from system message config before serialization.\n const { wirePayload: wireSystemMessage, transformCallbacks } = extractTransformCallbacks(\n config.systemMessage\n );\n if (transformCallbacks) {\n session.registerTransformCallbacks(transformCallbacks);\n }\n\n if (config.onEvent) {\n session.on(config.onEvent);\n }\n this.sessions.set(sessionId, session);\n if (this.sessionFsConfig) {\n if (config.createSessionFsHandler) {\n session.clientSessionApis.sessionFs = createSessionFsAdapter(\n config.createSessionFsHandler(session)\n );\n } else {\n throw new Error(\n \"createSessionFsHandler is required in session config when sessionFs is enabled in client options.\"\n );\n }\n }\n\n try {\n const response = await this.connection!.sendRequest(\"session.resume\", {\n ...(await getTraceContext(this.onGetTraceContext)),\n sessionId,\n clientName: config.clientName,\n model: config.model,\n reasoningEffort: config.reasoningEffort,\n systemMessage: wireSystemMessage,\n availableTools: config.availableTools,\n excludedTools: config.excludedTools,\n tools: config.tools?.map((tool) => ({\n name: tool.name,\n description: tool.description,\n parameters: toJsonSchema(tool.parameters),\n overridesBuiltInTool: tool.overridesBuiltInTool,\n skipPermission: tool.skipPermission,\n })),\n commands: config.commands?.map((cmd) => ({\n name: cmd.name,\n description: cmd.description,\n })),\n provider: config.provider,\n modelCapabilities: config.modelCapabilities,\n requestPermission:\n config.onPermissionRequest !== defaultJoinSessionPermissionHandler,\n requestUserInput: !!config.onUserInputRequest,\n requestElicitation: !!config.onElicitationRequest,\n hooks: !!(config.hooks && Object.values(config.hooks).some(Boolean)),\n workingDirectory: config.workingDirectory,\n configDir: config.configDir,\n enableConfigDiscovery: config.enableConfigDiscovery,\n streaming: config.streaming,\n includeSubAgentStreamingEvents: config.includeSubAgentStreamingEvents ?? true,\n mcpServers: config.mcpServers,\n envValueMode: \"direct\",\n customAgents: config.customAgents,\n defaultAgent: config.defaultAgent,\n agent: config.agent,\n skillDirectories: config.skillDirectories,\n disabledSkills: config.disabledSkills,\n infiniteSessions: config.infiniteSessions,\n disableResume: config.disableResume,\n continuePendingWork: config.continuePendingWork,\n gitHubToken: config.gitHubToken,\n });\n\n const { workspacePath, capabilities } = response as {\n sessionId: string;\n workspacePath?: string;\n capabilities?: { ui?: { elicitation?: boolean } };\n };\n session[\"_workspacePath\"] = workspacePath;\n session.setCapabilities(capabilities);\n } catch (e) {\n this.sessions.delete(sessionId);\n throw e;\n }\n\n return session;\n }\n\n /**\n * Gets the current connection state of the client.\n *\n * @returns The current connection state: \"disconnected\", \"connecting\", \"connected\", or \"error\"\n *\n * @example\n * ```typescript\n * if (client.getState() === \"connected\") {\n * const session = await client.createSession({ onPermissionRequest: approveAll });\n * }\n * ```\n */\n getState(): ConnectionState {\n return this.state;\n }\n\n /**\n * Sends a ping request to the server to verify connectivity.\n *\n * @param message - Optional message to include in the ping\n * @returns A promise that resolves with the ping response containing the message and timestamp\n * @throws Error if the client is not connected\n *\n * @example\n * ```typescript\n * const response = await client.ping(\"health check\");\n * console.log(`Server responded at ${new Date(response.timestamp)}`);\n * ```\n */\n async ping(\n message?: string\n ): Promise<{ message: string; timestamp: number; protocolVersion?: number }> {\n if (!this.connection) {\n throw new Error(\"Client not connected\");\n }\n\n const result = await this.connection.sendRequest(\"ping\", { message });\n return result as {\n message: string;\n timestamp: number;\n protocolVersion?: number;\n };\n }\n\n /**\n * Get CLI status including version and protocol information\n */\n async getStatus(): Promise {\n if (!this.connection) {\n throw new Error(\"Client not connected\");\n }\n\n const result = await this.connection.sendRequest(\"status.get\", {});\n return result as GetStatusResponse;\n }\n\n /**\n * Get current authentication status\n */\n async getAuthStatus(): Promise {\n if (!this.connection) {\n throw new Error(\"Client not connected\");\n }\n\n const result = await this.connection.sendRequest(\"auth.getStatus\", {});\n return result as GetAuthStatusResponse;\n }\n\n /**\n * List available models with their metadata.\n *\n * If an `onListModels` handler was provided in the client options,\n * it is called instead of querying the CLI server.\n *\n * Results are cached after the first successful call to avoid rate limiting.\n * The cache is cleared when the client disconnects.\n *\n * @throws Error if not connected (when no custom handler is set)\n */\n async listModels(): Promise {\n // Use promise-based locking to prevent race condition with concurrent calls\n await this.modelsCacheLock;\n\n let resolveLock: () => void;\n this.modelsCacheLock = new Promise((resolve) => {\n resolveLock = resolve;\n });\n\n try {\n // Check cache (already inside lock)\n if (this.modelsCache !== null) {\n return [...this.modelsCache]; // Return a copy to prevent cache mutation\n }\n\n let models: ModelInfo[];\n if (this.onListModels) {\n // Use custom handler instead of CLI RPC\n models = await this.onListModels();\n } else {\n if (!this.connection) {\n throw new Error(\"Client not connected\");\n }\n // Cache miss - fetch from backend while holding lock\n const result = await this.connection.sendRequest(\"models.list\", {});\n const response = result as { models: ModelInfo[] };\n models = response.models;\n\n // Normalize model capabilities — some models (e.g. embedding models)\n // may omit 'supports' or 'limits' in their capabilities.\n for (const model of models) {\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n const m = model as any;\n if (!m.capabilities) {\n m.capabilities = {\n supports: {},\n limits: { max_context_window_tokens: 0 },\n };\n } else {\n if (!m.capabilities.supports) m.capabilities.supports = {};\n if (!m.capabilities.limits) {\n m.capabilities.limits = { max_context_window_tokens: 0 };\n } else if (m.capabilities.limits.max_context_window_tokens === undefined) {\n m.capabilities.limits.max_context_window_tokens = 0;\n }\n }\n }\n }\n\n // Update cache before releasing lock (copy to prevent external mutation)\n this.modelsCache = [...models];\n\n return [...models]; // Return a copy to prevent cache mutation\n } finally {\n resolveLock!();\n }\n }\n\n /**\n * Verify that the server's protocol version is within the supported range\n * and store the negotiated version.\n */\n private async verifyProtocolVersion(): Promise {\n const maxVersion = getSdkProtocolVersion();\n\n // Race ping against process exit to detect early CLI failures\n let pingResult: Awaited>;\n if (this.processExitPromise) {\n pingResult = await Promise.race([this.ping(), this.processExitPromise]);\n } else {\n pingResult = await this.ping();\n }\n\n const serverVersion = pingResult.protocolVersion;\n\n if (serverVersion === undefined) {\n throw new Error(\n `SDK protocol version mismatch: SDK supports versions ${MIN_PROTOCOL_VERSION}-${maxVersion}, but server does not report a protocol version. ` +\n `Please update your server to ensure compatibility.`\n );\n }\n\n if (serverVersion < MIN_PROTOCOL_VERSION || serverVersion > maxVersion) {\n throw new Error(\n `SDK protocol version mismatch: SDK supports versions ${MIN_PROTOCOL_VERSION}-${maxVersion}, but server reports version ${serverVersion}. ` +\n `Please update your SDK or server to ensure compatibility.`\n );\n }\n\n this.negotiatedProtocolVersion = serverVersion;\n }\n\n /**\n * Gets the ID of the most recently updated session.\n *\n * This is useful for resuming the last conversation when the session ID\n * was not stored.\n *\n * @returns A promise that resolves with the session ID, or undefined if no sessions exist\n * @throws Error if the client is not connected\n *\n * @example\n * ```typescript\n * const lastId = await client.getLastSessionId();\n * if (lastId) {\n * const session = await client.resumeSession(lastId, { onPermissionRequest: approveAll });\n * }\n * ```\n */\n async getLastSessionId(): Promise {\n if (!this.connection) {\n throw new Error(\"Client not connected\");\n }\n\n const response = await this.connection.sendRequest(\"session.getLastId\", {});\n return (response as { sessionId?: string }).sessionId;\n }\n\n /**\n * Permanently deletes a session and all its data from disk, including\n * conversation history, planning state, and artifacts.\n *\n * Unlike {@link CopilotSession.disconnect}, which only releases in-memory\n * resources and preserves session data for later resumption, this method\n * is irreversible. The session cannot be resumed after deletion.\n *\n * @param sessionId - The ID of the session to delete\n * @returns A promise that resolves when the session is deleted\n * @throws Error if the session does not exist or deletion fails\n *\n * @example\n * ```typescript\n * await client.deleteSession(\"session-123\");\n * ```\n */\n async deleteSession(sessionId: string): Promise {\n if (!this.connection) {\n throw new Error(\"Client not connected\");\n }\n\n const response = await this.connection.sendRequest(\"session.delete\", {\n sessionId,\n });\n\n const { success, error } = response as { success: boolean; error?: string };\n if (!success) {\n throw new Error(`Failed to delete session ${sessionId}: ${error || \"Unknown error\"}`);\n }\n\n // Remove from local sessions map if present\n this.sessions.delete(sessionId);\n }\n\n /**\n * List all available sessions.\n *\n * @param filter - Optional filter to limit returned sessions by context fields\n *\n * @example\n * // List all sessions\n * const sessions = await client.listSessions();\n *\n * @example\n * // List sessions for a specific repository\n * const sessions = await client.listSessions({ repository: \"owner/repo\" });\n */\n async listSessions(filter?: SessionListFilter): Promise {\n if (!this.connection) {\n throw new Error(\"Client not connected\");\n }\n\n const response = await this.connection.sendRequest(\"session.list\", {\n filter,\n });\n const { sessions } = response as {\n sessions: Array<{\n sessionId: string;\n startTime: string;\n modifiedTime: string;\n summary?: string;\n isRemote: boolean;\n context?: SessionContext;\n }>;\n };\n\n return sessions.map(CopilotClient.toSessionMetadata);\n }\n\n /**\n * Gets metadata for a specific session by ID.\n *\n * This provides an efficient O(1) lookup of a single session's metadata\n * instead of listing all sessions. Returns undefined if the session is not found.\n *\n * @param sessionId - The ID of the session to look up\n * @returns A promise that resolves with the session metadata, or undefined if not found\n * @throws Error if the client is not connected\n *\n * @example\n * ```typescript\n * const metadata = await client.getSessionMetadata(\"session-123\");\n * if (metadata) {\n * console.log(`Session started at: ${metadata.startTime}`);\n * }\n * ```\n */\n async getSessionMetadata(sessionId: string): Promise {\n if (!this.connection) {\n throw new Error(\"Client not connected\");\n }\n\n const response = await this.connection.sendRequest(\"session.getMetadata\", { sessionId });\n const { session } = response as {\n session?: {\n sessionId: string;\n startTime: string;\n modifiedTime: string;\n summary?: string;\n isRemote: boolean;\n context?: SessionContext;\n };\n };\n\n if (!session) {\n return undefined;\n }\n\n return CopilotClient.toSessionMetadata(session);\n }\n\n private static toSessionMetadata(raw: {\n sessionId: string;\n startTime: string;\n modifiedTime: string;\n summary?: string;\n isRemote: boolean;\n context?: SessionContext;\n }): SessionMetadata {\n return {\n sessionId: raw.sessionId,\n startTime: new Date(raw.startTime),\n modifiedTime: new Date(raw.modifiedTime),\n summary: raw.summary,\n isRemote: raw.isRemote,\n context: raw.context,\n };\n }\n\n /**\n * Gets the foreground session ID in TUI+server mode.\n *\n * This returns the ID of the session currently displayed in the TUI.\n * Only available when connecting to a server running in TUI+server mode (--ui-server).\n *\n * @returns A promise that resolves with the foreground session ID, or undefined if none\n * @throws Error if the client is not connected\n *\n * @example\n * ```typescript\n * const sessionId = await client.getForegroundSessionId();\n * if (sessionId) {\n * console.log(`TUI is displaying session: ${sessionId}`);\n * }\n * ```\n */\n async getForegroundSessionId(): Promise {\n if (!this.connection) {\n throw new Error(\"Client not connected\");\n }\n\n const response = await this.connection.sendRequest(\"session.getForeground\", {});\n return (response as ForegroundSessionInfo).sessionId;\n }\n\n /**\n * Sets the foreground session in TUI+server mode.\n *\n * This requests the TUI to switch to displaying the specified session.\n * Only available when connecting to a server running in TUI+server mode (--ui-server).\n *\n * @param sessionId - The ID of the session to display in the TUI\n * @returns A promise that resolves when the session is switched\n * @throws Error if the client is not connected or if the operation fails\n *\n * @example\n * ```typescript\n * // Switch the TUI to display a specific session\n * await client.setForegroundSessionId(\"session-123\");\n * ```\n */\n async setForegroundSessionId(sessionId: string): Promise {\n if (!this.connection) {\n throw new Error(\"Client not connected\");\n }\n\n const response = await this.connection.sendRequest(\"session.setForeground\", { sessionId });\n const result = response as { success: boolean; error?: string };\n\n if (!result.success) {\n throw new Error(result.error || \"Failed to set foreground session\");\n }\n }\n\n /**\n * Subscribes to a specific session lifecycle event type.\n *\n * Lifecycle events are emitted when sessions are created, deleted, updated,\n * or change foreground/background state (in TUI+server mode).\n *\n * @param eventType - The specific event type to listen for\n * @param handler - A callback function that receives events of the specified type\n * @returns A function that, when called, unsubscribes the handler\n *\n * @example\n * ```typescript\n * // Listen for when a session becomes foreground in TUI\n * const unsubscribe = client.on(\"session.foreground\", (event) => {\n * console.log(`Session ${event.sessionId} is now displayed in TUI`);\n * });\n *\n * // Later, to stop receiving events:\n * unsubscribe();\n * ```\n */\n on(\n eventType: K,\n handler: TypedSessionLifecycleHandler\n ): () => void;\n\n /**\n * Subscribes to all session lifecycle events.\n *\n * @param handler - A callback function that receives all lifecycle events\n * @returns A function that, when called, unsubscribes the handler\n *\n * @example\n * ```typescript\n * const unsubscribe = client.on((event) => {\n * switch (event.type) {\n * case \"session.foreground\":\n * console.log(`Session ${event.sessionId} is now in foreground`);\n * break;\n * case \"session.created\":\n * console.log(`New session created: ${event.sessionId}`);\n * break;\n * }\n * });\n *\n * // Later, to stop receiving events:\n * unsubscribe();\n * ```\n */\n on(handler: SessionLifecycleHandler): () => void;\n\n on(\n eventTypeOrHandler: K | SessionLifecycleHandler,\n handler?: TypedSessionLifecycleHandler\n ): () => void {\n // Overload 1: on(eventType, handler) - typed event subscription\n if (typeof eventTypeOrHandler === \"string\" && handler) {\n const eventType = eventTypeOrHandler;\n if (!this.typedLifecycleHandlers.has(eventType)) {\n this.typedLifecycleHandlers.set(eventType, new Set());\n }\n const storedHandler = handler as (event: SessionLifecycleEvent) => void;\n this.typedLifecycleHandlers.get(eventType)!.add(storedHandler);\n return () => {\n const handlers = this.typedLifecycleHandlers.get(eventType);\n if (handlers) {\n handlers.delete(storedHandler);\n }\n };\n }\n\n // Overload 2: on(handler) - wildcard subscription\n const wildcardHandler = eventTypeOrHandler as SessionLifecycleHandler;\n this.sessionLifecycleHandlers.add(wildcardHandler);\n return () => {\n this.sessionLifecycleHandlers.delete(wildcardHandler);\n };\n }\n\n /**\n * Start the CLI server process\n */\n private async startCLIServer(): Promise {\n return new Promise((resolve, reject) => {\n // Clear stderr buffer for fresh capture\n this.stderrBuffer = \"\";\n\n const args = [\n ...this.options.cliArgs,\n \"--headless\",\n \"--no-auto-update\",\n \"--log-level\",\n this.options.logLevel,\n ];\n\n // Choose transport mode\n if (this.options.useStdio) {\n args.push(\"--stdio\");\n } else if (this.options.port > 0) {\n args.push(\"--port\", this.options.port.toString());\n }\n\n // Add auth-related flags\n if (this.options.gitHubToken) {\n args.push(\"--auth-token-env\", \"COPILOT_SDK_AUTH_TOKEN\");\n }\n if (!this.options.useLoggedInUser) {\n args.push(\"--no-auto-login\");\n }\n\n if (\n this.options.sessionIdleTimeoutSeconds !== undefined &&\n this.options.sessionIdleTimeoutSeconds > 0\n ) {\n args.push(\n \"--session-idle-timeout\",\n this.options.sessionIdleTimeoutSeconds.toString()\n );\n }\n\n // Suppress debug/trace output that might pollute stdout\n const envWithoutNodeDebug = { ...this.options.env };\n delete envWithoutNodeDebug.NODE_DEBUG;\n\n // Set auth token in environment if provided\n if (this.options.gitHubToken) {\n envWithoutNodeDebug.COPILOT_SDK_AUTH_TOKEN = this.options.gitHubToken;\n }\n\n if (!this.options.cliPath) {\n throw new Error(\n \"Path to Copilot CLI is required. Please provide it via the cliPath option, or use cliUrl to rely on a remote CLI.\"\n );\n }\n\n // Set OpenTelemetry environment variables if telemetry is configured\n if (this.options.telemetry) {\n const t = this.options.telemetry;\n envWithoutNodeDebug.COPILOT_OTEL_ENABLED = \"true\";\n if (t.otlpEndpoint !== undefined)\n envWithoutNodeDebug.OTEL_EXPORTER_OTLP_ENDPOINT = t.otlpEndpoint;\n if (t.filePath !== undefined)\n envWithoutNodeDebug.COPILOT_OTEL_FILE_EXPORTER_PATH = t.filePath;\n if (t.exporterType !== undefined)\n envWithoutNodeDebug.COPILOT_OTEL_EXPORTER_TYPE = t.exporterType;\n if (t.sourceName !== undefined)\n envWithoutNodeDebug.COPILOT_OTEL_SOURCE_NAME = t.sourceName;\n if (t.captureContent !== undefined)\n envWithoutNodeDebug.OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT = String(\n t.captureContent\n );\n }\n\n // Verify CLI exists before attempting to spawn\n if (!existsSync(this.options.cliPath)) {\n throw new Error(\n `Copilot CLI not found at ${this.options.cliPath}. Ensure @github/copilot is installed.`\n );\n }\n\n const stdioConfig: [\"pipe\", \"pipe\", \"pipe\"] | [\"ignore\", \"pipe\", \"pipe\"] = this.options\n .useStdio\n ? [\"pipe\", \"pipe\", \"pipe\"]\n : [\"ignore\", \"pipe\", \"pipe\"];\n\n // For .js files, spawn node explicitly; for executables, spawn directly\n const isJsFile = this.options.cliPath.endsWith(\".js\");\n if (isJsFile) {\n this.cliProcess = spawn(getNodeExecPath(), [this.options.cliPath, ...args], {\n stdio: stdioConfig,\n cwd: this.options.cwd,\n env: envWithoutNodeDebug,\n windowsHide: true,\n });\n } else {\n this.cliProcess = spawn(this.options.cliPath, args, {\n stdio: stdioConfig,\n cwd: this.options.cwd,\n env: envWithoutNodeDebug,\n windowsHide: true,\n });\n }\n\n let stdout = \"\";\n let resolved = false;\n\n // For stdio mode, we're ready immediately after spawn\n if (this.options.useStdio) {\n resolved = true;\n resolve();\n } else {\n // For TCP mode, wait for port announcement\n this.cliProcess.stdout?.on(\"data\", (data: Buffer) => {\n stdout += data.toString();\n const match = stdout.match(/listening on port (\\d+)/i);\n if (match && !resolved) {\n this.actualPort = parseInt(match[1], 10);\n resolved = true;\n resolve();\n }\n });\n }\n\n this.cliProcess.stderr?.on(\"data\", (data: Buffer) => {\n // Capture stderr for error messages\n this.stderrBuffer += data.toString();\n // Forward CLI stderr to parent's stderr so debug logs are visible\n const lines = data.toString().split(\"\\n\");\n for (const line of lines) {\n if (line.trim()) {\n process.stderr.write(`[CLI subprocess] ${line}\\n`);\n }\n }\n });\n\n this.cliProcess.on(\"error\", (error) => {\n if (!resolved) {\n resolved = true;\n const stderrOutput = this.stderrBuffer.trim();\n if (stderrOutput) {\n reject(\n new Error(\n `Failed to start CLI server: ${error.message}\\nstderr: ${stderrOutput}`\n )\n );\n } else {\n reject(new Error(`Failed to start CLI server: ${error.message}`));\n }\n }\n });\n\n // Set up a promise that rejects when the process exits (used to race against RPC calls)\n this.processExitPromise = new Promise((_, rejectProcessExit) => {\n this.cliProcess!.on(\"exit\", (code) => {\n // Give a small delay for stderr to be fully captured\n setTimeout(() => {\n const stderrOutput = this.stderrBuffer.trim();\n if (stderrOutput) {\n rejectProcessExit(\n new Error(\n `CLI server exited with code ${code}\\nstderr: ${stderrOutput}`\n )\n );\n } else {\n rejectProcessExit(\n new Error(`CLI server exited unexpectedly with code ${code}`)\n );\n }\n }, 50);\n });\n });\n // Prevent unhandled rejection when process exits normally (we only use this in Promise.race)\n this.processExitPromise.catch(() => {});\n\n this.cliProcess.on(\"exit\", (code) => {\n if (!resolved) {\n resolved = true;\n const stderrOutput = this.stderrBuffer.trim();\n if (stderrOutput) {\n reject(\n new Error(\n `CLI server exited with code ${code}\\nstderr: ${stderrOutput}`\n )\n );\n } else {\n reject(new Error(`CLI server exited with code ${code}`));\n }\n }\n });\n\n // Timeout after 10 seconds\n this.cliStartTimeout = setTimeout(() => {\n if (!resolved) {\n resolved = true;\n reject(new Error(\"Timeout waiting for CLI server to start\"));\n }\n }, 10000);\n });\n }\n\n /**\n * Connect to the CLI server (via socket or stdio)\n */\n private async connectToServer(): Promise {\n if (this.options.isChildProcess) {\n return this.connectToParentProcessViaStdio();\n } else if (this.options.useStdio) {\n return this.connectToChildProcessViaStdio();\n } else {\n return this.connectViaTcp();\n }\n }\n\n /**\n * Connect to child via stdio pipes\n */\n private async connectToChildProcessViaStdio(): Promise {\n if (!this.cliProcess) {\n throw new Error(\"CLI process not started\");\n }\n\n // Add error handler to stdin to prevent unhandled rejections during forceStop\n this.cliProcess.stdin?.on(\"error\", (err) => {\n if (!this.forceStopping) {\n throw err;\n }\n });\n\n // Create JSON-RPC connection over stdin/stdout\n this.connection = createMessageConnection(\n new StreamMessageReader(this.cliProcess.stdout!),\n new StreamMessageWriter(this.cliProcess.stdin!)\n );\n\n this.attachConnectionHandlers();\n this.connection.listen();\n }\n\n /**\n * Connect to parent via stdio pipes\n */\n private async connectToParentProcessViaStdio(): Promise {\n if (this.cliProcess) {\n throw new Error(\"CLI child process was unexpectedly started in parent process mode\");\n }\n\n // Create JSON-RPC connection over stdin/stdout\n this.connection = createMessageConnection(\n new StreamMessageReader(process.stdin),\n new StreamMessageWriter(process.stdout)\n );\n\n this.attachConnectionHandlers();\n this.connection.listen();\n }\n\n /**\n * Connect to the CLI server via TCP socket\n */\n private async connectViaTcp(): Promise {\n if (!this.actualPort) {\n throw new Error(\"Server port not available\");\n }\n\n return new Promise((resolve, reject) => {\n this.socket = new Socket();\n\n this.socket.connect(this.actualPort!, this.actualHost, () => {\n // Create JSON-RPC connection\n this.connection = createMessageConnection(\n new StreamMessageReader(this.socket!),\n new StreamMessageWriter(this.socket!)\n );\n\n this.attachConnectionHandlers();\n this.connection.listen();\n resolve();\n });\n\n this.socket.on(\"error\", (error) => {\n reject(new Error(`Failed to connect to CLI server: ${error.message}`));\n });\n });\n }\n\n private attachConnectionHandlers(): void {\n if (!this.connection) {\n return;\n }\n\n this.connection.onNotification(\"session.event\", (notification: unknown) => {\n this.handleSessionEventNotification(notification);\n });\n\n this.connection.onNotification(\"session.lifecycle\", (notification: unknown) => {\n this.handleSessionLifecycleNotification(notification);\n });\n\n // Protocol v3 servers send tool calls and permission requests as broadcast events\n // (external_tool.requested / permission.requested) handled in CopilotSession._dispatchEvent.\n // Protocol v2 servers use the older tool.call / permission.request RPC model instead.\n // We always register v2 adapters because handlers are set up before version negotiation;\n // a v3 server will simply never send these requests.\n this.connection.onRequest(\n \"tool.call\",\n async (params: ToolCallRequestPayload): Promise =>\n await this.handleToolCallRequestV2(params)\n );\n\n this.connection.onRequest(\n \"permission.request\",\n async (params: {\n sessionId: string;\n permissionRequest: unknown;\n }): Promise<{ result: unknown }> => await this.handlePermissionRequestV2(params)\n );\n\n this.connection.onRequest(\n \"userInput.request\",\n async (params: {\n sessionId: string;\n question: string;\n choices?: string[];\n allowFreeform?: boolean;\n }): Promise<{ answer: string; wasFreeform: boolean }> =>\n await this.handleUserInputRequest(params)\n );\n\n this.connection.onRequest(\n \"hooks.invoke\",\n async (params: {\n sessionId: string;\n hookType: string;\n input: unknown;\n }): Promise<{ output?: unknown }> => await this.handleHooksInvoke(params)\n );\n\n this.connection.onRequest(\n \"systemMessage.transform\",\n async (params: {\n sessionId: string;\n sections: Record;\n }): Promise<{ sections: Record }> =>\n await this.handleSystemMessageTransform(params)\n );\n\n // Register client session API handlers.\n const sessions = this.sessions;\n registerClientSessionApiHandlers(this.connection, (sessionId) => {\n const session = sessions.get(sessionId);\n if (!session) throw new Error(`No session found for sessionId: ${sessionId}`);\n return session.clientSessionApis;\n });\n\n this.connection.onClose(() => {\n this.state = \"disconnected\";\n });\n\n this.connection.onError((_error) => {\n this.state = \"disconnected\";\n });\n }\n\n private handleSessionEventNotification(notification: unknown): void {\n if (\n typeof notification !== \"object\" ||\n !notification ||\n !(\"sessionId\" in notification) ||\n typeof (notification as { sessionId?: unknown }).sessionId !== \"string\" ||\n !(\"event\" in notification)\n ) {\n return;\n }\n\n const session = this.sessions.get((notification as { sessionId: string }).sessionId);\n if (session) {\n session._dispatchEvent((notification as { event: SessionEvent }).event);\n }\n }\n\n private handleSessionLifecycleNotification(notification: unknown): void {\n if (\n typeof notification !== \"object\" ||\n !notification ||\n !(\"type\" in notification) ||\n typeof (notification as { type?: unknown }).type !== \"string\" ||\n !(\"sessionId\" in notification) ||\n typeof (notification as { sessionId?: unknown }).sessionId !== \"string\"\n ) {\n return;\n }\n\n const event = notification as SessionLifecycleEvent;\n\n // Dispatch to typed handlers for this specific event type\n const typedHandlers = this.typedLifecycleHandlers.get(event.type);\n if (typedHandlers) {\n for (const handler of typedHandlers) {\n try {\n handler(event);\n } catch {\n // Ignore handler errors\n }\n }\n }\n\n // Dispatch to wildcard handlers\n for (const handler of this.sessionLifecycleHandlers) {\n try {\n handler(event);\n } catch {\n // Ignore handler errors\n }\n }\n }\n\n private async handleUserInputRequest(params: {\n sessionId: string;\n question: string;\n choices?: string[];\n allowFreeform?: boolean;\n }): Promise<{ answer: string; wasFreeform: boolean }> {\n if (\n !params ||\n typeof params.sessionId !== \"string\" ||\n typeof params.question !== \"string\"\n ) {\n throw new Error(\"Invalid user input request payload\");\n }\n\n const session = this.sessions.get(params.sessionId);\n if (!session) {\n throw new Error(`Session not found: ${params.sessionId}`);\n }\n\n const result = await session._handleUserInputRequest({\n question: params.question,\n choices: params.choices,\n allowFreeform: params.allowFreeform,\n });\n return result;\n }\n\n private async handleHooksInvoke(params: {\n sessionId: string;\n hookType: string;\n input: unknown;\n }): Promise<{ output?: unknown }> {\n if (\n !params ||\n typeof params.sessionId !== \"string\" ||\n typeof params.hookType !== \"string\"\n ) {\n throw new Error(\"Invalid hooks invoke payload\");\n }\n\n const session = this.sessions.get(params.sessionId);\n if (!session) {\n throw new Error(`Session not found: ${params.sessionId}`);\n }\n\n const output = await session._handleHooksInvoke(params.hookType, params.input);\n return { output };\n }\n\n private async handleSystemMessageTransform(params: {\n sessionId: string;\n sections: Record;\n }): Promise<{ sections: Record }> {\n if (\n !params ||\n typeof params.sessionId !== \"string\" ||\n !params.sections ||\n typeof params.sections !== \"object\"\n ) {\n throw new Error(\"Invalid systemMessage.transform payload\");\n }\n\n const session = this.sessions.get(params.sessionId);\n if (!session) {\n throw new Error(`Session not found: ${params.sessionId}`);\n }\n\n return await session._handleSystemMessageTransform(params.sections);\n }\n\n // ========================================================================\n // Protocol v2 backward-compatibility adapters\n // ========================================================================\n\n /**\n * Handles a v2-style tool.call RPC request from the server.\n * Looks up the session and tool handler, executes it, and returns the result\n * in the v2 response format.\n */\n private async handleToolCallRequestV2(\n params: ToolCallRequestPayload\n ): Promise {\n if (\n !params ||\n typeof params.sessionId !== \"string\" ||\n typeof params.toolCallId !== \"string\" ||\n typeof params.toolName !== \"string\"\n ) {\n throw new Error(\"Invalid tool call payload\");\n }\n\n const session = this.sessions.get(params.sessionId);\n if (!session) {\n throw new Error(`Unknown session ${params.sessionId}`);\n }\n\n const handler = session.getToolHandler(params.toolName);\n if (!handler) {\n return {\n result: {\n textResultForLlm: `Tool '${params.toolName}' is not supported by this client instance.`,\n resultType: \"failure\",\n error: `tool '${params.toolName}' not supported`,\n toolTelemetry: {},\n },\n };\n }\n\n try {\n const traceparent = (params as { traceparent?: string }).traceparent;\n const tracestate = (params as { tracestate?: string }).tracestate;\n const invocation = {\n sessionId: params.sessionId,\n toolCallId: params.toolCallId,\n toolName: params.toolName,\n arguments: params.arguments,\n traceparent,\n tracestate,\n };\n const result = await handler(params.arguments, invocation);\n return { result: this.normalizeToolResultV2(result) };\n } catch (error) {\n const message = error instanceof Error ? error.message : String(error);\n return {\n result: {\n textResultForLlm:\n \"Invoking this tool produced an error. Detailed information is not available.\",\n resultType: \"failure\",\n error: message,\n toolTelemetry: {},\n },\n };\n }\n }\n\n /**\n * Handles a v2-style permission.request RPC request from the server.\n */\n private async handlePermissionRequestV2(params: {\n sessionId: string;\n permissionRequest: unknown;\n }): Promise<{ result: unknown }> {\n if (!params || typeof params.sessionId !== \"string\" || !params.permissionRequest) {\n throw new Error(\"Invalid permission request payload\");\n }\n\n const session = this.sessions.get(params.sessionId);\n if (!session) {\n throw new Error(`Session not found: ${params.sessionId}`);\n }\n\n try {\n const result = await session._handlePermissionRequestV2(params.permissionRequest);\n return { result };\n } catch (error) {\n if (error instanceof Error && error.message === NO_RESULT_PERMISSION_V2_ERROR) {\n throw error;\n }\n return {\n result: {\n kind: \"user-not-available\",\n },\n };\n }\n }\n\n private normalizeToolResultV2(result: unknown): ToolResultObject {\n if (result === undefined || result === null) {\n return {\n textResultForLlm: \"Tool returned no result\",\n resultType: \"failure\",\n error: \"tool returned no result\",\n toolTelemetry: {},\n };\n }\n\n if (this.isToolResultObject(result)) {\n return result;\n }\n\n const textResult = typeof result === \"string\" ? result : JSON.stringify(result);\n return {\n textResultForLlm: textResult,\n resultType: \"success\",\n toolTelemetry: {},\n };\n }\n\n private isToolResultObject(value: unknown): value is ToolResultObject {\n return (\n typeof value === \"object\" &&\n value !== null &&\n \"textResultForLlm\" in value &&\n typeof (value as ToolResultObject).textResultForLlm === \"string\" &&\n \"resultType\" in value\n );\n }\n}\n" }, { "path": "nodejs/src/extension.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { CopilotClient } from \"./client.js\";\nimport type { CopilotSession } from \"./session.js\";\nimport {\n defaultJoinSessionPermissionHandler,\n type PermissionHandler,\n type ResumeSessionConfig,\n} from \"./types.js\";\n\nexport type JoinSessionConfig = Omit & {\n onPermissionRequest?: PermissionHandler;\n};\n\n/**\n * Joins the current foreground session.\n *\n * @param config - Configuration to add to the session\n * @returns A promise that resolves with the joined session\n *\n * @example\n * ```typescript\n * import { joinSession } from \"@github/copilot-sdk/extension\";\n *\n * const session = await joinSession({ tools: [myTool] });\n * ```\n */\nexport async function joinSession(config: JoinSessionConfig = {}): Promise {\n const sessionId = process.env.SESSION_ID;\n if (!sessionId) {\n throw new Error(\n \"joinSession() is intended for extensions running as child processes of the Copilot CLI.\"\n );\n }\n\n const client = new CopilotClient({ isChildProcess: true });\n return client.resumeSession(sessionId, {\n ...config,\n onPermissionRequest: config.onPermissionRequest ?? defaultJoinSessionPermissionHandler,\n disableResume: config.disableResume ?? true,\n });\n}\n" }, { "path": "nodejs/src/generated/rpc.ts", "content": "/**\n * AUTO-GENERATED FILE - DO NOT EDIT\n * Generated from: api.schema.json\n */\n\nimport type { MessageConnection } from \"vscode-jsonrpc/node.js\";\n\n/**\n * Authentication type\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"AuthInfoType\".\n */\nexport type AuthInfoType = \"hmac\" | \"env\" | \"user\" | \"gh-cli\" | \"api-key\" | \"token\" | \"copilot-api-token\";\n/**\n * Server transport type: stdio, http, sse, or memory (local configs are normalized to stdio)\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"DiscoveredMcpServerType\".\n */\nexport type DiscoveredMcpServerType = \"stdio\" | \"http\" | \"sse\" | \"memory\";\n/**\n * Configuration source\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"DiscoveredMcpServerSource\".\n */\nexport type DiscoveredMcpServerSource = \"user\" | \"workspace\" | \"plugin\" | \"builtin\";\n/**\n * Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/)\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ExtensionSource\".\n */\nexport type ExtensionSource = \"project\" | \"user\";\n/**\n * Current status: running, disabled, failed, or starting\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ExtensionStatus\".\n */\nexport type ExtensionStatus = \"running\" | \"disabled\" | \"failed\" | \"starting\";\n/**\n * Tool call result (string or expanded result object)\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ExternalToolResult\".\n */\nexport type ExternalToolResult = string | ExternalToolTextResultForLlm;\n/**\n * A content block within a tool result, which may be text, terminal output, image, audio, or a resource\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ExternalToolTextResultForLlmContent\".\n */\nexport type ExternalToolTextResultForLlmContent =\n | ExternalToolTextResultForLlmContentText\n | ExternalToolTextResultForLlmContentTerminal\n | ExternalToolTextResultForLlmContentImage\n | ExternalToolTextResultForLlmContentAudio\n | ExternalToolTextResultForLlmContentResourceLink\n | ExternalToolTextResultForLlmContentResource;\n/**\n * Theme variant this icon is intended for\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ExternalToolTextResultForLlmContentResourceLinkIconTheme\".\n */\nexport type ExternalToolTextResultForLlmContentResourceLinkIconTheme = \"light\" | \"dark\";\n/**\n * The embedded resource contents, either text or base64-encoded binary\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ExternalToolTextResultForLlmContentResourceDetails\".\n */\nexport type ExternalToolTextResultForLlmContentResourceDetails =\n | EmbeddedTextResourceContents\n | EmbeddedBlobResourceContents;\n\nexport type FilterMapping =\n | {\n [k: string]: FilterMappingValue;\n }\n | FilterMappingString;\n\nexport type FilterMappingValue = \"none\" | \"markdown\" | \"hidden_characters\";\n\nexport type FilterMappingString = \"none\" | \"markdown\" | \"hidden_characters\";\n/**\n * Category of instruction source — used for merge logic\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"InstructionsSourcesType\".\n */\nexport type InstructionsSourcesType = \"home\" | \"repo\" | \"model\" | \"vscode\" | \"nested-agents\" | \"child-instructions\";\n/**\n * Where this source lives — used for UI grouping\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"InstructionsSourcesLocation\".\n */\nexport type InstructionsSourcesLocation = \"user\" | \"repository\" | \"working-directory\";\n/**\n * Log severity level. Determines how the message is displayed in the timeline. Defaults to \"info\".\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"SessionLogLevel\".\n */\nexport type SessionLogLevel = \"info\" | \"warning\" | \"error\";\n/**\n * MCP server configuration (local/stdio or remote/http)\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"McpServerConfig\".\n */\nexport type McpServerConfig = McpServerConfigLocal | McpServerConfigHttp;\n\nexport type McpServerConfigLocalType = \"local\" | \"stdio\";\n/**\n * Remote transport type. Defaults to \"http\" when omitted.\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"McpServerConfigHttpType\".\n */\nexport type McpServerConfigHttpType = \"http\" | \"sse\";\n\nexport type McpServerConfigHttpOauthGrantType = \"authorization_code\" | \"client_credentials\";\n/**\n * Connection status: connected, failed, needs-auth, pending, disabled, or not_configured\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"McpServerStatus\".\n */\nexport type McpServerStatus = \"connected\" | \"failed\" | \"needs-auth\" | \"pending\" | \"disabled\" | \"not_configured\";\n/**\n * Configuration source: user, workspace, plugin, or builtin\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"McpServerSource\".\n */\nexport type McpServerSource = \"user\" | \"workspace\" | \"plugin\" | \"builtin\";\n/**\n * The agent mode. Valid values: \"interactive\", \"plan\", \"autopilot\".\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"SessionMode\".\n */\nexport type SessionMode = \"interactive\" | \"plan\" | \"autopilot\";\n\nexport type PermissionDecision =\n | PermissionDecisionApproveOnce\n | PermissionDecisionApproveForSession\n | PermissionDecisionApproveForLocation\n | PermissionDecisionApprovePermanently\n | PermissionDecisionReject\n | PermissionDecisionUserNotAvailable;\n/**\n * The approval to add as a session-scoped rule\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"PermissionDecisionApproveForSessionApproval\".\n */\nexport type PermissionDecisionApproveForSessionApproval =\n | PermissionDecisionApproveForSessionApprovalCommands\n | PermissionDecisionApproveForSessionApprovalRead\n | PermissionDecisionApproveForSessionApprovalWrite\n | PermissionDecisionApproveForSessionApprovalMcp\n | PermissionDecisionApproveForSessionApprovalMcpSampling\n | PermissionDecisionApproveForSessionApprovalMemory\n | PermissionDecisionApproveForSessionApprovalCustomTool;\n/**\n * The approval to persist for this location\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"PermissionDecisionApproveForLocationApproval\".\n */\nexport type PermissionDecisionApproveForLocationApproval =\n | PermissionDecisionApproveForLocationApprovalCommands\n | PermissionDecisionApproveForLocationApprovalRead\n | PermissionDecisionApproveForLocationApprovalWrite\n | PermissionDecisionApproveForLocationApprovalMcp\n | PermissionDecisionApproveForLocationApprovalMcpSampling\n | PermissionDecisionApproveForLocationApprovalMemory\n | PermissionDecisionApproveForLocationApprovalCustomTool;\n/**\n * Error classification\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"SessionFsErrorCode\".\n */\nexport type SessionFsErrorCode = \"ENOENT\" | \"UNKNOWN\";\n/**\n * Entry type\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"SessionFsReaddirWithTypesEntryType\".\n */\nexport type SessionFsReaddirWithTypesEntryType = \"file\" | \"directory\";\n/**\n * Path conventions used by this filesystem\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"SessionFsSetProviderConventions\".\n */\nexport type SessionFsSetProviderConventions = \"windows\" | \"posix\";\n/**\n * Signal to send (default: SIGTERM)\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ShellKillSignal\".\n */\nexport type ShellKillSignal = \"SIGTERM\" | \"SIGKILL\" | \"SIGINT\";\n/**\n * Current lifecycle status of the task\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"TaskAgentInfoStatus\".\n */\nexport type TaskAgentInfoStatus = \"running\" | \"idle\" | \"completed\" | \"failed\" | \"cancelled\";\n/**\n * How the agent is currently being managed by the runtime\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"TaskAgentInfoExecutionMode\".\n */\nexport type TaskAgentInfoExecutionMode = \"sync\" | \"background\";\n\nexport type TaskInfo = TaskAgentInfo | TaskShellInfo;\n/**\n * Current lifecycle status of the task\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"TaskShellInfoStatus\".\n */\nexport type TaskShellInfoStatus = \"running\" | \"idle\" | \"completed\" | \"failed\" | \"cancelled\";\n/**\n * Whether the shell runs inside a managed PTY session or as an independent background process\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"TaskShellInfoAttachmentMode\".\n */\nexport type TaskShellInfoAttachmentMode = \"attached\" | \"detached\";\n/**\n * Whether the shell command is currently sync-waited or background-managed\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"TaskShellInfoExecutionMode\".\n */\nexport type TaskShellInfoExecutionMode = \"sync\" | \"background\";\n\nexport type UIElicitationFieldValue = string | number | boolean | string[];\n\nexport type UIElicitationSchemaProperty =\n | UIElicitationStringEnumField\n | UIElicitationStringOneOfField\n | UIElicitationArrayEnumField\n | UIElicitationArrayAnyOfField\n | UIElicitationSchemaPropertyBoolean\n | UIElicitationSchemaPropertyString\n | UIElicitationSchemaPropertyNumber;\n\nexport type UIElicitationSchemaPropertyStringFormat = \"email\" | \"uri\" | \"date\" | \"date-time\";\n\nexport type UIElicitationSchemaPropertyNumberType = \"number\" | \"integer\";\n/**\n * The user's response: accept (submitted), decline (rejected), or cancel (dismissed)\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"UIElicitationResponseAction\".\n */\nexport type UIElicitationResponseAction = \"accept\" | \"decline\" | \"cancel\";\n\nexport interface AccountGetQuotaRequest {\n /**\n * GitHub token for per-user quota lookup. When provided, resolves this token to determine the user's quota instead of using the global auth.\n */\n gitHubToken?: string;\n}\n\nexport interface AccountGetQuotaResult {\n /**\n * Quota snapshots keyed by type (e.g., chat, completions, premium_interactions)\n */\n quotaSnapshots: {\n [k: string]: AccountQuotaSnapshot;\n };\n}\n\nexport interface AccountQuotaSnapshot {\n /**\n * Whether the user has an unlimited usage entitlement\n */\n isUnlimitedEntitlement: boolean;\n /**\n * Number of requests included in the entitlement\n */\n entitlementRequests: number;\n /**\n * Number of requests used so far this period\n */\n usedRequests: number;\n /**\n * Whether usage is still permitted after quota exhaustion\n */\n usageAllowedWithExhaustedQuota: boolean;\n /**\n * Percentage of entitlement remaining\n */\n remainingPercentage: number;\n /**\n * Number of overage requests made this period\n */\n overage: number;\n /**\n * Whether overage is allowed when quota is exhausted\n */\n overageAllowedWithExhaustedQuota: boolean;\n /**\n * Date when the quota resets (ISO 8601 string)\n */\n resetDate?: string;\n}\n\n/** @experimental */\nexport interface AgentGetCurrentResult {\n /**\n * Currently selected custom agent, or null if using the default agent\n */\n agent?: AgentInfo | null;\n}\n\nexport interface AgentInfo {\n /**\n * Unique identifier of the custom agent\n */\n name: string;\n /**\n * Human-readable display name\n */\n displayName: string;\n /**\n * Description of the agent's purpose\n */\n description: string;\n /**\n * Absolute local file path of the agent definition. Only set for file-based agents loaded from disk; remote agents do not have a path.\n */\n path?: string;\n}\n\n/** @experimental */\nexport interface AgentList {\n /**\n * Available custom agents\n */\n agents: AgentInfo[];\n}\n\n/** @experimental */\nexport interface AgentReloadResult {\n /**\n * Reloaded custom agents\n */\n agents: AgentInfo[];\n}\n\n/** @experimental */\nexport interface AgentSelectRequest {\n /**\n * Name of the custom agent to select\n */\n name: string;\n}\n\n/** @experimental */\nexport interface AgentSelectResult {\n agent: AgentInfo;\n}\n\nexport interface CommandsHandlePendingCommandRequest {\n /**\n * Request ID from the command invocation event\n */\n requestId: string;\n /**\n * Error message if the command handler failed\n */\n error?: string;\n}\n\nexport interface CommandsHandlePendingCommandResult {\n /**\n * Whether the command was handled successfully\n */\n success: boolean;\n}\n\nexport interface CurrentModel {\n /**\n * Currently active model identifier\n */\n modelId?: string;\n}\n\nexport interface DiscoveredMcpServer {\n /**\n * Server name (config key)\n */\n name: string;\n type?: DiscoveredMcpServerType;\n source: DiscoveredMcpServerSource;\n /**\n * Whether the server is enabled (not in the disabled list)\n */\n enabled: boolean;\n}\n\nexport interface EmbeddedBlobResourceContents {\n /**\n * URI identifying the resource\n */\n uri: string;\n /**\n * MIME type of the blob content\n */\n mimeType?: string;\n /**\n * Base64-encoded binary content of the resource\n */\n blob: string;\n}\n\nexport interface EmbeddedTextResourceContents {\n /**\n * URI identifying the resource\n */\n uri: string;\n /**\n * MIME type of the text content\n */\n mimeType?: string;\n /**\n * Text content of the resource\n */\n text: string;\n}\n\nexport interface Extension {\n /**\n * Source-qualified ID (e.g., 'project:my-ext', 'user:auth-helper')\n */\n id: string;\n /**\n * Extension name (directory name)\n */\n name: string;\n source: ExtensionSource;\n status: ExtensionStatus;\n /**\n * Process ID if the extension is running\n */\n pid?: number;\n}\n\n/** @experimental */\nexport interface ExtensionList {\n /**\n * Discovered extensions and their current status\n */\n extensions: Extension[];\n}\n\n/** @experimental */\nexport interface ExtensionsDisableRequest {\n /**\n * Source-qualified extension ID to disable\n */\n id: string;\n}\n\n/** @experimental */\nexport interface ExtensionsEnableRequest {\n /**\n * Source-qualified extension ID to enable\n */\n id: string;\n}\n/**\n * Expanded external tool result payload\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ExternalToolTextResultForLlm\".\n */\nexport interface ExternalToolTextResultForLlm {\n /**\n * Text result returned to the model\n */\n textResultForLlm: string;\n /**\n * Execution outcome classification. Optional for back-compat; normalized to 'success' (or 'failure' when error is present) when missing or unrecognized.\n */\n resultType?: string;\n /**\n * Optional error message for failed executions\n */\n error?: string;\n /**\n * Detailed log content for timeline display\n */\n sessionLog?: string;\n /**\n * Optional tool-specific telemetry\n */\n toolTelemetry?: {\n [k: string]: unknown;\n };\n /**\n * Structured content blocks from the tool\n */\n contents?: ExternalToolTextResultForLlmContent[];\n [k: string]: unknown;\n}\n/**\n * Plain text content block\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ExternalToolTextResultForLlmContentText\".\n */\nexport interface ExternalToolTextResultForLlmContentText {\n /**\n * Content block type discriminator\n */\n type: \"text\";\n /**\n * The text content\n */\n text: string;\n}\n/**\n * Terminal/shell output content block with optional exit code and working directory\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ExternalToolTextResultForLlmContentTerminal\".\n */\nexport interface ExternalToolTextResultForLlmContentTerminal {\n /**\n * Content block type discriminator\n */\n type: \"terminal\";\n /**\n * Terminal/shell output text\n */\n text: string;\n /**\n * Process exit code, if the command has completed\n */\n exitCode?: number;\n /**\n * Working directory where the command was executed\n */\n cwd?: string;\n}\n/**\n * Image content block with base64-encoded data\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ExternalToolTextResultForLlmContentImage\".\n */\nexport interface ExternalToolTextResultForLlmContentImage {\n /**\n * Content block type discriminator\n */\n type: \"image\";\n /**\n * Base64-encoded image data\n */\n data: string;\n /**\n * MIME type of the image (e.g., image/png, image/jpeg)\n */\n mimeType: string;\n}\n/**\n * Audio content block with base64-encoded data\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ExternalToolTextResultForLlmContentAudio\".\n */\nexport interface ExternalToolTextResultForLlmContentAudio {\n /**\n * Content block type discriminator\n */\n type: \"audio\";\n /**\n * Base64-encoded audio data\n */\n data: string;\n /**\n * MIME type of the audio (e.g., audio/wav, audio/mpeg)\n */\n mimeType: string;\n}\n/**\n * Resource link content block referencing an external resource\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ExternalToolTextResultForLlmContentResourceLink\".\n */\nexport interface ExternalToolTextResultForLlmContentResourceLink {\n /**\n * Icons associated with this resource\n */\n icons?: ExternalToolTextResultForLlmContentResourceLinkIcon[];\n /**\n * Resource name identifier\n */\n name: string;\n /**\n * Human-readable display title for the resource\n */\n title?: string;\n /**\n * URI identifying the resource\n */\n uri: string;\n /**\n * Human-readable description of the resource\n */\n description?: string;\n /**\n * MIME type of the resource content\n */\n mimeType?: string;\n /**\n * Size of the resource in bytes\n */\n size?: number;\n /**\n * Content block type discriminator\n */\n type: \"resource_link\";\n}\n/**\n * Icon image for a resource\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ExternalToolTextResultForLlmContentResourceLinkIcon\".\n */\nexport interface ExternalToolTextResultForLlmContentResourceLinkIcon {\n /**\n * URL or path to the icon image\n */\n src: string;\n /**\n * MIME type of the icon image\n */\n mimeType?: string;\n /**\n * Available icon sizes (e.g., ['16x16', '32x32'])\n */\n sizes?: string[];\n theme?: ExternalToolTextResultForLlmContentResourceLinkIconTheme;\n}\n/**\n * Embedded resource content block with inline text or binary data\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ExternalToolTextResultForLlmContentResource\".\n */\nexport interface ExternalToolTextResultForLlmContentResource {\n /**\n * Content block type discriminator\n */\n type: \"resource\";\n resource: ExternalToolTextResultForLlmContentResourceDetails;\n}\n\n/** @experimental */\nexport interface FleetStartRequest {\n /**\n * Optional user prompt to combine with fleet instructions\n */\n prompt?: string;\n}\n\n/** @experimental */\nexport interface FleetStartResult {\n /**\n * Whether fleet mode was successfully activated\n */\n started: boolean;\n}\n\nexport interface HandlePendingToolCallRequest {\n /**\n * Request ID of the pending tool call\n */\n requestId: string;\n result?: ExternalToolResult;\n /**\n * Error message if the tool call failed\n */\n error?: string;\n}\n\nexport interface HandlePendingToolCallResult {\n /**\n * Whether the tool call result was handled successfully\n */\n success: boolean;\n}\n/**\n * Post-compaction context window usage breakdown\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"HistoryCompactContextWindow\".\n */\nexport interface HistoryCompactContextWindow {\n /**\n * Maximum token count for the model's context window\n */\n tokenLimit: number;\n /**\n * Current total tokens in the context window (system + conversation + tool definitions)\n */\n currentTokens: number;\n /**\n * Current number of messages in the conversation\n */\n messagesLength: number;\n /**\n * Token count from system message(s)\n */\n systemTokens?: number;\n /**\n * Token count from non-system messages (user, assistant, tool)\n */\n conversationTokens?: number;\n /**\n * Token count from tool definitions\n */\n toolDefinitionsTokens?: number;\n}\n\n/** @experimental */\nexport interface HistoryCompactResult {\n /**\n * Whether compaction completed successfully\n */\n success: boolean;\n /**\n * Number of tokens freed by compaction\n */\n tokensRemoved: number;\n /**\n * Number of messages removed during compaction\n */\n messagesRemoved: number;\n contextWindow?: HistoryCompactContextWindow;\n}\n\n/** @experimental */\nexport interface HistoryTruncateRequest {\n /**\n * Event ID to truncate to. This event and all events after it are removed from the session.\n */\n eventId: string;\n}\n\n/** @experimental */\nexport interface HistoryTruncateResult {\n /**\n * Number of events that were removed\n */\n eventsRemoved: number;\n}\n\nexport interface InstructionsGetSourcesResult {\n /**\n * Instruction sources for the session\n */\n sources: InstructionsSources[];\n}\n\nexport interface InstructionsSources {\n /**\n * Unique identifier for this source (used for toggling)\n */\n id: string;\n /**\n * Human-readable label\n */\n label: string;\n /**\n * File path relative to repo or absolute for home\n */\n sourcePath: string;\n /**\n * Raw content of the instruction file\n */\n content: string;\n type: InstructionsSourcesType;\n location: InstructionsSourcesLocation;\n /**\n * Glob pattern from frontmatter — when set, this instruction applies only to matching files\n */\n applyTo?: string;\n /**\n * Short description (body after frontmatter) for use in instruction tables\n */\n description?: string;\n}\n\nexport interface LogRequest {\n /**\n * Human-readable message\n */\n message: string;\n level?: SessionLogLevel;\n /**\n * When true, the message is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Optional URL the user can open in their browser for more details\n */\n url?: string;\n}\n\nexport interface LogResult {\n /**\n * The unique identifier of the emitted session event\n */\n eventId: string;\n}\n\nexport interface McpConfigAddRequest {\n /**\n * Unique name for the MCP server\n */\n name: string;\n config: McpServerConfig;\n}\n\nexport interface McpServerConfigLocal {\n /**\n * Tools to include. Defaults to all tools if not specified.\n */\n tools?: string[];\n type?: McpServerConfigLocalType;\n isDefaultServer?: boolean;\n filterMapping?: FilterMapping;\n /**\n * Timeout in milliseconds for tool calls to this server.\n */\n timeout?: number;\n command: string;\n args: string[];\n cwd?: string;\n env?: {\n [k: string]: string;\n };\n}\n\nexport interface McpServerConfigHttp {\n /**\n * Tools to include. Defaults to all tools if not specified.\n */\n tools?: string[];\n type?: McpServerConfigHttpType;\n isDefaultServer?: boolean;\n filterMapping?: FilterMapping;\n /**\n * Timeout in milliseconds for tool calls to this server.\n */\n timeout?: number;\n url: string;\n headers?: {\n [k: string]: string;\n };\n oauthClientId?: string;\n oauthPublicClient?: boolean;\n oauthGrantType?: McpServerConfigHttpOauthGrantType;\n}\n\nexport interface McpConfigDisableRequest {\n /**\n * Names of MCP servers to disable. Each server is added to the persisted disabled list so new sessions skip it. Already-disabled names are ignored. Active sessions keep their current connections until they end.\n */\n names: string[];\n}\n\nexport interface McpConfigEnableRequest {\n /**\n * Names of MCP servers to enable. Each server is removed from the persisted disabled list so new sessions spawn it. Unknown or already-enabled names are ignored.\n */\n names: string[];\n}\n\nexport interface McpConfigList {\n /**\n * All MCP servers from user config, keyed by name\n */\n servers: {\n [k: string]: McpServerConfig;\n };\n}\n\nexport interface McpConfigRemoveRequest {\n /**\n * Name of the MCP server to remove\n */\n name: string;\n}\n\nexport interface McpConfigUpdateRequest {\n /**\n * Name of the MCP server to update\n */\n name: string;\n config: McpServerConfig;\n}\n\n/** @experimental */\nexport interface McpDisableRequest {\n /**\n * Name of the MCP server to disable\n */\n serverName: string;\n}\n\nexport interface McpDiscoverRequest {\n /**\n * Working directory used as context for discovery (e.g., plugin resolution)\n */\n workingDirectory?: string;\n}\n\nexport interface McpDiscoverResult {\n /**\n * MCP servers discovered from all sources\n */\n servers: DiscoveredMcpServer[];\n}\n\n/** @experimental */\nexport interface McpEnableRequest {\n /**\n * Name of the MCP server to enable\n */\n serverName: string;\n}\n\n/** @experimental */\nexport interface McpOauthLoginRequest {\n /**\n * Name of the remote MCP server to authenticate\n */\n serverName: string;\n /**\n * When true, clears any cached OAuth token for the server and runs a full new authorization. Use when the user explicitly wants to switch accounts or believes their session is stuck.\n */\n forceReauth?: boolean;\n /**\n * Optional override for the OAuth client display name shown on the consent screen. Applies to newly registered dynamic clients only — existing registrations keep the name they were created with. When omitted, the runtime applies a neutral fallback; callers driving interactive auth should pass their own surface-specific label so the consent screen matches the product the user sees.\n */\n clientName?: string;\n /**\n * Optional override for the body text shown on the OAuth loopback callback success page. When omitted, the runtime applies a neutral fallback; callers driving interactive auth should pass surface-specific copy telling the user where to return.\n */\n callbackSuccessMessage?: string;\n}\n\n/** @experimental */\nexport interface McpOauthLoginResult {\n /**\n * URL the caller should open in a browser to complete OAuth. Omitted when cached tokens were still valid and no browser interaction was needed — the server is already reconnected in that case. When present, the runtime starts the callback listener before returning and continues the flow in the background; completion is signaled via session.mcp_server_status_changed.\n */\n authorizationUrl?: string;\n}\n\nexport interface McpServer {\n /**\n * Server name (config key)\n */\n name: string;\n status: McpServerStatus;\n source?: McpServerSource;\n /**\n * Error message if the server failed to connect\n */\n error?: string;\n}\n\n/** @experimental */\nexport interface McpServerList {\n /**\n * Configured MCP servers\n */\n servers: McpServer[];\n}\n\nexport interface Model {\n /**\n * Model identifier (e.g., \"claude-sonnet-4.5\")\n */\n id: string;\n /**\n * Display name\n */\n name: string;\n capabilities: ModelCapabilities;\n policy?: ModelPolicy;\n billing?: ModelBilling;\n /**\n * Supported reasoning effort levels (only present if model supports reasoning effort)\n */\n supportedReasoningEfforts?: string[];\n /**\n * Default reasoning effort level (only present if model supports reasoning effort)\n */\n defaultReasoningEffort?: string;\n}\n/**\n * Model capabilities and limits\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ModelCapabilities\".\n */\nexport interface ModelCapabilities {\n supports?: ModelCapabilitiesSupports;\n limits?: ModelCapabilitiesLimits;\n}\n/**\n * Feature flags indicating what the model supports\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ModelCapabilitiesSupports\".\n */\nexport interface ModelCapabilitiesSupports {\n /**\n * Whether this model supports vision/image input\n */\n vision?: boolean;\n /**\n * Whether this model supports reasoning effort configuration\n */\n reasoningEffort?: boolean;\n}\n/**\n * Token limits for prompts, outputs, and context window\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ModelCapabilitiesLimits\".\n */\nexport interface ModelCapabilitiesLimits {\n /**\n * Maximum number of prompt/input tokens\n */\n max_prompt_tokens?: number;\n /**\n * Maximum number of output/completion tokens\n */\n max_output_tokens?: number;\n /**\n * Maximum total context window size in tokens\n */\n max_context_window_tokens?: number;\n vision?: ModelCapabilitiesLimitsVision;\n}\n/**\n * Vision-specific limits\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ModelCapabilitiesLimitsVision\".\n */\nexport interface ModelCapabilitiesLimitsVision {\n /**\n * MIME types the model accepts\n */\n supported_media_types: string[];\n /**\n * Maximum number of images per prompt\n */\n max_prompt_images: number;\n /**\n * Maximum image size in bytes\n */\n max_prompt_image_size: number;\n}\n/**\n * Policy state (if applicable)\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ModelPolicy\".\n */\nexport interface ModelPolicy {\n /**\n * Current policy state for this model\n */\n state: string;\n /**\n * Usage terms or conditions for this model\n */\n terms?: string;\n}\n/**\n * Billing information\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ModelBilling\".\n */\nexport interface ModelBilling {\n /**\n * Billing cost multiplier relative to the base rate\n */\n multiplier: number;\n}\n/**\n * Override individual model capabilities resolved by the runtime\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ModelCapabilitiesOverride\".\n */\nexport interface ModelCapabilitiesOverride {\n supports?: ModelCapabilitiesOverrideSupports;\n limits?: ModelCapabilitiesOverrideLimits;\n}\n/**\n * Feature flags indicating what the model supports\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ModelCapabilitiesOverrideSupports\".\n */\nexport interface ModelCapabilitiesOverrideSupports {\n vision?: boolean;\n reasoningEffort?: boolean;\n}\n/**\n * Token limits for prompts, outputs, and context window\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"ModelCapabilitiesOverrideLimits\".\n */\nexport interface ModelCapabilitiesOverrideLimits {\n max_prompt_tokens?: number;\n max_output_tokens?: number;\n /**\n * Maximum total context window size in tokens\n */\n max_context_window_tokens?: number;\n vision?: ModelCapabilitiesOverrideLimitsVision;\n}\n\nexport interface ModelCapabilitiesOverrideLimitsVision {\n /**\n * MIME types the model accepts\n */\n supported_media_types?: string[];\n /**\n * Maximum number of images per prompt\n */\n max_prompt_images?: number;\n /**\n * Maximum image size in bytes\n */\n max_prompt_image_size?: number;\n}\n\nexport interface ModelList {\n /**\n * List of available models with full metadata\n */\n models: Model[];\n}\n\nexport interface ModelsListRequest {\n /**\n * GitHub token for per-user model listing. When provided, resolves this token to determine the user's Copilot plan and available models instead of using the global auth.\n */\n gitHubToken?: string;\n}\n\nexport interface ModelSwitchToRequest {\n /**\n * Model identifier to switch to\n */\n modelId: string;\n /**\n * Reasoning effort level to use for the model\n */\n reasoningEffort?: string;\n modelCapabilities?: ModelCapabilitiesOverride;\n}\n\nexport interface ModelSwitchToResult {\n /**\n * Currently active model identifier after the switch\n */\n modelId?: string;\n}\n\nexport interface ModeSetRequest {\n mode: SessionMode;\n}\n\nexport interface NameGetResult {\n /**\n * The session name (user-set or auto-generated), or null if not yet set\n */\n name: string | null;\n}\n\nexport interface NameSetRequest {\n /**\n * New session name (1–100 characters, trimmed of leading/trailing whitespace)\n */\n name: string;\n}\n\nexport interface PermissionDecisionApproveOnce {\n /**\n * The permission request was approved for this one instance\n */\n kind: \"approve-once\";\n}\n\nexport interface PermissionDecisionApproveForSession {\n /**\n * Approved and remembered for the rest of the session\n */\n kind: \"approve-for-session\";\n approval?: PermissionDecisionApproveForSessionApproval;\n /**\n * The URL domain to approve for this session\n */\n domain?: string;\n}\n\nexport interface PermissionDecisionApproveForSessionApprovalCommands {\n kind: \"commands\";\n commandIdentifiers: string[];\n}\n\nexport interface PermissionDecisionApproveForSessionApprovalRead {\n kind: \"read\";\n}\n\nexport interface PermissionDecisionApproveForSessionApprovalWrite {\n kind: \"write\";\n}\n\nexport interface PermissionDecisionApproveForSessionApprovalMcp {\n kind: \"mcp\";\n serverName: string;\n toolName: string | null;\n}\n\nexport interface PermissionDecisionApproveForSessionApprovalMcpSampling {\n kind: \"mcp-sampling\";\n serverName: string;\n}\n\nexport interface PermissionDecisionApproveForSessionApprovalMemory {\n kind: \"memory\";\n}\n\nexport interface PermissionDecisionApproveForSessionApprovalCustomTool {\n kind: \"custom-tool\";\n toolName: string;\n}\n\nexport interface PermissionDecisionApproveForLocation {\n /**\n * Approved and persisted for this project location\n */\n kind: \"approve-for-location\";\n approval: PermissionDecisionApproveForLocationApproval;\n /**\n * The location key (git root or cwd) to persist the approval to\n */\n locationKey: string;\n}\n\nexport interface PermissionDecisionApproveForLocationApprovalCommands {\n kind: \"commands\";\n commandIdentifiers: string[];\n}\n\nexport interface PermissionDecisionApproveForLocationApprovalRead {\n kind: \"read\";\n}\n\nexport interface PermissionDecisionApproveForLocationApprovalWrite {\n kind: \"write\";\n}\n\nexport interface PermissionDecisionApproveForLocationApprovalMcp {\n kind: \"mcp\";\n serverName: string;\n toolName: string | null;\n}\n\nexport interface PermissionDecisionApproveForLocationApprovalMcpSampling {\n kind: \"mcp-sampling\";\n serverName: string;\n}\n\nexport interface PermissionDecisionApproveForLocationApprovalMemory {\n kind: \"memory\";\n}\n\nexport interface PermissionDecisionApproveForLocationApprovalCustomTool {\n kind: \"custom-tool\";\n toolName: string;\n}\n\nexport interface PermissionDecisionApprovePermanently {\n /**\n * Approved and persisted across sessions\n */\n kind: \"approve-permanently\";\n /**\n * The URL domain to approve permanently\n */\n domain: string;\n}\n\nexport interface PermissionDecisionReject {\n /**\n * Denied by the user during an interactive prompt\n */\n kind: \"reject\";\n /**\n * Optional feedback from the user explaining the denial\n */\n feedback?: string;\n}\n\nexport interface PermissionDecisionUserNotAvailable {\n /**\n * Denied because user confirmation was unavailable\n */\n kind: \"user-not-available\";\n}\n\nexport interface PermissionDecisionRequest {\n /**\n * Request ID of the pending permission request\n */\n requestId: string;\n result: PermissionDecision;\n}\n\nexport interface PermissionRequestResult {\n /**\n * Whether the permission request was handled successfully\n */\n success: boolean;\n}\n\nexport interface PermissionsResetSessionApprovalsRequest {}\n\nexport interface PermissionsResetSessionApprovalsResult {\n /**\n * Whether the operation succeeded\n */\n success: boolean;\n}\n\nexport interface PermissionsSetApproveAllRequest {\n /**\n * Whether to auto-approve all tool permission requests\n */\n enabled: boolean;\n}\n\nexport interface PermissionsSetApproveAllResult {\n /**\n * Whether the operation succeeded\n */\n success: boolean;\n}\n\nexport interface PingRequest {\n /**\n * Optional message to echo back\n */\n message?: string;\n}\n\nexport interface PingResult {\n /**\n * Echoed message (or default greeting)\n */\n message: string;\n /**\n * Server timestamp in milliseconds\n */\n timestamp: number;\n /**\n * Server protocol version number\n */\n protocolVersion: number;\n}\n\nexport interface PlanReadResult {\n /**\n * Whether the plan file exists in the workspace\n */\n exists: boolean;\n /**\n * The content of the plan file, or null if it does not exist\n */\n content: string | null;\n /**\n * Absolute file path of the plan file, or null if workspace is not enabled\n */\n path: string | null;\n}\n\nexport interface PlanUpdateRequest {\n /**\n * The new content for the plan file\n */\n content: string;\n}\n\nexport interface Plugin {\n /**\n * Plugin name\n */\n name: string;\n /**\n * Marketplace the plugin came from\n */\n marketplace: string;\n /**\n * Installed version\n */\n version?: string;\n /**\n * Whether the plugin is currently enabled\n */\n enabled: boolean;\n}\n\n/** @experimental */\nexport interface PluginList {\n /**\n * Installed plugins\n */\n plugins: Plugin[];\n}\n\nexport interface ServerSkill {\n /**\n * Unique identifier for the skill\n */\n name: string;\n /**\n * Description of what the skill does\n */\n description: string;\n /**\n * Source location type (e.g., project, personal-copilot, plugin, builtin)\n */\n source: string;\n /**\n * Whether the skill can be invoked by the user as a slash command\n */\n userInvocable: boolean;\n /**\n * Whether the skill is currently enabled (based on global config)\n */\n enabled: boolean;\n /**\n * Absolute path to the skill file\n */\n path?: string;\n /**\n * The project path this skill belongs to (only for project/inherited skills)\n */\n projectPath?: string;\n}\n\nexport interface ServerSkillList {\n /**\n * All discovered skills across all sources\n */\n skills: ServerSkill[];\n}\n\nexport interface SessionAuthStatus {\n /**\n * Whether the session has resolved authentication\n */\n isAuthenticated: boolean;\n authType?: AuthInfoType;\n /**\n * Authentication host URL\n */\n host?: string;\n /**\n * Authenticated login/username, if available\n */\n login?: string;\n /**\n * Human-readable authentication status description\n */\n statusMessage?: string;\n /**\n * Copilot plan tier (e.g., individual_pro, business)\n */\n copilotPlan?: string;\n}\n\nexport interface SessionFsAppendFileRequest {\n /**\n * Target session identifier\n */\n sessionId: string;\n /**\n * Path using SessionFs conventions\n */\n path: string;\n /**\n * Content to append\n */\n content: string;\n /**\n * Optional POSIX-style mode for newly created files\n */\n mode?: number;\n}\n/**\n * Describes a filesystem error.\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"SessionFsError\".\n */\nexport interface SessionFsError {\n code: SessionFsErrorCode;\n /**\n * Free-form detail about the error, for logging/diagnostics\n */\n message?: string;\n}\n\nexport interface SessionFsExistsRequest {\n /**\n * Target session identifier\n */\n sessionId: string;\n /**\n * Path using SessionFs conventions\n */\n path: string;\n}\n\nexport interface SessionFsExistsResult {\n /**\n * Whether the path exists\n */\n exists: boolean;\n}\n\nexport interface SessionFsMkdirRequest {\n /**\n * Target session identifier\n */\n sessionId: string;\n /**\n * Path using SessionFs conventions\n */\n path: string;\n /**\n * Create parent directories as needed\n */\n recursive?: boolean;\n /**\n * Optional POSIX-style mode for newly created directories\n */\n mode?: number;\n}\n\nexport interface SessionFsReaddirRequest {\n /**\n * Target session identifier\n */\n sessionId: string;\n /**\n * Path using SessionFs conventions\n */\n path: string;\n}\n\nexport interface SessionFsReaddirResult {\n /**\n * Entry names in the directory\n */\n entries: string[];\n error?: SessionFsError;\n}\n\nexport interface SessionFsReaddirWithTypesEntry {\n /**\n * Entry name\n */\n name: string;\n type: SessionFsReaddirWithTypesEntryType;\n}\n\nexport interface SessionFsReaddirWithTypesRequest {\n /**\n * Target session identifier\n */\n sessionId: string;\n /**\n * Path using SessionFs conventions\n */\n path: string;\n}\n\nexport interface SessionFsReaddirWithTypesResult {\n /**\n * Directory entries with type information\n */\n entries: SessionFsReaddirWithTypesEntry[];\n error?: SessionFsError;\n}\n\nexport interface SessionFsReadFileRequest {\n /**\n * Target session identifier\n */\n sessionId: string;\n /**\n * Path using SessionFs conventions\n */\n path: string;\n}\n\nexport interface SessionFsReadFileResult {\n /**\n * File content as UTF-8 string\n */\n content: string;\n error?: SessionFsError;\n}\n\nexport interface SessionFsRenameRequest {\n /**\n * Target session identifier\n */\n sessionId: string;\n /**\n * Source path using SessionFs conventions\n */\n src: string;\n /**\n * Destination path using SessionFs conventions\n */\n dest: string;\n}\n\nexport interface SessionFsRmRequest {\n /**\n * Target session identifier\n */\n sessionId: string;\n /**\n * Path using SessionFs conventions\n */\n path: string;\n /**\n * Remove directories and their contents recursively\n */\n recursive?: boolean;\n /**\n * Ignore errors if the path does not exist\n */\n force?: boolean;\n}\n\nexport interface SessionFsSetProviderRequest {\n /**\n * Initial working directory for sessions\n */\n initialCwd: string;\n /**\n * Path within each session's SessionFs where the runtime stores files for that session\n */\n sessionStatePath: string;\n conventions: SessionFsSetProviderConventions;\n}\n\nexport interface SessionFsSetProviderResult {\n /**\n * Whether the provider was set successfully\n */\n success: boolean;\n}\n\nexport interface SessionFsStatRequest {\n /**\n * Target session identifier\n */\n sessionId: string;\n /**\n * Path using SessionFs conventions\n */\n path: string;\n}\n\nexport interface SessionFsStatResult {\n /**\n * Whether the path is a file\n */\n isFile: boolean;\n /**\n * Whether the path is a directory\n */\n isDirectory: boolean;\n /**\n * File size in bytes\n */\n size: number;\n /**\n * ISO 8601 timestamp of last modification\n */\n mtime: string;\n /**\n * ISO 8601 timestamp of creation\n */\n birthtime: string;\n error?: SessionFsError;\n}\n\nexport interface SessionFsWriteFileRequest {\n /**\n * Target session identifier\n */\n sessionId: string;\n /**\n * Path using SessionFs conventions\n */\n path: string;\n /**\n * Content to write\n */\n content: string;\n /**\n * Optional POSIX-style mode for newly created files\n */\n mode?: number;\n}\n\n/** @experimental */\nexport interface SessionsForkRequest {\n /**\n * Source session ID to fork from\n */\n sessionId: string;\n /**\n * Optional event ID boundary. When provided, the fork includes only events before this ID (exclusive). When omitted, all events are included.\n */\n toEventId?: string;\n}\n\n/** @experimental */\nexport interface SessionsForkResult {\n /**\n * The new forked session's ID\n */\n sessionId: string;\n}\n\nexport interface ShellExecRequest {\n /**\n * Shell command to execute\n */\n command: string;\n /**\n * Working directory (defaults to session working directory)\n */\n cwd?: string;\n /**\n * Timeout in milliseconds (default: 30000)\n */\n timeout?: number;\n}\n\nexport interface ShellExecResult {\n /**\n * Unique identifier for tracking streamed output\n */\n processId: string;\n}\n\nexport interface ShellKillRequest {\n /**\n * Process identifier returned by shell.exec\n */\n processId: string;\n signal?: ShellKillSignal;\n}\n\nexport interface ShellKillResult {\n /**\n * Whether the signal was sent successfully\n */\n killed: boolean;\n}\n\nexport interface Skill {\n /**\n * Unique identifier for the skill\n */\n name: string;\n /**\n * Description of what the skill does\n */\n description: string;\n /**\n * Source location type (e.g., project, personal, plugin)\n */\n source: string;\n /**\n * Whether the skill can be invoked by the user as a slash command\n */\n userInvocable: boolean;\n /**\n * Whether the skill is currently enabled\n */\n enabled: boolean;\n /**\n * Absolute path to the skill file\n */\n path?: string;\n}\n\n/** @experimental */\nexport interface SkillList {\n /**\n * Available skills\n */\n skills: Skill[];\n}\n\nexport interface SkillsConfigSetDisabledSkillsRequest {\n /**\n * List of skill names to disable\n */\n disabledSkills: string[];\n}\n\n/** @experimental */\nexport interface SkillsDisableRequest {\n /**\n * Name of the skill to disable\n */\n name: string;\n}\n\nexport interface SkillsDiscoverRequest {\n /**\n * Optional list of project directory paths to scan for project-scoped skills\n */\n projectPaths?: string[];\n /**\n * Optional list of additional skill directory paths to include\n */\n skillDirectories?: string[];\n}\n\n/** @experimental */\nexport interface SkillsEnableRequest {\n /**\n * Name of the skill to enable\n */\n name: string;\n}\n\nexport interface TaskAgentInfo {\n /**\n * Task kind\n */\n type: \"agent\";\n /**\n * Unique task identifier\n */\n id: string;\n /**\n * Tool call ID associated with this agent task\n */\n toolCallId: string;\n /**\n * Short description of the task\n */\n description: string;\n status: TaskAgentInfoStatus;\n /**\n * ISO 8601 timestamp when the task was started\n */\n startedAt: string;\n /**\n * ISO 8601 timestamp when the task finished\n */\n completedAt?: string;\n /**\n * Accumulated active execution time in milliseconds\n */\n activeTimeMs?: number;\n /**\n * ISO 8601 timestamp when the current active period began\n */\n activeStartedAt?: string;\n /**\n * Error message when the task failed\n */\n error?: string;\n /**\n * Type of agent running this task\n */\n agentType: string;\n /**\n * Prompt passed to the agent\n */\n prompt: string;\n /**\n * Result text from the task when available\n */\n result?: string;\n /**\n * Model used for the task when specified\n */\n model?: string;\n executionMode?: TaskAgentInfoExecutionMode;\n /**\n * Whether the task is currently in the original sync wait and can be moved to background mode. False once it is already backgrounded, idle, finished, or no longer has a promotable sync waiter.\n */\n canPromoteToBackground?: boolean;\n /**\n * Most recent response text from the agent\n */\n latestResponse?: string;\n /**\n * ISO 8601 timestamp when the agent entered idle state\n */\n idleSince?: string;\n}\n\nexport interface TaskShellInfo {\n /**\n * Task kind\n */\n type: \"shell\";\n /**\n * Unique task identifier\n */\n id: string;\n /**\n * Short description of the task\n */\n description: string;\n status: TaskShellInfoStatus;\n /**\n * ISO 8601 timestamp when the task was started\n */\n startedAt: string;\n /**\n * ISO 8601 timestamp when the task finished\n */\n completedAt?: string;\n /**\n * Command being executed\n */\n command: string;\n attachmentMode: TaskShellInfoAttachmentMode;\n executionMode?: TaskShellInfoExecutionMode;\n /**\n * Whether this shell task can be promoted to background mode\n */\n canPromoteToBackground?: boolean;\n /**\n * Path to the detached shell log, when available\n */\n logPath?: string;\n /**\n * Process ID when available\n */\n pid?: number;\n}\n\n/** @experimental */\nexport interface TaskList {\n /**\n * Currently tracked tasks\n */\n tasks: TaskInfo[];\n}\n\n/** @experimental */\nexport interface TasksCancelRequest {\n /**\n * Task identifier\n */\n id: string;\n}\n\n/** @experimental */\nexport interface TasksCancelResult {\n /**\n * Whether the task was successfully cancelled\n */\n cancelled: boolean;\n}\n\n/** @experimental */\nexport interface TasksPromoteToBackgroundRequest {\n /**\n * Task identifier\n */\n id: string;\n}\n\n/** @experimental */\nexport interface TasksPromoteToBackgroundResult {\n /**\n * Whether the task was successfully promoted to background mode\n */\n promoted: boolean;\n}\n\n/** @experimental */\nexport interface TasksRemoveRequest {\n /**\n * Task identifier\n */\n id: string;\n}\n\n/** @experimental */\nexport interface TasksRemoveResult {\n /**\n * Whether the task was removed. Returns false if the task does not exist or is still running/idle (cancel it first).\n */\n removed: boolean;\n}\n\n/** @experimental */\nexport interface TasksStartAgentRequest {\n /**\n * Type of agent to start (e.g., 'explore', 'task', 'general-purpose')\n */\n agentType: string;\n /**\n * Task prompt for the agent\n */\n prompt: string;\n /**\n * Short name for the agent, used to generate a human-readable ID\n */\n name: string;\n /**\n * Short description of the task\n */\n description?: string;\n /**\n * Optional model override\n */\n model?: string;\n}\n\n/** @experimental */\nexport interface TasksStartAgentResult {\n /**\n * Generated agent ID for the background task\n */\n agentId: string;\n}\n\nexport interface Tool {\n /**\n * Tool identifier (e.g., \"bash\", \"grep\", \"str_replace_editor\")\n */\n name: string;\n /**\n * Optional namespaced name for declarative filtering (e.g., \"playwright/navigate\" for MCP tools)\n */\n namespacedName?: string;\n /**\n * Description of what the tool does\n */\n description: string;\n /**\n * JSON Schema for the tool's input parameters\n */\n parameters?: {\n [k: string]: unknown;\n };\n /**\n * Optional instructions for how to use this tool effectively\n */\n instructions?: string;\n}\n\nexport interface ToolList {\n /**\n * List of available built-in tools with metadata\n */\n tools: Tool[];\n}\n\nexport interface ToolsListRequest {\n /**\n * Optional model ID — when provided, the returned tool list reflects model-specific overrides\n */\n model?: string;\n}\n\nexport interface UIElicitationArrayAnyOfField {\n type: \"array\";\n title?: string;\n description?: string;\n minItems?: number;\n maxItems?: number;\n items: UIElicitationArrayAnyOfFieldItems;\n default?: string[];\n}\n\nexport interface UIElicitationArrayAnyOfFieldItems {\n anyOf: UIElicitationArrayAnyOfFieldItemsAnyOf[];\n}\n\nexport interface UIElicitationArrayAnyOfFieldItemsAnyOf {\n const: string;\n title: string;\n}\n\nexport interface UIElicitationArrayEnumField {\n type: \"array\";\n title?: string;\n description?: string;\n minItems?: number;\n maxItems?: number;\n items: UIElicitationArrayEnumFieldItems;\n default?: string[];\n}\n\nexport interface UIElicitationArrayEnumFieldItems {\n type: \"string\";\n enum: string[];\n}\n\nexport interface UIElicitationRequest {\n /**\n * Message describing what information is needed from the user\n */\n message: string;\n requestedSchema: UIElicitationSchema;\n}\n/**\n * JSON Schema describing the form fields to present to the user\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"UIElicitationSchema\".\n */\nexport interface UIElicitationSchema {\n /**\n * Schema type indicator (always 'object')\n */\n type: \"object\";\n /**\n * Form field definitions, keyed by field name\n */\n properties: {\n [k: string]: UIElicitationSchemaProperty;\n };\n /**\n * List of required field names\n */\n required?: string[];\n}\n\nexport interface UIElicitationStringEnumField {\n type: \"string\";\n title?: string;\n description?: string;\n enum: string[];\n enumNames?: string[];\n default?: string;\n}\n\nexport interface UIElicitationStringOneOfField {\n type: \"string\";\n title?: string;\n description?: string;\n oneOf: UIElicitationStringOneOfFieldOneOf[];\n default?: string;\n}\n\nexport interface UIElicitationStringOneOfFieldOneOf {\n const: string;\n title: string;\n}\n\nexport interface UIElicitationSchemaPropertyBoolean {\n type: \"boolean\";\n title?: string;\n description?: string;\n default?: boolean;\n}\n\nexport interface UIElicitationSchemaPropertyString {\n type: \"string\";\n title?: string;\n description?: string;\n minLength?: number;\n maxLength?: number;\n format?: UIElicitationSchemaPropertyStringFormat;\n default?: string;\n}\n\nexport interface UIElicitationSchemaPropertyNumber {\n type: UIElicitationSchemaPropertyNumberType;\n title?: string;\n description?: string;\n minimum?: number;\n maximum?: number;\n default?: number;\n}\n/**\n * The elicitation response (accept with form values, decline, or cancel)\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"UIElicitationResponse\".\n */\nexport interface UIElicitationResponse {\n action: UIElicitationResponseAction;\n content?: UIElicitationResponseContent;\n}\n/**\n * The form values submitted by the user (present when action is 'accept')\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"UIElicitationResponseContent\".\n */\nexport interface UIElicitationResponseContent {\n [k: string]: UIElicitationFieldValue;\n}\n\nexport interface UIElicitationResult {\n /**\n * Whether the response was accepted. False if the request was already resolved by another client.\n */\n success: boolean;\n}\n\nexport interface UIHandlePendingElicitationRequest {\n /**\n * The unique request ID from the elicitation.requested event\n */\n requestId: string;\n result: UIElicitationResponse;\n}\n\n/** @experimental */\nexport interface UsageGetMetricsResult {\n /**\n * Total user-initiated premium request cost across all models (may be fractional due to multipliers)\n */\n totalPremiumRequestCost: number;\n /**\n * Raw count of user-initiated API requests\n */\n totalUserRequests: number;\n /**\n * Session-wide accumulated nano-AI units cost\n */\n totalNanoAiu?: number;\n /**\n * Session-wide per-token-type accumulated token counts\n */\n tokenDetails?: {\n [k: string]: UsageMetricsTokenDetail;\n };\n /**\n * Total time spent in model API calls (milliseconds)\n */\n totalApiDurationMs: number;\n /**\n * Session start timestamp (epoch milliseconds)\n */\n sessionStartTime: number;\n codeChanges: UsageMetricsCodeChanges;\n /**\n * Per-model token and request metrics, keyed by model identifier\n */\n modelMetrics: {\n [k: string]: UsageMetricsModelMetric;\n };\n /**\n * Currently active model identifier\n */\n currentModel?: string;\n /**\n * Input tokens from the most recent main-agent API call\n */\n lastCallInputTokens: number;\n /**\n * Output tokens from the most recent main-agent API call\n */\n lastCallOutputTokens: number;\n}\n\nexport interface UsageMetricsTokenDetail {\n /**\n * Accumulated token count for this token type\n */\n tokenCount: number;\n}\n/**\n * Aggregated code change metrics\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"UsageMetricsCodeChanges\".\n */\nexport interface UsageMetricsCodeChanges {\n /**\n * Total lines of code added\n */\n linesAdded: number;\n /**\n * Total lines of code removed\n */\n linesRemoved: number;\n /**\n * Number of distinct files modified\n */\n filesModifiedCount: number;\n}\n\nexport interface UsageMetricsModelMetric {\n requests: UsageMetricsModelMetricRequests;\n usage: UsageMetricsModelMetricUsage;\n /**\n * Accumulated nano-AI units cost for this model\n */\n totalNanoAiu?: number;\n /**\n * Token count details per type\n */\n tokenDetails?: {\n [k: string]: UsageMetricsModelMetricTokenDetail;\n };\n}\n/**\n * Request count and cost metrics for this model\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"UsageMetricsModelMetricRequests\".\n */\nexport interface UsageMetricsModelMetricRequests {\n /**\n * Number of API requests made with this model\n */\n count: number;\n /**\n * User-initiated premium request cost (with multiplier applied)\n */\n cost: number;\n}\n/**\n * Token usage metrics for this model\n *\n * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema\n * via the `definition` \"UsageMetricsModelMetricUsage\".\n */\nexport interface UsageMetricsModelMetricUsage {\n /**\n * Total input tokens consumed\n */\n inputTokens: number;\n /**\n * Total output tokens produced\n */\n outputTokens: number;\n /**\n * Total tokens read from prompt cache\n */\n cacheReadTokens: number;\n /**\n * Total tokens written to prompt cache\n */\n cacheWriteTokens: number;\n /**\n * Total output tokens used for reasoning\n */\n reasoningTokens?: number;\n}\n\nexport interface UsageMetricsModelMetricTokenDetail {\n /**\n * Accumulated token count for this token type\n */\n tokenCount: number;\n}\n\nexport interface WorkspacesCreateFileRequest {\n /**\n * Relative path within the workspace files directory\n */\n path: string;\n /**\n * File content to write as a UTF-8 string\n */\n content: string;\n}\n\nexport interface WorkspacesGetWorkspaceResult {\n /**\n * Current workspace metadata, or null if not available\n */\n workspace: {\n id: string;\n cwd?: string;\n git_root?: string;\n repository?: string;\n host_type?: \"github\" | \"ado\";\n branch?: string;\n name?: string;\n user_named?: boolean;\n summary?: string;\n summary_count?: number;\n created_at?: string;\n updated_at?: string;\n remote_steerable?: boolean;\n mc_task_id?: string;\n mc_session_id?: string;\n mc_last_event_id?: string;\n session_sync_level?: \"local\" | \"user\" | \"repo_and_user\";\n chronicle_sync_dismissed?: boolean;\n } | null;\n}\n\nexport interface WorkspacesListFilesResult {\n /**\n * Relative file paths in the workspace files directory\n */\n files: string[];\n}\n\nexport interface WorkspacesReadFileRequest {\n /**\n * Relative path within the workspace files directory\n */\n path: string;\n}\n\nexport interface WorkspacesReadFileResult {\n /**\n * File content as a UTF-8 string\n */\n content: string;\n}\n\n/** Create typed server-scoped RPC methods (no session required). */\nexport function createServerRpc(connection: MessageConnection) {\n return {\n ping: async (params: PingRequest): Promise =>\n connection.sendRequest(\"ping\", params),\n models: {\n list: async (params?: ModelsListRequest): Promise =>\n connection.sendRequest(\"models.list\", params),\n },\n tools: {\n list: async (params: ToolsListRequest): Promise =>\n connection.sendRequest(\"tools.list\", params),\n },\n account: {\n getQuota: async (params?: AccountGetQuotaRequest): Promise =>\n connection.sendRequest(\"account.getQuota\", params),\n },\n mcp: {\n config: {\n list: async (): Promise =>\n connection.sendRequest(\"mcp.config.list\", {}),\n add: async (params: McpConfigAddRequest): Promise =>\n connection.sendRequest(\"mcp.config.add\", params),\n update: async (params: McpConfigUpdateRequest): Promise =>\n connection.sendRequest(\"mcp.config.update\", params),\n remove: async (params: McpConfigRemoveRequest): Promise =>\n connection.sendRequest(\"mcp.config.remove\", params),\n enable: async (params: McpConfigEnableRequest): Promise =>\n connection.sendRequest(\"mcp.config.enable\", params),\n disable: async (params: McpConfigDisableRequest): Promise =>\n connection.sendRequest(\"mcp.config.disable\", params),\n },\n discover: async (params: McpDiscoverRequest): Promise =>\n connection.sendRequest(\"mcp.discover\", params),\n },\n skills: {\n config: {\n setDisabledSkills: async (params: SkillsConfigSetDisabledSkillsRequest): Promise =>\n connection.sendRequest(\"skills.config.setDisabledSkills\", params),\n },\n discover: async (params: SkillsDiscoverRequest): Promise =>\n connection.sendRequest(\"skills.discover\", params),\n },\n sessionFs: {\n setProvider: async (params: SessionFsSetProviderRequest): Promise =>\n connection.sendRequest(\"sessionFs.setProvider\", params),\n },\n /** @experimental */\n sessions: {\n fork: async (params: SessionsForkRequest): Promise =>\n connection.sendRequest(\"sessions.fork\", params),\n },\n };\n}\n\n/** Create typed session-scoped RPC methods. */\nexport function createSessionRpc(connection: MessageConnection, sessionId: string) {\n return {\n suspend: async (): Promise =>\n connection.sendRequest(\"session.suspend\", { sessionId }),\n auth: {\n getStatus: async (): Promise =>\n connection.sendRequest(\"session.auth.getStatus\", { sessionId }),\n },\n model: {\n getCurrent: async (): Promise =>\n connection.sendRequest(\"session.model.getCurrent\", { sessionId }),\n switchTo: async (params: ModelSwitchToRequest): Promise =>\n connection.sendRequest(\"session.model.switchTo\", { sessionId, ...params }),\n },\n mode: {\n get: async (): Promise =>\n connection.sendRequest(\"session.mode.get\", { sessionId }),\n set: async (params: ModeSetRequest): Promise =>\n connection.sendRequest(\"session.mode.set\", { sessionId, ...params }),\n },\n name: {\n get: async (): Promise =>\n connection.sendRequest(\"session.name.get\", { sessionId }),\n set: async (params: NameSetRequest): Promise =>\n connection.sendRequest(\"session.name.set\", { sessionId, ...params }),\n },\n plan: {\n read: async (): Promise =>\n connection.sendRequest(\"session.plan.read\", { sessionId }),\n update: async (params: PlanUpdateRequest): Promise =>\n connection.sendRequest(\"session.plan.update\", { sessionId, ...params }),\n delete: async (): Promise =>\n connection.sendRequest(\"session.plan.delete\", { sessionId }),\n },\n workspaces: {\n getWorkspace: async (): Promise =>\n connection.sendRequest(\"session.workspaces.getWorkspace\", { sessionId }),\n listFiles: async (): Promise =>\n connection.sendRequest(\"session.workspaces.listFiles\", { sessionId }),\n readFile: async (params: WorkspacesReadFileRequest): Promise =>\n connection.sendRequest(\"session.workspaces.readFile\", { sessionId, ...params }),\n createFile: async (params: WorkspacesCreateFileRequest): Promise =>\n connection.sendRequest(\"session.workspaces.createFile\", { sessionId, ...params }),\n },\n instructions: {\n getSources: async (): Promise =>\n connection.sendRequest(\"session.instructions.getSources\", { sessionId }),\n },\n /** @experimental */\n fleet: {\n start: async (params: FleetStartRequest): Promise =>\n connection.sendRequest(\"session.fleet.start\", { sessionId, ...params }),\n },\n /** @experimental */\n agent: {\n list: async (): Promise =>\n connection.sendRequest(\"session.agent.list\", { sessionId }),\n getCurrent: async (): Promise =>\n connection.sendRequest(\"session.agent.getCurrent\", { sessionId }),\n select: async (params: AgentSelectRequest): Promise =>\n connection.sendRequest(\"session.agent.select\", { sessionId, ...params }),\n deselect: async (): Promise =>\n connection.sendRequest(\"session.agent.deselect\", { sessionId }),\n reload: async (): Promise =>\n connection.sendRequest(\"session.agent.reload\", { sessionId }),\n },\n /** @experimental */\n tasks: {\n startAgent: async (params: TasksStartAgentRequest): Promise =>\n connection.sendRequest(\"session.tasks.startAgent\", { sessionId, ...params }),\n list: async (): Promise =>\n connection.sendRequest(\"session.tasks.list\", { sessionId }),\n promoteToBackground: async (params: TasksPromoteToBackgroundRequest): Promise =>\n connection.sendRequest(\"session.tasks.promoteToBackground\", { sessionId, ...params }),\n cancel: async (params: TasksCancelRequest): Promise =>\n connection.sendRequest(\"session.tasks.cancel\", { sessionId, ...params }),\n remove: async (params: TasksRemoveRequest): Promise =>\n connection.sendRequest(\"session.tasks.remove\", { sessionId, ...params }),\n },\n /** @experimental */\n skills: {\n list: async (): Promise =>\n connection.sendRequest(\"session.skills.list\", { sessionId }),\n enable: async (params: SkillsEnableRequest): Promise =>\n connection.sendRequest(\"session.skills.enable\", { sessionId, ...params }),\n disable: async (params: SkillsDisableRequest): Promise =>\n connection.sendRequest(\"session.skills.disable\", { sessionId, ...params }),\n reload: async (): Promise =>\n connection.sendRequest(\"session.skills.reload\", { sessionId }),\n },\n /** @experimental */\n mcp: {\n list: async (): Promise =>\n connection.sendRequest(\"session.mcp.list\", { sessionId }),\n enable: async (params: McpEnableRequest): Promise =>\n connection.sendRequest(\"session.mcp.enable\", { sessionId, ...params }),\n disable: async (params: McpDisableRequest): Promise =>\n connection.sendRequest(\"session.mcp.disable\", { sessionId, ...params }),\n reload: async (): Promise =>\n connection.sendRequest(\"session.mcp.reload\", { sessionId }),\n /** @experimental */\n oauth: {\n login: async (params: McpOauthLoginRequest): Promise =>\n connection.sendRequest(\"session.mcp.oauth.login\", { sessionId, ...params }),\n },\n },\n /** @experimental */\n plugins: {\n list: async (): Promise =>\n connection.sendRequest(\"session.plugins.list\", { sessionId }),\n },\n /** @experimental */\n extensions: {\n list: async (): Promise =>\n connection.sendRequest(\"session.extensions.list\", { sessionId }),\n enable: async (params: ExtensionsEnableRequest): Promise =>\n connection.sendRequest(\"session.extensions.enable\", { sessionId, ...params }),\n disable: async (params: ExtensionsDisableRequest): Promise =>\n connection.sendRequest(\"session.extensions.disable\", { sessionId, ...params }),\n reload: async (): Promise =>\n connection.sendRequest(\"session.extensions.reload\", { sessionId }),\n },\n tools: {\n handlePendingToolCall: async (params: HandlePendingToolCallRequest): Promise =>\n connection.sendRequest(\"session.tools.handlePendingToolCall\", { sessionId, ...params }),\n },\n commands: {\n handlePendingCommand: async (params: CommandsHandlePendingCommandRequest): Promise =>\n connection.sendRequest(\"session.commands.handlePendingCommand\", { sessionId, ...params }),\n },\n ui: {\n elicitation: async (params: UIElicitationRequest): Promise =>\n connection.sendRequest(\"session.ui.elicitation\", { sessionId, ...params }),\n handlePendingElicitation: async (params: UIHandlePendingElicitationRequest): Promise =>\n connection.sendRequest(\"session.ui.handlePendingElicitation\", { sessionId, ...params }),\n },\n permissions: {\n handlePendingPermissionRequest: async (params: PermissionDecisionRequest): Promise =>\n connection.sendRequest(\"session.permissions.handlePendingPermissionRequest\", { sessionId, ...params }),\n setApproveAll: async (params: PermissionsSetApproveAllRequest): Promise =>\n connection.sendRequest(\"session.permissions.setApproveAll\", { sessionId, ...params }),\n resetSessionApprovals: async (): Promise =>\n connection.sendRequest(\"session.permissions.resetSessionApprovals\", { sessionId }),\n },\n log: async (params: LogRequest): Promise =>\n connection.sendRequest(\"session.log\", { sessionId, ...params }),\n shell: {\n exec: async (params: ShellExecRequest): Promise =>\n connection.sendRequest(\"session.shell.exec\", { sessionId, ...params }),\n kill: async (params: ShellKillRequest): Promise =>\n connection.sendRequest(\"session.shell.kill\", { sessionId, ...params }),\n },\n /** @experimental */\n history: {\n compact: async (): Promise =>\n connection.sendRequest(\"session.history.compact\", { sessionId }),\n truncate: async (params: HistoryTruncateRequest): Promise =>\n connection.sendRequest(\"session.history.truncate\", { sessionId, ...params }),\n },\n /** @experimental */\n usage: {\n getMetrics: async (): Promise =>\n connection.sendRequest(\"session.usage.getMetrics\", { sessionId }),\n },\n };\n}\n\n/** Handler for `sessionFs` client session API methods. */\nexport interface SessionFsHandler {\n readFile(params: SessionFsReadFileRequest): Promise;\n writeFile(params: SessionFsWriteFileRequest): Promise;\n appendFile(params: SessionFsAppendFileRequest): Promise;\n exists(params: SessionFsExistsRequest): Promise;\n stat(params: SessionFsStatRequest): Promise;\n mkdir(params: SessionFsMkdirRequest): Promise;\n readdir(params: SessionFsReaddirRequest): Promise;\n readdirWithTypes(params: SessionFsReaddirWithTypesRequest): Promise;\n rm(params: SessionFsRmRequest): Promise;\n rename(params: SessionFsRenameRequest): Promise;\n}\n\n/** All client session API handler groups. */\nexport interface ClientSessionApiHandlers {\n sessionFs?: SessionFsHandler;\n}\n\n/**\n * Register client session API handlers on a JSON-RPC connection.\n * The server calls these methods to delegate work to the client.\n * Each incoming call includes a `sessionId` in the params; the registration\n * function uses `getHandlers` to resolve the session's handlers.\n */\nexport function registerClientSessionApiHandlers(\n connection: MessageConnection,\n getHandlers: (sessionId: string) => ClientSessionApiHandlers,\n): void {\n connection.onRequest(\"sessionFs.readFile\", async (params: SessionFsReadFileRequest) => {\n const handler = getHandlers(params.sessionId).sessionFs;\n if (!handler) throw new Error(`No sessionFs handler registered for session: ${params.sessionId}`);\n return handler.readFile(params);\n });\n connection.onRequest(\"sessionFs.writeFile\", async (params: SessionFsWriteFileRequest) => {\n const handler = getHandlers(params.sessionId).sessionFs;\n if (!handler) throw new Error(`No sessionFs handler registered for session: ${params.sessionId}`);\n return handler.writeFile(params);\n });\n connection.onRequest(\"sessionFs.appendFile\", async (params: SessionFsAppendFileRequest) => {\n const handler = getHandlers(params.sessionId).sessionFs;\n if (!handler) throw new Error(`No sessionFs handler registered for session: ${params.sessionId}`);\n return handler.appendFile(params);\n });\n connection.onRequest(\"sessionFs.exists\", async (params: SessionFsExistsRequest) => {\n const handler = getHandlers(params.sessionId).sessionFs;\n if (!handler) throw new Error(`No sessionFs handler registered for session: ${params.sessionId}`);\n return handler.exists(params);\n });\n connection.onRequest(\"sessionFs.stat\", async (params: SessionFsStatRequest) => {\n const handler = getHandlers(params.sessionId).sessionFs;\n if (!handler) throw new Error(`No sessionFs handler registered for session: ${params.sessionId}`);\n return handler.stat(params);\n });\n connection.onRequest(\"sessionFs.mkdir\", async (params: SessionFsMkdirRequest) => {\n const handler = getHandlers(params.sessionId).sessionFs;\n if (!handler) throw new Error(`No sessionFs handler registered for session: ${params.sessionId}`);\n return handler.mkdir(params);\n });\n connection.onRequest(\"sessionFs.readdir\", async (params: SessionFsReaddirRequest) => {\n const handler = getHandlers(params.sessionId).sessionFs;\n if (!handler) throw new Error(`No sessionFs handler registered for session: ${params.sessionId}`);\n return handler.readdir(params);\n });\n connection.onRequest(\"sessionFs.readdirWithTypes\", async (params: SessionFsReaddirWithTypesRequest) => {\n const handler = getHandlers(params.sessionId).sessionFs;\n if (!handler) throw new Error(`No sessionFs handler registered for session: ${params.sessionId}`);\n return handler.readdirWithTypes(params);\n });\n connection.onRequest(\"sessionFs.rm\", async (params: SessionFsRmRequest) => {\n const handler = getHandlers(params.sessionId).sessionFs;\n if (!handler) throw new Error(`No sessionFs handler registered for session: ${params.sessionId}`);\n return handler.rm(params);\n });\n connection.onRequest(\"sessionFs.rename\", async (params: SessionFsRenameRequest) => {\n const handler = getHandlers(params.sessionId).sessionFs;\n if (!handler) throw new Error(`No sessionFs handler registered for session: ${params.sessionId}`);\n return handler.rename(params);\n });\n}\n" }, { "path": "nodejs/src/generated/session-events.ts", "content": "/**\n * AUTO-GENERATED FILE - DO NOT EDIT\n * Generated from: session-events.schema.json\n */\n\nexport type SessionEvent =\n | StartEvent\n | ResumeEvent\n | RemoteSteerableChangedEvent\n | ErrorEvent\n | IdleEvent\n | TitleChangedEvent\n | InfoEvent\n | WarningEvent\n | ModelChangeEvent\n | ModeChangedEvent\n | PlanChangedEvent\n | WorkspaceFileChangedEvent\n | HandoffEvent\n | TruncationEvent\n | SnapshotRewindEvent\n | ShutdownEvent\n | ContextChangedEvent\n | UsageInfoEvent\n | CompactionStartEvent\n | CompactionCompleteEvent\n | TaskCompleteEvent\n | UserMessageEvent\n | PendingMessagesModifiedEvent\n | AssistantTurnStartEvent\n | AssistantIntentEvent\n | AssistantReasoningEvent\n | AssistantReasoningDeltaEvent\n | AssistantStreamingDeltaEvent\n | AssistantMessageEvent\n | AssistantMessageStartEvent\n | AssistantMessageDeltaEvent\n | AssistantTurnEndEvent\n | AssistantUsageEvent\n | ModelCallFailureEvent\n | AbortEvent\n | ToolUserRequestedEvent\n | ToolExecutionStartEvent\n | ToolExecutionPartialResultEvent\n | ToolExecutionProgressEvent\n | ToolExecutionCompleteEvent\n | SkillInvokedEvent\n | SubagentStartedEvent\n | SubagentCompletedEvent\n | SubagentFailedEvent\n | SubagentSelectedEvent\n | SubagentDeselectedEvent\n | HookStartEvent\n | HookEndEvent\n | SystemMessageEvent\n | SystemNotificationEvent\n | PermissionRequestedEvent\n | PermissionCompletedEvent\n | UserInputRequestedEvent\n | UserInputCompletedEvent\n | ElicitationRequestedEvent\n | ElicitationCompletedEvent\n | SamplingRequestedEvent\n | SamplingCompletedEvent\n | McpOauthRequiredEvent\n | McpOauthCompletedEvent\n | ExternalToolRequestedEvent\n | ExternalToolCompletedEvent\n | CommandQueuedEvent\n | CommandExecuteEvent\n | CommandCompletedEvent\n | AutoModeSwitchRequestedEvent\n | AutoModeSwitchCompletedEvent\n | CommandsChangedEvent\n | CapabilitiesChangedEvent\n | ExitPlanModeRequestedEvent\n | ExitPlanModeCompletedEvent\n | ToolsUpdatedEvent\n | BackgroundTasksChangedEvent\n | SkillsLoadedEvent\n | CustomAgentsUpdatedEvent\n | McpServersLoadedEvent\n | McpServerStatusChangedEvent\n | ExtensionsLoadedEvent;\n/**\n * Hosting platform type of the repository (github or ado)\n */\nexport type WorkingDirectoryContextHostType = \"github\" | \"ado\";\n/**\n * The type of operation performed on the plan file\n */\nexport type PlanChangedOperation = \"create\" | \"update\" | \"delete\";\n/**\n * Whether the file was newly created or updated\n */\nexport type WorkspaceFileChangedOperation = \"create\" | \"update\";\n/**\n * Origin type of the session being handed off\n */\nexport type HandoffSourceType = \"remote\" | \"local\";\n/**\n * Whether the session ended normally (\"routine\") or due to a crash/fatal error (\"error\")\n */\nexport type ShutdownType = \"routine\" | \"error\";\n/**\n * The agent mode that was active when this message was sent\n */\nexport type UserMessageAgentMode = \"interactive\" | \"plan\" | \"autopilot\" | \"shell\";\n/**\n * A user message attachment — a file, directory, code selection, blob, or GitHub reference\n */\nexport type UserMessageAttachment =\n | UserMessageAttachmentFile\n | UserMessageAttachmentDirectory\n | UserMessageAttachmentSelection\n | UserMessageAttachmentGithubReference\n | UserMessageAttachmentBlob;\n/**\n * Type of GitHub reference\n */\nexport type UserMessageAttachmentGithubReferenceType = \"issue\" | \"pr\" | \"discussion\";\n/**\n * Tool call type: \"function\" for standard tool calls, \"custom\" for grammar-based tool calls. Defaults to \"function\" when absent.\n */\nexport type AssistantMessageToolRequestType = \"function\" | \"custom\";\n/**\n * Where the failed model call originated\n */\nexport type ModelCallFailureSource = \"top_level\" | \"subagent\" | \"mcp_sampling\";\n/**\n * A content block within a tool result, which may be text, terminal output, image, audio, or a resource\n */\nexport type ToolExecutionCompleteContent =\n | ToolExecutionCompleteContentText\n | ToolExecutionCompleteContentTerminal\n | ToolExecutionCompleteContentImage\n | ToolExecutionCompleteContentAudio\n | ToolExecutionCompleteContentResourceLink\n | ToolExecutionCompleteContentResource;\n/**\n * Theme variant this icon is intended for\n */\nexport type ToolExecutionCompleteContentResourceLinkIconTheme = \"light\" | \"dark\";\n/**\n * The embedded resource contents, either text or base64-encoded binary\n */\nexport type ToolExecutionCompleteContentResourceDetails = EmbeddedTextResourceContents | EmbeddedBlobResourceContents;\n/**\n * Message role: \"system\" for system prompts, \"developer\" for developer-injected instructions\n */\nexport type SystemMessageRole = \"system\" | \"developer\";\n/**\n * Structured metadata identifying what triggered this notification\n */\nexport type SystemNotification =\n | SystemNotificationAgentCompleted\n | SystemNotificationAgentIdle\n | SystemNotificationNewInboxMessage\n | SystemNotificationShellCompleted\n | SystemNotificationShellDetachedCompleted\n | SystemNotificationInstructionDiscovered;\n/**\n * Whether the agent completed successfully or failed\n */\nexport type SystemNotificationAgentCompletedStatus = \"completed\" | \"failed\";\n/**\n * Details of the permission being requested\n */\nexport type PermissionRequest =\n | PermissionRequestShell\n | PermissionRequestWrite\n | PermissionRequestRead\n | PermissionRequestMcp\n | PermissionRequestUrl\n | PermissionRequestMemory\n | PermissionRequestCustomTool\n | PermissionRequestHook;\n/**\n * Whether this is a store or vote memory operation\n */\nexport type PermissionRequestMemoryAction = \"store\" | \"vote\";\n/**\n * Vote direction (vote only)\n */\nexport type PermissionRequestMemoryDirection = \"upvote\" | \"downvote\";\n/**\n * Derived user-facing permission prompt details for UI consumers\n */\nexport type PermissionPromptRequest =\n | PermissionPromptRequestCommands\n | PermissionPromptRequestWrite\n | PermissionPromptRequestRead\n | PermissionPromptRequestMcp\n | PermissionPromptRequestUrl\n | PermissionPromptRequestMemory\n | PermissionPromptRequestCustomTool\n | PermissionPromptRequestPath\n | PermissionPromptRequestHook;\n/**\n * Whether this is a store or vote memory operation\n */\nexport type PermissionPromptRequestMemoryAction = \"store\" | \"vote\";\n/**\n * Vote direction (vote only)\n */\nexport type PermissionPromptRequestMemoryDirection = \"upvote\" | \"downvote\";\n/**\n * Underlying permission kind that needs path approval\n */\nexport type PermissionPromptRequestPathAccessKind = \"read\" | \"shell\" | \"write\";\n/**\n * The result of the permission request\n */\nexport type PermissionResult =\n | PermissionApproved\n | PermissionApprovedForSession\n | PermissionApprovedForLocation\n | PermissionCancelled\n | PermissionDeniedByRules\n | PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser\n | PermissionDeniedInteractivelyByUser\n | PermissionDeniedByContentExclusionPolicy\n | PermissionDeniedByPermissionRequestHook;\n/**\n * The approval to add as a session-scoped rule\n */\nexport type UserToolSessionApproval =\n | UserToolSessionApprovalCommands\n | UserToolSessionApprovalRead\n | UserToolSessionApprovalWrite\n | UserToolSessionApprovalMcp\n | UserToolSessionApprovalMemory\n | UserToolSessionApprovalCustomTool;\n/**\n * Elicitation mode; \"form\" for structured input, \"url\" for browser-based. Defaults to \"form\" when absent.\n */\nexport type ElicitationRequestedMode = \"form\" | \"url\";\n/**\n * The user action: \"accept\" (submitted form), \"decline\" (explicitly refused), or \"cancel\" (dismissed)\n */\nexport type ElicitationCompletedAction = \"accept\" | \"decline\" | \"cancel\";\nexport type ElicitationCompletedContent = string | number | boolean | string[];\n/**\n * Connection status: connected, failed, needs-auth, pending, disabled, or not_configured\n */\nexport type McpServersLoadedServerStatus =\n | \"connected\"\n | \"failed\"\n | \"needs-auth\"\n | \"pending\"\n | \"disabled\"\n | \"not_configured\";\n/**\n * New connection status: connected, failed, needs-auth, pending, disabled, or not_configured\n */\nexport type McpServerStatusChangedStatus =\n | \"connected\"\n | \"failed\"\n | \"needs-auth\"\n | \"pending\"\n | \"disabled\"\n | \"not_configured\";\n/**\n * Discovery source\n */\nexport type ExtensionsLoadedExtensionSource = \"project\" | \"user\";\n/**\n * Current status: running, disabled, failed, or starting\n */\nexport type ExtensionsLoadedExtensionStatus = \"running\" | \"disabled\" | \"failed\" | \"starting\";\n\nexport interface StartEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: StartData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.start\";\n}\n/**\n * Session initialization metadata including context and configuration\n */\nexport interface StartData {\n /**\n * Whether the session was already in use by another client at start time\n */\n alreadyInUse?: boolean;\n context?: WorkingDirectoryContext;\n /**\n * Version string of the Copilot application\n */\n copilotVersion: string;\n /**\n * Identifier of the software producing the events (e.g., \"copilot-agent\")\n */\n producer: string;\n /**\n * Reasoning effort level used for model calls, if applicable (e.g. \"low\", \"medium\", \"high\", \"xhigh\")\n */\n reasoningEffort?: string;\n /**\n * Whether this session supports remote steering via Mission Control\n */\n remoteSteerable?: boolean;\n /**\n * Model selected at session creation time, if any\n */\n selectedModel?: string;\n /**\n * Unique identifier for the session\n */\n sessionId: string;\n /**\n * ISO 8601 timestamp when the session was created\n */\n startTime: string;\n /**\n * Schema version number for the session event format\n */\n version: number;\n}\n/**\n * Working directory and git context at session start\n */\nexport interface WorkingDirectoryContext {\n /**\n * Base commit of current git branch at session start time\n */\n baseCommit?: string;\n /**\n * Current git branch name\n */\n branch?: string;\n /**\n * Current working directory path\n */\n cwd: string;\n /**\n * Root directory of the git repository, resolved via git rev-parse\n */\n gitRoot?: string;\n /**\n * Head commit of current git branch at session start time\n */\n headCommit?: string;\n hostType?: WorkingDirectoryContextHostType;\n /**\n * Repository identifier derived from the git remote URL (\"owner/name\" for GitHub, \"org/project/repo\" for Azure DevOps)\n */\n repository?: string;\n /**\n * Raw host string from the git remote URL (e.g. \"github.com\", \"mycompany.ghe.com\", \"dev.azure.com\")\n */\n repositoryHost?: string;\n}\nexport interface ResumeEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: ResumeData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.resume\";\n}\n/**\n * Session resume metadata including current context and event count\n */\nexport interface ResumeData {\n /**\n * Whether the session was already in use by another client at resume time\n */\n alreadyInUse?: boolean;\n context?: WorkingDirectoryContext;\n /**\n * When true, tool calls and permission requests left in flight by the previous session lifetime remain pending after resume and the agentic loop awaits their results. User sends are queued behind the pending work until all such requests reach a terminal state. When false (the default), any such tool calls and permission requests are immediately marked as interrupted on resume.\n */\n continuePendingWork?: boolean;\n /**\n * Total number of persisted events in the session at the time of resume\n */\n eventCount: number;\n /**\n * Reasoning effort level used for model calls, if applicable (e.g. \"low\", \"medium\", \"high\", \"xhigh\")\n */\n reasoningEffort?: string;\n /**\n * Whether this session supports remote steering via Mission Control\n */\n remoteSteerable?: boolean;\n /**\n * ISO 8601 timestamp when the session was resumed\n */\n resumeTime: string;\n /**\n * Model currently selected at resume time\n */\n selectedModel?: string;\n /**\n * True when this resume attached to a session that the runtime already had running in-memory (for example, an extension joining a session another client was actively driving). False (or omitted) for cold resumes — the runtime had to reconstitute the session from its persisted event log.\n */\n sessionWasActive?: boolean;\n}\nexport interface RemoteSteerableChangedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: RemoteSteerableChangedData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.remote_steerable_changed\";\n}\n/**\n * Notifies Mission Control that the session's remote steering capability has changed\n */\nexport interface RemoteSteerableChangedData {\n /**\n * Whether this session now supports remote steering via Mission Control\n */\n remoteSteerable: boolean;\n}\nexport interface ErrorEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: ErrorData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.error\";\n}\n/**\n * Error details for timeline display including message and optional diagnostic information\n */\nexport interface ErrorData {\n /**\n * Only set on `errorType: \"rate_limit\"`. When `true`, the runtime will follow this error with an `auto_mode_switch.requested` event (or silently switch if `continueOnAutoMode` is enabled). UI clients can use this flag to suppress duplicate rendering of the rate-limit error when they show their own auto-mode-switch prompt.\n */\n eligibleForAutoSwitch?: boolean;\n /**\n * Fine-grained error code from the upstream provider, when available. For `errorType: \"rate_limit\"`, this is one of the `RateLimitErrorCode` values (e.g., `\"user_weekly_rate_limited\"`, `\"user_global_rate_limited\"`, `\"rate_limited\"`, `\"user_model_rate_limited\"`, `\"integration_rate_limited\"`).\n */\n errorCode?: string;\n /**\n * Category of error (e.g., \"authentication\", \"authorization\", \"quota\", \"rate_limit\", \"context_limit\", \"query\")\n */\n errorType: string;\n /**\n * Human-readable error message\n */\n message: string;\n /**\n * GitHub request tracing ID (x-github-request-id header) for correlating with server-side logs\n */\n providerCallId?: string;\n /**\n * Error stack trace, when available\n */\n stack?: string;\n /**\n * HTTP status code from the upstream request, if applicable\n */\n statusCode?: number;\n /**\n * Optional URL associated with this error that the user can open in a browser\n */\n url?: string;\n}\nexport interface IdleEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: IdleData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.idle\";\n}\n/**\n * Payload indicating the session is idle with no background agents in flight\n */\nexport interface IdleData {\n /**\n * True when the preceding agentic loop was cancelled via abort signal\n */\n aborted?: boolean;\n}\nexport interface TitleChangedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: TitleChangedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.title_changed\";\n}\n/**\n * Session title change payload containing the new display title\n */\nexport interface TitleChangedData {\n /**\n * The new display title for the session\n */\n title: string;\n}\nexport interface InfoEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: InfoData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.info\";\n}\n/**\n * Informational message for timeline display with categorization\n */\nexport interface InfoData {\n /**\n * Category of informational message (e.g., \"notification\", \"timing\", \"context_window\", \"mcp\", \"snapshot\", \"configuration\", \"authentication\", \"model\")\n */\n infoType: string;\n /**\n * Human-readable informational message for display in the timeline\n */\n message: string;\n /**\n * Optional actionable tip displayed with this message\n */\n tip?: string;\n /**\n * Optional URL associated with this message that the user can open in a browser\n */\n url?: string;\n}\nexport interface WarningEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: WarningData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.warning\";\n}\n/**\n * Warning message for timeline display with categorization\n */\nexport interface WarningData {\n /**\n * Human-readable warning message for display in the timeline\n */\n message: string;\n /**\n * Optional URL associated with this warning that the user can open in a browser\n */\n url?: string;\n /**\n * Category of warning (e.g., \"subscription\", \"policy\", \"mcp\")\n */\n warningType: string;\n}\nexport interface ModelChangeEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: ModelChangeData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.model_change\";\n}\n/**\n * Model change details including previous and new model identifiers\n */\nexport interface ModelChangeData {\n /**\n * Reason the change happened, when not user-initiated. Currently `\"rate_limit_auto_switch\"` for changes triggered by the auto-mode-switch rate-limit recovery path. UI clients can use this to render contextual copy.\n */\n cause?: string;\n /**\n * Newly selected model identifier\n */\n newModel: string;\n /**\n * Model that was previously selected, if any\n */\n previousModel?: string;\n /**\n * Reasoning effort level before the model change, if applicable\n */\n previousReasoningEffort?: string;\n /**\n * Reasoning effort level after the model change, if applicable\n */\n reasoningEffort?: string;\n}\nexport interface ModeChangedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: ModeChangedData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.mode_changed\";\n}\n/**\n * Agent mode change details including previous and new modes\n */\nexport interface ModeChangedData {\n /**\n * Agent mode after the change (e.g., \"interactive\", \"plan\", \"autopilot\")\n */\n newMode: string;\n /**\n * Agent mode before the change (e.g., \"interactive\", \"plan\", \"autopilot\")\n */\n previousMode: string;\n}\nexport interface PlanChangedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: PlanChangedData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.plan_changed\";\n}\n/**\n * Plan file operation details indicating what changed\n */\nexport interface PlanChangedData {\n operation: PlanChangedOperation;\n}\nexport interface WorkspaceFileChangedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: WorkspaceFileChangedData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.workspace_file_changed\";\n}\n/**\n * Workspace file change details including path and operation type\n */\nexport interface WorkspaceFileChangedData {\n operation: WorkspaceFileChangedOperation;\n /**\n * Relative path within the session workspace files directory\n */\n path: string;\n}\nexport interface HandoffEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: HandoffData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.handoff\";\n}\n/**\n * Session handoff metadata including source, context, and repository information\n */\nexport interface HandoffData {\n /**\n * Additional context information for the handoff\n */\n context?: string;\n /**\n * ISO 8601 timestamp when the handoff occurred\n */\n handoffTime: string;\n /**\n * GitHub host URL for the source session (e.g., https://github.com or https://tenant.ghe.com)\n */\n host?: string;\n /**\n * Session ID of the remote session being handed off\n */\n remoteSessionId?: string;\n repository?: HandoffRepository;\n sourceType: HandoffSourceType;\n /**\n * Summary of the work done in the source session\n */\n summary?: string;\n}\n/**\n * Repository context for the handed-off session\n */\nexport interface HandoffRepository {\n /**\n * Git branch name, if applicable\n */\n branch?: string;\n /**\n * Repository name\n */\n name: string;\n /**\n * Repository owner (user or organization)\n */\n owner: string;\n}\nexport interface TruncationEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: TruncationData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.truncation\";\n}\n/**\n * Conversation truncation statistics including token counts and removed content metrics\n */\nexport interface TruncationData {\n /**\n * Number of messages removed by truncation\n */\n messagesRemovedDuringTruncation: number;\n /**\n * Identifier of the component that performed truncation (e.g., \"BasicTruncator\")\n */\n performedBy: string;\n /**\n * Number of conversation messages after truncation\n */\n postTruncationMessagesLength: number;\n /**\n * Total tokens in conversation messages after truncation\n */\n postTruncationTokensInMessages: number;\n /**\n * Number of conversation messages before truncation\n */\n preTruncationMessagesLength: number;\n /**\n * Total tokens in conversation messages before truncation\n */\n preTruncationTokensInMessages: number;\n /**\n * Maximum token count for the model's context window\n */\n tokenLimit: number;\n /**\n * Number of tokens removed by truncation\n */\n tokensRemovedDuringTruncation: number;\n}\nexport interface SnapshotRewindEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: SnapshotRewindData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.snapshot_rewind\";\n}\n/**\n * Session rewind details including target event and count of removed events\n */\nexport interface SnapshotRewindData {\n /**\n * Number of events that were removed by the rewind\n */\n eventsRemoved: number;\n /**\n * Event ID that was rewound to; this event and all after it were removed\n */\n upToEventId: string;\n}\nexport interface ShutdownEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: ShutdownData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.shutdown\";\n}\n/**\n * Session termination metrics including usage statistics, code changes, and shutdown reason\n */\nexport interface ShutdownData {\n codeChanges: ShutdownCodeChanges;\n /**\n * Non-system message token count at shutdown\n */\n conversationTokens?: number;\n /**\n * Model that was selected at the time of shutdown\n */\n currentModel?: string;\n /**\n * Total tokens in context window at shutdown\n */\n currentTokens?: number;\n /**\n * Error description when shutdownType is \"error\"\n */\n errorReason?: string;\n /**\n * Per-model usage breakdown, keyed by model identifier\n */\n modelMetrics: {\n [k: string]: ShutdownModelMetric;\n };\n /**\n * Unix timestamp (milliseconds) when the session started\n */\n sessionStartTime: number;\n shutdownType: ShutdownType;\n /**\n * System message token count at shutdown\n */\n systemTokens?: number;\n /**\n * Session-wide per-token-type accumulated token counts\n */\n tokenDetails?: {\n [k: string]: ShutdownTokenDetail;\n };\n /**\n * Tool definitions token count at shutdown\n */\n toolDefinitionsTokens?: number;\n /**\n * Cumulative time spent in API calls during the session, in milliseconds\n */\n totalApiDurationMs: number;\n /**\n * Session-wide accumulated nano-AI units cost\n */\n totalNanoAiu?: number;\n /**\n * Total number of premium API requests used during the session\n */\n totalPremiumRequests: number;\n}\n/**\n * Aggregate code change metrics for the session\n */\nexport interface ShutdownCodeChanges {\n /**\n * List of file paths that were modified during the session\n */\n filesModified: string[];\n /**\n * Total number of lines added during the session\n */\n linesAdded: number;\n /**\n * Total number of lines removed during the session\n */\n linesRemoved: number;\n}\nexport interface ShutdownModelMetric {\n requests: ShutdownModelMetricRequests;\n /**\n * Token count details per type\n */\n tokenDetails?: {\n [k: string]: ShutdownModelMetricTokenDetail;\n };\n /**\n * Accumulated nano-AI units cost for this model\n */\n totalNanoAiu?: number;\n usage: ShutdownModelMetricUsage;\n}\n/**\n * Request count and cost metrics\n */\nexport interface ShutdownModelMetricRequests {\n /**\n * Cumulative cost multiplier for requests to this model\n */\n cost: number;\n /**\n * Total number of API requests made to this model\n */\n count: number;\n}\nexport interface ShutdownModelMetricTokenDetail {\n /**\n * Accumulated token count for this token type\n */\n tokenCount: number;\n}\n/**\n * Token usage breakdown\n */\nexport interface ShutdownModelMetricUsage {\n /**\n * Total tokens read from prompt cache across all requests\n */\n cacheReadTokens: number;\n /**\n * Total tokens written to prompt cache across all requests\n */\n cacheWriteTokens: number;\n /**\n * Total input tokens consumed across all requests to this model\n */\n inputTokens: number;\n /**\n * Total output tokens produced across all requests to this model\n */\n outputTokens: number;\n /**\n * Total reasoning tokens produced across all requests to this model\n */\n reasoningTokens?: number;\n}\nexport interface ShutdownTokenDetail {\n /**\n * Accumulated token count for this token type\n */\n tokenCount: number;\n}\nexport interface ContextChangedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: WorkingDirectoryContext;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.context_changed\";\n}\nexport interface UsageInfoEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: UsageInfoData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.usage_info\";\n}\n/**\n * Current context window usage statistics including token and message counts\n */\nexport interface UsageInfoData {\n /**\n * Token count from non-system messages (user, assistant, tool)\n */\n conversationTokens?: number;\n /**\n * Current number of tokens in the context window\n */\n currentTokens: number;\n /**\n * Whether this is the first usage_info event emitted in this session\n */\n isInitial?: boolean;\n /**\n * Current number of messages in the conversation\n */\n messagesLength: number;\n /**\n * Token count from system message(s)\n */\n systemTokens?: number;\n /**\n * Maximum token count for the model's context window\n */\n tokenLimit: number;\n /**\n * Token count from tool definitions\n */\n toolDefinitionsTokens?: number;\n}\nexport interface CompactionStartEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: CompactionStartData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.compaction_start\";\n}\n/**\n * Context window breakdown at the start of LLM-powered conversation compaction\n */\nexport interface CompactionStartData {\n /**\n * Token count from non-system messages (user, assistant, tool) at compaction start\n */\n conversationTokens?: number;\n /**\n * Token count from system message(s) at compaction start\n */\n systemTokens?: number;\n /**\n * Token count from tool definitions at compaction start\n */\n toolDefinitionsTokens?: number;\n}\nexport interface CompactionCompleteEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: CompactionCompleteData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.compaction_complete\";\n}\n/**\n * Conversation compaction results including success status, metrics, and optional error details\n */\nexport interface CompactionCompleteData {\n /**\n * Checkpoint snapshot number created for recovery\n */\n checkpointNumber?: number;\n /**\n * File path where the checkpoint was stored\n */\n checkpointPath?: string;\n compactionTokensUsed?: CompactionCompleteCompactionTokensUsed;\n /**\n * Token count from non-system messages (user, assistant, tool) after compaction\n */\n conversationTokens?: number;\n /**\n * Error message if compaction failed\n */\n error?: string;\n /**\n * Number of messages removed during compaction\n */\n messagesRemoved?: number;\n /**\n * Total tokens in conversation after compaction\n */\n postCompactionTokens?: number;\n /**\n * Number of messages before compaction\n */\n preCompactionMessagesLength?: number;\n /**\n * Total tokens in conversation before compaction\n */\n preCompactionTokens?: number;\n /**\n * GitHub request tracing ID (x-github-request-id header) for the compaction LLM call\n */\n requestId?: string;\n /**\n * Whether compaction completed successfully\n */\n success: boolean;\n /**\n * LLM-generated summary of the compacted conversation history\n */\n summaryContent?: string;\n /**\n * Token count from system message(s) after compaction\n */\n systemTokens?: number;\n /**\n * Number of tokens removed during compaction\n */\n tokensRemoved?: number;\n /**\n * Token count from tool definitions after compaction\n */\n toolDefinitionsTokens?: number;\n}\n/**\n * Token usage breakdown for the compaction LLM call (aligned with assistant.usage format)\n */\nexport interface CompactionCompleteCompactionTokensUsed {\n /**\n * Cached input tokens reused in the compaction LLM call\n */\n cacheReadTokens?: number;\n /**\n * Tokens written to prompt cache in the compaction LLM call\n */\n cacheWriteTokens?: number;\n copilotUsage?: CompactionCompleteCompactionTokensUsedCopilotUsage;\n /**\n * Duration of the compaction LLM call in milliseconds\n */\n duration?: number;\n /**\n * Input tokens consumed by the compaction LLM call\n */\n inputTokens?: number;\n /**\n * Model identifier used for the compaction LLM call\n */\n model?: string;\n /**\n * Output tokens produced by the compaction LLM call\n */\n outputTokens?: number;\n}\n/**\n * Per-request cost and usage data from the CAPI copilot_usage response field\n */\nexport interface CompactionCompleteCompactionTokensUsedCopilotUsage {\n /**\n * Itemized token usage breakdown\n */\n tokenDetails: CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail[];\n /**\n * Total cost in nano-AI units for this request\n */\n totalNanoAiu: number;\n}\n/**\n * Token usage detail for a single billing category\n */\nexport interface CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail {\n /**\n * Number of tokens in this billing batch\n */\n batchSize: number;\n /**\n * Cost per batch of tokens\n */\n costPerBatch: number;\n /**\n * Total token count for this entry\n */\n tokenCount: number;\n /**\n * Token category (e.g., \"input\", \"output\")\n */\n tokenType: string;\n}\nexport interface TaskCompleteEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: TaskCompleteData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.task_complete\";\n}\n/**\n * Task completion notification with summary from the agent\n */\nexport interface TaskCompleteData {\n /**\n * Whether the tool call succeeded. False when validation failed (e.g., invalid arguments)\n */\n success?: boolean;\n /**\n * Summary of the completed task, provided by the agent\n */\n summary?: string;\n}\nexport interface UserMessageEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: UserMessageData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"user.message\";\n}\nexport interface UserMessageData {\n agentMode?: UserMessageAgentMode;\n /**\n * Files, selections, or GitHub references attached to the message\n */\n attachments?: UserMessageAttachment[];\n /**\n * The user's message text as displayed in the timeline\n */\n content: string;\n /**\n * CAPI interaction ID for correlating this user message with its turn\n */\n interactionId?: string;\n /**\n * Path-backed native document attachments that stayed on the tagged_files path flow because native upload would exceed the request size limit\n */\n nativeDocumentPathFallbackPaths?: string[];\n /**\n * Parent agent task ID for background telemetry correlated to this user turn\n */\n parentAgentTaskId?: string;\n /**\n * Origin of this message, used for timeline filtering (e.g., \"skill-pdf\" for skill-injected messages that should be hidden from the user)\n */\n source?: string;\n /**\n * Normalized document MIME types that were sent natively instead of through tagged_files XML\n */\n supportedNativeDocumentMimeTypes?: string[];\n /**\n * Transformed version of the message sent to the model, with XML wrapping, timestamps, and other augmentations for prompt caching\n */\n transformedContent?: string;\n}\n/**\n * File attachment\n */\nexport interface UserMessageAttachmentFile {\n /**\n * User-facing display name for the attachment\n */\n displayName: string;\n lineRange?: UserMessageAttachmentFileLineRange;\n /**\n * Absolute file path\n */\n path: string;\n /**\n * Attachment type discriminator\n */\n type: \"file\";\n}\n/**\n * Optional line range to scope the attachment to a specific section of the file\n */\nexport interface UserMessageAttachmentFileLineRange {\n /**\n * End line number (1-based, inclusive)\n */\n end: number;\n /**\n * Start line number (1-based)\n */\n start: number;\n}\n/**\n * Directory attachment\n */\nexport interface UserMessageAttachmentDirectory {\n /**\n * User-facing display name for the attachment\n */\n displayName: string;\n /**\n * Absolute directory path\n */\n path: string;\n /**\n * Attachment type discriminator\n */\n type: \"directory\";\n}\n/**\n * Code selection attachment from an editor\n */\nexport interface UserMessageAttachmentSelection {\n /**\n * User-facing display name for the selection\n */\n displayName: string;\n /**\n * Absolute path to the file containing the selection\n */\n filePath: string;\n selection: UserMessageAttachmentSelectionDetails;\n /**\n * The selected text content\n */\n text: string;\n /**\n * Attachment type discriminator\n */\n type: \"selection\";\n}\n/**\n * Position range of the selection within the file\n */\nexport interface UserMessageAttachmentSelectionDetails {\n end: UserMessageAttachmentSelectionDetailsEnd;\n start: UserMessageAttachmentSelectionDetailsStart;\n}\n/**\n * End position of the selection\n */\nexport interface UserMessageAttachmentSelectionDetailsEnd {\n /**\n * End character offset within the line (0-based)\n */\n character: number;\n /**\n * End line number (0-based)\n */\n line: number;\n}\n/**\n * Start position of the selection\n */\nexport interface UserMessageAttachmentSelectionDetailsStart {\n /**\n * Start character offset within the line (0-based)\n */\n character: number;\n /**\n * Start line number (0-based)\n */\n line: number;\n}\n/**\n * GitHub issue, pull request, or discussion reference\n */\nexport interface UserMessageAttachmentGithubReference {\n /**\n * Issue, pull request, or discussion number\n */\n number: number;\n referenceType: UserMessageAttachmentGithubReferenceType;\n /**\n * Current state of the referenced item (e.g., open, closed, merged)\n */\n state: string;\n /**\n * Title of the referenced item\n */\n title: string;\n /**\n * Attachment type discriminator\n */\n type: \"github_reference\";\n /**\n * URL to the referenced item on GitHub\n */\n url: string;\n}\n/**\n * Blob attachment with inline base64-encoded data\n */\nexport interface UserMessageAttachmentBlob {\n /**\n * Base64-encoded content\n */\n data: string;\n /**\n * User-facing display name for the attachment\n */\n displayName?: string;\n /**\n * MIME type of the inline data\n */\n mimeType: string;\n /**\n * Attachment type discriminator\n */\n type: \"blob\";\n}\nexport interface PendingMessagesModifiedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: PendingMessagesModifiedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"pending_messages.modified\";\n}\n/**\n * Empty payload; the event signals that the pending message queue has changed\n */\nexport interface PendingMessagesModifiedData {}\nexport interface AssistantTurnStartEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: AssistantTurnStartData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"assistant.turn_start\";\n}\n/**\n * Turn initialization metadata including identifier and interaction tracking\n */\nexport interface AssistantTurnStartData {\n /**\n * CAPI interaction ID for correlating this turn with upstream telemetry\n */\n interactionId?: string;\n /**\n * Identifier for this turn within the agentic loop, typically a stringified turn number\n */\n turnId: string;\n}\nexport interface AssistantIntentEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: AssistantIntentData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"assistant.intent\";\n}\n/**\n * Agent intent description for current activity or plan\n */\nexport interface AssistantIntentData {\n /**\n * Short description of what the agent is currently doing or planning to do\n */\n intent: string;\n}\nexport interface AssistantReasoningEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: AssistantReasoningData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"assistant.reasoning\";\n}\n/**\n * Assistant reasoning content for timeline display with complete thinking text\n */\nexport interface AssistantReasoningData {\n /**\n * The complete extended thinking text from the model\n */\n content: string;\n /**\n * Unique identifier for this reasoning block\n */\n reasoningId: string;\n}\nexport interface AssistantReasoningDeltaEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: AssistantReasoningDeltaData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"assistant.reasoning_delta\";\n}\n/**\n * Streaming reasoning delta for incremental extended thinking updates\n */\nexport interface AssistantReasoningDeltaData {\n /**\n * Incremental text chunk to append to the reasoning content\n */\n deltaContent: string;\n /**\n * Reasoning block ID this delta belongs to, matching the corresponding assistant.reasoning event\n */\n reasoningId: string;\n}\nexport interface AssistantStreamingDeltaEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: AssistantStreamingDeltaData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"assistant.streaming_delta\";\n}\n/**\n * Streaming response progress with cumulative byte count\n */\nexport interface AssistantStreamingDeltaData {\n /**\n * Cumulative total bytes received from the streaming response so far\n */\n totalResponseSizeBytes: number;\n}\nexport interface AssistantMessageEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: AssistantMessageData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"assistant.message\";\n}\n/**\n * Assistant response containing text content, optional tool requests, and interaction metadata\n */\nexport interface AssistantMessageData {\n /**\n * The assistant's text response content\n */\n content: string;\n /**\n * Encrypted reasoning content from OpenAI models. Session-bound and stripped on resume.\n */\n encryptedContent?: string;\n /**\n * CAPI interaction ID for correlating this message with upstream telemetry\n */\n interactionId?: string;\n /**\n * Unique identifier for this assistant message\n */\n messageId: string;\n /**\n * Actual output token count from the API response (completion_tokens), used for accurate token accounting\n */\n outputTokens?: number;\n /**\n * @deprecated\n * Tool call ID of the parent tool invocation when this event originates from a sub-agent\n */\n parentToolCallId?: string;\n /**\n * Generation phase for phased-output models (e.g., thinking vs. response phases)\n */\n phase?: string;\n /**\n * Opaque/encrypted extended thinking data from Anthropic models. Session-bound and stripped on resume.\n */\n reasoningOpaque?: string;\n /**\n * Readable reasoning text from the model's extended thinking\n */\n reasoningText?: string;\n /**\n * GitHub request tracing ID (x-github-request-id header) for correlating with server-side logs\n */\n requestId?: string;\n /**\n * Tool invocations requested by the assistant in this message\n */\n toolRequests?: AssistantMessageToolRequest[];\n /**\n * Identifier for the agent loop turn that produced this message, matching the corresponding assistant.turn_start event\n */\n turnId?: string;\n}\n/**\n * A tool invocation request from the assistant\n */\nexport interface AssistantMessageToolRequest {\n /**\n * Arguments to pass to the tool, format depends on the tool\n */\n arguments?: {\n [k: string]: unknown;\n };\n /**\n * Resolved intention summary describing what this specific call does\n */\n intentionSummary?: string | null;\n /**\n * Name of the MCP server hosting this tool, when the tool is an MCP tool\n */\n mcpServerName?: string;\n /**\n * Name of the tool being invoked\n */\n name: string;\n /**\n * Unique identifier for this tool call\n */\n toolCallId: string;\n /**\n * Human-readable display title for the tool\n */\n toolTitle?: string;\n type?: AssistantMessageToolRequestType;\n}\nexport interface AssistantMessageStartEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: AssistantMessageStartData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"assistant.message_start\";\n}\n/**\n * Streaming assistant message start metadata\n */\nexport interface AssistantMessageStartData {\n /**\n * Message ID this start event belongs to, matching subsequent deltas and assistant.message\n */\n messageId: string;\n /**\n * Generation phase this message belongs to for phased-output models\n */\n phase?: string;\n}\nexport interface AssistantMessageDeltaEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: AssistantMessageDeltaData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"assistant.message_delta\";\n}\n/**\n * Streaming assistant message delta for incremental response updates\n */\nexport interface AssistantMessageDeltaData {\n /**\n * Incremental text chunk to append to the message content\n */\n deltaContent: string;\n /**\n * Message ID this delta belongs to, matching the corresponding assistant.message event\n */\n messageId: string;\n /**\n * @deprecated\n * Tool call ID of the parent tool invocation when this event originates from a sub-agent\n */\n parentToolCallId?: string;\n}\nexport interface AssistantTurnEndEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: AssistantTurnEndData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"assistant.turn_end\";\n}\n/**\n * Turn completion metadata including the turn identifier\n */\nexport interface AssistantTurnEndData {\n /**\n * Identifier of the turn that has ended, matching the corresponding assistant.turn_start event\n */\n turnId: string;\n}\nexport interface AssistantUsageEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: AssistantUsageData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"assistant.usage\";\n}\n/**\n * LLM API call usage metrics including tokens, costs, quotas, and billing information\n */\nexport interface AssistantUsageData {\n /**\n * Completion ID from the model provider (e.g., chatcmpl-abc123)\n */\n apiCallId?: string;\n /**\n * Number of tokens read from prompt cache\n */\n cacheReadTokens?: number;\n /**\n * Number of tokens written to prompt cache\n */\n cacheWriteTokens?: number;\n copilotUsage?: AssistantUsageCopilotUsage;\n /**\n * Model multiplier cost for billing purposes\n */\n cost?: number;\n /**\n * Duration of the API call in milliseconds\n */\n duration?: number;\n /**\n * What initiated this API call (e.g., \"sub-agent\", \"mcp-sampling\"); absent for user-initiated calls\n */\n initiator?: string;\n /**\n * Number of input tokens consumed\n */\n inputTokens?: number;\n /**\n * Average inter-token latency in milliseconds. Only available for streaming requests\n */\n interTokenLatencyMs?: number;\n /**\n * Model identifier used for this API call\n */\n model: string;\n /**\n * Number of output tokens produced\n */\n outputTokens?: number;\n /**\n * @deprecated\n * Parent tool call ID when this usage originates from a sub-agent\n */\n parentToolCallId?: string;\n /**\n * GitHub request tracing ID (x-github-request-id header) for server-side log correlation\n */\n providerCallId?: string;\n /**\n * Per-quota resource usage snapshots, keyed by quota identifier\n */\n quotaSnapshots?: {\n [k: string]: AssistantUsageQuotaSnapshot;\n };\n /**\n * Reasoning effort level used for model calls, if applicable (e.g. \"low\", \"medium\", \"high\", \"xhigh\")\n */\n reasoningEffort?: string;\n /**\n * Number of output tokens used for reasoning (e.g., chain-of-thought)\n */\n reasoningTokens?: number;\n /**\n * Time to first token in milliseconds. Only available for streaming requests\n */\n ttftMs?: number;\n}\n/**\n * Per-request cost and usage data from the CAPI copilot_usage response field\n */\nexport interface AssistantUsageCopilotUsage {\n /**\n * Itemized token usage breakdown\n */\n tokenDetails: AssistantUsageCopilotUsageTokenDetail[];\n /**\n * Total cost in nano-AI units for this request\n */\n totalNanoAiu: number;\n}\n/**\n * Token usage detail for a single billing category\n */\nexport interface AssistantUsageCopilotUsageTokenDetail {\n /**\n * Number of tokens in this billing batch\n */\n batchSize: number;\n /**\n * Cost per batch of tokens\n */\n costPerBatch: number;\n /**\n * Total token count for this entry\n */\n tokenCount: number;\n /**\n * Token category (e.g., \"input\", \"output\")\n */\n tokenType: string;\n}\nexport interface AssistantUsageQuotaSnapshot {\n /**\n * Total requests allowed by the entitlement\n */\n entitlementRequests: number;\n /**\n * Whether the user has an unlimited usage entitlement\n */\n isUnlimitedEntitlement: boolean;\n /**\n * Number of requests over the entitlement limit\n */\n overage: number;\n /**\n * Whether overage is allowed when quota is exhausted\n */\n overageAllowedWithExhaustedQuota: boolean;\n /**\n * Percentage of quota remaining (0.0 to 1.0)\n */\n remainingPercentage: number;\n /**\n * Date when the quota resets\n */\n resetDate?: string;\n /**\n * Whether usage is still permitted after quota exhaustion\n */\n usageAllowedWithExhaustedQuota: boolean;\n /**\n * Number of requests already consumed\n */\n usedRequests: number;\n}\nexport interface ModelCallFailureEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: ModelCallFailureData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"model.call_failure\";\n}\n/**\n * Failed LLM API call metadata for telemetry\n */\nexport interface ModelCallFailureData {\n /**\n * Completion ID from the model provider (e.g., chatcmpl-abc123)\n */\n apiCallId?: string;\n /**\n * Duration of the failed API call in milliseconds\n */\n durationMs?: number;\n /**\n * Raw provider/runtime error message for restricted telemetry\n */\n errorMessage?: string;\n /**\n * What initiated this API call (e.g., \"sub-agent\", \"mcp-sampling\"); absent for user-initiated calls\n */\n initiator?: string;\n /**\n * Model identifier used for the failed API call\n */\n model?: string;\n /**\n * GitHub request tracing ID (x-github-request-id header) for server-side log correlation\n */\n providerCallId?: string;\n source: ModelCallFailureSource;\n /**\n * HTTP status code from the failed request\n */\n statusCode?: number;\n}\nexport interface AbortEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: AbortData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"abort\";\n}\n/**\n * Turn abort information including the reason for termination\n */\nexport interface AbortData {\n /**\n * Reason the current turn was aborted (e.g., \"user initiated\")\n */\n reason: string;\n}\nexport interface ToolUserRequestedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: ToolUserRequestedData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"tool.user_requested\";\n}\n/**\n * User-initiated tool invocation request with tool name and arguments\n */\nexport interface ToolUserRequestedData {\n /**\n * Arguments for the tool invocation\n */\n arguments?: {\n [k: string]: unknown;\n };\n /**\n * Unique identifier for this tool call\n */\n toolCallId: string;\n /**\n * Name of the tool the user wants to invoke\n */\n toolName: string;\n}\nexport interface ToolExecutionStartEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: ToolExecutionStartData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"tool.execution_start\";\n}\n/**\n * Tool execution startup details including MCP server information when applicable\n */\nexport interface ToolExecutionStartData {\n /**\n * Arguments passed to the tool\n */\n arguments?: {\n [k: string]: unknown;\n };\n /**\n * Name of the MCP server hosting this tool, when the tool is an MCP tool\n */\n mcpServerName?: string;\n /**\n * Original tool name on the MCP server, when the tool is an MCP tool\n */\n mcpToolName?: string;\n /**\n * @deprecated\n * Tool call ID of the parent tool invocation when this event originates from a sub-agent\n */\n parentToolCallId?: string;\n /**\n * Unique identifier for this tool call\n */\n toolCallId: string;\n /**\n * Name of the tool being executed\n */\n toolName: string;\n /**\n * Identifier for the agent loop turn this tool was invoked in, matching the corresponding assistant.turn_start event\n */\n turnId?: string;\n}\nexport interface ToolExecutionPartialResultEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: ToolExecutionPartialData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"tool.execution_partial_result\";\n}\n/**\n * Streaming tool execution output for incremental result display\n */\nexport interface ToolExecutionPartialData {\n /**\n * Incremental output chunk from the running tool\n */\n partialOutput: string;\n /**\n * Tool call ID this partial result belongs to\n */\n toolCallId: string;\n}\nexport interface ToolExecutionProgressEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: ToolExecutionProgressData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"tool.execution_progress\";\n}\n/**\n * Tool execution progress notification with status message\n */\nexport interface ToolExecutionProgressData {\n /**\n * Human-readable progress status message (e.g., from an MCP server)\n */\n progressMessage: string;\n /**\n * Tool call ID this progress notification belongs to\n */\n toolCallId: string;\n}\nexport interface ToolExecutionCompleteEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: ToolExecutionCompleteData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"tool.execution_complete\";\n}\n/**\n * Tool execution completion results including success status, detailed output, and error information\n */\nexport interface ToolExecutionCompleteData {\n error?: ToolExecutionCompleteError;\n /**\n * CAPI interaction ID for correlating this tool execution with upstream telemetry\n */\n interactionId?: string;\n /**\n * Whether this tool call was explicitly requested by the user rather than the assistant\n */\n isUserRequested?: boolean;\n /**\n * Model identifier that generated this tool call\n */\n model?: string;\n /**\n * @deprecated\n * Tool call ID of the parent tool invocation when this event originates from a sub-agent\n */\n parentToolCallId?: string;\n result?: ToolExecutionCompleteResult;\n /**\n * Whether the tool execution completed successfully\n */\n success: boolean;\n /**\n * Unique identifier for the completed tool call\n */\n toolCallId: string;\n /**\n * Tool-specific telemetry data (e.g., CodeQL check counts, grep match counts)\n */\n toolTelemetry?: {\n [k: string]: unknown;\n };\n /**\n * Identifier for the agent loop turn this tool was invoked in, matching the corresponding assistant.turn_start event\n */\n turnId?: string;\n}\n/**\n * Error details when the tool execution failed\n */\nexport interface ToolExecutionCompleteError {\n /**\n * Machine-readable error code\n */\n code?: string;\n /**\n * Human-readable error message\n */\n message: string;\n}\n/**\n * Tool execution result on success\n */\nexport interface ToolExecutionCompleteResult {\n /**\n * Concise tool result text sent to the LLM for chat completion, potentially truncated for token efficiency\n */\n content: string;\n /**\n * Structured content blocks (text, images, audio, resources) returned by the tool in their native format\n */\n contents?: ToolExecutionCompleteContent[];\n /**\n * Full detailed tool result for UI/timeline display, preserving complete content such as diffs. Falls back to content when absent.\n */\n detailedContent?: string;\n}\n/**\n * Plain text content block\n */\nexport interface ToolExecutionCompleteContentText {\n /**\n * The text content\n */\n text: string;\n /**\n * Content block type discriminator\n */\n type: \"text\";\n}\n/**\n * Terminal/shell output content block with optional exit code and working directory\n */\nexport interface ToolExecutionCompleteContentTerminal {\n /**\n * Working directory where the command was executed\n */\n cwd?: string;\n /**\n * Process exit code, if the command has completed\n */\n exitCode?: number;\n /**\n * Terminal/shell output text\n */\n text: string;\n /**\n * Content block type discriminator\n */\n type: \"terminal\";\n}\n/**\n * Image content block with base64-encoded data\n */\nexport interface ToolExecutionCompleteContentImage {\n /**\n * Base64-encoded image data\n */\n data: string;\n /**\n * MIME type of the image (e.g., image/png, image/jpeg)\n */\n mimeType: string;\n /**\n * Content block type discriminator\n */\n type: \"image\";\n}\n/**\n * Audio content block with base64-encoded data\n */\nexport interface ToolExecutionCompleteContentAudio {\n /**\n * Base64-encoded audio data\n */\n data: string;\n /**\n * MIME type of the audio (e.g., audio/wav, audio/mpeg)\n */\n mimeType: string;\n /**\n * Content block type discriminator\n */\n type: \"audio\";\n}\n/**\n * Resource link content block referencing an external resource\n */\nexport interface ToolExecutionCompleteContentResourceLink {\n /**\n * Human-readable description of the resource\n */\n description?: string;\n /**\n * Icons associated with this resource\n */\n icons?: ToolExecutionCompleteContentResourceLinkIcon[];\n /**\n * MIME type of the resource content\n */\n mimeType?: string;\n /**\n * Resource name identifier\n */\n name: string;\n /**\n * Size of the resource in bytes\n */\n size?: number;\n /**\n * Human-readable display title for the resource\n */\n title?: string;\n /**\n * Content block type discriminator\n */\n type: \"resource_link\";\n /**\n * URI identifying the resource\n */\n uri: string;\n}\n/**\n * Icon image for a resource\n */\nexport interface ToolExecutionCompleteContentResourceLinkIcon {\n /**\n * MIME type of the icon image\n */\n mimeType?: string;\n /**\n * Available icon sizes (e.g., ['16x16', '32x32'])\n */\n sizes?: string[];\n /**\n * URL or path to the icon image\n */\n src: string;\n theme?: ToolExecutionCompleteContentResourceLinkIconTheme;\n}\n/**\n * Embedded resource content block with inline text or binary data\n */\nexport interface ToolExecutionCompleteContentResource {\n resource: ToolExecutionCompleteContentResourceDetails;\n /**\n * Content block type discriminator\n */\n type: \"resource\";\n}\nexport interface EmbeddedTextResourceContents {\n /**\n * MIME type of the text content\n */\n mimeType?: string;\n /**\n * Text content of the resource\n */\n text: string;\n /**\n * URI identifying the resource\n */\n uri: string;\n}\nexport interface EmbeddedBlobResourceContents {\n /**\n * Base64-encoded binary content of the resource\n */\n blob: string;\n /**\n * MIME type of the blob content\n */\n mimeType?: string;\n /**\n * URI identifying the resource\n */\n uri: string;\n}\nexport interface SkillInvokedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: SkillInvokedData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"skill.invoked\";\n}\n/**\n * Skill invocation details including content, allowed tools, and plugin metadata\n */\nexport interface SkillInvokedData {\n /**\n * Tool names that should be auto-approved when this skill is active\n */\n allowedTools?: string[];\n /**\n * Full content of the skill file, injected into the conversation for the model\n */\n content: string;\n /**\n * Description of the skill from its SKILL.md frontmatter\n */\n description?: string;\n /**\n * Name of the invoked skill\n */\n name: string;\n /**\n * File path to the SKILL.md definition\n */\n path: string;\n /**\n * Name of the plugin this skill originated from, when applicable\n */\n pluginName?: string;\n /**\n * Version of the plugin this skill originated from, when applicable\n */\n pluginVersion?: string;\n}\nexport interface SubagentStartedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: SubagentStartedData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"subagent.started\";\n}\n/**\n * Sub-agent startup details including parent tool call and agent information\n */\nexport interface SubagentStartedData {\n /**\n * Description of what the sub-agent does\n */\n agentDescription: string;\n /**\n * Human-readable display name of the sub-agent\n */\n agentDisplayName: string;\n /**\n * Internal name of the sub-agent\n */\n agentName: string;\n /**\n * Tool call ID of the parent tool invocation that spawned this sub-agent\n */\n toolCallId: string;\n}\nexport interface SubagentCompletedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: SubagentCompletedData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"subagent.completed\";\n}\n/**\n * Sub-agent completion details for successful execution\n */\nexport interface SubagentCompletedData {\n /**\n * Human-readable display name of the sub-agent\n */\n agentDisplayName: string;\n /**\n * Internal name of the sub-agent\n */\n agentName: string;\n /**\n * Wall-clock duration of the sub-agent execution in milliseconds\n */\n durationMs?: number;\n /**\n * Model used by the sub-agent\n */\n model?: string;\n /**\n * Tool call ID of the parent tool invocation that spawned this sub-agent\n */\n toolCallId: string;\n /**\n * Total tokens (input + output) consumed by the sub-agent\n */\n totalTokens?: number;\n /**\n * Total number of tool calls made by the sub-agent\n */\n totalToolCalls?: number;\n}\nexport interface SubagentFailedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: SubagentFailedData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"subagent.failed\";\n}\n/**\n * Sub-agent failure details including error message and agent information\n */\nexport interface SubagentFailedData {\n /**\n * Human-readable display name of the sub-agent\n */\n agentDisplayName: string;\n /**\n * Internal name of the sub-agent\n */\n agentName: string;\n /**\n * Wall-clock duration of the sub-agent execution in milliseconds\n */\n durationMs?: number;\n /**\n * Error message describing why the sub-agent failed\n */\n error: string;\n /**\n * Model used by the sub-agent (if any model calls succeeded before failure)\n */\n model?: string;\n /**\n * Tool call ID of the parent tool invocation that spawned this sub-agent\n */\n toolCallId: string;\n /**\n * Total tokens (input + output) consumed before the sub-agent failed\n */\n totalTokens?: number;\n /**\n * Total number of tool calls made before the sub-agent failed\n */\n totalToolCalls?: number;\n}\nexport interface SubagentSelectedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: SubagentSelectedData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"subagent.selected\";\n}\n/**\n * Custom agent selection details including name and available tools\n */\nexport interface SubagentSelectedData {\n /**\n * Human-readable display name of the selected custom agent\n */\n agentDisplayName: string;\n /**\n * Internal name of the selected custom agent\n */\n agentName: string;\n /**\n * List of tool names available to this agent, or null for all tools\n */\n tools: string[] | null;\n}\nexport interface SubagentDeselectedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: SubagentDeselectedData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"subagent.deselected\";\n}\n/**\n * Empty payload; the event signals that the custom agent was deselected, returning to the default agent\n */\nexport interface SubagentDeselectedData {}\nexport interface HookStartEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: HookStartData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"hook.start\";\n}\n/**\n * Hook invocation start details including type and input data\n */\nexport interface HookStartData {\n /**\n * Unique identifier for this hook invocation\n */\n hookInvocationId: string;\n /**\n * Type of hook being invoked (e.g., \"preToolUse\", \"postToolUse\", \"sessionStart\")\n */\n hookType: string;\n /**\n * Input data passed to the hook\n */\n input?: {\n [k: string]: unknown;\n };\n}\nexport interface HookEndEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: HookEndData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"hook.end\";\n}\n/**\n * Hook invocation completion details including output, success status, and error information\n */\nexport interface HookEndData {\n error?: HookEndError;\n /**\n * Identifier matching the corresponding hook.start event\n */\n hookInvocationId: string;\n /**\n * Type of hook that was invoked (e.g., \"preToolUse\", \"postToolUse\", \"sessionStart\")\n */\n hookType: string;\n /**\n * Output data produced by the hook\n */\n output?: {\n [k: string]: unknown;\n };\n /**\n * Whether the hook completed successfully\n */\n success: boolean;\n}\n/**\n * Error details when the hook failed\n */\nexport interface HookEndError {\n /**\n * Human-readable error message\n */\n message: string;\n /**\n * Error stack trace, when available\n */\n stack?: string;\n}\nexport interface SystemMessageEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: SystemMessageData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"system.message\";\n}\n/**\n * System/developer instruction content with role and optional template metadata\n */\nexport interface SystemMessageData {\n /**\n * The system or developer prompt text sent as model input\n */\n content: string;\n metadata?: SystemMessageMetadata;\n /**\n * Optional name identifier for the message source\n */\n name?: string;\n role: SystemMessageRole;\n}\n/**\n * Metadata about the prompt template and its construction\n */\nexport interface SystemMessageMetadata {\n /**\n * Version identifier of the prompt template used\n */\n promptVersion?: string;\n /**\n * Template variables used when constructing the prompt\n */\n variables?: {\n [k: string]: unknown;\n };\n}\nexport interface SystemNotificationEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: SystemNotificationData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"system.notification\";\n}\n/**\n * System-generated notification for runtime events like background task completion\n */\nexport interface SystemNotificationData {\n /**\n * The notification text, typically wrapped in XML tags\n */\n content: string;\n kind: SystemNotification;\n}\nexport interface SystemNotificationAgentCompleted {\n /**\n * Unique identifier of the background agent\n */\n agentId: string;\n /**\n * Type of the agent (e.g., explore, task, general-purpose)\n */\n agentType: string;\n /**\n * Human-readable description of the agent task\n */\n description?: string;\n /**\n * The full prompt given to the background agent\n */\n prompt?: string;\n status: SystemNotificationAgentCompletedStatus;\n type: \"agent_completed\";\n}\nexport interface SystemNotificationAgentIdle {\n /**\n * Unique identifier of the background agent\n */\n agentId: string;\n /**\n * Type of the agent (e.g., explore, task, general-purpose)\n */\n agentType: string;\n /**\n * Human-readable description of the agent task\n */\n description?: string;\n type: \"agent_idle\";\n}\nexport interface SystemNotificationNewInboxMessage {\n /**\n * Unique identifier of the inbox entry\n */\n entryId: string;\n /**\n * Human-readable name of the sender\n */\n senderName: string;\n /**\n * Category of the sender (e.g., sidekick-agent, plugin, hook)\n */\n senderType: string;\n /**\n * Short summary shown before the agent decides whether to read the inbox\n */\n summary: string;\n type: \"new_inbox_message\";\n}\nexport interface SystemNotificationShellCompleted {\n /**\n * Human-readable description of the command\n */\n description?: string;\n /**\n * Exit code of the shell command, if available\n */\n exitCode?: number;\n /**\n * Unique identifier of the shell session\n */\n shellId: string;\n type: \"shell_completed\";\n}\nexport interface SystemNotificationShellDetachedCompleted {\n /**\n * Human-readable description of the command\n */\n description?: string;\n /**\n * Unique identifier of the detached shell session\n */\n shellId: string;\n type: \"shell_detached_completed\";\n}\nexport interface SystemNotificationInstructionDiscovered {\n /**\n * Human-readable label for the timeline (e.g., 'AGENTS.md from packages/billing/')\n */\n description?: string;\n /**\n * Relative path to the discovered instruction file\n */\n sourcePath: string;\n /**\n * Path of the file access that triggered discovery\n */\n triggerFile: string;\n /**\n * Tool command that triggered discovery (currently always 'view')\n */\n triggerTool: string;\n type: \"instruction_discovered\";\n}\nexport interface PermissionRequestedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: PermissionRequestedData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"permission.requested\";\n}\n/**\n * Permission request notification requiring client approval with request details\n */\nexport interface PermissionRequestedData {\n permissionRequest: PermissionRequest;\n promptRequest?: PermissionPromptRequest;\n /**\n * Unique identifier for this permission request; used to respond via session.respondToPermission()\n */\n requestId: string;\n /**\n * When true, this permission was already resolved by a permissionRequest hook and requires no client action\n */\n resolvedByHook?: boolean;\n}\n/**\n * Shell command permission request\n */\nexport interface PermissionRequestShell {\n /**\n * Whether the UI can offer session-wide approval for this command pattern\n */\n canOfferSessionApproval: boolean;\n /**\n * Parsed command identifiers found in the command text\n */\n commands: PermissionRequestShellCommand[];\n /**\n * The complete shell command text to be executed\n */\n fullCommandText: string;\n /**\n * Whether the command includes a file write redirection (e.g., > or >>)\n */\n hasWriteFileRedirection: boolean;\n /**\n * Human-readable description of what the command intends to do\n */\n intention: string;\n /**\n * Permission kind discriminator\n */\n kind: \"shell\";\n /**\n * File paths that may be read or written by the command\n */\n possiblePaths: string[];\n /**\n * URLs that may be accessed by the command\n */\n possibleUrls: PermissionRequestShellPossibleUrl[];\n /**\n * Tool call ID that triggered this permission request\n */\n toolCallId?: string;\n /**\n * Optional warning message about risks of running this command\n */\n warning?: string;\n}\nexport interface PermissionRequestShellCommand {\n /**\n * Command identifier (e.g., executable name)\n */\n identifier: string;\n /**\n * Whether this command is read-only (no side effects)\n */\n readOnly: boolean;\n}\nexport interface PermissionRequestShellPossibleUrl {\n /**\n * URL that may be accessed by the command\n */\n url: string;\n}\n/**\n * File write permission request\n */\nexport interface PermissionRequestWrite {\n /**\n * Whether the UI can offer session-wide approval for file write operations\n */\n canOfferSessionApproval: boolean;\n /**\n * Unified diff showing the proposed changes\n */\n diff: string;\n /**\n * Path of the file being written to\n */\n fileName: string;\n /**\n * Human-readable description of the intended file change\n */\n intention: string;\n /**\n * Permission kind discriminator\n */\n kind: \"write\";\n /**\n * Complete new file contents for newly created files\n */\n newFileContents?: string;\n /**\n * Tool call ID that triggered this permission request\n */\n toolCallId?: string;\n}\n/**\n * File or directory read permission request\n */\nexport interface PermissionRequestRead {\n /**\n * Human-readable description of why the file is being read\n */\n intention: string;\n /**\n * Permission kind discriminator\n */\n kind: \"read\";\n /**\n * Path of the file or directory being read\n */\n path: string;\n /**\n * Tool call ID that triggered this permission request\n */\n toolCallId?: string;\n}\n/**\n * MCP tool invocation permission request\n */\nexport interface PermissionRequestMcp {\n /**\n * Arguments to pass to the MCP tool\n */\n args?: {\n [k: string]: unknown;\n };\n /**\n * Permission kind discriminator\n */\n kind: \"mcp\";\n /**\n * Whether this MCP tool is read-only (no side effects)\n */\n readOnly: boolean;\n /**\n * Name of the MCP server providing the tool\n */\n serverName: string;\n /**\n * Tool call ID that triggered this permission request\n */\n toolCallId?: string;\n /**\n * Internal name of the MCP tool\n */\n toolName: string;\n /**\n * Human-readable title of the MCP tool\n */\n toolTitle: string;\n}\n/**\n * URL access permission request\n */\nexport interface PermissionRequestUrl {\n /**\n * Human-readable description of why the URL is being accessed\n */\n intention: string;\n /**\n * Permission kind discriminator\n */\n kind: \"url\";\n /**\n * Tool call ID that triggered this permission request\n */\n toolCallId?: string;\n /**\n * URL to be fetched\n */\n url: string;\n}\n/**\n * Memory operation permission request\n */\nexport interface PermissionRequestMemory {\n action?: PermissionRequestMemoryAction;\n /**\n * Source references for the stored fact (store only)\n */\n citations?: string;\n direction?: PermissionRequestMemoryDirection;\n /**\n * The fact being stored or voted on\n */\n fact: string;\n /**\n * Permission kind discriminator\n */\n kind: \"memory\";\n /**\n * Reason for the vote (vote only)\n */\n reason?: string;\n /**\n * Topic or subject of the memory (store only)\n */\n subject?: string;\n /**\n * Tool call ID that triggered this permission request\n */\n toolCallId?: string;\n}\n/**\n * Custom tool invocation permission request\n */\nexport interface PermissionRequestCustomTool {\n /**\n * Arguments to pass to the custom tool\n */\n args?: {\n [k: string]: unknown;\n };\n /**\n * Permission kind discriminator\n */\n kind: \"custom-tool\";\n /**\n * Tool call ID that triggered this permission request\n */\n toolCallId?: string;\n /**\n * Description of what the custom tool does\n */\n toolDescription: string;\n /**\n * Name of the custom tool\n */\n toolName: string;\n}\n/**\n * Hook confirmation permission request\n */\nexport interface PermissionRequestHook {\n /**\n * Optional message from the hook explaining why confirmation is needed\n */\n hookMessage?: string;\n /**\n * Permission kind discriminator\n */\n kind: \"hook\";\n /**\n * Arguments of the tool call being gated\n */\n toolArgs?: {\n [k: string]: unknown;\n };\n /**\n * Tool call ID that triggered this permission request\n */\n toolCallId?: string;\n /**\n * Name of the tool the hook is gating\n */\n toolName: string;\n}\n/**\n * Shell command permission prompt\n */\nexport interface PermissionPromptRequestCommands {\n /**\n * Whether the UI can offer session-wide approval for this command pattern\n */\n canOfferSessionApproval: boolean;\n /**\n * Command identifiers covered by this approval prompt\n */\n commandIdentifiers: string[];\n /**\n * The complete shell command text to be executed\n */\n fullCommandText: string;\n /**\n * Human-readable description of what the command intends to do\n */\n intention: string;\n /**\n * Prompt kind discriminator\n */\n kind: \"commands\";\n /**\n * Tool call ID that triggered this permission request\n */\n toolCallId?: string;\n /**\n * Optional warning message about risks of running this command\n */\n warning?: string;\n}\n/**\n * File write permission prompt\n */\nexport interface PermissionPromptRequestWrite {\n /**\n * Whether the UI can offer session-wide approval for file write operations\n */\n canOfferSessionApproval: boolean;\n /**\n * Unified diff showing the proposed changes\n */\n diff: string;\n /**\n * Path of the file being written to\n */\n fileName: string;\n /**\n * Human-readable description of the intended file change\n */\n intention: string;\n /**\n * Prompt kind discriminator\n */\n kind: \"write\";\n /**\n * Complete new file contents for newly created files\n */\n newFileContents?: string;\n /**\n * Tool call ID that triggered this permission request\n */\n toolCallId?: string;\n}\n/**\n * File read permission prompt\n */\nexport interface PermissionPromptRequestRead {\n /**\n * Human-readable description of why the file is being read\n */\n intention: string;\n /**\n * Prompt kind discriminator\n */\n kind: \"read\";\n /**\n * Path of the file or directory being read\n */\n path: string;\n /**\n * Tool call ID that triggered this permission request\n */\n toolCallId?: string;\n}\n/**\n * MCP tool invocation permission prompt\n */\nexport interface PermissionPromptRequestMcp {\n args?: unknown;\n /**\n * Prompt kind discriminator\n */\n kind: \"mcp\";\n /**\n * Name of the MCP server providing the tool\n */\n serverName: string;\n /**\n * Tool call ID that triggered this permission request\n */\n toolCallId?: string;\n /**\n * Internal name of the MCP tool\n */\n toolName: string;\n /**\n * Human-readable title of the MCP tool\n */\n toolTitle: string;\n}\n/**\n * URL access permission prompt\n */\nexport interface PermissionPromptRequestUrl {\n /**\n * Human-readable description of why the URL is being accessed\n */\n intention: string;\n /**\n * Prompt kind discriminator\n */\n kind: \"url\";\n /**\n * Tool call ID that triggered this permission request\n */\n toolCallId?: string;\n /**\n * URL to be fetched\n */\n url: string;\n}\n/**\n * Memory operation permission prompt\n */\nexport interface PermissionPromptRequestMemory {\n action?: PermissionPromptRequestMemoryAction;\n /**\n * Source references for the stored fact (store only)\n */\n citations?: string;\n direction?: PermissionPromptRequestMemoryDirection;\n /**\n * The fact being stored or voted on\n */\n fact: string;\n /**\n * Prompt kind discriminator\n */\n kind: \"memory\";\n /**\n * Reason for the vote (vote only)\n */\n reason?: string;\n /**\n * Topic or subject of the memory (store only)\n */\n subject?: string;\n /**\n * Tool call ID that triggered this permission request\n */\n toolCallId?: string;\n}\n/**\n * Custom tool invocation permission prompt\n */\nexport interface PermissionPromptRequestCustomTool {\n /**\n * Arguments to pass to the custom tool\n */\n args?: {\n [k: string]: unknown;\n };\n /**\n * Prompt kind discriminator\n */\n kind: \"custom-tool\";\n /**\n * Tool call ID that triggered this permission request\n */\n toolCallId?: string;\n /**\n * Description of what the custom tool does\n */\n toolDescription: string;\n /**\n * Name of the custom tool\n */\n toolName: string;\n}\n/**\n * Path access permission prompt\n */\nexport interface PermissionPromptRequestPath {\n accessKind: PermissionPromptRequestPathAccessKind;\n /**\n * Prompt kind discriminator\n */\n kind: \"path\";\n /**\n * File paths that require explicit approval\n */\n paths: string[];\n /**\n * Tool call ID that triggered this permission request\n */\n toolCallId?: string;\n}\n/**\n * Hook confirmation permission prompt\n */\nexport interface PermissionPromptRequestHook {\n /**\n * Optional message from the hook explaining why confirmation is needed\n */\n hookMessage?: string;\n /**\n * Prompt kind discriminator\n */\n kind: \"hook\";\n /**\n * Arguments of the tool call being gated\n */\n toolArgs?: {\n [k: string]: unknown;\n };\n /**\n * Tool call ID that triggered this permission request\n */\n toolCallId?: string;\n /**\n * Name of the tool the hook is gating\n */\n toolName: string;\n}\nexport interface PermissionCompletedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: PermissionCompletedData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"permission.completed\";\n}\n/**\n * Permission request completion notification signaling UI dismissal\n */\nexport interface PermissionCompletedData {\n /**\n * Request ID of the resolved permission request; clients should dismiss any UI for this request\n */\n requestId: string;\n result: PermissionResult;\n /**\n * Optional tool call ID associated with this permission prompt; clients may use it to correlate UI created from tool-scoped prompts\n */\n toolCallId?: string;\n}\nexport interface PermissionApproved {\n /**\n * The permission request was approved\n */\n kind: \"approved\";\n}\nexport interface PermissionApprovedForSession {\n approval: UserToolSessionApproval;\n /**\n * Approved and remembered for the rest of the session\n */\n kind: \"approved-for-session\";\n}\nexport interface UserToolSessionApprovalCommands {\n /**\n * Command identifiers approved by the user\n */\n commandIdentifiers: string[];\n /**\n * Command approval kind\n */\n kind: \"commands\";\n}\nexport interface UserToolSessionApprovalRead {\n /**\n * Read approval kind\n */\n kind: \"read\";\n}\nexport interface UserToolSessionApprovalWrite {\n /**\n * Write approval kind\n */\n kind: \"write\";\n}\nexport interface UserToolSessionApprovalMcp {\n /**\n * MCP tool approval kind\n */\n kind: \"mcp\";\n /**\n * MCP server name\n */\n serverName: string;\n /**\n * Optional MCP tool name, or null for all tools on the server\n */\n toolName: string | null;\n}\nexport interface UserToolSessionApprovalMemory {\n /**\n * Memory approval kind\n */\n kind: \"memory\";\n}\nexport interface UserToolSessionApprovalCustomTool {\n /**\n * Custom tool approval kind\n */\n kind: \"custom-tool\";\n /**\n * Custom tool name\n */\n toolName: string;\n}\nexport interface PermissionApprovedForLocation {\n approval: UserToolSessionApproval;\n /**\n * Approved and persisted for this project location\n */\n kind: \"approved-for-location\";\n /**\n * The location key (git root or cwd) to persist the approval to\n */\n locationKey: string;\n}\nexport interface PermissionCancelled {\n /**\n * The permission request was cancelled before a response was used\n */\n kind: \"cancelled\";\n /**\n * Optional explanation of why the request was cancelled\n */\n reason?: string;\n}\nexport interface PermissionDeniedByRules {\n /**\n * Denied because approval rules explicitly blocked it\n */\n kind: \"denied-by-rules\";\n /**\n * Rules that denied the request\n */\n rules: PermissionRule[];\n}\nexport interface PermissionRule {\n /**\n * Optional rule argument matched against the request\n */\n argument: string | null;\n /**\n * The rule kind, such as Shell or GitHubMCP\n */\n kind: string;\n}\nexport interface PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser {\n /**\n * Denied because no approval rule matched and user confirmation was unavailable\n */\n kind: \"denied-no-approval-rule-and-could-not-request-from-user\";\n}\nexport interface PermissionDeniedInteractivelyByUser {\n /**\n * Optional feedback from the user explaining the denial\n */\n feedback?: string;\n /**\n * Whether to force-reject the current agent turn\n */\n forceReject?: boolean;\n /**\n * Denied by the user during an interactive prompt\n */\n kind: \"denied-interactively-by-user\";\n}\nexport interface PermissionDeniedByContentExclusionPolicy {\n /**\n * Denied by the organization's content exclusion policy\n */\n kind: \"denied-by-content-exclusion-policy\";\n /**\n * Human-readable explanation of why the path was excluded\n */\n message: string;\n /**\n * File path that triggered the exclusion\n */\n path: string;\n}\nexport interface PermissionDeniedByPermissionRequestHook {\n /**\n * Whether to interrupt the current agent turn\n */\n interrupt?: boolean;\n /**\n * Denied by a permission request hook registered by an extension or plugin\n */\n kind: \"denied-by-permission-request-hook\";\n /**\n * Optional message from the hook explaining the denial\n */\n message?: string;\n}\nexport interface UserInputRequestedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: UserInputRequestedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"user_input.requested\";\n}\n/**\n * User input request notification with question and optional predefined choices\n */\nexport interface UserInputRequestedData {\n /**\n * Whether the user can provide a free-form text response in addition to predefined choices\n */\n allowFreeform?: boolean;\n /**\n * Predefined choices for the user to select from, if applicable\n */\n choices?: string[];\n /**\n * The question or prompt to present to the user\n */\n question: string;\n /**\n * Unique identifier for this input request; used to respond via session.respondToUserInput()\n */\n requestId: string;\n /**\n * The LLM-assigned tool call ID that triggered this request; used by remote UIs to correlate responses\n */\n toolCallId?: string;\n}\nexport interface UserInputCompletedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: UserInputCompletedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"user_input.completed\";\n}\n/**\n * User input request completion with the user's response\n */\nexport interface UserInputCompletedData {\n /**\n * The user's answer to the input request\n */\n answer?: string;\n /**\n * Request ID of the resolved user input request; clients should dismiss any UI for this request\n */\n requestId: string;\n /**\n * Whether the answer was typed as free-form text rather than selected from choices\n */\n wasFreeform?: boolean;\n}\nexport interface ElicitationRequestedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: ElicitationRequestedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"elicitation.requested\";\n}\n/**\n * Elicitation request; may be form-based (structured input) or URL-based (browser redirect)\n */\nexport interface ElicitationRequestedData {\n /**\n * The source that initiated the request (MCP server name, or absent for agent-initiated)\n */\n elicitationSource?: string;\n /**\n * Message describing what information is needed from the user\n */\n message: string;\n mode?: ElicitationRequestedMode;\n requestedSchema?: ElicitationRequestedSchema;\n /**\n * Unique identifier for this elicitation request; used to respond via session.respondToElicitation()\n */\n requestId: string;\n /**\n * Tool call ID from the LLM completion; used to correlate with CompletionChunk.toolCall.id for remote UIs\n */\n toolCallId?: string;\n /**\n * URL to open in the user's browser (url mode only)\n */\n url?: string;\n [k: string]: unknown;\n}\n/**\n * JSON Schema describing the form fields to present to the user (form mode only)\n */\nexport interface ElicitationRequestedSchema {\n /**\n * Form field definitions, keyed by field name\n */\n properties: {\n [k: string]: unknown;\n };\n /**\n * List of required field names\n */\n required?: string[];\n /**\n * Schema type indicator (always 'object')\n */\n type: \"object\";\n}\nexport interface ElicitationCompletedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: ElicitationCompletedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"elicitation.completed\";\n}\n/**\n * Elicitation request completion with the user's response\n */\nexport interface ElicitationCompletedData {\n action?: ElicitationCompletedAction;\n /**\n * The submitted form data when action is 'accept'; keys match the requested schema fields\n */\n content?: {\n [k: string]: ElicitationCompletedContent;\n };\n /**\n * Request ID of the resolved elicitation request; clients should dismiss any UI for this request\n */\n requestId: string;\n}\nexport interface SamplingRequestedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: SamplingRequestedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"sampling.requested\";\n}\n/**\n * Sampling request from an MCP server; contains the server name and a requestId for correlation\n */\nexport interface SamplingRequestedData {\n /**\n * The JSON-RPC request ID from the MCP protocol\n */\n mcpRequestId: string | number;\n /**\n * Unique identifier for this sampling request; used to respond via session.respondToSampling()\n */\n requestId: string;\n /**\n * Name of the MCP server that initiated the sampling request\n */\n serverName: string;\n [k: string]: unknown;\n}\nexport interface SamplingCompletedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: SamplingCompletedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"sampling.completed\";\n}\n/**\n * Sampling request completion notification signaling UI dismissal\n */\nexport interface SamplingCompletedData {\n /**\n * Request ID of the resolved sampling request; clients should dismiss any UI for this request\n */\n requestId: string;\n}\nexport interface McpOauthRequiredEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: McpOauthRequiredData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"mcp.oauth_required\";\n}\n/**\n * OAuth authentication request for an MCP server\n */\nexport interface McpOauthRequiredData {\n /**\n * Unique identifier for this OAuth request; used to respond via session.respondToMcpOAuth()\n */\n requestId: string;\n /**\n * Display name of the MCP server that requires OAuth\n */\n serverName: string;\n /**\n * URL of the MCP server that requires OAuth\n */\n serverUrl: string;\n staticClientConfig?: McpOauthRequiredStaticClientConfig;\n}\n/**\n * Static OAuth client configuration, if the server specifies one\n */\nexport interface McpOauthRequiredStaticClientConfig {\n /**\n * OAuth client ID for the server\n */\n clientId: string;\n /**\n * Optional non-default OAuth grant type. When set to 'client_credentials', the OAuth flow runs headlessly using the client_id + keychain-stored secret (no browser, no callback server).\n */\n grantType?: \"client_credentials\";\n /**\n * Whether this is a public OAuth client\n */\n publicClient?: boolean;\n}\nexport interface McpOauthCompletedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: McpOauthCompletedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"mcp.oauth_completed\";\n}\n/**\n * MCP OAuth request completion notification\n */\nexport interface McpOauthCompletedData {\n /**\n * Request ID of the resolved OAuth request\n */\n requestId: string;\n}\nexport interface ExternalToolRequestedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: ExternalToolRequestedData;\n /**\n * When true, the event is transient and not persisted to the session event log on disk\n */\n ephemeral?: boolean;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"external_tool.requested\";\n}\n/**\n * External tool invocation request for client-side tool execution\n */\nexport interface ExternalToolRequestedData {\n /**\n * Arguments to pass to the external tool\n */\n arguments?: {\n [k: string]: unknown;\n };\n /**\n * Unique identifier for this request; used to respond via session.respondToExternalTool()\n */\n requestId: string;\n /**\n * Session ID that this external tool request belongs to\n */\n sessionId: string;\n /**\n * Tool call ID assigned to this external tool invocation\n */\n toolCallId: string;\n /**\n * Name of the external tool to invoke\n */\n toolName: string;\n /**\n * W3C Trace Context traceparent header for the execute_tool span\n */\n traceparent?: string;\n /**\n * W3C Trace Context tracestate header for the execute_tool span\n */\n tracestate?: string;\n}\nexport interface ExternalToolCompletedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: ExternalToolCompletedData;\n ephemeral?: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"external_tool.completed\";\n}\n/**\n * External tool completion notification signaling UI dismissal\n */\nexport interface ExternalToolCompletedData {\n /**\n * Request ID of the resolved external tool request; clients should dismiss any UI for this request\n */\n requestId: string;\n}\nexport interface CommandQueuedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: CommandQueuedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"command.queued\";\n}\n/**\n * Queued slash command dispatch request for client execution\n */\nexport interface CommandQueuedData {\n /**\n * The slash command text to be executed (e.g., /help, /clear)\n */\n command: string;\n /**\n * Unique identifier for this request; used to respond via session.respondToQueuedCommand()\n */\n requestId: string;\n}\nexport interface CommandExecuteEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: CommandExecuteData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"command.execute\";\n}\n/**\n * Registered command dispatch request routed to the owning client\n */\nexport interface CommandExecuteData {\n /**\n * Raw argument string after the command name\n */\n args: string;\n /**\n * The full command text (e.g., /deploy production)\n */\n command: string;\n /**\n * Command name without leading /\n */\n commandName: string;\n /**\n * Unique identifier; used to respond via session.commands.handlePendingCommand()\n */\n requestId: string;\n}\nexport interface CommandCompletedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: CommandCompletedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"command.completed\";\n}\n/**\n * Queued command completion notification signaling UI dismissal\n */\nexport interface CommandCompletedData {\n /**\n * Request ID of the resolved command request; clients should dismiss any UI for this request\n */\n requestId: string;\n}\nexport interface AutoModeSwitchRequestedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: AutoModeSwitchRequestedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"auto_mode_switch.requested\";\n}\n/**\n * Auto mode switch request notification requiring user approval\n */\nexport interface AutoModeSwitchRequestedData {\n /**\n * The rate limit error code that triggered this request\n */\n errorCode?: string;\n /**\n * Unique identifier for this request; used to respond via session.respondToAutoModeSwitch()\n */\n requestId: string;\n /**\n * Seconds until the rate limit resets, when known. Lets clients render a humanized reset time alongside the prompt.\n */\n retryAfterSeconds?: number;\n}\nexport interface AutoModeSwitchCompletedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: AutoModeSwitchCompletedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"auto_mode_switch.completed\";\n}\n/**\n * Auto mode switch completion notification\n */\nexport interface AutoModeSwitchCompletedData {\n /**\n * Request ID of the resolved request; clients should dismiss any UI for this request\n */\n requestId: string;\n /**\n * The user's choice: 'yes', 'yes_always', or 'no'\n */\n response: string;\n}\nexport interface CommandsChangedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: CommandsChangedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"commands.changed\";\n}\n/**\n * SDK command registration change notification\n */\nexport interface CommandsChangedData {\n /**\n * Current list of registered SDK commands\n */\n commands: CommandsChangedCommand[];\n}\nexport interface CommandsChangedCommand {\n description?: string;\n name: string;\n}\nexport interface CapabilitiesChangedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: CapabilitiesChangedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"capabilities.changed\";\n}\n/**\n * Session capability change notification\n */\nexport interface CapabilitiesChangedData {\n ui?: CapabilitiesChangedUI;\n}\n/**\n * UI capability changes\n */\nexport interface CapabilitiesChangedUI {\n /**\n * Whether elicitation is now supported\n */\n elicitation?: boolean;\n}\nexport interface ExitPlanModeRequestedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: ExitPlanModeRequestedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"exit_plan_mode.requested\";\n}\n/**\n * Plan approval request with plan content and available user actions\n */\nexport interface ExitPlanModeRequestedData {\n /**\n * Available actions the user can take (e.g., approve, edit, reject)\n */\n actions: string[];\n /**\n * Full content of the plan file\n */\n planContent: string;\n /**\n * The recommended action for the user to take\n */\n recommendedAction: string;\n /**\n * Unique identifier for this request; used to respond via session.respondToExitPlanMode()\n */\n requestId: string;\n /**\n * Summary of the plan that was created\n */\n summary: string;\n}\nexport interface ExitPlanModeCompletedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: ExitPlanModeCompletedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"exit_plan_mode.completed\";\n}\n/**\n * Plan mode exit completion with the user's approval decision and optional feedback\n */\nexport interface ExitPlanModeCompletedData {\n /**\n * Whether the plan was approved by the user\n */\n approved?: boolean;\n /**\n * Whether edits should be auto-approved without confirmation\n */\n autoApproveEdits?: boolean;\n /**\n * Free-form feedback from the user if they requested changes to the plan\n */\n feedback?: string;\n /**\n * Request ID of the resolved exit plan mode request; clients should dismiss any UI for this request\n */\n requestId: string;\n /**\n * Which action the user selected (e.g. 'autopilot', 'interactive', 'exit_only')\n */\n selectedAction?: string;\n}\nexport interface ToolsUpdatedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: ToolsUpdatedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.tools_updated\";\n}\nexport interface ToolsUpdatedData {\n model: string;\n}\nexport interface BackgroundTasksChangedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: BackgroundTasksChangedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.background_tasks_changed\";\n}\nexport interface BackgroundTasksChangedData {}\nexport interface SkillsLoadedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: SkillsLoadedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.skills_loaded\";\n}\nexport interface SkillsLoadedData {\n /**\n * Array of resolved skill metadata\n */\n skills: SkillsLoadedSkill[];\n}\nexport interface SkillsLoadedSkill {\n /**\n * Description of what the skill does\n */\n description: string;\n /**\n * Whether the skill is currently enabled\n */\n enabled: boolean;\n /**\n * Unique identifier for the skill\n */\n name: string;\n /**\n * Absolute path to the skill file, if available\n */\n path?: string;\n /**\n * Source location type of the skill (e.g., project, personal, plugin)\n */\n source: string;\n /**\n * Whether the skill can be invoked by the user as a slash command\n */\n userInvocable: boolean;\n}\nexport interface CustomAgentsUpdatedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: CustomAgentsUpdatedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.custom_agents_updated\";\n}\nexport interface CustomAgentsUpdatedData {\n /**\n * Array of loaded custom agent metadata\n */\n agents: CustomAgentsUpdatedAgent[];\n /**\n * Fatal errors from agent loading\n */\n errors: string[];\n /**\n * Non-fatal warnings from agent loading\n */\n warnings: string[];\n}\nexport interface CustomAgentsUpdatedAgent {\n /**\n * Description of what the agent does\n */\n description: string;\n /**\n * Human-readable display name\n */\n displayName: string;\n /**\n * Unique identifier for the agent\n */\n id: string;\n /**\n * Model override for this agent, if set\n */\n model?: string;\n /**\n * Internal name of the agent\n */\n name: string;\n /**\n * Source location: user, project, inherited, remote, or plugin\n */\n source: string;\n /**\n * List of tool names available to this agent\n */\n tools: string[];\n /**\n * Whether the agent can be selected by the user\n */\n userInvocable: boolean;\n}\nexport interface McpServersLoadedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: McpServersLoadedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.mcp_servers_loaded\";\n}\nexport interface McpServersLoadedData {\n /**\n * Array of MCP server status summaries\n */\n servers: McpServersLoadedServer[];\n}\nexport interface McpServersLoadedServer {\n /**\n * Error message if the server failed to connect\n */\n error?: string;\n /**\n * Server name (config key)\n */\n name: string;\n /**\n * Configuration source: user, workspace, plugin, or builtin\n */\n source?: string;\n status: McpServersLoadedServerStatus;\n}\nexport interface McpServerStatusChangedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: McpServerStatusChangedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.mcp_server_status_changed\";\n}\nexport interface McpServerStatusChangedData {\n /**\n * Name of the MCP server whose status changed\n */\n serverName: string;\n status: McpServerStatusChangedStatus;\n}\nexport interface ExtensionsLoadedEvent {\n /**\n * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.\n */\n agentId?: string;\n data: ExtensionsLoadedData;\n ephemeral: true;\n /**\n * Unique event identifier (UUID v4), generated when the event is emitted\n */\n id: string;\n /**\n * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.\n */\n parentId: string | null;\n /**\n * ISO 8601 timestamp when the event was created\n */\n timestamp: string;\n type: \"session.extensions_loaded\";\n}\nexport interface ExtensionsLoadedData {\n /**\n * Array of discovered extensions and their status\n */\n extensions: ExtensionsLoadedExtension[];\n}\nexport interface ExtensionsLoadedExtension {\n /**\n * Source-qualified extension ID (e.g., 'project:my-ext', 'user:auth-helper')\n */\n id: string;\n /**\n * Extension name (directory name)\n */\n name: string;\n source: ExtensionsLoadedExtensionSource;\n status: ExtensionsLoadedExtensionStatus;\n}\n" }, { "path": "nodejs/src/index.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\n/**\n * Copilot SDK - TypeScript/Node.js Client\n *\n * JSON-RPC based SDK for programmatic control of GitHub Copilot CLI\n */\n\nexport { CopilotClient } from \"./client.js\";\nexport { CopilotSession, type AssistantMessageEvent } from \"./session.js\";\nexport {\n defineTool,\n approveAll,\n convertMcpCallToolResult,\n createSessionFsAdapter,\n SYSTEM_PROMPT_SECTIONS,\n} from \"./types.js\";\nexport type {\n CommandContext,\n CommandDefinition,\n CommandHandler,\n ConnectionState,\n CopilotClientOptions,\n CustomAgentConfig,\n ElicitationFieldValue,\n ElicitationHandler,\n ElicitationParams,\n ElicitationContext,\n ElicitationResult,\n ElicitationSchema,\n ElicitationSchemaField,\n ForegroundSessionInfo,\n GetAuthStatusResponse,\n GetStatusResponse,\n InfiniteSessionConfig,\n InputOptions,\n MCPStdioServerConfig,\n MCPHTTPServerConfig,\n MCPServerConfig,\n DefaultAgentConfig,\n MessageOptions,\n ModelBilling,\n ModelCapabilities,\n ModelCapabilitiesOverride,\n ModelInfo,\n ModelPolicy,\n PermissionHandler,\n PermissionRequest,\n PermissionRequestResult,\n ProviderConfig,\n ResumeSessionConfig,\n SectionOverride,\n SectionOverrideAction,\n SectionTransformFn,\n SessionCapabilities,\n SessionConfig,\n SessionEvent,\n SessionEventHandler,\n SessionEventPayload,\n SessionEventType,\n SessionLifecycleEvent,\n SessionLifecycleEventType,\n SessionLifecycleHandler,\n SessionContext,\n SessionListFilter,\n SessionMetadata,\n SessionUiApi,\n SessionFsConfig,\n SessionFsProvider,\n SessionFsFileInfo,\n SystemMessageAppendConfig,\n SystemMessageConfig,\n SystemMessageCustomizeConfig,\n SystemMessageReplaceConfig,\n SystemPromptSection,\n TelemetryConfig,\n TraceContext,\n TraceContextProvider,\n Tool,\n ToolHandler,\n ToolInvocation,\n ToolResultObject,\n TypedSessionEventHandler,\n TypedSessionLifecycleHandler,\n ZodSchema,\n} from \"./types.js\";\n" }, { "path": "nodejs/src/sdkProtocolVersion.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\n// Code generated by update-protocol-version.ts. DO NOT EDIT.\n\n/**\n * The SDK protocol version.\n * This must match the version expected by the copilot-agent-runtime server.\n */\nexport const SDK_PROTOCOL_VERSION = 3;\n\n/**\n * Gets the SDK protocol version.\n * @returns The protocol version number\n */\nexport function getSdkProtocolVersion(): number {\n return SDK_PROTOCOL_VERSION;\n}\n" }, { "path": "nodejs/src/session.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\n/**\n * Copilot Session - represents a single conversation session with the Copilot CLI.\n * @module session\n */\n\nimport type { MessageConnection } from \"vscode-jsonrpc/node.js\";\nimport { ConnectionError, ResponseError } from \"vscode-jsonrpc/node.js\";\nimport { createSessionRpc } from \"./generated/rpc.js\";\nimport type { ClientSessionApiHandlers } from \"./generated/rpc.js\";\nimport { getTraceContext } from \"./telemetry.js\";\nimport type {\n CommandHandler,\n ElicitationHandler,\n ElicitationParams,\n ElicitationResult,\n ElicitationContext,\n InputOptions,\n MessageOptions,\n PermissionHandler,\n PermissionRequest,\n PermissionRequestResult,\n ReasoningEffort,\n ModelCapabilitiesOverride,\n SectionTransformFn,\n SessionCapabilities,\n SessionEvent,\n SessionEventHandler,\n SessionEventPayload,\n SessionEventType,\n SessionHooks,\n SessionUiApi,\n Tool,\n ToolHandler,\n ToolResult,\n ToolResultObject,\n TraceContextProvider,\n TypedSessionEventHandler,\n UserInputHandler,\n UserInputRequest,\n UserInputResponse,\n} from \"./types.js\";\n\nexport const NO_RESULT_PERMISSION_V2_ERROR =\n \"Permission handlers cannot return 'no-result' when connected to a protocol v2 server.\";\n\n/** Assistant message event - the final response from the assistant. */\nexport type AssistantMessageEvent = Extract;\n\n/**\n * Represents a single conversation session with the Copilot CLI.\n *\n * A session maintains conversation state, handles events, and manages tool execution.\n * Sessions are created via {@link CopilotClient.createSession} or resumed via\n * {@link CopilotClient.resumeSession}.\n *\n * @example\n * ```typescript\n * const session = await client.createSession({ model: \"gpt-4\" });\n *\n * // Subscribe to events\n * session.on((event) => {\n * if (event.type === \"assistant.message\") {\n * console.log(event.data.content);\n * }\n * });\n *\n * // Send a message and wait for completion\n * await session.sendAndWait({ prompt: \"Hello, world!\" });\n *\n * // Clean up\n * await session.disconnect();\n * ```\n */\nexport class CopilotSession {\n private eventHandlers: Set = new Set();\n private typedEventHandlers: Map void>> =\n new Map();\n private toolHandlers: Map = new Map();\n private commandHandlers: Map = new Map();\n private permissionHandler?: PermissionHandler;\n private userInputHandler?: UserInputHandler;\n private elicitationHandler?: ElicitationHandler;\n private hooks?: SessionHooks;\n private transformCallbacks?: Map;\n private _rpc: ReturnType | null = null;\n private traceContextProvider?: TraceContextProvider;\n private _capabilities: SessionCapabilities = {};\n\n /** @internal Client session API handlers, populated by CopilotClient during create/resume. */\n clientSessionApis: ClientSessionApiHandlers = {};\n\n /**\n * Creates a new CopilotSession instance.\n *\n * @param sessionId - The unique identifier for this session\n * @param connection - The JSON-RPC message connection to the Copilot CLI\n * @param workspacePath - Path to the session workspace directory (when infinite sessions enabled)\n * @param traceContextProvider - Optional callback to get W3C Trace Context for outbound RPCs\n * @internal This constructor is internal. Use {@link CopilotClient.createSession} to create sessions.\n */\n constructor(\n public readonly sessionId: string,\n private connection: MessageConnection,\n private _workspacePath?: string,\n traceContextProvider?: TraceContextProvider\n ) {\n this.traceContextProvider = traceContextProvider;\n }\n\n /**\n * Typed session-scoped RPC methods.\n */\n get rpc(): ReturnType {\n if (!this._rpc) {\n this._rpc = createSessionRpc(this.connection, this.sessionId);\n }\n return this._rpc;\n }\n\n /**\n * Path to the session workspace directory when infinite sessions are enabled.\n * Contains checkpoints/, plan.md, and files/ subdirectories.\n * Undefined if infinite sessions are disabled.\n */\n get workspacePath(): string | undefined {\n return this._workspacePath;\n }\n\n /**\n * Host capabilities reported when the session was created or resumed.\n * Use this to check feature support before calling capability-gated APIs.\n */\n get capabilities(): SessionCapabilities {\n return this._capabilities;\n }\n\n /**\n * Interactive UI methods for showing dialogs to the user.\n * Only available when the CLI host supports elicitation\n * (`session.capabilities.ui?.elicitation === true`).\n *\n * @example\n * ```typescript\n * if (session.capabilities.ui?.elicitation) {\n * const ok = await session.ui.confirm(\"Deploy to production?\");\n * }\n * ```\n */\n get ui(): SessionUiApi {\n return {\n elicitation: (params: ElicitationParams) => this._elicitation(params),\n confirm: (message: string) => this._confirm(message),\n select: (message: string, options: string[]) => this._select(message, options),\n input: (message: string, options?: InputOptions) => this._input(message, options),\n };\n }\n\n /**\n * Sends a message to this session and waits for the response.\n *\n * The message is processed asynchronously. Subscribe to events via {@link on}\n * to receive streaming responses and other session events.\n *\n * @param options - The message options including the prompt and optional attachments\n * @returns A promise that resolves with the message ID of the response\n * @throws Error if the session has been disconnected or the connection fails\n *\n * @example\n * ```typescript\n * const messageId = await session.send({\n * prompt: \"Explain this code\",\n * attachments: [{ type: \"file\", path: \"./src/index.ts\" }]\n * });\n * ```\n */\n async send(options: MessageOptions): Promise {\n const response = await this.connection.sendRequest(\"session.send\", {\n ...(await getTraceContext(this.traceContextProvider)),\n sessionId: this.sessionId,\n prompt: options.prompt,\n attachments: options.attachments,\n mode: options.mode,\n requestHeaders: options.requestHeaders,\n });\n\n return (response as { messageId: string }).messageId;\n }\n\n /**\n * Sends a message to this session and waits until the session becomes idle.\n *\n * This is a convenience method that combines {@link send} with waiting for\n * the `session.idle` event. Use this when you want to block until the\n * assistant has finished processing the message.\n *\n * Events are still delivered to handlers registered via {@link on} while waiting.\n *\n * @param options - The message options including the prompt and optional attachments\n * @param timeout - Timeout in milliseconds (default: 60000). Controls how long to wait; does not abort in-flight agent work.\n * @returns A promise that resolves with the final assistant message when the session becomes idle,\n * or undefined if no assistant message was received\n * @throws Error if the timeout is reached before the session becomes idle\n * @throws Error if the session has been disconnected or the connection fails\n *\n * @example\n * ```typescript\n * // Send and wait for completion with default 60s timeout\n * const response = await session.sendAndWait({ prompt: \"What is 2+2?\" });\n * console.log(response?.data.content); // \"4\"\n * ```\n */\n async sendAndWait(\n options: MessageOptions,\n timeout?: number\n ): Promise {\n const effectiveTimeout = timeout ?? 60_000;\n\n let resolveIdle: () => void;\n let rejectWithError: (error: Error) => void;\n const idlePromise = new Promise((resolve, reject) => {\n resolveIdle = resolve;\n rejectWithError = reject;\n });\n\n let lastAssistantMessage: AssistantMessageEvent | undefined;\n\n // Register event handler BEFORE calling send to avoid race condition\n // where session.idle fires before we start listening\n const unsubscribe = this.on((event) => {\n if (event.type === \"assistant.message\") {\n lastAssistantMessage = event;\n } else if (event.type === \"session.idle\") {\n resolveIdle();\n } else if (event.type === \"session.error\") {\n const error = new Error(event.data.message);\n error.stack = event.data.stack;\n rejectWithError(error);\n }\n });\n\n let timeoutId: ReturnType | undefined;\n try {\n await this.send(options);\n\n const timeoutPromise = new Promise((_, reject) => {\n timeoutId = setTimeout(\n () =>\n reject(\n new Error(\n `Timeout after ${effectiveTimeout}ms waiting for session.idle`\n )\n ),\n effectiveTimeout\n );\n });\n await Promise.race([idlePromise, timeoutPromise]);\n\n return lastAssistantMessage;\n } finally {\n if (timeoutId !== undefined) {\n clearTimeout(timeoutId);\n }\n unsubscribe();\n }\n }\n\n /**\n * Subscribes to events from this session.\n *\n * Events include assistant messages, tool executions, errors, and session state changes.\n * Multiple handlers can be registered and will all receive events.\n *\n * @param eventType - The specific event type to listen for (e.g., \"assistant.message\", \"session.idle\")\n * @param handler - A callback function that receives events of the specified type\n * @returns A function that, when called, unsubscribes the handler\n *\n * @example\n * ```typescript\n * // Listen for a specific event type\n * const unsubscribe = session.on(\"assistant.message\", (event) => {\n * console.log(\"Assistant:\", event.data.content);\n * });\n *\n * // Later, to stop receiving events:\n * unsubscribe();\n * ```\n */\n on(eventType: K, handler: TypedSessionEventHandler): () => void;\n\n /**\n * Subscribes to all events from this session.\n *\n * @param handler - A callback function that receives all session events\n * @returns A function that, when called, unsubscribes the handler\n *\n * @example\n * ```typescript\n * const unsubscribe = session.on((event) => {\n * switch (event.type) {\n * case \"assistant.message\":\n * console.log(\"Assistant:\", event.data.content);\n * break;\n * case \"session.error\":\n * console.error(\"Error:\", event.data.message);\n * break;\n * }\n * });\n *\n * // Later, to stop receiving events:\n * unsubscribe();\n * ```\n */\n on(handler: SessionEventHandler): () => void;\n\n on(\n eventTypeOrHandler: K | SessionEventHandler,\n handler?: TypedSessionEventHandler\n ): () => void {\n // Overload 1: on(eventType, handler) - typed event subscription\n if (typeof eventTypeOrHandler === \"string\" && handler) {\n const eventType = eventTypeOrHandler;\n if (!this.typedEventHandlers.has(eventType)) {\n this.typedEventHandlers.set(eventType, new Set());\n }\n // Cast is safe: handler receives the correctly typed event at dispatch time\n const storedHandler = handler as (event: SessionEvent) => void;\n this.typedEventHandlers.get(eventType)!.add(storedHandler);\n return () => {\n const handlers = this.typedEventHandlers.get(eventType);\n if (handlers) {\n handlers.delete(storedHandler);\n }\n };\n }\n\n // Overload 2: on(handler) - wildcard subscription\n const wildcardHandler = eventTypeOrHandler as SessionEventHandler;\n this.eventHandlers.add(wildcardHandler);\n return () => {\n this.eventHandlers.delete(wildcardHandler);\n };\n }\n\n /**\n * Dispatches an event to all registered handlers.\n * Also handles broadcast request events internally (external tool calls, permissions).\n *\n * @param event - The session event to dispatch\n * @internal This method is for internal use by the SDK.\n */\n _dispatchEvent(event: SessionEvent): void {\n // Handle broadcast request events internally (fire-and-forget)\n this._handleBroadcastEvent(event);\n\n // Dispatch to typed handlers for this specific event type\n const typedHandlers = this.typedEventHandlers.get(event.type);\n if (typedHandlers) {\n for (const handler of typedHandlers) {\n try {\n handler(event as SessionEventPayload);\n } catch (_error) {\n // Handler error\n }\n }\n }\n\n // Dispatch to wildcard handlers\n for (const handler of this.eventHandlers) {\n try {\n handler(event);\n } catch (_error) {\n // Handler error\n }\n }\n }\n\n /**\n * Handles broadcast request events by executing local handlers and responding via RPC.\n * Handlers are dispatched as fire-and-forget — rejections propagate as unhandled promise\n * rejections, consistent with standard EventEmitter / event handler semantics.\n * @internal\n */\n private _handleBroadcastEvent(event: SessionEvent): void {\n if (event.type === \"external_tool.requested\") {\n const { requestId, toolName } = event.data as {\n requestId: string;\n toolName: string;\n arguments: unknown;\n toolCallId: string;\n sessionId: string;\n };\n const args = (event.data as { arguments: unknown }).arguments;\n const toolCallId = (event.data as { toolCallId: string }).toolCallId;\n const traceparent = (event.data as { traceparent?: string }).traceparent;\n const tracestate = (event.data as { tracestate?: string }).tracestate;\n const handler = this.toolHandlers.get(toolName);\n if (handler) {\n void this._executeToolAndRespond(\n requestId,\n toolName,\n toolCallId,\n args,\n handler,\n traceparent,\n tracestate\n );\n }\n } else if (event.type === \"permission.requested\") {\n const { requestId, permissionRequest, resolvedByHook } = event.data as {\n requestId: string;\n permissionRequest: PermissionRequest;\n resolvedByHook?: boolean;\n };\n if (resolvedByHook) {\n return; // Already resolved by a permissionRequest hook; no client action needed.\n }\n if (this.permissionHandler) {\n void this._executePermissionAndRespond(requestId, permissionRequest);\n }\n } else if (event.type === \"command.execute\") {\n const { requestId, commandName, command, args } = event.data as {\n requestId: string;\n command: string;\n commandName: string;\n args: string;\n };\n void this._executeCommandAndRespond(requestId, commandName, command, args);\n } else if (event.type === \"elicitation.requested\") {\n if (this.elicitationHandler) {\n const { message, requestedSchema, mode, elicitationSource, url, requestId } =\n event.data;\n void this._handleElicitationRequest(\n {\n sessionId: this.sessionId,\n message,\n requestedSchema: requestedSchema as ElicitationContext[\"requestedSchema\"],\n mode,\n elicitationSource,\n url,\n },\n requestId\n );\n }\n } else if (event.type === \"capabilities.changed\") {\n this._capabilities = { ...this._capabilities, ...event.data };\n }\n }\n\n /**\n * Executes a tool handler and sends the result back via RPC.\n * @internal\n */\n private async _executeToolAndRespond(\n requestId: string,\n toolName: string,\n toolCallId: string,\n args: unknown,\n handler: ToolHandler,\n traceparent?: string,\n tracestate?: string\n ): Promise {\n try {\n const rawResult = await handler(args, {\n sessionId: this.sessionId,\n toolCallId,\n toolName,\n arguments: args,\n traceparent,\n tracestate,\n });\n let result: ToolResult;\n if (rawResult == null) {\n result = \"\";\n } else if (typeof rawResult === \"string\") {\n result = rawResult;\n } else if (isToolResultObject(rawResult)) {\n result = rawResult;\n } else {\n result = JSON.stringify(rawResult);\n }\n await this.rpc.tools.handlePendingToolCall({ requestId, result });\n } catch (error) {\n const message = error instanceof Error ? error.message : String(error);\n try {\n await this.rpc.tools.handlePendingToolCall({ requestId, error: message });\n } catch (rpcError) {\n if (!(rpcError instanceof ConnectionError || rpcError instanceof ResponseError)) {\n throw rpcError;\n }\n // Connection lost or RPC error — nothing we can do\n }\n }\n }\n\n /**\n * Executes a permission handler and sends the result back via RPC.\n * @internal\n */\n private async _executePermissionAndRespond(\n requestId: string,\n permissionRequest: PermissionRequest\n ): Promise {\n try {\n const result = await this.permissionHandler!(permissionRequest, {\n sessionId: this.sessionId,\n });\n if (result.kind === \"no-result\") {\n return;\n }\n await this.rpc.permissions.handlePendingPermissionRequest({ requestId, result });\n } catch (_error) {\n try {\n await this.rpc.permissions.handlePendingPermissionRequest({\n requestId,\n result: {\n kind: \"user-not-available\",\n },\n });\n } catch (rpcError) {\n if (!(rpcError instanceof ConnectionError || rpcError instanceof ResponseError)) {\n throw rpcError;\n }\n // Connection lost or RPC error — nothing we can do\n }\n }\n }\n\n /**\n * Executes a command handler and sends the result back via RPC.\n * @internal\n */\n private async _executeCommandAndRespond(\n requestId: string,\n commandName: string,\n command: string,\n args: string\n ): Promise {\n const handler = this.commandHandlers.get(commandName);\n if (!handler) {\n try {\n await this.rpc.commands.handlePendingCommand({\n requestId,\n error: `Unknown command: ${commandName}`,\n });\n } catch (rpcError) {\n if (!(rpcError instanceof ConnectionError || rpcError instanceof ResponseError)) {\n throw rpcError;\n }\n }\n return;\n }\n\n try {\n await handler({ sessionId: this.sessionId, command, commandName, args });\n await this.rpc.commands.handlePendingCommand({ requestId });\n } catch (error) {\n const message = error instanceof Error ? error.message : String(error);\n try {\n await this.rpc.commands.handlePendingCommand({ requestId, error: message });\n } catch (rpcError) {\n if (!(rpcError instanceof ConnectionError || rpcError instanceof ResponseError)) {\n throw rpcError;\n }\n }\n }\n }\n\n /**\n * Registers custom tool handlers for this session.\n *\n * Tools allow the assistant to execute custom functions. When the assistant\n * invokes a tool, the corresponding handler is called with the tool arguments.\n *\n * @param tools - An array of tool definitions with their handlers, or undefined to clear all tools\n * @internal This method is typically called internally when creating a session with tools.\n */\n registerTools(tools?: Tool[]): void {\n this.toolHandlers.clear();\n if (!tools) {\n return;\n }\n\n for (const tool of tools) {\n this.toolHandlers.set(tool.name, tool.handler);\n }\n }\n\n /**\n * Retrieves a registered tool handler by name.\n *\n * @param name - The name of the tool to retrieve\n * @returns The tool handler if found, or undefined\n * @internal This method is for internal use by the SDK.\n */\n getToolHandler(name: string): ToolHandler | undefined {\n return this.toolHandlers.get(name);\n }\n\n /**\n * Registers command handlers for this session.\n *\n * @param commands - An array of command definitions with handlers, or undefined to clear\n * @internal This method is typically called internally when creating/resuming a session.\n */\n registerCommands(commands?: { name: string; handler: CommandHandler }[]): void {\n this.commandHandlers.clear();\n if (!commands) {\n return;\n }\n for (const cmd of commands) {\n this.commandHandlers.set(cmd.name, cmd.handler);\n }\n }\n\n /**\n * Registers the elicitation handler for this session.\n *\n * @param handler - The handler to invoke when the server dispatches an elicitation request\n * @internal This method is typically called internally when creating/resuming a session.\n */\n registerElicitationHandler(handler?: ElicitationHandler): void {\n this.elicitationHandler = handler;\n }\n\n /**\n * Handles an elicitation.requested broadcast event.\n * Invokes the registered handler and responds via handlePendingElicitation RPC.\n * @internal\n */\n async _handleElicitationRequest(context: ElicitationContext, requestId: string): Promise {\n if (!this.elicitationHandler) {\n return;\n }\n try {\n const result = await this.elicitationHandler(context);\n await this.rpc.ui.handlePendingElicitation({ requestId, result });\n } catch {\n // Handler failed — attempt to cancel so the request doesn't hang\n try {\n await this.rpc.ui.handlePendingElicitation({\n requestId,\n result: { action: \"cancel\" },\n });\n } catch (rpcError) {\n if (!(rpcError instanceof ConnectionError || rpcError instanceof ResponseError)) {\n throw rpcError;\n }\n // Connection lost or RPC error — nothing we can do\n }\n }\n }\n\n /**\n * Sets the host capabilities for this session.\n *\n * @param capabilities - The capabilities object from the create/resume response\n * @internal This method is typically called internally when creating/resuming a session.\n */\n setCapabilities(capabilities?: SessionCapabilities): void {\n this._capabilities = capabilities ?? {};\n }\n\n private assertElicitation(): void {\n if (!this._capabilities.ui?.elicitation) {\n throw new Error(\n \"Elicitation is not supported by the host. \" +\n \"Check session.capabilities.ui?.elicitation before calling UI methods.\"\n );\n }\n }\n\n private async _elicitation(params: ElicitationParams): Promise {\n this.assertElicitation();\n return this.rpc.ui.elicitation({\n message: params.message,\n requestedSchema: params.requestedSchema,\n });\n }\n\n private async _confirm(message: string): Promise {\n this.assertElicitation();\n const result = await this.rpc.ui.elicitation({\n message,\n requestedSchema: {\n type: \"object\",\n properties: {\n confirmed: { type: \"boolean\", default: true },\n },\n required: [\"confirmed\"],\n },\n });\n return result.action === \"accept\" && (result.content?.confirmed as boolean) === true;\n }\n\n private async _select(message: string, options: string[]): Promise {\n this.assertElicitation();\n const result = await this.rpc.ui.elicitation({\n message,\n requestedSchema: {\n type: \"object\",\n properties: {\n selection: { type: \"string\", enum: options },\n },\n required: [\"selection\"],\n },\n });\n if (result.action === \"accept\" && result.content?.selection != null) {\n return result.content.selection as string;\n }\n return null;\n }\n\n private async _input(message: string, options?: InputOptions): Promise {\n this.assertElicitation();\n const field: Record = { type: \"string\" as const };\n if (options?.title) field.title = options.title;\n if (options?.description) field.description = options.description;\n if (options?.minLength != null) field.minLength = options.minLength;\n if (options?.maxLength != null) field.maxLength = options.maxLength;\n if (options?.format) field.format = options.format;\n if (options?.default != null) field.default = options.default;\n\n const result = await this.rpc.ui.elicitation({\n message,\n requestedSchema: {\n type: \"object\",\n properties: {\n value: field as ElicitationParams[\"requestedSchema\"][\"properties\"][string],\n },\n required: [\"value\"],\n },\n });\n if (result.action === \"accept\" && result.content?.value != null) {\n return result.content.value as string;\n }\n return null;\n }\n\n /**\n * Registers a handler for permission requests.\n *\n * When the assistant needs permission to perform certain actions (e.g., file operations),\n * this handler is called to approve or deny the request.\n *\n * @param handler - The permission handler function, or undefined to remove the handler\n * @internal This method is typically called internally when creating a session.\n */\n registerPermissionHandler(handler?: PermissionHandler): void {\n this.permissionHandler = handler;\n }\n\n /**\n * Registers a user input handler for ask_user requests.\n *\n * When the agent needs input from the user (via ask_user tool),\n * this handler is called to provide the response.\n *\n * @param handler - The user input handler function, or undefined to remove the handler\n * @internal This method is typically called internally when creating a session.\n */\n registerUserInputHandler(handler?: UserInputHandler): void {\n this.userInputHandler = handler;\n }\n\n /**\n * Registers hook handlers for session lifecycle events.\n *\n * Hooks allow custom logic to be executed at various points during\n * the session lifecycle (before/after tool use, session start/end, etc.).\n *\n * @param hooks - The hook handlers object, or undefined to remove all hooks\n * @internal This method is typically called internally when creating a session.\n */\n registerHooks(hooks?: SessionHooks): void {\n this.hooks = hooks;\n }\n\n /**\n * Registers transform callbacks for system message sections.\n *\n * @param callbacks - Map of section ID to transform callback, or undefined to clear\n * @internal This method is typically called internally when creating a session.\n */\n registerTransformCallbacks(callbacks?: Map): void {\n this.transformCallbacks = callbacks;\n }\n\n /**\n * Handles a systemMessage.transform request from the runtime.\n * Dispatches each section to its registered transform callback.\n *\n * @param sections - Map of section IDs to their current rendered content\n * @returns A promise that resolves with the transformed sections\n * @internal This method is for internal use by the SDK.\n */\n async _handleSystemMessageTransform(\n sections: Record\n ): Promise<{ sections: Record }> {\n const result: Record = {};\n\n for (const [sectionId, { content }] of Object.entries(sections)) {\n const callback = this.transformCallbacks?.get(sectionId);\n if (callback) {\n try {\n const transformed = await callback(content);\n result[sectionId] = { content: transformed };\n } catch (_error) {\n // Callback failed — return original content\n result[sectionId] = { content };\n }\n } else {\n // No callback for this section — pass through unchanged\n result[sectionId] = { content };\n }\n }\n\n return { sections: result };\n }\n\n /**\n * Handles a permission request in the v2 protocol format (synchronous RPC).\n * Used as a back-compat adapter when connected to a v2 server.\n *\n * @param request - The permission request data from the CLI\n * @returns A promise that resolves with the permission decision\n * @internal This method is for internal use by the SDK.\n */\n async _handlePermissionRequestV2(request: unknown): Promise {\n if (!this.permissionHandler) {\n return { kind: \"user-not-available\" };\n }\n\n try {\n const result = await this.permissionHandler(request as PermissionRequest, {\n sessionId: this.sessionId,\n });\n if (result.kind === \"no-result\") {\n throw new Error(NO_RESULT_PERMISSION_V2_ERROR);\n }\n return result;\n } catch (error) {\n if (error instanceof Error && error.message === NO_RESULT_PERMISSION_V2_ERROR) {\n throw error;\n }\n return { kind: \"user-not-available\" };\n }\n }\n\n /**\n * Handles a user input request from the Copilot CLI.\n *\n * @param request - The user input request data from the CLI\n * @returns A promise that resolves with the user's response\n * @internal This method is for internal use by the SDK.\n */\n async _handleUserInputRequest(request: unknown): Promise {\n if (!this.userInputHandler) {\n // No handler registered, throw error\n throw new Error(\"User input requested but no handler registered\");\n }\n\n try {\n const result = await this.userInputHandler(request as UserInputRequest, {\n sessionId: this.sessionId,\n });\n return result;\n } catch (error) {\n // Handler failed, rethrow\n throw error;\n }\n }\n\n /**\n * Handles a hooks invocation from the Copilot CLI.\n *\n * @param hookType - The type of hook being invoked\n * @param input - The input data for the hook\n * @returns A promise that resolves with the hook output, or undefined\n * @internal This method is for internal use by the SDK.\n */\n async _handleHooksInvoke(hookType: string, input: unknown): Promise {\n if (!this.hooks) {\n return undefined;\n }\n\n // Type-safe handler lookup with explicit casting\n type GenericHandler = (\n input: unknown,\n invocation: { sessionId: string }\n ) => Promise | unknown;\n\n const handlerMap: Record = {\n preToolUse: this.hooks.onPreToolUse as GenericHandler | undefined,\n postToolUse: this.hooks.onPostToolUse as GenericHandler | undefined,\n userPromptSubmitted: this.hooks.onUserPromptSubmitted as GenericHandler | undefined,\n sessionStart: this.hooks.onSessionStart as GenericHandler | undefined,\n sessionEnd: this.hooks.onSessionEnd as GenericHandler | undefined,\n errorOccurred: this.hooks.onErrorOccurred as GenericHandler | undefined,\n };\n\n const handler = handlerMap[hookType];\n if (!handler) {\n return undefined;\n }\n\n try {\n const result = await handler(input, { sessionId: this.sessionId });\n return result;\n } catch (_error) {\n // Hook failed, return undefined\n return undefined;\n }\n }\n\n /**\n * Retrieves all events and messages from this session's history.\n *\n * This returns the complete conversation history including user messages,\n * assistant responses, tool executions, and other session events.\n *\n * @returns A promise that resolves with an array of all session events\n * @throws Error if the session has been disconnected or the connection fails\n *\n * @example\n * ```typescript\n * const events = await session.getMessages();\n * for (const event of events) {\n * if (event.type === \"assistant.message\") {\n * console.log(\"Assistant:\", event.data.content);\n * }\n * }\n * ```\n */\n async getMessages(): Promise {\n const response = await this.connection.sendRequest(\"session.getMessages\", {\n sessionId: this.sessionId,\n });\n\n return (response as { events: SessionEvent[] }).events;\n }\n\n /**\n * Disconnects this session and releases all in-memory resources (event handlers,\n * tool handlers, permission handlers).\n *\n * Session state on disk (conversation history, planning state, artifacts) is\n * preserved, so the conversation can be resumed later by calling\n * {@link CopilotClient.resumeSession} with the session ID. To permanently\n * remove all session data including files on disk, use\n * {@link CopilotClient.deleteSession} instead.\n *\n * After calling this method, the session object can no longer be used.\n *\n * @returns A promise that resolves when the session is disconnected\n * @throws Error if the connection fails\n *\n * @example\n * ```typescript\n * // Clean up when done — session can still be resumed later\n * await session.disconnect();\n * ```\n */\n async disconnect(): Promise {\n await this.connection.sendRequest(\"session.destroy\", {\n sessionId: this.sessionId,\n });\n this.eventHandlers.clear();\n this.typedEventHandlers.clear();\n this.toolHandlers.clear();\n this.permissionHandler = undefined;\n }\n\n /**\n * @deprecated Use {@link disconnect} instead. This method will be removed in a future release.\n *\n * Disconnects this session and releases all in-memory resources.\n * Session data on disk is preserved for later resumption.\n *\n * @returns A promise that resolves when the session is disconnected\n * @throws Error if the connection fails\n */\n async destroy(): Promise {\n return this.disconnect();\n }\n\n /** Enables `await using session = ...` syntax for automatic cleanup. */\n async [Symbol.asyncDispose](): Promise {\n return this.disconnect();\n }\n\n /**\n * Aborts the currently processing message in this session.\n *\n * Use this to cancel a long-running request. The session remains valid\n * and can continue to be used for new messages.\n *\n * @returns A promise that resolves when the abort request is acknowledged\n * @throws Error if the session has been disconnected or the connection fails\n *\n * @example\n * ```typescript\n * // Start a long-running request\n * const messagePromise = session.send({ prompt: \"Write a very long story...\" });\n *\n * // Abort after 5 seconds\n * setTimeout(async () => {\n * await session.abort();\n * }, 5000);\n * ```\n */\n async abort(): Promise {\n await this.connection.sendRequest(\"session.abort\", {\n sessionId: this.sessionId,\n });\n }\n\n /**\n * Change the model for this session.\n * The new model takes effect for the next message. Conversation history is preserved.\n *\n * @param model - Model ID to switch to\n * @param options - Optional settings for the new model\n *\n * @example\n * ```typescript\n * await session.setModel(\"gpt-4.1\");\n * await session.setModel(\"claude-sonnet-4.6\", { reasoningEffort: \"high\" });\n * ```\n */\n async setModel(\n model: string,\n options?: {\n reasoningEffort?: ReasoningEffort;\n modelCapabilities?: ModelCapabilitiesOverride;\n }\n ): Promise {\n await this.rpc.model.switchTo({ modelId: model, ...options });\n }\n\n /**\n * Log a message to the session timeline.\n * The message appears in the session event stream and is visible to SDK consumers\n * and (for non-ephemeral messages) persisted to the session event log on disk.\n *\n * @param message - Human-readable message text\n * @param options - Optional log level and ephemeral flag\n *\n * @example\n * ```typescript\n * await session.log(\"Processing started\");\n * await session.log(\"Disk usage high\", { level: \"warning\" });\n * await session.log(\"Connection failed\", { level: \"error\" });\n * await session.log(\"Debug info\", { ephemeral: true });\n * ```\n */\n async log(\n message: string,\n options?: { level?: \"info\" | \"warning\" | \"error\"; ephemeral?: boolean }\n ): Promise {\n await this.rpc.log({ message, ...options });\n }\n}\n\n/**\n * Type guard that checks whether a value is a {@link ToolResultObject}.\n * A valid object must have a string `textResultForLlm` and a recognized `resultType`.\n */\nfunction isToolResultObject(value: unknown): value is ToolResultObject {\n if (typeof value !== \"object\" || value === null) {\n return false;\n }\n\n if (\n !(\"textResultForLlm\" in value) ||\n typeof (value as ToolResultObject).textResultForLlm !== \"string\"\n ) {\n return false;\n }\n\n if (!(\"resultType\" in value) || typeof (value as ToolResultObject).resultType !== \"string\") {\n return false;\n }\n\n const allowedResultTypes: Array = [\n \"success\",\n \"failure\",\n \"rejected\",\n \"denied\",\n \"timeout\",\n ];\n\n return allowedResultTypes.includes((value as ToolResultObject).resultType);\n}\n" }, { "path": "nodejs/src/sessionFsProvider.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport type {\n SessionFsHandler,\n SessionFsError,\n SessionFsStatResult,\n SessionFsReaddirWithTypesEntry,\n} from \"./generated/rpc.js\";\n\n/**\n * File metadata returned by {@link SessionFsProvider.stat}.\n * Same shape as the generated {@link SessionFsStatResult} but without the\n * `error` field, since providers signal errors by throwing.\n */\nexport type SessionFsFileInfo = Omit;\n\n/**\n * Interface for session filesystem providers. Implementors use idiomatic\n * TypeScript patterns: throw on error, return values directly. Use\n * {@link createSessionFsAdapter} to convert a provider into the\n * {@link SessionFsHandler} expected by the SDK.\n *\n * Errors with a `code` property of `\"ENOENT\"` are mapped to the ENOENT\n * error code; all others map to UNKNOWN.\n */\nexport interface SessionFsProvider {\n /** Reads the full content of a file. Throw if the file does not exist. */\n readFile(path: string): Promise;\n\n /** Writes content to a file, creating parent directories if needed. */\n writeFile(path: string, content: string, mode?: number): Promise;\n\n /** Appends content to a file, creating parent directories if needed. */\n appendFile(path: string, content: string, mode?: number): Promise;\n\n /** Checks whether a path exists. */\n exists(path: string): Promise;\n\n /** Gets metadata about a file or directory. Throw if it does not exist. */\n stat(path: string): Promise;\n\n /** Creates a directory. If recursive is true, creates parents as needed. */\n mkdir(path: string, recursive: boolean, mode?: number): Promise;\n\n /** Lists entry names in a directory. Throw if it does not exist. */\n readdir(path: string): Promise;\n\n /** Lists entries with type info. Throw if the directory does not exist. */\n readdirWithTypes(path: string): Promise;\n\n /** Removes a file or directory. If force is true, do not throw on ENOENT. */\n rm(path: string, recursive: boolean, force: boolean): Promise;\n\n /** Renames/moves a file or directory. */\n rename(src: string, dest: string): Promise;\n}\n\n/**\n * Wraps a {@link SessionFsProvider} into the {@link SessionFsHandler}\n * interface expected by the SDK, converting thrown errors into\n * {@link SessionFsError} results.\n */\nexport function createSessionFsAdapter(provider: SessionFsProvider): SessionFsHandler {\n return {\n readFile: async ({ path }) => {\n try {\n const content = await provider.readFile(path);\n return { content };\n } catch (err) {\n return { content: \"\", error: toSessionFsError(err) };\n }\n },\n writeFile: async ({ path, content, mode }) => {\n try {\n await provider.writeFile(path, content, mode);\n return undefined;\n } catch (err) {\n return toSessionFsError(err);\n }\n },\n appendFile: async ({ path, content, mode }) => {\n try {\n await provider.appendFile(path, content, mode);\n return undefined;\n } catch (err) {\n return toSessionFsError(err);\n }\n },\n exists: async ({ path }) => {\n try {\n return { exists: await provider.exists(path) };\n } catch {\n return { exists: false };\n }\n },\n stat: async ({ path }) => {\n try {\n return await provider.stat(path);\n } catch (err) {\n return {\n isFile: false,\n isDirectory: false,\n size: 0,\n mtime: new Date().toISOString(),\n birthtime: new Date().toISOString(),\n error: toSessionFsError(err),\n };\n }\n },\n mkdir: async ({ path, recursive, mode }) => {\n try {\n await provider.mkdir(path, recursive ?? false, mode);\n return undefined;\n } catch (err) {\n return toSessionFsError(err);\n }\n },\n readdir: async ({ path }) => {\n try {\n const entries = await provider.readdir(path);\n return { entries };\n } catch (err) {\n return { entries: [], error: toSessionFsError(err) };\n }\n },\n readdirWithTypes: async ({ path }) => {\n try {\n const entries = await provider.readdirWithTypes(path);\n return { entries };\n } catch (err) {\n return { entries: [], error: toSessionFsError(err) };\n }\n },\n rm: async ({ path, recursive, force }) => {\n try {\n await provider.rm(path, recursive ?? false, force ?? false);\n return undefined;\n } catch (err) {\n return toSessionFsError(err);\n }\n },\n rename: async ({ src, dest }) => {\n try {\n await provider.rename(src, dest);\n return undefined;\n } catch (err) {\n return toSessionFsError(err);\n }\n },\n };\n}\n\nfunction toSessionFsError(err: unknown): SessionFsError {\n const e = err as NodeJS.ErrnoException;\n const code = e.code === \"ENOENT\" ? \"ENOENT\" : \"UNKNOWN\";\n return { code, message: e.message ?? String(err) };\n}\n" }, { "path": "nodejs/src/telemetry.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\n/**\n * Trace-context helpers.\n *\n * The SDK does not depend on any OpenTelemetry packages. Instead, users\n * provide an {@link TraceContextProvider} callback via client options.\n *\n * @module telemetry\n */\n\nimport type { TraceContext, TraceContextProvider } from \"./types.js\";\n\n/**\n * Calls the user-provided {@link TraceContextProvider} to obtain the current\n * W3C Trace Context. Returns `{}` when no provider is configured.\n */\nexport async function getTraceContext(provider?: TraceContextProvider): Promise {\n if (!provider) return {};\n try {\n return (await provider()) ?? {};\n } catch {\n return {};\n }\n}\n" }, { "path": "nodejs/src/types.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\n/**\n * Type definitions for the Copilot SDK\n */\n\n// Import and re-export generated session event types\nimport type { SessionFsProvider } from \"./sessionFsProvider.js\";\nimport type { SessionEvent as GeneratedSessionEvent } from \"./generated/session-events.js\";\nimport type { CopilotSession } from \"./session.js\";\nexport type SessionEvent = GeneratedSessionEvent;\nexport type { SessionFsProvider } from \"./sessionFsProvider.js\";\nexport { createSessionFsAdapter } from \"./sessionFsProvider.js\";\nexport type { SessionFsFileInfo } from \"./sessionFsProvider.js\";\n\n/**\n * Options for creating a CopilotClient\n */\n/**\n * W3C Trace Context headers used for distributed trace propagation.\n */\nexport interface TraceContext {\n traceparent?: string;\n tracestate?: string;\n}\n\n/**\n * Callback that returns the current W3C Trace Context.\n * Wire this up to your OpenTelemetry (or other tracing) SDK to enable\n * distributed trace propagation between your app and the Copilot CLI.\n */\nexport type TraceContextProvider = () => TraceContext | Promise;\n\n/**\n * Configuration for OpenTelemetry instrumentation.\n *\n * When provided via {@link CopilotClientOptions.telemetry}, the SDK sets\n * the corresponding environment variables on the spawned CLI process so\n * that the CLI's built-in OTel exporter is configured automatically.\n */\nexport interface TelemetryConfig {\n /** OTLP HTTP endpoint URL for trace/metric export. Sets OTEL_EXPORTER_OTLP_ENDPOINT. */\n otlpEndpoint?: string;\n /** File path for JSON-lines trace output. Sets COPILOT_OTEL_FILE_EXPORTER_PATH. */\n filePath?: string;\n /** Exporter backend type: \"otlp-http\" or \"file\". Sets COPILOT_OTEL_EXPORTER_TYPE. */\n exporterType?: string;\n /** Instrumentation scope name. Sets COPILOT_OTEL_SOURCE_NAME. */\n sourceName?: string;\n /** Whether to capture message content (prompts, responses). Sets OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT. */\n captureContent?: boolean;\n}\n\nexport interface CopilotClientOptions {\n /**\n * Path to the CLI executable or JavaScript entry point.\n * If not specified, uses the bundled CLI from the @github/copilot package.\n */\n cliPath?: string;\n\n /**\n * Extra arguments to pass to the CLI executable (inserted before SDK-managed args)\n */\n cliArgs?: string[];\n\n /**\n * Working directory for the CLI process\n * If not set, inherits the current process's working directory\n */\n cwd?: string;\n\n /**\n * Port for the CLI server (TCP mode only)\n * @default 0 (random available port)\n */\n port?: number;\n\n /**\n * Use stdio transport instead of TCP\n * When true, communicates with CLI via stdin/stdout pipes\n * @default true\n */\n useStdio?: boolean;\n\n /**\n * When true, indicates the SDK is running as a child process of the Copilot CLI server, and should\n * use its own stdio for communicating with the existing parent process. Can only be used in combination\n * with useStdio: true.\n */\n isChildProcess?: boolean;\n\n /**\n * URL of an existing Copilot CLI server to connect to over TCP\n * When provided, the client will not spawn a CLI process\n * Format: \"host:port\" or \"http://host:port\" or just \"port\" (defaults to localhost)\n * Examples: \"localhost:8080\", \"http://127.0.0.1:9000\", \"8080\"\n * Mutually exclusive with cliPath, useStdio\n */\n cliUrl?: string;\n\n /**\n * Log level for the CLI server\n */\n logLevel?: \"none\" | \"error\" | \"warning\" | \"info\" | \"debug\" | \"all\";\n\n /**\n * Auto-start the CLI server on first use\n * @default true\n */\n autoStart?: boolean;\n\n /**\n * @deprecated This option has no effect and will be removed in a future release.\n */\n autoRestart?: boolean;\n\n /**\n * Environment variables to pass to the CLI process. If not set, inherits process.env.\n */\n env?: Record;\n\n /**\n * GitHub token to use for authentication.\n * When provided, the token is passed to the CLI server via environment variable.\n * This takes priority over other authentication methods.\n */\n gitHubToken?: string;\n\n /**\n * Whether to use the logged-in user for authentication.\n * When true, the CLI server will attempt to use stored OAuth tokens or gh CLI auth.\n * When false, only explicit tokens (gitHubToken or environment variables) are used.\n * @default true (but defaults to false when gitHubToken is provided)\n */\n useLoggedInUser?: boolean;\n\n /**\n * Custom handler for listing available models.\n * When provided, client.listModels() calls this handler instead of\n * querying the CLI server. Useful in BYOK mode to return models\n * available from your custom provider.\n */\n onListModels?: () => Promise | ModelInfo[];\n\n /**\n * OpenTelemetry configuration for the CLI process.\n * When provided, the corresponding OTel environment variables are set\n * on the spawned CLI server.\n */\n telemetry?: TelemetryConfig;\n\n /**\n * Advanced: callback that returns the current W3C Trace Context for distributed\n * trace propagation. Most users do not need this — the {@link telemetry} config\n * alone is sufficient to collect traces from the CLI.\n *\n * This callback is only useful when your application creates its own\n * OpenTelemetry spans and you want them to appear in the **same** distributed\n * trace as the CLI's spans. The SDK calls this before `session.create`,\n * `session.resume`, and `session.send` RPCs to inject `traceparent`/`tracestate`\n * into the request.\n *\n * @example\n * ```typescript\n * import { propagation, context } from \"@opentelemetry/api\";\n *\n * const client = new CopilotClient({\n * onGetTraceContext: () => {\n * const carrier: Record = {};\n * propagation.inject(context.active(), carrier);\n * return carrier;\n * },\n * });\n * ```\n */\n onGetTraceContext?: TraceContextProvider;\n\n /**\n * Custom session filesystem provider.\n * When provided, the client registers as the session filesystem provider\n * on connection, routing all session-scoped file I/O through these callbacks\n * instead of the server's default local filesystem storage.\n */\n sessionFs?: SessionFsConfig;\n\n /**\n * Server-wide idle timeout for sessions in seconds.\n * Sessions without activity for this duration are automatically cleaned up.\n * Set to 0 or omit to disable (sessions live indefinitely).\n * This option is only used when the SDK spawns the CLI process; it is ignored\n * when connecting to an external server via {@link cliUrl}.\n * @default undefined (disabled)\n */\n sessionIdleTimeoutSeconds?: number;\n}\n\n/**\n * Configuration for creating a session\n */\nexport type ToolResultType = \"success\" | \"failure\" | \"rejected\" | \"denied\" | \"timeout\";\n\nexport type ToolBinaryResult = {\n data: string;\n mimeType: string;\n type: string;\n description?: string;\n};\n\nexport type ToolResultObject = {\n textResultForLlm: string;\n binaryResultsForLlm?: ToolBinaryResult[];\n resultType: ToolResultType;\n error?: string;\n sessionLog?: string;\n toolTelemetry?: Record;\n};\n\nexport type ToolResult = string | ToolResultObject;\n\n// ============================================================================\n// MCP CallToolResult support\n// ============================================================================\n\n/**\n * Content block types within an MCP CallToolResult.\n */\ntype McpCallToolResultTextContent = {\n type: \"text\";\n text: string;\n};\n\ntype McpCallToolResultImageContent = {\n type: \"image\";\n data: string;\n mimeType: string;\n};\n\ntype McpCallToolResultResourceContent = {\n type: \"resource\";\n resource: {\n uri: string;\n mimeType?: string;\n text?: string;\n blob?: string;\n };\n};\n\ntype McpCallToolResultContent =\n | McpCallToolResultTextContent\n | McpCallToolResultImageContent\n | McpCallToolResultResourceContent;\n\n/**\n * MCP-compatible CallToolResult type. Can be passed to\n * {@link convertMcpCallToolResult} to produce a {@link ToolResultObject}.\n */\ntype McpCallToolResult = {\n content: McpCallToolResultContent[];\n isError?: boolean;\n};\n\n/**\n * Converts an MCP CallToolResult into the SDK's ToolResultObject format.\n */\nexport function convertMcpCallToolResult(callResult: McpCallToolResult): ToolResultObject {\n const textParts: string[] = [];\n const binaryResults: ToolBinaryResult[] = [];\n\n for (const block of callResult.content) {\n switch (block.type) {\n case \"text\":\n // Guard against malformed input where text field is missing at runtime\n if (typeof block.text === \"string\") {\n textParts.push(block.text);\n }\n break;\n case \"image\":\n if (\n typeof block.data === \"string\" &&\n block.data &&\n typeof block.mimeType === \"string\"\n ) {\n binaryResults.push({\n data: block.data,\n mimeType: block.mimeType,\n type: \"image\",\n });\n }\n break;\n case \"resource\": {\n // Use optional chaining: resource field may be absent in malformed input\n if (block.resource?.text) {\n textParts.push(block.resource.text);\n }\n if (block.resource?.blob) {\n binaryResults.push({\n data: block.resource.blob,\n mimeType: block.resource.mimeType ?? \"application/octet-stream\",\n type: \"resource\",\n description: block.resource.uri,\n });\n }\n break;\n }\n }\n }\n\n return {\n textResultForLlm: textParts.join(\"\\n\"),\n resultType: callResult.isError ? \"failure\" : \"success\",\n ...(binaryResults.length > 0 ? { binaryResultsForLlm: binaryResults } : {}),\n };\n}\n\nexport interface ToolInvocation {\n sessionId: string;\n toolCallId: string;\n toolName: string;\n arguments: unknown;\n /** W3C Trace Context traceparent from the CLI's execute_tool span. */\n traceparent?: string;\n /** W3C Trace Context tracestate from the CLI's execute_tool span. */\n tracestate?: string;\n}\n\nexport type ToolHandler = (\n args: TArgs,\n invocation: ToolInvocation\n) => Promise | unknown;\n\n/**\n * Zod-like schema interface for type inference.\n * Any object with `toJSONSchema()` method is treated as a Zod schema.\n */\nexport interface ZodSchema {\n _output: T;\n toJSONSchema(): Record;\n}\n\n/**\n * Tool definition. Parameters can be either:\n * - A Zod schema (provides type inference for handler)\n * - A raw JSON schema object\n * - Omitted (no parameters)\n */\nexport interface Tool {\n name: string;\n description?: string;\n parameters?: ZodSchema | Record;\n handler: ToolHandler;\n /**\n * When true, explicitly indicates this tool is intended to override a built-in tool\n * of the same name. If not set and the name clashes with a built-in tool, the runtime\n * will return an error.\n */\n overridesBuiltInTool?: boolean;\n /**\n * When true, the tool can execute without a permission prompt.\n */\n skipPermission?: boolean;\n}\n\n/**\n * Helper to define a tool with Zod schema and get type inference for the handler.\n * Without this helper, TypeScript cannot infer handler argument types from Zod schemas.\n */\nexport function defineTool(\n name: string,\n config: {\n description?: string;\n parameters?: ZodSchema | Record;\n handler: ToolHandler;\n overridesBuiltInTool?: boolean;\n skipPermission?: boolean;\n }\n): Tool {\n return { name, ...config };\n}\n\n// ============================================================================\n// Commands\n// ============================================================================\n\n/**\n * Context passed to a command handler when a command is executed.\n */\nexport interface CommandContext {\n /** Session ID where the command was invoked */\n sessionId: string;\n /** The full command text (e.g. \"/deploy production\") */\n command: string;\n /** Command name without leading / */\n commandName: string;\n /** Raw argument string after the command name */\n args: string;\n}\n\n/**\n * Handler invoked when a registered command is executed by a user.\n */\nexport type CommandHandler = (context: CommandContext) => Promise | void;\n\n/**\n * Definition of a slash command registered with the session.\n * When the CLI is running with a TUI, registered commands appear as\n * `/commandName` for the user to invoke.\n */\nexport interface CommandDefinition {\n /** Command name (without leading /). */\n name: string;\n /** Human-readable description shown in command completion UI. */\n description?: string;\n /** Handler invoked when the command is executed. */\n handler: CommandHandler;\n}\n\n// ============================================================================\n// UI Elicitation\n// ============================================================================\n\n/**\n * Capabilities reported by the CLI host for this session.\n */\nexport interface SessionCapabilities {\n ui?: {\n /** Whether the host supports interactive elicitation dialogs. */\n elicitation?: boolean;\n };\n}\n\n/**\n * A single field in an elicitation schema — matches the MCP SDK's\n * `PrimitiveSchemaDefinition` union.\n */\nexport type ElicitationSchemaField =\n | {\n type: \"string\";\n title?: string;\n description?: string;\n enum: string[];\n enumNames?: string[];\n default?: string;\n }\n | {\n type: \"string\";\n title?: string;\n description?: string;\n oneOf: { const: string; title: string }[];\n default?: string;\n }\n | {\n type: \"array\";\n title?: string;\n description?: string;\n minItems?: number;\n maxItems?: number;\n items: { type: \"string\"; enum: string[] };\n default?: string[];\n }\n | {\n type: \"array\";\n title?: string;\n description?: string;\n minItems?: number;\n maxItems?: number;\n items: { anyOf: { const: string; title: string }[] };\n default?: string[];\n }\n | {\n type: \"boolean\";\n title?: string;\n description?: string;\n default?: boolean;\n }\n | {\n type: \"string\";\n title?: string;\n description?: string;\n minLength?: number;\n maxLength?: number;\n format?: \"email\" | \"uri\" | \"date\" | \"date-time\";\n default?: string;\n }\n | {\n type: \"number\" | \"integer\";\n title?: string;\n description?: string;\n minimum?: number;\n maximum?: number;\n default?: number;\n };\n\n/**\n * Schema describing the form fields for an elicitation request.\n */\nexport interface ElicitationSchema {\n type: \"object\";\n properties: Record;\n required?: string[];\n}\n\n/**\n * Primitive field value in an elicitation result.\n * Matches MCP SDK's `ElicitResult.content` value type.\n */\nexport type ElicitationFieldValue = string | number | boolean | string[];\n\n/**\n * Result returned from an elicitation request.\n */\nexport interface ElicitationResult {\n /** User action: \"accept\" (submitted), \"decline\" (rejected), or \"cancel\" (dismissed). */\n action: \"accept\" | \"decline\" | \"cancel\";\n /** Form values submitted by the user (present when action is \"accept\"). */\n content?: Record;\n}\n\n/**\n * Parameters for a raw elicitation request.\n */\nexport interface ElicitationParams {\n /** Message describing what information is needed from the user. */\n message: string;\n /** JSON Schema describing the form fields to present. */\n requestedSchema: ElicitationSchema;\n}\n\n/**\n * Context for an elicitation handler invocation, combining the request data\n * with session context. Mirrors the single-argument pattern of {@link CommandContext}.\n */\nexport interface ElicitationContext {\n /** Identifier of the session that triggered the elicitation request. */\n sessionId: string;\n /** Message describing what information is needed from the user. */\n message: string;\n /** JSON Schema describing the form fields to present. */\n requestedSchema?: ElicitationSchema;\n /** Elicitation mode: \"form\" for structured input, \"url\" for browser redirect. */\n mode?: \"form\" | \"url\";\n /** The source that initiated the request (e.g. MCP server name). */\n elicitationSource?: string;\n /** URL to open in the user's browser (url mode only). */\n url?: string;\n}\n\n/**\n * Handler invoked when the server dispatches an elicitation request to this client.\n * Return an {@link ElicitationResult} with the user's response.\n */\nexport type ElicitationHandler = (\n context: ElicitationContext\n) => Promise | ElicitationResult;\n\n/**\n * Options for the `input()` convenience method.\n */\nexport interface InputOptions {\n /** Title label for the input field. */\n title?: string;\n /** Descriptive text shown below the field. */\n description?: string;\n /** Minimum character length. */\n minLength?: number;\n /** Maximum character length. */\n maxLength?: number;\n /** Semantic format hint. */\n format?: \"email\" | \"uri\" | \"date\" | \"date-time\";\n /** Default value pre-populated in the field. */\n default?: string;\n}\n\n/**\n * The `session.ui` API object providing interactive UI methods.\n * Only usable when the CLI host supports elicitation.\n */\nexport interface SessionUiApi {\n /**\n * Shows a generic elicitation dialog with a custom schema.\n * @throws Error if the host does not support elicitation.\n */\n elicitation(params: ElicitationParams): Promise;\n\n /**\n * Shows a confirmation dialog and returns the user's boolean answer.\n * Returns `false` if the user declines or cancels.\n * @throws Error if the host does not support elicitation.\n */\n confirm(message: string): Promise;\n\n /**\n * Shows a selection dialog with the given options.\n * Returns the selected value, or `null` if the user declines/cancels.\n * @throws Error if the host does not support elicitation.\n */\n select(message: string, options: string[]): Promise;\n\n /**\n * Shows a text input dialog.\n * Returns the entered text, or `null` if the user declines/cancels.\n * @throws Error if the host does not support elicitation.\n */\n input(message: string, options?: InputOptions): Promise;\n}\n\nexport interface ToolCallRequestPayload {\n sessionId: string;\n toolCallId: string;\n toolName: string;\n arguments: unknown;\n}\n\nexport interface ToolCallResponsePayload {\n result: ToolResult;\n}\n\n/**\n * Known system prompt section identifiers for the \"customize\" mode.\n * Each section corresponds to a distinct part of the system prompt.\n */\nexport type SystemPromptSection =\n | \"identity\"\n | \"tone\"\n | \"tool_efficiency\"\n | \"environment_context\"\n | \"code_change_rules\"\n | \"guidelines\"\n | \"safety\"\n | \"tool_instructions\"\n | \"custom_instructions\"\n | \"last_instructions\";\n\n/** Section metadata for documentation and tooling. */\nexport const SYSTEM_PROMPT_SECTIONS: Record = {\n identity: { description: \"Agent identity preamble and mode statement\" },\n tone: { description: \"Response style, conciseness rules, output formatting preferences\" },\n tool_efficiency: { description: \"Tool usage patterns, parallel calling, batching guidelines\" },\n environment_context: { description: \"CWD, OS, git root, directory listing, available tools\" },\n code_change_rules: { description: \"Coding rules, linting/testing, ecosystem tools, style\" },\n guidelines: { description: \"Tips, behavioral best practices, behavioral guidelines\" },\n safety: { description: \"Environment limitations, prohibited actions, security policies\" },\n tool_instructions: { description: \"Per-tool usage instructions\" },\n custom_instructions: { description: \"Repository and organization custom instructions\" },\n last_instructions: {\n description:\n \"End-of-prompt instructions: parallel tool calling, persistence, task completion\",\n },\n};\n\n/**\n * Transform callback for a single section: receives current content, returns new content.\n */\nexport type SectionTransformFn = (currentContent: string) => string | Promise;\n\n/**\n * Override action: a string literal for static overrides, or a callback for transforms.\n *\n * - `\"replace\"`: Replace section content entirely\n * - `\"remove\"`: Remove the section\n * - `\"append\"`: Append to existing section content\n * - `\"prepend\"`: Prepend to existing section content\n * - `function`: Transform callback — receives current section content, returns new content\n */\nexport type SectionOverrideAction =\n | \"replace\"\n | \"remove\"\n | \"append\"\n | \"prepend\"\n | SectionTransformFn;\n\n/**\n * Override operation for a single system prompt section.\n */\nexport interface SectionOverride {\n /**\n * The operation to perform on this section.\n * Can be a string action or a transform callback function.\n */\n action: SectionOverrideAction;\n\n /**\n * Content for the override. Optional for all actions.\n * - For replace, omitting content replaces with an empty string.\n * - For append/prepend, content is added before/after the existing section.\n * - Ignored for the remove action.\n */\n content?: string;\n}\n\n/**\n * Append mode: Use CLI foundation with optional appended content (default).\n */\nexport interface SystemMessageAppendConfig {\n mode?: \"append\";\n\n /**\n * Additional instructions appended after SDK-managed sections.\n */\n content?: string;\n}\n\n/**\n * Replace mode: Use caller-provided system message entirely.\n * Removes all SDK guardrails including security restrictions.\n */\nexport interface SystemMessageReplaceConfig {\n mode: \"replace\";\n\n /**\n * Complete system message content.\n * Replaces the entire SDK-managed system message.\n */\n content: string;\n}\n\n/**\n * Customize mode: Override individual sections of the system prompt.\n * Keeps the SDK-managed prompt structure while allowing targeted modifications.\n */\nexport interface SystemMessageCustomizeConfig {\n mode: \"customize\";\n\n /**\n * Override specific sections of the system prompt by section ID.\n * Unknown section IDs gracefully fall back: content-bearing overrides are appended\n * to additional instructions, and \"remove\" on unknown sections is a silent no-op.\n */\n sections?: Partial>;\n\n /**\n * Additional content appended after all sections.\n * Equivalent to append mode's content field — provided for convenience.\n */\n content?: string;\n}\n\n/**\n * System message configuration for session creation.\n * - Append mode (default): SDK foundation + optional custom content\n * - Replace mode: Full control, caller provides entire system message\n * - Customize mode: Section-level overrides with graceful fallback\n */\nexport type SystemMessageConfig =\n | SystemMessageAppendConfig\n | SystemMessageReplaceConfig\n | SystemMessageCustomizeConfig;\n\n/**\n * Permission request types from the server\n */\nexport interface PermissionRequest {\n kind: \"shell\" | \"write\" | \"mcp\" | \"read\" | \"url\" | \"custom-tool\" | \"memory\" | \"hook\";\n toolCallId?: string;\n}\n\nimport type { PermissionDecisionRequest } from \"./generated/rpc.js\";\n\nexport type PermissionRequestResult = PermissionDecisionRequest[\"result\"] | { kind: \"no-result\" };\n\nexport type PermissionHandler = (\n request: PermissionRequest,\n invocation: { sessionId: string }\n) => Promise | PermissionRequestResult;\n\nexport const approveAll: PermissionHandler = () => ({ kind: \"approve-once\" });\n\nexport const defaultJoinSessionPermissionHandler: PermissionHandler =\n (): PermissionRequestResult => ({\n kind: \"no-result\",\n });\n\n// ============================================================================\n// User Input Request Types\n// ============================================================================\n\n/**\n * Request for user input from the agent (enables ask_user tool)\n */\nexport interface UserInputRequest {\n /**\n * The question to ask the user\n */\n question: string;\n\n /**\n * Optional choices for multiple choice questions\n */\n choices?: string[];\n\n /**\n * Whether to allow freeform text input in addition to choices\n * @default true\n */\n allowFreeform?: boolean;\n}\n\n/**\n * Response to a user input request\n */\nexport interface UserInputResponse {\n /**\n * The user's answer\n */\n answer: string;\n\n /**\n * Whether the answer was freeform (not from choices)\n */\n wasFreeform: boolean;\n}\n\n/**\n * Handler for user input requests from the agent\n */\nexport type UserInputHandler = (\n request: UserInputRequest,\n invocation: { sessionId: string }\n) => Promise | UserInputResponse;\n\n// ============================================================================\n// Hook Types\n// ============================================================================\n\n/**\n * Base interface for all hook inputs\n */\nexport interface BaseHookInput {\n timestamp: number;\n cwd: string;\n}\n\n/**\n * Input for pre-tool-use hook\n */\nexport interface PreToolUseHookInput extends BaseHookInput {\n toolName: string;\n toolArgs: unknown;\n}\n\n/**\n * Output for pre-tool-use hook\n */\nexport interface PreToolUseHookOutput {\n permissionDecision?: \"allow\" | \"deny\" | \"ask\";\n permissionDecisionReason?: string;\n modifiedArgs?: unknown;\n additionalContext?: string;\n suppressOutput?: boolean;\n}\n\n/**\n * Handler for pre-tool-use hook\n */\nexport type PreToolUseHandler = (\n input: PreToolUseHookInput,\n invocation: { sessionId: string }\n) => Promise | PreToolUseHookOutput | void;\n\n/**\n * Input for post-tool-use hook\n */\nexport interface PostToolUseHookInput extends BaseHookInput {\n toolName: string;\n toolArgs: unknown;\n toolResult: ToolResultObject;\n}\n\n/**\n * Output for post-tool-use hook\n */\nexport interface PostToolUseHookOutput {\n modifiedResult?: ToolResultObject;\n additionalContext?: string;\n suppressOutput?: boolean;\n}\n\n/**\n * Handler for post-tool-use hook\n */\nexport type PostToolUseHandler = (\n input: PostToolUseHookInput,\n invocation: { sessionId: string }\n) => Promise | PostToolUseHookOutput | void;\n\n/**\n * Input for user-prompt-submitted hook\n */\nexport interface UserPromptSubmittedHookInput extends BaseHookInput {\n prompt: string;\n}\n\n/**\n * Output for user-prompt-submitted hook\n */\nexport interface UserPromptSubmittedHookOutput {\n modifiedPrompt?: string;\n additionalContext?: string;\n suppressOutput?: boolean;\n}\n\n/**\n * Handler for user-prompt-submitted hook\n */\nexport type UserPromptSubmittedHandler = (\n input: UserPromptSubmittedHookInput,\n invocation: { sessionId: string }\n) => Promise | UserPromptSubmittedHookOutput | void;\n\n/**\n * Input for session-start hook\n */\nexport interface SessionStartHookInput extends BaseHookInput {\n source: \"startup\" | \"resume\" | \"new\";\n initialPrompt?: string;\n}\n\n/**\n * Output for session-start hook\n */\nexport interface SessionStartHookOutput {\n additionalContext?: string;\n modifiedConfig?: Record;\n}\n\n/**\n * Handler for session-start hook\n */\nexport type SessionStartHandler = (\n input: SessionStartHookInput,\n invocation: { sessionId: string }\n) => Promise | SessionStartHookOutput | void;\n\n/**\n * Input for session-end hook\n */\nexport interface SessionEndHookInput extends BaseHookInput {\n reason: \"complete\" | \"error\" | \"abort\" | \"timeout\" | \"user_exit\";\n finalMessage?: string;\n error?: string;\n}\n\n/**\n * Output for session-end hook\n */\nexport interface SessionEndHookOutput {\n suppressOutput?: boolean;\n cleanupActions?: string[];\n sessionSummary?: string;\n}\n\n/**\n * Handler for session-end hook\n */\nexport type SessionEndHandler = (\n input: SessionEndHookInput,\n invocation: { sessionId: string }\n) => Promise | SessionEndHookOutput | void;\n\n/**\n * Input for error-occurred hook\n */\nexport interface ErrorOccurredHookInput extends BaseHookInput {\n error: string;\n errorContext: \"model_call\" | \"tool_execution\" | \"system\" | \"user_input\";\n recoverable: boolean;\n}\n\n/**\n * Output for error-occurred hook\n */\nexport interface ErrorOccurredHookOutput {\n suppressOutput?: boolean;\n errorHandling?: \"retry\" | \"skip\" | \"abort\";\n retryCount?: number;\n userNotification?: string;\n}\n\n/**\n * Handler for error-occurred hook\n */\nexport type ErrorOccurredHandler = (\n input: ErrorOccurredHookInput,\n invocation: { sessionId: string }\n) => Promise | ErrorOccurredHookOutput | void;\n\n/**\n * Configuration for session hooks\n */\nexport interface SessionHooks {\n /**\n * Called before a tool is executed\n */\n onPreToolUse?: PreToolUseHandler;\n\n /**\n * Called after a tool is executed\n */\n onPostToolUse?: PostToolUseHandler;\n\n /**\n * Called when the user submits a prompt\n */\n onUserPromptSubmitted?: UserPromptSubmittedHandler;\n\n /**\n * Called when a session starts\n */\n onSessionStart?: SessionStartHandler;\n\n /**\n * Called when a session ends\n */\n onSessionEnd?: SessionEndHandler;\n\n /**\n * Called when an error occurs\n */\n onErrorOccurred?: ErrorOccurredHandler;\n}\n\n// ============================================================================\n// MCP Server Configuration Types\n// ============================================================================\n\n/**\n * Base interface for MCP server configuration.\n */\ninterface MCPServerConfigBase {\n /**\n * List of tools to include from this server. [] means none. \"*\" means all.\n */\n tools: string[];\n /**\n * Indicates the server type: \"stdio\" for local/subprocess servers, \"http\"/\"sse\" for remote servers.\n * If not specified, defaults to \"stdio\".\n */\n type?: string;\n /**\n * Optional timeout in milliseconds for tool calls to this server.\n */\n timeout?: number;\n}\n\n/**\n * Configuration for a local/stdio MCP server.\n */\nexport interface MCPStdioServerConfig extends MCPServerConfigBase {\n type?: \"local\" | \"stdio\";\n command: string;\n args: string[];\n /**\n * Environment variables to pass to the server.\n */\n env?: Record;\n cwd?: string;\n}\n\n/**\n * Configuration for a remote MCP server (HTTP or SSE).\n */\nexport interface MCPHTTPServerConfig extends MCPServerConfigBase {\n type: \"http\" | \"sse\";\n /**\n * URL of the remote server.\n */\n url: string;\n /**\n * Optional HTTP headers to include in requests.\n */\n headers?: Record;\n}\n\n/**\n * Union type for MCP server configurations.\n */\nexport type MCPServerConfig = MCPStdioServerConfig | MCPHTTPServerConfig;\n\n// ============================================================================\n// Custom Agent Configuration Types\n// ============================================================================\n\n/**\n * Configuration for a custom agent.\n */\nexport interface CustomAgentConfig {\n /**\n * Unique name of the custom agent.\n */\n name: string;\n /**\n * Display name for UI purposes.\n */\n displayName?: string;\n /**\n * Description of what the agent does.\n */\n description?: string;\n /**\n * List of tool names the agent can use.\n * Use null or undefined for all tools.\n */\n tools?: string[] | null;\n /**\n * The prompt content for the agent.\n */\n prompt: string;\n /**\n * MCP servers specific to this agent.\n */\n mcpServers?: Record;\n /**\n * Whether the agent should be available for model inference.\n * @default true\n */\n infer?: boolean;\n /**\n * List of skill names to preload into this agent's context.\n * When set, the full content of each listed skill is eagerly injected into\n * the agent's context at startup. Skills are resolved by name from the\n * session's configured skill directories (`skillDirectories`).\n * When omitted, no skills are injected (opt-in model).\n */\n skills?: string[];\n}\n\n/**\n * Configuration for the default agent (the built-in agent that handles\n * turns when no custom agent is selected).\n * Use this to control tool visibility for the default agent independently of custom sub-agents.\n */\nexport interface DefaultAgentConfig {\n /**\n * List of tool names to exclude from the default agent.\n * These tools remain available to custom sub-agents that reference them in their `tools` array.\n * Use this to register tools that should only be accessed via delegation to sub-agents,\n * keeping the default agent's context clean.\n */\n excludedTools?: string[];\n}\n\n/**\n * Configuration for infinite sessions with automatic context compaction and workspace persistence.\n * When enabled, sessions automatically manage context window limits through background compaction\n * and persist state to a workspace directory.\n */\nexport interface InfiniteSessionConfig {\n /**\n * Whether infinite sessions are enabled.\n * @default true\n */\n enabled?: boolean;\n\n /**\n * Context utilization threshold (0.0-1.0) at which background compaction starts.\n * Compaction runs asynchronously, allowing the session to continue processing.\n * @default 0.80\n */\n backgroundCompactionThreshold?: number;\n\n /**\n * Context utilization threshold (0.0-1.0) at which the session blocks until compaction completes.\n * This prevents context overflow when compaction hasn't finished in time.\n * @default 0.95\n */\n bufferExhaustionThreshold?: number;\n}\n\n/**\n * Valid reasoning effort levels for models that support it.\n */\nexport type ReasoningEffort = \"low\" | \"medium\" | \"high\" | \"xhigh\";\n\nexport interface SessionConfig {\n /**\n * Optional custom session ID\n * If not provided, server will generate one\n */\n sessionId?: string;\n\n /**\n * Client name to identify the application using the SDK.\n * Included in the User-Agent header for API requests.\n */\n clientName?: string;\n\n /**\n * Model to use for this session\n */\n model?: string;\n\n /**\n * Reasoning effort level for models that support it.\n * Only valid for models where capabilities.supports.reasoningEffort is true.\n * Use client.listModels() to check supported values for each model.\n */\n reasoningEffort?: ReasoningEffort;\n\n /** Per-property overrides for model capabilities, deep-merged over runtime defaults. */\n modelCapabilities?: ModelCapabilitiesOverride;\n\n /**\n * Override the default configuration directory location.\n * When specified, the session will use this directory for storing config and state.\n */\n configDir?: string;\n\n /**\n * When true, automatically discovers MCP server configurations (e.g. `.mcp.json`,\n * `.vscode/mcp.json`) and skill directories from the working directory and merges\n * them with any explicitly provided `mcpServers` and `skillDirectories`, with\n * explicit values taking precedence on name collision.\n *\n * Note: custom instruction files (`.github/copilot-instructions.md`, `AGENTS.md`, etc.)\n * are always loaded from the working directory regardless of this setting.\n *\n * @default false\n */\n enableConfigDiscovery?: boolean;\n\n /**\n * Tools exposed to the CLI server\n */\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n tools?: Tool[];\n\n /**\n * Slash commands registered for this session.\n * When the CLI has a TUI, each command appears as `/name` for the user to invoke.\n * The handler is called when the user executes the command.\n */\n commands?: CommandDefinition[];\n\n /**\n * System message configuration\n * Controls how the system prompt is constructed\n */\n systemMessage?: SystemMessageConfig;\n\n /**\n * List of tool names to allow. When specified, only these tools will be available.\n * Takes precedence over excludedTools.\n */\n availableTools?: string[];\n\n /**\n * List of tool names to disable. All other tools remain available.\n * Ignored if availableTools is specified.\n */\n excludedTools?: string[];\n\n /**\n * Custom provider configuration (BYOK - Bring Your Own Key).\n * When specified, uses the provided API endpoint instead of the Copilot API.\n */\n provider?: ProviderConfig;\n\n /**\n * Handler for permission requests from the server.\n * When provided, the server will call this handler to request permission for operations.\n */\n onPermissionRequest: PermissionHandler;\n\n /**\n * Handler for user input requests from the agent.\n * When provided, enables the ask_user tool allowing the agent to ask questions.\n */\n onUserInputRequest?: UserInputHandler;\n\n /**\n * Handler for elicitation requests from the agent.\n * When provided, the server calls back to this client for form-based UI dialogs.\n * Also enables the `elicitation` capability on the session.\n */\n onElicitationRequest?: ElicitationHandler;\n\n /**\n * Hook handlers for intercepting session lifecycle events.\n * When provided, enables hooks callback allowing custom logic at various points.\n */\n hooks?: SessionHooks;\n\n /**\n * Working directory for the session.\n * Tool operations will be relative to this directory.\n */\n workingDirectory?: string;\n\n /*\n * Enable streaming of assistant message and reasoning chunks.\n * When true, ephemeral assistant.message_delta and assistant.reasoning_delta\n * events are sent as the response is generated. Clients should accumulate\n * deltaContent values to build the full response.\n * @default false\n */\n streaming?: boolean;\n\n /**\n * Include sub-agent streaming events in the event stream. When true, streaming\n * delta events from sub-agents (e.g., `assistant.message_delta`,\n * `assistant.reasoning_delta`, `assistant.streaming_delta` with `agentId` set)\n * are forwarded to this connection. When false, only non-streaming sub-agent\n * events and `subagent.*` lifecycle events are forwarded; streaming deltas from\n * sub-agents are suppressed.\n * @default true\n */\n includeSubAgentStreamingEvents?: boolean;\n\n /**\n * MCP server configurations for the session.\n * Keys are server names, values are server configurations.\n */\n mcpServers?: Record;\n\n /**\n * Custom agent configurations for the session.\n */\n customAgents?: CustomAgentConfig[];\n\n /**\n * Configuration for the default agent (the built-in agent that handles\n * turns when no custom agent is selected).\n * Use `excludedTools` to hide specific tools from the default agent while keeping\n * them available to custom sub-agents.\n */\n defaultAgent?: DefaultAgentConfig;\n\n /**\n * Name of the custom agent to activate when the session starts.\n * Must match the `name` of one of the agents in `customAgents`.\n * Equivalent to calling `session.rpc.agent.select({ name })` after creation.\n */\n agent?: string;\n\n /**\n * Directories to load skills from.\n */\n skillDirectories?: string[];\n\n /**\n * List of skill names to disable.\n */\n disabledSkills?: string[];\n\n /**\n * Infinite session configuration for persistent workspaces and automatic compaction.\n * When enabled (default), sessions automatically manage context limits and persist state.\n * Set to `{ enabled: false }` to disable.\n */\n infiniteSessions?: InfiniteSessionConfig;\n\n /**\n * GitHub token for per-session authentication.\n * When provided, the runtime resolves this token into a full GitHub identity\n * (login, Copilot plan, endpoints) and stores it on the session. This enables\n * multitenancy — different sessions can have different GitHub identities.\n *\n * This is independent of the client-level `gitHubToken` in {@link CopilotClientOptions},\n * which authenticates the CLI process itself. The session-level token determines\n * the identity used for content exclusion, model routing, and quota checks.\n */\n gitHubToken?: string;\n\n /**\n * Optional event handler that is registered on the session before the\n * session.create RPC is issued. This guarantees that early events emitted\n * by the CLI during session creation (e.g. session.start) are delivered to\n * the handler.\n *\n * Equivalent to calling `session.on(handler)` immediately after creation,\n * but executes earlier in the lifecycle so no events are missed.\n */\n onEvent?: SessionEventHandler;\n\n /**\n * Supplies a handler for session filesystem operations. This takes effect\n * only if {@link CopilotClientOptions.sessionFs} is configured.\n */\n createSessionFsHandler?: (session: CopilotSession) => SessionFsProvider;\n}\n\n/**\n * Configuration for resuming a session\n */\nexport type ResumeSessionConfig = Pick<\n SessionConfig,\n | \"clientName\"\n | \"model\"\n | \"tools\"\n | \"commands\"\n | \"systemMessage\"\n | \"availableTools\"\n | \"excludedTools\"\n | \"provider\"\n | \"modelCapabilities\"\n | \"streaming\"\n | \"includeSubAgentStreamingEvents\"\n | \"reasoningEffort\"\n | \"onPermissionRequest\"\n | \"onUserInputRequest\"\n | \"onElicitationRequest\"\n | \"hooks\"\n | \"workingDirectory\"\n | \"configDir\"\n | \"enableConfigDiscovery\"\n | \"mcpServers\"\n | \"customAgents\"\n | \"defaultAgent\"\n | \"agent\"\n | \"skillDirectories\"\n | \"disabledSkills\"\n | \"infiniteSessions\"\n | \"gitHubToken\"\n | \"onEvent\"\n | \"createSessionFsHandler\"\n> & {\n /**\n * When true, skips emitting the session.resume event.\n * Useful for reconnecting to a session without triggering resume-related side effects.\n * @default false\n */\n disableResume?: boolean;\n /**\n * When true, the runtime continues any tool calls or permission prompts that were\n * still pending when the session was last suspended. When false (the default), the\n * runtime treats pending work as interrupted on resume.\n *\n * For permission requests, the runtime re-emits `permission.requested` so the\n * registered `onPermissionRequest` handler can re-prompt; for external tool calls,\n * the consumer is expected to supply the result via the corresponding low-level\n * RPC method.\n * @default false\n */\n continuePendingWork?: boolean;\n};\n\n/**\n * Configuration for a custom API provider.\n */\nexport interface ProviderConfig {\n /**\n * Provider type. Defaults to \"openai\" for generic OpenAI-compatible APIs.\n */\n type?: \"openai\" | \"azure\" | \"anthropic\";\n\n /**\n * API format (openai/azure only). Defaults to \"completions\".\n */\n wireApi?: \"completions\" | \"responses\";\n\n /**\n * API endpoint URL\n */\n baseUrl: string;\n\n /**\n * API key. Optional for local providers like Ollama.\n */\n apiKey?: string;\n\n /**\n * Bearer token for authentication. Sets the Authorization header directly.\n * Use this for services requiring bearer token auth instead of API key.\n * Takes precedence over apiKey when both are set.\n */\n bearerToken?: string;\n\n /**\n * Azure-specific options\n */\n azure?: {\n /**\n * API version. Defaults to \"2024-10-21\".\n */\n apiVersion?: string;\n };\n\n /**\n * Custom HTTP headers to include in outbound provider requests.\n */\n headers?: Record;\n}\n\n/**\n * Options for sending a message to a session\n */\nexport interface MessageOptions {\n /**\n * The prompt/message to send\n */\n prompt: string;\n\n /**\n * File, directory, selection, or blob attachments\n */\n attachments?: Array<\n | {\n type: \"file\";\n path: string;\n displayName?: string;\n }\n | {\n type: \"directory\";\n path: string;\n displayName?: string;\n }\n | {\n type: \"selection\";\n filePath: string;\n displayName: string;\n selection?: {\n start: { line: number; character: number };\n end: { line: number; character: number };\n };\n text?: string;\n }\n | {\n type: \"blob\";\n data: string;\n mimeType: string;\n displayName?: string;\n }\n >;\n\n /**\n * Message delivery mode\n * - \"enqueue\": Add to queue (default)\n * - \"immediate\": Send immediately\n */\n mode?: \"enqueue\" | \"immediate\";\n\n /**\n * Custom HTTP headers to include in outbound model requests for this turn.\n */\n requestHeaders?: Record;\n}\n\n/**\n * All possible event type strings from SessionEvent\n */\nexport type SessionEventType = SessionEvent[\"type\"];\n\n/**\n * Extract the specific event payload for a given event type\n */\nexport type SessionEventPayload = Extract;\n\n/**\n * Event handler for a specific event type\n */\nexport type TypedSessionEventHandler = (\n event: SessionEventPayload\n) => void;\n\n/**\n * Event handler callback type (for all events)\n */\nexport type SessionEventHandler = (event: SessionEvent) => void;\n\n/**\n * Connection state\n */\nexport type ConnectionState = \"disconnected\" | \"connecting\" | \"connected\" | \"error\";\n\n/**\n * Working directory context for a session\n */\nexport interface SessionContext {\n /** Working directory where the session was created */\n cwd: string;\n /** Git repository root (if in a git repo) */\n gitRoot?: string;\n /** GitHub repository in \"owner/repo\" format */\n repository?: string;\n /** Current git branch */\n branch?: string;\n}\n\n/**\n * Configuration for a custom session filesystem provider.\n */\nexport interface SessionFsConfig {\n /**\n * Initial working directory for sessions (user's project directory).\n */\n initialCwd: string;\n\n /**\n * Path within each session's SessionFs where the runtime stores\n * session-scoped files (events, workspace, checkpoints, etc.).\n */\n sessionStatePath: string;\n\n /**\n * Path conventions used by this filesystem provider.\n */\n conventions: \"windows\" | \"posix\";\n}\n\n/**\n * Filter options for listing sessions\n */\nexport interface SessionListFilter {\n /** Filter by exact cwd match */\n cwd?: string;\n /** Filter by git root */\n gitRoot?: string;\n /** Filter by repository (owner/repo format) */\n repository?: string;\n /** Filter by branch */\n branch?: string;\n}\n\n/**\n * Metadata about a session\n */\nexport interface SessionMetadata {\n sessionId: string;\n startTime: Date;\n modifiedTime: Date;\n summary?: string;\n isRemote: boolean;\n /** Working directory context (cwd, git info) from session creation */\n context?: SessionContext;\n}\n\n/**\n * Response from status.get\n */\nexport interface GetStatusResponse {\n /** Package version (e.g., \"1.0.0\") */\n version: string;\n /** Protocol version for SDK compatibility */\n protocolVersion: number;\n}\n\n/**\n * Response from auth.getStatus\n */\nexport interface GetAuthStatusResponse {\n /** Whether the user is authenticated */\n isAuthenticated: boolean;\n /** Authentication type */\n authType?: \"user\" | \"env\" | \"gh-cli\" | \"hmac\" | \"api-key\" | \"token\";\n /** GitHub host URL */\n host?: string;\n /** User login name */\n login?: string;\n /** Human-readable status message */\n statusMessage?: string;\n}\n\n/**\n * Model capabilities and limits\n */\nexport interface ModelCapabilities {\n supports: {\n vision: boolean;\n /** Whether this model supports reasoning effort configuration */\n reasoningEffort: boolean;\n };\n limits: {\n max_prompt_tokens?: number;\n max_context_window_tokens: number;\n vision?: {\n supported_media_types: string[];\n max_prompt_images: number;\n max_prompt_image_size: number;\n };\n };\n}\n\n/** Recursively makes all properties optional, preserving arrays as-is. */\ntype DeepPartial = T extends readonly (infer U)[]\n ? DeepPartial[]\n : T extends object\n ? { [K in keyof T]?: DeepPartial }\n : T;\n\n/** Deep-partial override for model capabilities — every property at any depth is optional. */\nexport type ModelCapabilitiesOverride = DeepPartial;\n\n/**\n * Model policy state\n */\nexport interface ModelPolicy {\n state: \"enabled\" | \"disabled\" | \"unconfigured\";\n terms: string;\n}\n\n/**\n * Model billing information\n */\nexport interface ModelBilling {\n multiplier: number;\n}\n\n/**\n * Information about an available model\n */\nexport interface ModelInfo {\n /** Model identifier (e.g., \"claude-sonnet-4.5\") */\n id: string;\n /** Display name */\n name: string;\n /** Model capabilities and limits */\n capabilities: ModelCapabilities;\n /** Policy state */\n policy?: ModelPolicy;\n /** Billing information */\n billing?: ModelBilling;\n /** Supported reasoning effort levels (only present if model supports reasoning effort) */\n supportedReasoningEfforts?: ReasoningEffort[];\n /** Default reasoning effort level (only present if model supports reasoning effort) */\n defaultReasoningEffort?: ReasoningEffort;\n}\n\n// ============================================================================\n// Session Lifecycle Types (for TUI+server mode)\n// ============================================================================\n\n/**\n * Types of session lifecycle events\n */\nexport type SessionLifecycleEventType =\n | \"session.created\"\n | \"session.deleted\"\n | \"session.updated\"\n | \"session.foreground\"\n | \"session.background\";\n\n/**\n * Session lifecycle event notification\n * Sent when sessions are created, deleted, updated, or change foreground/background state\n */\nexport interface SessionLifecycleEvent {\n /** Type of lifecycle event */\n type: SessionLifecycleEventType;\n /** ID of the session this event relates to */\n sessionId: string;\n /** Session metadata (not included for deleted sessions) */\n metadata?: {\n startTime: string;\n modifiedTime: string;\n summary?: string;\n };\n}\n\n/**\n * Handler for session lifecycle events\n */\nexport type SessionLifecycleHandler = (event: SessionLifecycleEvent) => void;\n\n/**\n * Typed handler for specific session lifecycle event types\n */\nexport type TypedSessionLifecycleHandler = (\n event: SessionLifecycleEvent & { type: K }\n) => void;\n\n/**\n * Information about the foreground session in TUI+server mode\n */\nexport interface ForegroundSessionInfo {\n /** ID of the foreground session, or undefined if none */\n sessionId?: string;\n /** Workspace path of the foreground session */\n workspacePath?: string;\n}\n" }, { "path": "nodejs/test/call-tool-result.test.ts", "content": "import { describe, expect, it } from \"vitest\";\nimport { convertMcpCallToolResult } from \"../src/types.js\";\n\ntype McpCallToolResult = Parameters[0];\n\ndescribe(\"convertMcpCallToolResult\", () => {\n it(\"extracts text from text content blocks\", () => {\n const input: McpCallToolResult = {\n content: [\n { type: \"text\", text: \"line 1\" },\n { type: \"text\", text: \"line 2\" },\n ],\n };\n\n const result = convertMcpCallToolResult(input);\n\n expect(result.textResultForLlm).toBe(\"line 1\\nline 2\");\n expect(result.resultType).toBe(\"success\");\n expect(result.binaryResultsForLlm).toBeUndefined();\n });\n\n it(\"maps isError to failure resultType\", () => {\n const input: McpCallToolResult = {\n content: [{ type: \"text\", text: \"error occurred\" }],\n isError: true,\n };\n\n const result = convertMcpCallToolResult(input);\n\n expect(result.textResultForLlm).toBe(\"error occurred\");\n expect(result.resultType).toBe(\"failure\");\n });\n\n it(\"maps isError: false to success\", () => {\n const input: McpCallToolResult = {\n content: [{ type: \"text\", text: \"ok\" }],\n isError: false,\n };\n\n expect(convertMcpCallToolResult(input).resultType).toBe(\"success\");\n });\n\n it(\"converts image content to binaryResultsForLlm\", () => {\n const input: McpCallToolResult = {\n content: [{ type: \"image\", data: \"base64data\", mimeType: \"image/png\" }],\n };\n\n const result = convertMcpCallToolResult(input);\n\n expect(result.textResultForLlm).toBe(\"\");\n expect(result.binaryResultsForLlm).toHaveLength(1);\n expect(result.binaryResultsForLlm![0]).toEqual({\n data: \"base64data\",\n mimeType: \"image/png\",\n type: \"image\",\n });\n });\n\n it(\"converts resource with text to textResultForLlm\", () => {\n const input: McpCallToolResult = {\n content: [\n {\n type: \"resource\",\n resource: { uri: \"file:///tmp/data.txt\", text: \"file contents\" },\n },\n ],\n };\n\n const result = convertMcpCallToolResult(input);\n\n expect(result.textResultForLlm).toBe(\"file contents\");\n });\n\n it(\"converts resource with blob to binaryResultsForLlm\", () => {\n const input: McpCallToolResult = {\n content: [\n {\n type: \"resource\",\n resource: {\n uri: \"file:///tmp/image.png\",\n mimeType: \"image/png\",\n blob: \"blobdata\",\n },\n },\n ],\n };\n\n const result = convertMcpCallToolResult(input);\n\n expect(result.binaryResultsForLlm).toHaveLength(1);\n expect(result.binaryResultsForLlm![0]).toEqual({\n data: \"blobdata\",\n mimeType: \"image/png\",\n type: \"resource\",\n description: \"file:///tmp/image.png\",\n });\n });\n\n it(\"handles mixed content types\", () => {\n const input: McpCallToolResult = {\n content: [\n { type: \"text\", text: \"Analysis complete\" },\n { type: \"image\", data: \"chartdata\", mimeType: \"image/svg+xml\" },\n {\n type: \"resource\",\n resource: { uri: \"file:///report.txt\", text: \"Report details\" },\n },\n ],\n };\n\n const result = convertMcpCallToolResult(input);\n\n expect(result.textResultForLlm).toBe(\"Analysis complete\\nReport details\");\n expect(result.binaryResultsForLlm).toHaveLength(1);\n expect(result.binaryResultsForLlm![0]!.mimeType).toBe(\"image/svg+xml\");\n });\n\n it(\"handles empty content array\", () => {\n const result = convertMcpCallToolResult({ content: [] });\n\n expect(result.textResultForLlm).toBe(\"\");\n expect(result.resultType).toBe(\"success\");\n expect(result.binaryResultsForLlm).toBeUndefined();\n });\n\n it(\"defaults resource blob mimeType to application/octet-stream\", () => {\n const input: McpCallToolResult = {\n content: [\n {\n type: \"resource\",\n resource: { uri: \"file:///data.bin\", blob: \"binarydata\" },\n },\n ],\n };\n\n const result = convertMcpCallToolResult(input);\n\n expect(result.binaryResultsForLlm![0]!.mimeType).toBe(\"application/octet-stream\");\n });\n\n it(\"handles text block with missing text field without corrupting output\", () => {\n // The input type uses structural typing, so type-specific fields might be absent\n // at runtime. convertMcpCallToolResult must be defensive.\n const input = { content: [{ type: \"text\" }] } as unknown as McpCallToolResult;\n\n const result = convertMcpCallToolResult(input);\n\n expect(result.textResultForLlm).toBe(\"\");\n expect(result.textResultForLlm).not.toBe(\"undefined\");\n });\n\n it(\"handles resource block with missing resource field without crashing\", () => {\n // A resource content item missing the resource field would crash with an\n // unguarded block.resource.text access. Optional chaining must be used.\n const input = { content: [{ type: \"resource\" }] } as unknown as McpCallToolResult;\n\n expect(() => convertMcpCallToolResult(input)).not.toThrow();\n const result = convertMcpCallToolResult(input);\n expect(result.textResultForLlm).toBe(\"\");\n });\n});\n" }, { "path": "nodejs/test/cjs-compat.test.ts", "content": "/**\n * Dual ESM/CJS build compatibility tests\n *\n * Verifies that both the ESM and CJS builds exist and work correctly,\n * so consumers using either module system get a working package.\n *\n * See: https://github.com/github/copilot-sdk/issues/528\n */\n\nimport { describe, expect, it } from \"vitest\";\nimport { existsSync } from \"node:fs\";\nimport { execFileSync } from \"node:child_process\";\nimport { join } from \"node:path\";\n\nconst distDir = join(import.meta.dirname, \"../dist\");\n\ndescribe(\"Dual ESM/CJS build (#528)\", () => {\n it(\"ESM dist file should exist\", () => {\n expect(existsSync(join(distDir, \"index.js\"))).toBe(true);\n });\n\n it(\"CJS dist file should exist\", () => {\n expect(existsSync(join(distDir, \"cjs/index.js\"))).toBe(true);\n });\n\n it(\"CJS build is requireable and exports CopilotClient\", () => {\n const script = `\n const sdk = require(${JSON.stringify(join(distDir, \"cjs/index.js\"))});\n if (typeof sdk.CopilotClient !== 'function') {\n console.error('CopilotClient is not a function');\n process.exit(1);\n }\n console.log('CJS require: OK');\n `;\n const output = execFileSync(process.execPath, [\"--eval\", script], {\n encoding: \"utf-8\",\n timeout: 10000,\n cwd: join(import.meta.dirname, \"..\"),\n });\n expect(output).toContain(\"CJS require: OK\");\n });\n\n it(\"CJS build resolves bundled CLI path\", () => {\n const script = `\n const sdk = require(${JSON.stringify(join(distDir, \"cjs/index.js\"))});\n const client = new sdk.CopilotClient({ autoStart: false });\n console.log('CJS CLI resolved: OK');\n `;\n const output = execFileSync(process.execPath, [\"--eval\", script], {\n encoding: \"utf-8\",\n timeout: 10000,\n cwd: join(import.meta.dirname, \"..\"),\n });\n expect(output).toContain(\"CJS CLI resolved: OK\");\n });\n\n it(\"ESM build resolves bundled CLI path\", () => {\n const esmPath = join(distDir, \"index.js\");\n const script = `\n import { pathToFileURL } from 'node:url';\n const sdk = await import(pathToFileURL(${JSON.stringify(esmPath)}).href);\n const client = new sdk.CopilotClient({ autoStart: false });\n console.log('ESM CLI resolved: OK');\n `;\n const output = execFileSync(process.execPath, [\"--input-type=module\", \"--eval\", script], {\n encoding: \"utf-8\",\n timeout: 10000,\n cwd: join(import.meta.dirname, \"..\"),\n });\n expect(output).toContain(\"ESM CLI resolved: OK\");\n });\n});\n" }, { "path": "nodejs/test/client.test.ts", "content": "/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { describe, expect, it, onTestFinished, vi } from \"vitest\";\nimport { approveAll, CopilotClient, type ModelInfo } from \"../src/index.js\";\nimport { defaultJoinSessionPermissionHandler } from \"../src/types.js\";\n\n// This file is for unit tests. Where relevant, prefer to add e2e tests in e2e/*.test.ts instead\n\ndescribe(\"CopilotClient\", () => {\n it(\"throws when createSession is called without onPermissionRequest\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n await expect((client as any).createSession({})).rejects.toThrow(\n /onPermissionRequest.*is required/\n );\n });\n\n it(\"throws when resumeSession is called without onPermissionRequest\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n await expect((client as any).resumeSession(session.sessionId, {})).rejects.toThrow(\n /onPermissionRequest.*is required/\n );\n });\n\n it(\"does not respond to v3 permission requests when handler returns no-result\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({\n onPermissionRequest: () => ({ kind: \"no-result\" }),\n });\n const spy = vi.spyOn(session.rpc.permissions, \"handlePendingPermissionRequest\");\n\n await (session as any)._executePermissionAndRespond(\"request-1\", { kind: \"write\" });\n\n expect(spy).not.toHaveBeenCalled();\n });\n\n it(\"throws when a v2 permission handler returns no-result\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({\n onPermissionRequest: () => ({ kind: \"no-result\" }),\n });\n\n await expect(\n (client as any).handlePermissionRequestV2({\n sessionId: session.sessionId,\n permissionRequest: { kind: \"write\" },\n })\n ).rejects.toThrow(/protocol v2 server/);\n });\n\n it(\"forwards clientName in session.create request\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const spy = vi.spyOn((client as any).connection!, \"sendRequest\");\n await client.createSession({ clientName: \"my-app\", onPermissionRequest: approveAll });\n\n expect(spy).toHaveBeenCalledWith(\n \"session.create\",\n expect.objectContaining({ clientName: \"my-app\" })\n );\n });\n\n it(\"forwards clientName in session.resume request\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n // Mock sendRequest to capture the call without hitting the runtime\n const spy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string, params: any) => {\n if (method === \"session.resume\") return { sessionId: params.sessionId };\n throw new Error(`Unexpected method: ${method}`);\n });\n await client.resumeSession(session.sessionId, {\n clientName: \"my-app\",\n onPermissionRequest: approveAll,\n });\n\n expect(spy).toHaveBeenCalledWith(\n \"session.resume\",\n expect.objectContaining({ clientName: \"my-app\", sessionId: session.sessionId })\n );\n spy.mockRestore();\n });\n\n it(\"defaults includeSubAgentStreamingEvents to true in session.create when not specified\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const spy = vi.spyOn((client as any).connection!, \"sendRequest\");\n await client.createSession({ onPermissionRequest: approveAll });\n\n const payload = spy.mock.calls.find((c) => c[0] === \"session.create\")![1] as any;\n expect(payload.includeSubAgentStreamingEvents).toBe(true);\n });\n\n it(\"forwards explicit false for includeSubAgentStreamingEvents in session.create\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const spy = vi.spyOn((client as any).connection!, \"sendRequest\");\n await client.createSession({\n onPermissionRequest: approveAll,\n includeSubAgentStreamingEvents: false,\n });\n\n const payload = spy.mock.calls.find((c) => c[0] === \"session.create\")![1] as any;\n expect(payload.includeSubAgentStreamingEvents).toBe(false);\n });\n\n it(\"defaults includeSubAgentStreamingEvents to true in session.resume when not specified\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const spy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string, params: any) => {\n if (method === \"session.resume\") return { sessionId: params.sessionId };\n throw new Error(`Unexpected method: ${method}`);\n });\n await client.resumeSession(session.sessionId, { onPermissionRequest: approveAll });\n\n const payload = spy.mock.calls.find((c) => c[0] === \"session.resume\")![1] as any;\n expect(payload.includeSubAgentStreamingEvents).toBe(true);\n spy.mockRestore();\n });\n\n it(\"forwards explicit false for includeSubAgentStreamingEvents in session.resume\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const spy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string, params: any) => {\n if (method === \"session.resume\") return { sessionId: params.sessionId };\n throw new Error(`Unexpected method: ${method}`);\n });\n await client.resumeSession(session.sessionId, {\n onPermissionRequest: approveAll,\n includeSubAgentStreamingEvents: false,\n });\n\n const payload = spy.mock.calls.find((c) => c[0] === \"session.resume\")![1] as any;\n expect(payload.includeSubAgentStreamingEvents).toBe(false);\n spy.mockRestore();\n });\n\n it(\"forwards continuePendingWork in session.resume request\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const spy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string, params: any) => {\n if (method === \"session.resume\") return { sessionId: params.sessionId };\n throw new Error(`Unexpected method: ${method}`);\n });\n await client.resumeSession(session.sessionId, {\n onPermissionRequest: approveAll,\n continuePendingWork: true,\n });\n\n const payload = spy.mock.calls.find((c) => c[0] === \"session.resume\")![1] as any;\n expect(payload.continuePendingWork).toBe(true);\n spy.mockRestore();\n });\n\n it(\"omits continuePendingWork from session.resume payload when not specified\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const spy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string, params: any) => {\n if (method === \"session.resume\") return { sessionId: params.sessionId };\n throw new Error(`Unexpected method: ${method}`);\n });\n await client.resumeSession(session.sessionId, { onPermissionRequest: approveAll });\n\n const payload = spy.mock.calls.find((c) => c[0] === \"session.resume\")![1] as any;\n expect(payload.continuePendingWork).toBeUndefined();\n spy.mockRestore();\n });\n\n it(\"forwards provider headers in session.create request\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const spy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string, params: any) => {\n if (method === \"session.create\") return { sessionId: params.sessionId };\n throw new Error(`Unexpected method: ${method}`);\n });\n\n await client.createSession({\n onPermissionRequest: approveAll,\n provider: {\n baseUrl: \"https://example.com/provider\",\n headers: { Authorization: \"Bearer provider-token\" },\n },\n });\n\n const payload = spy.mock.calls.find(([method]) => method === \"session.create\")![1] as any;\n expect(payload.provider).toEqual(\n expect.objectContaining({\n baseUrl: \"https://example.com/provider\",\n headers: { Authorization: \"Bearer provider-token\" },\n })\n );\n spy.mockRestore();\n });\n\n it(\"forwards provider headers in session.resume request\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const spy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string, params: any) => {\n if (method === \"session.resume\") return { sessionId: params.sessionId };\n throw new Error(`Unexpected method: ${method}`);\n });\n\n await client.resumeSession(session.sessionId, {\n onPermissionRequest: approveAll,\n provider: {\n baseUrl: \"https://example.com/provider\",\n headers: { Authorization: \"Bearer resume-token\" },\n },\n });\n\n const payload = spy.mock.calls.find(([method]) => method === \"session.resume\")![1] as any;\n expect(payload.provider).toEqual(\n expect.objectContaining({\n baseUrl: \"https://example.com/provider\",\n headers: { Authorization: \"Bearer resume-token\" },\n })\n );\n spy.mockRestore();\n });\n\n it(\"forwards defaultAgent in session.create request\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const spy = vi.spyOn((client as any).connection!, \"sendRequest\");\n await client.createSession({\n defaultAgent: { excludedTools: [\"heavy-tool\"] },\n onPermissionRequest: approveAll,\n });\n\n expect(spy).toHaveBeenCalledWith(\n \"session.create\",\n expect.objectContaining({\n defaultAgent: { excludedTools: [\"heavy-tool\"] },\n })\n );\n });\n\n it(\"forwards defaultAgent in session.resume request\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const spy = vi.spyOn((client as any).connection!, \"sendRequest\");\n await client.resumeSession(session.sessionId, {\n defaultAgent: { excludedTools: [\"heavy-tool\"] },\n onPermissionRequest: approveAll,\n });\n\n expect(spy).toHaveBeenCalledWith(\n \"session.resume\",\n expect.objectContaining({\n defaultAgent: { excludedTools: [\"heavy-tool\"] },\n })\n );\n });\n\n it(\"does not request permissions on session.resume when using the default joinSession handler\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const spy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string, params: any) => {\n if (method === \"session.resume\") return { sessionId: params.sessionId };\n throw new Error(`Unexpected method: ${method}`);\n });\n\n await client.resumeSession(session.sessionId, {\n onPermissionRequest: defaultJoinSessionPermissionHandler,\n });\n\n expect(spy).toHaveBeenCalledWith(\n \"session.resume\",\n expect.objectContaining({\n sessionId: session.sessionId,\n requestPermission: false,\n })\n );\n spy.mockRestore();\n });\n\n it(\"requests permissions on session.resume when using an explicit handler\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const spy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string, params: any) => {\n if (method === \"session.resume\") return { sessionId: params.sessionId };\n throw new Error(`Unexpected method: ${method}`);\n });\n\n await client.resumeSession(session.sessionId, {\n onPermissionRequest: approveAll,\n });\n\n expect(spy).toHaveBeenCalledWith(\n \"session.resume\",\n expect.objectContaining({\n sessionId: session.sessionId,\n requestPermission: true,\n })\n );\n spy.mockRestore();\n });\n\n it(\"sends session.model.switchTo RPC with correct params\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n // Mock sendRequest to capture the call without hitting the runtime\n const spy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string, _params: any) => {\n if (method === \"session.model.switchTo\") return {};\n // Fall through for other methods (shouldn't be called)\n throw new Error(`Unexpected method: ${method}`);\n });\n\n await session.setModel(\"gpt-4.1\");\n\n expect(spy).toHaveBeenCalledWith(\"session.model.switchTo\", {\n sessionId: session.sessionId,\n modelId: \"gpt-4.1\",\n });\n\n spy.mockRestore();\n });\n\n it(\"sends reasoningEffort with session.model.switchTo when provided\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n const spy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string, _params: any) => {\n if (method === \"session.model.switchTo\") return {};\n throw new Error(`Unexpected method: ${method}`);\n });\n\n await session.setModel(\"claude-sonnet-4.6\", { reasoningEffort: \"high\" });\n\n expect(spy).toHaveBeenCalledWith(\"session.model.switchTo\", {\n sessionId: session.sessionId,\n modelId: \"claude-sonnet-4.6\",\n reasoningEffort: \"high\",\n });\n\n spy.mockRestore();\n });\n\n describe(\"URL parsing\", () => {\n it(\"should parse port-only URL format\", () => {\n const client = new CopilotClient({\n cliUrl: \"8080\",\n logLevel: \"error\",\n });\n\n // Verify internal state\n expect((client as any).actualPort).toBe(8080);\n expect((client as any).actualHost).toBe(\"localhost\");\n expect((client as any).isExternalServer).toBe(true);\n });\n\n it(\"should parse host:port URL format\", () => {\n const client = new CopilotClient({\n cliUrl: \"127.0.0.1:9000\",\n logLevel: \"error\",\n });\n\n expect((client as any).actualPort).toBe(9000);\n expect((client as any).actualHost).toBe(\"127.0.0.1\");\n expect((client as any).isExternalServer).toBe(true);\n });\n\n it(\"should parse http://host:port URL format\", () => {\n const client = new CopilotClient({\n cliUrl: \"http://localhost:7000\",\n logLevel: \"error\",\n });\n\n expect((client as any).actualPort).toBe(7000);\n expect((client as any).actualHost).toBe(\"localhost\");\n expect((client as any).isExternalServer).toBe(true);\n });\n\n it(\"should parse https://host:port URL format\", () => {\n const client = new CopilotClient({\n cliUrl: \"https://example.com:443\",\n logLevel: \"error\",\n });\n\n expect((client as any).actualPort).toBe(443);\n expect((client as any).actualHost).toBe(\"example.com\");\n expect((client as any).isExternalServer).toBe(true);\n });\n\n it(\"should throw error for invalid URL format\", () => {\n expect(() => {\n new CopilotClient({\n cliUrl: \"invalid-url\",\n logLevel: \"error\",\n });\n }).toThrow(/Invalid cliUrl format/);\n });\n\n it(\"should throw error for invalid port - too high\", () => {\n expect(() => {\n new CopilotClient({\n cliUrl: \"localhost:99999\",\n logLevel: \"error\",\n });\n }).toThrow(/Invalid port in cliUrl/);\n });\n\n it(\"should throw error for invalid port - zero\", () => {\n expect(() => {\n new CopilotClient({\n cliUrl: \"localhost:0\",\n logLevel: \"error\",\n });\n }).toThrow(/Invalid port in cliUrl/);\n });\n\n it(\"should throw error for invalid port - negative\", () => {\n expect(() => {\n new CopilotClient({\n cliUrl: \"localhost:-1\",\n logLevel: \"error\",\n });\n }).toThrow(/Invalid port in cliUrl/);\n });\n\n it(\"should throw error when cliUrl is used with useStdio\", () => {\n expect(() => {\n new CopilotClient({\n cliUrl: \"localhost:8080\",\n useStdio: true,\n logLevel: \"error\",\n });\n }).toThrow(/cliUrl is mutually exclusive/);\n });\n\n it(\"should throw error when cliUrl is used with cliPath\", () => {\n expect(() => {\n new CopilotClient({\n cliUrl: \"localhost:8080\",\n cliPath: \"/path/to/cli\",\n logLevel: \"error\",\n });\n }).toThrow(/cliUrl is mutually exclusive/);\n });\n\n it(\"should set useStdio to false when cliUrl is provided\", () => {\n const client = new CopilotClient({\n cliUrl: \"8080\",\n logLevel: \"error\",\n });\n\n expect(client[\"options\"].useStdio).toBe(false);\n });\n\n it(\"should mark client as using external server\", () => {\n const client = new CopilotClient({\n cliUrl: \"localhost:8080\",\n logLevel: \"error\",\n });\n\n expect((client as any).isExternalServer).toBe(true);\n });\n\n it(\"should not resolve cliPath when cliUrl is provided\", () => {\n const client = new CopilotClient({\n cliUrl: \"localhost:8080\",\n logLevel: \"error\",\n });\n\n expect(client[\"options\"].cliPath).toBeUndefined();\n });\n });\n\n describe(\"SessionFs config\", () => {\n it(\"throws when initialCwd is missing\", () => {\n expect(() => {\n new CopilotClient({\n sessionFs: {\n initialCwd: \"\",\n sessionStatePath: \"/session-state\",\n conventions: \"posix\",\n },\n logLevel: \"error\",\n });\n }).toThrow(/sessionFs\\.initialCwd is required/);\n });\n\n it(\"throws when sessionStatePath is missing\", () => {\n expect(() => {\n new CopilotClient({\n sessionFs: {\n initialCwd: \"/\",\n sessionStatePath: \"\",\n conventions: \"posix\",\n },\n logLevel: \"error\",\n });\n }).toThrow(/sessionFs\\.sessionStatePath is required/);\n });\n });\n\n describe(\"Auth options\", () => {\n it(\"should accept gitHubToken option\", () => {\n const client = new CopilotClient({\n gitHubToken: \"gho_test_token\",\n logLevel: \"error\",\n });\n\n expect((client as any).options.gitHubToken).toBe(\"gho_test_token\");\n });\n\n it(\"should default useLoggedInUser to true when no gitHubToken\", () => {\n const client = new CopilotClient({\n logLevel: \"error\",\n });\n\n expect((client as any).options.useLoggedInUser).toBe(true);\n });\n\n it(\"should default useLoggedInUser to false when gitHubToken is provided\", () => {\n const client = new CopilotClient({\n gitHubToken: \"gho_test_token\",\n logLevel: \"error\",\n });\n\n expect((client as any).options.useLoggedInUser).toBe(false);\n });\n\n it(\"should allow explicit useLoggedInUser: true with gitHubToken\", () => {\n const client = new CopilotClient({\n gitHubToken: \"gho_test_token\",\n useLoggedInUser: true,\n logLevel: \"error\",\n });\n\n expect((client as any).options.useLoggedInUser).toBe(true);\n });\n\n it(\"should allow explicit useLoggedInUser: false without gitHubToken\", () => {\n const client = new CopilotClient({\n useLoggedInUser: false,\n logLevel: \"error\",\n });\n\n expect((client as any).options.useLoggedInUser).toBe(false);\n });\n\n it(\"should throw error when gitHubToken is used with cliUrl\", () => {\n expect(() => {\n new CopilotClient({\n cliUrl: \"localhost:8080\",\n gitHubToken: \"gho_test_token\",\n logLevel: \"error\",\n });\n }).toThrow(/gitHubToken and useLoggedInUser cannot be used with cliUrl/);\n });\n\n it(\"should throw error when useLoggedInUser is used with cliUrl\", () => {\n expect(() => {\n new CopilotClient({\n cliUrl: \"localhost:8080\",\n useLoggedInUser: false,\n logLevel: \"error\",\n });\n }).toThrow(/gitHubToken and useLoggedInUser cannot be used with cliUrl/);\n });\n });\n\n describe(\"overridesBuiltInTool in tool definitions\", () => {\n it(\"sends overridesBuiltInTool in tool definition on session.create\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const spy = vi.spyOn((client as any).connection!, \"sendRequest\");\n await client.createSession({\n onPermissionRequest: approveAll,\n tools: [\n {\n name: \"grep\",\n description: \"custom grep\",\n handler: async () => \"ok\",\n overridesBuiltInTool: true,\n },\n ],\n });\n\n const payload = spy.mock.calls.find((c) => c[0] === \"session.create\")![1] as any;\n expect(payload.tools).toEqual([\n expect.objectContaining({ name: \"grep\", overridesBuiltInTool: true }),\n ]);\n });\n\n it(\"sends overridesBuiltInTool in tool definition on session.resume\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n // Mock sendRequest to capture the call without hitting the runtime\n const spy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string, params: any) => {\n if (method === \"session.resume\") return { sessionId: params.sessionId };\n throw new Error(`Unexpected method: ${method}`);\n });\n await client.resumeSession(session.sessionId, {\n onPermissionRequest: approveAll,\n tools: [\n {\n name: \"grep\",\n description: \"custom grep\",\n handler: async () => \"ok\",\n overridesBuiltInTool: true,\n },\n ],\n });\n\n const payload = spy.mock.calls.find((c) => c[0] === \"session.resume\")![1] as any;\n expect(payload.tools).toEqual([\n expect.objectContaining({ name: \"grep\", overridesBuiltInTool: true }),\n ]);\n spy.mockRestore();\n });\n });\n\n describe(\"agent parameter in session creation\", () => {\n it(\"forwards agent in session.create request\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const spy = vi.spyOn((client as any).connection!, \"sendRequest\");\n await client.createSession({\n onPermissionRequest: approveAll,\n customAgents: [\n {\n name: \"test-agent\",\n prompt: \"You are a test agent.\",\n },\n ],\n agent: \"test-agent\",\n });\n\n const payload = spy.mock.calls.find((c) => c[0] === \"session.create\")![1] as any;\n expect(payload.agent).toBe(\"test-agent\");\n expect(payload.customAgents).toEqual([expect.objectContaining({ name: \"test-agent\" })]);\n });\n\n it(\"forwards agent in session.resume request\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const spy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string, params: any) => {\n if (method === \"session.resume\") return { sessionId: params.sessionId };\n throw new Error(`Unexpected method: ${method}`);\n });\n await client.resumeSession(session.sessionId, {\n onPermissionRequest: approveAll,\n customAgents: [\n {\n name: \"test-agent\",\n prompt: \"You are a test agent.\",\n },\n ],\n agent: \"test-agent\",\n });\n\n const payload = spy.mock.calls.find((c) => c[0] === \"session.resume\")![1] as any;\n expect(payload.agent).toBe(\"test-agent\");\n spy.mockRestore();\n });\n });\n\n describe(\"onListModels\", () => {\n it(\"calls onListModels handler instead of RPC when provided\", async () => {\n const customModels: ModelInfo[] = [\n {\n id: \"my-custom-model\",\n name: \"My Custom Model\",\n capabilities: {\n supports: { vision: false, reasoningEffort: false },\n limits: { max_context_window_tokens: 128000 },\n },\n },\n ];\n\n const handler = vi.fn().mockReturnValue(customModels);\n const client = new CopilotClient({ onListModels: handler });\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const models = await client.listModels();\n expect(handler).toHaveBeenCalledTimes(1);\n expect(models).toEqual(customModels);\n });\n\n it(\"caches onListModels results on subsequent calls\", async () => {\n const customModels: ModelInfo[] = [\n {\n id: \"cached-model\",\n name: \"Cached Model\",\n capabilities: {\n supports: { vision: false, reasoningEffort: false },\n limits: { max_context_window_tokens: 128000 },\n },\n },\n ];\n\n const handler = vi.fn().mockReturnValue(customModels);\n const client = new CopilotClient({ onListModels: handler });\n await client.start();\n onTestFinished(() => client.forceStop());\n\n await client.listModels();\n await client.listModels();\n expect(handler).toHaveBeenCalledTimes(1); // Only called once due to caching\n });\n\n it(\"supports async onListModels handler\", async () => {\n const customModels: ModelInfo[] = [\n {\n id: \"async-model\",\n name: \"Async Model\",\n capabilities: {\n supports: { vision: false, reasoningEffort: false },\n limits: { max_context_window_tokens: 128000 },\n },\n },\n ];\n\n const handler = vi.fn().mockResolvedValue(customModels);\n const client = new CopilotClient({ onListModels: handler });\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const models = await client.listModels();\n expect(models).toEqual(customModels);\n });\n\n it(\"does not require client.start when onListModels is provided\", async () => {\n const customModels: ModelInfo[] = [\n {\n id: \"no-start-model\",\n name: \"No Start Model\",\n capabilities: {\n supports: { vision: false, reasoningEffort: false },\n limits: { max_context_window_tokens: 128000 },\n },\n },\n ];\n\n const handler = vi.fn().mockReturnValue(customModels);\n const client = new CopilotClient({ onListModels: handler });\n\n const models = await client.listModels();\n expect(handler).toHaveBeenCalledTimes(1);\n expect(models).toEqual(customModels);\n });\n });\n\n describe(\"unexpected disconnection\", () => {\n it(\"transitions to disconnected when child process is killed\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n expect(client.getState()).toBe(\"connected\");\n\n // Kill the child process to simulate unexpected termination\n const proc = (client as any).cliProcess as import(\"node:child_process\").ChildProcess;\n proc.kill();\n\n // Wait for the connection.onClose handler to fire\n await vi.waitFor(() => {\n expect(client.getState()).toBe(\"disconnected\");\n });\n });\n });\n\n describe(\"onGetTraceContext\", () => {\n it(\"includes trace context from callback in session.create request\", async () => {\n const traceContext = {\n traceparent: \"00-abcdef1234567890abcdef1234567890-1234567890abcdef-01\",\n tracestate: \"vendor=opaque\",\n };\n const provider = vi.fn().mockReturnValue(traceContext);\n const client = new CopilotClient({ onGetTraceContext: provider });\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const spy = vi.spyOn((client as any).connection!, \"sendRequest\");\n await client.createSession({ onPermissionRequest: approveAll });\n\n expect(provider).toHaveBeenCalled();\n expect(spy).toHaveBeenCalledWith(\n \"session.create\",\n expect.objectContaining({\n traceparent: \"00-abcdef1234567890abcdef1234567890-1234567890abcdef-01\",\n tracestate: \"vendor=opaque\",\n })\n );\n });\n\n it(\"includes trace context from callback in session.resume request\", async () => {\n const traceContext = {\n traceparent: \"00-abcdef1234567890abcdef1234567890-1234567890abcdef-01\",\n };\n const provider = vi.fn().mockReturnValue(traceContext);\n const client = new CopilotClient({ onGetTraceContext: provider });\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const spy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string, params: any) => {\n if (method === \"session.resume\") return { sessionId: params.sessionId };\n throw new Error(`Unexpected method: ${method}`);\n });\n await client.resumeSession(session.sessionId, { onPermissionRequest: approveAll });\n\n expect(spy).toHaveBeenCalledWith(\n \"session.resume\",\n expect.objectContaining({\n traceparent: \"00-abcdef1234567890abcdef1234567890-1234567890abcdef-01\",\n })\n );\n });\n\n it(\"includes trace context from callback in session.send request\", async () => {\n const traceContext = {\n traceparent: \"00-fedcba0987654321fedcba0987654321-abcdef1234567890-01\",\n };\n const provider = vi.fn().mockReturnValue(traceContext);\n const client = new CopilotClient({ onGetTraceContext: provider });\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const spy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string) => {\n if (method === \"session.send\") return { responseId: \"r1\" };\n throw new Error(`Unexpected method: ${method}`);\n });\n await session.send({ prompt: \"hello\" });\n\n expect(spy).toHaveBeenCalledWith(\n \"session.send\",\n expect.objectContaining({\n traceparent: \"00-fedcba0987654321fedcba0987654321-abcdef1234567890-01\",\n })\n );\n });\n\n it(\"forwards requestHeaders in session.send request\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const spy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string) => {\n if (method === \"session.send\") return { messageId: \"m1\" };\n throw new Error(`Unexpected method: ${method}`);\n });\n\n await session.send({\n prompt: \"hello\",\n requestHeaders: { Authorization: \"Bearer turn-token\" },\n });\n\n expect(spy).toHaveBeenCalledWith(\n \"session.send\",\n expect.objectContaining({\n prompt: \"hello\",\n requestHeaders: { Authorization: \"Bearer turn-token\" },\n })\n );\n });\n\n it(\"does not include trace context when no callback is provided\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const spy = vi.spyOn((client as any).connection!, \"sendRequest\");\n await client.createSession({ onPermissionRequest: approveAll });\n\n const [, params] = spy.mock.calls.find(([method]) => method === \"session.create\")!;\n expect(params.traceparent).toBeUndefined();\n expect(params.tracestate).toBeUndefined();\n });\n });\n\n describe(\"commands\", () => {\n it(\"forwards commands in session.create RPC\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const spy = vi.spyOn((client as any).connection!, \"sendRequest\");\n await client.createSession({\n onPermissionRequest: approveAll,\n commands: [\n { name: \"deploy\", description: \"Deploy the app\", handler: async () => {} },\n { name: \"rollback\", handler: async () => {} },\n ],\n });\n\n const payload = spy.mock.calls.find((c) => c[0] === \"session.create\")![1] as any;\n expect(payload.commands).toEqual([\n { name: \"deploy\", description: \"Deploy the app\" },\n { name: \"rollback\", description: undefined },\n ]);\n });\n\n it(\"forwards commands in session.resume RPC\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const spy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string, params: any) => {\n if (method === \"session.resume\") return { sessionId: params.sessionId };\n throw new Error(`Unexpected method: ${method}`);\n });\n await client.resumeSession(session.sessionId, {\n onPermissionRequest: approveAll,\n commands: [{ name: \"deploy\", description: \"Deploy\", handler: async () => {} }],\n });\n\n const payload = spy.mock.calls.find((c) => c[0] === \"session.resume\")![1] as any;\n expect(payload.commands).toEqual([{ name: \"deploy\", description: \"Deploy\" }]);\n spy.mockRestore();\n });\n\n it(\"routes command.execute event to the correct handler\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const handler = vi.fn();\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n commands: [{ name: \"deploy\", handler }],\n });\n\n // Mock the RPC response so handlePendingCommand doesn't fail\n const rpcSpy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string) => {\n if (method === \"session.commands.handlePendingCommand\")\n return { success: true };\n throw new Error(`Unexpected method: ${method}`);\n });\n\n // Simulate a command.execute event\n (session as any)._dispatchEvent({\n id: \"evt-1\",\n timestamp: new Date().toISOString(),\n parentId: null,\n ephemeral: true,\n type: \"command.execute\",\n data: {\n requestId: \"req-1\",\n command: \"/deploy production\",\n commandName: \"deploy\",\n args: \"production\",\n },\n });\n\n // Wait for the async handler to complete\n await vi.waitFor(() => expect(handler).toHaveBeenCalledTimes(1));\n expect(handler).toHaveBeenCalledWith(\n expect.objectContaining({\n sessionId: session.sessionId,\n command: \"/deploy production\",\n commandName: \"deploy\",\n args: \"production\",\n })\n );\n\n // Verify handlePendingCommand was called with the requestId\n expect(rpcSpy).toHaveBeenCalledWith(\n \"session.commands.handlePendingCommand\",\n expect.objectContaining({ requestId: \"req-1\" })\n );\n rpcSpy.mockRestore();\n });\n\n it(\"sends error when command handler throws\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n commands: [\n {\n name: \"fail\",\n handler: () => {\n throw new Error(\"deploy failed\");\n },\n },\n ],\n });\n\n const rpcSpy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string) => {\n if (method === \"session.commands.handlePendingCommand\")\n return { success: true };\n throw new Error(`Unexpected method: ${method}`);\n });\n\n (session as any)._dispatchEvent({\n id: \"evt-2\",\n timestamp: new Date().toISOString(),\n parentId: null,\n ephemeral: true,\n type: \"command.execute\",\n data: {\n requestId: \"req-2\",\n command: \"/fail\",\n commandName: \"fail\",\n args: \"\",\n },\n });\n\n await vi.waitFor(() =>\n expect(rpcSpy).toHaveBeenCalledWith(\n \"session.commands.handlePendingCommand\",\n expect.objectContaining({ requestId: \"req-2\", error: \"deploy failed\" })\n )\n );\n rpcSpy.mockRestore();\n });\n\n it(\"sends error for unknown command\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n commands: [{ name: \"deploy\", handler: async () => {} }],\n });\n\n const rpcSpy = vi\n .spyOn((client as any).connection!, \"sendRequest\")\n .mockImplementation(async (method: string) => {\n if (method === \"session.commands.handlePendingCommand\")\n return { success: true };\n throw new Error(`Unexpected method: ${method}`);\n });\n\n (session as any)._dispatchEvent({\n id: \"evt-3\",\n timestamp: new Date().toISOString(),\n parentId: null,\n ephemeral: true,\n type: \"command.execute\",\n data: {\n requestId: \"req-3\",\n command: \"/unknown\",\n commandName: \"unknown\",\n args: \"\",\n },\n });\n\n await vi.waitFor(() =>\n expect(rpcSpy).toHaveBeenCalledWith(\n \"session.commands.handlePendingCommand\",\n expect.objectContaining({\n requestId: \"req-3\",\n error: expect.stringContaining(\"Unknown command\"),\n })\n )\n );\n rpcSpy.mockRestore();\n });\n });\n\n describe(\"ui elicitation\", () => {\n it(\"reads capabilities from session.create response\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n // Intercept session.create to inject capabilities\n const origSendRequest = (client as any).connection!.sendRequest.bind(\n (client as any).connection\n );\n vi.spyOn((client as any).connection!, \"sendRequest\").mockImplementation(\n async (method: string, params: any) => {\n if (method === \"session.create\") {\n const result = await origSendRequest(method, params);\n return {\n ...result,\n capabilities: { ui: { elicitation: true } },\n };\n }\n return origSendRequest(method, params);\n }\n );\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n expect(session.capabilities).toEqual({ ui: { elicitation: true } });\n });\n\n it(\"defaults capabilities when not injected\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n // CLI returns actual capabilities (elicitation false in headless mode)\n expect(session.capabilities.ui?.elicitation).toBe(false);\n });\n\n it(\"elicitation throws when capability is missing\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await expect(\n session.ui.elicitation({\n message: \"Enter name\",\n requestedSchema: {\n type: \"object\",\n properties: { name: { type: \"string\", minLength: 1 } },\n required: [\"name\"],\n },\n })\n ).rejects.toThrow(/not supported/);\n });\n\n it(\"sends requestElicitation flag when onElicitationRequest is provided\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const rpcSpy = vi.spyOn((client as any).connection!, \"sendRequest\");\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n onElicitationRequest: async () => ({\n action: \"accept\" as const,\n content: {},\n }),\n });\n expect(session).toBeDefined();\n\n const createCall = rpcSpy.mock.calls.find((c) => c[0] === \"session.create\");\n expect(createCall).toBeDefined();\n expect(createCall![1]).toEqual(\n expect.objectContaining({\n requestElicitation: true,\n })\n );\n rpcSpy.mockRestore();\n });\n\n it(\"does not send requestElicitation when no handler provided\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const rpcSpy = vi.spyOn((client as any).connection!, \"sendRequest\");\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n });\n expect(session).toBeDefined();\n\n const createCall = rpcSpy.mock.calls.find((c) => c[0] === \"session.create\");\n expect(createCall).toBeDefined();\n expect(createCall![1]).toEqual(\n expect.objectContaining({\n requestElicitation: false,\n })\n );\n rpcSpy.mockRestore();\n });\n\n it(\"sends cancel when elicitation handler throws\", async () => {\n const client = new CopilotClient();\n await client.start();\n onTestFinished(() => client.forceStop());\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n onElicitationRequest: async () => {\n throw new Error(\"handler exploded\");\n },\n });\n\n const rpcSpy = vi.spyOn((client as any).connection!, \"sendRequest\");\n\n await session._handleElicitationRequest(\n { sessionId: session.sessionId, message: \"Pick a color\" },\n \"req-123\"\n );\n\n const cancelCall = rpcSpy.mock.calls.find(\n (c) =>\n c[0] === \"session.ui.handlePendingElicitation\" &&\n (c[1] as any)?.result?.action === \"cancel\"\n );\n expect(cancelCall).toBeDefined();\n expect(cancelCall![1]).toEqual(\n expect.objectContaining({\n requestId: \"req-123\",\n result: { action: \"cancel\" },\n })\n );\n rpcSpy.mockRestore();\n });\n });\n\n describe(\"sessionIdleTimeoutSeconds\", () => {\n it(\"should default to 0 when not specified\", () => {\n const client = new CopilotClient({\n logLevel: \"error\",\n });\n\n expect((client as any).options.sessionIdleTimeoutSeconds).toBe(0);\n });\n\n it(\"should store a custom value\", () => {\n const client = new CopilotClient({\n sessionIdleTimeoutSeconds: 600,\n logLevel: \"error\",\n });\n\n expect((client as any).options.sessionIdleTimeoutSeconds).toBe(600);\n });\n });\n});\n" }, { "path": "nodejs/test/e2e/agent_and_compact_rpc.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { describe, expect, it } from \"vitest\";\nimport { approveAll } from \"../../src/index.js\";\nimport type { CustomAgentConfig } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\ndescribe(\"Agent Selection RPC\", async () => {\n const { copilotClient: client } = await createSdkTestContext();\n\n it(\"should list available custom agents\", async () => {\n const customAgents: CustomAgentConfig[] = [\n {\n name: \"test-agent\",\n displayName: \"Test Agent\",\n description: \"A test agent\",\n prompt: \"You are a test agent.\",\n },\n {\n name: \"another-agent\",\n displayName: \"Another Agent\",\n description: \"Another test agent\",\n prompt: \"You are another agent.\",\n },\n ];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n customAgents,\n });\n\n const result = await session.rpc.agent.list();\n expect(result.agents).toBeDefined();\n expect(Array.isArray(result.agents)).toBe(true);\n expect(result.agents.length).toBe(2);\n expect(result.agents[0].name).toBe(\"test-agent\");\n expect(result.agents[0].displayName).toBe(\"Test Agent\");\n expect(result.agents[0].description).toBe(\"A test agent\");\n expect(result.agents[1].name).toBe(\"another-agent\");\n\n await session.disconnect();\n });\n\n it(\"should return null when no agent is selected\", async () => {\n const customAgents: CustomAgentConfig[] = [\n {\n name: \"test-agent\",\n displayName: \"Test Agent\",\n description: \"A test agent\",\n prompt: \"You are a test agent.\",\n },\n ];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n customAgents,\n });\n\n const result = await session.rpc.agent.getCurrent();\n expect(result.agent).toBeNull();\n\n await session.disconnect();\n });\n\n it(\"should select and get current agent\", async () => {\n const customAgents: CustomAgentConfig[] = [\n {\n name: \"test-agent\",\n displayName: \"Test Agent\",\n description: \"A test agent\",\n prompt: \"You are a test agent.\",\n },\n ];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n customAgents,\n });\n\n // Select the agent\n const selectResult = await session.rpc.agent.select({ name: \"test-agent\" });\n expect(selectResult.agent).toBeDefined();\n expect(selectResult.agent.name).toBe(\"test-agent\");\n expect(selectResult.agent.displayName).toBe(\"Test Agent\");\n\n // Verify getCurrent returns the selected agent\n const currentResult = await session.rpc.agent.getCurrent();\n expect(currentResult.agent).not.toBeNull();\n expect(currentResult.agent!.name).toBe(\"test-agent\");\n\n await session.disconnect();\n });\n\n it(\"should deselect current agent\", async () => {\n const customAgents: CustomAgentConfig[] = [\n {\n name: \"test-agent\",\n displayName: \"Test Agent\",\n description: \"A test agent\",\n prompt: \"You are a test agent.\",\n },\n ];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n customAgents,\n });\n\n // Select then deselect\n await session.rpc.agent.select({ name: \"test-agent\" });\n await session.rpc.agent.deselect();\n\n // Verify no agent is selected\n const currentResult = await session.rpc.agent.getCurrent();\n expect(currentResult.agent).toBeNull();\n\n await session.disconnect();\n });\n\n it(\"should return empty list when no custom agents configured\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n const result = await session.rpc.agent.list();\n expect(result.agents).toEqual([]);\n\n await session.disconnect();\n });\n});\n\ndescribe(\"Session Compact RPC\", async () => {\n const { copilotClient: client } = await createSdkTestContext();\n\n it(\"should compact session history after messages\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n // Send a message to create some history\n await session.sendAndWait({ prompt: \"What is 2+2?\" });\n\n // Compact the session\n const result = await session.rpc.history.compact();\n expect(typeof result.success).toBe(\"boolean\");\n expect(typeof result.tokensRemoved).toBe(\"number\");\n expect(typeof result.messagesRemoved).toBe(\"number\");\n\n await session.disconnect();\n }, 60000);\n});\n" }, { "path": "nodejs/test/e2e/ask_user.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { describe, expect, it } from \"vitest\";\nimport type { UserInputRequest, UserInputResponse } from \"../../src/index.js\";\nimport { approveAll } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\ndescribe(\"User input (ask_user)\", async () => {\n const { copilotClient: client } = await createSdkTestContext();\n\n it(\"should invoke user input handler when model uses ask_user tool\", async () => {\n const userInputRequests: UserInputRequest[] = [];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n onUserInputRequest: async (request, invocation) => {\n userInputRequests.push(request);\n expect(invocation.sessionId).toBe(session.sessionId);\n\n // Return the first choice if available, otherwise a freeform answer\n const response: UserInputResponse = {\n answer: request.choices?.[0] ?? \"freeform answer\",\n wasFreeform: !request.choices?.length,\n };\n return response;\n },\n });\n\n await session.sendAndWait({\n prompt: \"Ask me to choose between 'Option A' and 'Option B' using the ask_user tool. Wait for my response before continuing.\",\n });\n\n // Should have received at least one user input request\n expect(userInputRequests.length).toBeGreaterThan(0);\n\n // The request should have a question\n expect(userInputRequests.some((req) => req.question && req.question.length > 0)).toBe(true);\n\n await session.disconnect();\n });\n\n it(\"should receive choices in user input request\", async () => {\n const userInputRequests: UserInputRequest[] = [];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n onUserInputRequest: async (request) => {\n userInputRequests.push(request);\n // Pick the first choice\n return {\n answer: request.choices?.[0] ?? \"default\",\n wasFreeform: false,\n };\n },\n });\n\n await session.sendAndWait({\n prompt: \"Use the ask_user tool to ask me to pick between exactly two options: 'Red' and 'Blue'. These should be provided as choices. Wait for my answer.\",\n });\n\n // Should have received a request\n expect(userInputRequests.length).toBeGreaterThan(0);\n\n // At least one request should have choices\n const requestWithChoices = userInputRequests.find(\n (req) => req.choices && req.choices.length > 0\n );\n expect(requestWithChoices).toBeDefined();\n\n await session.disconnect();\n });\n\n it(\"should handle freeform user input response\", async () => {\n const userInputRequests: UserInputRequest[] = [];\n const freeformAnswer = \"This is my custom freeform answer that was not in the choices\";\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n onUserInputRequest: async (request) => {\n userInputRequests.push(request);\n // Return a freeform answer (not from choices)\n return {\n answer: freeformAnswer,\n wasFreeform: true,\n };\n },\n });\n\n const response = await session.sendAndWait({\n prompt: \"Ask me a question using ask_user and then include my answer in your response. The question should be 'What is your favorite color?'\",\n });\n\n // Should have received a request\n expect(userInputRequests.length).toBeGreaterThan(0);\n\n // The model's response should reference the freeform answer we provided\n // (This is a soft check since the model may paraphrase)\n expect(response).toBeDefined();\n\n await session.disconnect();\n });\n});\n" }, { "path": "nodejs/test/e2e/builtin_tools.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { writeFile, mkdir } from \"fs/promises\";\nimport { join } from \"path\";\nimport { describe, expect, it } from \"vitest\";\nimport { approveAll } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext\";\n\ndescribe(\"Built-in Tools\", async () => {\n const { copilotClient: client, workDir } = await createSdkTestContext();\n\n describe(\"bash\", () => {\n it(\"should capture exit code in output\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const msg = await session.sendAndWait({\n prompt: \"Run 'echo hello && echo world'. Tell me the exact output.\",\n });\n expect(msg?.data.content).toContain(\"hello\");\n expect(msg?.data.content).toContain(\"world\");\n });\n\n it.skipIf(process.platform === \"win32\")(\"should capture stderr output\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const msg = await session.sendAndWait({\n prompt: \"Run 'echo error_msg >&2; echo ok' and tell me what stderr said. Reply with just the stderr content.\",\n });\n expect(msg?.data.content).toContain(\"error_msg\");\n });\n });\n\n describe(\"view\", () => {\n it(\"should read file with line range\", async () => {\n await writeFile(join(workDir, \"lines.txt\"), \"line1\\nline2\\nline3\\nline4\\nline5\\n\");\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const msg = await session.sendAndWait({\n prompt: \"Read lines 2 through 4 of the file 'lines.txt' in this directory. Tell me what those lines contain.\",\n });\n expect(msg?.data.content).toContain(\"line2\");\n expect(msg?.data.content).toContain(\"line4\");\n });\n\n it(\"should handle nonexistent file gracefully\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const msg = await session.sendAndWait({\n prompt: \"Try to read the file 'does_not_exist.txt'. If it doesn't exist, say 'FILE_NOT_FOUND'.\",\n });\n expect(msg?.data.content?.toUpperCase()).toMatch(\n /NOT.FOUND|NOT.EXIST|NO.SUCH|FILE_NOT_FOUND|DOES.NOT.EXIST|ERROR/i\n );\n });\n });\n\n describe(\"edit\", () => {\n it(\"should edit a file successfully\", async () => {\n await writeFile(join(workDir, \"edit_me.txt\"), \"Hello World\\nGoodbye World\\n\");\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const msg = await session.sendAndWait({\n prompt: \"Edit the file 'edit_me.txt': replace 'Hello World' with 'Hi Universe'. Then read it back and tell me its contents.\",\n });\n expect(msg?.data.content).toContain(\"Hi Universe\");\n });\n });\n\n describe(\"create_file\", () => {\n it(\"should create a new file\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const msg = await session.sendAndWait({\n prompt: \"Create a file called 'new_file.txt' with the content 'Created by test'. Then read it back to confirm.\",\n });\n expect(msg?.data.content).toContain(\"Created by test\");\n });\n });\n\n describe(\"grep\", () => {\n it(\"should search for patterns in files\", async () => {\n await writeFile(join(workDir, \"data.txt\"), \"apple\\nbanana\\napricot\\ncherry\\n\");\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const msg = await session.sendAndWait({\n prompt: \"Search for lines starting with 'ap' in the file 'data.txt'. Tell me which lines matched.\",\n });\n expect(msg?.data.content).toContain(\"apple\");\n expect(msg?.data.content).toContain(\"apricot\");\n });\n });\n\n describe(\"glob\", () => {\n it(\"should find files by pattern\", async () => {\n await mkdir(join(workDir, \"src\"), { recursive: true });\n await writeFile(join(workDir, \"src\", \"index.ts\"), \"export const index = 1;\");\n await writeFile(join(workDir, \"README.md\"), \"# Readme\");\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const msg = await session.sendAndWait({\n prompt: \"Find all .ts files in this directory (recursively). List the filenames you found.\",\n });\n expect(msg?.data.content).toContain(\"index.ts\");\n });\n });\n});\n" }, { "path": "nodejs/test/e2e/client.e2e.test.ts", "content": "import { ChildProcess } from \"child_process\";\nimport { describe, expect, it, onTestFinished } from \"vitest\";\nimport { CopilotClient, approveAll } from \"../../src/index.js\";\n\nfunction onTestFinishedForceStop(client: CopilotClient) {\n onTestFinished(async () => {\n try {\n await client.forceStop();\n } catch {\n // Ignore cleanup errors - process may already be stopped\n }\n });\n}\n\ndescribe(\"Client\", () => {\n it(\"should start and connect to server using stdio\", async () => {\n const client = new CopilotClient({ useStdio: true });\n onTestFinishedForceStop(client);\n\n await client.start();\n expect(client.getState()).toBe(\"connected\");\n\n const pong = await client.ping(\"test message\");\n expect(pong.message).toBe(\"pong: test message\");\n expect(pong.timestamp).toBeGreaterThanOrEqual(0);\n\n expect(await client.stop()).toHaveLength(0); // No errors on stop\n expect(client.getState()).toBe(\"disconnected\");\n });\n\n it(\"should start and connect to server using tcp\", async () => {\n const client = new CopilotClient({ useStdio: false });\n onTestFinishedForceStop(client);\n\n await client.start();\n expect(client.getState()).toBe(\"connected\");\n\n const pong = await client.ping(\"test message\");\n expect(pong.message).toBe(\"pong: test message\");\n expect(pong.timestamp).toBeGreaterThanOrEqual(0);\n\n expect(await client.stop()).toHaveLength(0); // No errors on stop\n expect(client.getState()).toBe(\"disconnected\");\n });\n\n it.skipIf(process.platform === \"darwin\")(\n \"should stop cleanly when the server exits during cleanup\",\n async () => {\n // Use TCP mode to avoid stdin stream destruction issues\n // Without this, on macOS there are intermittent test failures\n // saying \"Cannot call write after a stream was destroyed\"\n // because the JSON-RPC logic is still trying to write to stdin after\n // the process has exited.\n const client = new CopilotClient({ useStdio: false });\n\n await client.createSession({ onPermissionRequest: approveAll });\n\n // Kill the server processto force cleanup to fail\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n const cliProcess = (client as any).cliProcess as ChildProcess;\n expect(cliProcess).toBeDefined();\n cliProcess.kill(\"SIGKILL\");\n await new Promise((resolve) => setTimeout(resolve, 100));\n\n const errors = await client.stop();\n expect(client.getState()).toBe(\"disconnected\");\n if (errors.length > 0) {\n expect(errors[0].message).toContain(\"Failed to disconnect session\");\n }\n },\n // Generous timeout: client.stop() must wait for session.destroy to time out\n // when the server process is dead. The default 30s can flake on slow CI under load.\n 60_000\n );\n\n it(\"should forceStop without cleanup\", async () => {\n const client = new CopilotClient({});\n onTestFinishedForceStop(client);\n\n await client.createSession({ onPermissionRequest: approveAll });\n await client.forceStop();\n expect(client.getState()).toBe(\"disconnected\");\n });\n\n it(\"should get status with version and protocol info\", async () => {\n const client = new CopilotClient({ useStdio: true });\n onTestFinishedForceStop(client);\n\n await client.start();\n\n const status = await client.getStatus();\n expect(status.version).toBeDefined();\n expect(typeof status.version).toBe(\"string\");\n expect(status.protocolVersion).toBeDefined();\n expect(typeof status.protocolVersion).toBe(\"number\");\n expect(status.protocolVersion).toBeGreaterThanOrEqual(1);\n\n await client.stop();\n });\n\n it(\"should get auth status\", async () => {\n const client = new CopilotClient({ useStdio: true });\n onTestFinishedForceStop(client);\n\n await client.start();\n\n const authStatus = await client.getAuthStatus();\n expect(typeof authStatus.isAuthenticated).toBe(\"boolean\");\n if (authStatus.isAuthenticated) {\n expect(authStatus.authType).toBeDefined();\n expect(authStatus.statusMessage).toBeDefined();\n }\n\n await client.stop();\n });\n\n it(\"should list models when authenticated\", async () => {\n const client = new CopilotClient({ useStdio: true });\n onTestFinishedForceStop(client);\n\n await client.start();\n\n const authStatus = await client.getAuthStatus();\n if (!authStatus.isAuthenticated) {\n // Skip if not authenticated - models.list requires auth\n await client.stop();\n return;\n }\n\n const models = await client.listModels();\n expect(Array.isArray(models)).toBe(true);\n if (models.length > 0) {\n const model = models[0];\n expect(model.id).toBeDefined();\n expect(model.name).toBeDefined();\n expect(model.capabilities).toBeDefined();\n expect(model.capabilities.supports).toBeDefined();\n expect(model.capabilities.limits).toBeDefined();\n }\n\n await client.stop();\n });\n\n it(\"should report error with stderr when CLI fails to start\", async () => {\n const client = new CopilotClient({\n cliArgs: [\"--nonexistent-flag-for-testing\"],\n useStdio: true,\n });\n onTestFinishedForceStop(client);\n\n let initialError: Error | undefined;\n try {\n await client.start();\n expect.fail(\"Expected start() to throw an error\");\n } catch (error) {\n initialError = error as Error;\n expect(initialError.message).toContain(\"stderr\");\n expect(initialError.message).toContain(\"nonexistent\");\n }\n\n // Verify subsequent calls also fail (don't hang)\n try {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n await session.send(\"test\");\n expect.fail(\"Expected send() to throw an error after CLI exit\");\n } catch (error) {\n expect((error as Error).message).toContain(\"Connection is closed\");\n }\n });\n});\n" }, { "path": "nodejs/test/e2e/client_api.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { describe, expect, it } from \"vitest\";\nimport { approveAll } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\ndescribe(\"Client session management\", async () => {\n const { copilotClient: client } = await createSdkTestContext();\n\n async function assertFailure(\n action: () => Promise,\n expectedMessage: string\n ): Promise {\n await expect(action()).rejects.toSatisfy((err: unknown) => {\n const text = err instanceof Error ? `${err.message}\\n${err.stack ?? \"\"}` : String(err);\n expect(text.toLowerCase()).toContain(expectedMessage.toLowerCase());\n return true;\n });\n }\n\n it(\"should delete session by id\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const sessionId = session.sessionId;\n\n await session.sendAndWait({ prompt: \"Say OK.\" });\n await session.disconnect();\n await client.deleteSession(sessionId);\n\n const metadata = await client.getSessionMetadata(sessionId);\n expect(metadata).toBeFalsy();\n });\n\n it(\"should report error when deleting unknown session id\", async () => {\n await client.start();\n\n await assertFailure(\n () => client.deleteSession(\"00000000-0000-0000-0000-000000000000\"),\n \"Session file not found\"\n );\n });\n\n it(\"should get null last session id before any sessions exist\", async () => {\n await client.start();\n\n const result = await client.getLastSessionId();\n expect(result).toBeFalsy();\n });\n\n it(\"should track last session id after session created\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n await session.sendAndWait({ prompt: \"Say OK.\" });\n const sessionId = session.sessionId;\n await session.disconnect();\n\n const lastId = await client.getLastSessionId();\n expect(lastId).toBe(sessionId);\n });\n\n it(\"should get null foreground session id in headless mode\", async () => {\n await client.start();\n\n const sessionId = await client.getForegroundSessionId();\n expect(sessionId).toBeFalsy();\n });\n\n it(\"should report error when setting foreground session in headless mode\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await assertFailure(\n () => client.setForegroundSessionId(session.sessionId),\n \"Not running in TUI+server mode\"\n );\n\n await session.disconnect();\n });\n});\n" }, { "path": "nodejs/test/e2e/client_lifecycle.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { describe, expect, it } from \"vitest\";\nimport { SessionLifecycleEvent, approveAll } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext\";\n\ndescribe(\"Client Lifecycle\", async () => {\n const { copilotClient: client } = await createSdkTestContext();\n\n function deferred(): { promise: Promise; resolve: (value: T) => void } {\n let resolveFn!: (value: T) => void;\n const promise = new Promise((resolve) => {\n resolveFn = resolve;\n });\n return { promise, resolve: resolveFn };\n }\n\n async function withTimeout(promise: Promise, ms: number, label: string): Promise {\n let timer: NodeJS.Timeout | undefined;\n try {\n return await Promise.race([\n promise,\n new Promise((_, reject) => {\n timer = setTimeout(() => reject(new Error(`Timeout: ${label}`)), ms);\n }),\n ]);\n } finally {\n if (timer) clearTimeout(timer);\n }\n }\n\n it(\"should return last session id after sending a message\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await session.sendAndWait({ prompt: \"Say hello\" });\n\n // Poll until getLastSessionId returns something rather than a hard 500ms wait.\n // (Using await with a polling loop keeps fast machines fast and slow CI safe.)\n let lastSessionId: string | undefined;\n const deadline = Date.now() + 10_000;\n while (Date.now() < deadline) {\n lastSessionId = await client.getLastSessionId();\n if (lastSessionId) break;\n await new Promise((r) => setTimeout(r, 50));\n }\n\n // In parallel test runs we can't guarantee the last session ID matches\n // this specific session, since other tests may flush session data concurrently.\n expect(lastSessionId).toBeTruthy();\n\n await session.disconnect();\n });\n\n it(\"should return undefined for getLastSessionId with no sessions\", async () => {\n // On a fresh client this may return undefined or an older session ID\n const lastSessionId = await client.getLastSessionId();\n expect(lastSessionId === undefined || typeof lastSessionId === \"string\").toBe(true);\n });\n\n it(\"should emit session lifecycle events\", async () => {\n const events: SessionLifecycleEvent[] = [];\n const unsubscribe = client.on((event: SessionLifecycleEvent) => {\n events.push(event);\n });\n\n try {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await session.sendAndWait({ prompt: \"Say hello\" });\n\n // Poll for the session-specific event rather than a hard 500ms wait.\n const deadline = Date.now() + 10_000;\n while (\n Date.now() < deadline &&\n !events.some((e) => e.sessionId === session.sessionId)\n ) {\n await new Promise((r) => setTimeout(r, 50));\n }\n\n // Lifecycle events may not fire in all runtimes\n if (events.length > 0) {\n const sessionEvents = events.filter((e) => e.sessionId === session.sessionId);\n expect(sessionEvents.length).toBeGreaterThan(0);\n }\n\n await session.disconnect();\n } finally {\n unsubscribe();\n }\n });\n\n it(\"should receive session created lifecycle event\", async () => {\n const created = deferred();\n const unsubscribe = client.on((evt) => {\n if (evt.type === \"session.created\") {\n created.resolve(evt);\n }\n });\n\n try {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const evt = await withTimeout(created.promise, 10_000, \"session.created\");\n\n expect(evt.type).toBe(\"session.created\");\n expect(evt.sessionId).toBe(session.sessionId);\n\n await session.disconnect();\n } finally {\n unsubscribe();\n }\n });\n\n it(\"should filter session lifecycle events by type\", async () => {\n const created = deferred();\n const unsubscribe = client.on(\"session.created\", (evt) => {\n created.resolve(evt);\n });\n\n try {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const evt = await withTimeout(created.promise, 10_000, \"session.created (filtered)\");\n\n expect(evt.type).toBe(\"session.created\");\n expect(evt.sessionId).toBe(session.sessionId);\n\n await session.disconnect();\n } finally {\n unsubscribe();\n }\n });\n\n it(\"disposing lifecycle subscription stops receiving events\", async () => {\n let count = 0;\n const created = deferred();\n const unsubscribeFirst = client.on(() => {\n count += 1;\n });\n unsubscribeFirst();\n\n const unsubscribeActive = client.on(\"session.created\", (evt) => {\n created.resolve(evt);\n });\n\n try {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const evt = await withTimeout(created.promise, 10_000, \"session.created\");\n\n expect(evt.sessionId).toBe(session.sessionId);\n expect(count).toBe(0);\n\n await session.disconnect();\n } finally {\n unsubscribeActive();\n }\n });\n});\n" }, { "path": "nodejs/test/e2e/client_options.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport * as fs from \"fs\";\nimport * as net from \"net\";\nimport * as path from \"path\";\nimport { describe, expect, it, onTestFinished } from \"vitest\";\nimport { approveAll, CopilotClient } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\nconst FAKE_STDIO_CLI_SCRIPT = `const fs = require(\"fs\");\n\nconst captureIndex = process.argv.indexOf(\"--capture-file\");\nconst captureFile = captureIndex >= 0 ? process.argv[captureIndex + 1] : undefined;\nconst requests = [];\n\nfunction saveCapture() {\n if (!captureFile) {\n return;\n }\n\n fs.writeFileSync(captureFile, JSON.stringify({\n args: process.argv.slice(2),\n cwd: process.cwd(),\n requests,\n env: {\n COPILOT_SDK_AUTH_TOKEN: process.env.COPILOT_SDK_AUTH_TOKEN,\n COPILOT_OTEL_ENABLED: process.env.COPILOT_OTEL_ENABLED,\n OTEL_EXPORTER_OTLP_ENDPOINT: process.env.OTEL_EXPORTER_OTLP_ENDPOINT,\n COPILOT_OTEL_FILE_EXPORTER_PATH: process.env.COPILOT_OTEL_FILE_EXPORTER_PATH,\n COPILOT_OTEL_EXPORTER_TYPE: process.env.COPILOT_OTEL_EXPORTER_TYPE,\n COPILOT_OTEL_SOURCE_NAME: process.env.COPILOT_OTEL_SOURCE_NAME,\n OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT: process.env.OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT\n }\n }));\n}\n\nsaveCapture();\n\nlet buffer = Buffer.alloc(0);\n\nprocess.stdin.on(\"data\", chunk => {\n buffer = Buffer.concat([buffer, chunk]);\n processBuffer();\n});\n\nprocess.stdin.resume();\n\nfunction processBuffer() {\n while (true) {\n const headerEnd = buffer.indexOf(\"\\\\r\\\\n\\\\r\\\\n\");\n if (headerEnd < 0) {\n return;\n }\n\n const header = buffer.subarray(0, headerEnd).toString(\"utf8\");\n const match = /Content-Length:\\\\s*(\\\\d+)/i.exec(header);\n if (!match) {\n throw new Error(\"Missing Content-Length header\");\n }\n\n const length = Number(match[1]);\n const bodyStart = headerEnd + 4;\n const bodyEnd = bodyStart + length;\n if (buffer.length < bodyEnd) {\n return;\n }\n\n const body = buffer.subarray(bodyStart, bodyEnd).toString(\"utf8\");\n buffer = buffer.subarray(bodyEnd);\n handleMessage(JSON.parse(body));\n }\n}\n\nfunction handleMessage(message) {\n if (!Object.prototype.hasOwnProperty.call(message, \"id\")) {\n return;\n }\n\n requests.push({ method: message.method, params: message.params });\n saveCapture();\n\n if (message.method === \"ping\") {\n writeResponse(message.id, { message: \"pong\", protocolVersion: 3 });\n return;\n }\n\n if (message.method === \"session.create\") {\n const sessionId = message.params?.sessionId ?? message.params?.[0]?.sessionId ?? \"fake-session\";\n writeResponse(message.id, { sessionId, workspacePath: null, capabilities: null });\n return;\n }\n\n writeResponse(message.id, {});\n}\n\nfunction writeResponse(id, result) {\n const body = JSON.stringify({ jsonrpc: \"2.0\", id, result });\n process.stdout.write(\\`Content-Length: \\${Buffer.byteLength(body, \"utf8\")}\\\\r\\\\n\\\\r\\\\n\\${body}\\`);\n}\n`;\n\nasync function getAvailableTcpPort(): Promise {\n return new Promise((resolve, reject) => {\n const server = net.createServer();\n server.once(\"error\", reject);\n server.listen(0, \"127.0.0.1\", () => {\n const address = server.address();\n if (typeof address === \"object\" && address !== null) {\n const port = address.port;\n server.close(() => resolve(port));\n } else {\n server.close(() => reject(new Error(\"Failed to get available TCP port\")));\n }\n });\n });\n}\n\nfunction assertArgumentValue(\n args: (string | undefined)[],\n name: string,\n expectedValue: string\n): void {\n const index = args.indexOf(name);\n expect(\n index,\n `Expected argument '${name}' was not present. Args: ${args.join(\" \")}`\n ).toBeGreaterThanOrEqual(0);\n expect(index + 1).toBeLessThan(args.length);\n expect(args[index + 1]).toBe(expectedValue);\n}\n\ndescribe(\"Client options\", async () => {\n const { copilotClient: defaultClient, env, workDir } = await createSdkTestContext();\n\n it(\"autostart false requires explicit start\", async () => {\n const client = new CopilotClient({\n cwd: workDir,\n env,\n cliPath: process.env.COPILOT_CLI_PATH,\n autoStart: false,\n });\n onTestFinished(async () => {\n try {\n await client.forceStop();\n } catch {\n // Ignore cleanup errors\n }\n });\n\n expect(client.getState()).toBe(\"disconnected\");\n\n await expect(client.createSession({ onPermissionRequest: approveAll })).rejects.toThrow(\n /start/i\n );\n\n await client.start();\n expect(client.getState()).toBe(\"connected\");\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n expect(session.sessionId).toMatch(/^[a-f0-9-]+$/);\n\n await session.disconnect();\n });\n\n it(\"should listen on configured tcp port\", async () => {\n const port = await getAvailableTcpPort();\n const client = new CopilotClient({\n cwd: workDir,\n env,\n cliPath: process.env.COPILOT_CLI_PATH,\n useStdio: false,\n port,\n });\n onTestFinished(async () => {\n try {\n await client.forceStop();\n } catch {\n // Ignore cleanup errors\n }\n });\n\n await client.start();\n\n expect(client.getState()).toBe(\"connected\");\n expect((client as unknown as { actualPort: number }).actualPort).toBe(port);\n\n const response = await client.ping(\"fixed-port\");\n expect(response.message).toBe(\"pong: fixed-port\");\n });\n\n it(\"should use client cwd for default workingdirectory\", async () => {\n const clientCwd = path.join(workDir, \"client-cwd\");\n fs.mkdirSync(clientCwd, { recursive: true });\n fs.writeFileSync(path.join(clientCwd, \"marker.txt\"), \"I am in the client cwd\");\n\n // Reference defaultClient to keep the shared test context (and its CAPI proxy/env)\n // alive for the duration of this test; we deliberately spin up a fresh client with\n // a custom cwd to assert that the custom cwd is honored.\n void defaultClient;\n const client = new CopilotClient({\n cwd: clientCwd,\n env,\n cliPath: process.env.COPILOT_CLI_PATH,\n gitHubToken: process.env.CI ? \"fake-token-for-e2e-tests\" : undefined,\n });\n onTestFinished(async () => {\n try {\n await client.forceStop();\n } catch {\n // Ignore cleanup errors\n }\n });\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n const message = await session.sendAndWait({\n prompt: \"Read the file marker.txt and tell me what it says\",\n });\n\n expect(message?.data.content ?? \"\").toContain(\"client cwd\");\n\n await session.disconnect();\n });\n\n it(\"should propagate process options to spawned cli\", async () => {\n const cliPath = path.join(\n workDir,\n `fake-cli-${Date.now()}-${Math.random().toString(36).slice(2)}.js`\n );\n const capturePath = path.join(\n workDir,\n `fake-cli-capture-${Date.now()}-${Math.random().toString(36).slice(2)}.json`\n );\n const telemetryPath = path.join(workDir, \"telemetry.jsonl\");\n fs.writeFileSync(cliPath, FAKE_STDIO_CLI_SCRIPT);\n\n const client = new CopilotClient({\n cwd: workDir,\n env,\n autoStart: false,\n cliPath,\n cliArgs: [\"--capture-file\", capturePath],\n gitHubToken: \"process-option-token\",\n logLevel: \"debug\",\n sessionIdleTimeoutSeconds: 17,\n telemetry: {\n otlpEndpoint: \"http://127.0.0.1:4318\",\n filePath: telemetryPath,\n exporterType: \"file\",\n sourceName: \"ts-sdk-e2e\",\n captureContent: true,\n },\n useLoggedInUser: false,\n });\n onTestFinished(async () => {\n try {\n await client.forceStop();\n } catch {\n // Ignore cleanup errors\n }\n });\n\n await client.start();\n\n const captureRaw = fs.readFileSync(capturePath, \"utf8\");\n const capture = JSON.parse(captureRaw) as {\n args: string[];\n cwd: string;\n env: Record;\n requests: { method: string; params: unknown }[];\n };\n\n assertArgumentValue(capture.args, \"--log-level\", \"debug\");\n expect(capture.args).toContain(\"--stdio\");\n assertArgumentValue(capture.args, \"--auth-token-env\", \"COPILOT_SDK_AUTH_TOKEN\");\n expect(capture.args).toContain(\"--no-auto-login\");\n assertArgumentValue(capture.args, \"--session-idle-timeout\", \"17\");\n expect(path.resolve(capture.cwd)).toBe(path.resolve(workDir));\n\n expect(capture.env.COPILOT_SDK_AUTH_TOKEN).toBe(\"process-option-token\");\n expect(capture.env.COPILOT_OTEL_ENABLED).toBe(\"true\");\n expect(capture.env.OTEL_EXPORTER_OTLP_ENDPOINT).toBe(\"http://127.0.0.1:4318\");\n expect(capture.env.COPILOT_OTEL_FILE_EXPORTER_PATH).toBe(telemetryPath);\n expect(capture.env.COPILOT_OTEL_EXPORTER_TYPE).toBe(\"file\");\n expect(capture.env.COPILOT_OTEL_SOURCE_NAME).toBe(\"ts-sdk-e2e\");\n expect(capture.env.OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT).toBe(\"true\");\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n enableConfigDiscovery: true,\n includeSubAgentStreamingEvents: false,\n });\n\n const updatedRaw = fs.readFileSync(capturePath, \"utf8\");\n const updated = JSON.parse(updatedRaw) as {\n requests: {\n method: string;\n params: {\n enableConfigDiscovery?: boolean;\n includeSubAgentStreamingEvents?: boolean;\n };\n }[];\n };\n const createRequests = updated.requests.filter((r) => r.method === \"session.create\");\n expect(createRequests).toHaveLength(1);\n expect(createRequests[0].params.enableConfigDiscovery).toBe(true);\n expect(createRequests[0].params.includeSubAgentStreamingEvents).toBe(false);\n\n await session.disconnect();\n });\n\n it(\"should throw when githubtoken used with cliurl\", () => {\n expect(() => {\n new CopilotClient({\n cliUrl: \"localhost:8080\",\n gitHubToken: \"gho_test_token\",\n });\n }).toThrow();\n });\n\n it(\"should throw when useloggedinuser used with cliurl\", () => {\n expect(() => {\n new CopilotClient({\n cliUrl: \"localhost:8080\",\n useLoggedInUser: false,\n });\n }).toThrow();\n });\n});\n" }, { "path": "nodejs/test/e2e/commands.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { afterAll, describe, expect, it } from \"vitest\";\nimport { CopilotClient, approveAll } from \"../../src/index.js\";\nimport type { SessionEvent } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\ndescribe(\"Commands\", async () => {\n // Use TCP mode so a second client can connect to the same CLI process\n const ctx = await createSdkTestContext({ useStdio: false });\n const client1 = ctx.copilotClient;\n\n // Trigger connection so we can read the port\n const initSession = await client1.createSession({ onPermissionRequest: approveAll });\n await initSession.disconnect();\n\n const actualPort = (client1 as unknown as { actualPort: number }).actualPort;\n const client2 = new CopilotClient({ cliUrl: `localhost:${actualPort}` });\n\n afterAll(async () => {\n await client2.stop();\n });\n\n it(\n \"client receives commands.changed when another client joins with commands\",\n { timeout: 20_000 },\n async () => {\n const session1 = await client1.createSession({\n onPermissionRequest: approveAll,\n });\n\n type CommandsChangedEvent = Extract;\n\n // Wait for the commands.changed event deterministically\n const commandsChangedPromise = new Promise((resolve) => {\n session1.on((event) => {\n if (event.type === \"commands.changed\") resolve(event);\n });\n });\n\n // Client2 joins with commands\n const session2 = await client2.resumeSession(session1.sessionId, {\n onPermissionRequest: approveAll,\n commands: [\n { name: \"deploy\", description: \"Deploy the app\", handler: async () => {} },\n ],\n disableResume: true,\n });\n\n // Rely on default vitest timeout\n const commandsChanged = await commandsChangedPromise;\n expect(commandsChanged.data.commands).toEqual(\n expect.arrayContaining([\n expect.objectContaining({ name: \"deploy\", description: \"Deploy the app\" }),\n ])\n );\n\n await session2.disconnect();\n }\n );\n\n it(\"session with commands creates successfully\", async () => {\n const session = await client1.createSession({\n onPermissionRequest: approveAll,\n commands: [\n { name: \"deploy\", description: \"Deploy the app\", handler: async () => {} },\n { name: \"rollback\", handler: async () => {} },\n ],\n });\n\n expect(session).toBeDefined();\n expect(session.sessionId).toMatch(/^[a-f0-9-]+$/);\n\n await session.disconnect();\n });\n\n it(\"session with commands resumes successfully\", async () => {\n const session1 = await client1.createSession({ onPermissionRequest: approveAll });\n const sessionId = session1.sessionId;\n\n const session2 = await client1.resumeSession(sessionId, {\n onPermissionRequest: approveAll,\n commands: [{ name: \"deploy\", description: \"Deploy\", handler: async () => {} }],\n });\n\n expect(session2).toBeDefined();\n expect(session2.sessionId).toBe(sessionId);\n\n await session2.disconnect();\n });\n\n it(\"session with no commands creates successfully\", async () => {\n const session = await client1.createSession({\n onPermissionRequest: approveAll,\n });\n\n expect(session).toBeDefined();\n expect(session.sessionId).toMatch(/^[a-f0-9-]+$/);\n\n await session.disconnect();\n });\n});\n" }, { "path": "nodejs/test/e2e/compaction.e2e.test.ts", "content": "import { describe, expect, it } from \"vitest\";\nimport { SessionEvent, approveAll } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\n// TODO: Compaction tests are skipped due to flakiness — re-enable once stabilized\ndescribe.skip(\"Compaction\", async () => {\n const { copilotClient: client } = await createSdkTestContext();\n\n it(\"should trigger compaction with low threshold and emit events\", async () => {\n // Create session with very low compaction thresholds to trigger compaction quickly\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n infiniteSessions: {\n enabled: true,\n // Trigger background compaction at 0.5% context usage (~1000 tokens)\n backgroundCompactionThreshold: 0.005,\n // Block at 1% to ensure compaction runs\n bufferExhaustionThreshold: 0.01,\n },\n });\n\n const events: SessionEvent[] = [];\n session.on((event) => {\n events.push(event);\n });\n\n // Send multiple messages to fill up the context window\n // With such low thresholds, even a few messages should trigger compaction\n await session.sendAndWait({\n prompt: \"Tell me a story about a dragon. Be detailed.\",\n });\n await session.sendAndWait({\n prompt: \"Continue the story with more details about the dragon's castle.\",\n });\n await session.sendAndWait({\n prompt: \"Now describe the dragon's treasure in great detail.\",\n });\n\n // Check for compaction events\n const compactionStartEvents = events.filter((e) => e.type === \"session.compaction_start\");\n const compactionCompleteEvents = events.filter(\n (e) => e.type === \"session.compaction_complete\"\n );\n\n // Should have triggered compaction at least once\n expect(compactionStartEvents.length).toBeGreaterThanOrEqual(1);\n expect(compactionCompleteEvents.length).toBeGreaterThanOrEqual(1);\n\n // Compaction should have succeeded\n const lastCompactionComplete =\n compactionCompleteEvents[compactionCompleteEvents.length - 1];\n expect(lastCompactionComplete.data.success).toBe(true);\n\n // Should have removed some tokens\n if (lastCompactionComplete.data.tokensRemoved !== undefined) {\n expect(lastCompactionComplete.data.tokensRemoved).toBeGreaterThan(0);\n }\n\n // Verify the session still works after compaction\n const answer = await session.sendAndWait({ prompt: \"What was the story about?\" });\n expect(answer?.data.content).toBeDefined();\n // Should remember it was about a dragon (context preserved via summary)\n expect(answer?.data.content?.toLowerCase()).toContain(\"dragon\");\n }, 120000);\n\n it(\"should not emit compaction events when infinite sessions disabled\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n infiniteSessions: {\n enabled: false,\n },\n });\n\n const compactionEvents: SessionEvent[] = [];\n session.on((event) => {\n if (\n event.type === \"session.compaction_start\" ||\n event.type === \"session.compaction_complete\"\n ) {\n compactionEvents.push(event);\n }\n });\n\n await session.sendAndWait({ prompt: \"What is 2+2?\" });\n\n // Should not have any compaction events when disabled\n expect(compactionEvents.length).toBe(0);\n });\n});\n" }, { "path": "nodejs/test/e2e/error_resilience.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { describe, expect, it } from \"vitest\";\nimport { approveAll } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext\";\n\ndescribe(\"Error Resilience\", async () => {\n const { copilotClient: client } = await createSdkTestContext();\n\n it(\"should throw when sending to disconnected session\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n await session.disconnect();\n\n await expect(session.sendAndWait({ prompt: \"Hello\" })).rejects.toThrow();\n });\n\n it(\"should throw when getting messages from disconnected session\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n await session.disconnect();\n\n await expect(session.getMessages()).rejects.toThrow();\n });\n\n it(\"should handle double abort without error\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n // First abort should be fine\n await session.abort();\n // Second abort should not throw\n await session.abort();\n\n // Session should still be disconnectable\n await session.disconnect();\n });\n\n it(\"should throw when resuming non-existent session\", async () => {\n await expect(\n client.resumeSession(\"non-existent-session-id-12345\", {\n onPermissionRequest: approveAll,\n })\n ).rejects.toThrow();\n });\n});\n" }, { "path": "nodejs/test/e2e/event_fidelity.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { writeFile } from \"fs/promises\";\nimport { join } from \"path\";\nimport { describe, expect, it } from \"vitest\";\nimport { SessionEvent, approveAll } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext\";\n\ndescribe(\"Event Fidelity\", async () => {\n const { copilotClient: client, workDir } = await createSdkTestContext();\n\n it(\"should emit events in correct order for tool-using conversation\", async () => {\n await writeFile(join(workDir, \"hello.txt\"), \"Hello World\");\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const events: SessionEvent[] = [];\n session.on((event) => {\n events.push(event);\n });\n\n await session.sendAndWait({\n prompt: \"Read the file 'hello.txt' and tell me its contents.\",\n });\n\n const types = events.map((e) => e.type);\n\n // Must have user message, tool execution, assistant message, and idle\n expect(types).toContain(\"user.message\");\n expect(types).toContain(\"assistant.message\");\n\n // user.message should come before assistant.message\n const userIdx = types.indexOf(\"user.message\");\n const assistantIdx = types.lastIndexOf(\"assistant.message\");\n expect(userIdx).toBeLessThan(assistantIdx);\n\n // session.idle should be last\n const idleIdx = types.lastIndexOf(\"session.idle\");\n expect(idleIdx).toBe(types.length - 1);\n\n await session.disconnect();\n });\n\n it(\"should include valid fields on all events\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const events: SessionEvent[] = [];\n session.on((event) => {\n events.push(event);\n });\n\n await session.sendAndWait({\n prompt: \"What is 5+5? Reply with just the number.\",\n });\n\n // All events must have id and timestamp\n for (const event of events) {\n expect(event.id).toBeDefined();\n expect(typeof event.id).toBe(\"string\");\n expect(event.id.length).toBeGreaterThan(0);\n\n expect(event.timestamp).toBeDefined();\n expect(typeof event.timestamp).toBe(\"string\");\n }\n\n // user.message should have content\n const userEvent = events.find((e) => e.type === \"user.message\");\n expect(userEvent).toBeDefined();\n expect(userEvent?.data.content).toBeDefined();\n\n // assistant.message should have messageId and content\n const assistantEvent = events.find((e) => e.type === \"assistant.message\");\n expect(assistantEvent).toBeDefined();\n expect(assistantEvent?.data.messageId).toBeDefined();\n expect(assistantEvent?.data.content).toBeDefined();\n\n await session.disconnect();\n });\n\n it(\"should emit tool execution events with correct fields\", async () => {\n await writeFile(join(workDir, \"data.txt\"), \"test data\");\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const events: SessionEvent[] = [];\n session.on((event) => {\n events.push(event);\n });\n\n await session.sendAndWait({\n prompt: \"Read the file 'data.txt'.\",\n });\n\n // Should have tool.execution_start and tool.execution_complete\n const toolStarts = events.filter((e) => e.type === \"tool.execution_start\");\n const toolCompletes = events.filter((e) => e.type === \"tool.execution_complete\");\n\n expect(toolStarts.length).toBeGreaterThanOrEqual(1);\n expect(toolCompletes.length).toBeGreaterThanOrEqual(1);\n\n // Tool start should have toolCallId and toolName\n const firstStart = toolStarts[0]!;\n expect(firstStart.data.toolCallId).toBeDefined();\n expect(firstStart.data.toolName).toBeDefined();\n\n // Tool complete should have toolCallId\n const firstComplete = toolCompletes[0]!;\n expect(firstComplete.data.toolCallId).toBeDefined();\n\n await session.disconnect();\n });\n\n it(\"should emit assistant.message with messageId\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const events: SessionEvent[] = [];\n session.on((event) => {\n events.push(event);\n });\n\n await session.sendAndWait({\n prompt: \"Say 'pong'.\",\n });\n\n const assistantEvents = events.filter((e) => e.type === \"assistant.message\");\n expect(assistantEvents.length).toBeGreaterThanOrEqual(1);\n\n // messageId should be present\n const msg = assistantEvents[0]!;\n expect(msg.data.messageId).toBeDefined();\n expect(typeof msg.data.messageId).toBe(\"string\");\n expect(msg.data.content).toContain(\"pong\");\n\n await session.disconnect();\n });\n});\n" }, { "path": "nodejs/test/e2e/harness/CapiProxy.ts", "content": "import { spawn } from \"child_process\";\nimport { resolve } from \"path\";\nimport { expect } from \"vitest\";\nimport {\n CopilotUserResponse,\n ParsedHttpExchange,\n} from \"../../../../test/harness/replayingCapiProxy\";\n\nconst HARNESS_SERVER_PATH = resolve(__dirname, \"../../../../test/harness/server.ts\");\n\n// Manages a child process that acts as a replaying proxy to the underlying AI endpoints\nexport class CapiProxy {\n private proxyUrl: string | undefined;\n\n /**\n * Returns the URL of the running proxy. Throws if the proxy has not been started.\n */\n get url(): string {\n if (!this.proxyUrl) {\n throw new Error(\"CapiProxy has not been started; call start() first.\");\n }\n return this.proxyUrl;\n }\n\n async start(): Promise {\n const serverProcess = spawn(\"npx\", [\"tsx\", HARNESS_SERVER_PATH], {\n stdio: [\"ignore\", \"pipe\", \"inherit\"],\n shell: true,\n });\n\n this.proxyUrl = await new Promise((resolve) => {\n serverProcess.stdout!.once(\"data\", (chunk: Buffer) => {\n const match = chunk.toString().match(/Listening: (http:\\/\\/[^\\s]+)/);\n resolve(match![1]);\n });\n });\n\n return this.proxyUrl;\n }\n\n async updateConfig(config: {\n filePath: string;\n workDir: string;\n testInfo?: { file: string; line?: number };\n }): Promise {\n const response = await fetch(`${this.proxyUrl}/config`, {\n method: \"POST\",\n headers: { \"content-type\": \"application/json\" },\n body: JSON.stringify(config),\n });\n expect(response.ok).toBe(true);\n }\n\n async getExchanges(): Promise {\n const response = await fetch(`${this.proxyUrl}/exchanges`, { method: \"GET\" });\n return await response.json();\n }\n\n async stop(skipWritingCache?: boolean): Promise {\n const url = skipWritingCache\n ? `${this.proxyUrl}/stop?skipWritingCache=true`\n : `${this.proxyUrl}/stop`;\n const response = await fetch(url, { method: \"POST\" });\n expect(response.ok).toBe(true);\n }\n\n /**\n * Register a per-token response for the `/copilot_internal/user` endpoint.\n * When a request with `Authorization: Bearer ` arrives at the proxy,\n * the matching response is returned.\n */\n async setCopilotUserByToken(token: string, response: CopilotUserResponse): Promise {\n const res = await fetch(`${this.proxyUrl}/copilot-user-config`, {\n method: \"POST\",\n headers: { \"content-type\": \"application/json\" },\n body: JSON.stringify({ token, response }),\n });\n expect(res.ok).toBe(true);\n }\n}\n" }, { "path": "nodejs/test/e2e/harness/sdkTestContext.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport fs, { realpathSync } from \"fs\";\nimport { rm } from \"fs/promises\";\nimport os from \"os\";\nimport { basename, dirname, join, resolve } from \"path\";\nimport { rimraf } from \"rimraf\";\nimport { fileURLToPath } from \"url\";\nimport { afterAll, afterEach, beforeEach, onTestFailed, TestContext } from \"vitest\";\nimport { CopilotClient, CopilotClientOptions } from \"../../../src\";\nimport { CapiProxy } from \"./CapiProxy\";\nimport { retry, formatError } from \"./sdkTestHelper\";\n\nexport const isCI = process.env.GITHUB_ACTIONS === \"true\";\n\nconst __filename = fileURLToPath(import.meta.url);\nconst __dirname = dirname(__filename);\nconst SNAPSHOTS_DIR = resolve(__dirname, \"../../../../test/snapshots\");\n\nexport async function createSdkTestContext({\n logLevel,\n useStdio,\n copilotClientOptions,\n}: {\n logLevel?: \"error\" | \"none\" | \"warning\" | \"info\" | \"debug\" | \"all\";\n cliPath?: string;\n useStdio?: boolean;\n copilotClientOptions?: CopilotClientOptions;\n} = {}) {\n const homeDir = realpathSync(fs.mkdtempSync(join(os.tmpdir(), \"copilot-test-config-\")));\n const copilotHomeDir = realpathSync(fs.mkdtempSync(join(os.tmpdir(), \"copilot-test-home-\")));\n const workDir = realpathSync(fs.mkdtempSync(join(os.tmpdir(), \"copilot-test-work-\")));\n\n const openAiEndpoint = new CapiProxy();\n const proxyUrl = await openAiEndpoint.start();\n const env = {\n ...process.env,\n COPILOT_API_URL: proxyUrl,\n COPILOT_HOME: copilotHomeDir,\n\n // TODO: I'm not convinced the SDK should default to using whatever config you happen to have in your homedir.\n // The SDK config should be independent of the regular CLI app. Likewise it shouldn't mix sessions from the\n // SDK with those from the CLI app, at least not by default.\n XDG_CONFIG_HOME: homeDir,\n XDG_STATE_HOME: homeDir,\n };\n\n const copilotClient = new CopilotClient({\n cwd: workDir,\n env,\n logLevel: logLevel || \"error\",\n cliPath: process.env.COPILOT_CLI_PATH,\n // Use fake token in CI to allow cached responses without real auth\n gitHubToken: isCI ? \"fake-token-for-e2e-tests\" : undefined,\n useStdio: useStdio,\n ...copilotClientOptions,\n });\n\n const harness = { homeDir, workDir, openAiEndpoint, copilotClient, env };\n\n // Track if any test fails to avoid writing corrupted snapshots\n let anyTestFailed = false;\n\n // Wire up to Vitest lifecycle\n beforeEach(async (testContext) => {\n // Must be inside beforeEach - vitest requires test context\n onTestFailed(() => {\n anyTestFailed = true;\n });\n\n await openAiEndpoint.updateConfig({\n filePath: getTrafficCapturePath(testContext),\n workDir,\n testInfo: {\n file: testContext.task.file.filepath,\n line: testContext.task.location?.line,\n },\n });\n });\n\n afterEach(async () => {\n // Empty directories but leave them in place for next test\n await rimraf([join(homeDir, \"*\"), join(workDir, \"*\")], { glob: true });\n });\n\n afterAll(async () => {\n await copilotClient.stop();\n await openAiEndpoint.stop(anyTestFailed);\n await rmDir(\"remove e2e test copilotHomeDir\", copilotHomeDir);\n await rmDir(\"remove e2e test homeDir\", homeDir);\n await rmDir(\"remove e2e test workDir\", workDir);\n });\n\n return harness;\n}\n\nfunction getTrafficCapturePath(testContext: TestContext): string {\n const testFilePath = testContext.task.file.filepath;\n const suffix = \".test.ts\";\n if (!testFilePath.endsWith(suffix)) {\n throw new Error(\n `Test file path does not end with expected suffix '${suffix}': ${testFilePath}`\n );\n }\n\n // Convert to snake_case for cross-SDK snapshot compatibility\n // Strip \".e2e\" suffix so renamed \"xxx.e2e.test.ts\" still uses snapshot folder \"xxx\"\n let testFileName = basename(testFilePath, suffix).replace(/-/g, \"_\");\n if (testFileName.endsWith(\".e2e\")) {\n testFileName = testFileName.slice(0, -\".e2e\".length);\n }\n const taskNameAsFilename = testContext.task.name.replace(/[^a-z0-9]/gi, \"_\").toLowerCase();\n return join(SNAPSHOTS_DIR, testFileName, `${taskNameAsFilename}.yaml`);\n}\n\nasync function rmDir(message: string, path: string): Promise {\n // Use longer retries to tolerate Windows holding SQLite session-store.db\n // open briefly after the CLI subprocess exits. If the temp dir still can't\n // be removed (e.g. CLI background writer racing with cleanup), warn and\n // continue rather than failing the whole test run — the OS / CI runner\n // will reclaim the temp dir on shutdown.\n try {\n await retry(message, () => rm(path, { recursive: true, force: true }), 30, 1000);\n } catch (error) {\n console.warn(\n `WARN: ${message} failed; leaving temp dir for OS cleanup: ${formatError(error)}`\n );\n }\n}\n" }, { "path": "nodejs/test/e2e/harness/sdkTestHelper.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { AssistantMessageEvent, CopilotSession, SessionEvent } from \"../../../src\";\n\nexport async function getFinalAssistantMessage(\n session: CopilotSession,\n { alreadyIdle = false }: { alreadyIdle?: boolean } = {}\n): Promise {\n // We don't know whether the answer has already arrived or not, so race both possibilities\n return new Promise(async (resolve, reject) => {\n getFutureFinalResponse(session).then(resolve).catch(reject);\n getExistingFinalResponse(session, alreadyIdle)\n .then((msg) => {\n if (msg) {\n resolve(msg);\n }\n })\n .catch(reject);\n });\n}\n\nfunction getExistingFinalResponse(\n session: CopilotSession,\n alreadyIdle: boolean = false\n): Promise {\n return new Promise(async (resolve, reject) => {\n const messages = await session.getMessages();\n const finalUserMessageIndex = messages.findLastIndex((m) => m.type === \"user.message\");\n const currentTurnMessages =\n finalUserMessageIndex < 0 ? messages : messages.slice(finalUserMessageIndex);\n\n const currentTurnError = currentTurnMessages.find((m) => m.type === \"session.error\");\n if (currentTurnError) {\n const error = new Error(currentTurnError.data.message);\n error.stack = currentTurnError.data.stack;\n reject(error);\n return;\n }\n\n const sessionIdleMessageIndex = alreadyIdle\n ? currentTurnMessages.length\n : currentTurnMessages.findIndex((m) => m.type === \"session.idle\");\n if (sessionIdleMessageIndex !== -1) {\n const lastAssistantMessage = currentTurnMessages\n .slice(0, sessionIdleMessageIndex)\n .findLast((m) => m.type === \"assistant.message\");\n resolve(lastAssistantMessage as AssistantMessageEvent | undefined);\n return;\n }\n\n resolve(undefined);\n });\n}\n\nfunction getFutureFinalResponse(session: CopilotSession): Promise {\n return new Promise((resolve, reject) => {\n let finalAssistantMessage: AssistantMessageEvent | undefined;\n session.on((event) => {\n if (event.type === \"assistant.message\") {\n finalAssistantMessage = event;\n } else if (event.type === \"session.idle\") {\n if (!finalAssistantMessage) {\n reject(\n new Error(\"Received session.idle without a preceding assistant.message\")\n );\n } else {\n resolve(finalAssistantMessage);\n }\n } else if (event.type === \"session.error\") {\n const error = new Error(event.data.message);\n error.stack = event.data.stack;\n reject(error);\n }\n });\n });\n}\n\nexport async function retry(\n message: string,\n fn: () => Promise,\n maxTries: number = 100,\n delay: number = 100\n) {\n let failedAttempts = 0;\n while (true) {\n try {\n await fn();\n return;\n } catch (error: unknown) {\n failedAttempts++;\n if (failedAttempts >= maxTries) {\n throw new Error(\n `Failed to ${message} after ${maxTries} attempts\\n${formatError(error)}`\n );\n }\n await new Promise((resolve) => setTimeout(resolve, delay));\n }\n }\n}\n\nexport function formatError(error: unknown): string {\n if (error instanceof Error) {\n return String(error);\n } else if (typeof error === \"object\" && error !== null) {\n try {\n return JSON.stringify(error);\n } catch {\n return \"[object with circular reference]\";\n }\n } else {\n return String(error);\n }\n}\n\nexport function getNextEventOfType(\n session: CopilotSession,\n eventType: SessionEvent[\"type\"]\n): Promise {\n return new Promise((resolve, reject) => {\n const unsubscribe = session.on((event) => {\n if (event.type === eventType) {\n unsubscribe();\n resolve(event);\n } else if (event.type === \"session.error\") {\n unsubscribe();\n reject(new Error(`${event.data.message}\\n${event.data.stack}`));\n }\n });\n });\n}\n" }, { "path": "nodejs/test/e2e/hooks.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { readFile, writeFile } from \"fs/promises\";\nimport { join } from \"path\";\nimport { describe, expect, it } from \"vitest\";\nimport type {\n PreToolUseHookInput,\n PreToolUseHookOutput,\n PostToolUseHookInput,\n PostToolUseHookOutput,\n} from \"../../src/index.js\";\nimport { approveAll } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\ndescribe(\"Session hooks\", async () => {\n const { copilotClient: client, workDir } = await createSdkTestContext();\n\n it(\"should invoke preToolUse hook when model runs a tool\", async () => {\n const preToolUseInputs: PreToolUseHookInput[] = [];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n hooks: {\n onPreToolUse: async (input, invocation) => {\n preToolUseInputs.push(input);\n expect(invocation.sessionId).toBe(session.sessionId);\n // Allow the tool to run\n return { permissionDecision: \"allow\" } as PreToolUseHookOutput;\n },\n },\n });\n\n // Create a file for the model to read\n await writeFile(join(workDir, \"hello.txt\"), \"Hello from the test!\");\n\n await session.sendAndWait({\n prompt: \"Read the contents of hello.txt and tell me what it says\",\n });\n\n // Should have received at least one preToolUse hook call\n expect(preToolUseInputs.length).toBeGreaterThan(0);\n\n // Should have received the tool name\n expect(preToolUseInputs.some((input) => input.toolName)).toBe(true);\n\n await session.disconnect();\n });\n\n it(\"should invoke postToolUse hook after model runs a tool\", async () => {\n const postToolUseInputs: PostToolUseHookInput[] = [];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n hooks: {\n onPostToolUse: async (input, invocation) => {\n postToolUseInputs.push(input);\n expect(invocation.sessionId).toBe(session.sessionId);\n return null as PostToolUseHookOutput;\n },\n },\n });\n\n // Create a file for the model to read\n await writeFile(join(workDir, \"world.txt\"), \"World from the test!\");\n\n await session.sendAndWait({\n prompt: \"Read the contents of world.txt and tell me what it says\",\n });\n\n // Should have received at least one postToolUse hook call\n expect(postToolUseInputs.length).toBeGreaterThan(0);\n\n // Should have received the tool name and result\n expect(postToolUseInputs.some((input) => input.toolName)).toBe(true);\n expect(postToolUseInputs.some((input) => input.toolResult !== undefined)).toBe(true);\n\n await session.disconnect();\n });\n\n it(\"should invoke both preToolUse and postToolUse hooks for a single tool call\", async () => {\n const preToolUseInputs: PreToolUseHookInput[] = [];\n const postToolUseInputs: PostToolUseHookInput[] = [];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n hooks: {\n onPreToolUse: async (input) => {\n preToolUseInputs.push(input);\n return { permissionDecision: \"allow\" } as PreToolUseHookOutput;\n },\n onPostToolUse: async (input) => {\n postToolUseInputs.push(input);\n return null as PostToolUseHookOutput;\n },\n },\n });\n\n await writeFile(join(workDir, \"both.txt\"), \"Testing both hooks!\");\n\n await session.sendAndWait({\n prompt: \"Read the contents of both.txt\",\n });\n\n // Both hooks should have been called\n expect(preToolUseInputs.length).toBeGreaterThan(0);\n expect(postToolUseInputs.length).toBeGreaterThan(0);\n\n // The same tool should appear in both\n const preToolNames = preToolUseInputs.map((i) => i.toolName);\n const postToolNames = postToolUseInputs.map((i) => i.toolName);\n const commonTool = preToolNames.find((name) => postToolNames.includes(name));\n expect(commonTool).toBeDefined();\n\n await session.disconnect();\n });\n\n it(\"should deny tool execution when preToolUse returns deny\", async () => {\n const preToolUseInputs: PreToolUseHookInput[] = [];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n hooks: {\n onPreToolUse: async (input) => {\n preToolUseInputs.push(input);\n // Deny all tool calls\n return { permissionDecision: \"deny\" } as PreToolUseHookOutput;\n },\n },\n });\n\n // Create a file\n const originalContent = \"Original content that should not be modified\";\n await writeFile(join(workDir, \"protected.txt\"), originalContent);\n\n const response = await session.sendAndWait({\n prompt: \"Edit protected.txt and replace 'Original' with 'Modified'\",\n });\n\n // The hook should have been called\n expect(preToolUseInputs.length).toBeGreaterThan(0);\n\n // The response should indicate the tool was denied (behavior may vary)\n // At minimum, we verify the hook was invoked\n expect(response).toBeDefined();\n\n // Strengthen: verify the actual deny behavior — the protected file was NOT\n // modified by the runtime even though the LLM tried to edit it. The\n // pre-tool-use hook denial blocks tool execution before it can mutate state.\n const actualContent = await readFile(join(workDir, \"protected.txt\"), \"utf-8\");\n expect(actualContent).toBe(originalContent);\n\n await session.disconnect();\n });\n});\n" }, { "path": "nodejs/test/e2e/hooks_extended.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { describe, expect, it } from \"vitest\";\nimport { z } from \"zod\";\nimport { approveAll, defineTool } from \"../../src/index.js\";\nimport type {\n ErrorOccurredHookInput,\n PostToolUseHookInput,\n PreToolUseHookInput,\n SessionEndHookInput,\n SessionStartHookInput,\n UserPromptSubmittedHookInput,\n} from \"../../src/types.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\ndescribe(\"Extended session hooks\", async () => {\n const { copilotClient: client } = await createSdkTestContext();\n\n it(\"should invoke onSessionStart hook on new session\", async () => {\n const sessionStartInputs: SessionStartHookInput[] = [];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n hooks: {\n onSessionStart: async (input, invocation) => {\n sessionStartInputs.push(input);\n expect(invocation.sessionId).toBe(session.sessionId);\n },\n },\n });\n\n await session.sendAndWait({\n prompt: \"Say hi\",\n });\n\n expect(sessionStartInputs.length).toBeGreaterThan(0);\n expect(sessionStartInputs[0].source).toBe(\"new\");\n expect(sessionStartInputs[0].timestamp).toBeGreaterThan(0);\n expect(sessionStartInputs[0].cwd).toBeDefined();\n\n await session.disconnect();\n });\n\n it(\"should invoke onUserPromptSubmitted hook when sending a message\", async () => {\n const userPromptInputs: UserPromptSubmittedHookInput[] = [];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n hooks: {\n onUserPromptSubmitted: async (input, invocation) => {\n userPromptInputs.push(input);\n expect(invocation.sessionId).toBe(session.sessionId);\n },\n },\n });\n\n await session.sendAndWait({\n prompt: \"Say hello\",\n });\n\n expect(userPromptInputs.length).toBeGreaterThan(0);\n expect(userPromptInputs[0].prompt).toContain(\"Say hello\");\n expect(userPromptInputs[0].timestamp).toBeGreaterThan(0);\n expect(userPromptInputs[0].cwd).toBeDefined();\n\n await session.disconnect();\n });\n\n it(\"should invoke onSessionEnd hook when session is disconnected\", async () => {\n const sessionEndInputs: SessionEndHookInput[] = [];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n hooks: {\n onSessionEnd: async (input, invocation) => {\n sessionEndInputs.push(input);\n expect(invocation.sessionId).toBe(session.sessionId);\n },\n },\n });\n\n await session.sendAndWait({\n prompt: \"Say hi\",\n });\n\n await session.disconnect();\n\n // Wait briefly for async hook\n await new Promise((resolve) => setTimeout(resolve, 100));\n\n expect(sessionEndInputs.length).toBeGreaterThan(0);\n });\n\n it(\"should invoke onErrorOccurred hook when error occurs\", async () => {\n const errorInputs: ErrorOccurredHookInput[] = [];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n hooks: {\n onErrorOccurred: async (input, invocation) => {\n errorInputs.push(input);\n expect(invocation.sessionId).toBe(session.sessionId);\n expect(input.timestamp).toBeGreaterThan(0);\n expect(input.cwd).toBeDefined();\n expect(input.error).toBeDefined();\n expect([\"model_call\", \"tool_execution\", \"system\", \"user_input\"]).toContain(\n input.errorContext\n );\n expect(typeof input.recoverable).toBe(\"boolean\");\n },\n },\n });\n\n await session.sendAndWait({\n prompt: \"Say hi\",\n });\n\n // onErrorOccurred is dispatched by the runtime for actual errors (model failures, system errors).\n // In a normal session it may not fire. Verify the hook is properly wired by checking\n // that the session works correctly with the hook registered.\n // If the hook did fire, the assertions inside it would have run.\n expect(session.sessionId).toBeDefined();\n\n await session.disconnect();\n });\n\n it(\"should invoke userPromptSubmitted hook and modify prompt\", async () => {\n const inputs: UserPromptSubmittedHookInput[] = [];\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n hooks: {\n onUserPromptSubmitted: async (input, invocation) => {\n inputs.push(input);\n expect(invocation.sessionId).toBeTruthy();\n return { modifiedPrompt: \"Reply with exactly: HOOKED_PROMPT\" };\n },\n },\n });\n\n const response = await session.sendAndWait({ prompt: \"Say something else\" });\n\n expect(inputs.length).toBeGreaterThan(0);\n expect(inputs[0].prompt).toContain(\"Say something else\");\n expect(response?.data.content ?? \"\").toContain(\"HOOKED_PROMPT\");\n\n await session.disconnect();\n });\n\n it(\"should invoke sessionStart hook\", async () => {\n const inputs: SessionStartHookInput[] = [];\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n hooks: {\n onSessionStart: async (input, invocation) => {\n inputs.push(input);\n expect(invocation.sessionId).toBeTruthy();\n return { additionalContext: \"Session start hook context.\" };\n },\n },\n });\n\n await session.sendAndWait({ prompt: \"Say hi\" });\n\n expect(inputs.length).toBeGreaterThan(0);\n expect(inputs[0].source).toBe(\"new\");\n expect(inputs[0].cwd).toBeTruthy();\n\n await session.disconnect();\n });\n\n it(\"should invoke sessionEnd hook\", async () => {\n const inputs: SessionEndHookInput[] = [];\n let resolveHook!: (value: SessionEndHookInput) => void;\n const hookInvoked = new Promise((resolve) => {\n resolveHook = resolve;\n });\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n hooks: {\n onSessionEnd: async (input, invocation) => {\n inputs.push(input);\n expect(invocation.sessionId).toBeTruthy();\n resolveHook(input);\n return { sessionSummary: \"session ended\" };\n },\n },\n });\n\n await session.sendAndWait({ prompt: \"Say bye\" });\n await session.disconnect();\n\n let timer: NodeJS.Timeout | undefined;\n try {\n await Promise.race([\n hookInvoked,\n new Promise((_, reject) => {\n timer = setTimeout(() => reject(new Error(\"Timeout: onSessionEnd\")), 10_000);\n }),\n ]);\n } finally {\n if (timer) clearTimeout(timer);\n }\n\n expect(inputs.length).toBeGreaterThan(0);\n });\n\n it(\"should register erroroccurred hook\", async () => {\n const inputs: ErrorOccurredHookInput[] = [];\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n hooks: {\n onErrorOccurred: async (input, invocation) => {\n inputs.push(input);\n expect(invocation.sessionId).toBeTruthy();\n return { errorHandling: \"skip\" };\n },\n },\n });\n\n await session.sendAndWait({ prompt: \"Say hi\" });\n\n // OnErrorOccurred is dispatched only by genuine runtime errors. A normal turn\n // cannot deterministically trigger one; this test is registration-only.\n expect(inputs.length).toBe(0);\n expect(session.sessionId).toBeTruthy();\n\n await session.disconnect();\n });\n\n it(\"should allow preToolUse to return modifiedArgs and suppressOutput\", async () => {\n const inputs: PreToolUseHookInput[] = [];\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n tools: [\n defineTool(\"echo_value\", {\n description: \"Echoes the supplied value\",\n parameters: z.object({ value: z.string() }),\n handler: ({ value }) => value,\n }),\n ],\n hooks: {\n onPreToolUse: async (input) => {\n inputs.push(input);\n if (input.toolName !== \"echo_value\") {\n return { permissionDecision: \"allow\" };\n }\n return {\n permissionDecision: \"allow\",\n modifiedArgs: { value: \"modified by hook\" },\n suppressOutput: false,\n };\n },\n },\n });\n\n const response = await session.sendAndWait({\n prompt: \"Call echo_value with value 'original', then reply with the result.\",\n });\n\n expect(inputs.length).toBeGreaterThan(0);\n expect(inputs.some((input) => input.toolName === \"echo_value\")).toBe(true);\n expect(response?.data.content ?? \"\").toContain(\"modified by hook\");\n\n await session.disconnect();\n });\n\n it(\"should allow postToolUse to return modifiedResult\", async () => {\n const inputs: PostToolUseHookInput[] = [];\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n availableTools: [\"report_intent\"],\n hooks: {\n onPostToolUse: async (input) => {\n inputs.push(input);\n if (input.toolName !== \"report_intent\") {\n return undefined;\n }\n return {\n modifiedResult: {\n textResultForLlm: \"modified by post hook\",\n resultType: \"success\",\n toolTelemetry: {},\n },\n suppressOutput: false,\n };\n },\n },\n });\n\n const response = await session.sendAndWait({\n prompt: \"Call the report_intent tool with intent 'Testing post hook', then reply done.\",\n });\n\n expect(inputs.some((input) => input.toolName === \"report_intent\")).toBe(true);\n expect(response?.data.content).toBe(\"Done.\");\n\n await session.disconnect();\n });\n});\n" }, { "path": "nodejs/test/e2e/mcp_and_agents.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { dirname, resolve } from \"path\";\nimport { fileURLToPath } from \"url\";\nimport { describe, expect, it } from \"vitest\";\nimport { z } from \"zod\";\nimport type { CustomAgentConfig, MCPStdioServerConfig, MCPServerConfig } from \"../../src/index.js\";\nimport { approveAll, defineTool } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\nconst __filename = fileURLToPath(import.meta.url);\nconst __dirname = dirname(__filename);\nconst TEST_MCP_SERVER = resolve(__dirname, \"../../../test/harness/test-mcp-server.mjs\");\n\ndescribe(\"MCP Servers and Custom Agents\", async () => {\n const { copilotClient: client, openAiEndpoint } = await createSdkTestContext();\n\n describe(\"MCP Servers\", () => {\n it(\"should accept MCP server configuration on session create\", async () => {\n const mcpServers: Record = {\n \"test-server\": {\n type: \"local\",\n command: \"echo\",\n args: [\"hello\"],\n tools: [\"*\"],\n } as MCPStdioServerConfig,\n };\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n mcpServers,\n });\n\n expect(session.sessionId).toBeDefined();\n\n // Simple interaction to verify session works\n const message = await session.sendAndWait({\n prompt: \"What is 2+2?\",\n });\n expect(message?.data.content).toContain(\"4\");\n\n await session.disconnect();\n });\n\n it(\"should accept MCP server configuration on session resume\", async () => {\n // Create a session first\n const session1 = await client.createSession({ onPermissionRequest: approveAll });\n const sessionId = session1.sessionId;\n await session1.sendAndWait({ prompt: \"What is 1+1?\" });\n\n // Resume with MCP servers\n const mcpServers: Record = {\n \"test-server\": {\n type: \"local\",\n command: \"echo\",\n args: [\"hello\"],\n tools: [\"*\"],\n } as MCPStdioServerConfig,\n };\n\n const session2 = await client.resumeSession(sessionId, {\n onPermissionRequest: approveAll,\n mcpServers,\n });\n\n expect(session2.sessionId).toBe(sessionId);\n\n const message = await session2.sendAndWait({\n prompt: \"What is 3+3?\",\n });\n expect(message?.data.content).toContain(\"6\");\n\n await session2.disconnect();\n });\n\n it(\"should handle multiple MCP servers\", async () => {\n const mcpServers: Record = {\n server1: {\n type: \"local\",\n command: \"echo\",\n args: [\"server1\"],\n tools: [\"*\"],\n } as MCPStdioServerConfig,\n server2: {\n type: \"local\",\n command: \"echo\",\n args: [\"server2\"],\n tools: [\"*\"],\n } as MCPStdioServerConfig,\n };\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n mcpServers,\n });\n\n expect(session.sessionId).toBeDefined();\n await session.disconnect();\n });\n\n it(\"should pass literal env values to MCP server subprocess\", async () => {\n const mcpServers: Record = {\n \"env-echo\": {\n type: \"local\",\n command: \"node\",\n args: [TEST_MCP_SERVER],\n tools: [\"*\"],\n env: { TEST_SECRET: \"hunter2\" },\n } as MCPStdioServerConfig,\n };\n\n const session = await client.createSession({\n mcpServers,\n onPermissionRequest: approveAll,\n });\n\n expect(session.sessionId).toBeDefined();\n\n const message = await session.sendAndWait({\n prompt: \"Use the env-echo/get_env tool to read the TEST_SECRET environment variable. Reply with just the value, nothing else.\",\n });\n expect(message?.data.content).toContain(\"hunter2\");\n\n await session.disconnect();\n });\n });\n\n describe(\"Custom Agents\", () => {\n it(\"should accept custom agent configuration on session create\", async () => {\n const customAgents: CustomAgentConfig[] = [\n {\n name: \"test-agent\",\n displayName: \"Test Agent\",\n description: \"A test agent for SDK testing\",\n prompt: \"You are a helpful test agent.\",\n infer: true,\n },\n ];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n customAgents,\n });\n\n expect(session.sessionId).toBeDefined();\n\n // Simple interaction to verify session works\n const message = await session.sendAndWait({\n prompt: \"What is 5+5?\",\n });\n expect(message?.data.content).toContain(\"10\");\n\n await session.disconnect();\n });\n\n it(\"should accept custom agent configuration on session resume\", async () => {\n // Create a session first\n const session1 = await client.createSession({ onPermissionRequest: approveAll });\n const sessionId = session1.sessionId;\n await session1.sendAndWait({ prompt: \"What is 1+1?\" });\n\n // Resume with custom agents\n const customAgents: CustomAgentConfig[] = [\n {\n name: \"resume-agent\",\n displayName: \"Resume Agent\",\n description: \"An agent added on resume\",\n prompt: \"You are a resume test agent.\",\n },\n ];\n\n const session2 = await client.resumeSession(sessionId, {\n onPermissionRequest: approveAll,\n customAgents,\n });\n\n expect(session2.sessionId).toBe(sessionId);\n\n const message = await session2.sendAndWait({\n prompt: \"What is 6+6?\",\n });\n expect(message?.data.content).toContain(\"12\");\n\n await session2.disconnect();\n });\n\n it(\"should handle custom agent with tools configuration\", async () => {\n const customAgents: CustomAgentConfig[] = [\n {\n name: \"tool-agent\",\n displayName: \"Tool Agent\",\n description: \"An agent with specific tools\",\n prompt: \"You are an agent with specific tools.\",\n tools: [\"bash\", \"edit\"],\n infer: true,\n },\n ];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n customAgents,\n });\n\n expect(session.sessionId).toBeDefined();\n await session.disconnect();\n });\n\n it(\"should handle custom agent with MCP servers\", async () => {\n const customAgents: CustomAgentConfig[] = [\n {\n name: \"mcp-agent\",\n displayName: \"MCP Agent\",\n description: \"An agent with its own MCP servers\",\n prompt: \"You are an agent with MCP servers.\",\n mcpServers: {\n \"agent-server\": {\n type: \"local\",\n command: \"echo\",\n args: [\"agent-mcp\"],\n tools: [\"*\"],\n } as MCPStdioServerConfig,\n },\n },\n ];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n customAgents,\n });\n\n expect(session.sessionId).toBeDefined();\n await session.disconnect();\n });\n\n it(\"should handle multiple custom agents\", async () => {\n const customAgents: CustomAgentConfig[] = [\n {\n name: \"agent1\",\n displayName: \"Agent One\",\n description: \"First agent\",\n prompt: \"You are agent one.\",\n },\n {\n name: \"agent2\",\n displayName: \"Agent Two\",\n description: \"Second agent\",\n prompt: \"You are agent two.\",\n infer: false,\n },\n ];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n customAgents,\n });\n\n expect(session.sessionId).toBeDefined();\n await session.disconnect();\n });\n });\n\n describe(\"Combined Configuration\", () => {\n it(\"should accept both MCP servers and custom agents\", async () => {\n const mcpServers: Record = {\n \"shared-server\": {\n type: \"local\",\n command: \"echo\",\n args: [\"shared\"],\n tools: [\"*\"],\n } as MCPStdioServerConfig,\n };\n\n const customAgents: CustomAgentConfig[] = [\n {\n name: \"combined-agent\",\n displayName: \"Combined Agent\",\n description: \"An agent using shared MCP servers\",\n prompt: \"You are a combined test agent.\",\n },\n ];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n mcpServers,\n customAgents,\n });\n\n expect(session.sessionId).toBeDefined();\n\n const message = await session.sendAndWait({\n prompt: \"What is 7+7?\",\n });\n expect(message?.data.content).toContain(\"14\");\n\n await session.disconnect();\n });\n });\n\n describe(\"Default Agent Tool Exclusion\", () => {\n it(\"should hide excluded tools from default agent\", async () => {\n const secretTool = defineTool(\"secret_tool\", {\n description: \"A secret tool hidden from the default agent\",\n parameters: z.object({\n input: z.string().describe(\"Input to process\"),\n }),\n handler: ({ input }) => `SECRET:${input}`,\n });\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n tools: [secretTool],\n defaultAgent: {\n excludedTools: [\"secret_tool\"],\n },\n });\n\n // Ask about the tool — the default agent should not see it\n const message = await session.sendAndWait({\n prompt: \"Do you have access to a tool called secret_tool? Answer yes or no.\",\n });\n\n // Sanity-check the replayed response (not the actual exclusion assertion)\n expect(message?.data.content?.toLowerCase()).toContain(\"no\");\n\n // The real assertion: verify the runtime excluded the tool from the CAPI request\n const exchanges = await openAiEndpoint.getExchanges();\n const toolNames = exchanges.flatMap((e) =>\n (e.request.tools ?? []).map((t) => (\"function\" in t ? t.function.name : \"\"))\n );\n expect(toolNames).not.toContain(\"secret_tool\");\n\n await session.disconnect();\n });\n\n it(\"should accept defaultAgent configuration on session resume\", async () => {\n const session1 = await client.createSession({ onPermissionRequest: approveAll });\n const sessionId = session1.sessionId;\n await session1.sendAndWait({ prompt: \"What is 3+3?\" });\n\n const secretTool = defineTool(\"secret_tool\", {\n description: \"A secret tool hidden from the default agent\",\n parameters: z.object({\n input: z.string().describe(\"Input to process\"),\n }),\n handler: ({ input }) => `SECRET:${input}`,\n });\n\n const session2 = await client.resumeSession(sessionId, {\n onPermissionRequest: approveAll,\n tools: [secretTool],\n defaultAgent: {\n excludedTools: [\"secret_tool\"],\n },\n });\n\n expect(session2.sessionId).toBe(sessionId);\n\n const message = await session2.sendAndWait({\n prompt: \"What is 4+4?\",\n });\n expect(message?.data.content).toContain(\"8\");\n\n await session2.disconnect();\n });\n });\n});\n" }, { "path": "nodejs/test/e2e/multi-client.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { describe, expect, it, afterAll } from \"vitest\";\nimport { z } from \"zod\";\nimport { CopilotClient, defineTool, approveAll } from \"../../src/index.js\";\nimport type { SessionEvent } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext\";\n\ndescribe(\"Multi-client broadcast\", async () => {\n // Use TCP mode so a second client can connect to the same CLI process\n const ctx = await createSdkTestContext({ useStdio: false });\n const client1 = ctx.copilotClient;\n\n // Trigger connection so we can read the port\n const initSession = await client1.createSession({ onPermissionRequest: approveAll });\n await initSession.disconnect();\n\n const actualPort = (client1 as unknown as { actualPort: number }).actualPort;\n let client2 = new CopilotClient({ cliUrl: `localhost:${actualPort}` });\n\n afterAll(async () => {\n await client2.stop();\n });\n\n it(\"both clients see tool request and completion events\", async () => {\n const tool = defineTool(\"magic_number\", {\n description: \"Returns a magic number\",\n parameters: z.object({\n seed: z.string().describe(\"A seed value\"),\n }),\n handler: ({ seed }) => `MAGIC_${seed}_42`,\n });\n\n // Client 1 creates a session with a custom tool\n const session1 = await client1.createSession({\n onPermissionRequest: approveAll,\n tools: [tool],\n });\n\n // Client 2 resumes with NO tools — should not overwrite client 1's tools\n const session2 = await client2.resumeSession(session1.sessionId, {\n onPermissionRequest: approveAll,\n });\n\n // Set up event waiters BEFORE sending the prompt to avoid race conditions\n const waitForEvent = (session: typeof session1, type: string) =>\n new Promise((resolve) => {\n const unsub = session.on((event) => {\n if (event.type === type) {\n unsub();\n resolve(event);\n }\n });\n });\n\n const client1RequestedP = waitForEvent(session1, \"external_tool.requested\");\n const client2RequestedP = waitForEvent(session2, \"external_tool.requested\");\n const client1CompletedP = waitForEvent(session1, \"external_tool.completed\");\n const client2CompletedP = waitForEvent(session2, \"external_tool.completed\");\n\n // Send a prompt that triggers the custom tool\n const response = await session1.sendAndWait({\n prompt: \"Use the magic_number tool with seed 'hello' and tell me the result\",\n });\n\n // The response should contain the tool's output\n expect(response?.data.content).toContain(\"MAGIC_hello_42\");\n\n // Wait for all broadcast events to arrive on both clients\n await expect(\n Promise.all([\n client1RequestedP,\n client2RequestedP,\n client1CompletedP,\n client2CompletedP,\n ])\n ).resolves.toBeDefined();\n\n await session2.disconnect();\n });\n\n it(\"one client approves permission and both see the result\", async () => {\n const client1PermissionRequests: unknown[] = [];\n\n // Client 1 creates a session and manually approves permission requests\n const session1 = await client1.createSession({\n onPermissionRequest: (request) => {\n client1PermissionRequests.push(request);\n return { kind: \"approve-once\" as const };\n },\n });\n\n // Client 2 resumes the same session — its handler never resolves,\n // so only client 1's approval takes effect (no race)\n const session2 = await client2.resumeSession(session1.sessionId, {\n onPermissionRequest: () => new Promise(() => {}),\n });\n\n // Track events seen by each client\n const client1Events: SessionEvent[] = [];\n const client2Events: SessionEvent[] = [];\n\n session1.on((event) => client1Events.push(event));\n session2.on((event) => client2Events.push(event));\n\n // Send a prompt that triggers a write operation (requires permission)\n const response = await session1.sendAndWait({\n prompt: \"Create a file called hello.txt containing the text 'hello world'\",\n });\n\n expect(response?.data.content).toBeTruthy();\n\n // Client 1 should have handled the permission request\n expect(client1PermissionRequests.length).toBeGreaterThan(0);\n\n // Both clients should have seen permission.requested events\n const client1PermRequested = client1Events.filter((e) => e.type === \"permission.requested\");\n const client2PermRequested = client2Events.filter((e) => e.type === \"permission.requested\");\n expect(client1PermRequested.length).toBeGreaterThan(0);\n expect(client2PermRequested.length).toBeGreaterThan(0);\n\n // Both clients should have seen permission.completed events with approved result\n const client1PermCompleted = client1Events.filter(\n (e): e is SessionEvent & { type: \"permission.completed\" } =>\n e.type === \"permission.completed\"\n );\n const client2PermCompleted = client2Events.filter(\n (e): e is SessionEvent & { type: \"permission.completed\" } =>\n e.type === \"permission.completed\"\n );\n expect(client1PermCompleted.length).toBeGreaterThan(0);\n expect(client2PermCompleted.length).toBeGreaterThan(0);\n for (const event of [...client1PermCompleted, ...client2PermCompleted]) {\n expect(event.data.result.kind).toBe(\"approved\");\n }\n\n await session2.disconnect();\n });\n\n it(\"one client rejects permission and both see the result\", async () => {\n // Client 1 creates a session and denies all permission requests\n const session1 = await client1.createSession({\n onPermissionRequest: () => ({ kind: \"reject\" as const }),\n });\n\n // Client 2 resumes — its handler never resolves so only client 1's denial takes effect\n const session2 = await client2.resumeSession(session1.sessionId, {\n onPermissionRequest: () => new Promise(() => {}),\n });\n\n const client1Events: SessionEvent[] = [];\n const client2Events: SessionEvent[] = [];\n\n session1.on((event) => client1Events.push(event));\n session2.on((event) => client2Events.push(event));\n\n // Ask the agent to write a file (requires permission)\n const { writeFile } = await import(\"fs/promises\");\n const { join } = await import(\"path\");\n const testFile = join(ctx.workDir, \"protected.txt\");\n await writeFile(testFile, \"protected content\");\n\n await session1.sendAndWait({\n prompt: \"Edit protected.txt and replace 'protected' with 'hacked'.\",\n });\n\n // Verify the file was NOT modified (permission was denied)\n const { readFile } = await import(\"fs/promises\");\n const content = await readFile(testFile, \"utf-8\");\n expect(content).toBe(\"protected content\");\n\n // Both clients should have seen permission.requested and permission.completed\n expect(\n client1Events.filter((e) => e.type === \"permission.requested\").length\n ).toBeGreaterThan(0);\n expect(\n client2Events.filter((e) => e.type === \"permission.requested\").length\n ).toBeGreaterThan(0);\n\n // Both clients should see the denial in the completed event\n const client1PermCompleted = client1Events.filter(\n (e): e is SessionEvent & { type: \"permission.completed\" } =>\n e.type === \"permission.completed\"\n );\n const client2PermCompleted = client2Events.filter(\n (e): e is SessionEvent & { type: \"permission.completed\" } =>\n e.type === \"permission.completed\"\n );\n expect(client1PermCompleted.length).toBeGreaterThan(0);\n expect(client2PermCompleted.length).toBeGreaterThan(0);\n for (const event of [...client1PermCompleted, ...client2PermCompleted]) {\n expect(event.data.result.kind).toBe(\"denied-interactively-by-user\");\n }\n\n await session2.disconnect();\n });\n\n it(\n \"two clients register different tools and agent uses both\",\n { timeout: 90_000 },\n async () => {\n const toolA = defineTool(\"city_lookup\", {\n description: \"Returns a city name for a given country code\",\n parameters: z.object({\n countryCode: z.string().describe(\"A two-letter country code\"),\n }),\n handler: ({ countryCode }) => `CITY_FOR_${countryCode}`,\n });\n\n const toolB = defineTool(\"currency_lookup\", {\n description: \"Returns a currency for a given country code\",\n parameters: z.object({\n countryCode: z.string().describe(\"A two-letter country code\"),\n }),\n handler: ({ countryCode }) => `CURRENCY_FOR_${countryCode}`,\n });\n\n // Client 1 creates a session with tool A\n const session1 = await client1.createSession({\n onPermissionRequest: approveAll,\n tools: [toolA],\n });\n\n // Client 2 resumes with tool B (different tool, union should have both)\n const session2 = await client2.resumeSession(session1.sessionId, {\n onPermissionRequest: approveAll,\n tools: [toolB],\n });\n\n // Send prompts sequentially to avoid nondeterministic tool_call ordering\n const response1 = await session1.sendAndWait({\n prompt: \"Use the city_lookup tool with countryCode 'US' and tell me the result.\",\n });\n expect(response1?.data.content).toContain(\"CITY_FOR_US\");\n\n const response2 = await session1.sendAndWait({\n prompt: \"Now use the currency_lookup tool with countryCode 'US' and tell me the result.\",\n });\n expect(response2?.data.content).toContain(\"CURRENCY_FOR_US\");\n\n await session2.disconnect();\n }\n );\n\n it(\"disconnecting client removes its tools\", { timeout: 90_000 }, async () => {\n const toolA = defineTool(\"stable_tool\", {\n description: \"A tool that persists across disconnects\",\n parameters: z.object({ input: z.string() }),\n handler: ({ input }) => `STABLE_${input}`,\n });\n\n const toolB = defineTool(\"ephemeral_tool\", {\n description: \"A tool that will disappear when its client disconnects\",\n parameters: z.object({ input: z.string() }),\n handler: ({ input }) => `EPHEMERAL_${input}`,\n });\n\n // Client 1 creates a session with stable_tool\n const session1 = await client1.createSession({\n onPermissionRequest: approveAll,\n tools: [toolA],\n });\n\n // Client 2 resumes with ephemeral_tool\n await client2.resumeSession(session1.sessionId, {\n onPermissionRequest: approveAll,\n tools: [toolB],\n });\n\n // Verify both tools work before disconnect (sequential to avoid nondeterministic tool_call ordering)\n const stableResponse = await session1.sendAndWait({\n prompt: \"Use the stable_tool with input 'test1' and tell me the result.\",\n });\n expect(stableResponse?.data.content).toContain(\"STABLE_test1\");\n\n const ephemeralResponse = await session1.sendAndWait({\n prompt: \"Use the ephemeral_tool with input 'test2' and tell me the result.\",\n });\n expect(ephemeralResponse?.data.content).toContain(\"EPHEMERAL_test2\");\n\n // Disconnect client 2 without destroying the shared session.\n // Suppress \"Connection is disposed\" rejections that occur when the server\n // broadcasts events (e.g. tool_changed_notice) to the now-dead connection.\n const suppressDisposed = (reason: unknown) => {\n if (reason instanceof Error && reason.message.includes(\"Connection is disposed\")) {\n return;\n }\n throw reason;\n };\n process.on(\"unhandledRejection\", suppressDisposed);\n await client2.forceStop();\n\n // Give the server time to process the connection close and remove tools\n await new Promise((resolve) => setTimeout(resolve, 500));\n process.removeListener(\"unhandledRejection\", suppressDisposed);\n\n // Recreate client2 for cleanup in afterAll (but don't rejoin the session)\n client2 = new CopilotClient({ cliUrl: `localhost:${actualPort}` });\n\n // Now only stable_tool should be available\n const afterResponse = await session1.sendAndWait({\n prompt: \"Use the stable_tool with input 'still_here'. Also try using ephemeral_tool if it is available.\",\n });\n expect(afterResponse?.data.content).toContain(\"STABLE_still_here\");\n // ephemeral_tool should NOT have produced a result\n expect(afterResponse?.data.content).not.toContain(\"EPHEMERAL_\");\n });\n});\n" }, { "path": "nodejs/test/e2e/multi_turn.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { writeFile } from \"fs/promises\";\nimport { join } from \"path\";\nimport { describe, expect, it } from \"vitest\";\nimport { approveAll } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext\";\n\ndescribe(\"Multi-turn Tool Usage\", async () => {\n const { copilotClient: client, workDir } = await createSdkTestContext();\n\n it(\"should use tool results from previous turns\", async () => {\n // Write a file, then ask the model to read it and reason about its content\n await writeFile(join(workDir, \"secret.txt\"), \"The magic number is 42.\");\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n const msg1 = await session.sendAndWait({\n prompt: \"Read the file 'secret.txt' and tell me what the magic number is.\",\n });\n expect(msg1?.data.content).toContain(\"42\");\n\n // Follow-up that requires context from the previous turn\n const msg2 = await session.sendAndWait({\n prompt: \"What is that magic number multiplied by 2?\",\n });\n expect(msg2?.data.content).toContain(\"84\");\n });\n\n it(\"should handle file creation then reading across turns\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n // First turn: create a file\n await session.sendAndWait({\n prompt: \"Create a file called 'greeting.txt' with the content 'Hello from multi-turn test'.\",\n });\n\n // Second turn: read the file\n const msg = await session.sendAndWait({\n prompt: \"Read the file 'greeting.txt' and tell me its exact contents.\",\n });\n expect(msg?.data.content).toContain(\"Hello from multi-turn test\");\n });\n});\n" }, { "path": "nodejs/test/e2e/pending_work_resume.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { describe, expect, it, onTestFinished } from \"vitest\";\nimport { z } from \"zod\";\nimport { approveAll, CopilotClient, defineTool } from \"../../src/index.js\";\nimport type {\n CopilotSession,\n ExternalToolRequestedEvent,\n PermissionRequest,\n PermissionRequestedEvent,\n PermissionRequestResult,\n} from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\nimport { getFinalAssistantMessage } from \"./harness/sdkTestHelper.js\";\n\nconst PENDING_WORK_TIMEOUT_MS = 60_000;\nconst TEST_TIMEOUT_MS = 180_000;\n\nfunction deferred(): {\n promise: Promise;\n resolve: (value: T) => void;\n reject: (reason: unknown) => void;\n settled: () => boolean;\n} {\n let resolveFn!: (value: T) => void;\n let rejectFn!: (reason: unknown) => void;\n let isSettled = false;\n const promise = new Promise((resolve, reject) => {\n resolveFn = (value: T) => {\n isSettled = true;\n resolve(value);\n };\n rejectFn = (reason: unknown) => {\n isSettled = true;\n reject(reason);\n };\n });\n return { promise, resolve: resolveFn, reject: rejectFn, settled: () => isSettled };\n}\n\nasync function waitWithTimeout(\n promise: Promise,\n timeoutMs: number,\n label: string\n): Promise {\n let timer: NodeJS.Timeout | undefined;\n try {\n return await Promise.race([\n promise,\n new Promise((_, reject) => {\n timer = setTimeout(() => reject(new Error(`Timeout: ${label}`)), timeoutMs);\n }),\n ]);\n } finally {\n if (timer) clearTimeout(timer);\n }\n}\n\nfunction waitForExternalToolRequests(\n session: CopilotSession,\n toolNames: string[]\n): Promise> {\n const expected = new Set(toolNames);\n const seen: Record = {};\n const d = deferred>();\n let timer: NodeJS.Timeout | undefined;\n\n const unsubscribe = session.on((event) => {\n if (event.type === \"external_tool.requested\") {\n const evt = event as ExternalToolRequestedEvent;\n if (expected.has(evt.data.toolName)) {\n seen[evt.data.toolName] = evt;\n if (Object.keys(seen).length === expected.size) {\n if (timer) clearTimeout(timer);\n unsubscribe();\n d.resolve({ ...seen });\n }\n }\n } else if (event.type === \"session.error\") {\n if (timer) clearTimeout(timer);\n unsubscribe();\n d.reject(new Error(event.data.message ?? \"session error\"));\n }\n });\n\n timer = setTimeout(() => {\n unsubscribe();\n d.reject(\n new Error(\n `Timeout waiting for external tool request(s): ${Array.from(expected).join(\", \")}`\n )\n );\n }, PENDING_WORK_TIMEOUT_MS);\n\n return d.promise;\n}\n\nfunction waitForPermissionRequest(session: CopilotSession): Promise {\n const d = deferred();\n let timer: NodeJS.Timeout | undefined;\n\n const unsubscribe = session.on((event) => {\n if (event.type === \"permission.requested\") {\n if (timer) clearTimeout(timer);\n unsubscribe();\n d.resolve(event as PermissionRequestedEvent);\n } else if (event.type === \"session.error\") {\n if (timer) clearTimeout(timer);\n unsubscribe();\n d.reject(new Error(event.data.message ?? \"session error\"));\n }\n });\n\n timer = setTimeout(() => {\n unsubscribe();\n d.reject(new Error(\"Timeout waiting for permission.requested\"));\n }, PENDING_WORK_TIMEOUT_MS);\n\n return d.promise;\n}\n\ndescribe(\"Pending work resume\", async () => {\n const { env, workDir } = await createSdkTestContext();\n\n function createTcpServer(): CopilotClient {\n const server = new CopilotClient({\n cwd: workDir,\n env,\n cliPath: process.env.COPILOT_CLI_PATH,\n useStdio: false,\n });\n onTestFinished(async () => {\n try {\n await server.forceStop();\n } catch {\n // Ignore cleanup errors\n }\n });\n return server;\n }\n\n function createConnectingClient(cliUrl: string): CopilotClient {\n const client = new CopilotClient({ cliUrl });\n onTestFinished(async () => {\n try {\n await client.forceStop();\n } catch {\n // Ignore cleanup errors\n }\n });\n return client;\n }\n\n function getCliUrl(server: CopilotClient): string {\n const port = (server as unknown as { actualPort: number | null }).actualPort;\n if (!port) {\n throw new Error(\"Expected the test server to be listening on a TCP port.\");\n }\n return `localhost:${port}`;\n }\n\n it(\n \"should continue pending permission request after resume\",\n { timeout: TEST_TIMEOUT_MS },\n async () => {\n const originalPermissionRequest = deferred();\n const releaseOriginalPermission = deferred();\n let resumedToolInvoked = false;\n\n const server = createTcpServer();\n await server.start();\n const cliUrl = getCliUrl(server);\n\n const suspendedClient = createConnectingClient(cliUrl);\n const session1 = await suspendedClient.createSession({\n tools: [\n defineTool(\"resume_permission_tool\", {\n description: \"Transforms a value after permission is granted\",\n parameters: z.object({ value: z.string() }),\n handler: ({ value }) => `ORIGINAL_SHOULD_NOT_RUN_${value}`,\n }),\n ],\n onPermissionRequest: (request) => {\n originalPermissionRequest.resolve(request);\n return releaseOriginalPermission.promise;\n },\n });\n const sessionId = session1.sessionId;\n\n try {\n const permissionRequestedP = waitForPermissionRequest(session1);\n\n await session1.send({\n prompt: \"Use resume_permission_tool with value 'alpha', then reply with the result.\",\n });\n\n const initialRequest = await waitWithTimeout(\n originalPermissionRequest.promise,\n PENDING_WORK_TIMEOUT_MS,\n \"originalPermissionRequest\"\n );\n const permissionEvent = await permissionRequestedP;\n expect(initialRequest.kind).toBe(\"custom-tool\");\n\n await suspendedClient.forceStop();\n\n const resumedTcpClient = createConnectingClient(cliUrl);\n const session2 = await resumedTcpClient.resumeSession(sessionId, {\n continuePendingWork: true,\n onPermissionRequest: () => ({ kind: \"no-result\" }),\n tools: [\n defineTool(\"resume_permission_tool\", {\n description: \"Transforms a value after permission is granted\",\n parameters: z.object({ value: z.string() }),\n handler: ({ value }) => {\n resumedToolInvoked = true;\n return `PERMISSION_RESUMED_${value.toUpperCase()}`;\n },\n }),\n ],\n });\n\n const permissionResult =\n await session2.rpc.permissions.handlePendingPermissionRequest({\n requestId: permissionEvent.data.requestId,\n result: { kind: \"approve-once\" },\n });\n expect(permissionResult.success).toBe(true);\n\n const answer = await waitWithTimeout(\n getFinalAssistantMessage(session2),\n PENDING_WORK_TIMEOUT_MS,\n \"final assistant message\"\n );\n\n expect(resumedToolInvoked).toBe(true);\n expect(answer.data.content ?? \"\").toContain(\"PERMISSION_RESUMED_ALPHA\");\n\n await session2.disconnect();\n } finally {\n if (!releaseOriginalPermission.settled()) {\n releaseOriginalPermission.resolve({ kind: \"no-result\" });\n }\n }\n }\n );\n\n it(\n \"should continue pending external tool request after resume\",\n { timeout: TEST_TIMEOUT_MS },\n async () => {\n const originalToolStarted = deferred();\n const releaseOriginalTool = deferred();\n\n const server = createTcpServer();\n await server.start();\n const cliUrl = getCliUrl(server);\n\n const suspendedClient = createConnectingClient(cliUrl);\n const session1 = await suspendedClient.createSession({\n tools: [\n defineTool(\"resume_external_tool\", {\n description: \"Looks up a value after resumption\",\n parameters: z.object({ value: z.string() }),\n handler: async ({ value }) => {\n originalToolStarted.resolve(value);\n return await releaseOriginalTool.promise;\n },\n }),\n ],\n onPermissionRequest: approveAll,\n });\n const sessionId = session1.sessionId;\n\n try {\n const toolRequestsP = waitForExternalToolRequests(session1, [\n \"resume_external_tool\",\n ]);\n\n await session1.send({\n prompt: \"Use resume_external_tool with value 'beta', then reply with the result.\",\n });\n\n const toolEvents = await toolRequestsP;\n const toolEvent = toolEvents[\"resume_external_tool\"];\n expect(\n await waitWithTimeout(\n originalToolStarted.promise,\n PENDING_WORK_TIMEOUT_MS,\n \"originalToolStarted\"\n )\n ).toBe(\"beta\");\n\n await suspendedClient.forceStop();\n\n const resumedClient = createConnectingClient(cliUrl);\n const session2 = await resumedClient.resumeSession(sessionId, {\n continuePendingWork: true,\n onPermissionRequest: approveAll,\n });\n\n const toolResult = await session2.rpc.tools.handlePendingToolCall({\n requestId: toolEvent.data.requestId,\n result: \"EXTERNAL_RESUMED_BETA\",\n });\n expect(toolResult.success).toBe(true);\n\n const answer = await waitWithTimeout(\n getFinalAssistantMessage(session2),\n PENDING_WORK_TIMEOUT_MS,\n \"final assistant message\"\n );\n expect(answer.data.content ?? \"\").toContain(\"EXTERNAL_RESUMED_BETA\");\n\n await session2.disconnect();\n } finally {\n if (!releaseOriginalTool.settled()) {\n releaseOriginalTool.resolve(\"ORIGINAL_SHOULD_NOT_WIN\");\n }\n }\n }\n );\n\n it(\n \"should continue parallel pending external tool requests after resume\",\n { timeout: TEST_TIMEOUT_MS },\n async () => {\n const originalToolAStarted = deferred();\n const originalToolBStarted = deferred();\n const releaseOriginalToolA = deferred();\n const releaseOriginalToolB = deferred();\n\n const server = createTcpServer();\n await server.start();\n const cliUrl = getCliUrl(server);\n\n const suspendedClient = createConnectingClient(cliUrl);\n const session1 = await suspendedClient.createSession({\n tools: [\n defineTool(\"pending_lookup_a\", {\n description: \"Looks up the first value after resumption\",\n parameters: z.object({ value: z.string() }),\n handler: async ({ value }) => {\n originalToolAStarted.resolve(value);\n return await releaseOriginalToolA.promise;\n },\n }),\n defineTool(\"pending_lookup_b\", {\n description: \"Looks up the second value after resumption\",\n parameters: z.object({ value: z.string() }),\n handler: async ({ value }) => {\n originalToolBStarted.resolve(value);\n return await releaseOriginalToolB.promise;\n },\n }),\n ],\n onPermissionRequest: approveAll,\n });\n const sessionId = session1.sessionId;\n\n try {\n const toolRequestsP = waitForExternalToolRequests(session1, [\n \"pending_lookup_a\",\n \"pending_lookup_b\",\n ]);\n\n await session1.send({\n prompt: \"Call pending_lookup_a with value 'alpha' and pending_lookup_b with value 'beta', then reply with both results.\",\n });\n\n const toolEvents = await toolRequestsP;\n await waitWithTimeout(\n Promise.all([originalToolAStarted.promise, originalToolBStarted.promise]),\n PENDING_WORK_TIMEOUT_MS,\n \"originalToolAStarted/B\"\n );\n expect(await originalToolAStarted.promise).toBe(\"alpha\");\n expect(await originalToolBStarted.promise).toBe(\"beta\");\n\n await suspendedClient.forceStop();\n\n const resumedClient = createConnectingClient(cliUrl);\n const session2 = await resumedClient.resumeSession(sessionId, {\n continuePendingWork: true,\n onPermissionRequest: approveAll,\n });\n\n const toolA = toolEvents[\"pending_lookup_a\"];\n const toolB = toolEvents[\"pending_lookup_b\"];\n const resultB = await session2.rpc.tools.handlePendingToolCall({\n requestId: toolB.data.requestId,\n result: \"PARALLEL_B_BETA\",\n });\n expect(resultB.success).toBe(true);\n const resultA = await session2.rpc.tools.handlePendingToolCall({\n requestId: toolA.data.requestId,\n result: \"PARALLEL_A_ALPHA\",\n });\n expect(resultA.success).toBe(true);\n\n const answer = await waitWithTimeout(\n getFinalAssistantMessage(session2),\n PENDING_WORK_TIMEOUT_MS,\n \"final assistant message\"\n );\n\n const content = answer.data.content ?? \"\";\n expect(content).toContain(\"PARALLEL_A_ALPHA\");\n expect(content).toContain(\"PARALLEL_B_BETA\");\n\n await session2.disconnect();\n } finally {\n if (!releaseOriginalToolA.settled()) {\n releaseOriginalToolA.resolve(\"ORIGINAL_A_SHOULD_NOT_WIN\");\n }\n if (!releaseOriginalToolB.settled()) {\n releaseOriginalToolB.resolve(\"ORIGINAL_B_SHOULD_NOT_WIN\");\n }\n }\n }\n );\n\n it(\n \"should resume successfully when no pending work exists\",\n { timeout: TEST_TIMEOUT_MS },\n async () => {\n const server = createTcpServer();\n await server.start();\n const cliUrl = getCliUrl(server);\n\n let sessionId: string;\n {\n const firstClient = createConnectingClient(cliUrl);\n const firstSession = await firstClient.createSession({\n onPermissionRequest: approveAll,\n });\n sessionId = firstSession.sessionId;\n\n const firstAnswer = await firstSession.sendAndWait({\n prompt: \"Reply with exactly: NO_PENDING_TURN_ONE\",\n });\n expect(firstAnswer?.data.content ?? \"\").toContain(\"NO_PENDING_TURN_ONE\");\n\n await firstSession.disconnect();\n await firstClient.forceStop();\n }\n\n const resumedClient = createConnectingClient(cliUrl);\n const resumedSession = await resumedClient.resumeSession(sessionId, {\n continuePendingWork: true,\n onPermissionRequest: approveAll,\n });\n\n const followUp = await resumedSession.sendAndWait({\n prompt: \"Reply with exactly: NO_PENDING_TURN_TWO\",\n });\n\n expect(followUp?.data.content ?? \"\").toContain(\"NO_PENDING_TURN_TWO\");\n\n await resumedSession.disconnect();\n }\n );\n});\n" }, { "path": "nodejs/test/e2e/per_session_auth.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { describe, expect, it } from \"vitest\";\nimport { approveAll } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\ndescribe(\"Per-session GitHub auth\", async () => {\n const { copilotClient: client, openAiEndpoint, env } = await createSdkTestContext();\n\n // Redirect GitHub API calls (e.g., fetchCopilotUser) to the proxy\n // so per-session auth token resolution can be tested\n env.COPILOT_DEBUG_GITHUB_API_URL = env.COPILOT_API_URL;\n\n // Configure per-token responses on the proxy.\n // endpoints.api points back to the proxy so subsequent CAPI calls are also intercepted.\n const proxyUrl = env.COPILOT_API_URL;\n await openAiEndpoint.setCopilotUserByToken(\"token-alice\", {\n login: \"alice\",\n copilot_plan: \"individual_pro\",\n endpoints: {\n api: proxyUrl,\n telemetry: \"https://localhost:1/telemetry\",\n },\n analytics_tracking_id: \"alice-tracking-id\",\n });\n\n await openAiEndpoint.setCopilotUserByToken(\"token-bob\", {\n login: \"bob\",\n copilot_plan: \"business\",\n endpoints: {\n api: proxyUrl,\n telemetry: \"https://localhost:1/telemetry\",\n },\n analytics_tracking_id: \"bob-tracking-id\",\n });\n\n it(\"should create session with gitHubToken and check auth status\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n gitHubToken: \"token-alice\",\n });\n\n const authStatus = await session.rpc.auth.getStatus();\n expect(authStatus.isAuthenticated).toBe(true);\n expect(authStatus.login).toBe(\"alice\");\n expect(authStatus.copilotPlan).toBe(\"individual_pro\");\n\n await session.disconnect();\n });\n\n it(\"should isolate auth between sessions with different tokens\", async () => {\n const sessionA = await client.createSession({\n onPermissionRequest: approveAll,\n gitHubToken: \"token-alice\",\n });\n const sessionB = await client.createSession({\n onPermissionRequest: approveAll,\n gitHubToken: \"token-bob\",\n });\n\n const statusA = await sessionA.rpc.auth.getStatus();\n const statusB = await sessionB.rpc.auth.getStatus();\n\n expect(statusA.isAuthenticated).toBe(true);\n expect(statusA.login).toBe(\"alice\");\n expect(statusA.copilotPlan).toBe(\"individual_pro\");\n\n expect(statusB.isAuthenticated).toBe(true);\n expect(statusB.login).toBe(\"bob\");\n expect(statusB.copilotPlan).toBe(\"business\");\n\n await sessionA.disconnect();\n await sessionB.disconnect();\n });\n\n it(\"should return unauthenticated when no token is provided\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n });\n\n const authStatus = await session.rpc.auth.getStatus();\n // Without a per-session GitHub token, there is no per-session identity.\n // In CI the process-level fake token may still authenticate globally,\n // so we check login rather than isAuthenticated.\n expect(authStatus.login).toBeFalsy();\n\n await session.disconnect();\n });\n\n it(\"should error when creating session with invalid token\", async () => {\n await expect(\n client.createSession({\n onPermissionRequest: approveAll,\n gitHubToken: \"invalid-token-12345\",\n })\n ).rejects.toThrow(/401|Unauthorized/i);\n });\n});\n" }, { "path": "nodejs/test/e2e/permissions.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { readFile, writeFile } from \"fs/promises\";\nimport { join } from \"path\";\nimport { describe, expect, it } from \"vitest\";\nimport type { PermissionRequest, PermissionRequestResult } from \"../../src/index.js\";\nimport { approveAll } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\ndescribe(\"Permission callbacks\", async () => {\n const { copilotClient: client, workDir } = await createSdkTestContext();\n\n it(\"should invoke permission handler for write operations\", async () => {\n const permissionRequests: PermissionRequest[] = [];\n\n const session = await client.createSession({\n onPermissionRequest: (request, invocation) => {\n permissionRequests.push(request);\n expect(invocation.sessionId).toBe(session.sessionId);\n\n // Approve the permission\n const result: PermissionRequestResult = { kind: \"approve-once\" };\n return result;\n },\n });\n\n await writeFile(join(workDir, \"test.txt\"), \"original content\");\n\n await session.sendAndWait({\n prompt: \"Edit test.txt and replace 'original' with 'modified'\",\n });\n\n // Should have received at least one permission request\n expect(permissionRequests.length).toBeGreaterThan(0);\n\n // Should include write permission request\n const writeRequests = permissionRequests.filter((req) => req.kind === \"write\");\n expect(writeRequests.length).toBeGreaterThan(0);\n\n await session.disconnect();\n });\n\n it(\"should deny permission when handler returns denied\", async () => {\n const session = await client.createSession({\n onPermissionRequest: () => {\n return { kind: \"reject\" };\n },\n });\n\n const originalContent = \"protected content\";\n const testFile = join(workDir, \"protected.txt\");\n await writeFile(testFile, originalContent);\n\n await session.sendAndWait({\n prompt: \"Edit protected.txt and replace 'protected' with 'hacked'.\",\n });\n\n // Verify the file was NOT modified\n const content = await readFile(testFile, \"utf-8\");\n expect(content).toBe(originalContent);\n\n await session.disconnect();\n });\n\n it(\"should deny tool operations when handler explicitly denies\", async () => {\n let permissionDenied = false;\n\n const session = await client.createSession({\n onPermissionRequest: () => ({\n kind: \"user-not-available\",\n }),\n });\n session.on((event) => {\n if (\n event.type === \"tool.execution_complete\" &&\n !event.data.success &&\n event.data.error?.message.includes(\"Permission denied\")\n ) {\n permissionDenied = true;\n }\n });\n\n await session.sendAndWait({ prompt: \"Run 'node --version'\" });\n\n expect(permissionDenied).toBe(true);\n\n await session.disconnect();\n });\n\n it(\"should deny tool operations when handler explicitly denies after resume\", async () => {\n const session1 = await client.createSession({ onPermissionRequest: approveAll });\n const sessionId = session1.sessionId;\n await session1.sendAndWait({ prompt: \"What is 1+1?\" });\n\n const session2 = await client.resumeSession(sessionId, {\n onPermissionRequest: () => ({\n kind: \"user-not-available\",\n }),\n });\n let permissionDenied = false;\n session2.on((event) => {\n if (\n event.type === \"tool.execution_complete\" &&\n !event.data.success &&\n event.data.error?.message.includes(\"Permission denied\")\n ) {\n permissionDenied = true;\n }\n });\n\n await session2.sendAndWait({ prompt: \"Run 'node --version'\" });\n\n expect(permissionDenied).toBe(true);\n\n await session2.disconnect();\n });\n\n it(\"should work with approve-all permission handler\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n const message = await session.sendAndWait({\n prompt: \"What is 2+2?\",\n });\n expect(message?.data.content).toContain(\"4\");\n\n await session.disconnect();\n });\n\n it(\"should handle async permission handler\", async () => {\n const permissionRequests: PermissionRequest[] = [];\n\n const session = await client.createSession({\n onPermissionRequest: async (request, _invocation) => {\n permissionRequests.push(request);\n\n // Simulate async permission check (e.g., user prompt)\n await new Promise((resolve) => setTimeout(resolve, 10));\n\n return { kind: \"approve-once\" };\n },\n });\n\n await session.sendAndWait({\n prompt: \"Run 'echo test' and tell me what happens\",\n });\n\n expect(permissionRequests.length).toBeGreaterThan(0);\n\n await session.disconnect();\n });\n\n it(\"should resume session with permission handler\", async () => {\n const permissionRequests: PermissionRequest[] = [];\n\n // Create initial session\n const session1 = await client.createSession({ onPermissionRequest: approveAll });\n const sessionId = session1.sessionId;\n await session1.sendAndWait({ prompt: \"What is 1+1?\" });\n\n // Resume with permission handler\n const session2 = await client.resumeSession(sessionId, {\n onPermissionRequest: (request) => {\n permissionRequests.push(request);\n return { kind: \"approve-once\" };\n },\n });\n\n await session2.sendAndWait({\n prompt: \"Run 'echo resumed' for me\",\n });\n\n // Should have permission requests from resumed session\n expect(permissionRequests.length).toBeGreaterThan(0);\n\n await session2.disconnect();\n });\n\n it(\"should handle permission handler errors gracefully\", async () => {\n const session = await client.createSession({\n onPermissionRequest: () => {\n throw new Error(\"Handler error\");\n },\n });\n\n const message = await session.sendAndWait({\n prompt: \"Run 'echo test'. If you can't, say 'failed'.\",\n });\n\n // Should handle the error and deny permission\n expect(message?.data.content?.toLowerCase()).toMatch(/fail|cannot|unable|permission/);\n\n await session.disconnect();\n });\n\n it(\"should receive toolCallId in permission requests\", async () => {\n let receivedToolCallId = false;\n\n const session = await client.createSession({\n onPermissionRequest: (request) => {\n if (request.toolCallId) {\n receivedToolCallId = true;\n expect(typeof request.toolCallId).toBe(\"string\");\n expect(request.toolCallId.length).toBeGreaterThan(0);\n }\n return { kind: \"approve-once\" };\n },\n });\n\n await session.sendAndWait({\n prompt: \"Run 'echo test'\",\n });\n\n expect(receivedToolCallId).toBe(true);\n\n await session.disconnect();\n });\n});\n" }, { "path": "nodejs/test/e2e/rpc.e2e.test.ts", "content": "import { describe, expect, it, onTestFinished } from \"vitest\";\nimport { CopilotClient, approveAll } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\nfunction onTestFinishedForceStop(client: CopilotClient) {\n onTestFinished(async () => {\n try {\n await client.forceStop();\n } catch {\n // Ignore cleanup errors - process may already be stopped\n }\n });\n}\n\ndescribe(\"RPC\", () => {\n it(\"should call rpc.ping with typed params and result\", async () => {\n const client = new CopilotClient({ useStdio: true });\n onTestFinishedForceStop(client);\n\n await client.start();\n\n const result = await client.rpc.ping({ message: \"typed rpc test\" });\n expect(result.message).toBe(\"pong: typed rpc test\");\n expect(typeof result.timestamp).toBe(\"number\");\n\n await client.stop();\n });\n\n it(\"should call rpc.models.list with typed result\", async () => {\n const client = new CopilotClient({ useStdio: true });\n onTestFinishedForceStop(client);\n\n await client.start();\n\n const authStatus = await client.getAuthStatus();\n if (!authStatus.isAuthenticated) {\n await client.stop();\n return;\n }\n\n const result = await client.rpc.models.list();\n expect(result.models).toBeDefined();\n expect(Array.isArray(result.models)).toBe(true);\n\n await client.stop();\n });\n\n // account.getQuota is defined in schema but not yet implemented in CLI\n it.skip(\"should call rpc.account.getQuota when authenticated\", async () => {\n const client = new CopilotClient({ useStdio: true });\n onTestFinishedForceStop(client);\n\n await client.start();\n\n const authStatus = await client.getAuthStatus();\n if (!authStatus.isAuthenticated) {\n await client.stop();\n return;\n }\n\n const result = await client.rpc.account.getQuota();\n expect(result.quotaSnapshots).toBeDefined();\n expect(typeof result.quotaSnapshots).toBe(\"object\");\n\n await client.stop();\n });\n});\n\ndescribe(\"Session RPC\", async () => {\n const { copilotClient: client } = await createSdkTestContext();\n\n // session.model.getCurrent is defined in schema but not yet implemented in CLI\n it.skip(\"should call session.rpc.model.getCurrent\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n model: \"claude-sonnet-4.5\",\n });\n\n const result = await session.rpc.model.getCurrent();\n expect(result.modelId).toBeDefined();\n expect(typeof result.modelId).toBe(\"string\");\n });\n\n // session.model.switchTo is defined in schema but not yet implemented in CLI\n it.skip(\"should call session.rpc.model.switchTo\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n model: \"claude-sonnet-4.5\",\n });\n\n // Get initial model\n const before = await session.rpc.model.getCurrent();\n expect(before.modelId).toBeDefined();\n\n // Switch to a different model with reasoning effort\n const result = await session.rpc.model.switchTo({\n modelId: \"gpt-4.1\",\n reasoningEffort: \"high\",\n });\n expect(result.modelId).toBe(\"gpt-4.1\");\n\n // Verify the switch persisted\n const after = await session.rpc.model.getCurrent();\n expect(after.modelId).toBe(\"gpt-4.1\");\n });\n\n it(\"should get and set session mode\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n // Get initial mode (default should be interactive)\n const initial = await session.rpc.mode.get();\n expect(initial).toBe(\"interactive\");\n\n // Switch to plan mode\n await session.rpc.mode.set({ mode: \"plan\" });\n\n // Verify mode persisted\n const afterPlan = await session.rpc.mode.get();\n expect(afterPlan).toBe(\"plan\");\n\n // Switch back to interactive\n await session.rpc.mode.set({ mode: \"interactive\" });\n\n // Verify switch back\n const afterInteractive = await session.rpc.mode.get();\n expect(afterInteractive).toBe(\"interactive\");\n });\n\n it(\"should read, update, and delete plan\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n // Initially plan should not exist\n const initial = await session.rpc.plan.read();\n expect(initial.exists).toBe(false);\n expect(initial.content).toBeNull();\n\n // Create/update plan\n const planContent = \"# Test Plan\\n\\n- Step 1\\n- Step 2\";\n await session.rpc.plan.update({ content: planContent });\n\n // Verify plan exists and has correct content\n const afterUpdate = await session.rpc.plan.read();\n expect(afterUpdate.exists).toBe(true);\n expect(afterUpdate.content).toBe(planContent);\n\n // Delete plan\n await session.rpc.plan.delete();\n\n // Verify plan is deleted\n const afterDelete = await session.rpc.plan.read();\n expect(afterDelete.exists).toBe(false);\n expect(afterDelete.content).toBeNull();\n });\n\n it(\"should create, list, and read workspace files\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n // Initially no files\n const initialFiles = await session.rpc.workspaces.listFiles();\n expect(initialFiles.files).toEqual([]);\n\n // Create a file\n const fileContent = \"Hello, workspace!\";\n await session.rpc.workspaces.createFile({ path: \"test.txt\", content: fileContent });\n\n // List files\n const afterCreate = await session.rpc.workspaces.listFiles();\n expect(afterCreate.files).toContain(\"test.txt\");\n\n // Read file\n const readResult = await session.rpc.workspaces.readFile({ path: \"test.txt\" });\n expect(readResult.content).toBe(fileContent);\n\n // Create nested file\n await session.rpc.workspaces.createFile({\n path: \"subdir/nested.txt\",\n content: \"Nested content\",\n });\n\n const afterNested = await session.rpc.workspaces.listFiles();\n expect(afterNested.files).toContain(\"test.txt\");\n expect(afterNested.files.some((f) => f.includes(\"nested.txt\"))).toBe(true);\n });\n});\n" }, { "path": "nodejs/test/e2e/rpc_mcp_and_skills.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport * as fs from \"fs\";\nimport * as path from \"path\";\nimport { describe, expect, it } from \"vitest\";\nimport { approveAll } from \"../../src/index.js\";\nimport type { MCPServerConfig } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\ndescribe(\"Session MCP and skills RPC\", async () => {\n const { copilotClient: client, workDir } = await createSdkTestContext();\n\n function createSkill(skillsDir: string, skillName: string, description: string): void {\n const skillSubdir = path.join(skillsDir, skillName);\n fs.mkdirSync(skillSubdir, { recursive: true });\n const skillContent = `---\\nname: ${skillName}\\ndescription: ${description}\\n---\\n\\n# ${skillName}\\n\\nThis skill is used by RPC E2E tests.\\n`;\n fs.writeFileSync(path.join(skillSubdir, \"SKILL.md\"), skillContent);\n }\n\n function createSkillDirectory(skillName: string, description: string): string {\n const skillsDir = path.join(\n workDir,\n \"session-rpc-skills\",\n `dir-${Date.now()}-${Math.random().toString(36).slice(2)}`\n );\n fs.mkdirSync(skillsDir, { recursive: true });\n createSkill(skillsDir, skillName, description);\n return skillsDir;\n }\n\n async function expectFailure(\n action: () => Promise,\n expectedMessage: string\n ): Promise {\n await expect(action()).rejects.toSatisfy((err: unknown) => {\n const text = err instanceof Error ? err.message : String(err);\n expect(text.toLowerCase()).toContain(expectedMessage.toLowerCase());\n return true;\n });\n }\n\n it(\"should list and toggle session skills\", async () => {\n const skillName = `session-rpc-skill-${Date.now()}-${Math.random().toString(36).slice(2)}`;\n const skillsDir = createSkillDirectory(skillName, \"Session skill controlled by RPC.\");\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n skillDirectories: [skillsDir],\n disabledSkills: [skillName],\n });\n\n const disabled = await session.rpc.skills.list();\n const disabledSkill = disabled.skills.find((s) => s.name === skillName);\n expect(disabledSkill).toBeDefined();\n expect(disabledSkill!.enabled).toBe(false);\n expect(disabledSkill!.path.endsWith(path.join(skillName, \"SKILL.md\"))).toBe(true);\n\n await session.rpc.skills.enable({ name: skillName });\n const enabled = await session.rpc.skills.list();\n const enabledSkill = enabled.skills.find((s) => s.name === skillName);\n expect(enabledSkill).toBeDefined();\n expect(enabledSkill!.enabled).toBe(true);\n\n await session.rpc.skills.disable({ name: skillName });\n const disabledAgain = await session.rpc.skills.list();\n const disabledSkillAgain = disabledAgain.skills.find((s) => s.name === skillName);\n expect(disabledSkillAgain).toBeDefined();\n expect(disabledSkillAgain!.enabled).toBe(false);\n\n await session.disconnect();\n });\n\n it(\"should reload session skills\", async () => {\n const skillsDir = path.join(\n workDir,\n \"reloadable-rpc-skills\",\n `dir-${Date.now()}-${Math.random().toString(36).slice(2)}`\n );\n fs.mkdirSync(skillsDir, { recursive: true });\n const skillName = `reload-rpc-skill-${Date.now()}-${Math.random().toString(36).slice(2)}`;\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n skillDirectories: [skillsDir],\n });\n\n const before = await session.rpc.skills.list();\n expect(before.skills.find((s) => s.name === skillName)).toBeUndefined();\n\n createSkill(skillsDir, skillName, \"Skill added after session creation.\");\n await session.rpc.skills.reload();\n\n const after = await session.rpc.skills.list();\n const reloadedSkill = after.skills.find((s) => s.name === skillName);\n expect(reloadedSkill).toBeDefined();\n expect(reloadedSkill!.enabled).toBe(true);\n expect(reloadedSkill!.description).toBe(\"Skill added after session creation.\");\n\n await session.disconnect();\n });\n\n it(\"should list mcp servers with configured server\", async () => {\n const serverName = \"rpc-list-mcp-server\";\n const mcpServers: Record = {\n [serverName]: {\n type: \"stdio\",\n command: \"echo\",\n args: [\"rpc-list-mcp-server\"],\n tools: [\"*\"],\n },\n };\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n mcpServers,\n });\n\n const result = await session.rpc.mcp.list();\n const server = result.servers.find((s) => s.name === serverName);\n expect(server).toBeDefined();\n expect(typeof server!.status).toBe(\"string\");\n\n await session.disconnect();\n });\n\n it(\"should list plugins\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n const result = await session.rpc.plugins.list();\n expect(Array.isArray(result.plugins)).toBe(true);\n for (const plugin of result.plugins) {\n expect(plugin.name).toBeTruthy();\n }\n\n await session.disconnect();\n });\n\n it(\"should list extensions\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n const result = await session.rpc.extensions.list();\n expect(Array.isArray(result.extensions)).toBe(true);\n for (const extension of result.extensions) {\n expect(extension.id).toBeTruthy();\n expect(extension.name).toBeTruthy();\n }\n\n await session.disconnect();\n });\n\n it(\"should report error when mcp host is not initialized\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await expectFailure(\n () => session.rpc.mcp.enable({ serverName: \"missing-server\" }),\n \"No MCP host initialized\"\n );\n await expectFailure(\n () => session.rpc.mcp.disable({ serverName: \"missing-server\" }),\n \"No MCP host initialized\"\n );\n await expectFailure(() => session.rpc.mcp.reload(), \"MCP config reload not available\");\n\n await session.disconnect();\n });\n\n it(\"should report error when extensions are not available\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await expectFailure(\n () => session.rpc.extensions.enable({ id: \"missing-extension\" }),\n \"Extensions not available\"\n );\n await expectFailure(\n () => session.rpc.extensions.disable({ id: \"missing-extension\" }),\n \"Extensions not available\"\n );\n await expectFailure(() => session.rpc.extensions.reload(), \"Extensions not available\");\n\n await session.disconnect();\n });\n});\n" }, { "path": "nodejs/test/e2e/rpc_mcp_config.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { describe, expect, it, onTestFinished } from \"vitest\";\nimport { CopilotClient } from \"../../src/index.js\";\n\nfunction startEphemeralClient(): CopilotClient {\n const client = new CopilotClient({ useStdio: true });\n onTestFinished(async () => {\n try {\n await client.forceStop();\n } catch {\n // Ignore cleanup errors\n }\n });\n return client;\n}\n\nfunction uniqueName(prefix: string): string {\n return `${prefix}-${Date.now()}-${Math.random().toString(36).slice(2)}`;\n}\n\ntype ServerEntry = Record;\n\nfunction getServerConfig(list: { servers: Record }, name: string): ServerEntry {\n expect(list.servers).toHaveProperty(name);\n const entry = list.servers[name] as ServerEntry;\n expect(entry).toBeDefined();\n return entry;\n}\n\ndescribe(\"Server-scoped MCP config RPC\", () => {\n it(\"should call server mcp config rpcs\", async () => {\n const client = startEphemeralClient();\n await client.start();\n\n const serverName = uniqueName(\"sdk-test\");\n const config = {\n type: \"local\" as const,\n command: \"node\",\n args: [] as string[],\n };\n const updatedConfig = {\n type: \"local\" as const,\n command: \"node\",\n args: [\"--version\"],\n };\n\n const initial = await client.rpc.mcp.config.list();\n expect(initial.servers[serverName]).toBeUndefined();\n\n try {\n await client.rpc.mcp.config.add({ name: serverName, config });\n const afterAdd = await client.rpc.mcp.config.list();\n expect(afterAdd.servers[serverName]).toBeDefined();\n\n await client.rpc.mcp.config.update({ name: serverName, config: updatedConfig });\n const afterUpdate = await client.rpc.mcp.config.list();\n const updated = getServerConfig(afterUpdate, serverName) as {\n command?: string;\n args?: string[];\n };\n expect(updated.command).toBe(\"node\");\n expect(updated.args?.[0]).toBe(\"--version\");\n\n await client.rpc.mcp.config.disable({ names: [serverName] });\n await client.rpc.mcp.config.enable({ names: [serverName] });\n } finally {\n await client.rpc.mcp.config.remove({ name: serverName });\n }\n\n const afterRemove = await client.rpc.mcp.config.list();\n expect(afterRemove.servers[serverName]).toBeUndefined();\n\n await client.stop();\n });\n\n it(\"should roundtrip http mcp oauth config rpc\", async () => {\n const client = startEphemeralClient();\n await client.start();\n\n const serverName = uniqueName(\"sdk-http-oauth\");\n const config = {\n type: \"http\" as const,\n url: \"https://example.com/mcp\",\n headers: { Authorization: \"Bearer token\" } as Record,\n oauthClientId: \"client-id\",\n oauthPublicClient: false,\n oauthGrantType: \"client_credentials\" as const,\n tools: [\"*\"],\n timeout: 3000,\n };\n const updatedConfig = {\n type: \"http\" as const,\n url: \"https://example.com/updated-mcp\",\n oauthClientId: \"updated-client-id\",\n oauthPublicClient: true,\n oauthGrantType: \"authorization_code\" as const,\n tools: [\"updated-tool\"],\n timeout: 4000,\n };\n\n try {\n await client.rpc.mcp.config.add({ name: serverName, config });\n const afterAdd = await client.rpc.mcp.config.list();\n const added = getServerConfig(afterAdd, serverName) as Record & {\n headers?: Record;\n };\n expect(added.type).toBe(\"http\");\n expect(added.url).toBe(\"https://example.com/mcp\");\n expect(added.headers?.Authorization).toBe(\"Bearer token\");\n expect(added.oauthClientId).toBe(\"client-id\");\n expect(added.oauthPublicClient).toBe(false);\n expect(added.oauthGrantType).toBe(\"client_credentials\");\n\n await client.rpc.mcp.config.update({ name: serverName, config: updatedConfig });\n const afterUpdate = await client.rpc.mcp.config.list();\n const updated = getServerConfig(afterUpdate, serverName) as Record & {\n tools?: string[];\n };\n expect(updated.url).toBe(\"https://example.com/updated-mcp\");\n expect(updated.oauthClientId).toBe(\"updated-client-id\");\n expect(updated.oauthPublicClient).toBe(true);\n expect(updated.oauthGrantType).toBe(\"authorization_code\");\n expect(updated.tools?.[0]).toBe(\"updated-tool\");\n expect(updated.timeout).toBe(4000);\n } finally {\n await client.rpc.mcp.config.remove({ name: serverName });\n }\n\n const afterRemove = await client.rpc.mcp.config.list();\n expect(afterRemove.servers[serverName]).toBeUndefined();\n\n await client.stop();\n });\n});\n" }, { "path": "nodejs/test/e2e/rpc_server.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport * as fs from \"fs\";\nimport * as path from \"path\";\nimport { describe, expect, it, onTestFinished } from \"vitest\";\nimport { CopilotClient } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\ndescribe(\"Server-scoped RPC\", async () => {\n const { copilotClient: client, openAiEndpoint, env, workDir } = await createSdkTestContext();\n\n function createAuthenticatedClient(token: string): CopilotClient {\n const childEnv = {\n ...env,\n COPILOT_DEBUG_GITHUB_API_URL: env.COPILOT_API_URL,\n };\n const authClient = new CopilotClient({\n cwd: workDir,\n env: childEnv,\n logLevel: \"error\",\n cliPath: process.env.COPILOT_CLI_PATH,\n gitHubToken: token,\n });\n onTestFinished(async () => {\n try {\n await authClient.forceStop();\n } catch {\n // Ignore cleanup errors\n }\n });\n return authClient;\n }\n\n async function configureAuthenticatedUser(\n token: string,\n quotaSnapshots?: Record<\n string,\n {\n entitlement?: number;\n overage_count?: number;\n overage_permitted?: boolean;\n percent_remaining?: number;\n timestamp_utc?: string;\n unlimited?: boolean;\n }\n >\n ): Promise {\n await openAiEndpoint.setCopilotUserByToken(token, {\n login: \"rpc-user\",\n copilot_plan: \"individual_pro\",\n endpoints: {\n api: env.COPILOT_API_URL,\n telemetry: \"https://localhost:1/telemetry\",\n },\n analytics_tracking_id: \"rpc-user-tracking-id\",\n quota_snapshots: quotaSnapshots,\n });\n }\n\n function createSkillDirectory(skillName: string, description: string): string {\n const skillsDir = path.join(\n workDir,\n \"server-rpc-skills\",\n `dir-${Date.now()}-${Math.random().toString(36).slice(2)}`\n );\n const skillSubdir = path.join(skillsDir, skillName);\n fs.mkdirSync(skillSubdir, { recursive: true });\n const skillContent = `---\\nname: ${skillName}\\ndescription: ${description}\\n---\\n\\n# ${skillName}\\n\\nThis skill is used by RPC E2E tests.\\n`;\n fs.writeFileSync(path.join(skillSubdir, \"SKILL.md\"), skillContent);\n return skillsDir;\n }\n\n it(\"should call rpc ping with typed params and result\", async () => {\n await client.start();\n const result = await client.ping(\"typed rpc test\");\n expect(result.message).toBe(\"pong: typed rpc test\");\n expect(result.timestamp).toBeGreaterThanOrEqual(0);\n });\n\n it(\"should call rpc models list with typed result\", async () => {\n const token = \"rpc-models-token\";\n await configureAuthenticatedUser(token);\n const authClient = createAuthenticatedClient(token);\n await authClient.start();\n\n const result = await authClient.listModels();\n expect(Array.isArray(result)).toBe(true);\n expect(result.some((m) => m.id === \"claude-sonnet-4.5\")).toBe(true);\n for (const model of result) {\n expect(model.name).toBeTruthy();\n }\n });\n\n it(\"should call rpc account getquota when authenticated\", async () => {\n const token = \"rpc-quota-token\";\n await configureAuthenticatedUser(token, {\n chat: {\n entitlement: 100,\n overage_count: 2,\n overage_permitted: true,\n percent_remaining: 75,\n timestamp_utc: \"2026-04-30T00:00:00Z\",\n },\n });\n const authClient = createAuthenticatedClient(token);\n await authClient.start();\n\n const result = await authClient.rpc.account.getQuota({ gitHubToken: token });\n\n expect(result.quotaSnapshots).toHaveProperty(\"chat\");\n const chatQuota = result.quotaSnapshots.chat;\n expect(chatQuota.entitlementRequests).toBe(100);\n expect(chatQuota.usedRequests).toBe(25);\n expect(chatQuota.remainingPercentage).toBe(75);\n expect(chatQuota.overage).toBe(2);\n expect(chatQuota.usageAllowedWithExhaustedQuota).toBe(true);\n expect(chatQuota.overageAllowedWithExhaustedQuota).toBe(true);\n expect(chatQuota.resetDate).toBe(\"2026-04-30T00:00:00Z\");\n });\n\n it(\"should call rpc tools list with typed result\", async () => {\n await client.start();\n const result = await client.rpc.tools.list();\n expect(result.tools).toBeDefined();\n expect(result.tools.length).toBeGreaterThan(0);\n for (const tool of result.tools) {\n expect(tool.name).toBeTruthy();\n }\n });\n\n it(\"should discover server mcp and skills\", async () => {\n await client.start();\n\n const skillName = `server-rpc-skill-${Date.now()}-${Math.random().toString(36).slice(2)}`;\n const skillDirectory = createSkillDirectory(\n skillName,\n \"Skill discovered by server-scoped RPC tests.\"\n );\n\n const mcp = await client.rpc.mcp.discover({ workingDirectory: workDir });\n expect(mcp.servers).toBeDefined();\n\n const skills = await client.rpc.skills.discover({ skillDirectories: [skillDirectory] });\n const discovered = skills.skills.filter((s) => s.name === skillName);\n expect(discovered).toHaveLength(1);\n expect(discovered[0].description).toBe(\"Skill discovered by server-scoped RPC tests.\");\n expect(discovered[0].enabled).toBe(true);\n expect(discovered[0].path.endsWith(path.join(skillName, \"SKILL.md\"))).toBe(true);\n\n try {\n await client.rpc.skills.config.setDisabledSkills({ disabledSkills: [skillName] });\n const disabled = await client.rpc.skills.discover({\n skillDirectories: [skillDirectory],\n });\n const disabledMatches = disabled.skills.filter((s) => s.name === skillName);\n expect(disabledMatches).toHaveLength(1);\n expect(disabledMatches[0].enabled).toBe(false);\n } finally {\n await client.rpc.skills.config.setDisabledSkills({ disabledSkills: [] });\n }\n });\n});\n" }, { "path": "nodejs/test/e2e/rpc_session_state.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { describe, expect, it } from \"vitest\";\nimport { approveAll } from \"../../src/index.js\";\nimport type { SessionEvent } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\ndescribe(\"Session-scoped RPC\", async () => {\n const { copilotClient: client } = await createSdkTestContext();\n\n async function assertImplementedFailure(\n action: () => Promise,\n method: string\n ): Promise {\n await expect(action()).rejects.toSatisfy((err: unknown) => {\n const text = err instanceof Error ? `${err.message}\\n${err.stack ?? \"\"}` : String(err);\n expect(text.toLowerCase()).not.toContain(`unhandled method ${method.toLowerCase()}`);\n return true;\n });\n }\n\n function getConversationMessages(events: SessionEvent[]): { role: string; content: string }[] {\n const messages: { role: string; content: string }[] = [];\n for (const evt of events) {\n if (evt.type === \"user.message\") {\n messages.push({ role: \"user\", content: evt.data.content });\n } else if (evt.type === \"assistant.message\") {\n messages.push({ role: \"assistant\", content: evt.data.content });\n }\n }\n return messages;\n }\n\n it(\"should call session rpc model getcurrent\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n model: \"claude-sonnet-4.5\",\n });\n\n const result = await session.rpc.model.getCurrent();\n expect(result.modelId).toBeTruthy();\n\n await session.disconnect();\n });\n\n it(\"should call session rpc model switchto\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n model: \"claude-sonnet-4.5\",\n });\n\n const before = await session.rpc.model.getCurrent();\n expect(before.modelId).toBeTruthy();\n\n const result = await session.rpc.model.switchTo({\n modelId: \"gpt-4.1\",\n reasoningEffort: \"high\",\n });\n const after = await session.rpc.model.getCurrent();\n\n expect(result.modelId).toBe(\"gpt-4.1\");\n expect(after.modelId).toBe(before.modelId);\n\n await session.disconnect();\n });\n\n it(\"should get and set session mode\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n const initial = await session.rpc.mode.get();\n expect(initial).toBe(\"interactive\");\n\n await session.rpc.mode.set({ mode: \"plan\" });\n expect(await session.rpc.mode.get()).toBe(\"plan\");\n\n await session.rpc.mode.set({ mode: \"interactive\" });\n expect(await session.rpc.mode.get()).toBe(\"interactive\");\n\n await session.disconnect();\n });\n\n it(\"should read update and delete plan\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n const initial = await session.rpc.plan.read();\n expect(initial.exists).toBe(false);\n expect(initial.content).toBeFalsy();\n\n const planContent = \"# Test Plan\\n\\n- Step 1\\n- Step 2\";\n await session.rpc.plan.update({ content: planContent });\n\n const afterUpdate = await session.rpc.plan.read();\n expect(afterUpdate.exists).toBe(true);\n expect(afterUpdate.content).toBe(planContent);\n\n await session.rpc.plan.delete();\n\n const afterDelete = await session.rpc.plan.read();\n expect(afterDelete.exists).toBe(false);\n expect(afterDelete.content).toBeFalsy();\n\n await session.disconnect();\n });\n\n it(\"should call workspace file rpc methods\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n const initial = await session.rpc.workspaces.listFiles();\n expect(initial.files).toBeDefined();\n\n await session.rpc.workspaces.createFile({\n path: \"test.txt\",\n content: \"Hello, workspace!\",\n });\n\n const afterCreate = await session.rpc.workspaces.listFiles();\n expect(afterCreate.files).toContain(\"test.txt\");\n\n const file = await session.rpc.workspaces.readFile({ path: \"test.txt\" });\n expect(file.content).toBe(\"Hello, workspace!\");\n\n const workspace = await session.rpc.workspaces.getWorkspace();\n expect(workspace.workspace).toBeDefined();\n expect(workspace.workspace.id).toBeTruthy();\n\n await session.disconnect();\n });\n\n it(\"should get and set session metadata\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await session.rpc.name.set({ name: \"SDK test session\" });\n const name = await session.rpc.name.get();\n expect(name.name).toBe(\"SDK test session\");\n\n const sources = await session.rpc.instructions.getSources();\n expect(sources.sources).toBeDefined();\n\n await session.disconnect();\n });\n\n it(\"should fork session with persisted messages\", async () => {\n const sourcePrompt = \"Say FORK_SOURCE_ALPHA exactly.\";\n const forkPrompt = \"Now say FORK_CHILD_BETA exactly.\";\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n const initialAnswer = await session.sendAndWait({ prompt: sourcePrompt });\n expect(initialAnswer?.data.content ?? \"\").toContain(\"FORK_SOURCE_ALPHA\");\n\n const sourceConversation = getConversationMessages(await session.getMessages());\n expect(\n sourceConversation.some((m) => m.role === \"user\" && m.content === sourcePrompt)\n ).toBe(true);\n expect(\n sourceConversation.some(\n (m) => m.role === \"assistant\" && m.content.includes(\"FORK_SOURCE_ALPHA\")\n )\n ).toBe(true);\n\n const fork = await client.rpc.sessions.fork({ sessionId: session.sessionId });\n expect(fork.sessionId).toBeTruthy();\n expect(fork.sessionId).not.toBe(session.sessionId);\n\n const forkedSession = await client.resumeSession(fork.sessionId, {\n onPermissionRequest: approveAll,\n });\n const forkedConversation = getConversationMessages(await forkedSession.getMessages());\n expect(forkedConversation.slice(0, sourceConversation.length)).toEqual(sourceConversation);\n\n const forkAnswer = await forkedSession.sendAndWait({ prompt: forkPrompt });\n expect(forkAnswer?.data.content ?? \"\").toContain(\"FORK_CHILD_BETA\");\n\n const sourceAfterFork = getConversationMessages(await session.getMessages());\n expect(sourceAfterFork.some((m) => m.content === forkPrompt)).toBe(false);\n\n const forkAfterPrompt = getConversationMessages(await forkedSession.getMessages());\n expect(forkAfterPrompt.some((m) => m.role === \"user\" && m.content === forkPrompt)).toBe(\n true\n );\n expect(\n forkAfterPrompt.some(\n (m) => m.role === \"assistant\" && m.content.includes(\"FORK_CHILD_BETA\")\n )\n ).toBe(true);\n\n await forkedSession.disconnect();\n await session.disconnect();\n });\n\n it(\"should report error when forking session without persisted events\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await expect(client.rpc.sessions.fork({ sessionId: session.sessionId })).rejects.toSatisfy(\n (err: unknown) => {\n const text =\n err instanceof Error ? `${err.message}\\n${err.stack ?? \"\"}` : String(err);\n expect(text.toLowerCase()).toContain(\"not found or has no persisted events\");\n expect(text.toLowerCase()).not.toContain(\"unhandled method sessions.fork\");\n return true;\n }\n );\n\n await session.disconnect();\n });\n\n it(\"should call session usage and permission rpcs\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n const metrics = await session.rpc.usage.getMetrics();\n expect(metrics.sessionStartTime).toBeGreaterThan(0);\n if (metrics.totalNanoAiu !== undefined && metrics.totalNanoAiu !== null) {\n expect(metrics.totalNanoAiu).toBeGreaterThanOrEqual(0);\n }\n if (metrics.tokenDetails) {\n for (const detail of Object.values(metrics.tokenDetails)) {\n expect(detail.tokenCount).toBeGreaterThanOrEqual(0);\n }\n }\n for (const modelMetric of Object.values(metrics.modelMetrics)) {\n if (modelMetric.totalNanoAiu !== undefined && modelMetric.totalNanoAiu !== null) {\n expect(modelMetric.totalNanoAiu).toBeGreaterThanOrEqual(0);\n }\n if (modelMetric.tokenDetails) {\n for (const detail of Object.values(modelMetric.tokenDetails)) {\n expect(detail.tokenCount).toBeGreaterThanOrEqual(0);\n }\n }\n }\n\n try {\n const approve = await session.rpc.permissions.setApproveAll({ enabled: true });\n expect(approve.success).toBe(true);\n\n const reset = await session.rpc.permissions.resetSessionApprovals();\n expect(reset.success).toBe(true);\n } finally {\n await session.rpc.permissions.setApproveAll({ enabled: false });\n }\n\n await session.disconnect();\n });\n\n it(\"should report implemented errors for unsupported session rpc paths\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await assertImplementedFailure(\n () => session.rpc.history.truncate({ eventId: \"missing-event\" }),\n \"session.history.truncate\"\n );\n\n await assertImplementedFailure(\n () => session.rpc.mcp.oauth.login({ serverName: \"missing-server\" }),\n \"session.mcp.oauth.login\"\n );\n\n await session.disconnect();\n });\n\n it(\"should compact session history after messages\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await session.sendAndWait({ prompt: \"What is 2+2?\" });\n\n const result = await session.rpc.history.compact();\n expect(result).toBeDefined();\n\n await session.disconnect();\n });\n});\n" }, { "path": "nodejs/test/e2e/rpc_shell_and_fleet.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport * as fs from \"fs\";\nimport * as os from \"os\";\nimport * as path from \"path\";\nimport { describe, expect, it } from \"vitest\";\nimport { z } from \"zod\";\nimport { approveAll, defineTool } from \"../../src/index.js\";\nimport type { CopilotSession, SessionEvent } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\ndescribe(\"Shell and fleet RPC\", async () => {\n const { copilotClient: client, workDir } = await createSdkTestContext();\n\n function createWriteFileCommand(markerPath: string, marker: string): string {\n if (os.platform() === \"win32\") {\n return `powershell -NoLogo -NoProfile -Command \"Set-Content -LiteralPath '${markerPath}' -Value '${marker}'\"`;\n }\n return `sh -c \"printf '%s' '${marker}' > '${markerPath}'\"`;\n }\n\n async function waitForFileText(\n filePath: string,\n expected: string,\n timeoutMs = 30_000\n ): Promise {\n const deadline = Date.now() + timeoutMs;\n while (Date.now() < deadline) {\n if (fs.existsSync(filePath)) {\n const content = fs.readFileSync(filePath, \"utf8\");\n if (content.includes(expected)) {\n return;\n }\n }\n await new Promise((resolve) => setTimeout(resolve, 100));\n }\n throw new Error(\n `Timed out waiting for shell command to write '${expected}' to '${filePath}'.`\n );\n }\n\n async function waitForMessages(\n session: CopilotSession,\n predicate: (events: SessionEvent[]) => boolean,\n timeoutMs = 120_000\n ): Promise {\n // Fleet-mode tasks do not emit session.idle on completion, so polling the\n // session message list is the simplest way to wait for a satisfying state.\n const deadline = Date.now() + timeoutMs;\n while (Date.now() < deadline) {\n const messages = await session.getMessages();\n if (predicate(messages)) {\n return messages;\n }\n await new Promise((resolve) => setTimeout(resolve, 250));\n }\n throw new Error(\"Timed out waiting for fleet-mode assistant reply to satisfy predicate.\");\n }\n\n it(\"should execute shell command\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const markerPath = path.join(\n workDir,\n `shell-rpc-${Date.now()}-${Math.random().toString(36).slice(2)}.txt`\n );\n const marker = \"copilot-sdk-shell-rpc\";\n\n const result = await session.rpc.shell.exec({\n command: createWriteFileCommand(markerPath, marker),\n cwd: workDir,\n });\n\n expect(result.processId).toBeTruthy();\n await waitForFileText(markerPath, marker);\n\n await session.disconnect();\n });\n\n it(\"should kill shell process\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const command =\n os.platform() === \"win32\"\n ? `powershell -NoLogo -NoProfile -Command \"Start-Sleep -Seconds 30\"`\n : \"sleep 30\";\n\n const execResult = await session.rpc.shell.exec({ command });\n expect(execResult.processId).toBeTruthy();\n\n const killResult = await session.rpc.shell.kill({ processId: execResult.processId });\n expect(killResult.killed).toBe(true);\n\n await session.disconnect();\n });\n\n it(\"should start fleet and complete custom tool task\", { timeout: 180_000 }, async () => {\n const markerPath = path.join(\n workDir,\n `fleet-rpc-${Date.now()}-${Math.random().toString(36).slice(2)}.txt`\n );\n const marker = \"copilot-sdk-fleet-rpc\";\n const toolName = \"record_fleet_completion\";\n\n const recordFleetCompletion = defineTool(toolName, {\n description: \"Records completion of the fleet validation task.\",\n parameters: z.object({ content: z.string() }),\n handler: ({ content }) => {\n fs.writeFileSync(markerPath, content);\n return content;\n },\n });\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n tools: [recordFleetCompletion],\n });\n\n const prompt = `Use the ${toolName} tool with content '${marker}', then report that the fleet task is complete.`;\n\n const result = await session.rpc.fleet.start({ prompt });\n expect(result.started).toBe(true);\n\n await waitForFileText(markerPath, marker);\n\n const messages = await waitForMessages(session, (events) =>\n events.some(\n (e) =>\n e.type === \"assistant.message\" &&\n (e.data.content ?? \"\").toLowerCase().includes(\"fleet task\")\n )\n );\n\n const userMessages = messages.filter((m) => m.type === \"user.message\");\n expect(userMessages.some((m) => m.data.content.includes(prompt))).toBe(true);\n\n const toolStarts = messages.filter((m) => m.type === \"tool.execution_start\");\n expect(toolStarts.some((m) => m.data.toolName === toolName)).toBe(true);\n\n const toolCompletes = messages.filter((m) => m.type === \"tool.execution_complete\");\n expect(\n toolCompletes.some(\n (m) =>\n m.data.success === true &&\n typeof m.data.result?.content === \"string\" &&\n m.data.result.content.includes(marker)\n )\n ).toBe(true);\n\n const assistantMessages = messages.filter((m) => m.type === \"assistant.message\");\n expect(\n assistantMessages.some((m) =>\n (m.data.content ?? \"\").toLowerCase().includes(\"fleet task\")\n )\n ).toBe(true);\n\n await session.disconnect();\n });\n});\n" }, { "path": "nodejs/test/e2e/rpc_tasks_and_handlers.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { describe, expect, it } from \"vitest\";\nimport { approveAll } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\ndescribe(\"Session tasks RPC and pending handlers\", async () => {\n const { copilotClient: client } = await createSdkTestContext();\n\n async function assertImplementedFailure(\n action: () => Promise,\n method: string\n ): Promise {\n await expect(action()).rejects.toSatisfy((err: unknown) => {\n const text = err instanceof Error ? `${err.message}\\n${err.stack ?? \"\"}` : String(err);\n expect(text.toLowerCase()).not.toContain(`unhandled method ${method.toLowerCase()}`);\n return true;\n });\n }\n\n it(\"should list task state and return false for missing task operations\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n const tasks = await session.rpc.tasks.list();\n expect(tasks.tasks).toBeDefined();\n expect(tasks.tasks).toEqual([]);\n\n const promote = await session.rpc.tasks.promoteToBackground({ taskId: \"missing-task\" });\n expect(promote.promoted).toBe(false);\n\n const cancel = await session.rpc.tasks.cancel({ taskId: \"missing-task\" });\n expect(cancel.cancelled).toBe(false);\n\n const remove = await session.rpc.tasks.remove({ taskId: \"missing-task\" });\n expect(remove.removed).toBe(false);\n\n await session.disconnect();\n });\n\n it(\"should report implemented error for missing task agent type\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await assertImplementedFailure(\n () =>\n session.rpc.tasks.startAgent({\n agentType: \"missing-agent-type\",\n prompt: \"Say hi\",\n name: \"sdk-test-task\",\n }),\n \"session.tasks.startAgent\"\n );\n\n await session.disconnect();\n });\n\n it(\"should return expected results for missing pending handler requestIds\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n const tool = await session.rpc.tools.handlePendingToolCall({\n requestId: \"missing-tool-request\",\n result: \"tool result\",\n });\n expect(tool.success).toBe(false);\n\n const command = await session.rpc.commands.handlePendingCommand({\n requestId: \"missing-command-request\",\n error: \"command error\",\n });\n expect(command.success).toBe(true);\n\n const elicitation = await session.rpc.ui.handlePendingElicitation({\n requestId: \"missing-elicitation-request\",\n result: { action: \"cancel\" },\n });\n expect(elicitation.success).toBe(false);\n\n const permission = await session.rpc.permissions.handlePendingPermissionRequest({\n requestId: \"missing-permission-request\",\n result: { kind: \"reject\", feedback: \"not approved\" },\n });\n expect(permission.success).toBe(false);\n\n const permanent = await session.rpc.permissions.handlePendingPermissionRequest({\n requestId: \"missing-permanent-permission-request\",\n result: { kind: \"approve-permanently\", domain: \"example.com\" },\n });\n expect(permanent.success).toBe(false);\n\n await session.disconnect();\n });\n});\n" }, { "path": "nodejs/test/e2e/session.e2e.test.ts", "content": "import { rm } from \"fs/promises\";\nimport { describe, expect, it, onTestFinished, vi } from \"vitest\";\nimport { ParsedHttpExchange } from \"../../../test/harness/replayingCapiProxy.js\";\nimport { CopilotClient, approveAll, defineTool } from \"../../src/index.js\";\nimport { createSdkTestContext, isCI } from \"./harness/sdkTestContext.js\";\nimport { getFinalAssistantMessage, getNextEventOfType } from \"./harness/sdkTestHelper.js\";\n\ndescribe(\"Sessions\", async () => {\n const {\n copilotClient: client,\n openAiEndpoint,\n homeDir,\n workDir,\n env,\n } = await createSdkTestContext();\n\n it(\"should create and disconnect sessions\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n model: \"claude-sonnet-4.5\",\n });\n expect(session.sessionId).toMatch(/^[a-f0-9-]+$/);\n\n const allEvents = await session.getMessages();\n const sessionStartEvents = allEvents.filter((e) => e.type === \"session.start\");\n expect(sessionStartEvents).toMatchObject([\n {\n type: \"session.start\",\n data: { sessionId: session.sessionId, selectedModel: \"claude-sonnet-4.5\" },\n },\n ]);\n\n await session.disconnect();\n await expect(() => session.getMessages()).rejects.toThrow(/Session not found/);\n });\n\n // TODO: Re-enable once test harness CAPI proxy supports this test's session lifecycle\n it.skip(\"should list sessions with context field\", { timeout: 60000 }, async () => {\n // Create a session — just creating it is enough for it to appear in listSessions\n const session = await client.createSession({ onPermissionRequest: approveAll });\n expect(session.sessionId).toMatch(/^[a-f0-9-]+$/);\n\n // Verify it has a start event (confirms session is active)\n const messages = await session.getMessages();\n expect(messages.length).toBeGreaterThan(0);\n\n // List sessions and find the one we just created\n const sessions = await client.listSessions();\n const ourSession = sessions.find((s) => s.sessionId === session.sessionId);\n\n expect(ourSession).toBeDefined();\n // Context may not be populated if workspace.yaml hasn't been written yet\n if (ourSession?.context) {\n expect(ourSession.context.cwd).toMatch(/^(\\/|[A-Za-z]:)/);\n }\n });\n\n it(\"should get session metadata by ID\", { timeout: 60000 }, async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n expect(session.sessionId).toMatch(/^[a-f0-9-]+$/);\n\n // Send a message to persist the session to disk\n await session.sendAndWait({ prompt: \"Say hello\" });\n\n // Poll until metadata is available rather than guessing a wait duration.\n let metadata: Awaited> | undefined;\n const deadline = Date.now() + 10_000;\n while (Date.now() < deadline) {\n metadata = await client.getSessionMetadata(session.sessionId);\n if (metadata) break;\n await new Promise((r) => setTimeout(r, 50));\n }\n\n expect(metadata).toBeDefined();\n expect(metadata!.sessionId).toBe(session.sessionId);\n expect(metadata!.startTime).toBeInstanceOf(Date);\n expect(metadata!.modifiedTime).toBeInstanceOf(Date);\n expect(typeof metadata!.isRemote).toBe(\"boolean\");\n\n // Verify non-existent session returns undefined\n const notFound = await client.getSessionMetadata(\"non-existent-session-id\");\n expect(notFound).toBeUndefined();\n });\n\n it(\"should have stateful conversation\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const assistantMessage = await session.sendAndWait({ prompt: \"What is 1+1?\" });\n expect(assistantMessage?.data.content).toContain(\"2\");\n\n const secondAssistantMessage = await session.sendAndWait({\n prompt: \"Now if you double that, what do you get?\",\n });\n expect(secondAssistantMessage?.data.content).toContain(\"4\");\n });\n\n it(\"should create a session with appended systemMessage config\", async () => {\n const systemMessageSuffix = \"End each response with the phrase 'Have a nice day!'\";\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n systemMessage: {\n mode: \"append\",\n content: systemMessageSuffix,\n },\n });\n\n const assistantMessage = await session.sendAndWait({ prompt: \"What is your full name?\" });\n expect(assistantMessage?.data.content).toContain(\"GitHub\");\n expect(assistantMessage?.data.content).toContain(\"Have a nice day!\");\n\n // Also validate the underlying traffic\n const traffic = await openAiEndpoint.getExchanges();\n const systemMessage = getSystemMessage(traffic[0]);\n expect(systemMessage).toContain(\"GitHub\");\n expect(systemMessage).toContain(systemMessageSuffix);\n });\n\n it(\"should create a session with replaced systemMessage config\", async () => {\n const testSystemMessage = \"You are an assistant called Testy McTestface. Reply succinctly.\";\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n systemMessage: { mode: \"replace\", content: testSystemMessage },\n });\n\n const assistantMessage = await session.sendAndWait({ prompt: \"What is your full name?\" });\n expect(assistantMessage?.data.content).not.toContain(\"GitHub\");\n expect(assistantMessage?.data.content).toContain(\"Testy\");\n\n // Also validate the underlying traffic\n const traffic = await openAiEndpoint.getExchanges();\n const systemMessage = getSystemMessage(traffic[0]);\n expect(systemMessage).toEqual(testSystemMessage); // Exact match\n });\n\n it(\"should create a session with customized systemMessage config\", async () => {\n const customTone = \"Respond in a warm, professional tone. Be thorough in explanations.\";\n const appendedContent = \"Always mention quarterly earnings.\";\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n systemMessage: {\n mode: \"customize\",\n sections: {\n tone: { action: \"replace\", content: customTone },\n code_change_rules: { action: \"remove\" },\n },\n content: appendedContent,\n },\n });\n\n const assistantMessage = await session.sendAndWait({ prompt: \"Who are you?\" });\n expect(assistantMessage?.data.content).toBeDefined();\n\n // Validate the system message sent to the model\n const traffic = await openAiEndpoint.getExchanges();\n const systemMessage = getSystemMessage(traffic[0]);\n expect(systemMessage).toContain(customTone);\n expect(systemMessage).toContain(appendedContent);\n // The code_change_rules section should have been removed\n expect(systemMessage).not.toContain(\"\");\n });\n\n it(\"should create a session with availableTools\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n availableTools: [\"view\", \"edit\"],\n });\n\n await session.sendAndWait({ prompt: \"What is 1+1?\" });\n\n // It only tells the model about the specified tools and no others\n const traffic = await openAiEndpoint.getExchanges();\n expect(traffic[0].request.tools).toMatchObject([\n { function: { name: \"view\" } },\n { function: { name: \"edit\" } },\n ]);\n });\n\n it(\"should create a session with excludedTools\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n excludedTools: [\"view\"],\n });\n\n await session.sendAndWait({ prompt: \"What is 1+1?\" });\n\n // It has other tools, but not the one we excluded\n const traffic = await openAiEndpoint.getExchanges();\n const functionNames = traffic[0].request.tools?.map(\n (t) => (t as { function: { name: string } }).function.name\n );\n expect(functionNames).toContain(\"edit\");\n expect(functionNames).toContain(\"grep\");\n expect(functionNames).not.toContain(\"view\");\n });\n\n it(\"should create a session with defaultAgent excludedTools\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n tools: [\n defineTool(\"secret_tool\", {\n description: \"A secret tool hidden from the default agent\",\n parameters: {\n type: \"object\",\n properties: { input: { type: \"string\" } },\n required: [\"input\"],\n },\n handler: async () => \"SECRET\",\n }),\n ],\n defaultAgent: {\n excludedTools: [\"secret_tool\"],\n },\n });\n\n await session.sendAndWait({ prompt: \"What is 1+1?\" });\n\n // The secret_tool should be registered with the runtime but not advertised\n // to the default agent's underlying model call.\n const traffic = await openAiEndpoint.getExchanges();\n expect(traffic.length).toBeGreaterThan(0);\n const functionNames = traffic[0].request.tools?.map(\n (t) => (t as { function: { name: string } }).function.name\n );\n expect(functionNames).not.toContain(\"secret_tool\");\n\n await session.disconnect();\n });\n\n // TODO: This test shows there's a race condition inside client.ts. If createSession is called\n // concurrently and autoStart is on, it may start multiple child processes. This needs to be fixed.\n // Right now it manifests as being unable to delete the temp directories during afterAll even though\n // we stopped all the clients (one or more child processes were left orphaned).\n it.skip(\"should handle multiple concurrent sessions\", async () => {\n const [s1, s2, s3] = await Promise.all([\n client.createSession({ onPermissionRequest: approveAll }),\n client.createSession({ onPermissionRequest: approveAll }),\n client.createSession({ onPermissionRequest: approveAll }),\n ]);\n\n // All sessions should have unique IDs\n const distinctSessionIds = new Set([s1.sessionId, s2.sessionId, s3.sessionId]);\n expect(distinctSessionIds.size).toBe(3);\n\n // All are connected\n for (const s of [s1, s2, s3]) {\n expect(await s.getMessages()).toMatchObject([\n {\n type: \"session.start\",\n data: { sessionId: s.sessionId },\n },\n ]);\n }\n\n // All can be disconnected\n await Promise.all([s1.disconnect(), s2.disconnect(), s3.disconnect()]);\n for (const s of [s1, s2, s3]) {\n await expect(() => s.getMessages()).rejects.toThrow(/Session not found/);\n }\n });\n\n it(\"should resume a session using the same client\", async () => {\n // Create initial session\n const session1 = await client.createSession({ onPermissionRequest: approveAll });\n const sessionId = session1.sessionId;\n const answer = await session1.sendAndWait({ prompt: \"What is 1+1?\" });\n expect(answer?.data.content).toContain(\"2\");\n\n // Resume using the same client\n const session2 = await client.resumeSession(sessionId, { onPermissionRequest: approveAll });\n expect(session2.sessionId).toBe(sessionId);\n const messages = await session2.getMessages();\n const assistantMessages = messages.filter((m) => m.type === \"assistant.message\");\n expect(assistantMessages[assistantMessages.length - 1].data.content).toContain(\"2\");\n\n // Can continue the conversation statefully\n const secondAssistantMessage = await session2.sendAndWait({\n prompt: \"Now if you double that, what do you get?\",\n });\n expect(secondAssistantMessage?.data.content).toContain(\"4\");\n });\n\n it(\"should resume a session using a new client\", async () => {\n // Create initial session\n const session1 = await client.createSession({ onPermissionRequest: approveAll });\n const sessionId = session1.sessionId;\n const answer = await session1.sendAndWait({ prompt: \"What is 1+1?\" });\n expect(answer?.data.content).toContain(\"2\");\n\n // Resume using a new client\n const newClient = new CopilotClient({\n env,\n gitHubToken: isCI ? \"fake-token-for-e2e-tests\" : undefined,\n });\n\n onTestFinished(() => newClient.forceStop());\n const session2 = await newClient.resumeSession(sessionId, {\n onPermissionRequest: approveAll,\n });\n expect(session2.sessionId).toBe(sessionId);\n\n // session.idle is ephemeral and not persisted, so use alreadyIdle\n // to find the assistant message from the completed session.\n const answer2 = await getFinalAssistantMessage(session2, { alreadyIdle: true });\n expect(answer2?.data.content).toContain(\"2\");\n\n const messages = await session2.getMessages();\n expect(messages).toContainEqual(expect.objectContaining({ type: \"user.message\" }));\n expect(messages).toContainEqual(expect.objectContaining({ type: \"session.resume\" }));\n\n // Can continue the conversation statefully\n const secondAssistantMessage = await session2.sendAndWait({\n prompt: \"Now if you double that, what do you get?\",\n });\n expect(secondAssistantMessage?.data.content).toContain(\"4\");\n });\n\n it(\"should throw error when resuming non-existent session\", async () => {\n await expect(\n client.resumeSession(\"non-existent-session-id\", { onPermissionRequest: approveAll })\n ).rejects.toThrow();\n });\n\n it(\"should create session with custom tool\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n tools: [\n {\n name: \"get_secret_number\",\n description: \"Gets the secret number\",\n parameters: {\n type: \"object\",\n properties: {\n key: { type: \"string\", description: \"Key\" },\n },\n required: [\"key\"],\n },\n // Shows that raw JSON schemas still work - Zod is optional\n handler: async (args: { key: string }) => {\n return {\n textResultForLlm: args.key === \"ALPHA\" ? \"54321\" : \"unknown\",\n resultType: \"success\" as const,\n };\n },\n },\n ],\n });\n\n const answer = await session.sendAndWait({\n prompt: \"What is the secret number for key ALPHA?\",\n });\n expect(answer?.data.content).toContain(\"54321\");\n });\n\n it(\"should resume session with a custom provider\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const sessionId = session.sessionId;\n\n // Resume the session with a provider\n const session2 = await client.resumeSession(sessionId, {\n onPermissionRequest: approveAll,\n provider: {\n type: \"openai\",\n baseUrl: \"https://api.openai.com/v1\",\n apiKey: \"fake-key\",\n },\n });\n\n expect(session2.sessionId).toBe(sessionId);\n });\n\n it(\"should abort a session\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n // Set up event listeners BEFORE sending to avoid race conditions\n const nextToolCallStart = getNextEventOfType(session, \"tool.execution_start\");\n const nextSessionIdle = getNextEventOfType(session, \"session.idle\");\n\n await session.send({\n prompt: \"run the shell command 'sleep 100' (note this works on both bash and PowerShell)\",\n });\n\n // Abort once we see a tool execution start\n await nextToolCallStart;\n await session.abort();\n await nextSessionIdle;\n\n // The session should still be alive and usable after abort\n const messages = await session.getMessages();\n expect(messages.length).toBeGreaterThan(0);\n expect(messages.some((m) => m.type === \"abort\")).toBe(true);\n\n // We should be able to send another message\n const answer = await session.sendAndWait({ prompt: \"What is 2+2?\" });\n expect(answer?.data.content).toContain(\"4\");\n });\n\n it(\"should receive session events\", async () => {\n // Use onEvent to capture events dispatched during session creation.\n // session.start is emitted during the session.create RPC; if the session\n // weren't registered in the sessions map before the RPC, it would be dropped.\n const earlyEvents: Array<{ type: string }> = [];\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n onEvent: (event) => {\n earlyEvents.push(event);\n },\n });\n\n expect(earlyEvents.some((e) => e.type === \"session.start\")).toBe(true);\n\n const receivedEvents: Array<{ type: string }> = [];\n\n session.on((event) => {\n receivedEvents.push(event);\n });\n\n // Send a message and wait for completion\n const assistantMessage = await session.sendAndWait({ prompt: \"What is 100+200?\" });\n\n // Should have received multiple events\n expect(receivedEvents.length).toBeGreaterThan(0);\n expect(receivedEvents.some((e) => e.type === \"user.message\")).toBe(true);\n expect(receivedEvents.some((e) => e.type === \"assistant.message\")).toBe(true);\n expect(receivedEvents.some((e) => e.type === \"session.idle\")).toBe(true);\n\n // Verify the assistant response contains the expected answer\n expect(assistantMessage?.data.content).toContain(\"300\");\n });\n\n it(\"handler exception does not halt event delivery\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n let eventCount = 0;\n let gotIdle = false;\n const idlePromise = new Promise((resolve) => {\n session.on((event) => {\n eventCount++;\n // Throw on the first event to verify the loop keeps going.\n if (eventCount === 1) {\n throw new Error(\"boom\");\n }\n if (event.type === \"session.idle\") {\n gotIdle = true;\n resolve();\n }\n });\n });\n\n await session.send({ prompt: \"What is 1+1?\" });\n\n await vi.waitFor(() => expect(gotIdle).toBe(true), { timeout: 30_000 });\n await idlePromise;\n\n // Handler saw more than just the first (throwing) event.\n expect(eventCount).toBeGreaterThan(1);\n\n await session.disconnect();\n });\n\n it(\"disposeAsync from handler does not deadlock\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n let disposed = false;\n const disposedPromise = new Promise((resolve) => {\n session.on((event) => {\n if (event.type === \"user.message\") {\n // Call disconnect from within a handler — must not deadlock.\n session.disconnect().then(() => {\n disposed = true;\n resolve();\n });\n }\n });\n });\n\n await session.send({ prompt: \"What is 1+1?\" });\n\n // If this times out, we deadlocked.\n await vi.waitFor(() => expect(disposed).toBe(true), { timeout: 10_000 });\n await disposedPromise;\n });\n\n it(\"should create session with custom config dir\", async () => {\n const customConfigDir = `${homeDir}/custom-config`;\n onTestFinished(async () => {\n await rm(customConfigDir, { recursive: true, force: true }).catch(() => {});\n });\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n configDir: customConfigDir,\n });\n\n expect(session.sessionId).toMatch(/^[a-f0-9-]+$/);\n\n // Session should work normally with custom config dir\n await session.send({ prompt: \"What is 1+1?\" });\n const assistantMessage = await getFinalAssistantMessage(session);\n expect(assistantMessage.data.content).toContain(\"2\");\n });\n\n it(\"should log messages at all levels and emit matching session events\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n const events: Array<{ type: string; id?: string; data?: Record }> = [];\n session.on((event) => {\n events.push(event as (typeof events)[number]);\n });\n\n await session.log(\"Info message\");\n await session.log(\"Warning message\", { level: \"warning\" });\n await session.log(\"Error message\", { level: \"error\" });\n await session.log(\"Ephemeral message\", { ephemeral: true });\n\n await vi.waitFor(\n () => {\n const notifications = events.filter(\n (e) =>\n e.data &&\n (\"infoType\" in e.data || \"warningType\" in e.data || \"errorType\" in e.data)\n );\n expect(notifications).toHaveLength(4);\n },\n { timeout: 10_000 }\n );\n\n const byMessage = (msg: string) => events.find((e) => e.data?.message === msg)!;\n expect(byMessage(\"Info message\").type).toBe(\"session.info\");\n expect(byMessage(\"Info message\").data).toEqual({\n infoType: \"notification\",\n message: \"Info message\",\n });\n\n expect(byMessage(\"Warning message\").type).toBe(\"session.warning\");\n expect(byMessage(\"Warning message\").data).toEqual({\n warningType: \"notification\",\n message: \"Warning message\",\n });\n\n expect(byMessage(\"Error message\").type).toBe(\"session.error\");\n expect(byMessage(\"Error message\").data).toEqual({\n errorType: \"notification\",\n message: \"Error message\",\n });\n\n expect(byMessage(\"Ephemeral message\").type).toBe(\"session.info\");\n expect(byMessage(\"Ephemeral message\").data).toEqual({\n infoType: \"notification\",\n message: \"Ephemeral message\",\n });\n });\n\n it(\"should send with file attachment\", async () => {\n const filePath = `${workDir}/attached-file.txt`;\n const { writeFile } = await import(\"fs/promises\");\n await writeFile(filePath, \"FILE_ATTACHMENT_SENTINEL\");\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await session.sendAndWait({\n prompt: \"Read the attached file and reply with its contents.\",\n attachments: [\n {\n type: \"file\",\n path: filePath,\n displayName: \"attached-file.txt\",\n // lineRange is not part of the public TS attachment shape, but\n // is forwarded to the runtime to match the C# parity test.\n lineRange: { start: 1, end: 1 },\n } as unknown as NonNullable<\n Parameters[0][\"attachments\"]\n >[number],\n ],\n });\n\n const messages = await session.getMessages();\n const userMessage = messages.filter((m) => m.type === \"user.message\").at(-1);\n expect(userMessage).toBeDefined();\n const attachments = (userMessage as unknown as { data: { attachments?: unknown[] } }).data\n .attachments;\n expect(attachments).toHaveLength(1);\n const attachment = attachments![0] as {\n type: string;\n displayName: string;\n path: string;\n lineRange?: { start: number; end: number };\n };\n expect(attachment.type).toBe(\"file\");\n expect(attachment.displayName).toBe(\"attached-file.txt\");\n expect(attachment.path).toBe(filePath);\n expect(attachment.lineRange).toEqual({ start: 1, end: 1 });\n\n await session.disconnect();\n });\n\n it(\"should send with directory attachment\", async () => {\n const directoryPath = `${workDir}/attached-directory`;\n const { writeFile, mkdir } = await import(\"fs/promises\");\n await mkdir(directoryPath, { recursive: true });\n await writeFile(`${directoryPath}/readme.txt`, \"DIRECTORY_ATTACHMENT_SENTINEL\");\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await session.sendAndWait({\n prompt: \"List the attached directory.\",\n attachments: [\n {\n type: \"directory\",\n path: directoryPath,\n displayName: \"attached-directory\",\n },\n ],\n });\n\n const messages = await session.getMessages();\n const userMessage = messages.filter((m) => m.type === \"user.message\").at(-1);\n expect(userMessage).toBeDefined();\n const attachments = (userMessage as unknown as { data: { attachments?: unknown[] } }).data\n .attachments;\n expect(attachments).toHaveLength(1);\n const attachment = attachments![0] as { type: string; displayName: string; path: string };\n expect(attachment.type).toBe(\"directory\");\n expect(attachment.displayName).toBe(\"attached-directory\");\n expect(attachment.path).toBe(directoryPath);\n\n await session.disconnect();\n });\n\n it(\"should send with selection attachment\", async () => {\n const filePath = `${workDir}/selected-file.cs`;\n const { writeFile } = await import(\"fs/promises\");\n await writeFile(filePath, 'class C { string Value = \"SELECTION_SENTINEL\"; }');\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await session.sendAndWait({\n prompt: \"Summarize the selected code.\",\n attachments: [\n {\n type: \"selection\",\n filePath,\n displayName: \"selected-file.cs\",\n text: 'string Value = \"SELECTION_SENTINEL\";',\n selection: {\n start: { line: 1, character: 10 },\n end: { line: 1, character: 45 },\n },\n },\n ],\n });\n\n const messages = await session.getMessages();\n const userMessage = messages.filter((m) => m.type === \"user.message\").at(-1);\n expect(userMessage).toBeDefined();\n const attachments = (userMessage as unknown as { data: { attachments?: unknown[] } }).data\n .attachments;\n expect(attachments).toHaveLength(1);\n const attachment = attachments![0] as {\n type: string;\n displayName: string;\n filePath: string;\n text: string;\n selection: {\n start: { line: number; character: number };\n end: { line: number; character: number };\n };\n };\n expect(attachment.type).toBe(\"selection\");\n expect(attachment.displayName).toBe(\"selected-file.cs\");\n expect(attachment.filePath).toBe(filePath);\n expect(attachment.text).toBe('string Value = \"SELECTION_SENTINEL\";');\n expect(attachment.selection.start).toEqual({ line: 1, character: 10 });\n expect(attachment.selection.end).toEqual({ line: 1, character: 45 });\n\n await session.disconnect();\n });\n\n it(\"should accept blob attachments\", async () => {\n const pngBase64 =\n \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\";\n const { writeFile } = await import(\"fs/promises\");\n await writeFile(`${workDir}/test-pixel.png`, Buffer.from(pngBase64, \"base64\"));\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await session.sendAndWait({\n prompt: \"Describe this image\",\n attachments: [\n {\n type: \"blob\",\n data: pngBase64,\n mimeType: \"image/png\",\n displayName: \"test-pixel.png\",\n },\n ],\n });\n\n await session.disconnect();\n });\n\n it(\"should send with github reference attachment\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await session.sendAndWait({\n prompt: \"Summarize the referenced issue.\",\n // GitHub reference is a valid runtime attachment type but not part of\n // the public TS attachment shape; cast through unknown to forward it.\n attachments: [\n {\n type: \"github_reference\",\n number: 1234,\n referenceType: \"issue\",\n state: \"open\",\n title: \"Add E2E attachment coverage\",\n url: \"https://github.com/github/copilot-sdk/issues/1234\",\n } as unknown as NonNullable<\n Parameters[0][\"attachments\"]\n >[number],\n ],\n });\n\n const messages = await session.getMessages();\n const userMessage = messages.filter((m) => m.type === \"user.message\").at(-1);\n expect(userMessage).toBeDefined();\n const attachments = (userMessage as unknown as { data: { attachments?: unknown[] } }).data\n .attachments;\n expect(attachments).toHaveLength(1);\n const attachment = attachments![0] as {\n type: string;\n number: number;\n referenceType: string;\n state: string;\n title: string;\n url: string;\n };\n expect(attachment.type).toBe(\"github_reference\");\n expect(attachment.number).toBe(1234);\n expect(attachment.referenceType).toBe(\"issue\");\n expect(attachment.state).toBe(\"open\");\n expect(attachment.title).toBe(\"Add E2E attachment coverage\");\n expect(attachment.url).toBe(\"https://github.com/github/copilot-sdk/issues/1234\");\n\n await session.disconnect();\n });\n\n it(\"should send with mode property\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await session.sendAndWait({\n prompt: \"Say mode ok.\",\n // The runtime accepts arbitrary agent mode strings (e.g. \"plan\", \"interactive\")\n // but the public TS type currently constrains mode to send-time values.\n mode: \"plan\" as unknown as NonNullable[0][\"mode\"]>,\n });\n\n const messages = await session.getMessages();\n const userMessage = messages.filter((m) => m.type === \"user.message\").at(-1) as\n | { data: { content: string; agentMode?: string | null } }\n | undefined;\n expect(userMessage).toBeDefined();\n expect(userMessage!.data.content).toBe(\"Say mode ok.\");\n // The current runtime accepts the per-message mode option but does not echo it\n // on the user.message event.\n expect(userMessage!.data.agentMode ?? null).toBeNull();\n\n await session.disconnect();\n });\n\n it(\"should send with custom requestHeaders\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await session.sendAndWait({\n prompt: \"What is 1+1?\",\n requestHeaders: {\n \"x-copilot-sdk-test-header\": \"ts-request-headers\",\n },\n });\n\n const exchanges = await openAiEndpoint.getExchanges();\n expect(exchanges.length).toBeGreaterThan(0);\n const headers = exchanges[exchanges.length - 1].requestHeaders ?? {};\n const matchingKey = Object.keys(headers).find(\n (k) => k.toLowerCase() === \"x-copilot-sdk-test-header\"\n );\n expect(matchingKey).toBeDefined();\n const headerValue = headers[matchingKey!];\n const headerStr = Array.isArray(headerValue) ? headerValue.join(\",\") : (headerValue ?? \"\");\n expect(headerStr).toContain(\"ts-request-headers\");\n\n await session.disconnect();\n });\n});\n\nfunction getSystemMessage(exchange: ParsedHttpExchange): string | undefined {\n const systemMessage = exchange.request.messages.find((m) => m.role === \"system\") as\n | { role: \"system\"; content: string }\n | undefined;\n return systemMessage?.content;\n}\n\ndescribe(\"Send Blocking Behavior\", async () => {\n // Tests for Issue #17: send() should return immediately, not block until turn completes\n const { copilotClient: client } = await createSdkTestContext();\n\n it(\"send returns immediately while events stream in background\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n });\n\n const events: string[] = [];\n session.on((event) => {\n events.push(event.type);\n });\n\n // Use a slow command so we can verify send() returns before completion\n await session.send({ prompt: \"Run 'sleep 2 && echo done'\" });\n\n // send() should return before turn completes (no session.idle yet)\n expect(events).not.toContain(\"session.idle\");\n\n // Wait for turn to complete\n const message = await getFinalAssistantMessage(session);\n\n expect(message.data.content).toContain(\"done\");\n expect(events).toContain(\"session.idle\");\n expect(events).toContain(\"assistant.message\");\n });\n\n it(\"sendAndWait blocks until session.idle and returns final assistant message\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n const events: string[] = [];\n session.on((event) => {\n events.push(event.type);\n });\n\n const response = await session.sendAndWait({ prompt: \"What is 2+2?\" });\n\n expect(response).toBeDefined();\n expect(response?.type).toBe(\"assistant.message\");\n expect(response?.data.content).toContain(\"4\");\n expect(events).toContain(\"session.idle\");\n expect(events).toContain(\"assistant.message\");\n });\n\n // This test validates client-side timeout behavior.\n // The snapshot has no assistant response since we expect timeout before completion.\n it(\"sendAndWait throws on timeout\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n // Use a slow command to ensure timeout triggers before completion\n await expect(\n session.sendAndWait({ prompt: \"Run 'sleep 2 && echo done'\" }, 100)\n ).rejects.toThrow(/Timeout after 100ms/);\n });\n\n it(\"should set model on existing session\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n // Subscribe for the model change event before calling setModel.\n const modelChangePromise = getNextEventOfType(session, \"session.model_change\");\n\n await session.setModel(\"gpt-4.1\");\n\n // Verify a model_change event was emitted with the new model.\n const event = await modelChangePromise;\n expect(event.data.newModel).toBe(\"gpt-4.1\");\n\n await session.disconnect();\n });\n\n it(\"should set model with reasoningEffort\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n const modelChangePromise = getNextEventOfType(session, \"session.model_change\");\n\n await session.setModel(\"gpt-4.1\", { reasoningEffort: \"high\" });\n\n const event = await modelChangePromise;\n expect(event.data.newModel).toBe(\"gpt-4.1\");\n expect(event.data.reasoningEffort).toBe(\"high\");\n });\n});\n" }, { "path": "nodejs/test/e2e/session_config.e2e.test.ts", "content": "import { describe, expect, it } from \"vitest\";\nimport { writeFile, mkdir } from \"fs/promises\";\nimport { join } from \"path\";\nimport { approveAll } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\ndescribe(\"Session Configuration\", async () => {\n const { copilotClient: client, workDir, openAiEndpoint } = await createSdkTestContext();\n\n it(\"should use workingDirectory for tool execution\", async () => {\n const subDir = join(workDir, \"subproject\");\n await mkdir(subDir, { recursive: true });\n await writeFile(join(subDir, \"marker.txt\"), \"I am in the subdirectory\");\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n workingDirectory: subDir,\n });\n\n const assistantMessage = await session.sendAndWait({\n prompt: \"Read the file marker.txt and tell me what it says\",\n });\n expect(assistantMessage?.data.content).toContain(\"subdirectory\");\n\n await session.disconnect();\n });\n\n it(\"should create session with custom provider config\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n provider: {\n baseUrl: \"https://api.example.com/v1\",\n apiKey: \"test-key\",\n },\n });\n\n expect(session.sessionId).toMatch(/^[a-f0-9-]+$/);\n\n try {\n await session.disconnect();\n } catch {\n // disconnect may fail since the provider is fake\n }\n });\n\n it(\"should accept blob attachments\", async () => {\n // Write the image to disk so the model can view it if it tries\n const pngBase64 =\n \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\";\n await writeFile(join(workDir, \"pixel.png\"), Buffer.from(pngBase64, \"base64\"));\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await session.sendAndWait({\n prompt: \"What color is this pixel? Reply in one word.\",\n attachments: [\n {\n type: \"blob\",\n data: pngBase64,\n mimeType: \"image/png\",\n displayName: \"pixel.png\",\n },\n ],\n });\n\n await session.disconnect();\n });\n\n it(\"should accept message attachments\", async () => {\n await writeFile(join(workDir, \"attached.txt\"), \"This file is attached\");\n\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await session.sendAndWait({\n prompt: \"Summarize the attached file\",\n attachments: [{ type: \"file\", path: join(workDir, \"attached.txt\") }],\n });\n\n await session.disconnect();\n });\n\n const PNG_1X1 = Buffer.from(\n \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\",\n \"base64\"\n );\n const VIEW_IMAGE_PROMPT =\n \"Use the view tool to look at the file test.png and describe what you see\";\n\n function hasImageUrlContent(messages: Array<{ role: string; content: unknown }>): boolean {\n return messages.some(\n (m) =>\n m.role === \"user\" &&\n Array.isArray(m.content) &&\n m.content.some((p: { type: string }) => p.type === \"image_url\")\n );\n }\n\n it(\"vision disabled then enabled via setModel\", async () => {\n await writeFile(join(workDir, \"test.png\"), PNG_1X1);\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n modelCapabilities: { supports: { vision: false } },\n });\n\n // Turn 1: vision off — no image_url expected\n await session.sendAndWait({ prompt: VIEW_IMAGE_PROMPT });\n const trafficAfterT1 = await openAiEndpoint.getExchanges();\n const t1Messages = trafficAfterT1.flatMap((e) => e.request.messages ?? []);\n expect(hasImageUrlContent(t1Messages)).toBe(false);\n\n // Switch vision on (re-specify same model with updated capabilities)\n await session.setModel(\"claude-sonnet-4.5\", {\n modelCapabilities: { supports: { vision: true } },\n });\n\n // Turn 2: vision on — image_url expected\n await session.sendAndWait({ prompt: VIEW_IMAGE_PROMPT });\n const trafficAfterT2 = await openAiEndpoint.getExchanges();\n // Only check exchanges added after turn 1\n const newExchanges = trafficAfterT2.slice(trafficAfterT1.length);\n const t2Messages = newExchanges.flatMap((e) => e.request.messages ?? []);\n expect(hasImageUrlContent(t2Messages)).toBe(true);\n\n await session.disconnect();\n });\n\n it(\"vision enabled then disabled via setModel\", async () => {\n await writeFile(join(workDir, \"test.png\"), PNG_1X1);\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n modelCapabilities: { supports: { vision: true } },\n });\n\n // Turn 1: vision on — image_url expected\n await session.sendAndWait({ prompt: VIEW_IMAGE_PROMPT });\n const trafficAfterT1 = await openAiEndpoint.getExchanges();\n const t1Messages = trafficAfterT1.flatMap((e) => e.request.messages ?? []);\n expect(hasImageUrlContent(t1Messages)).toBe(true);\n\n // Switch vision off\n await session.setModel(\"claude-sonnet-4.5\", {\n modelCapabilities: { supports: { vision: false } },\n });\n\n // Turn 2: vision off — no image_url expected in new exchanges\n await session.sendAndWait({ prompt: VIEW_IMAGE_PROMPT });\n const trafficAfterT2 = await openAiEndpoint.getExchanges();\n const newExchanges = trafficAfterT2.slice(trafficAfterT1.length);\n const t2Messages = newExchanges.flatMap((e) => e.request.messages ?? []);\n expect(hasImageUrlContent(t2Messages)).toBe(false);\n\n await session.disconnect();\n });\n\n const PROVIDER_HEADER_NAME = \"x-copilot-sdk-provider-header\";\n const CLIENT_NAME = \"ts-public-surface-client\";\n\n function createProxyProvider(headerValue: string) {\n return {\n type: \"openai\" as const,\n baseUrl: openAiEndpoint.url,\n apiKey: \"test-provider-key\",\n headers: {\n [PROVIDER_HEADER_NAME]: headerValue,\n },\n };\n }\n\n function getHeaderString(\n headers: Record | undefined,\n name: string\n ): string | undefined {\n if (!headers) {\n return undefined;\n }\n const matchingKey = Object.keys(headers).find(\n (k) => k.toLowerCase() === name.toLowerCase()\n );\n if (!matchingKey) {\n return undefined;\n }\n const value = headers[matchingKey];\n if (Array.isArray(value)) {\n return value.join(\",\");\n }\n return value ?? \"\";\n }\n\n function getSystemMessage(exchange: {\n request: { messages?: Array<{ role: string; content: unknown }> };\n }): string | undefined {\n const sys = (exchange.request.messages ?? []).find((m) => m.role === \"system\") as\n | { content: string }\n | undefined;\n return sys?.content;\n }\n\n function getToolNames(exchange: {\n request: { tools?: Array<{ function: { name: string } }> };\n }): string[] {\n return (exchange.request.tools ?? []).map((t) => t.function.name);\n }\n\n it(\"should forward clientName in user-agent\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n clientName: CLIENT_NAME,\n });\n\n await session.sendAndWait({ prompt: \"What is 1+1?\" });\n\n const exchanges = await openAiEndpoint.getExchanges();\n expect(exchanges.length).toBeGreaterThan(0);\n const userAgent = getHeaderString(exchanges[0].requestHeaders, \"user-agent\");\n expect(userAgent).toBeDefined();\n expect(userAgent).toContain(CLIENT_NAME);\n\n await session.disconnect();\n });\n\n it(\"should forward custom provider headers on create\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n model: \"claude-sonnet-4.5\",\n provider: createProxyProvider(\"create-provider-header\"),\n });\n\n const message = await session.sendAndWait({ prompt: \"What is 1+1?\" });\n expect(message?.data.content ?? \"\").toContain(\"2\");\n\n const exchanges = await openAiEndpoint.getExchanges();\n expect(exchanges.length).toBeGreaterThan(0);\n const auth = getHeaderString(exchanges[0].requestHeaders, \"authorization\");\n expect(auth).toContain(\"Bearer test-provider-key\");\n const customHeader = getHeaderString(exchanges[0].requestHeaders, PROVIDER_HEADER_NAME);\n expect(customHeader).toContain(\"create-provider-header\");\n\n await session.disconnect();\n });\n\n it(\"should forward custom provider headers on resume\", async () => {\n const session1 = await client.createSession({ onPermissionRequest: approveAll });\n const sessionId = session1.sessionId;\n\n const session2 = await client.resumeSession(sessionId, {\n onPermissionRequest: approveAll,\n model: \"claude-sonnet-4.5\",\n provider: createProxyProvider(\"resume-provider-header\"),\n });\n\n const message = await session2.sendAndWait({ prompt: \"What is 2+2?\" });\n expect(message?.data.content ?? \"\").toContain(\"4\");\n\n const exchanges = await openAiEndpoint.getExchanges();\n expect(exchanges.length).toBeGreaterThan(0);\n const lastExchange = exchanges[exchanges.length - 1];\n const auth = getHeaderString(lastExchange.requestHeaders, \"authorization\");\n expect(auth).toContain(\"Bearer test-provider-key\");\n const customHeader = getHeaderString(lastExchange.requestHeaders, PROVIDER_HEADER_NAME);\n expect(customHeader).toContain(\"resume-provider-header\");\n\n await session2.disconnect();\n });\n\n it(\"should apply workingDirectory on session resume\", async () => {\n const subDir = join(workDir, \"resume-subproject\");\n await mkdir(subDir, { recursive: true });\n await writeFile(join(subDir, \"resume-marker.txt\"), \"I am in the resume working directory\");\n\n const session1 = await client.createSession({ onPermissionRequest: approveAll });\n const sessionId = session1.sessionId;\n\n const session2 = await client.resumeSession(sessionId, {\n onPermissionRequest: approveAll,\n workingDirectory: subDir,\n });\n\n const message = await session2.sendAndWait({\n prompt: \"Read the file resume-marker.txt and tell me what it says\",\n });\n expect(message?.data.content ?? \"\").toContain(\"resume working directory\");\n\n await session2.disconnect();\n });\n\n it(\"should apply systemMessage on session resume\", async () => {\n const session1 = await client.createSession({ onPermissionRequest: approveAll });\n const sessionId = session1.sessionId;\n\n const resumeInstruction = \"End the response with RESUME_SYSTEM_MESSAGE_SENTINEL.\";\n const session2 = await client.resumeSession(sessionId, {\n onPermissionRequest: approveAll,\n systemMessage: { mode: \"append\", content: resumeInstruction },\n });\n\n const message = await session2.sendAndWait({ prompt: \"What is 1+1?\" });\n expect(message?.data.content ?? \"\").toContain(\"RESUME_SYSTEM_MESSAGE_SENTINEL\");\n\n const exchanges = await openAiEndpoint.getExchanges();\n expect(exchanges.length).toBeGreaterThan(0);\n const sys = getSystemMessage(exchanges[exchanges.length - 1]);\n expect(sys).toContain(resumeInstruction);\n\n await session2.disconnect();\n });\n\n it(\"should apply availableTools on session resume\", async () => {\n const session1 = await client.createSession({ onPermissionRequest: approveAll });\n const sessionId = session1.sessionId;\n\n const session2 = await client.resumeSession(sessionId, {\n onPermissionRequest: approveAll,\n availableTools: [\"view\"],\n });\n\n await session2.sendAndWait({ prompt: \"What is 1+1?\" });\n\n const exchanges = await openAiEndpoint.getExchanges();\n expect(exchanges.length).toBeGreaterThan(0);\n const toolNames = getToolNames(exchanges[exchanges.length - 1]);\n expect(toolNames).toEqual([\"view\"]);\n\n await session2.disconnect();\n });\n});\n" }, { "path": "nodejs/test/e2e/session_fs.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { SessionCompactionCompleteEvent } from \"@github/copilot/sdk\";\nimport { MemoryProvider, VirtualProvider } from \"@platformatic/vfs\";\nimport { mkdtempSync, realpathSync } from \"fs\";\nimport { tmpdir } from \"os\";\nimport { join } from \"path\";\nimport { describe, expect, it, onTestFinished } from \"vitest\";\nimport { CopilotClient } from \"../../src/client.js\";\nimport { createSessionFsAdapter } from \"../../src/index.js\";\nimport type { SessionFsReaddirWithTypesEntry } from \"../../src/generated/rpc.js\";\nimport {\n approveAll,\n CopilotSession,\n defineTool,\n SessionEvent,\n type SessionFsConfig,\n type SessionFsProvider,\n type SessionFsFileInfo,\n} from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\nconst sessionStatePath =\n process.platform === \"win32\"\n ? \"/session-state\"\n : join(\n realpathSync(mkdtempSync(join(tmpdir(), \"copilot-sessionfs-state-\"))),\n \"session-state\"\n ).replace(/\\\\/g, \"/\");\n\ndescribe(\"Session Fs\", async () => {\n // Single provider for the describe block — session IDs are unique per test,\n // so no cross-contamination between tests.\n const provider = new MemoryProvider();\n const createSessionFsHandler = (session: CopilotSession) =>\n createTestSessionFsHandler(session, provider);\n\n // Helpers to build session-namespaced paths for direct provider assertions\n const p = (sessionId: string, path: string) =>\n `/${sessionId}${path.startsWith(\"/\") ? path : \"/\" + path}`;\n\n const { copilotClient: client, env } = await createSdkTestContext({\n copilotClientOptions: { sessionFs: sessionFsConfig },\n });\n\n it(\"should route file operations through the session fs provider\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n createSessionFsHandler,\n });\n\n const msg = await session.sendAndWait({ prompt: \"What is 100 + 200?\" });\n expect(msg?.data.content).toContain(\"300\");\n await session.disconnect();\n\n const buf = await provider.readFile(\n p(session.sessionId, `${sessionStatePath}/events.jsonl`)\n );\n const content = buf.toString(\"utf8\");\n expect(content).toContain(\"300\");\n });\n\n it(\"should load session data from fs provider on resume\", async () => {\n const session1 = await client.createSession({\n onPermissionRequest: approveAll,\n createSessionFsHandler,\n });\n const sessionId = session1.sessionId;\n\n const msg = await session1.sendAndWait({ prompt: \"What is 50 + 50?\" });\n expect(msg?.data.content).toContain(\"100\");\n await session1.disconnect();\n\n // The events file should exist before resume\n expect(await provider.exists(p(sessionId, `${sessionStatePath}/events.jsonl`))).toBe(true);\n\n const session2 = await client.resumeSession(sessionId, {\n onPermissionRequest: approveAll,\n createSessionFsHandler,\n });\n\n // Send another message to verify the session is functional after resume\n const msg2 = await session2.sendAndWait({ prompt: \"What is that times 3?\" });\n await session2.disconnect();\n expect(msg2?.data.content).toContain(\"300\");\n });\n\n it(\"should reject setProvider when sessions already exist\", async () => {\n const client = new CopilotClient({\n useStdio: false, // Use TCP so we can connect from a second client\n env,\n });\n onTestFinished(() => client.forceStop());\n await client.createSession({ onPermissionRequest: approveAll, createSessionFsHandler });\n\n // Get the port the first client's runtime is listening on\n const port = (client as unknown as { actualPort: number }).actualPort;\n\n // Second client tries to connect with a session fs — should fail\n // because sessions already exist on the runtime.\n const client2 = new CopilotClient({\n env,\n logLevel: \"error\",\n cliUrl: `localhost:${port}`,\n sessionFs: sessionFsConfig,\n });\n onTestFinished(() => client2.forceStop());\n\n await expect(client2.start()).rejects.toThrow();\n });\n\n it(\"should map large output handling into sessionFs\", async () => {\n const suppliedFileContent = \"x\".repeat(100_000);\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n createSessionFsHandler,\n tools: [\n defineTool(\"get_big_string\", {\n description: \"Returns a large string\",\n handler: async () => suppliedFileContent,\n }),\n ],\n });\n\n await session.sendAndWait({\n prompt: \"Call the get_big_string tool and reply with the word DONE only.\",\n });\n\n // The tool result should reference a temp file under the session state path\n const messages = await session.getMessages();\n const toolResult = findToolCallResult(messages, \"get_big_string\");\n expect(toolResult).toContain(`${sessionStatePath}/temp/`);\n const filename = toolResult?.match(\n new RegExp(`(${escapeRegExp(sessionStatePath)}/temp/[^\\\\s]+)`)\n )?.[1];\n expect(filename).toBeDefined();\n\n // Verify the file was written with the correct content via the provider\n const fileContent = await provider.readFile(p(session.sessionId, filename!), \"utf8\");\n expect(fileContent).toBe(suppliedFileContent);\n await session.disconnect();\n });\n\n it(\"should write workspace metadata via sessionFs\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n createSessionFsHandler,\n });\n\n const msg = await session.sendAndWait({ prompt: \"What is 7 * 8?\" });\n expect(msg?.data.content).toContain(\"56\");\n\n // WorkspaceManager should have created workspace.yaml via sessionFs\n const workspaceYamlPath = p(session.sessionId, `${sessionStatePath}/workspace.yaml`);\n await expect.poll(() => provider.exists(workspaceYamlPath)).toBe(true);\n const yaml = await provider.readFile(workspaceYamlPath, \"utf8\");\n expect(yaml).toContain(\"id:\");\n\n // Checkpoint index should also exist\n const indexPath = p(session.sessionId, `${sessionStatePath}/checkpoints/index.md`);\n await expect.poll(() => provider.exists(indexPath)).toBe(true);\n\n await session.disconnect();\n });\n\n it(\"should persist plan.md via sessionFs\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n createSessionFsHandler,\n });\n\n // Write a plan via the session RPC\n await session.sendAndWait({ prompt: \"What is 2 + 3?\" });\n await session.rpc.plan.update({ content: \"# Test Plan\\n\\nThis is a test.\" });\n\n const planPath = p(session.sessionId, `${sessionStatePath}/plan.md`);\n await expect.poll(() => provider.exists(planPath)).toBe(true);\n const content = await provider.readFile(planPath, \"utf8\");\n expect(content).toContain(\"# Test Plan\");\n\n await session.disconnect();\n });\n\n it(\"should succeed with compaction while using sessionFs\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n createSessionFsHandler,\n });\n\n let compactionEvent: SessionCompactionCompleteEvent | undefined;\n session.on(\"session.compaction_complete\", (evt) => (compactionEvent = evt));\n\n await session.sendAndWait({ prompt: \"What is 2+2?\" });\n\n const eventsPath = p(session.sessionId, `${sessionStatePath}/events.jsonl`);\n await expect.poll(() => provider.exists(eventsPath)).toBe(true);\n const contentBefore = await provider.readFile(eventsPath, \"utf8\");\n expect(contentBefore).not.toContain(\"checkpointNumber\");\n\n await session.rpc.history.compact();\n await expect.poll(() => compactionEvent).toBeDefined();\n expect(compactionEvent!.data.success).toBe(true);\n\n // Verify the events file was rewritten with a checkpoint via sessionFs\n await expect\n .poll(() => provider.readFile(eventsPath, \"utf8\"))\n .toContain(\"checkpointNumber\");\n });\n});\n\ndescribe(\"Session Fs Adapter\", () => {\n it(\"should map all sessionFs handler operations\", async () => {\n const provider = new MemoryProvider();\n const userProvider: SessionFsProvider = {\n async readFile(path: string): Promise {\n return (await provider.readFile(path, \"utf8\")) as string;\n },\n async writeFile(path: string, content: string): Promise {\n await provider.writeFile(path, content);\n },\n async appendFile(path: string, content: string): Promise {\n await provider.appendFile(path, content);\n },\n async exists(path: string): Promise {\n return provider.exists(path);\n },\n async stat(path: string): Promise {\n const st = await provider.stat(path);\n return {\n isFile: st.isFile(),\n isDirectory: st.isDirectory(),\n size: st.size,\n mtime: new Date(st.mtimeMs).toISOString(),\n birthtime: new Date(st.birthtimeMs).toISOString(),\n };\n },\n async mkdir(path: string, recursive: boolean, mode?: number): Promise {\n await provider.mkdir(path, { recursive, mode });\n },\n async readdir(path: string): Promise {\n return (await provider.readdir(path)) as string[];\n },\n async readdirWithTypes(path: string): Promise {\n const names = (await provider.readdir(path)) as string[];\n return Promise.all(\n names.map(async (name) => {\n const st = await provider.stat(`${path}/${name}`);\n return {\n name,\n type: st.isDirectory() ? (\"directory\" as const) : (\"file\" as const),\n };\n })\n );\n },\n async rm(path: string, _recursive: boolean, force: boolean): Promise {\n try {\n await provider.unlink(path);\n } catch (err) {\n if (force && (err as NodeJS.ErrnoException).code === \"ENOENT\") {\n return;\n }\n throw err;\n }\n },\n async rename(src: string, dest: string): Promise {\n await provider.rename(src, dest);\n },\n };\n const handler = createSessionFsAdapter(userProvider);\n\n const sessionId = \"handler-session\";\n const params = (extra: Record = {}) => ({ sessionId, ...extra });\n\n expect(\n await handler.mkdir(params({ path: \"/workspace/nested\", recursive: true }))\n ).toBeUndefined();\n\n expect(\n await handler.writeFile(\n params({ path: \"/workspace/nested/file.txt\", content: \"hello\" })\n )\n ).toBeUndefined();\n\n expect(\n await handler.appendFile(\n params({ path: \"/workspace/nested/file.txt\", content: \" world\" })\n )\n ).toBeUndefined();\n\n const exists = await handler.exists(params({ path: \"/workspace/nested/file.txt\" }));\n expect(exists.exists).toBe(true);\n\n const stat = await handler.stat(params({ path: \"/workspace/nested/file.txt\" }));\n expect(stat.isFile).toBe(true);\n expect(stat.isDirectory).toBe(false);\n expect(stat.size).toBe(\"hello world\".length);\n expect(stat.error).toBeUndefined();\n\n const content = await handler.readFile(params({ path: \"/workspace/nested/file.txt\" }));\n expect(content.content).toBe(\"hello world\");\n expect(content.error).toBeUndefined();\n\n const entries = await handler.readdir(params({ path: \"/workspace/nested\" }));\n expect(entries.entries).toContain(\"file.txt\");\n expect(entries.error).toBeUndefined();\n\n const typedEntries = await handler.readdirWithTypes(params({ path: \"/workspace/nested\" }));\n expect(typedEntries.entries).toContainEqual({ name: \"file.txt\", type: \"file\" });\n expect(typedEntries.error).toBeUndefined();\n\n expect(\n await handler.rename(\n params({\n src: \"/workspace/nested/file.txt\",\n dest: \"/workspace/nested/renamed.txt\",\n })\n )\n ).toBeUndefined();\n\n const oldPath = await handler.exists(params({ path: \"/workspace/nested/file.txt\" }));\n expect(oldPath.exists).toBe(false);\n\n const renamed = await handler.readFile(params({ path: \"/workspace/nested/renamed.txt\" }));\n expect(renamed.content).toBe(\"hello world\");\n\n expect(await handler.rm(params({ path: \"/workspace/nested/renamed.txt\" }))).toBeUndefined();\n\n const removed = await handler.exists(params({ path: \"/workspace/nested/renamed.txt\" }));\n expect(removed.exists).toBe(false);\n\n // Forced removal of a missing file should not error.\n expect(\n await handler.rm(params({ path: \"/workspace/nested/missing.txt\", force: true }))\n ).toBeUndefined();\n\n const missing = await handler.stat(params({ path: \"/workspace/nested/missing.txt\" }));\n expect(missing.error?.code).toBe(\"ENOENT\");\n });\n\n it(\"converts provider exceptions to RPC errors\", async () => {\n const enoent: NodeJS.ErrnoException = Object.assign(new Error(\"missing\"), {\n code: \"ENOENT\",\n });\n const throwing: SessionFsProvider = {\n readFile: async () => {\n throw enoent;\n },\n writeFile: async () => {\n throw enoent;\n },\n appendFile: async () => {\n throw enoent;\n },\n exists: async () => {\n throw enoent;\n },\n stat: async () => {\n throw enoent;\n },\n mkdir: async () => {\n throw enoent;\n },\n readdir: async () => {\n throw enoent;\n },\n readdirWithTypes: async () => {\n throw enoent;\n },\n rm: async () => {\n throw enoent;\n },\n rename: async () => {\n throw enoent;\n },\n };\n\n const handler = createSessionFsAdapter(throwing);\n\n const assertEnoent = (error: { code: string; message: string } | undefined) => {\n expect(error).toBeDefined();\n expect(error!.code).toBe(\"ENOENT\");\n expect(error!.message.toLowerCase()).toContain(\"missing\");\n };\n\n assertEnoent((await handler.readFile({ path: \"missing.txt\" } as never)).error);\n assertEnoent(\n await handler.writeFile({\n path: \"missing.txt\",\n content: \"content\",\n } as never)\n );\n assertEnoent(\n await handler.appendFile({\n path: \"missing.txt\",\n content: \"content\",\n } as never)\n );\n\n // exists swallows errors and returns { exists: false }\n const existsResult = await handler.exists({ path: \"missing.txt\" } as never);\n expect(existsResult.exists).toBe(false);\n\n assertEnoent((await handler.stat({ path: \"missing.txt\" } as never)).error);\n assertEnoent(await handler.mkdir({ path: \"missing-dir\" } as never));\n assertEnoent((await handler.readdir({ path: \"missing-dir\" } as never)).error);\n assertEnoent((await handler.readdirWithTypes({ path: \"missing-dir\" } as never)).error);\n assertEnoent(await handler.rm({ path: \"missing.txt\" } as never));\n assertEnoent(await handler.rename({ src: \"missing.txt\", dest: \"dest.txt\" } as never));\n\n // Non-ENOENT errors map to UNKNOWN.\n const unknown: SessionFsProvider = {\n ...throwing,\n writeFile: async () => {\n throw new Error(\"bad path\");\n },\n };\n const unknownHandler = createSessionFsAdapter(unknown);\n const unknownError = await unknownHandler.writeFile({\n path: \"bad.txt\",\n content: \"content\",\n } as never);\n expect(unknownError?.code).toBe(\"UNKNOWN\");\n });\n});\n\nfunction findToolCallResult(messages: SessionEvent[], toolName: string): string | undefined {\n for (const m of messages) {\n if (m.type === \"tool.execution_complete\") {\n if (findToolName(messages, m.data.toolCallId) === toolName) {\n return m.data.result?.content;\n }\n }\n }\n}\n\nfunction findToolName(messages: SessionEvent[], toolCallId: string): string | undefined {\n for (const m of messages) {\n if (m.type === \"tool.execution_start\" && m.data.toolCallId === toolCallId) {\n return m.data.toolName;\n }\n }\n}\n\nconst sessionFsConfig: SessionFsConfig = {\n initialCwd: \"/\",\n sessionStatePath,\n conventions: \"posix\",\n};\n\nfunction escapeRegExp(value: string): string {\n return value.replace(/[.*+?^${}()|[\\]\\\\]/g, \"\\\\$&\");\n}\n\nfunction createTestSessionFsHandler(\n session: CopilotSession,\n provider: VirtualProvider\n): SessionFsProvider {\n const sp = (path: string) => `/${session.sessionId}${path.startsWith(\"/\") ? path : \"/\" + path}`;\n\n return {\n async readFile(path: string): Promise {\n return (await provider.readFile(sp(path), \"utf8\")) as string;\n },\n async writeFile(path: string, content: string): Promise {\n await provider.writeFile(sp(path), content);\n },\n async appendFile(path: string, content: string): Promise {\n await provider.appendFile(sp(path), content);\n },\n async exists(path: string): Promise {\n return provider.exists(sp(path));\n },\n async stat(path: string): Promise {\n const st = await provider.stat(sp(path));\n return {\n isFile: st.isFile(),\n isDirectory: st.isDirectory(),\n size: st.size,\n mtime: new Date(st.mtimeMs).toISOString(),\n birthtime: new Date(st.birthtimeMs).toISOString(),\n };\n },\n async mkdir(path: string, recursive: boolean, mode?: number): Promise {\n await provider.mkdir(sp(path), { recursive, mode });\n },\n async readdir(path: string): Promise {\n return (await provider.readdir(sp(path))) as string[];\n },\n async readdirWithTypes(path: string): Promise {\n const names = (await provider.readdir(sp(path))) as string[];\n return Promise.all(\n names.map(async (name) => {\n const st = await provider.stat(sp(`${path}/${name}`));\n return {\n name,\n type: st.isDirectory() ? (\"directory\" as const) : (\"file\" as const),\n };\n })\n );\n },\n async rm(path: string): Promise {\n await provider.unlink(sp(path));\n },\n async rename(src: string, dest: string): Promise {\n await provider.rename(sp(src), sp(dest));\n },\n };\n}\n" }, { "path": "nodejs/test/e2e/session_lifecycle.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { describe, expect, it } from \"vitest\";\nimport { SessionEvent, approveAll } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext\";\n\n/**\n * Polls until predicate returns true or deadline expires. Used in lieu of arbitrary\n * `setTimeout` waits for \"session flushed to disk\" so fast machines exit immediately\n * and slow CI machines still get up to `timeoutMs` before the test fails.\n */\nasync function waitFor(\n predicate: () => Promise | boolean,\n timeoutMs = 10_000\n): Promise {\n const deadline = Date.now() + timeoutMs;\n while (Date.now() < deadline) {\n if (await predicate()) return;\n await new Promise((r) => setTimeout(r, 50));\n }\n throw new Error(`waitFor: condition not met within ${timeoutMs}ms`);\n}\n\ndescribe(\"Session Lifecycle\", async () => {\n const { copilotClient: client } = await createSdkTestContext();\n\n it(\"should list created sessions after sending a message\", async () => {\n const session1 = await client.createSession({ onPermissionRequest: approveAll });\n const session2 = await client.createSession({ onPermissionRequest: approveAll });\n\n // Sessions must have activity to be persisted to disk\n await session1.sendAndWait({ prompt: \"Say hello\" });\n await session2.sendAndWait({ prompt: \"Say world\" });\n\n // Poll until both sessions are visible on disk instead of a hard 500ms wait.\n await waitFor(async () => {\n const ids = (await client.listSessions()).map((s) => s.sessionId);\n return ids.includes(session1.sessionId) && ids.includes(session2.sessionId);\n });\n\n const sessions = await client.listSessions();\n const sessionIds = sessions.map((s) => s.sessionId);\n\n expect(sessionIds).toContain(session1.sessionId);\n expect(sessionIds).toContain(session2.sessionId);\n\n await session1.disconnect();\n await session2.disconnect();\n });\n\n it(\"should delete session permanently\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n const sessionId = session.sessionId;\n\n // Send a message so the session is persisted\n await session.sendAndWait({ prompt: \"Say hi\" });\n\n // Poll until the session is visible on disk instead of a hard 500ms wait.\n await waitFor(async () => {\n const ids = (await client.listSessions()).map((s) => s.sessionId);\n return ids.includes(sessionId);\n });\n\n // Verify it appears in the list\n const before = await client.listSessions();\n expect(before.map((s) => s.sessionId)).toContain(sessionId);\n\n await session.disconnect();\n await client.deleteSession(sessionId);\n\n // After delete, the session should not be in the list\n const after = await client.listSessions();\n expect(after.map((s) => s.sessionId)).not.toContain(sessionId);\n });\n\n it(\"should return events via getMessages after conversation\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await session.sendAndWait({\n prompt: \"What is 2+2? Reply with just the number.\",\n });\n\n const messages = await session.getMessages();\n expect(messages.length).toBeGreaterThan(0);\n\n // Should have at least session.start, user.message, assistant.message, session.idle\n const types = messages.map((m: SessionEvent) => m.type);\n expect(types).toContain(\"session.start\");\n expect(types).toContain(\"user.message\");\n expect(types).toContain(\"assistant.message\");\n\n await session.disconnect();\n });\n\n it(\"should support multiple concurrent sessions\", async () => {\n const session1 = await client.createSession({ onPermissionRequest: approveAll });\n const session2 = await client.createSession({ onPermissionRequest: approveAll });\n\n // Send to both sessions\n const [msg1, msg2] = await Promise.all([\n session1.sendAndWait({ prompt: \"What is 1+1? Reply with just the number.\" }),\n session2.sendAndWait({ prompt: \"What is 3+3? Reply with just the number.\" }),\n ]);\n\n expect(msg1?.data.content).toContain(\"2\");\n expect(msg2?.data.content).toContain(\"6\");\n\n await session1.disconnect();\n await session2.disconnect();\n });\n});\n" }, { "path": "nodejs/test/e2e/skills.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport * as fs from \"fs\";\nimport * as path from \"path\";\nimport { beforeEach, describe, expect, it } from \"vitest\";\nimport type { CustomAgentConfig } from \"../../src/index.js\";\nimport { approveAll } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\ndescribe(\"Skills Configuration\", async () => {\n const { copilotClient: client, workDir } = await createSdkTestContext({ logLevel: \"debug\" });\n const SKILL_MARKER = \"PINEAPPLE_COCONUT_42\";\n const skillsDir = path.join(workDir, \".test_skills\");\n\n beforeEach(() => {\n // Ensure we start fresh each time\n if (fs.existsSync(skillsDir)) {\n fs.rmSync(skillsDir, { recursive: true, force: true });\n }\n });\n\n function createSkillDir(): string {\n fs.mkdirSync(skillsDir, { recursive: true });\n\n // Create a skill subdirectory with SKILL.md\n const skillSubdir = path.join(skillsDir, \"test-skill\");\n fs.mkdirSync(skillSubdir, { recursive: true });\n\n // Create a skill that instructs the model to include a specific marker in responses\n const skillContent = `---\nname: test-skill\ndescription: A test skill that adds a marker to responses\n---\n\n# Test Skill Instructions\n\nIMPORTANT: You MUST include the exact text \"${SKILL_MARKER}\" somewhere in EVERY response you give. This is a mandatory requirement. Include it naturally in your response.\n`;\n fs.writeFileSync(path.join(skillSubdir, \"SKILL.md\"), skillContent);\n return skillsDir;\n }\n\n describe(\"Skill Behavior\", () => {\n it(\"should load and apply skill from skillDirectories\", async () => {\n const skillsDir = createSkillDir();\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n skillDirectories: [skillsDir],\n });\n\n expect(session.sessionId).toBeDefined();\n\n // The skill instructs the model to include a marker - verify it appears\n const message = await session.sendAndWait({\n prompt: \"Say hello briefly using the test skill.\",\n });\n\n expect(message?.data.content).toContain(SKILL_MARKER);\n\n await session.disconnect();\n });\n\n it(\"should not apply skill when disabled via disabledSkills\", async () => {\n const skillsDir = createSkillDir();\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n skillDirectories: [skillsDir],\n disabledSkills: [\"test-skill\"],\n });\n\n expect(session.sessionId).toBeDefined();\n\n // The skill is disabled, so the marker should NOT appear\n const message = await session.sendAndWait({\n prompt: \"Say hello briefly using the test skill.\",\n });\n\n expect(message?.data.content).not.toContain(SKILL_MARKER);\n\n await session.disconnect();\n });\n\n // Skipped because the underlying feature doesn't work correctly yet.\n // - If this test is run during the same run as other tests in this file (sharing the same Client instance),\n // or if it already has a snapshot of the traffic from a passing run, it passes\n // - But if you delete the snapshot for this test and then run it alone, it fails\n // Be careful not to unskip this test just because it passes when run alongside others. It needs to pass when\n // run alone and without any prior snapshot.\n // It's likely there's an underlying issue either with session resumption in all the client SDKs, or in CLI with\n // how skills are applied on session resume.\n // Also, if this test runs FIRST and then the \"should load and apply skill from skillDirectories\" test runs second\n // within the same run (i.e., sharing the same Client instance), then the second test fails too. There's definitely\n // some state being shared or cached incorrectly.\n it(\"should allow agent with skills to invoke skill\", async () => {\n const skillsDir = createSkillDir();\n const customAgents: CustomAgentConfig[] = [\n {\n name: \"skill-agent\",\n description: \"An agent with access to test-skill\",\n prompt: \"You are a helpful test agent.\",\n skills: [\"test-skill\"],\n },\n ];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n skillDirectories: [skillsDir],\n customAgents,\n agent: \"skill-agent\",\n });\n\n expect(session.sessionId).toBeDefined();\n\n // The agent has skills: [\"test-skill\"], so the skill content is preloaded into its context\n const message = await session.sendAndWait({\n prompt: \"Say hello briefly using the test skill.\",\n });\n\n expect(message?.data.content).toContain(SKILL_MARKER);\n\n await session.disconnect();\n });\n\n it(\"should not provide skills to agent without skills field\", async () => {\n const skillsDir = createSkillDir();\n const customAgents: CustomAgentConfig[] = [\n {\n name: \"no-skill-agent\",\n description: \"An agent without skills access\",\n prompt: \"You are a helpful test agent.\",\n },\n ];\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n skillDirectories: [skillsDir],\n customAgents,\n agent: \"no-skill-agent\",\n });\n\n expect(session.sessionId).toBeDefined();\n\n // The agent has no skills field, so no skill content is injected\n const message = await session.sendAndWait({\n prompt: \"Say hello briefly using the test skill.\",\n });\n\n expect(message?.data.content).not.toContain(SKILL_MARKER);\n\n await session.disconnect();\n });\n\n it.skip(\"should apply skill on session resume with skillDirectories\", async () => {\n const skillsDir = createSkillDir();\n\n // Create a session without skills first\n const session1 = await client.createSession({ onPermissionRequest: approveAll });\n const sessionId = session1.sessionId;\n\n // First message without skill - marker should not appear\n const message1 = await session1.sendAndWait({ prompt: \"Say hi.\" });\n expect(message1?.data.content).not.toContain(SKILL_MARKER);\n\n // Resume with skillDirectories - skill should now be active\n const session2 = await client.resumeSession(sessionId, {\n onPermissionRequest: approveAll,\n skillDirectories: [skillsDir],\n });\n\n expect(session2.sessionId).toBe(sessionId);\n\n // Now the skill should be applied\n const message2 = await session2.sendAndWait({\n prompt: \"Say hello again using the test skill.\",\n });\n\n expect(message2?.data.content).toContain(SKILL_MARKER);\n\n await session2.disconnect();\n });\n });\n});\n" }, { "path": "nodejs/test/e2e/streaming_fidelity.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { describe, expect, it, onTestFinished } from \"vitest\";\nimport { CopilotClient, SessionEvent, approveAll } from \"../../src/index.js\";\nimport { createSdkTestContext, isCI } from \"./harness/sdkTestContext\";\n\ndescribe(\"Streaming Fidelity\", async () => {\n const { copilotClient: client, env } = await createSdkTestContext();\n\n it(\"should produce delta events when streaming is enabled\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n streaming: true,\n });\n const events: SessionEvent[] = [];\n session.on((event) => {\n events.push(event);\n });\n\n await session.sendAndWait({\n prompt: \"Count from 1 to 5, separated by commas.\",\n });\n\n const types = events.map((e) => e.type);\n\n // Should have streaming deltas before the final message\n const deltaEvents = events.filter((e) => e.type === \"assistant.message_delta\");\n expect(deltaEvents.length).toBeGreaterThanOrEqual(1);\n\n // Deltas should have content\n for (const delta of deltaEvents) {\n expect(delta.data.deltaContent).toBeDefined();\n expect(typeof delta.data.deltaContent).toBe(\"string\");\n }\n\n // Should still have a final assistant.message\n expect(types).toContain(\"assistant.message\");\n\n // Deltas should come before the final message\n const firstDeltaIdx = types.indexOf(\"assistant.message_delta\");\n const lastAssistantIdx = types.lastIndexOf(\"assistant.message\");\n expect(firstDeltaIdx).toBeLessThan(lastAssistantIdx);\n\n await session.disconnect();\n });\n\n it(\"should not produce deltas when streaming is disabled\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n streaming: false,\n });\n const events: SessionEvent[] = [];\n session.on((event) => {\n events.push(event);\n });\n\n await session.sendAndWait({\n prompt: \"Say 'hello world'.\",\n });\n\n const deltaEvents = events.filter((e) => e.type === \"assistant.message_delta\");\n\n // No deltas when streaming is off\n expect(deltaEvents.length).toBe(0);\n\n // But should still have a final assistant.message\n const assistantEvents = events.filter((e) => e.type === \"assistant.message\");\n expect(assistantEvents.length).toBeGreaterThanOrEqual(1);\n\n await session.disconnect();\n });\n\n it(\"should produce deltas after session resume\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n streaming: false,\n });\n await session.sendAndWait({ prompt: \"What is 3 + 6?\" });\n await session.disconnect();\n\n // Resume using a new client\n const newClient = new CopilotClient({\n env,\n gitHubToken: isCI ? \"fake-token-for-e2e-tests\" : undefined,\n });\n onTestFinished(() => newClient.forceStop());\n const session2 = await newClient.resumeSession(session.sessionId, {\n onPermissionRequest: approveAll,\n streaming: true,\n });\n const events: SessionEvent[] = [];\n session2.on((event) => events.push(event));\n\n const secondAssistantMessage = await session2.sendAndWait({\n prompt: \"Now if you double that, what do you get?\",\n });\n expect(secondAssistantMessage?.data.content).toContain(\"18\");\n\n // Should have streaming deltas before the final message\n const deltaEvents = events.filter((e) => e.type === \"assistant.message_delta\");\n expect(deltaEvents.length).toBeGreaterThanOrEqual(1);\n\n // Deltas should have content\n for (const delta of deltaEvents) {\n expect(delta.data.deltaContent).toBeDefined();\n expect(typeof delta.data.deltaContent).toBe(\"string\");\n }\n\n await session2.disconnect();\n });\n});\n" }, { "path": "nodejs/test/e2e/suspend.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { describe, expect, it, onTestFinished } from \"vitest\";\nimport { z } from \"zod\";\nimport { approveAll, CopilotClient, defineTool } from \"../../src/index.js\";\nimport type { PermissionRequest, PermissionRequestResult, SessionEvent } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\nconst SUSPEND_TIMEOUT_MS = 60_000;\nconst TEST_TIMEOUT_MS = 180_000;\n\ntype Deferred = {\n promise: Promise;\n resolve: (value: T) => void;\n settled: () => boolean;\n};\n\nfunction deferred(): Deferred {\n let resolveFn!: (value: T) => void;\n let isSettled = false;\n const promise = new Promise((resolve) => {\n resolveFn = (value: T) => {\n isSettled = true;\n resolve(value);\n };\n });\n return { promise, resolve: resolveFn, settled: () => isSettled };\n}\n\nasync function waitWithTimeout(\n promise: Promise,\n timeoutMs: number,\n label: string\n): Promise {\n let timer: ReturnType | undefined;\n try {\n return await Promise.race([\n promise,\n new Promise((_, reject) => {\n timer = setTimeout(() => reject(new Error(`Timeout: ${label}`)), timeoutMs);\n }),\n ]);\n } finally {\n if (timer) clearTimeout(timer);\n }\n}\n\nfunction onTestFinishedForceStop(client: CopilotClient): void {\n onTestFinished(async () => {\n try {\n await client.forceStop();\n } catch {\n // Ignore cleanup errors\n }\n });\n}\n\ndescribe(\"Suspend RPC\", async () => {\n const { copilotClient: client, env, workDir } = await createSdkTestContext();\n\n function createTcpServer(): CopilotClient {\n const server = new CopilotClient({\n cwd: workDir,\n env,\n cliPath: process.env.COPILOT_CLI_PATH,\n useStdio: false,\n });\n onTestFinishedForceStop(server);\n return server;\n }\n\n function createConnectingClient(cliUrl: string): CopilotClient {\n const connectedClient = new CopilotClient({ cliUrl });\n onTestFinishedForceStop(connectedClient);\n return connectedClient;\n }\n\n function getCliUrl(server: CopilotClient): string {\n const port = (server as unknown as { actualPort: number | null }).actualPort;\n if (!port) {\n throw new Error(\"Expected the test server to be listening on a TCP port.\");\n }\n return `localhost:${port}`;\n }\n\n it(\"should suspend idle session without throwing\", async () => {\n const session = await client.createSession({ onPermissionRequest: approveAll });\n\n await session.sendAndWait({ prompt: \"Reply with: SUSPEND_IDLE_OK\" });\n\n await waitWithTimeout(session.rpc.suspend(), SUSPEND_TIMEOUT_MS, \"session.rpc.suspend\");\n\n await session.disconnect();\n });\n\n it(\n \"should allow resume and continue conversation after suspend\",\n { timeout: TEST_TIMEOUT_MS },\n async () => {\n const server = createTcpServer();\n await server.start();\n const cliUrl = getCliUrl(server);\n\n let sessionId: string;\n {\n const client1 = createConnectingClient(cliUrl);\n const session1 = await client1.createSession({ onPermissionRequest: approveAll });\n sessionId = session1.sessionId;\n\n await session1.sendAndWait({\n prompt: \"Remember the magic word: SUSPENSE. Reply with: SUSPEND_TURN_ONE\",\n });\n\n await waitWithTimeout(\n session1.rpc.suspend(),\n SUSPEND_TIMEOUT_MS,\n \"session1.rpc.suspend\"\n );\n await session1.disconnect();\n }\n\n const client2 = createConnectingClient(cliUrl);\n const session2 = await client2.resumeSession(sessionId, {\n onPermissionRequest: approveAll,\n });\n\n const followUp = await session2.sendAndWait({\n prompt: \"What was the magic word I asked you to remember? Reply with just the word.\",\n });\n expect(followUp?.data.content ?? \"\").toMatch(/SUSPENSE/i);\n\n await session2.disconnect();\n }\n );\n\n it(\"should cancel pending permission request when suspending\", async () => {\n const permissionHandlerEntered = deferred();\n const releasePermissionHandler = deferred();\n let toolInvoked = false;\n\n const session = await client.createSession({\n tools: [\n defineTool(\"suspend_cancel_permission_tool\", {\n description:\n \"Transforms a value (should not run when suspend cancels permission)\",\n parameters: z.object({\n value: z.string().describe(\"Value to transform\"),\n }),\n handler: ({ value }) => {\n toolInvoked = true;\n return `SHOULD_NOT_RUN_${value}`;\n },\n }),\n ],\n onPermissionRequest: (request) => {\n permissionHandlerEntered.resolve(request);\n return releasePermissionHandler.promise;\n },\n });\n\n try {\n await session.send({\n prompt: \"Use suspend_cancel_permission_tool with value 'omega', then reply with the result.\",\n });\n\n const requestObserved = await waitWithTimeout(\n permissionHandlerEntered.promise,\n SUSPEND_TIMEOUT_MS,\n \"pending permission request\"\n );\n expect(requestObserved.kind).toBe(\"custom-tool\");\n expect((requestObserved as PermissionRequest & { toolName?: string }).toolName).toBe(\n \"suspend_cancel_permission_tool\"\n );\n\n await waitWithTimeout(session.rpc.suspend(), SUSPEND_TIMEOUT_MS, \"session.rpc.suspend\");\n\n expect(toolInvoked).toBe(false);\n } finally {\n if (!releasePermissionHandler.settled()) {\n releasePermissionHandler.resolve({ kind: \"user-not-available\" });\n }\n await session.disconnect();\n }\n });\n\n it(\"should reject pending external tool when suspending\", async () => {\n const toolStarted = deferred();\n const releaseTool = deferred();\n const externalToolRequested = deferred();\n\n const session = await client.createSession({\n tools: [\n defineTool(\"suspend_reject_external_tool\", {\n description: \"Looks up a value externally\",\n parameters: z.object({\n value: z.string().describe(\"Value to look up\"),\n }),\n handler: async ({ value }) => {\n toolStarted.resolve(value);\n return await releaseTool.promise;\n },\n }),\n ],\n onPermissionRequest: approveAll,\n });\n\n const unsubscribe = session.on((event: SessionEvent) => {\n if (\n event.type === \"external_tool.requested\" &&\n event.data.toolName === \"suspend_reject_external_tool\"\n ) {\n externalToolRequested.resolve();\n }\n });\n\n try {\n await session.send({\n prompt: \"Use suspend_reject_external_tool with value 'sigma', then reply with the result.\",\n });\n\n const [value] = await waitWithTimeout(\n Promise.all([toolStarted.promise, externalToolRequested.promise]),\n SUSPEND_TIMEOUT_MS,\n \"pending external tool request\"\n );\n expect(value).toBe(\"sigma\");\n\n await waitWithTimeout(session.rpc.suspend(), SUSPEND_TIMEOUT_MS, \"session.rpc.suspend\");\n } finally {\n unsubscribe();\n if (!releaseTool.settled()) {\n releaseTool.resolve(\"RELEASED_AFTER_SUSPEND\");\n }\n await session.disconnect();\n }\n });\n});\n" }, { "path": "nodejs/test/e2e/system_message_transform.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { writeFile } from \"fs/promises\";\nimport { join } from \"path\";\nimport { describe, expect, it } from \"vitest\";\nimport { ParsedHttpExchange } from \"../../../test/harness/replayingCapiProxy.js\";\nimport { approveAll } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\ndescribe(\"System message transform\", async () => {\n const { copilotClient: client, openAiEndpoint, workDir } = await createSdkTestContext();\n\n it(\"should invoke transform callbacks with section content\", async () => {\n const transformedSections: Record = {};\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n systemMessage: {\n mode: \"customize\",\n sections: {\n identity: {\n action: (content: string) => {\n transformedSections[\"identity\"] = content;\n // Pass through unchanged\n return content;\n },\n },\n tone: {\n action: (content: string) => {\n transformedSections[\"tone\"] = content;\n return content;\n },\n },\n },\n },\n });\n\n await writeFile(join(workDir, \"test.txt\"), \"Hello transform!\");\n\n await session.sendAndWait({\n prompt: \"Read the contents of test.txt and tell me what it says\",\n });\n\n // Transform callbacks should have been invoked with real section content\n expect(Object.keys(transformedSections).length).toBe(2);\n expect(transformedSections[\"identity\"]).toBeDefined();\n expect(transformedSections[\"identity\"]!.length).toBeGreaterThan(0);\n expect(transformedSections[\"tone\"]).toBeDefined();\n expect(transformedSections[\"tone\"]!.length).toBeGreaterThan(0);\n\n await session.disconnect();\n });\n\n it(\"should apply transform modifications to section content\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n systemMessage: {\n mode: \"customize\",\n sections: {\n identity: {\n action: (content: string) => {\n return content + \"\\nTRANSFORM_MARKER\";\n },\n },\n },\n },\n });\n\n await writeFile(join(workDir, \"hello.txt\"), \"Hello!\");\n\n await session.sendAndWait({\n prompt: \"Read the contents of hello.txt\",\n });\n\n // Verify the transform result was actually applied to the system message\n const traffic = await openAiEndpoint.getExchanges();\n const systemMessage = getSystemMessage(traffic[0]);\n expect(systemMessage).toContain(\"TRANSFORM_MARKER\");\n\n await session.disconnect();\n });\n\n it(\"should work with static overrides and transforms together\", async () => {\n const transformedSections: Record = {};\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n systemMessage: {\n mode: \"customize\",\n sections: {\n // Static override\n safety: { action: \"remove\" },\n // Transform\n identity: {\n action: (content: string) => {\n transformedSections[\"identity\"] = content;\n return content;\n },\n },\n },\n },\n });\n\n await writeFile(join(workDir, \"combo.txt\"), \"Combo test!\");\n\n await session.sendAndWait({\n prompt: \"Read the contents of combo.txt and tell me what it says\",\n });\n\n // Transform should have been invoked\n expect(transformedSections[\"identity\"]).toBeDefined();\n expect(transformedSections[\"identity\"]!.length).toBeGreaterThan(0);\n\n await session.disconnect();\n });\n});\n\nfunction getSystemMessage(exchange: ParsedHttpExchange): string | undefined {\n const systemMessage = exchange.request.messages.find((m) => m.role === \"system\") as\n | { role: \"system\"; content: string }\n | undefined;\n return systemMessage?.content;\n}\n" }, { "path": "nodejs/test/e2e/telemetry.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { existsSync, statSync } from \"fs\";\nimport { readFile } from \"fs/promises\";\nimport { join } from \"path\";\nimport { describe, expect, it } from \"vitest\";\nimport { z } from \"zod\";\nimport { approveAll, defineTool } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\nimport { getFinalAssistantMessage } from \"./harness/sdkTestHelper.js\";\n\ninterface TelemetryEntry {\n type?: string;\n traceId?: string;\n spanId?: string;\n parentSpanId?: string;\n instrumentationScope?: { name?: string };\n attributes?: Record;\n status?: { code?: number };\n}\n\nfunction getStringAttribute(entry: TelemetryEntry, name: string): string | undefined {\n const value = entry.attributes?.[name];\n if (value === undefined || value === null) {\n return undefined;\n }\n return typeof value === \"string\" ? value : JSON.stringify(value);\n}\n\nfunction isRootSpan(entry: TelemetryEntry): boolean {\n const parent = entry.parentSpanId ?? \"\";\n return parent === \"\" || parent === \"0000000000000000\";\n}\n\nasync function readTelemetryEntries(\n path: string,\n isComplete: (entries: TelemetryEntry[]) => boolean,\n timeoutMs = 30_000\n): Promise {\n const deadline = Date.now() + timeoutMs;\n while (Date.now() < deadline) {\n if (existsSync(path) && statSync(path).size > 0) {\n const content = await readFile(path, \"utf8\");\n const entries: TelemetryEntry[] = [];\n for (const line of content.split(\"\\n\")) {\n const trimmed = line.trim();\n if (!trimmed) continue;\n try {\n entries.push(JSON.parse(trimmed));\n } catch {\n // Skip malformed lines (file may still be writing)\n }\n }\n if (entries.length > 0 && isComplete(entries)) {\n return entries;\n }\n }\n await new Promise((resolve) => setTimeout(resolve, 100));\n }\n throw new Error(`Timed out waiting for telemetry records in '${path}'.`);\n}\n\ndescribe(\"Telemetry export\", async () => {\n const marker = \"copilot-sdk-telemetry-e2e\";\n const sourceName = \"ts-sdk-telemetry-e2e\";\n const toolName = \"echo_telemetry_marker\";\n const prompt = `Use the ${toolName} tool with value '${marker}', then respond with TELEMETRY_E2E_DONE.`;\n\n const telemetryFileName = `telemetry-${Date.now()}-${Math.random().toString(36).slice(2)}.jsonl`;\n\n const { copilotClient: client, workDir } = await createSdkTestContext({\n copilotClientOptions: {\n telemetry: {\n filePath: telemetryFileName,\n exporterType: \"file\",\n sourceName,\n captureContent: true,\n },\n },\n });\n\n it(\"should export file telemetry for sdk interactions\", { timeout: 90_000 }, async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n tools: [\n defineTool(toolName, {\n description: \"Echoes a marker string for telemetry validation.\",\n parameters: z.object({ value: z.string() }),\n handler: ({ value }) => value,\n }),\n ],\n });\n\n await session.send({ prompt });\n const assistantMessage = await getFinalAssistantMessage(session);\n expect(assistantMessage).toBeDefined();\n expect(assistantMessage.data.content ?? \"\").toContain(\"TELEMETRY_E2E_DONE\");\n\n await session.disconnect();\n await client.stop();\n\n // Telemetry exporter writes to telemetryFileName resolved relative to the CLI cwd (workDir).\n const telemetryPath = join(workDir, telemetryFileName);\n const entries = await readTelemetryEntries(telemetryPath, (entries) =>\n entries.some(\n (entry) =>\n entry.type === \"span\" &&\n getStringAttribute(entry, \"gen_ai.operation.name\") === \"invoke_agent\"\n )\n );\n const spans = entries.filter((entry) => entry.type === \"span\");\n\n expect(spans.length).toBeGreaterThan(0);\n for (const span of spans) {\n expect(span.instrumentationScope?.name).toBe(sourceName);\n }\n\n // All spans for one SDK turn must share the same trace id and must not be in error state.\n const traceIds = Array.from(\n new Set(spans.map((span) => span.traceId).filter((id): id is string => Boolean(id)))\n );\n expect(traceIds).toHaveLength(1);\n for (const span of spans) {\n expect(span.status?.code).not.toBe(2);\n }\n\n const invokeAgentSpan = spans.find(\n (span) => getStringAttribute(span, \"gen_ai.operation.name\") === \"invoke_agent\"\n );\n expect(invokeAgentSpan).toBeDefined();\n expect(getStringAttribute(invokeAgentSpan!, \"gen_ai.conversation.id\")).toBe(\n session.sessionId\n );\n expect(isRootSpan(invokeAgentSpan!)).toBe(true);\n const invokeAgentSpanId = invokeAgentSpan!.spanId;\n expect(invokeAgentSpanId).toBeTruthy();\n\n const chatSpans = spans.filter(\n (span) => getStringAttribute(span, \"gen_ai.operation.name\") === \"chat\"\n );\n expect(chatSpans.length).toBeGreaterThan(0);\n for (const chat of chatSpans) {\n expect(chat.parentSpanId).toBe(invokeAgentSpanId);\n }\n expect(\n chatSpans.some((span) =>\n (getStringAttribute(span, \"gen_ai.input.messages\") ?? \"\").includes(prompt)\n )\n ).toBe(true);\n expect(\n chatSpans.some((span) =>\n (getStringAttribute(span, \"gen_ai.output.messages\") ?? \"\").includes(\n \"TELEMETRY_E2E_DONE\"\n )\n )\n ).toBe(true);\n\n const toolSpan = spans.find(\n (span) => getStringAttribute(span, \"gen_ai.operation.name\") === \"execute_tool\"\n );\n expect(toolSpan).toBeDefined();\n expect(toolSpan!.parentSpanId).toBe(invokeAgentSpanId);\n expect(getStringAttribute(toolSpan!, \"gen_ai.tool.name\")).toBe(toolName);\n expect(getStringAttribute(toolSpan!, \"gen_ai.tool.call.id\")).toBeTruthy();\n expect(getStringAttribute(toolSpan!, \"gen_ai.tool.call.arguments\")).toBe(\n `{\"value\":\"${marker}\"}`\n );\n expect(getStringAttribute(toolSpan!, \"gen_ai.tool.call.result\")).toBe(marker);\n });\n});\n" }, { "path": "nodejs/test/e2e/tool_results.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { describe, expect, it } from \"vitest\";\nimport { z } from \"zod\";\nimport type { SessionEvent, ToolResultObject } from \"../../src/index.js\";\nimport { approveAll, defineTool } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext\";\n\ndescribe(\"Tool Results\", async () => {\n const { copilotClient: client, openAiEndpoint } = await createSdkTestContext();\n\n it(\"should handle structured ToolResultObject from custom tool\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n tools: [\n defineTool(\"get_weather\", {\n description: \"Gets weather for a city\",\n parameters: z.object({\n city: z.string(),\n }),\n handler: ({ city }): ToolResultObject => ({\n textResultForLlm: `The weather in ${city} is sunny and 72°F`,\n resultType: \"success\",\n }),\n }),\n ],\n });\n\n const assistantMessage = await session.sendAndWait({\n prompt: \"What's the weather in Paris?\",\n });\n\n const content = assistantMessage?.data.content ?? \"\";\n expect(content).toMatch(/sunny|72/i);\n\n await session.disconnect();\n });\n\n it(\"should handle tool result with failure resultType\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n tools: [\n defineTool(\"check_status\", {\n description: \"Checks the status of a service\",\n handler: (): ToolResultObject => ({\n textResultForLlm: \"Service unavailable\",\n resultType: \"failure\",\n error: \"API timeout\",\n }),\n }),\n ],\n });\n\n const assistantMessage = await session.sendAndWait({\n prompt: \"Check the status of the service using check_status. If it fails, say 'service is down'.\",\n });\n\n const failureContent = assistantMessage?.data.content ?? \"\";\n expect(failureContent).toMatch(/service is down/i);\n\n await session.disconnect();\n });\n\n it(\"should pass validated Zod parameters to tool handler\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n tools: [\n defineTool(\"calculate\", {\n description: \"Calculates a math expression\",\n parameters: z.object({\n operation: z.enum([\"add\", \"subtract\", \"multiply\"]),\n a: z.number(),\n b: z.number(),\n }),\n handler: ({ operation, a, b }) => {\n expect(typeof a).toBe(\"number\");\n expect(typeof b).toBe(\"number\");\n switch (operation) {\n case \"add\":\n return String(a + b);\n case \"subtract\":\n return String(a - b);\n case \"multiply\":\n return String(a * b);\n }\n },\n }),\n ],\n });\n\n const assistantMessage = await session.sendAndWait({\n prompt: \"Use calculate to add 17 and 25\",\n });\n\n expect(assistantMessage?.data.content).toContain(\"42\");\n\n await session.disconnect();\n });\n\n it(\"should preserve toolTelemetry and not stringify structured results for LLM\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n tools: [\n defineTool(\"analyze_code\", {\n description: \"Analyzes code for issues\",\n parameters: z.object({\n file: z.string(),\n }),\n handler: ({ file }): ToolResultObject => ({\n textResultForLlm: `Analysis of ${file}: no issues found`,\n resultType: \"success\",\n toolTelemetry: {\n metrics: { analysisTimeMs: 150 },\n properties: { analyzer: \"eslint\" },\n },\n }),\n }),\n ],\n });\n\n const events: SessionEvent[] = [];\n session.on((event) => events.push(event));\n\n const assistantMessage = await session.sendAndWait({\n prompt: \"Analyze the file main.ts for issues.\",\n });\n\n expect(assistantMessage?.data.content).toMatch(/no issues/i);\n\n // Verify the LLM received just textResultForLlm, not stringified JSON\n const traffic = await openAiEndpoint.getExchanges();\n const lastConversation = traffic[traffic.length - 1]!;\n const toolResults = lastConversation.request.messages.filter(\n (m: { role: string }) => m.role === \"tool\"\n );\n expect(toolResults.length).toBe(1);\n expect(toolResults[0]!.content).not.toContain(\"toolTelemetry\");\n expect(toolResults[0]!.content).not.toContain(\"resultType\");\n\n // Verify tool.execution_complete event fires for this tool call\n const toolCompletes = events.filter((e) => e.type === \"tool.execution_complete\");\n expect(toolCompletes.length).toBeGreaterThanOrEqual(1);\n const completeEvent = toolCompletes[0]!;\n expect(completeEvent.data.success).toBe(true);\n // When the server preserves the structured result, toolTelemetry should\n // be present and non-empty (not the {} that results from stringification).\n if (completeEvent.data.toolTelemetry) {\n expect(Object.keys(completeEvent.data.toolTelemetry).length).toBeGreaterThan(0);\n }\n\n await session.disconnect();\n });\n});\n" }, { "path": "nodejs/test/e2e/tools.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { writeFile } from \"fs/promises\";\nimport { join } from \"path\";\nimport { assert, describe, expect, it } from \"vitest\";\nimport { z } from \"zod\";\nimport { defineTool, approveAll } from \"../../src/index.js\";\nimport type { PermissionRequest } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext\";\n\ndescribe(\"Custom tools\", async () => {\n const { copilotClient: client, openAiEndpoint, workDir } = await createSdkTestContext();\n\n it(\"invokes built-in tools\", async () => {\n await writeFile(join(workDir, \"README.md\"), \"# ELIZA, the only chatbot you'll ever need\");\n\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n });\n const assistantMessage = await session.sendAndWait({\n prompt: \"What's the first line of README.md in this directory?\",\n });\n expect(assistantMessage?.data.content).toContain(\"ELIZA\");\n });\n\n it(\"invokes custom tool\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n tools: [\n defineTool(\"encrypt_string\", {\n description: \"Encrypts a string\",\n parameters: z.object({\n input: z.string().describe(\"String to encrypt\"),\n }),\n handler: ({ input }) => input.toUpperCase(),\n }),\n ],\n });\n\n const assistantMessage = await session.sendAndWait({\n prompt: \"Use encrypt_string to encrypt this string: Hello\",\n });\n expect(assistantMessage?.data.content).toContain(\"HELLO\");\n });\n\n it(\"handles tool calling errors\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n tools: [\n defineTool(\"get_user_location\", {\n description: \"Gets the user's location\",\n handler: () => {\n throw new Error(\"Melbourne\");\n },\n }),\n ],\n });\n\n const answer = await session.sendAndWait({\n prompt: \"What is my location? If you can't find out, just say 'unknown'.\",\n });\n\n // Check the underlying traffic\n const traffic = await openAiEndpoint.getExchanges();\n const lastConversation = traffic[traffic.length - 1];\n\n const toolCalls = lastConversation.request.messages.flatMap((m) =>\n m.role === \"assistant\" ? m.tool_calls : []\n );\n expect(toolCalls.length).toBe(1);\n const toolCall = toolCalls[0]!;\n assert(toolCall.type === \"function\");\n expect(toolCall.function.name).toBe(\"get_user_location\");\n\n const toolResults = lastConversation.request.messages.filter((m) => m.role === \"tool\");\n expect(toolResults.length).toBe(1);\n const toolResult = toolResults[0]!;\n expect(toolResult.tool_call_id).toBe(toolCall.id);\n expect(toolResult.content).not.toContain(\"Melbourne\");\n\n // Importantly, we're checking that the assistant does not see the\n // exception information as if it was the tool's output.\n expect(answer?.data.content).not.toContain(\"Melbourne\");\n expect(answer?.data.content?.toLowerCase()).toContain(\"unknown\");\n });\n\n it(\"can receive and return complex types\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n tools: [\n defineTool(\"db_query\", {\n description: \"Performs a database query\",\n parameters: z.object({\n query: z.object({\n table: z.string(),\n ids: z.array(z.number()),\n sortAscending: z.boolean(),\n }),\n }),\n handler: ({ query }, invocation) => {\n expect(query.table).toBe(\"cities\");\n expect(query.ids).toEqual([12, 19]);\n expect(query.sortAscending).toBe(true);\n expect(invocation.sessionId).toBe(session.sessionId);\n\n return [\n { countryId: 19, cityName: \"Passos\", population: 135460 },\n { countryId: 12, cityName: \"San Lorenzo\", population: 204356 },\n ];\n },\n }),\n ],\n });\n\n const assistantMessage = await session.sendAndWait({\n prompt:\n \"Perform a DB query for the 'cities' table using IDs 12 and 19, sorting ascending. \" +\n \"Reply only with lines of the form: [cityname] [population]\",\n });\n\n const responseContent = assistantMessage?.data.content!;\n expect(assistantMessage).not.toBeNull();\n expect(responseContent).not.toBe(\"\");\n expect(responseContent).toContain(\"Passos\");\n expect(responseContent).toContain(\"San Lorenzo\");\n expect(responseContent.replace(/,/g, \"\")).toContain(\"135460\");\n expect(responseContent.replace(/,/g, \"\")).toContain(\"204356\");\n });\n\n it(\"invokes custom tool with permission handler\", async () => {\n const permissionRequests: PermissionRequest[] = [];\n\n const session = await client.createSession({\n tools: [\n defineTool(\"encrypt_string\", {\n description: \"Encrypts a string\",\n parameters: z.object({\n input: z.string().describe(\"String to encrypt\"),\n }),\n handler: ({ input }) => input.toUpperCase(),\n }),\n ],\n onPermissionRequest: (request) => {\n permissionRequests.push(request);\n return { kind: \"approve-once\" };\n },\n });\n\n const assistantMessage = await session.sendAndWait({\n prompt: \"Use encrypt_string to encrypt this string: Hello\",\n });\n expect(assistantMessage?.data.content).toContain(\"HELLO\");\n\n // Should have received a custom-tool permission request\n const customToolRequests = permissionRequests.filter((req) => req.kind === \"custom-tool\");\n expect(customToolRequests.length).toBeGreaterThan(0);\n expect(customToolRequests[0].toolName).toBe(\"encrypt_string\");\n });\n\n it(\"skipPermission sent in tool definition\", async () => {\n let didRunPermissionRequest = false;\n const session = await client.createSession({\n onPermissionRequest: () => {\n didRunPermissionRequest = true;\n return { kind: \"no-result\" };\n },\n tools: [\n defineTool(\"safe_lookup\", {\n description: \"A safe lookup that skips permission\",\n parameters: z.object({\n id: z.string().describe(\"ID to look up\"),\n }),\n handler: ({ id }) => `RESULT: ${id}`,\n skipPermission: true,\n }),\n ],\n });\n\n const assistantMessage = await session.sendAndWait({\n prompt: \"Use safe_lookup to look up 'test123'\",\n });\n expect(assistantMessage?.data.content).toContain(\"RESULT: test123\");\n expect(didRunPermissionRequest).toBe(false);\n });\n\n it(\"overrides built-in tool with custom tool\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n tools: [\n defineTool(\"grep\", {\n description: \"A custom grep implementation that overrides the built-in\",\n parameters: z.object({\n query: z.string().describe(\"Search query\"),\n }),\n handler: ({ query }) => `CUSTOM_GREP_RESULT: ${query}`,\n overridesBuiltInTool: true,\n }),\n ],\n });\n\n const assistantMessage = await session.sendAndWait({\n prompt: \"Use grep to search for the word 'hello'\",\n });\n expect(assistantMessage?.data.content).toContain(\"CUSTOM_GREP_RESULT\");\n });\n\n it(\"denies custom tool when permission denied\", async () => {\n let toolHandlerCalled = false;\n\n const session = await client.createSession({\n tools: [\n defineTool(\"encrypt_string\", {\n description: \"Encrypts a string\",\n parameters: z.object({\n input: z.string().describe(\"String to encrypt\"),\n }),\n handler: ({ input }) => {\n toolHandlerCalled = true;\n return input.toUpperCase();\n },\n }),\n ],\n onPermissionRequest: () => {\n return { kind: \"reject\" };\n },\n });\n\n await session.sendAndWait({\n prompt: \"Use encrypt_string to encrypt this string: Hello\",\n });\n\n // The tool handler should NOT have been called since permission was denied\n expect(toolHandlerCalled).toBe(false);\n });\n});\n" }, { "path": "nodejs/test/e2e/ui_elicitation.e2e.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { afterAll, describe, expect, it } from \"vitest\";\nimport { CopilotClient, approveAll } from \"../../src/index.js\";\nimport type { SessionEvent } from \"../../src/index.js\";\nimport { createSdkTestContext } from \"./harness/sdkTestContext.js\";\n\ndescribe(\"UI Elicitation\", async () => {\n const { copilotClient: client } = await createSdkTestContext();\n\n it(\"elicitation methods throw in headless mode\", async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n });\n\n // The SDK spawns the CLI headless - no TUI means no elicitation support.\n expect(session.capabilities.ui?.elicitation).toBeFalsy();\n await expect(session.ui.confirm(\"test\")).rejects.toThrow(/not supported/);\n });\n});\n\ndescribe(\"UI Elicitation Callback\", async () => {\n const ctx = await createSdkTestContext();\n const client = ctx.copilotClient;\n\n it(\n \"session created with onElicitationRequest reports elicitation capability\",\n { timeout: 20_000 },\n async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n onElicitationRequest: async () => ({ action: \"accept\", content: {} }),\n });\n\n expect(session.capabilities.ui?.elicitation).toBe(true);\n }\n );\n\n it(\n \"session created without onElicitationRequest reports no elicitation capability\",\n { timeout: 20_000 },\n async () => {\n const session = await client.createSession({\n onPermissionRequest: approveAll,\n });\n\n expect(session.capabilities.ui?.elicitation).toBe(false);\n }\n );\n});\n\ndescribe(\"UI Elicitation Multi-Client Capabilities\", async () => {\n // Use TCP mode so a second client can connect to the same CLI process\n const ctx = await createSdkTestContext({ useStdio: false });\n const client1 = ctx.copilotClient;\n\n // Trigger connection so we can read the port\n const initSession = await client1.createSession({ onPermissionRequest: approveAll });\n await initSession.disconnect();\n\n const actualPort = (client1 as unknown as { actualPort: number }).actualPort;\n const client2 = new CopilotClient({ cliUrl: `localhost:${actualPort}` });\n\n afterAll(async () => {\n await client2.stop();\n });\n\n it(\n \"capabilities.changed fires when second client joins with elicitation handler\",\n { timeout: 20_000 },\n async () => {\n // Client1 creates session without elicitation\n const session1 = await client1.createSession({\n onPermissionRequest: approveAll,\n });\n expect(session1.capabilities.ui?.elicitation).toBe(false);\n\n // Listen for capabilities.changed event\n let unsubscribe: (() => void) | undefined;\n const capChangedPromise = new Promise((resolve) => {\n unsubscribe = session1.on((event) => {\n if ((event as { type: string }).type === \"capabilities.changed\") {\n resolve(event);\n }\n });\n });\n\n // Client2 joins WITH elicitation handler — triggers capabilities.changed\n const session2 = await client2.resumeSession(session1.sessionId, {\n onPermissionRequest: approveAll,\n onElicitationRequest: async () => ({ action: \"accept\", content: {} }),\n disableResume: true,\n });\n\n const capEvent = await capChangedPromise;\n unsubscribe?.();\n const data = (capEvent as { data: { ui?: { elicitation?: boolean } } }).data;\n expect(data.ui?.elicitation).toBe(true);\n\n // Client1's capabilities should have been auto-updated\n expect(session1.capabilities.ui?.elicitation).toBe(true);\n\n await session2.disconnect();\n }\n );\n\n it(\n \"capabilities.changed fires when elicitation provider disconnects\",\n { timeout: 20_000 },\n async () => {\n // Client1 creates session without elicitation\n const session1 = await client1.createSession({\n onPermissionRequest: approveAll,\n });\n expect(session1.capabilities.ui?.elicitation).toBe(false);\n\n // Wait for elicitation to become available\n let unsubEnabled: (() => void) | undefined;\n const capEnabledPromise = new Promise((resolve) => {\n unsubEnabled = session1.on((event) => {\n const data = event as {\n type: string;\n data: { ui?: { elicitation?: boolean } };\n };\n if (\n data.type === \"capabilities.changed\" &&\n data.data.ui?.elicitation === true\n ) {\n resolve();\n }\n });\n });\n\n // Use a dedicated client so we can stop it without affecting shared client2\n const client3 = new CopilotClient({ cliUrl: `localhost:${actualPort}` });\n\n // Client3 joins WITH elicitation handler\n await client3.resumeSession(session1.sessionId, {\n onPermissionRequest: approveAll,\n onElicitationRequest: async () => ({ action: \"accept\", content: {} }),\n disableResume: true,\n });\n\n await capEnabledPromise;\n unsubEnabled?.();\n expect(session1.capabilities.ui?.elicitation).toBe(true);\n\n // Now listen for the capability being removed\n let unsubDisabled: (() => void) | undefined;\n const capDisabledPromise = new Promise((resolve) => {\n unsubDisabled = session1.on((event) => {\n const data = event as {\n type: string;\n data: { ui?: { elicitation?: boolean } };\n };\n if (\n data.type === \"capabilities.changed\" &&\n data.data.ui?.elicitation === false\n ) {\n resolve();\n }\n });\n });\n\n // Force-stop client3 — destroys the socket, triggering server-side cleanup\n await client3.forceStop();\n\n await capDisabledPromise;\n unsubDisabled?.();\n expect(session1.capabilities.ui?.elicitation).toBe(false);\n }\n );\n});\n" }, { "path": "nodejs/test/extension.test.ts", "content": "import { afterEach, describe, expect, it, vi } from \"vitest\";\nimport { CopilotClient } from \"../src/client.js\";\nimport { approveAll } from \"../src/index.js\";\nimport { joinSession } from \"../src/extension.js\";\nimport { defaultJoinSessionPermissionHandler } from \"../src/types.js\";\n\ndescribe(\"joinSession\", () => {\n const originalSessionId = process.env.SESSION_ID;\n\n afterEach(() => {\n if (originalSessionId === undefined) {\n delete process.env.SESSION_ID;\n } else {\n process.env.SESSION_ID = originalSessionId;\n }\n vi.restoreAllMocks();\n });\n\n it(\"defaults onPermissionRequest to no-result\", async () => {\n process.env.SESSION_ID = \"session-123\";\n const resumeSession = vi\n .spyOn(CopilotClient.prototype, \"resumeSession\")\n .mockResolvedValue({} as any);\n\n await joinSession({ tools: [] });\n\n const [, config] = resumeSession.mock.calls[0]!;\n expect(config.onPermissionRequest).toBeDefined();\n expect(config.onPermissionRequest).toBe(defaultJoinSessionPermissionHandler);\n const result = await Promise.resolve(\n config.onPermissionRequest!({ kind: \"write\" }, { sessionId: \"session-123\" })\n );\n expect(result).toEqual({ kind: \"no-result\" });\n expect(config.disableResume).toBe(true);\n });\n\n it(\"preserves an explicit onPermissionRequest handler\", async () => {\n process.env.SESSION_ID = \"session-123\";\n const resumeSession = vi\n .spyOn(CopilotClient.prototype, \"resumeSession\")\n .mockResolvedValue({} as any);\n\n await joinSession({ onPermissionRequest: approveAll, disableResume: false });\n\n const [, config] = resumeSession.mock.calls[0]!;\n expect(config.onPermissionRequest).toBe(approveAll);\n expect(config.disableResume).toBe(false);\n });\n});\n" }, { "path": "nodejs/test/python-codegen.test.ts", "content": "import type { JSONSchema7 } from \"json-schema\";\nimport { describe, expect, it } from \"vitest\";\n\nimport { generatePythonSessionEventsCode } from \"../../scripts/codegen/python.ts\";\n\ndescribe(\"python session event codegen\", () => {\n it(\"maps special schema formats to the expected Python types\", () => {\n const schema: JSONSchema7 = {\n definitions: {\n SessionEvent: {\n anyOf: [\n {\n type: \"object\",\n required: [\"type\", \"data\"],\n properties: {\n type: { const: \"session.synthetic\" },\n data: {\n type: \"object\",\n required: [\n \"at\",\n \"identifier\",\n \"duration\",\n \"integerDuration\",\n \"uri\",\n \"pattern\",\n \"payload\",\n \"encoded\",\n \"count\",\n ],\n properties: {\n at: { type: \"string\", format: \"date-time\" },\n identifier: { type: \"string\", format: \"uuid\" },\n duration: { type: \"number\", format: \"duration\" },\n integerDuration: { type: \"integer\", format: \"duration\" },\n optionalDuration: {\n type: [\"number\", \"null\"],\n format: \"duration\",\n },\n action: {\n type: \"string\",\n enum: [\"store\", \"vote\"],\n default: \"store\",\n },\n summary: { type: \"string\", default: \"\" },\n uri: { type: \"string\", format: \"uri\" },\n pattern: { type: \"string\", format: \"regex\" },\n payload: { type: \"string\", format: \"byte\" },\n encoded: { type: \"string\", contentEncoding: \"base64\" },\n count: { type: \"integer\" },\n },\n },\n },\n },\n ],\n },\n },\n };\n\n const code = generatePythonSessionEventsCode(schema);\n\n expect(code).toContain(\"from datetime import datetime, timedelta\");\n expect(code).toContain(\"at: datetime\");\n expect(code).toContain(\"identifier: UUID\");\n expect(code).toContain(\"duration: timedelta\");\n expect(code).toContain(\"integer_duration: timedelta\");\n expect(code).toContain(\"optional_duration: timedelta | None = None\");\n expect(code).toContain('duration = from_timedelta(obj.get(\"duration\"))');\n expect(code).toContain('result[\"duration\"] = to_timedelta(self.duration)');\n expect(code).toContain(\n 'result[\"integerDuration\"] = to_timedelta_int(self.integer_duration)'\n );\n expect(code).toContain(\"def to_timedelta_int(x: timedelta) -> int:\");\n expect(code).toContain(\n 'action = from_union([from_none, lambda x: parse_enum(SessionSyntheticDataAction, x)], obj.get(\"action\", \"store\"))'\n );\n expect(code).toContain(\n 'summary = from_union([from_none, from_str], obj.get(\"summary\", \"\"))'\n );\n expect(code).toContain(\"uri: str\");\n expect(code).toContain(\"pattern: str\");\n expect(code).toContain(\"payload: str\");\n expect(code).toContain(\"encoded: str\");\n expect(code).toContain(\"count: int\");\n });\n\n it(\"collapses redundant callable wrapper lambdas\", () => {\n const schema: JSONSchema7 = {\n definitions: {\n SessionEvent: {\n anyOf: [\n {\n type: \"object\",\n required: [\"type\", \"data\"],\n properties: {\n type: { const: \"session.synthetic\" },\n data: {\n type: \"object\",\n properties: {\n summary: { type: \"string\" },\n tags: {\n type: \"array\",\n items: { type: \"string\" },\n },\n context: {\n type: \"object\",\n properties: {\n gitRoot: { type: \"string\" },\n },\n },\n },\n },\n },\n },\n ],\n },\n },\n };\n\n const code = generatePythonSessionEventsCode(schema);\n\n expect(code).toContain('summary = from_union([from_none, from_str], obj.get(\"summary\"))');\n expect(code).toContain(\n 'tags = from_union([from_none, lambda x: from_list(from_str, x)], obj.get(\"tags\"))'\n );\n expect(code).toContain(\n 'context = from_union([from_none, SessionSyntheticDataContext.from_dict], obj.get(\"context\"))'\n );\n expect(code).not.toContain(\"lambda x: from_str(x)\");\n expect(code).not.toContain(\"lambda x: SessionSyntheticDataContext.from_dict(x)\");\n expect(code).not.toContain(\"from_list(lambda x: from_str(x), x)\");\n });\n\n it(\"preserves key shortened nested type names\", () => {\n const schema: JSONSchema7 = {\n definitions: {\n SessionEvent: {\n anyOf: [\n {\n type: \"object\",\n required: [\"type\", \"data\"],\n properties: {\n type: { const: \"permission.requested\" },\n data: {\n type: \"object\",\n required: [\"requestId\", \"permissionRequest\"],\n properties: {\n requestId: { type: \"string\" },\n permissionRequest: {\n anyOf: [\n {\n type: \"object\",\n required: [\n \"kind\",\n \"fullCommandText\",\n \"intention\",\n \"commands\",\n \"possiblePaths\",\n \"possibleUrls\",\n \"hasWriteFileRedirection\",\n \"canOfferSessionApproval\",\n ],\n properties: {\n kind: { const: \"shell\", type: \"string\" },\n fullCommandText: { type: \"string\" },\n intention: { type: \"string\" },\n commands: {\n type: \"array\",\n items: {\n type: \"object\",\n required: [\n \"identifier\",\n \"readOnly\",\n ],\n properties: {\n identifier: { type: \"string\" },\n readOnly: { type: \"boolean\" },\n },\n },\n },\n possiblePaths: {\n type: \"array\",\n items: { type: \"string\" },\n },\n possibleUrls: {\n type: \"array\",\n items: {\n type: \"object\",\n required: [\"url\"],\n properties: {\n url: { type: \"string\" },\n },\n },\n },\n hasWriteFileRedirection: {\n type: \"boolean\",\n },\n canOfferSessionApproval: {\n type: \"boolean\",\n },\n },\n },\n {\n type: \"object\",\n required: [\"kind\", \"fact\"],\n properties: {\n kind: { const: \"memory\", type: \"string\" },\n fact: { type: \"string\" },\n action: {\n type: \"string\",\n enum: [\"store\", \"vote\"],\n default: \"store\",\n },\n direction: {\n type: \"string\",\n enum: [\"upvote\", \"downvote\"],\n },\n },\n },\n ],\n },\n },\n },\n },\n },\n {\n type: \"object\",\n required: [\"type\", \"data\"],\n properties: {\n type: { const: \"elicitation.requested\" },\n data: {\n type: \"object\",\n properties: {\n requestedSchema: {\n type: \"object\",\n required: [\"type\", \"properties\"],\n properties: {\n type: { const: \"object\", type: \"string\" },\n properties: {\n type: \"object\",\n additionalProperties: {},\n },\n },\n },\n mode: {\n type: \"string\",\n enum: [\"form\", \"url\"],\n },\n },\n },\n },\n },\n {\n type: \"object\",\n required: [\"type\", \"data\"],\n properties: {\n type: { const: \"capabilities.changed\" },\n data: {\n type: \"object\",\n properties: {\n ui: {\n type: \"object\",\n properties: {\n elicitation: { type: \"boolean\" },\n },\n },\n },\n },\n },\n },\n ],\n },\n },\n };\n\n const code = generatePythonSessionEventsCode(schema);\n\n expect(code).toContain(\"class PermissionRequest:\");\n expect(code).toContain(\"class PermissionRequestShellCommand:\");\n expect(code).toContain(\"class PermissionRequestShellPossibleURL:\");\n expect(code).toContain(\"class PermissionRequestMemoryAction(Enum):\");\n expect(code).toContain(\"class PermissionRequestMemoryDirection(Enum):\");\n expect(code).toContain(\"class ElicitationRequestedSchema:\");\n expect(code).toContain(\"class ElicitationRequestedMode(Enum):\");\n expect(code).toContain(\"class CapabilitiesChangedUI:\");\n expect(code).not.toContain(\"class PermissionRequestedDataPermissionRequest:\");\n expect(code).not.toContain(\"class ElicitationRequestedDataRequestedSchema:\");\n expect(code).not.toContain(\"class CapabilitiesChangedDataUi:\");\n });\n\n it(\"keeps distinct enum types even when they share the same values\", () => {\n const schema: JSONSchema7 = {\n definitions: {\n SessionEvent: {\n anyOf: [\n {\n type: \"object\",\n required: [\"type\", \"data\"],\n properties: {\n type: { const: \"assistant.message\" },\n data: {\n type: \"object\",\n properties: {\n toolRequests: {\n type: \"array\",\n items: {\n type: \"object\",\n required: [\"toolCallId\", \"name\", \"type\"],\n properties: {\n toolCallId: { type: \"string\" },\n name: { type: \"string\" },\n type: {\n type: \"string\",\n enum: [\"function\", \"custom\"],\n },\n },\n },\n },\n },\n },\n },\n },\n {\n type: \"object\",\n required: [\"type\", \"data\"],\n properties: {\n type: { const: \"session.import_legacy\" },\n data: {\n type: \"object\",\n properties: {\n legacySession: {\n type: \"object\",\n properties: {\n chatMessages: {\n type: \"array\",\n items: {\n type: \"object\",\n properties: {\n toolCalls: {\n type: \"array\",\n items: {\n type: \"object\",\n properties: {\n type: {\n type: \"string\",\n enum: [\n \"function\",\n \"custom\",\n ],\n },\n },\n },\n },\n },\n },\n },\n },\n },\n },\n },\n },\n },\n ],\n },\n },\n };\n\n const code = generatePythonSessionEventsCode(schema);\n\n expect(code).toContain(\"class AssistantMessageToolRequestType(Enum):\");\n expect(code).toContain(\"type: AssistantMessageToolRequestType\");\n expect(code).toContain(\"parse_enum(AssistantMessageToolRequestType,\");\n expect(code).toContain(\n \"class SessionImportLegacyDataLegacySessionChatMessagesItemToolCallsItemType(Enum):\"\n );\n });\n});\n" }, { "path": "nodejs/test/session_fs_adapter.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { MemoryProvider } from \"@platformatic/vfs\";\nimport { describe, expect, it } from \"vitest\";\nimport { createSessionFsAdapter, type SessionFsProvider } from \"../src/index.js\";\n\ndescribe(\"SessionFsAdapter\", () => {\n it(\"should map all sessionFs handler operations\", async () => {\n const memoryProvider = new MemoryProvider();\n const sessionId = \"handler-session\";\n const sp = (path: string) => `/${sessionId}${path.startsWith(\"/\") ? path : \"/\" + path}`;\n\n const provider: SessionFsProvider = {\n async readFile(path) {\n return (await memoryProvider.readFile(sp(path), \"utf8\")) as string;\n },\n async writeFile(path, content) {\n await memoryProvider.writeFile(sp(path), content);\n },\n async appendFile(path, content) {\n await memoryProvider.appendFile(sp(path), content);\n },\n async exists(path) {\n return memoryProvider.exists(sp(path));\n },\n async stat(path) {\n const st = await memoryProvider.stat(sp(path));\n return {\n isFile: st.isFile(),\n isDirectory: st.isDirectory(),\n size: st.size,\n mtime: new Date(st.mtimeMs).toISOString(),\n birthtime: new Date(st.birthtimeMs).toISOString(),\n };\n },\n async mkdir(path, recursive, mode) {\n await memoryProvider.mkdir(sp(path), { recursive, mode });\n },\n async readdir(path) {\n return (await memoryProvider.readdir(sp(path))) as string[];\n },\n async readdirWithTypes(path) {\n const names = (await memoryProvider.readdir(sp(path))) as string[];\n return Promise.all(\n names.map(async (name) => {\n const st = await memoryProvider.stat(sp(`${path}/${name}`));\n return {\n name,\n type: st.isDirectory() ? (\"directory\" as const) : (\"file\" as const),\n };\n })\n );\n },\n async rm(path) {\n await memoryProvider.unlink(sp(path));\n },\n async rename(src, dest) {\n await memoryProvider.rename(sp(src), sp(dest));\n },\n };\n\n const handler = createSessionFsAdapter(provider);\n\n const mkdirError = await handler.mkdir({\n sessionId,\n path: \"/workspace/nested\",\n recursive: true,\n });\n expect(mkdirError).toBeUndefined();\n\n const writeError = await handler.writeFile({\n sessionId,\n path: \"/workspace/nested/file.txt\",\n content: \"hello\",\n });\n expect(writeError).toBeUndefined();\n\n const appendError = await handler.appendFile({\n sessionId,\n path: \"/workspace/nested/file.txt\",\n content: \" world\",\n });\n expect(appendError).toBeUndefined();\n\n const exists = await handler.exists({ sessionId, path: \"/workspace/nested/file.txt\" });\n expect(exists.exists).toBe(true);\n\n const stat = await handler.stat({ sessionId, path: \"/workspace/nested/file.txt\" });\n expect(stat.isFile).toBe(true);\n expect(stat.isDirectory).toBe(false);\n expect(stat.size).toBe(\"hello world\".length);\n expect(stat.error).toBeUndefined();\n\n const content = await handler.readFile({\n sessionId,\n path: \"/workspace/nested/file.txt\",\n });\n expect(content.content).toBe(\"hello world\");\n expect(content.error).toBeUndefined();\n\n const entries = await handler.readdir({ sessionId, path: \"/workspace/nested\" });\n expect(entries.entries).toContain(\"file.txt\");\n expect(entries.error).toBeUndefined();\n\n const typedEntries = await handler.readdirWithTypes({\n sessionId,\n path: \"/workspace/nested\",\n });\n expect(\n typedEntries.entries.some((entry) => entry.name === \"file.txt\" && entry.type === \"file\")\n ).toBe(true);\n expect(typedEntries.error).toBeUndefined();\n\n const renameError = await handler.rename({\n sessionId,\n src: \"/workspace/nested/file.txt\",\n dest: \"/workspace/nested/renamed.txt\",\n });\n expect(renameError).toBeUndefined();\n\n const oldPath = await handler.exists({\n sessionId,\n path: \"/workspace/nested/file.txt\",\n });\n expect(oldPath.exists).toBe(false);\n\n const renamedPath = await handler.readFile({\n sessionId,\n path: \"/workspace/nested/renamed.txt\",\n });\n expect(renamedPath.content).toBe(\"hello world\");\n\n const rmError = await handler.rm({\n sessionId,\n path: \"/workspace/nested/renamed.txt\",\n });\n expect(rmError).toBeUndefined();\n\n const removed = await handler.exists({\n sessionId,\n path: \"/workspace/nested/renamed.txt\",\n });\n expect(removed.exists).toBe(false);\n\n const missing = await handler.stat({\n sessionId,\n path: \"/workspace/nested/missing.txt\",\n });\n expect(missing.error?.code).toBe(\"ENOENT\");\n });\n\n it(\"converts provider exceptions to rpc errors\", async () => {\n function makeError(message: string, code?: string): Error {\n const err = new Error(message) as Error & { code?: string };\n if (code) {\n err.code = code;\n }\n return err;\n }\n\n function makeThrowingProvider(error: Error): SessionFsProvider {\n return {\n readFile: () => Promise.reject(error),\n writeFile: () => Promise.reject(error),\n appendFile: () => Promise.reject(error),\n exists: () => Promise.reject(error),\n stat: () => Promise.reject(error),\n mkdir: () => Promise.reject(error),\n readdir: () => Promise.reject(error),\n readdirWithTypes: () => Promise.reject(error),\n rm: () => Promise.reject(error),\n rename: () => Promise.reject(error),\n };\n }\n\n const enoent = makeError(\"missing file\", \"ENOENT\");\n const handler = createSessionFsAdapter(makeThrowingProvider(enoent));\n const sessionId = \"throw-session\";\n\n function assertEnoent(error: { code: string; message: string } | undefined) {\n expect(error).toBeDefined();\n expect(error!.code).toBe(\"ENOENT\");\n expect(error!.message.toLowerCase()).toContain(\"missing\");\n }\n\n assertEnoent((await handler.readFile({ sessionId, path: \"missing.txt\" })).error);\n assertEnoent(\n await handler.writeFile({ sessionId, path: \"missing.txt\", content: \"content\" })\n );\n assertEnoent(\n await handler.appendFile({ sessionId, path: \"missing.txt\", content: \"content\" })\n );\n\n const exists = await handler.exists({ sessionId, path: \"missing.txt\" });\n expect(exists.exists).toBe(false);\n\n assertEnoent((await handler.stat({ sessionId, path: \"missing.txt\" })).error);\n assertEnoent(await handler.mkdir({ sessionId, path: \"missing-dir\" }));\n assertEnoent((await handler.readdir({ sessionId, path: \"missing-dir\" })).error);\n assertEnoent((await handler.readdirWithTypes({ sessionId, path: \"missing-dir\" })).error);\n assertEnoent(await handler.rm({ sessionId, path: \"missing.txt\" }));\n assertEnoent(await handler.rename({ sessionId, src: \"missing.txt\", dest: \"dest.txt\" }));\n\n const unknownProvider = createSessionFsAdapter(makeThrowingProvider(makeError(\"bad path\")));\n const unknownError = await unknownProvider.writeFile({\n sessionId,\n path: \"bad.txt\",\n content: \"content\",\n });\n expect(unknownError).toBeDefined();\n expect(unknownError!.code).toBe(\"UNKNOWN\");\n });\n});\n" }, { "path": "nodejs/test/telemetry.test.ts", "content": "/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { describe, expect, it } from \"vitest\";\nimport { getTraceContext } from \"../src/telemetry.js\";\nimport type { TraceContextProvider } from \"../src/types.js\";\n\ndescribe(\"telemetry\", () => {\n describe(\"getTraceContext\", () => {\n it(\"returns empty object when no provider is given\", async () => {\n const ctx = await getTraceContext();\n expect(ctx).toEqual({});\n });\n\n it(\"returns empty object when provider is undefined\", async () => {\n const ctx = await getTraceContext(undefined);\n expect(ctx).toEqual({});\n });\n\n it(\"calls provider and returns trace context\", async () => {\n const provider: TraceContextProvider = () => ({\n traceparent: \"00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01\",\n tracestate: \"congo=t61rcWkgMzE\",\n });\n const ctx = await getTraceContext(provider);\n expect(ctx).toEqual({\n traceparent: \"00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01\",\n tracestate: \"congo=t61rcWkgMzE\",\n });\n });\n\n it(\"supports async providers\", async () => {\n const provider: TraceContextProvider = async () => ({\n traceparent: \"00-abcdef1234567890abcdef1234567890-1234567890abcdef-01\",\n });\n const ctx = await getTraceContext(provider);\n expect(ctx).toEqual({\n traceparent: \"00-abcdef1234567890abcdef1234567890-1234567890abcdef-01\",\n });\n });\n\n it(\"returns empty object when provider throws\", async () => {\n const provider: TraceContextProvider = () => {\n throw new Error(\"boom\");\n };\n const ctx = await getTraceContext(provider);\n expect(ctx).toEqual({});\n });\n\n it(\"returns empty object when async provider rejects\", async () => {\n const provider: TraceContextProvider = async () => {\n throw new Error(\"boom\");\n };\n const ctx = await getTraceContext(provider);\n expect(ctx).toEqual({});\n });\n\n it(\"returns empty object when provider returns null\", async () => {\n const provider = (() => null) as unknown as TraceContextProvider;\n const ctx = await getTraceContext(provider);\n expect(ctx).toEqual({});\n });\n });\n\n describe(\"TelemetryConfig env var mapping\", () => {\n it(\"sets correct env vars for full telemetry config\", async () => {\n const telemetry = {\n otlpEndpoint: \"http://localhost:4318\",\n filePath: \"/tmp/traces.jsonl\",\n exporterType: \"otlp-http\",\n sourceName: \"my-app\",\n captureContent: true,\n };\n\n const env: Record = {};\n\n if (telemetry) {\n const t = telemetry;\n env.COPILOT_OTEL_ENABLED = \"true\";\n if (t.otlpEndpoint !== undefined) env.OTEL_EXPORTER_OTLP_ENDPOINT = t.otlpEndpoint;\n if (t.filePath !== undefined) env.COPILOT_OTEL_FILE_EXPORTER_PATH = t.filePath;\n if (t.exporterType !== undefined) env.COPILOT_OTEL_EXPORTER_TYPE = t.exporterType;\n if (t.sourceName !== undefined) env.COPILOT_OTEL_SOURCE_NAME = t.sourceName;\n if (t.captureContent !== undefined)\n env.OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT = String(\n t.captureContent\n );\n }\n\n expect(env).toEqual({\n COPILOT_OTEL_ENABLED: \"true\",\n OTEL_EXPORTER_OTLP_ENDPOINT: \"http://localhost:4318\",\n COPILOT_OTEL_FILE_EXPORTER_PATH: \"/tmp/traces.jsonl\",\n COPILOT_OTEL_EXPORTER_TYPE: \"otlp-http\",\n COPILOT_OTEL_SOURCE_NAME: \"my-app\",\n OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT: \"true\",\n });\n });\n\n it(\"only sets COPILOT_OTEL_ENABLED for empty telemetry config\", async () => {\n const telemetry = {};\n const env: Record = {};\n\n if (telemetry) {\n const t = telemetry as any;\n env.COPILOT_OTEL_ENABLED = \"true\";\n if (t.otlpEndpoint !== undefined) env.OTEL_EXPORTER_OTLP_ENDPOINT = t.otlpEndpoint;\n if (t.filePath !== undefined) env.COPILOT_OTEL_FILE_EXPORTER_PATH = t.filePath;\n if (t.exporterType !== undefined) env.COPILOT_OTEL_EXPORTER_TYPE = t.exporterType;\n if (t.sourceName !== undefined) env.COPILOT_OTEL_SOURCE_NAME = t.sourceName;\n if (t.captureContent !== undefined)\n env.OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT = String(\n t.captureContent\n );\n }\n\n expect(env).toEqual({\n COPILOT_OTEL_ENABLED: \"true\",\n });\n });\n\n it(\"converts captureContent false to string 'false'\", async () => {\n const telemetry = { captureContent: false };\n const env: Record = {};\n\n env.COPILOT_OTEL_ENABLED = \"true\";\n if (telemetry.captureContent !== undefined)\n env.OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT = String(\n telemetry.captureContent\n );\n\n expect(env.OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT).toBe(\"false\");\n });\n });\n});\n" }, { "path": "nodejs/tsconfig.json", "content": "{\n \"compilerOptions\": {\n \"target\": \"ES2022\",\n \"module\": \"ES2022\",\n \"lib\": [\"ES2022\"],\n \"moduleResolution\": \"node\",\n \"outDir\": \"./dist\",\n \"declaration\": true,\n \"declarationMap\": false,\n \"emitDeclarationOnly\": true,\n \"strict\": true,\n \"esModuleInterop\": true,\n \"skipLibCheck\": true,\n \"forceConsistentCasingInFileNames\": true,\n \"resolveJsonModule\": true\n },\n \"include\": [\"src/**/*\"],\n \"exclude\": [\"node_modules\", \"dist\"]\n}\n" }, { "path": "nodejs/vitest.config.ts", "content": "import { defineConfig } from \"vitest/config\";\n\nexport default defineConfig({\n test: {\n globals: true,\n environment: \"node\",\n testTimeout: 30000, // 30 seconds for integration tests\n hookTimeout: 30000,\n teardownTimeout: 10000,\n isolate: true, // Run each test file in isolation\n pool: \"forks\", // Use process forking for better isolation\n // Exclude our ad-hoc test files that aren't vitest-based\n exclude: [\n \"**/node_modules/**\",\n \"**/dist/**\",\n \"**/*.d.ts\",\n \"**/basic-test.ts\", // Old manual test\n ],\n },\n});\n" }, { "path": "python/.gitignore", "content": "# Byte-compiled / optimized / DLL files\n__pycache__/\n*.py[cod]\n*$py.class\n\n# C extensions\n*.so\n\n# Distribution / packaging\n.Python\nbuild/\ndevelop-eggs/\ndist/\ndownloads/\neggs/\n.eggs/\nlib/\nlib64/\nparts/\nsdist/\nvar/\nwheels/\nshare/python-wheels/\n*.egg-info/\n.installed.cfg\n*.egg\nMANIFEST\n\n# PyInstaller\n# Usually these files are written by a python script from a template\n# before PyInstaller builds the exe, so as to inject date/other infos into it.\n*.manifest\n*.spec\n\n# Installer logs\npip-log.txt\npip-delete-this-directory.txt\n\n# Unit test / coverage reports\nhtmlcov/\n.tox/\n.nox/\n.coverage\n.coverage.*\n.cache\nnosetests.xml\ncoverage.xml\n*.cover\n*.py,cover\n.hypothesis/\n.pytest_cache/\ncover/\n\n# Translations\n*.mo\n*.pot\n\n# Django stuff:\n*.log\nlocal_settings.py\ndb.sqlite3\ndb.sqlite3-journal\n\n# Flask stuff:\ninstance/\n.webassets-cache\n\n# Scrapy stuff:\n.scrapy\n\n# Sphinx documentation\ndocs/_build/\n\n# PyBuilder\n.pybuilder/\ntarget/\n\n# Jupyter Notebook\n.ipynb_checkpoints\n\n# IPython\nprofile_default/\nipython_config.py\n\n# pyenv\n# For a library or package, you might want to ignore these files since the code is\n# intended to run in multiple environments; otherwise, check them in:\n# .python-version\n\n# pipenv\n# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.\n# However, in case of collaboration, if having platform-specific dependencies or dependencies\n# having no cross-platform support, pipenv may install dependencies that don't work, or not\n# install all needed dependencies.\n#Pipfile.lock\n\n# poetry\n# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.\n# This is especially recommended for binary packages to ensure reproducibility, and is more\n# commonly ignored for libraries.\n# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control\n#poetry.lock\n\n# pdm\n# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.\n#pdm.lock\n# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it\n# in version control.\n# https://pdm.fming.dev/#use-with-ide\n.pdm.toml\n\n# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm\n__pypackages__/\n\n# Celery stuff\ncelerybeat-schedule\ncelerybeat.pid\n\n# SageMath parsed files\n*.sage.py\n\n# Environments\n.env\n.venv\nenv/\nvenv/\nENV/\nenv.bak/\nvenv.bak/\n\n# Spyder project settings\n.spyderproject\n.spyproject\n\n# Rope project settings\n.ropeproject\n\n# mkdocs documentation\n/site\n\n# mypy\n.mypy_cache/\n.dmypy.json\ndmypy.json\n\n# Pyre type checker\n.pyre/\n\n# pytype static type analyzer\n.pytype/\n\n# Cython debug symbols\ncython_debug/\n\n# PyCharm\n# JetBrains specific template is maintained in a separate JetBrains.gitignore that can\n# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore\n# and can be added to the global gitignore or merged into this file. For a more nuclear\n# option (not recommended) you can uncomment the following to ignore the entire idea folder.\n#.idea/\n\n# Ruff and ty cache\n.ruff_cache/\n.ty_cache/\n\n# uv\nuv.lock\n\n# Build script caches\n.cli-cache/\n.build-temp/\n\n# Bundled CLI binary (only in platform wheels, not in repo)\ncopilot/bin/\n" }, { "path": "python/README.md", "content": "# Copilot Python SDK\n\nPython SDK for programmatic control of GitHub Copilot CLI via JSON-RPC.\n\n> **Note:** This SDK is in public preview and may change in breaking ways.\n\n## Installation\n\n```bash\npip install -e \".[telemetry,dev]\"\n# or\nuv pip install -e \".[telemetry,dev]\"\n```\n\n## Run the Sample\n\nTry the interactive chat sample (from the repo root):\n\n```bash\ncd python/samples\npython chat.py\n```\n\n## Quick Start\n\n```python\nimport asyncio\n\nfrom copilot import CopilotClient\nfrom copilot.generated.session_events import AssistantMessageData, SessionIdleData\n\nasync def main():\n # Client automatically starts on enter and cleans up on exit\n async with CopilotClient() as client:\n # Create a session with automatic cleanup\n async with await client.create_session(model=\"gpt-5\") as session:\n # Wait for response using session.idle event\n done = asyncio.Event()\n\n def on_event(event):\n match event.data:\n case AssistantMessageData() as data:\n print(data.content)\n case SessionIdleData():\n done.set()\n\n session.on(on_event)\n\n # Send a message and wait for completion\n await session.send(\"What is 2+2?\")\n await done.wait()\n\nasyncio.run(main())\n```\n\n### Manual Resource Management\n\nIf you need more control over the lifecycle, you can call `start()`, `stop()`, and `disconnect()` manually:\n\n```python\nimport asyncio\n\nfrom copilot import CopilotClient\nfrom copilot.generated.session_events import AssistantMessageData, SessionIdleData\nfrom copilot.session import PermissionHandler\n\nasync def main():\n client = CopilotClient()\n await client.start()\n\n # Create a session (on_permission_request is required)\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model=\"gpt-5\",\n )\n\n done = asyncio.Event()\n\n def on_event(event):\n match event.data:\n case AssistantMessageData() as data:\n print(data.content)\n case SessionIdleData():\n done.set()\n\n session.on(on_event)\n await session.send(\"What is 2+2?\")\n await done.wait()\n\n # Clean up manually\n await session.disconnect()\n await client.stop()\n\nasyncio.run(main())\n```\n\n## Features\n\n- ✅ Full JSON-RPC protocol support\n- ✅ stdio and TCP transports\n- ✅ Real-time streaming events\n- ✅ Session history with `get_messages()`\n- ✅ Type hints throughout\n- ✅ Async/await native\n- ✅ Async context manager support for automatic resource cleanup\n\n## API Reference\n\n### CopilotClient\n\n```python\nfrom copilot import CopilotClient, SubprocessConfig\nfrom copilot.session import PermissionHandler\n\nasync with CopilotClient() as client:\n async with await client.create_session(model=\"gpt-5\") as session:\n def on_event(event):\n print(f\"Event: {event.type}\")\n\n session.on(on_event)\n await session.send(\"Hello!\")\n\n # ... wait for events ...\n```\n\n> **Note:** For manual lifecycle management, see [Manual Resource Management](#manual-resource-management) above.\n\n```python\nfrom copilot import CopilotClient, ExternalServerConfig\n\n# Connect to an existing CLI server\nclient = CopilotClient(ExternalServerConfig(url=\"localhost:3000\"))\n```\n\n**CopilotClient Constructor:**\n\n```python\nCopilotClient(\n config=None, # SubprocessConfig | ExternalServerConfig | None\n *,\n auto_start=True, # auto-start server on first use\n on_list_models=None, # custom handler for list_models()\n)\n```\n\n**SubprocessConfig** — spawn a local CLI process:\n\n- `cli_path` (str | None): Path to CLI executable (default: `COPILOT_CLI_PATH` env var, or bundled binary)\n- `cli_args` (list[str]): Extra arguments for the CLI executable\n- `cwd` (str | None): Working directory for CLI process (default: current dir)\n- `use_stdio` (bool): Use stdio transport instead of TCP (default: True)\n- `port` (int): Server port for TCP mode (default: 0 for random)\n- `log_level` (str): Log level (default: \"info\")\n- `env` (dict | None): Environment variables for the CLI process\n- `github_token` (str | None): GitHub token for authentication. When provided, takes priority over other auth methods.\n- `use_logged_in_user` (bool | None): Whether to use logged-in user for authentication (default: True, but False when `github_token` is provided).\n- `telemetry` (dict | None): OpenTelemetry configuration for the CLI process. Providing this enables telemetry — no separate flag needed. See [Telemetry](#telemetry) below.\n\n**ExternalServerConfig** — connect to an existing CLI server:\n\n- `url` (str): Server URL (e.g., `\"localhost:8080\"`, `\"http://127.0.0.1:9000\"`, or just `\"8080\"`).\n\n**`CopilotClient.create_session()`:**\n\nThese are passed as keyword arguments to `create_session()`:\n\n- `model` (str): Model to use (\"gpt-5\", \"claude-sonnet-4.5\", etc.). **Required when using custom provider.**\n- `reasoning_effort` (str): Reasoning effort level for models that support it (\"low\", \"medium\", \"high\", \"xhigh\"). Use `list_models()` to check which models support this option.\n- `session_id` (str): Custom session ID\n- `tools` (list): Custom tools exposed to the CLI\n- `system_message` (SystemMessageConfig): System message configuration\n- `streaming` (bool): Enable streaming delta events\n- `provider` (ProviderConfig): Custom API provider configuration (BYOK). See [Custom Providers](#custom-providers) section.\n- `infinite_sessions` (InfiniteSessionConfig): Automatic context compaction configuration\n- `on_permission_request` (callable): **Required.** Handler called before each tool execution to approve or deny it. Use `PermissionHandler.approve_all` to allow everything, or provide a custom function for fine-grained control. See [Permission Handling](#permission-handling) section.\n- `on_user_input_request` (callable): Handler for user input requests from the agent (enables ask_user tool). See [User Input Requests](#user-input-requests) section.\n- `hooks` (SessionHooks): Hook handlers for session lifecycle events. See [Session Hooks](#session-hooks) section.\n\n**Session Lifecycle Methods:**\n\n```python\n# Get the session currently displayed in TUI (TUI+server mode only)\nsession_id = await client.get_foreground_session_id()\n\n# Request TUI to display a specific session (TUI+server mode only)\nawait client.set_foreground_session_id(\"session-123\")\n\n# Subscribe to all lifecycle events\ndef on_lifecycle(event):\n print(f\"{event.type}: {event.sessionId}\")\n\nunsubscribe = client.on(on_lifecycle)\n\n# Subscribe to specific event type\nunsubscribe = client.on(\"session.foreground\", lambda e: print(f\"Foreground: {e.sessionId}\"))\n\n# Later, to stop receiving events:\nunsubscribe()\n```\n\n**Lifecycle Event Types:**\n\n- `session.created` - A new session was created\n- `session.deleted` - A session was deleted\n- `session.updated` - A session was updated\n- `session.foreground` - A session became the foreground session in TUI\n- `session.background` - A session is no longer the foreground session\n\n### Tools\n\nDefine tools with automatic JSON schema generation using the `@define_tool` decorator and Pydantic models:\n\n```python\nfrom pydantic import BaseModel, Field\nfrom copilot import CopilotClient, define_tool\n\nclass LookupIssueParams(BaseModel):\n id: str = Field(description=\"Issue identifier\")\n\n@define_tool(description=\"Fetch issue details from our tracker\")\nasync def lookup_issue(params: LookupIssueParams) -> str:\n issue = await fetch_issue(params.id)\n return issue.summary\n\nasync with await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model=\"gpt-5\",\n tools=[lookup_issue],\n) as session:\n ...\n```\n\n> **Note:** When using `from __future__ import annotations`, define Pydantic models at module level (not inside functions).\n\n**Low-level API (without Pydantic):**\n\nFor users who prefer manual schema definition:\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.tools import Tool, ToolInvocation, ToolResult\nfrom copilot.session import PermissionHandler\n\nasync def lookup_issue(invocation: ToolInvocation) -> ToolResult:\n issue_id = invocation.arguments[\"id\"]\n issue = await fetch_issue(issue_id)\n return ToolResult(\n text_result_for_llm=issue.summary,\n result_type=\"success\",\n session_log=f\"Fetched issue {issue_id}\",\n )\n\nasync with await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model=\"gpt-5\",\n tools=[\n Tool(\n name=\"lookup_issue\",\n description=\"Fetch issue details from our tracker\",\n parameters={\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"string\", \"description\": \"Issue identifier\"},\n },\n \"required\": [\"id\"],\n },\n handler=lookup_issue,\n )\n ],\n) as session:\n ...\n```\n\nThe SDK automatically handles `tool.call`, executes your handler (sync or async), and responds with the final result when the tool completes.\n\n#### Overriding Built-in Tools\n\nIf you register a tool with the same name as a built-in CLI tool (e.g. `edit_file`, `read_file`), the SDK will throw an error unless you explicitly opt in by setting `overrides_built_in_tool=True`. This flag signals that you intend to replace the built-in tool with your custom implementation.\n\n```python\nclass EditFileParams(BaseModel):\n path: str = Field(description=\"File path\")\n content: str = Field(description=\"New file content\")\n\n@define_tool(name=\"edit_file\", description=\"Custom file editor with project-specific validation\", overrides_built_in_tool=True)\nasync def edit_file(params: EditFileParams) -> str:\n # your logic\n```\n\n#### Skipping Permission Prompts\n\nSet `skip_permission=True` on a tool definition to allow it to execute without triggering a permission prompt:\n\n```python\n@define_tool(name=\"safe_lookup\", description=\"A read-only lookup that needs no confirmation\", skip_permission=True)\nasync def safe_lookup(params: LookupParams) -> str:\n # your logic\n```\n\n## Image Support\n\nThe SDK supports image attachments via the `attachments` parameter. You can attach images by providing their file path, or by passing base64-encoded data directly using a blob attachment:\n\n```python\n# File attachment — runtime reads from disk\nawait session.send(\n \"What's in this image?\",\n attachments=[\n {\n \"type\": \"file\",\n \"path\": \"/path/to/image.jpg\",\n }\n ],\n)\n\n# Blob attachment — provide base64 data directly\nawait session.send(\n \"What's in this image?\",\n attachments=[\n {\n \"type\": \"blob\",\n \"data\": base64_image_data,\n \"mimeType\": \"image/png\",\n }\n ],\n)\n```\n\nSupported image formats include JPG, PNG, GIF, and other common image types. The agent's `view` tool can also read images directly from the filesystem, so you can also ask questions like:\n\n```python\nawait session.send(\"What does the most recent jpg in this directory portray?\")\n```\n\n## Streaming\n\nEnable streaming to receive assistant response chunks as they're generated:\n\n```python\nimport asyncio\n\nfrom copilot import CopilotClient\nfrom copilot.generated.session_events import (\n AssistantMessageData,\n AssistantMessageDeltaData,\n AssistantReasoningData,\n AssistantReasoningDeltaData,\n SessionIdleData,\n)\nfrom copilot.session import PermissionHandler\n\nasync def main():\n async with CopilotClient() as client:\n async with await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model=\"gpt-5\",\n streaming=True,\n ) as session:\n # Use asyncio.Event to wait for completion\n done = asyncio.Event()\n\n def on_event(event):\n match event.data:\n case AssistantMessageDeltaData() as data:\n # Streaming message chunk - print incrementally\n delta = data.delta_content or \"\"\n print(delta, end=\"\", flush=True)\n case AssistantReasoningDeltaData() as data:\n # Streaming reasoning chunk (if model supports reasoning)\n delta = data.delta_content or \"\"\n print(delta, end=\"\", flush=True)\n case AssistantMessageData() as data:\n # Final message - complete content\n print(\"\\n--- Final message ---\")\n print(data.content)\n case AssistantReasoningData() as data:\n # Final reasoning content (if model supports reasoning)\n print(\"--- Reasoning ---\")\n print(data.content)\n case SessionIdleData():\n # Session finished processing\n done.set()\n\n session.on(on_event)\n await session.send(\"Tell me a short story\")\n await done.wait() # Wait for streaming to complete\n\nasyncio.run(main())\n```\n\nWhen `streaming=True`:\n\n- `assistant.message_delta` events are sent with `delta_content` containing incremental text\n- `assistant.reasoning_delta` events are sent with `delta_content` for reasoning/chain-of-thought (model-dependent)\n- Accumulate `delta_content` values to build the full response progressively\n- The final `assistant.message` and `assistant.reasoning` events contain the complete content\n\nNote: `assistant.message` and `assistant.reasoning` (final events) are always sent regardless of streaming setting.\n\n## Infinite Sessions\n\nBy default, sessions use **infinite sessions** which automatically manage context window limits through background compaction and persist state to a workspace directory.\n\n```python\n# Default: infinite sessions enabled with default thresholds\nasync with await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model=\"gpt-5\",\n) as session:\n # Access the workspace path for checkpoints and files\n print(session.workspace_path)\n # => ~/.copilot/session-state/{session_id}/\n\n# Custom thresholds\nasync with await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model=\"gpt-5\",\n infinite_sessions={\n \"enabled\": True,\n \"background_compaction_threshold\": 0.80, # Start compacting at 80% context usage\n \"buffer_exhaustion_threshold\": 0.95, # Block at 95% until compaction completes\n },\n) as session:\n ...\n\n# Disable infinite sessions\nasync with await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model=\"gpt-5\",\n infinite_sessions={\"enabled\": False},\n) as session:\n ...\n```\n\nWhen enabled, sessions emit compaction events:\n\n- `session.compaction_start` - Background compaction started\n- `session.compaction_complete` - Compaction finished (includes token counts)\n\n## Custom Providers\n\nThe SDK supports custom OpenAI-compatible API providers (BYOK - Bring Your Own Key), including local providers like Ollama. When using a custom provider, you must specify the `model` explicitly.\n\n**ProviderConfig fields:**\n\n- `type` (str): Provider type - `\"openai\"`, `\"azure\"`, or `\"anthropic\"` (default: `\"openai\"`)\n- `base_url` (str): API endpoint URL (required)\n- `api_key` (str): API key (optional for local providers like Ollama)\n- `bearer_token` (str): Bearer token for authentication (takes precedence over `api_key`)\n- `wire_api` (str): API format for OpenAI/Azure - `\"completions\"` or `\"responses\"` (default: `\"completions\"`)\n- `azure` (dict): Azure-specific options with `api_version` (default: `\"2024-10-21\"`)\n\n**Example with Ollama:**\n\n```python\nasync with await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model=\"deepseek-coder-v2:16b\", # Required when using custom provider\n provider={\n \"type\": \"openai\",\n \"base_url\": \"http://localhost:11434/v1\", # Ollama endpoint\n # api_key not required for Ollama\n },\n) as session:\n await session.send(\"Hello!\")\n```\n\n**Example with custom OpenAI-compatible API:**\n\n```python\nimport os\n\nasync with await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model=\"gpt-4\",\n provider={\n \"type\": \"openai\",\n \"base_url\": \"https://my-api.example.com/v1\",\n \"api_key\": os.environ[\"MY_API_KEY\"],\n },\n) as session:\n ...\n```\n\n**Example with Azure OpenAI:**\n\n```python\nimport os\n\nasync with await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model=\"gpt-4\",\n provider={\n \"type\": \"azure\", # Must be \"azure\" for Azure endpoints, NOT \"openai\"\n \"base_url\": \"https://my-resource.openai.azure.com\", # Just the host, no path\n \"api_key\": os.environ[\"AZURE_OPENAI_KEY\"],\n \"azure\": {\n \"api_version\": \"2024-10-21\",\n },\n },\n) as session:\n ...\n```\n\n> **Important notes:**\n>\n> - When using a custom provider, the `model` parameter is **required**. The SDK will throw an error if no model is specified.\n> - For Azure OpenAI endpoints (`*.openai.azure.com`), you **must** use `type: \"azure\"`, not `type: \"openai\"`.\n> - The `base_url` should be just the host (e.g., `https://my-resource.openai.azure.com`). Do **not** include `/openai/v1` in the URL - the SDK handles path construction automatically.\n\n## Telemetry\n\nThe SDK supports OpenTelemetry for distributed tracing. Provide a `telemetry` config to enable trace export and automatic W3C Trace Context propagation.\n\n```python\nfrom copilot import CopilotClient, SubprocessConfig\n\nclient = CopilotClient(SubprocessConfig(\n telemetry={\n \"otlp_endpoint\": \"http://localhost:4318\",\n },\n))\n```\n\n**TelemetryConfig options:**\n\n- `otlp_endpoint` (str): OTLP HTTP endpoint URL\n- `file_path` (str): File path for JSON-lines trace output\n- `exporter_type` (str): `\"otlp-http\"` or `\"file\"`\n- `source_name` (str): Instrumentation scope name\n- `capture_content` (bool): Whether to capture message content\n\nTrace context (`traceparent`/`tracestate`) is automatically propagated between the SDK and CLI on `create_session`, `resume_session`, and `send` calls, and inbound when the CLI invokes tool handlers.\n\nInstall with telemetry extras: `pip install copilot-sdk[telemetry]` (provides `opentelemetry-api`)\n\n## Permission Handling\n\nAn `on_permission_request` handler is **required** whenever you create or resume a session. The handler is called before the agent executes each tool (file writes, shell commands, custom tools, etc.) and must return a decision.\n\n### Approve All (simplest)\n\nUse the built-in `PermissionHandler.approve_all` helper to allow every tool call without any checks:\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionHandler\n\nsession = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model=\"gpt-5\",\n)\n```\n\n### Custom Permission Handler\n\nProvide your own function to inspect each request and apply custom logic (sync or async):\n\n```python\nfrom copilot.session import PermissionRequestResult\nfrom copilot.generated.session_events import PermissionRequest\n\ndef on_permission_request(\n request: PermissionRequest, invocation: dict\n) -> PermissionRequestResult:\n # request.kind — what type of operation is being requested:\n # \"shell\" — executing a shell command\n # \"write\" — writing or editing a file\n # \"read\" — reading a file\n # \"mcp\" — calling an MCP tool\n # \"custom-tool\" — calling one of your registered tools\n # \"url\" — fetching a URL\n # \"memory\" — accessing or updating session/workspace memory\n # \"hook\" — invoking a registered hook\n # request.tool_call_id — the tool call that triggered this request\n # request.tool_name — name of the tool (for custom-tool / mcp)\n # request.file_name — file being written (for write)\n # request.full_command_text — full shell command (for shell)\n\n if request.kind.value == \"shell\":\n # Deny shell commands\n return PermissionRequestResult(kind=\"denied-interactively-by-user\")\n\n return PermissionRequestResult(kind=\"approved\")\n\nsession = await client.create_session(\n on_permission_request=on_permission_request,\n model=\"gpt-5\",\n)\n```\n\nAsync handlers are also supported:\n\n```python\nasync def on_permission_request(\n request: PermissionRequest, invocation: dict\n) -> PermissionRequestResult:\n # Simulate an async approval check (e.g., prompting a user over a network)\n await asyncio.sleep(0)\n return PermissionRequestResult(kind=\"approved\")\n```\n\n### Permission Result Kinds\n\n| `kind` value | Meaning |\n| ----------------------------------------------------------- | ---------------------------------------------------------------------------------------- |\n| `\"approved\"` | Allow the tool to run |\n| `\"denied-interactively-by-user\"` | User explicitly denied the request |\n| `\"denied-no-approval-rule-and-could-not-request-from-user\"` | No approval rule matched and user could not be asked (default when no kind is specified) |\n| `\"denied-by-rules\"` | Denied by a policy rule |\n| `\"denied-by-content-exclusion-policy\"` | Denied due to a content exclusion policy |\n| `\"no-result\"` | Leave the request unanswered (not allowed for protocol v2 permission requests) |\n\n### Resuming Sessions\n\nPass `on_permission_request` when resuming a session too — it is required:\n\n```python\nsession = await client.resume_session(\n \"session-id\",\n on_permission_request=PermissionHandler.approve_all,\n)\n```\n\n### Per-Tool Skip Permission\n\nTo let a specific custom tool bypass the permission prompt entirely, set `skip_permission=True` on the tool definition. See [Skipping Permission Prompts](#skipping-permission-prompts) under Tools.\n\n## User Input Requests\n\nEnable the agent to ask questions to the user using the `ask_user` tool by providing an `on_user_input_request` handler:\n\n```python\nasync def handle_user_input(request, invocation):\n # request[\"question\"] - The question to ask\n # request.get(\"choices\") - Optional list of choices for multiple choice\n # request.get(\"allowFreeform\", True) - Whether freeform input is allowed\n\n print(f\"Agent asks: {request['question']}\")\n if request.get(\"choices\"):\n print(f\"Choices: {', '.join(request['choices'])}\")\n\n # Return the user's response\n return {\n \"answer\": \"User's answer here\",\n \"wasFreeform\": True, # Whether the answer was freeform (not from choices)\n }\n\nasync with await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model=\"gpt-5\",\n on_user_input_request=handle_user_input,\n) as session:\n ...\n```\n\n## Session Hooks\n\nHook into session lifecycle events by providing handlers in the `hooks` configuration:\n\n```python\nasync def on_pre_tool_use(input, invocation):\n print(f\"About to run tool: {input['toolName']}\")\n # Return permission decision and optionally modify args\n return {\n \"permissionDecision\": \"allow\", # \"allow\", \"deny\", or \"ask\"\n \"modifiedArgs\": input.get(\"toolArgs\"), # Optionally modify tool arguments\n \"additionalContext\": \"Extra context for the model\",\n }\n\nasync def on_post_tool_use(input, invocation):\n print(f\"Tool {input['toolName']} completed\")\n return {\n \"additionalContext\": \"Post-execution notes\",\n }\n\nasync def on_user_prompt_submitted(input, invocation):\n print(f\"User prompt: {input['prompt']}\")\n return {\n \"modifiedPrompt\": input[\"prompt\"], # Optionally modify the prompt\n }\n\nasync def on_session_start(input, invocation):\n print(f\"Session started from: {input['source']}\") # \"startup\", \"resume\", \"new\"\n return {\n \"additionalContext\": \"Session initialization context\",\n }\n\nasync def on_session_end(input, invocation):\n print(f\"Session ended: {input['reason']}\")\n\nasync def on_error_occurred(input, invocation):\n print(f\"Error in {input['errorContext']}: {input['error']}\")\n return {\n \"errorHandling\": \"retry\", # \"retry\", \"skip\", or \"abort\"\n }\n\nasync with await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model=\"gpt-5\",\n hooks={\n \"on_pre_tool_use\": on_pre_tool_use,\n \"on_post_tool_use\": on_post_tool_use,\n \"on_user_prompt_submitted\": on_user_prompt_submitted,\n \"on_session_start\": on_session_start,\n \"on_session_end\": on_session_end,\n \"on_error_occurred\": on_error_occurred,\n },\n) as session:\n ...\n```\n\n**Available hooks:**\n\n- `on_pre_tool_use` - Intercept tool calls before execution. Can allow/deny or modify arguments.\n- `on_post_tool_use` - Process tool results after execution. Can modify results or add context.\n- `on_user_prompt_submitted` - Intercept user prompts. Can modify the prompt before processing.\n- `on_session_start` - Run logic when a session starts or resumes.\n- `on_session_end` - Cleanup or logging when session ends.\n- `on_error_occurred` - Handle errors with retry/skip/abort strategies.\n\n## Commands\n\nRegister slash commands that users can invoke from the CLI TUI. When the user types `/commandName`, the SDK dispatches the event to your handler.\n\n```python\nfrom copilot.session import CommandDefinition, CommandContext, PermissionHandler\n\nasync def handle_deploy(ctx: CommandContext) -> None:\n print(f\"Deploying with args: {ctx.args}\")\n # ctx.session_id — the session where the command was invoked\n # ctx.command — full command text (e.g. \"/deploy production\")\n # ctx.command_name — command name without leading / (e.g. \"deploy\")\n # ctx.args — raw argument string (e.g. \"production\")\n\nasync with await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n commands=[\n CommandDefinition(\n name=\"deploy\",\n description=\"Deploy the app\",\n handler=handle_deploy,\n ),\n CommandDefinition(\n name=\"rollback\",\n description=\"Rollback to previous version\",\n handler=lambda ctx: print(\"Rolling back...\"),\n ),\n ],\n) as session:\n ...\n```\n\nCommands can also be provided when resuming a session via `resume_session(commands=[...])`.\n\n## UI Elicitation\n\nThe `session.ui` API provides convenience methods for asking the user questions through interactive dialogs. These methods are only available when the CLI host supports elicitation — check `session.capabilities` before calling.\n\n### Capability Check\n\n```python\nui_caps = session.capabilities.get(\"ui\", {})\nif ui_caps.get(\"elicitation\"):\n # Safe to call session.ui methods\n ...\n```\n\n### Confirm\n\nShows a yes/no confirmation dialog:\n\n```python\nok = await session.ui.confirm(\"Deploy to production?\")\nif ok:\n print(\"Deploying...\")\n```\n\n### Select\n\nShows a selection dialog with a list of options:\n\n```python\nenv = await session.ui.select(\"Choose environment:\", [\"staging\", \"production\", \"dev\"])\nif env:\n print(f\"Selected: {env}\")\n```\n\n### Input\n\nShows a text input dialog with optional constraints:\n\n```python\nname = await session.ui.input(\"Enter your name:\")\n\n# With options\nemail = await session.ui.input(\"Enter email:\", {\n \"title\": \"Email Address\",\n \"description\": \"We'll use this for notifications\",\n \"format\": \"email\",\n})\n```\n\n### Custom Elicitation\n\nFor full control, use the `elicitation()` method with a custom JSON schema:\n\n```python\nresult = await session.ui.elicitation({\n \"message\": \"Configure deployment\",\n \"requestedSchema\": {\n \"type\": \"object\",\n \"properties\": {\n \"region\": {\"type\": \"string\", \"enum\": [\"us-east-1\", \"eu-west-1\"]},\n \"replicas\": {\"type\": \"number\", \"minimum\": 1, \"maximum\": 10},\n },\n \"required\": [\"region\"],\n },\n})\n\nif result[\"action\"] == \"accept\":\n region = result[\"content\"][\"region\"]\n replicas = result[\"content\"].get(\"replicas\", 1)\n```\n\n## Elicitation Request Handler\n\nWhen the server (or an MCP tool) needs to ask the end-user a question, it sends an `elicitation.requested` event. Provide an `on_elicitation_request` handler to respond:\n\n```python\nfrom copilot.session import ElicitationContext, ElicitationResult, PermissionHandler\n\nasync def handle_elicitation(\n context: ElicitationContext,\n) -> ElicitationResult:\n # context[\"session_id\"] — the session ID\n # context[\"message\"] — what the server is asking\n # context.get(\"requestedSchema\") — optional JSON schema for form fields\n # context.get(\"mode\") — \"form\" or \"url\"\n\n print(f\"Server asks: {context['message']}\")\n\n # Return the user's response\n return {\n \"action\": \"accept\", # or \"decline\" or \"cancel\"\n \"content\": {\"answer\": \"yes\"},\n }\n\nasync with await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n on_elicitation_request=handle_elicitation,\n) as session:\n ...\n```\n\nWhen `on_elicitation_request` is provided, the SDK automatically:\n\n- Sends `requestElicitation: true` to the server during session creation/resumption\n- Reports the `elicitation` capability on the session\n- Dispatches `elicitation.requested` events to your handler\n- Auto-cancels if your handler throws an error (so the server doesn't hang)\n\n## Requirements\n\n- Python 3.11+\n- GitHub Copilot CLI installed and accessible\n" }, { "path": "python/copilot/__init__.py", "content": "\"\"\"\nCopilot SDK - Python Client for GitHub Copilot CLI\n\nJSON-RPC based SDK for programmatic control of GitHub Copilot CLI\n\"\"\"\n\nfrom .client import (\n CopilotClient,\n ExternalServerConfig,\n ModelCapabilitiesOverride,\n ModelLimitsOverride,\n ModelSupportsOverride,\n ModelVisionLimitsOverride,\n SubprocessConfig,\n)\nfrom .session import (\n CommandContext,\n CommandDefinition,\n CopilotSession,\n CreateSessionFsHandler,\n ElicitationContext,\n ElicitationHandler,\n ElicitationParams,\n ElicitationResult,\n InputOptions,\n ProviderConfig,\n SessionCapabilities,\n SessionFsConfig,\n SessionUiApi,\n SessionUiCapabilities,\n)\nfrom .session_fs_provider import (\n SessionFsFileInfo,\n SessionFsProvider,\n create_session_fs_adapter,\n)\nfrom .tools import convert_mcp_call_tool_result, define_tool\n\n__version__ = \"0.1.0\"\n\n__all__ = [\n \"CommandContext\",\n \"CommandDefinition\",\n \"CopilotClient\",\n \"CopilotSession\",\n \"CreateSessionFsHandler\",\n \"ElicitationHandler\",\n \"ElicitationParams\",\n \"ElicitationContext\",\n \"ElicitationResult\",\n \"ExternalServerConfig\",\n \"InputOptions\",\n \"ModelCapabilitiesOverride\",\n \"ModelLimitsOverride\",\n \"ModelSupportsOverride\",\n \"ModelVisionLimitsOverride\",\n \"ProviderConfig\",\n \"SessionCapabilities\",\n \"SessionFsConfig\",\n \"SessionFsFileInfo\",\n \"SessionFsProvider\",\n \"create_session_fs_adapter\",\n \"SessionUiApi\",\n \"SessionUiCapabilities\",\n \"SubprocessConfig\",\n \"convert_mcp_call_tool_result\",\n \"define_tool\",\n]\n" }, { "path": "python/copilot/_jsonrpc.py", "content": "\"\"\"\nMinimal async JSON-RPC 2.0 client for stdio transport\n\nThis uses threading to handle blocking IO in an async-friendly way.\nMuch simpler and more reliable than pure asyncio subprocess.\n\"\"\"\n\nimport asyncio\nimport inspect\nimport json\nimport threading\nimport uuid\nfrom collections.abc import Awaitable, Callable\nfrom typing import Any\n\n\nclass JsonRpcError(Exception):\n \"\"\"JSON-RPC error response\"\"\"\n\n def __init__(self, code: int, message: str, data: Any = None):\n self.code = code\n self.message = message\n self.data = data\n super().__init__(f\"JSON-RPC Error {code}: {message}\")\n\n\nclass ProcessExitedError(Exception):\n \"\"\"Error raised when the CLI process exits unexpectedly\"\"\"\n\n pass\n\n\nRequestHandler = Callable[[dict], dict | Awaitable[dict]]\n\n\nclass JsonRpcClient:\n \"\"\"\n Minimal async JSON-RPC 2.0 client for stdio transport\n\n Uses threads for blocking IO but provides async interface.\n \"\"\"\n\n def __init__(self, process):\n \"\"\"\n Create client from subprocess.Popen with stdin/stdout pipes\n\n Args:\n process: subprocess.Popen with stdin=PIPE, stdout=PIPE\n \"\"\"\n self.process = process\n self.pending_requests: dict[str, asyncio.Future] = {}\n self.notification_handler: Callable[[str, dict], None] | None = None\n self.request_handlers: dict[str, RequestHandler] = {}\n self._running = False\n self._read_thread: threading.Thread | None = None\n self._stderr_thread: threading.Thread | None = None\n self._loop: asyncio.AbstractEventLoop | None = None\n self._write_lock = threading.Lock()\n self._pending_lock = threading.Lock()\n self._process_exit_error: str | None = None\n self._stderr_output: list[str] = []\n self._stderr_lock = threading.Lock()\n self.on_close: Callable[[], None] | None = None\n\n def start(self, loop: asyncio.AbstractEventLoop | None = None):\n \"\"\"Start listening for messages in background thread\"\"\"\n if not self._running:\n self._running = True\n # Always use the provided loop or get the running loop\n self._loop = loop or asyncio.get_running_loop()\n self._read_thread = threading.Thread(target=self._read_loop, daemon=True)\n self._read_thread.start()\n # Start stderr reader thread if process has stderr\n if hasattr(self.process, \"stderr\") and self.process.stderr:\n self._stderr_thread = threading.Thread(target=self._stderr_loop, daemon=True)\n self._stderr_thread.start()\n\n def _stderr_loop(self):\n \"\"\"Read stderr in background to capture error messages\"\"\"\n try:\n while self._running:\n if not self.process.stderr:\n break\n line = self.process.stderr.readline()\n if not line:\n break\n with self._stderr_lock:\n self._stderr_output.append(\n line.decode(\"utf-8\") if isinstance(line, bytes) else line\n )\n except Exception:\n pass # Ignore errors reading stderr\n\n def get_stderr_output(self) -> str:\n \"\"\"Get captured stderr output\"\"\"\n with self._stderr_lock:\n return \"\".join(self._stderr_output).strip()\n\n async def stop(self):\n \"\"\"Stop listening and clean up\"\"\"\n self._running = False\n if self._read_thread:\n self._read_thread.join(timeout=1.0)\n if self._stderr_thread:\n self._stderr_thread.join(timeout=1.0)\n\n async def request(\n self, method: str, params: dict | None = None, timeout: float | None = None\n ) -> Any:\n \"\"\"\n Send a JSON-RPC request and wait for response\n\n Args:\n method: Method name\n params: Optional parameters\n timeout: Optional request timeout in seconds. If None (default),\n waits indefinitely for the server to respond.\n\n Returns:\n The result from the response\n\n Raises:\n JsonRpcError: If server returns an error\n asyncio.TimeoutError: If request times out (only when timeout is set)\n \"\"\"\n request_id = str(uuid.uuid4())\n\n # Use the stored loop to ensure consistency with the reader thread\n if not self._loop:\n raise RuntimeError(\"Client not started. Call start() first.\")\n\n future = self._loop.create_future()\n with self._pending_lock:\n self.pending_requests[request_id] = future\n\n message = {\n \"jsonrpc\": \"2.0\",\n \"id\": request_id,\n \"method\": method,\n \"params\": params or {},\n }\n\n await self._send_message(message)\n\n try:\n if timeout is not None:\n return await asyncio.wait_for(future, timeout=timeout)\n return await future\n finally:\n with self._pending_lock:\n self.pending_requests.pop(request_id, None)\n\n async def notify(self, method: str, params: dict | None = None):\n \"\"\"\n Send a JSON-RPC notification (no response expected)\n\n Args:\n method: Method name\n params: Optional parameters\n \"\"\"\n message = {\n \"jsonrpc\": \"2.0\",\n \"method\": method,\n \"params\": params or {},\n }\n await self._send_message(message)\n\n def set_notification_handler(self, handler: Callable[[str, dict], None]):\n \"\"\"Set handler for incoming notifications from server\"\"\"\n self.notification_handler = handler\n\n def set_request_handler(self, method: str, handler: RequestHandler):\n if handler is None:\n self.request_handlers.pop(method, None)\n else:\n self.request_handlers[method] = handler\n\n async def _send_message(self, message: dict):\n \"\"\"Send a JSON-RPC message with Content-Length header\"\"\"\n loop = self._loop or asyncio.get_event_loop()\n\n def write():\n content = json.dumps(message, separators=(\",\", \":\"))\n content_bytes = content.encode(\"utf-8\")\n header = f\"Content-Length: {len(content_bytes)}\\r\\n\\r\\n\"\n with self._write_lock:\n self.process.stdin.write(header.encode(\"utf-8\"))\n self.process.stdin.write(content_bytes)\n self.process.stdin.flush()\n\n # Run in thread pool to avoid blocking\n await loop.run_in_executor(None, write)\n\n def _read_loop(self):\n \"\"\"Read messages from the stream (runs in thread)\"\"\"\n try:\n while self._running:\n message = self._read_message()\n if message:\n self._handle_message(message)\n else:\n # No message means stream closed - process likely exited\n break\n except EOFError:\n # Stream closed - check if process exited\n pass\n except Exception as e:\n if self._running:\n # Store error for pending requests\n self._process_exit_error = str(e)\n\n # Process exited or read failed - fail all pending requests\n if self._running:\n self._fail_pending_requests()\n if self.on_close is not None:\n self.on_close()\n\n def _fail_pending_requests(self):\n \"\"\"Fail all pending requests when process exits\"\"\"\n # Build error message with stderr output\n stderr_output = self.get_stderr_output()\n return_code = None\n if hasattr(self.process, \"poll\"):\n return_code = self.process.poll()\n\n if stderr_output:\n error_msg = f\"CLI process exited with code {return_code}\\nstderr: {stderr_output}\"\n elif return_code is not None:\n error_msg = f\"CLI process exited with code {return_code}\"\n else:\n error_msg = \"CLI process exited unexpectedly\"\n\n # Fail all pending requests\n with self._pending_lock:\n for request_id, future in list(self.pending_requests.items()):\n if not future.done():\n exc = ProcessExitedError(error_msg)\n loop = future.get_loop()\n loop.call_soon_threadsafe(future.set_exception, exc)\n\n def _read_exact(self, num_bytes: int) -> bytes:\n \"\"\"\n Read exactly num_bytes, handling partial/short reads from pipes.\n\n Args:\n num_bytes: Number of bytes to read\n\n Returns:\n Bytes read from stream\n\n Raises:\n EOFError: If stream ends before reading all bytes\n \"\"\"\n chunks = []\n remaining = num_bytes\n while remaining > 0:\n chunk = self.process.stdout.read(remaining)\n if not chunk:\n raise EOFError(\"Unexpected end of stream while reading JSON-RPC message\")\n chunks.append(chunk)\n remaining -= len(chunk)\n return b\"\".join(chunks)\n\n def _read_message(self) -> dict | None:\n \"\"\"\n Read a single JSON-RPC message with Content-Length header (blocking)\n\n Returns:\n Parsed JSON message or None if connection closed\n \"\"\"\n # Read header line\n header_line = self.process.stdout.readline()\n if not header_line:\n return None\n\n # Parse Content-Length\n header = header_line.decode(\"utf-8\").strip()\n if not header.startswith(\"Content-Length:\"):\n return None\n\n content_length = int(header.split(\":\")[1].strip())\n\n # Read empty line\n self.process.stdout.readline()\n\n # Read exact content using loop to handle short reads\n content_bytes = self._read_exact(content_length)\n content = content_bytes.decode(\"utf-8\")\n\n return json.loads(content)\n\n def _handle_message(self, message: dict):\n \"\"\"Handle an incoming message (response or notification)\"\"\"\n # Check if it's a response to our request\n if \"id\" in message:\n with self._pending_lock:\n future = self.pending_requests.get(message[\"id\"])\n\n if future is not None:\n loop = future.get_loop()\n\n if \"error\" in message:\n error = message[\"error\"]\n exc = JsonRpcError(\n error.get(\"code\", -1),\n error.get(\"message\", \"Unknown error\"),\n error.get(\"data\"),\n )\n loop.call_soon_threadsafe(future.set_exception, exc)\n elif \"result\" in message:\n loop.call_soon_threadsafe(future.set_result, message[\"result\"])\n else:\n exc = ValueError(\"Invalid JSON-RPC response\")\n loop.call_soon_threadsafe(future.set_exception, exc)\n return\n\n # Check if it's a notification from server\n if \"method\" in message and \"id\" not in message:\n if self.notification_handler and self._loop:\n method = message[\"method\"]\n params = message.get(\"params\", {})\n # Schedule notification handler on the event loop for thread safety\n self._loop.call_soon_threadsafe(self.notification_handler, method, params)\n return\n\n # Otherwise handle as incoming request (tool.call, etc.)\n if \"method\" in message and \"id\" in message:\n self._handle_request(message)\n\n def _handle_request(self, message: dict):\n method = message.get(\"method\", \"\")\n handler = self.request_handlers.get(method)\n if not handler:\n if self._loop:\n asyncio.run_coroutine_threadsafe(\n self._send_error_response(\n message[\"id\"], -32601, f\"Method not found: {message['method']}\", None\n ),\n self._loop,\n )\n return\n if not self._loop:\n return\n asyncio.run_coroutine_threadsafe(\n self._dispatch_request(message, handler),\n self._loop,\n )\n\n async def _dispatch_request(self, message: dict, handler: RequestHandler):\n try:\n params = message.get(\"params\", {})\n outcome = handler(params)\n if inspect.isawaitable(outcome):\n outcome = await outcome\n if outcome is not None and not isinstance(outcome, dict):\n raise ValueError(\n f\"Request handler must return a dict, got {type(outcome).__name__}\"\n )\n await self._send_response(message[\"id\"], outcome)\n except JsonRpcError as exc:\n await self._send_error_response(message[\"id\"], exc.code, exc.message, exc.data)\n except Exception as exc: # pylint: disable=broad-except\n await self._send_error_response(message[\"id\"], -32603, str(exc), None)\n\n async def _send_response(self, request_id: str, result: dict | None):\n response = {\n \"jsonrpc\": \"2.0\",\n \"id\": request_id,\n \"result\": result,\n }\n await self._send_message(response)\n\n async def _send_error_response(\n self, request_id: str, code: int, message: str, data: dict | None\n ):\n response = {\n \"jsonrpc\": \"2.0\",\n \"id\": request_id,\n \"error\": {\n \"code\": code,\n \"message\": message,\n \"data\": data,\n },\n }\n await self._send_message(response)\n" }, { "path": "python/copilot/_sdk_protocol_version.py", "content": "# Code generated by update-protocol-version.ts. DO NOT EDIT.\n\n\"\"\"\nSDK Protocol Version for the Copilot SDK.\n\nThis must match the version expected by the copilot-agent-runtime server.\n\"\"\"\n\nSDK_PROTOCOL_VERSION = 3\n\n\ndef get_sdk_protocol_version() -> int:\n \"\"\"\n Gets the SDK protocol version.\n\n Returns:\n The protocol version number\n \"\"\"\n return SDK_PROTOCOL_VERSION\n" }, { "path": "python/copilot/_telemetry.py", "content": "\"\"\"OpenTelemetry trace context helpers for Copilot SDK.\"\"\"\n\nfrom __future__ import annotations\n\nfrom collections.abc import Generator\nfrom contextlib import contextmanager\n\n\ndef get_trace_context() -> dict[str, str]:\n \"\"\"Get the current W3C Trace Context (traceparent/tracestate) if OpenTelemetry is available.\"\"\"\n try:\n from opentelemetry import context, propagate\n except ImportError:\n return {}\n\n carrier: dict[str, str] = {}\n propagate.inject(carrier, context=context.get_current())\n result: dict[str, str] = {}\n if \"traceparent\" in carrier:\n result[\"traceparent\"] = carrier[\"traceparent\"]\n if \"tracestate\" in carrier:\n result[\"tracestate\"] = carrier[\"tracestate\"]\n return result\n\n\n@contextmanager\ndef trace_context(traceparent: str | None, tracestate: str | None) -> Generator[None, None, None]:\n \"\"\"Context manager that sets the trace context from W3C headers for the block's duration.\"\"\"\n try:\n from opentelemetry import context, propagate\n except ImportError:\n yield\n return\n\n if not traceparent:\n yield\n return\n\n carrier: dict[str, str] = {\"traceparent\": traceparent}\n if tracestate:\n carrier[\"tracestate\"] = tracestate\n\n ctx = propagate.extract(carrier, context=context.get_current())\n token = context.attach(ctx)\n try:\n yield\n finally:\n context.detach(token)\n" }, { "path": "python/copilot/client.py", "content": "\"\"\"\nCopilot CLI SDK Client - Main entry point for the Copilot SDK.\n\nThis module provides the :class:`CopilotClient` class, which manages the connection\nto the Copilot CLI server and provides session management capabilities.\n\nExample:\n >>> from copilot import CopilotClient\n >>>\n >>> async with CopilotClient() as client:\n ... session = await client.create_session()\n ... await session.send(\"Hello!\")\n\"\"\"\n\nfrom __future__ import annotations\n\nimport asyncio\nimport inspect\nimport os\nimport re\nimport shutil\nimport subprocess\nimport sys\nimport threading\nimport uuid\nfrom collections.abc import Awaitable, Callable\nfrom dataclasses import KW_ONLY, dataclass, field\nfrom pathlib import Path\nfrom types import TracebackType\nfrom typing import Any, Literal, TypedDict, cast, overload\n\nfrom ._jsonrpc import JsonRpcClient, ProcessExitedError\nfrom ._sdk_protocol_version import get_sdk_protocol_version\nfrom ._telemetry import get_trace_context, trace_context\nfrom .generated.rpc import (\n ClientSessionApiHandlers,\n ServerRpc,\n register_client_session_api_handlers,\n)\nfrom .generated.session_events import (\n PermissionRequest,\n SessionEvent,\n session_event_from_dict,\n)\nfrom .session import (\n CommandDefinition,\n CopilotSession,\n CreateSessionFsHandler,\n CustomAgentConfig,\n DefaultAgentConfig,\n ElicitationHandler,\n InfiniteSessionConfig,\n MCPServerConfig,\n ProviderConfig,\n ReasoningEffort,\n SectionTransformFn,\n SessionFsConfig,\n SessionHooks,\n SystemMessageConfig,\n UserInputHandler,\n _PermissionHandlerFn,\n)\nfrom .session_fs_provider import create_session_fs_adapter\nfrom .tools import Tool, ToolInvocation, ToolResult\n\n# ============================================================================\n# Connection Types\n# ============================================================================\n\nConnectionState = Literal[\"disconnected\", \"connecting\", \"connected\", \"error\"]\n\nLogLevel = Literal[\"none\", \"error\", \"warning\", \"info\", \"debug\", \"all\"]\n\n\ndef _validate_session_fs_config(config: SessionFsConfig) -> None:\n if not config.get(\"initial_cwd\"):\n raise ValueError(\"session_fs.initial_cwd is required\")\n if not config.get(\"session_state_path\"):\n raise ValueError(\"session_fs.session_state_path is required\")\n if config.get(\"conventions\") not in (\"posix\", \"windows\"):\n raise ValueError(\"session_fs.conventions must be either 'posix' or 'windows'\")\n\n\nclass TelemetryConfig(TypedDict, total=False):\n \"\"\"Configuration for OpenTelemetry integration with the Copilot CLI.\"\"\"\n\n otlp_endpoint: str\n \"\"\"OTLP HTTP endpoint URL for trace/metric export. Sets OTEL_EXPORTER_OTLP_ENDPOINT.\"\"\"\n file_path: str\n \"\"\"File path for JSON-lines trace output. Sets COPILOT_OTEL_FILE_EXPORTER_PATH.\"\"\"\n exporter_type: str\n \"\"\"Exporter backend type: \"otlp-http\" or \"file\". Sets COPILOT_OTEL_EXPORTER_TYPE.\"\"\"\n source_name: str\n \"\"\"Instrumentation scope name. Sets COPILOT_OTEL_SOURCE_NAME.\"\"\"\n capture_content: bool\n \"\"\"Whether to capture message content. Sets OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT.\"\"\" # noqa: E501\n\n\n@dataclass\nclass SubprocessConfig:\n \"\"\"Config for spawning a local Copilot CLI subprocess.\n\n Example:\n >>> config = SubprocessConfig(github_token=\"ghp_...\")\n >>> client = CopilotClient(config)\n\n >>> # Custom CLI path with TCP transport\n >>> config = SubprocessConfig(\n ... cli_path=\"/usr/local/bin/copilot\",\n ... use_stdio=False,\n ... log_level=\"debug\",\n ... )\n \"\"\"\n\n cli_path: str | None = None\n \"\"\"Path to the Copilot CLI executable. ``None`` uses the bundled binary.\"\"\"\n\n cli_args: list[str] = field(default_factory=list)\n \"\"\"Extra arguments passed to the CLI executable (inserted before SDK-managed args).\"\"\"\n\n _: KW_ONLY\n\n cwd: str | None = None\n \"\"\"Working directory for the CLI process. ``None`` uses the current directory.\"\"\"\n\n use_stdio: bool = True\n \"\"\"Use stdio transport (``True``, default) or TCP (``False``).\"\"\"\n\n port: int = 0\n \"\"\"TCP port for the CLI server (only when ``use_stdio=False``). 0 means random.\"\"\"\n\n log_level: LogLevel = \"info\"\n \"\"\"Log level for the CLI process.\"\"\"\n\n env: dict[str, str] | None = None\n \"\"\"Environment variables for the CLI process. ``None`` inherits the current env.\"\"\"\n\n github_token: str | None = None\n \"\"\"GitHub token for authentication. Takes priority over other auth methods.\"\"\"\n\n use_logged_in_user: bool | None = None\n \"\"\"Use the logged-in user for authentication.\n\n ``None`` (default) resolves to ``True`` unless ``github_token`` is set.\n \"\"\"\n\n telemetry: TelemetryConfig | None = None\n \"\"\"OpenTelemetry configuration. Providing this enables telemetry — no separate flag needed.\"\"\"\n\n session_fs: SessionFsConfig | None = None\n \"\"\"Connection-level session filesystem provider configuration.\"\"\"\n\n session_idle_timeout_seconds: int | None = None\n \"\"\"Server-wide session idle timeout in seconds.\n\n Sessions without activity for this duration are automatically cleaned up.\n Set to ``None`` or ``0`` to disable (sessions live indefinitely).\n This option is only used when the SDK spawns the CLI process.\n \"\"\"\n\n\n@dataclass\nclass ExternalServerConfig:\n \"\"\"Config for connecting to an existing Copilot CLI server over TCP.\n\n Example:\n >>> config = ExternalServerConfig(url=\"localhost:3000\")\n >>> client = CopilotClient(config)\n \"\"\"\n\n url: str\n \"\"\"Server URL. Supports ``\"host:port\"``, ``\"http://host:port\"``, or just ``\"port\"``.\"\"\"\n\n _: KW_ONLY\n\n session_fs: SessionFsConfig | None = None\n \"\"\"Connection-level session filesystem provider configuration.\"\"\"\n\n\n# ============================================================================\n# Response Types\n# ============================================================================\n\n\n@dataclass\nclass PingResponse:\n \"\"\"Response from ping\"\"\"\n\n message: str # Echo message with \"pong: \" prefix\n timestamp: int # Server timestamp in milliseconds\n protocolVersion: int # Protocol version for SDK compatibility\n\n @staticmethod\n def from_dict(obj: Any) -> PingResponse:\n assert isinstance(obj, dict)\n message = obj.get(\"message\")\n timestamp = obj.get(\"timestamp\")\n protocolVersion = obj.get(\"protocolVersion\")\n if message is None or timestamp is None or protocolVersion is None:\n raise ValueError(\n f\"Missing required fields in PingResponse: message={message}, \"\n f\"timestamp={timestamp}, protocolVersion={protocolVersion}\"\n )\n return PingResponse(str(message), int(timestamp), int(protocolVersion))\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"message\"] = self.message\n result[\"timestamp\"] = self.timestamp\n result[\"protocolVersion\"] = self.protocolVersion\n return result\n\n\n@dataclass\nclass StopError(Exception):\n \"\"\"Error that occurred during client stop cleanup.\"\"\"\n\n message: str # Error message describing what failed during cleanup\n\n def __post_init__(self) -> None:\n Exception.__init__(self, self.message)\n\n @staticmethod\n def from_dict(obj: Any) -> StopError:\n assert isinstance(obj, dict)\n message = obj.get(\"message\")\n if message is None:\n raise ValueError(\"Missing required field 'message' in StopError\")\n return StopError(str(message))\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"message\"] = self.message\n return result\n\n\n@dataclass\nclass GetStatusResponse:\n \"\"\"Response from status.get\"\"\"\n\n version: str # Package version (e.g., \"1.0.0\")\n protocolVersion: int # Protocol version for SDK compatibility\n\n @staticmethod\n def from_dict(obj: Any) -> GetStatusResponse:\n assert isinstance(obj, dict)\n version = obj.get(\"version\")\n protocolVersion = obj.get(\"protocolVersion\")\n if version is None or protocolVersion is None:\n raise ValueError(\n f\"Missing required fields in GetStatusResponse: version={version}, \"\n f\"protocolVersion={protocolVersion}\"\n )\n return GetStatusResponse(str(version), int(protocolVersion))\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"version\"] = self.version\n result[\"protocolVersion\"] = self.protocolVersion\n return result\n\n\n@dataclass\nclass GetAuthStatusResponse:\n \"\"\"Response from auth.getStatus\"\"\"\n\n isAuthenticated: bool # Whether the user is authenticated\n authType: str | None = None # Authentication type\n host: str | None = None # GitHub host URL\n login: str | None = None # User login name\n statusMessage: str | None = None # Human-readable status message\n\n @staticmethod\n def from_dict(obj: Any) -> GetAuthStatusResponse:\n assert isinstance(obj, dict)\n isAuthenticated = obj.get(\"isAuthenticated\")\n if isAuthenticated is None:\n raise ValueError(\"Missing required field 'isAuthenticated' in GetAuthStatusResponse\")\n authType = obj.get(\"authType\")\n host = obj.get(\"host\")\n login = obj.get(\"login\")\n statusMessage = obj.get(\"statusMessage\")\n return GetAuthStatusResponse(\n isAuthenticated=bool(isAuthenticated),\n authType=authType,\n host=host,\n login=login,\n statusMessage=statusMessage,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"isAuthenticated\"] = self.isAuthenticated\n if self.authType is not None:\n result[\"authType\"] = self.authType\n if self.host is not None:\n result[\"host\"] = self.host\n if self.login is not None:\n result[\"login\"] = self.login\n if self.statusMessage is not None:\n result[\"statusMessage\"] = self.statusMessage\n return result\n\n\n# ============================================================================\n# Model Types\n# ============================================================================\n\n\n@dataclass\nclass ModelVisionLimits:\n \"\"\"Vision-specific limits\"\"\"\n\n supported_media_types: list[str] | None = None\n max_prompt_images: int | None = None\n max_prompt_image_size: int | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> ModelVisionLimits:\n assert isinstance(obj, dict)\n supported_media_types = obj.get(\"supported_media_types\")\n max_prompt_images = obj.get(\"max_prompt_images\")\n max_prompt_image_size = obj.get(\"max_prompt_image_size\")\n return ModelVisionLimits(\n supported_media_types=supported_media_types,\n max_prompt_images=max_prompt_images,\n max_prompt_image_size=max_prompt_image_size,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.supported_media_types is not None:\n result[\"supported_media_types\"] = self.supported_media_types\n if self.max_prompt_images is not None:\n result[\"max_prompt_images\"] = self.max_prompt_images\n if self.max_prompt_image_size is not None:\n result[\"max_prompt_image_size\"] = self.max_prompt_image_size\n return result\n\n\n@dataclass\nclass ModelLimits:\n \"\"\"Model limits\"\"\"\n\n max_prompt_tokens: int | None = None\n max_context_window_tokens: int | None = None\n vision: ModelVisionLimits | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> ModelLimits:\n assert isinstance(obj, dict)\n max_prompt_tokens = obj.get(\"max_prompt_tokens\")\n max_context_window_tokens = obj.get(\"max_context_window_tokens\")\n vision_dict = obj.get(\"vision\")\n vision = ModelVisionLimits.from_dict(vision_dict) if vision_dict else None\n return ModelLimits(\n max_prompt_tokens=max_prompt_tokens,\n max_context_window_tokens=max_context_window_tokens,\n vision=vision,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.max_prompt_tokens is not None:\n result[\"max_prompt_tokens\"] = self.max_prompt_tokens\n if self.max_context_window_tokens is not None:\n result[\"max_context_window_tokens\"] = self.max_context_window_tokens\n if self.vision is not None:\n result[\"vision\"] = self.vision.to_dict()\n return result\n\n\n@dataclass\nclass ModelSupports:\n \"\"\"Model support flags\"\"\"\n\n vision: bool = False\n reasoning_effort: bool = False # Whether this model supports reasoning effort\n\n @staticmethod\n def from_dict(obj: Any) -> ModelSupports:\n assert isinstance(obj, dict)\n vision = obj.get(\"vision\", False)\n reasoning_effort = obj.get(\"reasoningEffort\", False)\n return ModelSupports(vision=bool(vision), reasoning_effort=bool(reasoning_effort))\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"vision\"] = self.vision\n result[\"reasoningEffort\"] = self.reasoning_effort\n return result\n\n\n@dataclass\nclass ModelCapabilities:\n \"\"\"Model capabilities and limits\"\"\"\n\n supports: ModelSupports\n limits: ModelLimits\n\n @staticmethod\n def from_dict(obj: Any) -> ModelCapabilities:\n assert isinstance(obj, dict)\n supports_dict = obj.get(\"supports\")\n limits_dict = obj.get(\"limits\")\n supports = ModelSupports.from_dict(supports_dict) if supports_dict else ModelSupports()\n limits = ModelLimits.from_dict(limits_dict) if limits_dict else ModelLimits()\n return ModelCapabilities(supports=supports, limits=limits)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"supports\"] = self.supports.to_dict()\n result[\"limits\"] = self.limits.to_dict()\n return result\n\n\n@dataclass\nclass ModelVisionLimitsOverride:\n supported_media_types: list[str] | None = None\n max_prompt_images: int | None = None\n max_prompt_image_size: int | None = None\n\n\n@dataclass\nclass ModelLimitsOverride:\n max_prompt_tokens: int | None = None\n max_output_tokens: int | None = None\n max_context_window_tokens: int | None = None\n vision: ModelVisionLimitsOverride | None = None\n\n\n@dataclass\nclass ModelSupportsOverride:\n vision: bool | None = None\n reasoning_effort: bool | None = None\n\n\n@dataclass\nclass ModelCapabilitiesOverride:\n supports: ModelSupportsOverride | None = None\n limits: ModelLimitsOverride | None = None\n\n\ndef _capabilities_to_dict(caps: ModelCapabilitiesOverride) -> dict:\n result: dict = {}\n if caps.supports is not None:\n s: dict = {}\n if caps.supports.vision is not None:\n s[\"vision\"] = caps.supports.vision\n if caps.supports.reasoning_effort is not None:\n s[\"reasoningEffort\"] = caps.supports.reasoning_effort\n if s:\n result[\"supports\"] = s\n if caps.limits is not None:\n lim: dict = {}\n if caps.limits.max_prompt_tokens is not None:\n lim[\"max_prompt_tokens\"] = caps.limits.max_prompt_tokens\n if caps.limits.max_output_tokens is not None:\n lim[\"max_output_tokens\"] = caps.limits.max_output_tokens\n if caps.limits.max_context_window_tokens is not None:\n lim[\"max_context_window_tokens\"] = caps.limits.max_context_window_tokens\n if caps.limits.vision is not None:\n v: dict = {}\n if caps.limits.vision.supported_media_types is not None:\n v[\"supported_media_types\"] = caps.limits.vision.supported_media_types\n if caps.limits.vision.max_prompt_images is not None:\n v[\"max_prompt_images\"] = caps.limits.vision.max_prompt_images\n if caps.limits.vision.max_prompt_image_size is not None:\n v[\"max_prompt_image_size\"] = caps.limits.vision.max_prompt_image_size\n if v:\n lim[\"vision\"] = v\n if lim:\n result[\"limits\"] = lim\n return result\n\n\n@dataclass\nclass ModelPolicy:\n \"\"\"Model policy state\"\"\"\n\n state: str # \"enabled\", \"disabled\", or \"unconfigured\"\n terms: str\n\n @staticmethod\n def from_dict(obj: Any) -> ModelPolicy:\n assert isinstance(obj, dict)\n state = obj.get(\"state\")\n terms = obj.get(\"terms\")\n if state is None or terms is None:\n raise ValueError(\n f\"Missing required fields in ModelPolicy: state={state}, terms={terms}\"\n )\n return ModelPolicy(state=str(state), terms=str(terms))\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"state\"] = self.state\n result[\"terms\"] = self.terms\n return result\n\n\n@dataclass\nclass ModelBilling:\n \"\"\"Model billing information\"\"\"\n\n multiplier: float\n\n @staticmethod\n def from_dict(obj: Any) -> ModelBilling:\n assert isinstance(obj, dict)\n multiplier = obj.get(\"multiplier\")\n if multiplier is None:\n raise ValueError(\"Missing required field 'multiplier' in ModelBilling\")\n return ModelBilling(multiplier=float(multiplier))\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"multiplier\"] = self.multiplier\n return result\n\n\n@dataclass\nclass ModelInfo:\n \"\"\"Information about an available model\"\"\"\n\n id: str # Model identifier (e.g., \"claude-sonnet-4.5\")\n name: str # Display name\n capabilities: ModelCapabilities # Model capabilities and limits\n policy: ModelPolicy | None = None # Policy state\n billing: ModelBilling | None = None # Billing information\n # Supported reasoning effort levels (only present if model supports reasoning effort)\n supported_reasoning_efforts: list[str] | None = None\n # Default reasoning effort level (only present if model supports reasoning effort)\n default_reasoning_effort: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> ModelInfo:\n assert isinstance(obj, dict)\n id = obj.get(\"id\")\n name = obj.get(\"name\")\n capabilities_dict = obj.get(\"capabilities\")\n if id is None or name is None or capabilities_dict is None:\n raise ValueError(\n f\"Missing required fields in ModelInfo: id={id}, name={name}, \"\n f\"capabilities={capabilities_dict}\"\n )\n capabilities = ModelCapabilities.from_dict(capabilities_dict)\n policy_dict = obj.get(\"policy\")\n policy = ModelPolicy.from_dict(policy_dict) if policy_dict else None\n billing_dict = obj.get(\"billing\")\n billing = ModelBilling.from_dict(billing_dict) if billing_dict else None\n supported_reasoning_efforts = obj.get(\"supportedReasoningEfforts\")\n default_reasoning_effort = obj.get(\"defaultReasoningEffort\")\n return ModelInfo(\n id=str(id),\n name=str(name),\n capabilities=capabilities,\n policy=policy,\n billing=billing,\n supported_reasoning_efforts=supported_reasoning_efforts,\n default_reasoning_effort=default_reasoning_effort,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"id\"] = self.id\n result[\"name\"] = self.name\n result[\"capabilities\"] = self.capabilities.to_dict()\n if self.policy is not None:\n result[\"policy\"] = self.policy.to_dict()\n if self.billing is not None:\n result[\"billing\"] = self.billing.to_dict()\n if self.supported_reasoning_efforts is not None:\n result[\"supportedReasoningEfforts\"] = self.supported_reasoning_efforts\n if self.default_reasoning_effort is not None:\n result[\"defaultReasoningEffort\"] = self.default_reasoning_effort\n return result\n\n\n# ============================================================================\n# Session Metadata Types\n# ============================================================================\n\n\n@dataclass\nclass SessionContext:\n \"\"\"Working directory context for a session\"\"\"\n\n cwd: str # Working directory where the session was created\n gitRoot: str | None = None # Git repository root (if in a git repo)\n repository: str | None = None # GitHub repository in \"owner/repo\" format\n branch: str | None = None # Current git branch\n\n @staticmethod\n def from_dict(obj: Any) -> SessionContext:\n assert isinstance(obj, dict)\n cwd = obj.get(\"cwd\")\n if cwd is None:\n raise ValueError(\"Missing required field 'cwd' in SessionContext\")\n return SessionContext(\n cwd=str(cwd),\n gitRoot=obj.get(\"gitRoot\"),\n repository=obj.get(\"repository\"),\n branch=obj.get(\"branch\"),\n )\n\n def to_dict(self) -> dict:\n result: dict = {\"cwd\": self.cwd}\n if self.gitRoot is not None:\n result[\"gitRoot\"] = self.gitRoot\n if self.repository is not None:\n result[\"repository\"] = self.repository\n if self.branch is not None:\n result[\"branch\"] = self.branch\n return result\n\n\n@dataclass\nclass SessionListFilter:\n \"\"\"Filter options for listing sessions\"\"\"\n\n cwd: str | None = None # Filter by exact cwd match\n gitRoot: str | None = None # Filter by git root\n repository: str | None = None # Filter by repository (owner/repo format)\n branch: str | None = None # Filter by branch\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.cwd is not None:\n result[\"cwd\"] = self.cwd\n if self.gitRoot is not None:\n result[\"gitRoot\"] = self.gitRoot\n if self.repository is not None:\n result[\"repository\"] = self.repository\n if self.branch is not None:\n result[\"branch\"] = self.branch\n return result\n\n\n@dataclass\nclass SessionMetadata:\n \"\"\"Metadata about a session\"\"\"\n\n sessionId: str # Session identifier\n startTime: str # ISO 8601 timestamp when session was created\n modifiedTime: str # ISO 8601 timestamp when session was last modified\n isRemote: bool # Whether the session is remote\n summary: str | None = None # Optional summary of the session\n context: SessionContext | None = None # Working directory context\n\n @staticmethod\n def from_dict(obj: Any) -> SessionMetadata:\n assert isinstance(obj, dict)\n sessionId = obj.get(\"sessionId\")\n startTime = obj.get(\"startTime\")\n modifiedTime = obj.get(\"modifiedTime\")\n isRemote = obj.get(\"isRemote\")\n if sessionId is None or startTime is None or modifiedTime is None or isRemote is None:\n raise ValueError(\n f\"Missing required fields in SessionMetadata: sessionId={sessionId}, \"\n f\"startTime={startTime}, modifiedTime={modifiedTime}, isRemote={isRemote}\"\n )\n summary = obj.get(\"summary\")\n context_dict = obj.get(\"context\")\n context = SessionContext.from_dict(context_dict) if context_dict else None\n return SessionMetadata(\n sessionId=str(sessionId),\n startTime=str(startTime),\n modifiedTime=str(modifiedTime),\n isRemote=bool(isRemote),\n summary=summary,\n context=context,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"sessionId\"] = self.sessionId\n result[\"startTime\"] = self.startTime\n result[\"modifiedTime\"] = self.modifiedTime\n result[\"isRemote\"] = self.isRemote\n if self.summary is not None:\n result[\"summary\"] = self.summary\n if self.context is not None:\n result[\"context\"] = self.context.to_dict()\n return result\n\n\n# ============================================================================\n# Session Lifecycle Types (for TUI+server mode)\n# ============================================================================\n\nSessionLifecycleEventType = Literal[\n \"session.created\",\n \"session.deleted\",\n \"session.updated\",\n \"session.foreground\",\n \"session.background\",\n]\n\n\n@dataclass\nclass SessionLifecycleEventMetadata:\n \"\"\"Metadata for session lifecycle events.\"\"\"\n\n startTime: str\n modifiedTime: str\n summary: str | None = None\n\n @staticmethod\n def from_dict(data: dict) -> SessionLifecycleEventMetadata:\n return SessionLifecycleEventMetadata(\n startTime=data.get(\"startTime\", \"\"),\n modifiedTime=data.get(\"modifiedTime\", \"\"),\n summary=data.get(\"summary\"),\n )\n\n\n@dataclass\nclass SessionLifecycleEvent:\n \"\"\"Session lifecycle event notification.\"\"\"\n\n type: SessionLifecycleEventType\n sessionId: str\n metadata: SessionLifecycleEventMetadata | None = None\n\n @staticmethod\n def from_dict(data: dict) -> SessionLifecycleEvent:\n metadata = None\n if \"metadata\" in data and data[\"metadata\"]:\n metadata = SessionLifecycleEventMetadata.from_dict(data[\"metadata\"])\n return SessionLifecycleEvent(\n type=data.get(\"type\", \"session.updated\"),\n sessionId=data.get(\"sessionId\", \"\"),\n metadata=metadata,\n )\n\n\nSessionLifecycleHandler = Callable[[SessionLifecycleEvent], None]\n\nHandlerUnsubcribe = Callable[[], None]\n\nNO_RESULT_PERMISSION_V2_ERROR = (\n \"Permission handlers cannot return 'no-result' when connected to a protocol v2 server.\"\n)\n\n# Minimum protocol version this SDK can communicate with.\n# Servers reporting a version below this are rejected.\nMIN_PROTOCOL_VERSION = 2\n\n\ndef _get_bundled_cli_path() -> str | None:\n \"\"\"Get the path to the bundled CLI binary, if available.\"\"\"\n # The binary is bundled in copilot/bin/ within the package\n bin_dir = Path(__file__).parent / \"bin\"\n if not bin_dir.exists():\n return None\n\n # Determine binary name based on platform\n if sys.platform == \"win32\":\n binary_name = \"copilot.exe\"\n else:\n binary_name = \"copilot\"\n\n binary_path = bin_dir / binary_name\n if binary_path.exists():\n return str(binary_path)\n\n return None\n\n\ndef _extract_transform_callbacks(\n system_message: SystemMessageConfig | dict[str, Any] | None,\n) -> tuple[dict[str, Any] | None, dict[str, SectionTransformFn] | None]:\n \"\"\"Extract function-valued actions from system message config.\n\n Returns a wire-safe payload (with callable actions replaced by ``\"transform\"``)\n and a dict of transform callbacks keyed by section ID.\n \"\"\"\n wire_system_message = cast(dict[str, Any] | None, system_message)\n if (\n not wire_system_message\n or wire_system_message.get(\"mode\") != \"customize\"\n or not wire_system_message.get(\"sections\")\n ):\n return wire_system_message, None\n\n callbacks: dict[str, SectionTransformFn] = {}\n wire_sections: dict[str, Any] = {}\n for section_id, override in wire_system_message[\"sections\"].items():\n if not override:\n continue\n action = override.get(\"action\")\n if callable(action):\n callbacks[section_id] = action\n wire_sections[section_id] = {\"action\": \"transform\"}\n else:\n wire_sections[section_id] = override\n\n if not callbacks:\n return wire_system_message, None\n\n wire_payload = {**wire_system_message, \"sections\": wire_sections}\n return wire_payload, callbacks\n\n\nclass CopilotClient:\n \"\"\"\n Main client for interacting with the Copilot CLI.\n\n The CopilotClient manages the connection to the Copilot CLI server and provides\n methods to create and manage conversation sessions. It can either spawn a CLI\n server process or connect to an existing server.\n\n The client supports both stdio (default) and TCP transport modes for\n communication with the CLI server.\n\n Example:\n >>> # Create a client with default options (spawns CLI server)\n >>> client = CopilotClient()\n >>> await client.start()\n >>>\n >>> # Create a session and send a message\n >>> session = await client.create_session(\n ... on_permission_request=PermissionHandler.approve_all,\n ... model=\"gpt-4\",\n ... )\n >>> session.on(lambda event: print(event.type))\n >>> await session.send(\"Hello!\")\n >>>\n >>> # Clean up\n >>> await session.disconnect()\n >>> await client.stop()\n\n >>> # Or connect to an existing server\n >>> client = CopilotClient(ExternalServerConfig(url=\"localhost:3000\"))\n \"\"\"\n\n def __init__(\n self,\n config: SubprocessConfig | ExternalServerConfig | None = None,\n *,\n auto_start: bool = True,\n on_list_models: Callable[[], list[ModelInfo] | Awaitable[list[ModelInfo]]] | None = None,\n ):\n \"\"\"\n Initialize a new CopilotClient.\n\n Args:\n config: Connection configuration. Pass a :class:`SubprocessConfig` to\n spawn a local CLI process, or an :class:`ExternalServerConfig` to\n connect to an existing server. Defaults to ``SubprocessConfig()``.\n auto_start: Automatically start the connection on first use\n (default: ``True``).\n on_list_models: Custom handler for :meth:`list_models`. When provided,\n the handler is called instead of querying the CLI server.\n\n Example:\n >>> # Default — spawns CLI server using stdio\n >>> client = CopilotClient()\n >>>\n >>> # Connect to an existing server\n >>> client = CopilotClient(ExternalServerConfig(url=\"localhost:3000\"))\n >>>\n >>> # Custom CLI path with specific log level\n >>> client = CopilotClient(\n ... SubprocessConfig(\n ... cli_path=\"/usr/local/bin/copilot\",\n ... log_level=\"debug\",\n ... )\n ... )\n \"\"\"\n if config is None:\n config = SubprocessConfig()\n\n self._config: SubprocessConfig | ExternalServerConfig = config\n self._auto_start = auto_start\n self._on_list_models = on_list_models\n\n # Resolve connection-mode-specific state\n self._actual_host: str = \"localhost\"\n self._is_external_server: bool = isinstance(config, ExternalServerConfig)\n\n if isinstance(config, ExternalServerConfig):\n self._actual_host, actual_port = self._parse_cli_url(config.url)\n self._actual_port: int | None = actual_port\n else:\n self._actual_port = None\n\n # Resolve CLI path: explicit > COPILOT_CLI_PATH env var > bundled binary\n effective_env = config.env if config.env is not None else os.environ\n if config.cli_path is None:\n env_cli_path = effective_env.get(\"COPILOT_CLI_PATH\")\n if env_cli_path:\n config.cli_path = env_cli_path\n else:\n bundled_path = _get_bundled_cli_path()\n if bundled_path:\n config.cli_path = bundled_path\n else:\n raise RuntimeError(\n \"Copilot CLI not found. The bundled CLI binary is not available. \"\n \"Ensure you installed a platform-specific wheel, or provide cli_path.\"\n )\n\n # Resolve use_logged_in_user default\n if config.use_logged_in_user is None:\n config.use_logged_in_user = not bool(config.github_token)\n\n self._process: subprocess.Popen | None = None\n self._client: JsonRpcClient | None = None\n self._state: ConnectionState = \"disconnected\"\n self._sessions: dict[str, CopilotSession] = {}\n self._sessions_lock = threading.Lock()\n self._models_cache: list[ModelInfo] | None = None\n self._models_cache_lock = asyncio.Lock()\n self._lifecycle_handlers: list[SessionLifecycleHandler] = []\n self._typed_lifecycle_handlers: dict[\n SessionLifecycleEventType, list[SessionLifecycleHandler]\n ] = {}\n self._lifecycle_handlers_lock = threading.Lock()\n self._rpc: ServerRpc | None = None\n self._negotiated_protocol_version: int | None = None\n if config.session_fs is not None:\n _validate_session_fs_config(config.session_fs)\n self._session_fs_config = config.session_fs\n\n @property\n def rpc(self) -> ServerRpc:\n \"\"\"Typed server-scoped RPC methods.\"\"\"\n if self._rpc is None:\n raise RuntimeError(\"Client is not connected. Call start() first.\")\n return self._rpc\n\n @property\n def actual_port(self) -> int | None:\n \"\"\"The actual TCP port the CLI server is listening on, if using TCP transport.\n\n Useful for multi-client scenarios where a second client needs to connect\n to the same server. Only available after :meth:`start` completes and\n only when not using stdio transport.\n \"\"\"\n return self._actual_port\n\n def _parse_cli_url(self, url: str) -> tuple[str, int]:\n \"\"\"\n Parse CLI URL into host and port.\n\n Supports formats: \"host:port\", \"http://host:port\", \"https://host:port\",\n or just \"port\".\n\n Args:\n url: The CLI URL to parse.\n\n Returns:\n A tuple of (host, port).\n\n Raises:\n ValueError: If the URL format is invalid or the port is out of range.\n \"\"\"\n import re\n\n # Remove protocol if present\n clean_url = re.sub(r\"^https?://\", \"\", url)\n\n # Check if it's just a port number\n if clean_url.isdigit():\n port = int(clean_url)\n if port <= 0 or port > 65535:\n raise ValueError(f\"Invalid port in cli_url: {url}\")\n return (\"localhost\", port)\n\n # Parse host:port format\n parts = clean_url.split(\":\")\n if len(parts) != 2:\n raise ValueError(f\"Invalid cli_url format: {url}\")\n\n host = parts[0] if parts[0] else \"localhost\"\n try:\n port = int(parts[1])\n except ValueError as e:\n raise ValueError(f\"Invalid port in cli_url: {url}\") from e\n\n if port <= 0 or port > 65535:\n raise ValueError(f\"Invalid port in cli_url: {url}\")\n\n return (host, port)\n\n async def __aenter__(self) -> CopilotClient:\n \"\"\"\n Enter the async context manager.\n\n Automatically starts the CLI server and establishes a connection if not\n already connected.\n\n Returns:\n The CopilotClient instance.\n\n Example:\n >>> async with CopilotClient() as client:\n ... session = await client.create_session()\n ... await session.send(\"Hello!\")\n \"\"\"\n await self.start()\n return self\n\n async def __aexit__(\n self,\n exc_type: type[BaseException] | None = None,\n exc_val: BaseException | None = None,\n exc_tb: TracebackType | None = None,\n ) -> None:\n \"\"\"\n Exit the async context manager.\n\n Performs graceful cleanup by destroying all active sessions and stopping\n the CLI server.\n \"\"\"\n await self.stop()\n\n async def start(self) -> None:\n \"\"\"\n Start the CLI server and establish a connection.\n\n If connecting to an external server (via :class:`ExternalServerConfig`),\n only establishes the connection. Otherwise, spawns the CLI server process\n and then connects.\n\n This method is called automatically when creating a session if ``auto_start``\n is True (default).\n\n Raises:\n RuntimeError: If the server fails to start or the connection fails.\n\n Example:\n >>> client = CopilotClient(auto_start=False)\n >>> await client.start()\n >>> # Now ready to create sessions\n \"\"\"\n if self._state == \"connected\":\n return\n\n self._state = \"connecting\"\n\n try:\n # Only start CLI server process if not connecting to external server\n if not self._is_external_server:\n await self._start_cli_server()\n\n # Connect to the server\n await self._connect_to_server()\n\n # Verify protocol version compatibility\n await self._verify_protocol_version()\n\n if self._session_fs_config:\n await self._set_session_fs_provider()\n\n self._state = \"connected\"\n except ProcessExitedError as e:\n # Process exited with error - reraise as RuntimeError with stderr\n self._state = \"error\"\n raise RuntimeError(str(e)) from None\n except Exception as e:\n self._state = \"error\"\n # Check if process exited and capture any remaining stderr\n if self._process and hasattr(self._process, \"poll\"):\n return_code = self._process.poll()\n if return_code is not None and self._client:\n stderr_output = self._client.get_stderr_output()\n if stderr_output:\n raise RuntimeError(\n f\"CLI process exited with code {return_code}\\nstderr: {stderr_output}\"\n ) from e\n raise\n\n async def stop(self) -> None:\n \"\"\"\n Stop the CLI server and close all active sessions.\n\n This method performs graceful cleanup:\n 1. Closes all active sessions (releases in-memory resources)\n 2. Closes the JSON-RPC connection\n 3. Terminates the CLI server process (if spawned by this client)\n\n Note: session data on disk is preserved, so sessions can be resumed\n later. To permanently remove session data before stopping, call\n :meth:`delete_session` for each session first.\n\n Raises:\n ExceptionGroup[StopError]: If any errors occurred during cleanup.\n\n Example:\n >>> try:\n ... await client.stop()\n ... except* StopError as eg:\n ... for error in eg.exceptions:\n ... print(f\"Cleanup error: {error.message}\")\n \"\"\"\n errors: list[StopError] = []\n\n # Atomically take ownership of all sessions and clear the dict\n # so no other thread can access them\n with self._sessions_lock:\n sessions_to_destroy = list(self._sessions.values())\n self._sessions.clear()\n\n for session in sessions_to_destroy:\n try:\n await session.disconnect()\n except Exception as e:\n errors.append(\n StopError(message=f\"Failed to disconnect session {session.session_id}: {e}\")\n )\n\n # Close client\n if self._client:\n await self._client.stop()\n self._client = None\n self._rpc = None\n\n # Clear models cache\n async with self._models_cache_lock:\n self._models_cache = None\n\n # Kill CLI process (only if we spawned it)\n if self._process and not self._is_external_server:\n self._process.terminate()\n try:\n self._process.wait(timeout=5)\n except subprocess.TimeoutExpired:\n self._process.kill()\n self._process = None\n\n self._state = \"disconnected\"\n if not self._is_external_server:\n self._actual_port = None\n\n if errors:\n raise ExceptionGroup(\"errors during CopilotClient.stop()\", errors)\n\n async def force_stop(self) -> None:\n \"\"\"\n Forcefully stop the CLI server without graceful cleanup.\n\n Use this when :meth:`stop` fails or takes too long. This method:\n - Clears all sessions immediately without destroying them\n - Force closes the connection (closes the underlying transport)\n - Kills the CLI process (if spawned by this client)\n\n Example:\n >>> # If normal stop hangs, force stop\n >>> try:\n ... await asyncio.wait_for(client.stop(), timeout=5.0)\n ... except asyncio.TimeoutError:\n ... await client.force_stop()\n \"\"\"\n # Clear sessions immediately without trying to destroy them\n with self._sessions_lock:\n self._sessions.clear()\n\n # Close the transport first to signal the server immediately.\n # For external servers (TCP), this closes the socket.\n # For spawned processes (stdio), this kills the process.\n if self._process:\n try:\n if self._is_external_server:\n self._process.terminate() # closes the TCP socket\n else:\n self._process.kill()\n self._process = None\n except Exception:\n pass\n\n # Then clean up the JSON-RPC client\n if self._client:\n try:\n await self._client.stop()\n except Exception:\n pass # Ignore errors during force stop\n self._client = None\n self._rpc = None\n\n # Clear models cache\n async with self._models_cache_lock:\n self._models_cache = None\n\n self._state = \"disconnected\"\n if not self._is_external_server:\n self._actual_port = None\n\n async def create_session(\n self,\n *,\n on_permission_request: _PermissionHandlerFn,\n model: str | None = None,\n session_id: str | None = None,\n client_name: str | None = None,\n reasoning_effort: ReasoningEffort | None = None,\n tools: list[Tool] | None = None,\n system_message: SystemMessageConfig | None = None,\n available_tools: list[str] | None = None,\n excluded_tools: list[str] | None = None,\n on_user_input_request: UserInputHandler | None = None,\n hooks: SessionHooks | None = None,\n working_directory: str | None = None,\n provider: ProviderConfig | None = None,\n model_capabilities: ModelCapabilitiesOverride | None = None,\n streaming: bool | None = None,\n include_sub_agent_streaming_events: bool | None = None,\n mcp_servers: dict[str, MCPServerConfig] | None = None,\n custom_agents: list[CustomAgentConfig] | None = None,\n default_agent: DefaultAgentConfig | dict[str, Any] | None = None,\n agent: str | None = None,\n config_dir: str | None = None,\n enable_config_discovery: bool | None = None,\n skill_directories: list[str] | None = None,\n disabled_skills: list[str] | None = None,\n infinite_sessions: InfiniteSessionConfig | None = None,\n on_event: Callable[[SessionEvent], None] | None = None,\n commands: list[CommandDefinition] | None = None,\n on_elicitation_request: ElicitationHandler | None = None,\n create_session_fs_handler: CreateSessionFsHandler | None = None,\n github_token: str | None = None,\n ) -> CopilotSession:\n \"\"\"\n Create a new conversation session with the Copilot CLI.\n\n Sessions maintain conversation state, handle events, and manage tool execution.\n If the client is not connected and ``auto_start`` is enabled, this will\n automatically start the connection.\n\n Args:\n on_permission_request: Handler for permission requests. Use\n ``PermissionHandler.approve_all`` to allow all permissions.\n model: The model to use for the session (e.g. ``\"gpt-4\"``).\n session_id: Optional session ID. If not provided, a UUID is generated.\n client_name: Optional client name for identification.\n reasoning_effort: Reasoning effort level for the model.\n tools: Custom tools to register with the session.\n system_message: System message configuration.\n available_tools: Allowlist of built-in tools to enable.\n excluded_tools: List of built-in tools to disable.\n on_user_input_request: Handler for user input requests.\n hooks: Lifecycle hooks for the session.\n working_directory: Working directory for the session.\n provider: Provider configuration for Azure or custom endpoints.\n model_capabilities: Override individual model capabilities resolved by the runtime.\n streaming: Whether to enable streaming responses.\n include_sub_agent_streaming_events: Whether to include sub-agent streaming\n delta events (e.g., ``assistant.message_delta``,\n ``assistant.reasoning_delta``, ``assistant.streaming_delta`` with\n ``agentId`` set). When False, only non-streaming sub-agent events and\n ``subagent.*`` lifecycle events are forwarded. Defaults to True.\n mcp_servers: MCP server configurations.\n custom_agents: Custom agent configurations.\n default_agent: Configuration for the default agent,\n including tool visibility controls.\n agent: Agent to use for the session.\n config_dir: Override for the configuration directory.\n enable_config_discovery: When True, automatically discovers MCP server\n configurations (e.g. ``.mcp.json``, ``.vscode/mcp.json``) and skill\n directories from the working directory and merges them with any\n explicitly provided ``mcp_servers`` and ``skill_directories``, with\n explicit values taking precedence on name collision. Custom instruction\n files (``.github/copilot-instructions.md``, ``AGENTS.md``, etc.) are\n always loaded regardless of this setting.\n skill_directories: Directories to search for skills.\n disabled_skills: Skills to disable.\n infinite_sessions: Infinite session configuration.\n on_event: Callback for session events.\n\n Returns:\n A :class:`CopilotSession` instance for the new session.\n\n Raises:\n RuntimeError: If the client is not connected and auto_start is disabled.\n ValueError: If ``on_permission_request`` is not a valid callable.\n\n Example:\n >>> session = await client.create_session(\n ... on_permission_request=PermissionHandler.approve_all,\n ... )\n >>>\n >>> # Session with model and streaming\n >>> session = await client.create_session(\n ... on_permission_request=PermissionHandler.approve_all,\n ... model=\"gpt-4\",\n ... streaming=True,\n ... )\n \"\"\"\n if not on_permission_request or not callable(on_permission_request):\n raise ValueError(\n \"A valid on_permission_request handler is required. \"\n \"Use PermissionHandler.approve_all or provide a custom handler.\"\n )\n if not self._client:\n if self._auto_start:\n await self.start()\n else:\n raise RuntimeError(\"Client not connected. Call start() first.\")\n\n tool_defs = []\n if tools:\n for tool in tools:\n definition: dict[str, Any] = {\n \"name\": tool.name,\n \"description\": tool.description,\n }\n if tool.parameters:\n definition[\"parameters\"] = tool.parameters\n if tool.overrides_built_in_tool:\n definition[\"overridesBuiltInTool\"] = True\n if tool.skip_permission:\n definition[\"skipPermission\"] = True\n tool_defs.append(definition)\n\n payload: dict[str, Any] = {}\n if model:\n payload[\"model\"] = model\n if client_name:\n payload[\"clientName\"] = client_name\n if reasoning_effort:\n payload[\"reasoningEffort\"] = reasoning_effort\n if tool_defs:\n payload[\"tools\"] = tool_defs\n\n wire_system_message, transform_callbacks = _extract_transform_callbacks(system_message)\n if wire_system_message:\n payload[\"systemMessage\"] = wire_system_message\n\n if available_tools is not None:\n payload[\"availableTools\"] = available_tools\n if excluded_tools is not None:\n payload[\"excludedTools\"] = excluded_tools\n\n # Always enable permission request callback\n payload[\"requestPermission\"] = True\n\n # Enable user input request callback if handler provided\n if on_user_input_request:\n payload[\"requestUserInput\"] = True\n\n # Enable elicitation request callback if handler provided\n payload[\"requestElicitation\"] = bool(on_elicitation_request)\n\n # Serialize commands (name + description only) into payload\n if commands:\n payload[\"commands\"] = [\n {\"name\": cmd.name, \"description\": cmd.description} for cmd in commands\n ]\n\n # Enable hooks callback if any hook handler provided\n if hooks and any(hooks.values()):\n payload[\"hooks\"] = True\n\n # Add GitHub token for per-session authentication\n if github_token is not None:\n payload[\"gitHubToken\"] = github_token\n\n # Add working directory if provided\n if working_directory:\n payload[\"workingDirectory\"] = working_directory\n\n # Add streaming option if provided\n if streaming is not None:\n payload[\"streaming\"] = streaming\n\n # Include sub-agent streaming events (defaults to True)\n payload[\"includeSubAgentStreamingEvents\"] = (\n include_sub_agent_streaming_events\n if include_sub_agent_streaming_events is not None\n else True\n )\n\n # Add provider configuration if provided\n if provider:\n payload[\"provider\"] = self._convert_provider_to_wire_format(provider)\n\n # Add model capabilities override if provided\n if model_capabilities:\n payload[\"modelCapabilities\"] = _capabilities_to_dict(model_capabilities)\n\n # Add MCP servers configuration if provided\n if mcp_servers:\n payload[\"mcpServers\"] = mcp_servers\n payload[\"envValueMode\"] = \"direct\"\n\n # Add custom agents configuration if provided\n if custom_agents:\n payload[\"customAgents\"] = [\n self._convert_custom_agent_to_wire_format(agent) for agent in custom_agents\n ]\n\n # Add default agent configuration if provided\n if default_agent:\n payload[\"defaultAgent\"] = self._convert_default_agent_to_wire_format(default_agent)\n\n # Add agent selection if provided\n if agent:\n payload[\"agent\"] = agent\n\n # Add config directory override if provided\n if config_dir:\n payload[\"configDir\"] = config_dir\n\n # Add config discovery flag if provided\n if enable_config_discovery is not None:\n payload[\"enableConfigDiscovery\"] = enable_config_discovery\n\n # Add skill directories configuration if provided\n if skill_directories:\n payload[\"skillDirectories\"] = skill_directories\n\n # Add disabled skills configuration if provided\n if disabled_skills:\n payload[\"disabledSkills\"] = disabled_skills\n\n # Add infinite sessions configuration if provided\n if infinite_sessions:\n wire_config: dict[str, Any] = {}\n if \"enabled\" in infinite_sessions:\n wire_config[\"enabled\"] = infinite_sessions[\"enabled\"]\n if \"background_compaction_threshold\" in infinite_sessions:\n wire_config[\"backgroundCompactionThreshold\"] = infinite_sessions[\n \"background_compaction_threshold\"\n ]\n if \"buffer_exhaustion_threshold\" in infinite_sessions:\n wire_config[\"bufferExhaustionThreshold\"] = infinite_sessions[\n \"buffer_exhaustion_threshold\"\n ]\n payload[\"infiniteSessions\"] = wire_config\n\n if not self._client:\n raise RuntimeError(\"Client not connected\")\n\n actual_session_id = session_id or str(uuid.uuid4())\n payload[\"sessionId\"] = actual_session_id\n\n # Propagate W3C Trace Context to CLI if OpenTelemetry is active\n trace_ctx = get_trace_context()\n payload.update(trace_ctx)\n\n # Create and register the session before issuing the RPC so that\n # events emitted by the CLI (e.g. session.start) are not dropped.\n session = CopilotSession(actual_session_id, self._client, workspace_path=None)\n if self._session_fs_config:\n if create_session_fs_handler is None:\n raise ValueError(\n \"create_session_fs_handler is required in session config when \"\n \"session_fs is enabled in client options.\"\n )\n session._client_session_apis.session_fs = create_session_fs_adapter(\n create_session_fs_handler(session)\n )\n session._register_tools(tools)\n session._register_commands(commands)\n session._register_permission_handler(on_permission_request)\n if on_user_input_request:\n session._register_user_input_handler(on_user_input_request)\n if on_elicitation_request:\n session._register_elicitation_handler(on_elicitation_request)\n if hooks:\n session._register_hooks(hooks)\n if transform_callbacks:\n session._register_transform_callbacks(transform_callbacks)\n if on_event:\n session.on(on_event)\n with self._sessions_lock:\n self._sessions[actual_session_id] = session\n\n try:\n response = await self._client.request(\"session.create\", payload)\n session._workspace_path = response.get(\"workspacePath\")\n capabilities = response.get(\"capabilities\")\n session._set_capabilities(capabilities)\n except BaseException:\n with self._sessions_lock:\n self._sessions.pop(actual_session_id, None)\n raise\n\n return session\n\n async def resume_session(\n self,\n session_id: str,\n *,\n on_permission_request: _PermissionHandlerFn,\n model: str | None = None,\n client_name: str | None = None,\n reasoning_effort: ReasoningEffort | None = None,\n tools: list[Tool] | None = None,\n system_message: SystemMessageConfig | None = None,\n available_tools: list[str] | None = None,\n excluded_tools: list[str] | None = None,\n on_user_input_request: UserInputHandler | None = None,\n hooks: SessionHooks | None = None,\n working_directory: str | None = None,\n provider: ProviderConfig | None = None,\n model_capabilities: ModelCapabilitiesOverride | None = None,\n streaming: bool | None = None,\n include_sub_agent_streaming_events: bool | None = None,\n mcp_servers: dict[str, MCPServerConfig] | None = None,\n custom_agents: list[CustomAgentConfig] | None = None,\n default_agent: DefaultAgentConfig | dict[str, Any] | None = None,\n agent: str | None = None,\n config_dir: str | None = None,\n enable_config_discovery: bool | None = None,\n skill_directories: list[str] | None = None,\n disabled_skills: list[str] | None = None,\n infinite_sessions: InfiniteSessionConfig | None = None,\n on_event: Callable[[SessionEvent], None] | None = None,\n commands: list[CommandDefinition] | None = None,\n on_elicitation_request: ElicitationHandler | None = None,\n create_session_fs_handler: CreateSessionFsHandler | None = None,\n github_token: str | None = None,\n continue_pending_work: bool | None = None,\n ) -> CopilotSession:\n \"\"\"\n Resume an existing conversation session by its ID.\n\n This allows you to continue a previous conversation, maintaining all\n conversation history. The session must have been previously created\n and not deleted.\n\n Args:\n session_id: The ID of the session to resume.\n on_permission_request: Handler for permission requests. Use\n ``PermissionHandler.approve_all`` to allow all permissions.\n model: The model to use for the resumed session.\n client_name: Optional client name for identification.\n reasoning_effort: Reasoning effort level for the model.\n tools: Custom tools to register with the session.\n system_message: System message configuration.\n available_tools: Allowlist of built-in tools to enable.\n excluded_tools: List of built-in tools to disable.\n on_user_input_request: Handler for user input requests.\n hooks: Lifecycle hooks for the session.\n working_directory: Working directory for the session.\n provider: Provider configuration for Azure or custom endpoints.\n model_capabilities: Override individual model capabilities resolved by the runtime.\n streaming: Whether to enable streaming responses.\n include_sub_agent_streaming_events: Whether to include sub-agent streaming\n delta events (e.g., ``assistant.message_delta``,\n ``assistant.reasoning_delta``, ``assistant.streaming_delta`` with\n ``agentId`` set). When False, only non-streaming sub-agent events and\n ``subagent.*`` lifecycle events are forwarded. Defaults to True.\n mcp_servers: MCP server configurations.\n custom_agents: Custom agent configurations.\n default_agent: Configuration for the default agent,\n including tool visibility controls.\n agent: Agent to use for the session.\n config_dir: Override for the configuration directory.\n enable_config_discovery: When True, automatically discovers MCP server\n configurations (e.g. ``.mcp.json``, ``.vscode/mcp.json``) and skill\n directories from the working directory and merges them with any\n explicitly provided ``mcp_servers`` and ``skill_directories``, with\n explicit values taking precedence on name collision. Custom instruction\n files (``.github/copilot-instructions.md``, ``AGENTS.md``, etc.) are\n always loaded regardless of this setting.\n skill_directories: Directories to search for skills.\n disabled_skills: Skills to disable.\n infinite_sessions: Infinite session configuration.\n on_event: Callback for session events.\n continue_pending_work: When True, instructs the runtime to continue any\n tool calls or permission prompts that were still pending when the\n session was last suspended. When False (the default), the runtime\n treats pending work as interrupted on resume.\n\n Returns:\n A :class:`CopilotSession` instance for the resumed session.\n\n Raises:\n RuntimeError: If the session does not exist or the client is not connected.\n ValueError: If ``on_permission_request`` is not a valid callable.\n\n Example:\n >>> session = await client.resume_session(\n ... \"session-123\",\n ... on_permission_request=PermissionHandler.approve_all,\n ... )\n >>>\n >>> # Resume with new tools\n >>> session = await client.resume_session(\n ... \"session-123\",\n ... on_permission_request=PermissionHandler.approve_all,\n ... tools=[my_new_tool],\n ... )\n \"\"\"\n if not on_permission_request or not callable(on_permission_request):\n raise ValueError(\n \"A valid on_permission_request handler is required. \"\n \"Use PermissionHandler.approve_all or provide a custom handler.\"\n )\n if not self._client:\n if self._auto_start:\n await self.start()\n else:\n raise RuntimeError(\"Client not connected. Call start() first.\")\n\n tool_defs = []\n if tools:\n for tool in tools:\n definition: dict[str, Any] = {\n \"name\": tool.name,\n \"description\": tool.description,\n }\n if tool.parameters:\n definition[\"parameters\"] = tool.parameters\n if tool.overrides_built_in_tool:\n definition[\"overridesBuiltInTool\"] = True\n if tool.skip_permission:\n definition[\"skipPermission\"] = True\n tool_defs.append(definition)\n\n payload: dict[str, Any] = {\"sessionId\": session_id}\n\n if client_name:\n payload[\"clientName\"] = client_name\n if model:\n payload[\"model\"] = model\n if reasoning_effort:\n payload[\"reasoningEffort\"] = reasoning_effort\n if tool_defs:\n payload[\"tools\"] = tool_defs\n wire_system_message, transform_callbacks = _extract_transform_callbacks(system_message)\n if wire_system_message:\n payload[\"systemMessage\"] = wire_system_message\n if available_tools is not None:\n payload[\"availableTools\"] = available_tools\n if excluded_tools is not None:\n payload[\"excludedTools\"] = excluded_tools\n if provider:\n payload[\"provider\"] = self._convert_provider_to_wire_format(provider)\n if model_capabilities:\n payload[\"modelCapabilities\"] = _capabilities_to_dict(model_capabilities)\n if streaming is not None:\n payload[\"streaming\"] = streaming\n\n # Include sub-agent streaming events (defaults to True)\n payload[\"includeSubAgentStreamingEvents\"] = (\n include_sub_agent_streaming_events\n if include_sub_agent_streaming_events is not None\n else True\n )\n\n # Always enable permission request callback\n payload[\"requestPermission\"] = True\n\n if on_user_input_request:\n payload[\"requestUserInput\"] = True\n\n # Enable elicitation request callback if handler provided\n payload[\"requestElicitation\"] = bool(on_elicitation_request)\n\n # Serialize commands (name + description only) into payload\n if commands:\n payload[\"commands\"] = [\n {\"name\": cmd.name, \"description\": cmd.description} for cmd in commands\n ]\n\n if hooks and any(hooks.values()):\n payload[\"hooks\"] = True\n\n # Add GitHub token for per-session authentication\n if github_token is not None:\n payload[\"gitHubToken\"] = github_token\n\n if working_directory:\n payload[\"workingDirectory\"] = working_directory\n if config_dir:\n payload[\"configDir\"] = config_dir\n if enable_config_discovery is not None:\n payload[\"enableConfigDiscovery\"] = enable_config_discovery\n\n if continue_pending_work is not None:\n payload[\"continuePendingWork\"] = continue_pending_work\n\n # TODO: disable_resume is not a keyword arg yet; keeping for future use\n if mcp_servers:\n payload[\"mcpServers\"] = mcp_servers\n payload[\"envValueMode\"] = \"direct\"\n\n if custom_agents:\n payload[\"customAgents\"] = [\n self._convert_custom_agent_to_wire_format(a) for a in custom_agents\n ]\n\n # Add default agent configuration if provided\n if default_agent:\n payload[\"defaultAgent\"] = self._convert_default_agent_to_wire_format(default_agent)\n\n if agent:\n payload[\"agent\"] = agent\n if skill_directories:\n payload[\"skillDirectories\"] = skill_directories\n if disabled_skills:\n payload[\"disabledSkills\"] = disabled_skills\n\n if infinite_sessions:\n wire_config: dict[str, Any] = {}\n if \"enabled\" in infinite_sessions:\n wire_config[\"enabled\"] = infinite_sessions[\"enabled\"]\n if \"background_compaction_threshold\" in infinite_sessions:\n wire_config[\"backgroundCompactionThreshold\"] = infinite_sessions[\n \"background_compaction_threshold\"\n ]\n if \"buffer_exhaustion_threshold\" in infinite_sessions:\n wire_config[\"bufferExhaustionThreshold\"] = infinite_sessions[\n \"buffer_exhaustion_threshold\"\n ]\n payload[\"infiniteSessions\"] = wire_config\n\n if not self._client:\n raise RuntimeError(\"Client not connected\")\n\n # Propagate W3C Trace Context to CLI if OpenTelemetry is active\n trace_ctx = get_trace_context()\n payload.update(trace_ctx)\n\n # Create and register the session before issuing the RPC so that\n # events emitted by the CLI (e.g. session.start) are not dropped.\n session = CopilotSession(session_id, self._client, workspace_path=None)\n if self._session_fs_config:\n if create_session_fs_handler is None:\n raise ValueError(\n \"create_session_fs_handler is required in session config when \"\n \"session_fs is enabled in client options.\"\n )\n session._client_session_apis.session_fs = create_session_fs_adapter(\n create_session_fs_handler(session)\n )\n session._register_tools(tools)\n session._register_commands(commands)\n session._register_permission_handler(on_permission_request)\n if on_user_input_request:\n session._register_user_input_handler(on_user_input_request)\n if on_elicitation_request:\n session._register_elicitation_handler(on_elicitation_request)\n if hooks:\n session._register_hooks(hooks)\n if transform_callbacks:\n session._register_transform_callbacks(transform_callbacks)\n if on_event:\n session.on(on_event)\n with self._sessions_lock:\n self._sessions[session_id] = session\n\n try:\n response = await self._client.request(\"session.resume\", payload)\n session._workspace_path = response.get(\"workspacePath\")\n capabilities = response.get(\"capabilities\")\n session._set_capabilities(capabilities)\n except BaseException:\n with self._sessions_lock:\n self._sessions.pop(session_id, None)\n raise\n\n return session\n\n def get_state(self) -> ConnectionState:\n \"\"\"\n Get the current connection state of the client.\n\n Returns:\n The current connection state: \"disconnected\", \"connecting\",\n \"connected\", or \"error\".\n\n Example:\n >>> if client.get_state() == \"connected\":\n ... session = await client.create_session()\n \"\"\"\n return self._state\n\n async def ping(self, message: str | None = None) -> PingResponse:\n \"\"\"\n Send a ping request to the server to verify connectivity.\n\n Args:\n message: Optional message to include in the ping.\n\n Returns:\n A PingResponse object containing the ping response.\n\n Raises:\n RuntimeError: If the client is not connected.\n\n Example:\n >>> response = await client.ping(\"health check\")\n >>> print(f\"Server responded at {response.timestamp}\")\n \"\"\"\n if not self._client:\n raise RuntimeError(\"Client not connected\")\n\n result = await self._client.request(\"ping\", {\"message\": message})\n return PingResponse.from_dict(result)\n\n async def get_status(self) -> GetStatusResponse:\n \"\"\"\n Get CLI status including version and protocol information.\n\n Returns:\n A GetStatusResponse object containing version and protocolVersion.\n\n Raises:\n RuntimeError: If the client is not connected.\n\n Example:\n >>> status = await client.get_status()\n >>> print(f\"CLI version: {status.version}\")\n \"\"\"\n if not self._client:\n raise RuntimeError(\"Client not connected\")\n\n result = await self._client.request(\"status.get\", {})\n return GetStatusResponse.from_dict(result)\n\n async def get_auth_status(self) -> GetAuthStatusResponse:\n \"\"\"\n Get current authentication status.\n\n Returns:\n A GetAuthStatusResponse object containing authentication state.\n\n Raises:\n RuntimeError: If the client is not connected.\n\n Example:\n >>> auth = await client.get_auth_status()\n >>> if auth.isAuthenticated:\n ... print(f\"Logged in as {auth.login}\")\n \"\"\"\n if not self._client:\n raise RuntimeError(\"Client not connected\")\n\n result = await self._client.request(\"auth.getStatus\", {})\n return GetAuthStatusResponse.from_dict(result)\n\n async def list_models(self) -> list[ModelInfo]:\n \"\"\"\n List available models with their metadata.\n\n Results are cached after the first successful call to avoid rate limiting.\n The cache is cleared when the client disconnects.\n\n If a custom ``on_list_models`` handler was provided in the client options,\n it is called instead of querying the CLI server. The handler may be sync\n or async.\n\n Returns:\n A list of ModelInfo objects with model details.\n\n Raises:\n RuntimeError: If the client is not connected (when no custom handler is set).\n Exception: If not authenticated.\n\n Example:\n >>> models = await client.list_models()\n >>> for model in models:\n ... print(f\"{model.id}: {model.name}\")\n \"\"\"\n # Use asyncio lock to prevent race condition with concurrent calls\n async with self._models_cache_lock:\n # Check cache (already inside lock)\n if self._models_cache is not None:\n return list(self._models_cache) # Return a copy to prevent cache mutation\n\n if self._on_list_models:\n # Use custom handler instead of CLI RPC\n result = self._on_list_models()\n if inspect.isawaitable(result):\n models = cast(list[ModelInfo], await result)\n else:\n models = cast(list[ModelInfo], result)\n else:\n if not self._client:\n raise RuntimeError(\"Client not connected\")\n\n # Cache miss - fetch from backend while holding lock\n response = await self._client.request(\"models.list\", {})\n models_data = response.get(\"models\", [])\n models = [ModelInfo.from_dict(model) for model in models_data]\n\n # Update cache before releasing lock (copy to prevent external mutation)\n self._models_cache = list(models)\n\n return list(models) # Return a copy to prevent cache mutation\n\n async def list_sessions(self, filter: SessionListFilter | None = None) -> list[SessionMetadata]:\n \"\"\"\n List all available sessions known to the server.\n\n Returns metadata about each session including ID, timestamps, and summary.\n\n Args:\n filter: Optional filter to narrow down the list of sessions by cwd, git root,\n repository, or branch.\n\n Returns:\n A list of SessionMetadata objects.\n\n Raises:\n RuntimeError: If the client is not connected.\n\n Example:\n >>> sessions = await client.list_sessions()\n >>> for session in sessions:\n ... print(f\"Session: {session.sessionId}\")\n >>> # Filter sessions by repository\n >>> from copilot.client import SessionListFilter\n >>> filtered = await client.list_sessions(SessionListFilter(repository=\"owner/repo\"))\n \"\"\"\n if not self._client:\n raise RuntimeError(\"Client not connected\")\n\n payload: dict = {}\n if filter is not None:\n payload[\"filter\"] = filter.to_dict()\n\n response = await self._client.request(\"session.list\", payload)\n sessions_data = response.get(\"sessions\", [])\n return [SessionMetadata.from_dict(session) for session in sessions_data]\n\n async def get_session_metadata(self, session_id: str) -> SessionMetadata | None:\n \"\"\"\n Get metadata for a specific session by ID.\n\n This provides an efficient O(1) lookup of a single session's metadata\n instead of listing all sessions. Returns None if the session is not found.\n\n Args:\n session_id: The ID of the session to look up.\n\n Returns:\n A SessionMetadata object, or None if the session was not found.\n\n Raises:\n RuntimeError: If the client is not connected.\n\n Example:\n >>> metadata = await client.get_session_metadata(\"session-123\")\n >>> if metadata:\n ... print(f\"Session started at: {metadata.startTime}\")\n \"\"\"\n if not self._client:\n raise RuntimeError(\"Client not connected\")\n\n response = await self._client.request(\"session.getMetadata\", {\"sessionId\": session_id})\n session_data = response.get(\"session\")\n if session_data is None:\n return None\n return SessionMetadata.from_dict(session_data)\n\n async def delete_session(self, session_id: str) -> None:\n \"\"\"\n Permanently delete a session and all its data from disk, including\n conversation history, planning state, and artifacts.\n\n Unlike :meth:`CopilotSession.disconnect`, which only releases in-memory\n resources and preserves session data for later resumption, this method\n is irreversible. The session cannot be resumed after deletion.\n\n Args:\n session_id: The ID of the session to delete.\n\n Raises:\n RuntimeError: If the client is not connected or deletion fails.\n\n Example:\n >>> await client.delete_session(\"session-123\")\n \"\"\"\n if not self._client:\n raise RuntimeError(\"Client not connected\")\n\n response = await self._client.request(\"session.delete\", {\"sessionId\": session_id})\n\n success = response.get(\"success\", False)\n if not success:\n error = response.get(\"error\", \"Unknown error\")\n raise RuntimeError(f\"Failed to delete session {session_id}: {error}\")\n\n # Remove from local sessions map if present\n with self._sessions_lock:\n if session_id in self._sessions:\n del self._sessions[session_id]\n\n async def get_last_session_id(self) -> str | None:\n \"\"\"\n Get the ID of the most recently updated session.\n\n This is useful for resuming the last conversation when the session ID\n was not stored.\n\n Returns:\n The session ID, or None if no sessions exist.\n\n Raises:\n RuntimeError: If the client is not connected.\n\n Example:\n >>> last_id = await client.get_last_session_id()\n >>> if last_id:\n ... config = {\"on_permission_request\": PermissionHandler.approve_all}\n ... session = await client.resume_session(last_id, config)\n \"\"\"\n if not self._client:\n raise RuntimeError(\"Client not connected\")\n\n response = await self._client.request(\"session.getLastId\", {})\n return response.get(\"sessionId\")\n\n async def get_foreground_session_id(self) -> str | None:\n \"\"\"\n Get the ID of the session currently displayed in the TUI.\n\n This is only available when connecting to a server running in TUI+server mode\n (--ui-server).\n\n Returns:\n The session ID, or None if no foreground session is set.\n\n Raises:\n RuntimeError: If the client is not connected.\n\n Example:\n >>> session_id = await client.get_foreground_session_id()\n >>> if session_id:\n ... print(f\"TUI is displaying session: {session_id}\")\n \"\"\"\n if not self._client:\n raise RuntimeError(\"Client not connected\")\n\n response = await self._client.request(\"session.getForeground\", {})\n return response.get(\"sessionId\")\n\n async def set_foreground_session_id(self, session_id: str) -> None:\n \"\"\"\n Request the TUI to switch to displaying the specified session.\n\n This is only available when connecting to a server running in TUI+server mode\n (--ui-server).\n\n Args:\n session_id: The ID of the session to display in the TUI.\n\n Raises:\n RuntimeError: If the client is not connected or the operation fails.\n\n Example:\n >>> await client.set_foreground_session_id(\"session-123\")\n \"\"\"\n if not self._client:\n raise RuntimeError(\"Client not connected\")\n\n response = await self._client.request(\"session.setForeground\", {\"sessionId\": session_id})\n\n success = response.get(\"success\", False)\n if not success:\n error = response.get(\"error\", \"Unknown error\")\n raise RuntimeError(f\"Failed to set foreground session: {error}\")\n\n @overload\n def on(self, handler: SessionLifecycleHandler, /) -> HandlerUnsubcribe: ...\n\n @overload\n def on(\n self, event_type: SessionLifecycleEventType, /, handler: SessionLifecycleHandler\n ) -> HandlerUnsubcribe: ...\n\n def on(\n self,\n event_type_or_handler: SessionLifecycleEventType | SessionLifecycleHandler,\n /,\n handler: SessionLifecycleHandler | None = None,\n ) -> HandlerUnsubcribe:\n \"\"\"\n Subscribe to session lifecycle events.\n\n Lifecycle events are emitted when sessions are created, deleted, updated,\n or change foreground/background state (in TUI+server mode).\n\n Can be called in two ways:\n - on(handler): Subscribe to all lifecycle events\n - on(event_type, handler): Subscribe to a specific event type\n\n Args:\n event_type_or_handler: Either a specific event type to listen for,\n or a handler function for all events.\n handler: Handler function when subscribing to a specific event type.\n\n Returns:\n A function that, when called, unsubscribes the handler.\n\n Example:\n >>> # Subscribe to specific event type\n >>> unsubscribe = client.on(\"session.foreground\", lambda e: print(e.sessionId))\n >>>\n >>> # Subscribe to all events\n >>> unsubscribe = client.on(lambda e: print(f\"{e.type}: {e.sessionId}\"))\n >>>\n >>> # Later, to stop receiving events:\n >>> unsubscribe()\n \"\"\"\n with self._lifecycle_handlers_lock:\n if callable(event_type_or_handler) and handler is None:\n # Wildcard subscription: on(handler)\n wildcard_handler = event_type_or_handler\n self._lifecycle_handlers.append(wildcard_handler)\n\n def unsubscribe_wildcard() -> None:\n with self._lifecycle_handlers_lock:\n if wildcard_handler in self._lifecycle_handlers:\n self._lifecycle_handlers.remove(wildcard_handler)\n\n return unsubscribe_wildcard\n elif isinstance(event_type_or_handler, str) and handler is not None:\n # Typed subscription: on(event_type, handler)\n event_type = cast(SessionLifecycleEventType, event_type_or_handler)\n if event_type not in self._typed_lifecycle_handlers:\n self._typed_lifecycle_handlers[event_type] = []\n self._typed_lifecycle_handlers[event_type].append(handler)\n\n def unsubscribe_typed() -> None:\n with self._lifecycle_handlers_lock:\n handlers = self._typed_lifecycle_handlers.get(event_type, [])\n if handler in handlers:\n handlers.remove(handler)\n\n return unsubscribe_typed\n else:\n raise ValueError(\"Invalid arguments: use on(handler) or on(event_type, handler)\")\n\n def _dispatch_lifecycle_event(self, event: SessionLifecycleEvent) -> None:\n \"\"\"Dispatch a lifecycle event to all registered handlers.\"\"\"\n with self._lifecycle_handlers_lock:\n # Copy handlers to avoid holding lock during callbacks\n typed_handlers = list(self._typed_lifecycle_handlers.get(event.type, []))\n wildcard_handlers = list(self._lifecycle_handlers)\n\n # Dispatch to typed handlers\n for handler in typed_handlers:\n try:\n handler(event)\n except Exception:\n pass # Ignore handler errors\n\n # Dispatch to wildcard handlers\n for handler in wildcard_handlers:\n try:\n handler(event)\n except Exception:\n pass # Ignore handler errors\n\n async def _verify_protocol_version(self) -> None:\n \"\"\"Verify that the server's protocol version is within the supported range\n and store the negotiated version.\"\"\"\n max_version = get_sdk_protocol_version()\n ping_result = await self.ping()\n server_version = ping_result.protocolVersion\n\n if server_version is None:\n raise RuntimeError(\n \"SDK protocol version mismatch: \"\n f\"SDK supports versions {MIN_PROTOCOL_VERSION}-{max_version}\"\n \", but server does not report a protocol version. \"\n \"Please update your server to ensure compatibility.\"\n )\n\n if server_version < MIN_PROTOCOL_VERSION or server_version > max_version:\n raise RuntimeError(\n \"SDK protocol version mismatch: \"\n f\"SDK supports versions {MIN_PROTOCOL_VERSION}-{max_version}\"\n f\", but server reports version {server_version}. \"\n \"Please update your SDK or server to ensure compatibility.\"\n )\n\n self._negotiated_protocol_version = server_version\n\n def _convert_provider_to_wire_format(\n self, provider: ProviderConfig | dict[str, Any]\n ) -> dict[str, Any]:\n \"\"\"\n Convert provider config from snake_case to camelCase wire format.\n\n Args:\n provider: The provider configuration in snake_case format.\n\n Returns:\n The provider configuration in camelCase wire format.\n \"\"\"\n wire_provider: dict[str, Any] = {\"type\": provider.get(\"type\")}\n if \"base_url\" in provider:\n wire_provider[\"baseUrl\"] = provider[\"base_url\"]\n if \"api_key\" in provider:\n wire_provider[\"apiKey\"] = provider[\"api_key\"]\n if \"wire_api\" in provider:\n wire_provider[\"wireApi\"] = provider[\"wire_api\"]\n if \"bearer_token\" in provider:\n wire_provider[\"bearerToken\"] = provider[\"bearer_token\"]\n if \"headers\" in provider:\n wire_provider[\"headers\"] = provider[\"headers\"]\n if \"azure\" in provider:\n azure = provider[\"azure\"]\n wire_azure: dict[str, Any] = {}\n if \"api_version\" in azure:\n wire_azure[\"apiVersion\"] = azure[\"api_version\"]\n if wire_azure:\n wire_provider[\"azure\"] = wire_azure\n return wire_provider\n\n def _convert_custom_agent_to_wire_format(\n self, agent: CustomAgentConfig | dict[str, Any]\n ) -> dict[str, Any]:\n \"\"\"\n Convert custom agent config from snake_case to camelCase wire format.\n\n Args:\n agent: The custom agent configuration in snake_case format.\n\n Returns:\n The custom agent configuration in camelCase wire format.\n \"\"\"\n wire_agent: dict[str, Any] = {\"name\": agent.get(\"name\"), \"prompt\": agent.get(\"prompt\")}\n if \"display_name\" in agent:\n wire_agent[\"displayName\"] = agent[\"display_name\"]\n if \"description\" in agent:\n wire_agent[\"description\"] = agent[\"description\"]\n if \"tools\" in agent:\n wire_agent[\"tools\"] = agent[\"tools\"]\n if \"mcp_servers\" in agent:\n wire_agent[\"mcpServers\"] = agent[\"mcp_servers\"]\n if \"infer\" in agent:\n wire_agent[\"infer\"] = agent[\"infer\"]\n if \"skills\" in agent:\n wire_agent[\"skills\"] = agent[\"skills\"]\n return wire_agent\n\n def _convert_default_agent_to_wire_format(\n self, config: DefaultAgentConfig | dict[str, Any]\n ) -> dict[str, Any]:\n \"\"\"\n Convert default agent config from snake_case to camelCase wire format.\n\n Args:\n config: The default agent configuration in snake_case format.\n\n Returns:\n The default agent configuration in camelCase wire format.\n \"\"\"\n wire: dict[str, Any] = {}\n if \"excluded_tools\" in config:\n wire[\"excludedTools\"] = config[\"excluded_tools\"]\n return wire\n\n async def _start_cli_server(self) -> None:\n \"\"\"\n Start the CLI server process.\n\n This spawns the CLI server as a subprocess using the configured transport\n mode (stdio or TCP).\n\n Raises:\n RuntimeError: If the server fails to start or times out.\n \"\"\"\n assert isinstance(self._config, SubprocessConfig)\n cfg = self._config\n\n cli_path = cfg.cli_path\n assert cli_path is not None # resolved in __init__\n\n # Verify CLI exists\n if not os.path.exists(cli_path):\n original_path = cli_path\n if (cli_path := shutil.which(cli_path)) is None:\n raise RuntimeError(f\"Copilot CLI not found at {original_path}\")\n\n # Start with user-provided cli_args, then add SDK-managed args\n args = list(cfg.cli_args) + [\n \"--headless\",\n \"--no-auto-update\",\n \"--log-level\",\n cfg.log_level,\n ]\n\n # Add auth-related flags\n if cfg.github_token:\n args.extend([\"--auth-token-env\", \"COPILOT_SDK_AUTH_TOKEN\"])\n if not cfg.use_logged_in_user:\n args.append(\"--no-auto-login\")\n\n if cfg.session_idle_timeout_seconds is not None and cfg.session_idle_timeout_seconds > 0:\n args.extend([\"--session-idle-timeout\", str(cfg.session_idle_timeout_seconds)])\n\n # If cli_path is a .js file, run it with node\n # Note that we can't rely on the shebang as Windows doesn't support it\n if cli_path.endswith(\".js\"):\n args = [\"node\", cli_path] + args\n else:\n args = [cli_path] + args\n\n # Get environment variables\n if cfg.env is None:\n env = dict(os.environ)\n else:\n env = dict(cfg.env)\n\n # Set auth token in environment if provided\n if cfg.github_token:\n env[\"COPILOT_SDK_AUTH_TOKEN\"] = cfg.github_token\n\n # Set OpenTelemetry environment variables if telemetry config is provided\n telemetry = cfg.telemetry\n if telemetry is not None:\n env[\"COPILOT_OTEL_ENABLED\"] = \"true\"\n if \"otlp_endpoint\" in telemetry:\n env[\"OTEL_EXPORTER_OTLP_ENDPOINT\"] = telemetry[\"otlp_endpoint\"]\n if \"file_path\" in telemetry:\n env[\"COPILOT_OTEL_FILE_EXPORTER_PATH\"] = telemetry[\"file_path\"]\n if \"exporter_type\" in telemetry:\n env[\"COPILOT_OTEL_EXPORTER_TYPE\"] = telemetry[\"exporter_type\"]\n if \"source_name\" in telemetry:\n env[\"COPILOT_OTEL_SOURCE_NAME\"] = telemetry[\"source_name\"]\n if \"capture_content\" in telemetry:\n env[\"OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT\"] = str(\n telemetry[\"capture_content\"]\n ).lower()\n\n # On Windows, hide the console window to avoid distracting users in GUI apps\n creationflags = subprocess.CREATE_NO_WINDOW if sys.platform == \"win32\" else 0\n\n cwd = cfg.cwd or os.getcwd()\n\n # Choose transport mode\n if cfg.use_stdio:\n args.append(\"--stdio\")\n # Use regular Popen with pipes (buffering=0 for unbuffered)\n self._process = subprocess.Popen(\n args,\n stdin=subprocess.PIPE,\n stdout=subprocess.PIPE,\n stderr=subprocess.PIPE,\n bufsize=0,\n cwd=cwd,\n env=env,\n creationflags=creationflags,\n )\n else:\n if cfg.port > 0:\n args.extend([\"--port\", str(cfg.port)])\n self._process = subprocess.Popen(\n args,\n stdin=subprocess.DEVNULL,\n stdout=subprocess.PIPE,\n stderr=subprocess.PIPE,\n cwd=cwd,\n env=env,\n creationflags=creationflags,\n )\n\n # For stdio mode, we're ready immediately\n if cfg.use_stdio:\n return\n\n # For TCP mode, wait for port announcement\n loop = asyncio.get_event_loop()\n process = self._process # Capture for closure\n\n async def read_port():\n if not process or not process.stdout:\n raise RuntimeError(\"Process not started or stdout not available\")\n while True:\n line = await loop.run_in_executor(None, process.stdout.readline)\n if not line:\n raise RuntimeError(\"CLI process exited before announcing port\")\n\n line_str = line.decode() if isinstance(line, bytes) else line\n match = re.search(r\"listening on port (\\d+)\", line_str, re.IGNORECASE)\n if match:\n self._actual_port = int(match.group(1))\n return\n\n try:\n await asyncio.wait_for(read_port(), timeout=10.0)\n except TimeoutError:\n raise RuntimeError(\"Timeout waiting for CLI server to start\")\n\n async def _connect_to_server(self) -> None:\n \"\"\"\n Connect to the CLI server via the configured transport.\n\n Uses either stdio or TCP based on the client configuration.\n\n Raises:\n RuntimeError: If the connection fails.\n \"\"\"\n use_stdio = isinstance(self._config, SubprocessConfig) and self._config.use_stdio\n if use_stdio:\n await self._connect_via_stdio()\n else:\n await self._connect_via_tcp()\n\n async def _connect_via_stdio(self) -> None:\n \"\"\"\n Connect to the CLI server via stdio pipes.\n\n Creates a JSON-RPC client using the CLI process's stdin/stdout.\n\n Raises:\n RuntimeError: If the CLI process is not started.\n \"\"\"\n if not self._process:\n raise RuntimeError(\"CLI process not started\")\n\n # Create JSON-RPC client with the process\n self._client = JsonRpcClient(self._process)\n self._client.on_close = lambda: setattr(self, \"_state\", \"disconnected\")\n self._rpc = ServerRpc(self._client)\n\n # Set up notification handler for session events\n # Note: This handler is called from the event loop (thread-safe scheduling)\n def handle_notification(method: str, params: dict):\n if method == \"session.event\":\n session_id = params[\"sessionId\"]\n event_dict = params[\"event\"]\n # Convert dict to SessionEvent object\n event = session_event_from_dict(event_dict)\n with self._sessions_lock:\n session = self._sessions.get(session_id)\n if session:\n session._dispatch_event(event)\n elif method == \"session.lifecycle\":\n # Handle session lifecycle events\n lifecycle_event = SessionLifecycleEvent.from_dict(params)\n self._dispatch_lifecycle_event(lifecycle_event)\n\n self._client.set_notification_handler(handle_notification)\n # Protocol v3 servers send tool calls / permission requests as broadcast events.\n # Protocol v2 servers use the older tool.call / permission.request RPC model.\n # We always register v2 adapters because handlers are set up before version\n # negotiation; a v3 server will simply never send these requests.\n self._client.set_request_handler(\"tool.call\", self._handle_tool_call_request_v2)\n self._client.set_request_handler(\"permission.request\", self._handle_permission_request_v2)\n self._client.set_request_handler(\"userInput.request\", self._handle_user_input_request)\n self._client.set_request_handler(\"hooks.invoke\", self._handle_hooks_invoke)\n self._client.set_request_handler(\n \"systemMessage.transform\", self._handle_system_message_transform\n )\n register_client_session_api_handlers(self._client, self._get_client_session_handlers)\n\n # Start listening for messages\n loop = asyncio.get_running_loop()\n self._client.start(loop)\n\n async def _connect_via_tcp(self) -> None:\n \"\"\"\n Connect to the CLI server via TCP socket.\n\n Creates a TCP connection to the server at the configured host and port.\n\n Raises:\n RuntimeError: If the server port is not available or connection fails.\n \"\"\"\n if not self._actual_port:\n raise RuntimeError(\"Server port not available\")\n\n # Create a TCP socket connection with timeout\n import socket\n\n # Connection timeout constant\n TCP_CONNECTION_TIMEOUT = 10 # seconds\n\n sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)\n sock.settimeout(TCP_CONNECTION_TIMEOUT)\n\n try:\n sock.connect((self._actual_host, self._actual_port))\n sock.settimeout(None) # Remove timeout after connection\n except OSError as e:\n raise RuntimeError(\n f\"Failed to connect to CLI server at {self._actual_host}:{self._actual_port}: {e}\"\n )\n\n # Create a file-like wrapper for the socket\n sock_file = sock.makefile(\"rwb\", buffering=0)\n\n # Create a mock process object that JsonRpcClient expects\n class SocketWrapper:\n def __init__(self, sock_file, sock_obj):\n self.stdin = sock_file\n self.stdout = sock_file\n self.stderr = None\n self._socket = sock_obj\n\n def terminate(self):\n import socket as _socket_mod\n\n # shutdown() sends TCP FIN to the server (triggering\n # server-side disconnect detection) and interrupts any\n # pending blocking reads on other threads immediately.\n try:\n self._socket.shutdown(_socket_mod.SHUT_RDWR)\n except OSError:\n pass # Safe to ignore — socket may already be closed\n # Close the file wrapper — makefile() holds its own\n # reference to the fd, so socket.close() alone won't\n # release the OS resource until the wrapper is closed too.\n try:\n self.stdin.close()\n except OSError:\n pass # Safe to ignore — already closed\n try:\n self._socket.close()\n except OSError:\n pass # Safe to ignore — already closed\n\n def kill(self):\n self.terminate()\n\n def wait(self, timeout=None):\n pass\n\n self._process = SocketWrapper(sock_file, sock) # type: ignore\n self._client = JsonRpcClient(self._process)\n self._client.on_close = lambda: setattr(self, \"_state\", \"disconnected\")\n self._rpc = ServerRpc(self._client)\n\n # Set up notification handler for session events\n def handle_notification(method: str, params: dict):\n if method == \"session.event\":\n session_id = params[\"sessionId\"]\n event_dict = params[\"event\"]\n # Convert dict to SessionEvent object\n event = session_event_from_dict(event_dict)\n session = self._sessions.get(session_id)\n if session:\n session._dispatch_event(event)\n elif method == \"session.lifecycle\":\n # Handle session lifecycle events\n lifecycle_event = SessionLifecycleEvent.from_dict(params)\n self._dispatch_lifecycle_event(lifecycle_event)\n\n self._client.set_notification_handler(handle_notification)\n # Protocol v3 servers send tool calls / permission requests as broadcast events.\n # Protocol v2 servers use the older tool.call / permission.request RPC model.\n # We always register v2 adapters; a v3 server will simply never send these requests.\n self._client.set_request_handler(\"tool.call\", self._handle_tool_call_request_v2)\n self._client.set_request_handler(\"permission.request\", self._handle_permission_request_v2)\n self._client.set_request_handler(\"userInput.request\", self._handle_user_input_request)\n self._client.set_request_handler(\"hooks.invoke\", self._handle_hooks_invoke)\n self._client.set_request_handler(\n \"systemMessage.transform\", self._handle_system_message_transform\n )\n register_client_session_api_handlers(self._client, self._get_client_session_handlers)\n\n # Start listening for messages\n loop = asyncio.get_running_loop()\n self._client.start(loop)\n\n async def _set_session_fs_provider(self) -> None:\n if not self._session_fs_config or not self._client:\n return\n\n await self._client.request(\n \"sessionFs.setProvider\",\n {\n \"initialCwd\": self._session_fs_config[\"initial_cwd\"],\n \"sessionStatePath\": self._session_fs_config[\"session_state_path\"],\n \"conventions\": self._session_fs_config[\"conventions\"],\n },\n )\n\n def _get_client_session_handlers(self, session_id: str) -> ClientSessionApiHandlers:\n with self._sessions_lock:\n session = self._sessions.get(session_id)\n if session is None:\n raise ValueError(f\"unknown session {session_id}\")\n return session._client_session_apis\n\n async def _handle_user_input_request(self, params: dict) -> dict:\n \"\"\"\n Handle a user input request from the CLI server.\n\n Args:\n params: The user input request parameters from the server.\n\n Returns:\n A dict containing the user's response.\n\n Raises:\n ValueError: If the request payload is invalid.\n \"\"\"\n session_id = params.get(\"sessionId\")\n question = params.get(\"question\")\n\n if not session_id or not question:\n raise ValueError(\"invalid user input request payload\")\n\n with self._sessions_lock:\n session = self._sessions.get(session_id)\n if not session:\n raise ValueError(f\"unknown session {session_id}\")\n\n result = await session._handle_user_input_request(params)\n return {\"answer\": result[\"answer\"], \"wasFreeform\": result[\"wasFreeform\"]}\n\n async def _handle_hooks_invoke(self, params: dict) -> dict:\n \"\"\"\n Handle a hooks invocation from the CLI server.\n\n Args:\n params: The hooks invocation parameters from the server.\n\n Returns:\n A dict containing the hook output.\n\n Raises:\n ValueError: If the request payload is invalid.\n \"\"\"\n session_id = params.get(\"sessionId\")\n hook_type = params.get(\"hookType\")\n input_data = params.get(\"input\")\n\n if not session_id or not hook_type:\n raise ValueError(\"invalid hooks invoke payload\")\n\n with self._sessions_lock:\n session = self._sessions.get(session_id)\n if not session:\n raise ValueError(f\"unknown session {session_id}\")\n\n output = await session._handle_hooks_invoke(hook_type, input_data)\n return {\"output\": output}\n\n async def _handle_system_message_transform(self, params: dict) -> dict:\n \"\"\"Handle a systemMessage.transform request from the CLI server.\"\"\"\n session_id = params.get(\"sessionId\")\n sections = params.get(\"sections\")\n\n if not session_id or not sections:\n raise ValueError(\"invalid systemMessage.transform payload\")\n\n with self._sessions_lock:\n session = self._sessions.get(session_id)\n if not session:\n raise ValueError(f\"unknown session {session_id}\")\n\n return await session._handle_system_message_transform(sections)\n\n # ========================================================================\n # Protocol v2 backward-compatibility adapters\n # ========================================================================\n\n async def _handle_tool_call_request_v2(self, params: dict) -> dict:\n \"\"\"Handle a v2-style tool.call RPC request from the server.\"\"\"\n session_id = params.get(\"sessionId\")\n tool_call_id = params.get(\"toolCallId\")\n tool_name = params.get(\"toolName\")\n\n if not session_id or not tool_call_id or not tool_name:\n raise ValueError(\"invalid tool call payload\")\n\n with self._sessions_lock:\n session = self._sessions.get(session_id)\n if not session:\n raise ValueError(f\"unknown session {session_id}\")\n\n handler = session._get_tool_handler(tool_name)\n if not handler:\n return {\n \"result\": {\n \"textResultForLlm\": (\n f\"Tool '{tool_name}' is not supported by this client instance.\"\n ),\n \"resultType\": \"failure\",\n \"error\": f\"tool '{tool_name}' not supported\",\n \"toolTelemetry\": {},\n }\n }\n\n arguments = params.get(\"arguments\")\n invocation = ToolInvocation(\n session_id=session_id,\n tool_call_id=tool_call_id,\n tool_name=tool_name,\n arguments=arguments,\n )\n\n tp = params.get(\"traceparent\")\n ts = params.get(\"tracestate\")\n\n try:\n with trace_context(tp, ts):\n result = handler(invocation)\n if inspect.isawaitable(result):\n result = await result\n\n tool_result: ToolResult = result # type: ignore[assignment]\n return {\n \"result\": {\n \"textResultForLlm\": tool_result.text_result_for_llm,\n \"resultType\": tool_result.result_type,\n \"error\": tool_result.error,\n \"toolTelemetry\": tool_result.tool_telemetry or {},\n }\n }\n except Exception as exc:\n return {\n \"result\": {\n \"textResultForLlm\": (\n \"Invoking this tool produced an error.\"\n \" Detailed information is not available.\"\n ),\n \"resultType\": \"failure\",\n \"error\": str(exc),\n \"toolTelemetry\": {},\n }\n }\n\n async def _handle_permission_request_v2(self, params: dict) -> dict:\n \"\"\"Handle a v2-style permission.request RPC request from the server.\"\"\"\n session_id = params.get(\"sessionId\")\n permission_request = params.get(\"permissionRequest\")\n\n if not session_id or not permission_request:\n raise ValueError(\"invalid permission request payload\")\n\n with self._sessions_lock:\n session = self._sessions.get(session_id)\n if not session:\n raise ValueError(f\"unknown session {session_id}\")\n\n try:\n perm_request = PermissionRequest.from_dict(permission_request)\n result = await session._handle_permission_request(perm_request)\n if result.kind == \"no-result\":\n raise ValueError(NO_RESULT_PERMISSION_V2_ERROR)\n return {\"result\": {\"kind\": result.kind}}\n except ValueError as exc:\n if str(exc) == NO_RESULT_PERMISSION_V2_ERROR:\n raise\n return {\n \"result\": {\n \"kind\": \"user-not-available\",\n }\n }\n except Exception: # pylint: disable=broad-except\n return {\n \"result\": {\n \"kind\": \"user-not-available\",\n }\n }\n" }, { "path": "python/copilot/generated/__init__.py", "content": "" }, { "path": "python/copilot/generated/rpc.py", "content": "\"\"\"\nAUTO-GENERATED FILE - DO NOT EDIT\nGenerated from: api.schema.json\n\"\"\"\n\nfrom typing import TYPE_CHECKING\n\nif TYPE_CHECKING:\n from .._jsonrpc import JsonRpcClient\n\nfrom collections.abc import Callable\nfrom dataclasses import dataclass\nfrom datetime import datetime\nfrom enum import Enum\nfrom typing import Any, Protocol, TypeVar, cast\nfrom uuid import UUID\n\nimport dateutil.parser\n\nT = TypeVar(\"T\")\nEnumT = TypeVar(\"EnumT\", bound=Enum)\n\n\ndef from_str(x: Any) -> str:\n assert isinstance(x, str)\n return x\n\ndef from_none(x: Any) -> Any:\n assert x is None\n return x\n\ndef from_union(fs, x):\n for f in fs:\n try:\n return f(x)\n except Exception:\n pass\n assert False\n\ndef from_int(x: Any) -> int:\n assert isinstance(x, int) and not isinstance(x, bool)\n return x\n\ndef from_bool(x: Any) -> bool:\n assert isinstance(x, bool)\n return x\n\ndef from_float(x: Any) -> float:\n assert isinstance(x, (float, int)) and not isinstance(x, bool)\n return float(x)\n\ndef to_float(x: Any) -> float:\n assert isinstance(x, (int, float))\n return x\n\ndef from_dict(f: Callable[[Any], T], x: Any) -> dict[str, T]:\n assert isinstance(x, dict)\n return { k: f(v) for (k, v) in x.items() }\n\ndef to_class(c: type[T], x: Any) -> dict:\n assert isinstance(x, c)\n return cast(Any, x).to_dict()\n\ndef from_list(f: Callable[[Any], T], x: Any) -> list[T]:\n assert isinstance(x, list)\n return [f(y) for y in x]\n\ndef to_enum(c: type[EnumT], x: Any) -> EnumT:\n assert isinstance(x, c)\n return x.value\n\ndef from_datetime(x: Any) -> datetime:\n return dateutil.parser.parse(x)\n\n@dataclass\nclass AccountGetQuotaRequest:\n git_hub_token: str | None = None\n \"\"\"GitHub token for per-user quota lookup. When provided, resolves this token to determine\n the user's quota instead of using the global auth.\n \"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'AccountGetQuotaRequest':\n assert isinstance(obj, dict)\n git_hub_token = from_union([from_str, from_none], obj.get(\"gitHubToken\"))\n return AccountGetQuotaRequest(git_hub_token)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.git_hub_token is not None:\n result[\"gitHubToken\"] = from_union([from_str, from_none], self.git_hub_token)\n return result\n\n@dataclass\nclass AccountQuotaSnapshot:\n entitlement_requests: int\n \"\"\"Number of requests included in the entitlement\"\"\"\n\n is_unlimited_entitlement: bool\n \"\"\"Whether the user has an unlimited usage entitlement\"\"\"\n\n overage: float\n \"\"\"Number of overage requests made this period\"\"\"\n\n overage_allowed_with_exhausted_quota: bool\n \"\"\"Whether overage is allowed when quota is exhausted\"\"\"\n\n remaining_percentage: float\n \"\"\"Percentage of entitlement remaining\"\"\"\n\n usage_allowed_with_exhausted_quota: bool\n \"\"\"Whether usage is still permitted after quota exhaustion\"\"\"\n\n used_requests: int\n \"\"\"Number of requests used so far this period\"\"\"\n\n reset_date: str | None = None\n \"\"\"Date when the quota resets (ISO 8601 string)\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'AccountQuotaSnapshot':\n assert isinstance(obj, dict)\n entitlement_requests = from_int(obj.get(\"entitlementRequests\"))\n is_unlimited_entitlement = from_bool(obj.get(\"isUnlimitedEntitlement\"))\n overage = from_float(obj.get(\"overage\"))\n overage_allowed_with_exhausted_quota = from_bool(obj.get(\"overageAllowedWithExhaustedQuota\"))\n remaining_percentage = from_float(obj.get(\"remainingPercentage\"))\n usage_allowed_with_exhausted_quota = from_bool(obj.get(\"usageAllowedWithExhaustedQuota\"))\n used_requests = from_int(obj.get(\"usedRequests\"))\n reset_date = from_union([from_str, from_none], obj.get(\"resetDate\"))\n return AccountQuotaSnapshot(entitlement_requests, is_unlimited_entitlement, overage, overage_allowed_with_exhausted_quota, remaining_percentage, usage_allowed_with_exhausted_quota, used_requests, reset_date)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"entitlementRequests\"] = from_int(self.entitlement_requests)\n result[\"isUnlimitedEntitlement\"] = from_bool(self.is_unlimited_entitlement)\n result[\"overage\"] = to_float(self.overage)\n result[\"overageAllowedWithExhaustedQuota\"] = from_bool(self.overage_allowed_with_exhausted_quota)\n result[\"remainingPercentage\"] = to_float(self.remaining_percentage)\n result[\"usageAllowedWithExhaustedQuota\"] = from_bool(self.usage_allowed_with_exhausted_quota)\n result[\"usedRequests\"] = from_int(self.used_requests)\n if self.reset_date is not None:\n result[\"resetDate\"] = from_union([from_str, from_none], self.reset_date)\n return result\n\n@dataclass\nclass AgentInfo:\n \"\"\"The newly selected custom agent\"\"\"\n\n description: str\n \"\"\"Description of the agent's purpose\"\"\"\n\n display_name: str\n \"\"\"Human-readable display name\"\"\"\n\n name: str\n \"\"\"Unique identifier of the custom agent\"\"\"\n\n path: str | None = None\n \"\"\"Absolute local file path of the agent definition. Only set for file-based agents loaded\n from disk; remote agents do not have a path.\n \"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'AgentInfo':\n assert isinstance(obj, dict)\n description = from_str(obj.get(\"description\"))\n display_name = from_str(obj.get(\"displayName\"))\n name = from_str(obj.get(\"name\"))\n path = from_union([from_str, from_none], obj.get(\"path\"))\n return AgentInfo(description, display_name, name, path)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"description\"] = from_str(self.description)\n result[\"displayName\"] = from_str(self.display_name)\n result[\"name\"] = from_str(self.name)\n if self.path is not None:\n result[\"path\"] = from_union([from_str, from_none], self.path)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass AgentSelectRequest:\n name: str\n \"\"\"Name of the custom agent to select\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'AgentSelectRequest':\n assert isinstance(obj, dict)\n name = from_str(obj.get(\"name\"))\n return AgentSelectRequest(name)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"name\"] = from_str(self.name)\n return result\n\nclass AuthInfoType(Enum):\n \"\"\"Authentication type\"\"\"\n\n API_KEY = \"api-key\"\n COPILOT_API_TOKEN = \"copilot-api-token\"\n ENV = \"env\"\n GH_CLI = \"gh-cli\"\n HMAC = \"hmac\"\n TOKEN = \"token\"\n USER = \"user\"\n\n@dataclass\nclass CommandsHandlePendingCommandRequest:\n request_id: str\n \"\"\"Request ID from the command invocation event\"\"\"\n\n error: str | None = None\n \"\"\"Error message if the command handler failed\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'CommandsHandlePendingCommandRequest':\n assert isinstance(obj, dict)\n request_id = from_str(obj.get(\"requestId\"))\n error = from_union([from_str, from_none], obj.get(\"error\"))\n return CommandsHandlePendingCommandRequest(request_id, error)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"requestId\"] = from_str(self.request_id)\n if self.error is not None:\n result[\"error\"] = from_union([from_str, from_none], self.error)\n return result\n\n@dataclass\nclass CommandsHandlePendingCommandResult:\n success: bool\n \"\"\"Whether the command was handled successfully\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'CommandsHandlePendingCommandResult':\n assert isinstance(obj, dict)\n success = from_bool(obj.get(\"success\"))\n return CommandsHandlePendingCommandResult(success)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"success\"] = from_bool(self.success)\n return result\n\n@dataclass\nclass CurrentModel:\n model_id: str | None = None\n \"\"\"Currently active model identifier\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'CurrentModel':\n assert isinstance(obj, dict)\n model_id = from_union([from_str, from_none], obj.get(\"modelId\"))\n return CurrentModel(model_id)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.model_id is not None:\n result[\"modelId\"] = from_union([from_str, from_none], self.model_id)\n return result\n\nclass MCPServerSource(Enum):\n \"\"\"Configuration source\n\n Configuration source: user, workspace, plugin, or builtin\n \"\"\"\n BUILTIN = \"builtin\"\n PLUGIN = \"plugin\"\n USER = \"user\"\n WORKSPACE = \"workspace\"\n\nclass DiscoveredMCPServerType(Enum):\n \"\"\"Server transport type: stdio, http, sse, or memory (local configs are normalized to stdio)\"\"\"\n\n HTTP = \"http\"\n MEMORY = \"memory\"\n SSE = \"sse\"\n STDIO = \"stdio\"\n\n@dataclass\nclass EmbeddedBlobResourceContents:\n blob: str\n \"\"\"Base64-encoded binary content of the resource\"\"\"\n\n uri: str\n \"\"\"URI identifying the resource\"\"\"\n\n mime_type: str | None = None\n \"\"\"MIME type of the blob content\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'EmbeddedBlobResourceContents':\n assert isinstance(obj, dict)\n blob = from_str(obj.get(\"blob\"))\n uri = from_str(obj.get(\"uri\"))\n mime_type = from_union([from_str, from_none], obj.get(\"mimeType\"))\n return EmbeddedBlobResourceContents(blob, uri, mime_type)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"blob\"] = from_str(self.blob)\n result[\"uri\"] = from_str(self.uri)\n if self.mime_type is not None:\n result[\"mimeType\"] = from_union([from_str, from_none], self.mime_type)\n return result\n\n@dataclass\nclass EmbeddedTextResourceContents:\n text: str\n \"\"\"Text content of the resource\"\"\"\n\n uri: str\n \"\"\"URI identifying the resource\"\"\"\n\n mime_type: str | None = None\n \"\"\"MIME type of the text content\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'EmbeddedTextResourceContents':\n assert isinstance(obj, dict)\n text = from_str(obj.get(\"text\"))\n uri = from_str(obj.get(\"uri\"))\n mime_type = from_union([from_str, from_none], obj.get(\"mimeType\"))\n return EmbeddedTextResourceContents(text, uri, mime_type)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"text\"] = from_str(self.text)\n result[\"uri\"] = from_str(self.uri)\n if self.mime_type is not None:\n result[\"mimeType\"] = from_union([from_str, from_none], self.mime_type)\n return result\n\nclass ExtensionSource(Enum):\n \"\"\"Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/)\"\"\"\n\n PROJECT = \"project\"\n USER = \"user\"\n\nclass ExtensionStatus(Enum):\n \"\"\"Current status: running, disabled, failed, or starting\"\"\"\n\n DISABLED = \"disabled\"\n FAILED = \"failed\"\n RUNNING = \"running\"\n STARTING = \"starting\"\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass ExtensionsDisableRequest:\n id: str\n \"\"\"Source-qualified extension ID to disable\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ExtensionsDisableRequest':\n assert isinstance(obj, dict)\n id = from_str(obj.get(\"id\"))\n return ExtensionsDisableRequest(id)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"id\"] = from_str(self.id)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass ExtensionsEnableRequest:\n id: str\n \"\"\"Source-qualified extension ID to enable\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ExtensionsEnableRequest':\n assert isinstance(obj, dict)\n id = from_str(obj.get(\"id\"))\n return ExtensionsEnableRequest(id)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"id\"] = from_str(self.id)\n return result\n\nclass ExternalToolTextResultForLlmContentResourceLinkIconTheme(Enum):\n \"\"\"Theme variant this icon is intended for\"\"\"\n\n DARK = \"dark\"\n LIGHT = \"light\"\n\n@dataclass\nclass ExternalToolTextResultForLlmContentResourceDetails:\n \"\"\"The embedded resource contents, either text or base64-encoded binary\"\"\"\n\n uri: str\n \"\"\"URI identifying the resource\"\"\"\n\n mime_type: str | None = None\n \"\"\"MIME type of the text content\n\n MIME type of the blob content\n \"\"\"\n text: str | None = None\n \"\"\"Text content of the resource\"\"\"\n\n blob: str | None = None\n \"\"\"Base64-encoded binary content of the resource\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentResourceDetails':\n assert isinstance(obj, dict)\n uri = from_str(obj.get(\"uri\"))\n mime_type = from_union([from_str, from_none], obj.get(\"mimeType\"))\n text = from_union([from_str, from_none], obj.get(\"text\"))\n blob = from_union([from_str, from_none], obj.get(\"blob\"))\n return ExternalToolTextResultForLlmContentResourceDetails(uri, mime_type, text, blob)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"uri\"] = from_str(self.uri)\n if self.mime_type is not None:\n result[\"mimeType\"] = from_union([from_str, from_none], self.mime_type)\n if self.text is not None:\n result[\"text\"] = from_union([from_str, from_none], self.text)\n if self.blob is not None:\n result[\"blob\"] = from_union([from_str, from_none], self.blob)\n return result\n\nclass ExternalToolTextResultForLlmContentType(Enum):\n AUDIO = \"audio\"\n IMAGE = \"image\"\n RESOURCE = \"resource\"\n RESOURCE_LINK = \"resource_link\"\n TERMINAL = \"terminal\"\n TEXT = \"text\"\n\nclass ExternalToolTextResultForLlmContentAudioType(Enum):\n AUDIO = \"audio\"\n\nclass ExternalToolTextResultForLlmContentImageType(Enum):\n IMAGE = \"image\"\n\nclass ExternalToolTextResultForLlmContentResourceType(Enum):\n RESOURCE = \"resource\"\n\nclass ExternalToolTextResultForLlmContentResourceLinkType(Enum):\n RESOURCE_LINK = \"resource_link\"\n\nclass ExternalToolTextResultForLlmContentTerminalType(Enum):\n TERMINAL = \"terminal\"\n\nclass ExternalToolTextResultForLlmContentTextType(Enum):\n TEXT = \"text\"\n\nclass FilterMappingString(Enum):\n HIDDEN_CHARACTERS = \"hidden_characters\"\n MARKDOWN = \"markdown\"\n NONE = \"none\"\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass FleetStartRequest:\n prompt: str | None = None\n \"\"\"Optional user prompt to combine with fleet instructions\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'FleetStartRequest':\n assert isinstance(obj, dict)\n prompt = from_union([from_str, from_none], obj.get(\"prompt\"))\n return FleetStartRequest(prompt)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.prompt is not None:\n result[\"prompt\"] = from_union([from_str, from_none], self.prompt)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass FleetStartResult:\n started: bool\n \"\"\"Whether fleet mode was successfully activated\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'FleetStartResult':\n assert isinstance(obj, dict)\n started = from_bool(obj.get(\"started\"))\n return FleetStartResult(started)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"started\"] = from_bool(self.started)\n return result\n\n@dataclass\nclass HandlePendingToolCallResult:\n success: bool\n \"\"\"Whether the tool call result was handled successfully\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'HandlePendingToolCallResult':\n assert isinstance(obj, dict)\n success = from_bool(obj.get(\"success\"))\n return HandlePendingToolCallResult(success)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"success\"] = from_bool(self.success)\n return result\n\n@dataclass\nclass HistoryCompactContextWindow:\n \"\"\"Post-compaction context window usage breakdown\"\"\"\n\n current_tokens: int\n \"\"\"Current total tokens in the context window (system + conversation + tool definitions)\"\"\"\n\n messages_length: int\n \"\"\"Current number of messages in the conversation\"\"\"\n\n token_limit: int\n \"\"\"Maximum token count for the model's context window\"\"\"\n\n conversation_tokens: int | None = None\n \"\"\"Token count from non-system messages (user, assistant, tool)\"\"\"\n\n system_tokens: int | None = None\n \"\"\"Token count from system message(s)\"\"\"\n\n tool_definitions_tokens: int | None = None\n \"\"\"Token count from tool definitions\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'HistoryCompactContextWindow':\n assert isinstance(obj, dict)\n current_tokens = from_int(obj.get(\"currentTokens\"))\n messages_length = from_int(obj.get(\"messagesLength\"))\n token_limit = from_int(obj.get(\"tokenLimit\"))\n conversation_tokens = from_union([from_int, from_none], obj.get(\"conversationTokens\"))\n system_tokens = from_union([from_int, from_none], obj.get(\"systemTokens\"))\n tool_definitions_tokens = from_union([from_int, from_none], obj.get(\"toolDefinitionsTokens\"))\n return HistoryCompactContextWindow(current_tokens, messages_length, token_limit, conversation_tokens, system_tokens, tool_definitions_tokens)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"currentTokens\"] = from_int(self.current_tokens)\n result[\"messagesLength\"] = from_int(self.messages_length)\n result[\"tokenLimit\"] = from_int(self.token_limit)\n if self.conversation_tokens is not None:\n result[\"conversationTokens\"] = from_union([from_int, from_none], self.conversation_tokens)\n if self.system_tokens is not None:\n result[\"systemTokens\"] = from_union([from_int, from_none], self.system_tokens)\n if self.tool_definitions_tokens is not None:\n result[\"toolDefinitionsTokens\"] = from_union([from_int, from_none], self.tool_definitions_tokens)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass HistoryTruncateRequest:\n event_id: str\n \"\"\"Event ID to truncate to. This event and all events after it are removed from the session.\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'HistoryTruncateRequest':\n assert isinstance(obj, dict)\n event_id = from_str(obj.get(\"eventId\"))\n return HistoryTruncateRequest(event_id)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"eventId\"] = from_str(self.event_id)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass HistoryTruncateResult:\n events_removed: int\n \"\"\"Number of events that were removed\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'HistoryTruncateResult':\n assert isinstance(obj, dict)\n events_removed = from_int(obj.get(\"eventsRemoved\"))\n return HistoryTruncateResult(events_removed)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"eventsRemoved\"] = from_int(self.events_removed)\n return result\n\nclass InstructionsSourcesLocation(Enum):\n \"\"\"Where this source lives — used for UI grouping\"\"\"\n\n REPOSITORY = \"repository\"\n USER = \"user\"\n WORKING_DIRECTORY = \"working-directory\"\n\nclass InstructionsSourcesType(Enum):\n \"\"\"Category of instruction source — used for merge logic\"\"\"\n\n CHILD_INSTRUCTIONS = \"child-instructions\"\n HOME = \"home\"\n MODEL = \"model\"\n NESTED_AGENTS = \"nested-agents\"\n REPO = \"repo\"\n VSCODE = \"vscode\"\n\nclass SessionLogLevel(Enum):\n \"\"\"Log severity level. Determines how the message is displayed in the timeline. Defaults to\n \"info\".\n \"\"\"\n ERROR = \"error\"\n INFO = \"info\"\n WARNING = \"warning\"\n\n@dataclass\nclass LogResult:\n event_id: UUID\n \"\"\"The unique identifier of the emitted session event\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'LogResult':\n assert isinstance(obj, dict)\n event_id = UUID(obj.get(\"eventId\"))\n return LogResult(event_id)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"eventId\"] = str(self.event_id)\n return result\n\nclass MCPServerConfigHTTPOauthGrantType(Enum):\n AUTHORIZATION_CODE = \"authorization_code\"\n CLIENT_CREDENTIALS = \"client_credentials\"\n\nclass MCPServerConfigType(Enum):\n \"\"\"Remote transport type. Defaults to \"http\" when omitted.\"\"\"\n\n HTTP = \"http\"\n LOCAL = \"local\"\n SSE = \"sse\"\n STDIO = \"stdio\"\n\n@dataclass\nclass MCPConfigDisableRequest:\n names: list[str]\n \"\"\"Names of MCP servers to disable. Each server is added to the persisted disabled list so\n new sessions skip it. Already-disabled names are ignored. Active sessions keep their\n current connections until they end.\n \"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'MCPConfigDisableRequest':\n assert isinstance(obj, dict)\n names = from_list(from_str, obj.get(\"names\"))\n return MCPConfigDisableRequest(names)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"names\"] = from_list(from_str, self.names)\n return result\n\n@dataclass\nclass MCPConfigEnableRequest:\n names: list[str]\n \"\"\"Names of MCP servers to enable. Each server is removed from the persisted disabled list\n so new sessions spawn it. Unknown or already-enabled names are ignored.\n \"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'MCPConfigEnableRequest':\n assert isinstance(obj, dict)\n names = from_list(from_str, obj.get(\"names\"))\n return MCPConfigEnableRequest(names)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"names\"] = from_list(from_str, self.names)\n return result\n\n@dataclass\nclass MCPConfigRemoveRequest:\n name: str\n \"\"\"Name of the MCP server to remove\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'MCPConfigRemoveRequest':\n assert isinstance(obj, dict)\n name = from_str(obj.get(\"name\"))\n return MCPConfigRemoveRequest(name)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"name\"] = from_str(self.name)\n return result\n\n@dataclass\nclass MCPDisableRequest:\n server_name: str\n \"\"\"Name of the MCP server to disable\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'MCPDisableRequest':\n assert isinstance(obj, dict)\n server_name = from_str(obj.get(\"serverName\"))\n return MCPDisableRequest(server_name)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"serverName\"] = from_str(self.server_name)\n return result\n\n@dataclass\nclass MCPDiscoverRequest:\n working_directory: str | None = None\n \"\"\"Working directory used as context for discovery (e.g., plugin resolution)\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'MCPDiscoverRequest':\n assert isinstance(obj, dict)\n working_directory = from_union([from_str, from_none], obj.get(\"workingDirectory\"))\n return MCPDiscoverRequest(working_directory)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.working_directory is not None:\n result[\"workingDirectory\"] = from_union([from_str, from_none], self.working_directory)\n return result\n\n@dataclass\nclass MCPEnableRequest:\n server_name: str\n \"\"\"Name of the MCP server to enable\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'MCPEnableRequest':\n assert isinstance(obj, dict)\n server_name = from_str(obj.get(\"serverName\"))\n return MCPEnableRequest(server_name)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"serverName\"] = from_str(self.server_name)\n return result\n\n@dataclass\nclass MCPOauthLoginRequest:\n server_name: str\n \"\"\"Name of the remote MCP server to authenticate\"\"\"\n\n callback_success_message: str | None = None\n \"\"\"Optional override for the body text shown on the OAuth loopback callback success page.\n When omitted, the runtime applies a neutral fallback; callers driving interactive auth\n should pass surface-specific copy telling the user where to return.\n \"\"\"\n client_name: str | None = None\n \"\"\"Optional override for the OAuth client display name shown on the consent screen. Applies\n to newly registered dynamic clients only — existing registrations keep the name they were\n created with. When omitted, the runtime applies a neutral fallback; callers driving\n interactive auth should pass their own surface-specific label so the consent screen\n matches the product the user sees.\n \"\"\"\n force_reauth: bool | None = None\n \"\"\"When true, clears any cached OAuth token for the server and runs a full new\n authorization. Use when the user explicitly wants to switch accounts or believes their\n session is stuck.\n \"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'MCPOauthLoginRequest':\n assert isinstance(obj, dict)\n server_name = from_str(obj.get(\"serverName\"))\n callback_success_message = from_union([from_str, from_none], obj.get(\"callbackSuccessMessage\"))\n client_name = from_union([from_str, from_none], obj.get(\"clientName\"))\n force_reauth = from_union([from_bool, from_none], obj.get(\"forceReauth\"))\n return MCPOauthLoginRequest(server_name, callback_success_message, client_name, force_reauth)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"serverName\"] = from_str(self.server_name)\n if self.callback_success_message is not None:\n result[\"callbackSuccessMessage\"] = from_union([from_str, from_none], self.callback_success_message)\n if self.client_name is not None:\n result[\"clientName\"] = from_union([from_str, from_none], self.client_name)\n if self.force_reauth is not None:\n result[\"forceReauth\"] = from_union([from_bool, from_none], self.force_reauth)\n return result\n\n@dataclass\nclass MCPOauthLoginResult:\n authorization_url: str | None = None\n \"\"\"URL the caller should open in a browser to complete OAuth. Omitted when cached tokens\n were still valid and no browser interaction was needed — the server is already\n reconnected in that case. When present, the runtime starts the callback listener before\n returning and continues the flow in the background; completion is signaled via\n session.mcp_server_status_changed.\n \"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'MCPOauthLoginResult':\n assert isinstance(obj, dict)\n authorization_url = from_union([from_str, from_none], obj.get(\"authorizationUrl\"))\n return MCPOauthLoginResult(authorization_url)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.authorization_url is not None:\n result[\"authorizationUrl\"] = from_union([from_str, from_none], self.authorization_url)\n return result\n\nclass MCPServerStatus(Enum):\n \"\"\"Connection status: connected, failed, needs-auth, pending, disabled, or not_configured\"\"\"\n\n CONNECTED = \"connected\"\n DISABLED = \"disabled\"\n FAILED = \"failed\"\n NEEDS_AUTH = \"needs-auth\"\n NOT_CONFIGURED = \"not_configured\"\n PENDING = \"pending\"\n\nclass MCPServerConfigHTTPType(Enum):\n \"\"\"Remote transport type. Defaults to \"http\" when omitted.\"\"\"\n\n HTTP = \"http\"\n SSE = \"sse\"\n\nclass MCPServerConfigLocalType(Enum):\n LOCAL = \"local\"\n STDIO = \"stdio\"\n\nclass SessionMode(Enum):\n \"\"\"The agent mode. Valid values: \"interactive\", \"plan\", \"autopilot\".\"\"\"\n\n AUTOPILOT = \"autopilot\"\n INTERACTIVE = \"interactive\"\n PLAN = \"plan\"\n\n@dataclass\nclass ModelBilling:\n \"\"\"Billing information\"\"\"\n\n multiplier: float\n \"\"\"Billing cost multiplier relative to the base rate\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ModelBilling':\n assert isinstance(obj, dict)\n multiplier = from_float(obj.get(\"multiplier\"))\n return ModelBilling(multiplier)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"multiplier\"] = to_float(self.multiplier)\n return result\n\n@dataclass\nclass ModelCapabilitiesLimitsVision:\n \"\"\"Vision-specific limits\"\"\"\n\n max_prompt_image_size: int\n \"\"\"Maximum image size in bytes\"\"\"\n\n max_prompt_images: int\n \"\"\"Maximum number of images per prompt\"\"\"\n\n supported_media_types: list[str]\n \"\"\"MIME types the model accepts\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ModelCapabilitiesLimitsVision':\n assert isinstance(obj, dict)\n max_prompt_image_size = from_int(obj.get(\"max_prompt_image_size\"))\n max_prompt_images = from_int(obj.get(\"max_prompt_images\"))\n supported_media_types = from_list(from_str, obj.get(\"supported_media_types\"))\n return ModelCapabilitiesLimitsVision(max_prompt_image_size, max_prompt_images, supported_media_types)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"max_prompt_image_size\"] = from_int(self.max_prompt_image_size)\n result[\"max_prompt_images\"] = from_int(self.max_prompt_images)\n result[\"supported_media_types\"] = from_list(from_str, self.supported_media_types)\n return result\n\n@dataclass\nclass ModelCapabilitiesSupports:\n \"\"\"Feature flags indicating what the model supports\"\"\"\n\n reasoning_effort: bool | None = None\n \"\"\"Whether this model supports reasoning effort configuration\"\"\"\n\n vision: bool | None = None\n \"\"\"Whether this model supports vision/image input\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ModelCapabilitiesSupports':\n assert isinstance(obj, dict)\n reasoning_effort = from_union([from_bool, from_none], obj.get(\"reasoningEffort\"))\n vision = from_union([from_bool, from_none], obj.get(\"vision\"))\n return ModelCapabilitiesSupports(reasoning_effort, vision)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.reasoning_effort is not None:\n result[\"reasoningEffort\"] = from_union([from_bool, from_none], self.reasoning_effort)\n if self.vision is not None:\n result[\"vision\"] = from_union([from_bool, from_none], self.vision)\n return result\n\n@dataclass\nclass ModelPolicy:\n \"\"\"Policy state (if applicable)\"\"\"\n\n state: str\n \"\"\"Current policy state for this model\"\"\"\n\n terms: str | None = None\n \"\"\"Usage terms or conditions for this model\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ModelPolicy':\n assert isinstance(obj, dict)\n state = from_str(obj.get(\"state\"))\n terms = from_union([from_str, from_none], obj.get(\"terms\"))\n return ModelPolicy(state, terms)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"state\"] = from_str(self.state)\n if self.terms is not None:\n result[\"terms\"] = from_union([from_str, from_none], self.terms)\n return result\n\n@dataclass\nclass ModelCapabilitiesOverrideLimitsVision:\n max_prompt_image_size: int | None = None\n \"\"\"Maximum image size in bytes\"\"\"\n\n max_prompt_images: int | None = None\n \"\"\"Maximum number of images per prompt\"\"\"\n\n supported_media_types: list[str] | None = None\n \"\"\"MIME types the model accepts\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ModelCapabilitiesOverrideLimitsVision':\n assert isinstance(obj, dict)\n max_prompt_image_size = from_union([from_int, from_none], obj.get(\"max_prompt_image_size\"))\n max_prompt_images = from_union([from_int, from_none], obj.get(\"max_prompt_images\"))\n supported_media_types = from_union([lambda x: from_list(from_str, x), from_none], obj.get(\"supported_media_types\"))\n return ModelCapabilitiesOverrideLimitsVision(max_prompt_image_size, max_prompt_images, supported_media_types)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.max_prompt_image_size is not None:\n result[\"max_prompt_image_size\"] = from_union([from_int, from_none], self.max_prompt_image_size)\n if self.max_prompt_images is not None:\n result[\"max_prompt_images\"] = from_union([from_int, from_none], self.max_prompt_images)\n if self.supported_media_types is not None:\n result[\"supported_media_types\"] = from_union([lambda x: from_list(from_str, x), from_none], self.supported_media_types)\n return result\n\n@dataclass\nclass ModelCapabilitiesOverrideSupports:\n \"\"\"Feature flags indicating what the model supports\"\"\"\n\n reasoning_effort: bool | None = None\n vision: bool | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> 'ModelCapabilitiesOverrideSupports':\n assert isinstance(obj, dict)\n reasoning_effort = from_union([from_bool, from_none], obj.get(\"reasoningEffort\"))\n vision = from_union([from_bool, from_none], obj.get(\"vision\"))\n return ModelCapabilitiesOverrideSupports(reasoning_effort, vision)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.reasoning_effort is not None:\n result[\"reasoningEffort\"] = from_union([from_bool, from_none], self.reasoning_effort)\n if self.vision is not None:\n result[\"vision\"] = from_union([from_bool, from_none], self.vision)\n return result\n\n@dataclass\nclass ModelSwitchToResult:\n model_id: str | None = None\n \"\"\"Currently active model identifier after the switch\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ModelSwitchToResult':\n assert isinstance(obj, dict)\n model_id = from_union([from_str, from_none], obj.get(\"modelId\"))\n return ModelSwitchToResult(model_id)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.model_id is not None:\n result[\"modelId\"] = from_union([from_str, from_none], self.model_id)\n return result\n\n@dataclass\nclass ModelsListRequest:\n git_hub_token: str | None = None\n \"\"\"GitHub token for per-user model listing. When provided, resolves this token to determine\n the user's Copilot plan and available models instead of using the global auth.\n \"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ModelsListRequest':\n assert isinstance(obj, dict)\n git_hub_token = from_union([from_str, from_none], obj.get(\"gitHubToken\"))\n return ModelsListRequest(git_hub_token)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.git_hub_token is not None:\n result[\"gitHubToken\"] = from_union([from_str, from_none], self.git_hub_token)\n return result\n\n@dataclass\nclass NameGetResult:\n name: str | None = None\n \"\"\"The session name (user-set or auto-generated), or null if not yet set\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'NameGetResult':\n assert isinstance(obj, dict)\n name = from_union([from_none, from_str], obj.get(\"name\"))\n return NameGetResult(name)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"name\"] = from_union([from_none, from_str], self.name)\n return result\n\n@dataclass\nclass NameSetRequest:\n name: str\n \"\"\"New session name (1–100 characters, trimmed of leading/trailing whitespace)\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'NameSetRequest':\n assert isinstance(obj, dict)\n name = from_str(obj.get(\"name\"))\n return NameSetRequest(name)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"name\"] = from_str(self.name)\n return result\n\nclass ApprovalKind(Enum):\n COMMANDS = \"commands\"\n CUSTOM_TOOL = \"custom-tool\"\n MCP = \"mcp\"\n MCP_SAMPLING = \"mcp-sampling\"\n MEMORY = \"memory\"\n READ = \"read\"\n WRITE = \"write\"\n\nclass PermissionDecisionKind(Enum):\n APPROVE_FOR_LOCATION = \"approve-for-location\"\n APPROVE_FOR_SESSION = \"approve-for-session\"\n APPROVE_ONCE = \"approve-once\"\n APPROVE_PERMANENTLY = \"approve-permanently\"\n REJECT = \"reject\"\n USER_NOT_AVAILABLE = \"user-not-available\"\n\nclass PermissionDecisionApproveForLocationKind(Enum):\n APPROVE_FOR_LOCATION = \"approve-for-location\"\n\nclass PermissionDecisionApproveForLocationApprovalCommandsKind(Enum):\n COMMANDS = \"commands\"\n\nclass PermissionDecisionApproveForLocationApprovalCustomToolKind(Enum):\n CUSTOM_TOOL = \"custom-tool\"\n\nclass PermissionDecisionApproveForLocationApprovalMCPKind(Enum):\n MCP = \"mcp\"\n\nclass PermissionDecisionApproveForLocationApprovalMCPSamplingKind(Enum):\n MCP_SAMPLING = \"mcp-sampling\"\n\nclass PermissionDecisionApproveForLocationApprovalMemoryKind(Enum):\n MEMORY = \"memory\"\n\nclass PermissionDecisionApproveForLocationApprovalReadKind(Enum):\n READ = \"read\"\n\nclass PermissionDecisionApproveForLocationApprovalWriteKind(Enum):\n WRITE = \"write\"\n\nclass PermissionDecisionApproveForSessionKind(Enum):\n APPROVE_FOR_SESSION = \"approve-for-session\"\n\nclass PermissionDecisionApproveOnceKind(Enum):\n APPROVE_ONCE = \"approve-once\"\n\nclass PermissionDecisionApprovePermanentlyKind(Enum):\n APPROVE_PERMANENTLY = \"approve-permanently\"\n\nclass PermissionDecisionRejectKind(Enum):\n REJECT = \"reject\"\n\nclass PermissionDecisionUserNotAvailableKind(Enum):\n USER_NOT_AVAILABLE = \"user-not-available\"\n\n@dataclass\nclass PermissionRequestResult:\n success: bool\n \"\"\"Whether the permission request was handled successfully\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionRequestResult':\n assert isinstance(obj, dict)\n success = from_bool(obj.get(\"success\"))\n return PermissionRequestResult(success)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"success\"] = from_bool(self.success)\n return result\n\n@dataclass\nclass PermissionsResetSessionApprovalsRequest:\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionsResetSessionApprovalsRequest':\n assert isinstance(obj, dict)\n return PermissionsResetSessionApprovalsRequest()\n\n def to_dict(self) -> dict:\n result: dict = {}\n return result\n\n@dataclass\nclass PermissionsResetSessionApprovalsResult:\n success: bool\n \"\"\"Whether the operation succeeded\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionsResetSessionApprovalsResult':\n assert isinstance(obj, dict)\n success = from_bool(obj.get(\"success\"))\n return PermissionsResetSessionApprovalsResult(success)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"success\"] = from_bool(self.success)\n return result\n\n@dataclass\nclass PermissionsSetApproveAllRequest:\n enabled: bool\n \"\"\"Whether to auto-approve all tool permission requests\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionsSetApproveAllRequest':\n assert isinstance(obj, dict)\n enabled = from_bool(obj.get(\"enabled\"))\n return PermissionsSetApproveAllRequest(enabled)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"enabled\"] = from_bool(self.enabled)\n return result\n\n@dataclass\nclass PermissionsSetApproveAllResult:\n success: bool\n \"\"\"Whether the operation succeeded\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionsSetApproveAllResult':\n assert isinstance(obj, dict)\n success = from_bool(obj.get(\"success\"))\n return PermissionsSetApproveAllResult(success)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"success\"] = from_bool(self.success)\n return result\n\n@dataclass\nclass PingRequest:\n message: str | None = None\n \"\"\"Optional message to echo back\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'PingRequest':\n assert isinstance(obj, dict)\n message = from_union([from_str, from_none], obj.get(\"message\"))\n return PingRequest(message)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.message is not None:\n result[\"message\"] = from_union([from_str, from_none], self.message)\n return result\n\n@dataclass\nclass PingResult:\n message: str\n \"\"\"Echoed message (or default greeting)\"\"\"\n\n protocol_version: int\n \"\"\"Server protocol version number\"\"\"\n\n timestamp: int\n \"\"\"Server timestamp in milliseconds\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'PingResult':\n assert isinstance(obj, dict)\n message = from_str(obj.get(\"message\"))\n protocol_version = from_int(obj.get(\"protocolVersion\"))\n timestamp = from_int(obj.get(\"timestamp\"))\n return PingResult(message, protocol_version, timestamp)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"message\"] = from_str(self.message)\n result[\"protocolVersion\"] = from_int(self.protocol_version)\n result[\"timestamp\"] = from_int(self.timestamp)\n return result\n\n@dataclass\nclass PlanReadResult:\n exists: bool\n \"\"\"Whether the plan file exists in the workspace\"\"\"\n\n content: str | None = None\n \"\"\"The content of the plan file, or null if it does not exist\"\"\"\n\n path: str | None = None\n \"\"\"Absolute file path of the plan file, or null if workspace is not enabled\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'PlanReadResult':\n assert isinstance(obj, dict)\n exists = from_bool(obj.get(\"exists\"))\n content = from_union([from_none, from_str], obj.get(\"content\"))\n path = from_union([from_none, from_str], obj.get(\"path\"))\n return PlanReadResult(exists, content, path)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"exists\"] = from_bool(self.exists)\n result[\"content\"] = from_union([from_none, from_str], self.content)\n result[\"path\"] = from_union([from_none, from_str], self.path)\n return result\n\n@dataclass\nclass PlanUpdateRequest:\n content: str\n \"\"\"The new content for the plan file\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'PlanUpdateRequest':\n assert isinstance(obj, dict)\n content = from_str(obj.get(\"content\"))\n return PlanUpdateRequest(content)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"content\"] = from_str(self.content)\n return result\n\n@dataclass\nclass Plugin:\n enabled: bool\n \"\"\"Whether the plugin is currently enabled\"\"\"\n\n marketplace: str\n \"\"\"Marketplace the plugin came from\"\"\"\n\n name: str\n \"\"\"Plugin name\"\"\"\n\n version: str | None = None\n \"\"\"Installed version\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'Plugin':\n assert isinstance(obj, dict)\n enabled = from_bool(obj.get(\"enabled\"))\n marketplace = from_str(obj.get(\"marketplace\"))\n name = from_str(obj.get(\"name\"))\n version = from_union([from_str, from_none], obj.get(\"version\"))\n return Plugin(enabled, marketplace, name, version)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"enabled\"] = from_bool(self.enabled)\n result[\"marketplace\"] = from_str(self.marketplace)\n result[\"name\"] = from_str(self.name)\n if self.version is not None:\n result[\"version\"] = from_union([from_str, from_none], self.version)\n return result\n\n@dataclass\nclass ServerSkill:\n description: str\n \"\"\"Description of what the skill does\"\"\"\n\n enabled: bool\n \"\"\"Whether the skill is currently enabled (based on global config)\"\"\"\n\n name: str\n \"\"\"Unique identifier for the skill\"\"\"\n\n source: str\n \"\"\"Source location type (e.g., project, personal-copilot, plugin, builtin)\"\"\"\n\n user_invocable: bool\n \"\"\"Whether the skill can be invoked by the user as a slash command\"\"\"\n\n path: str | None = None\n \"\"\"Absolute path to the skill file\"\"\"\n\n project_path: str | None = None\n \"\"\"The project path this skill belongs to (only for project/inherited skills)\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ServerSkill':\n assert isinstance(obj, dict)\n description = from_str(obj.get(\"description\"))\n enabled = from_bool(obj.get(\"enabled\"))\n name = from_str(obj.get(\"name\"))\n source = from_str(obj.get(\"source\"))\n user_invocable = from_bool(obj.get(\"userInvocable\"))\n path = from_union([from_str, from_none], obj.get(\"path\"))\n project_path = from_union([from_str, from_none], obj.get(\"projectPath\"))\n return ServerSkill(description, enabled, name, source, user_invocable, path, project_path)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"description\"] = from_str(self.description)\n result[\"enabled\"] = from_bool(self.enabled)\n result[\"name\"] = from_str(self.name)\n result[\"source\"] = from_str(self.source)\n result[\"userInvocable\"] = from_bool(self.user_invocable)\n if self.path is not None:\n result[\"path\"] = from_union([from_str, from_none], self.path)\n if self.project_path is not None:\n result[\"projectPath\"] = from_union([from_str, from_none], self.project_path)\n return result\n\n@dataclass\nclass SessionFSAppendFileRequest:\n content: str\n \"\"\"Content to append\"\"\"\n\n path: str\n \"\"\"Path using SessionFs conventions\"\"\"\n\n session_id: str\n \"\"\"Target session identifier\"\"\"\n\n mode: int | None = None\n \"\"\"Optional POSIX-style mode for newly created files\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionFSAppendFileRequest':\n assert isinstance(obj, dict)\n content = from_str(obj.get(\"content\"))\n path = from_str(obj.get(\"path\"))\n session_id = from_str(obj.get(\"sessionId\"))\n mode = from_union([from_int, from_none], obj.get(\"mode\"))\n return SessionFSAppendFileRequest(content, path, session_id, mode)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"content\"] = from_str(self.content)\n result[\"path\"] = from_str(self.path)\n result[\"sessionId\"] = from_str(self.session_id)\n if self.mode is not None:\n result[\"mode\"] = from_union([from_int, from_none], self.mode)\n return result\n\nclass SessionFSErrorCode(Enum):\n \"\"\"Error classification\"\"\"\n\n ENOENT = \"ENOENT\"\n UNKNOWN = \"UNKNOWN\"\n\n@dataclass\nclass SessionFSExistsRequest:\n path: str\n \"\"\"Path using SessionFs conventions\"\"\"\n\n session_id: str\n \"\"\"Target session identifier\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionFSExistsRequest':\n assert isinstance(obj, dict)\n path = from_str(obj.get(\"path\"))\n session_id = from_str(obj.get(\"sessionId\"))\n return SessionFSExistsRequest(path, session_id)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"path\"] = from_str(self.path)\n result[\"sessionId\"] = from_str(self.session_id)\n return result\n\n@dataclass\nclass SessionFSExistsResult:\n exists: bool\n \"\"\"Whether the path exists\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionFSExistsResult':\n assert isinstance(obj, dict)\n exists = from_bool(obj.get(\"exists\"))\n return SessionFSExistsResult(exists)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"exists\"] = from_bool(self.exists)\n return result\n\n@dataclass\nclass SessionFSMkdirRequest:\n path: str\n \"\"\"Path using SessionFs conventions\"\"\"\n\n session_id: str\n \"\"\"Target session identifier\"\"\"\n\n mode: int | None = None\n \"\"\"Optional POSIX-style mode for newly created directories\"\"\"\n\n recursive: bool | None = None\n \"\"\"Create parent directories as needed\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionFSMkdirRequest':\n assert isinstance(obj, dict)\n path = from_str(obj.get(\"path\"))\n session_id = from_str(obj.get(\"sessionId\"))\n mode = from_union([from_int, from_none], obj.get(\"mode\"))\n recursive = from_union([from_bool, from_none], obj.get(\"recursive\"))\n return SessionFSMkdirRequest(path, session_id, mode, recursive)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"path\"] = from_str(self.path)\n result[\"sessionId\"] = from_str(self.session_id)\n if self.mode is not None:\n result[\"mode\"] = from_union([from_int, from_none], self.mode)\n if self.recursive is not None:\n result[\"recursive\"] = from_union([from_bool, from_none], self.recursive)\n return result\n\n@dataclass\nclass SessionFSReadFileRequest:\n path: str\n \"\"\"Path using SessionFs conventions\"\"\"\n\n session_id: str\n \"\"\"Target session identifier\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionFSReadFileRequest':\n assert isinstance(obj, dict)\n path = from_str(obj.get(\"path\"))\n session_id = from_str(obj.get(\"sessionId\"))\n return SessionFSReadFileRequest(path, session_id)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"path\"] = from_str(self.path)\n result[\"sessionId\"] = from_str(self.session_id)\n return result\n\n@dataclass\nclass SessionFSReaddirRequest:\n path: str\n \"\"\"Path using SessionFs conventions\"\"\"\n\n session_id: str\n \"\"\"Target session identifier\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionFSReaddirRequest':\n assert isinstance(obj, dict)\n path = from_str(obj.get(\"path\"))\n session_id = from_str(obj.get(\"sessionId\"))\n return SessionFSReaddirRequest(path, session_id)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"path\"] = from_str(self.path)\n result[\"sessionId\"] = from_str(self.session_id)\n return result\n\nclass SessionFSReaddirWithTypesEntryType(Enum):\n \"\"\"Entry type\"\"\"\n\n DIRECTORY = \"directory\"\n FILE = \"file\"\n\n@dataclass\nclass SessionFSReaddirWithTypesRequest:\n path: str\n \"\"\"Path using SessionFs conventions\"\"\"\n\n session_id: str\n \"\"\"Target session identifier\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionFSReaddirWithTypesRequest':\n assert isinstance(obj, dict)\n path = from_str(obj.get(\"path\"))\n session_id = from_str(obj.get(\"sessionId\"))\n return SessionFSReaddirWithTypesRequest(path, session_id)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"path\"] = from_str(self.path)\n result[\"sessionId\"] = from_str(self.session_id)\n return result\n\n@dataclass\nclass SessionFSRenameRequest:\n dest: str\n \"\"\"Destination path using SessionFs conventions\"\"\"\n\n session_id: str\n \"\"\"Target session identifier\"\"\"\n\n src: str\n \"\"\"Source path using SessionFs conventions\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionFSRenameRequest':\n assert isinstance(obj, dict)\n dest = from_str(obj.get(\"dest\"))\n session_id = from_str(obj.get(\"sessionId\"))\n src = from_str(obj.get(\"src\"))\n return SessionFSRenameRequest(dest, session_id, src)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"dest\"] = from_str(self.dest)\n result[\"sessionId\"] = from_str(self.session_id)\n result[\"src\"] = from_str(self.src)\n return result\n\n@dataclass\nclass SessionFSRmRequest:\n path: str\n \"\"\"Path using SessionFs conventions\"\"\"\n\n session_id: str\n \"\"\"Target session identifier\"\"\"\n\n force: bool | None = None\n \"\"\"Ignore errors if the path does not exist\"\"\"\n\n recursive: bool | None = None\n \"\"\"Remove directories and their contents recursively\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionFSRmRequest':\n assert isinstance(obj, dict)\n path = from_str(obj.get(\"path\"))\n session_id = from_str(obj.get(\"sessionId\"))\n force = from_union([from_bool, from_none], obj.get(\"force\"))\n recursive = from_union([from_bool, from_none], obj.get(\"recursive\"))\n return SessionFSRmRequest(path, session_id, force, recursive)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"path\"] = from_str(self.path)\n result[\"sessionId\"] = from_str(self.session_id)\n if self.force is not None:\n result[\"force\"] = from_union([from_bool, from_none], self.force)\n if self.recursive is not None:\n result[\"recursive\"] = from_union([from_bool, from_none], self.recursive)\n return result\n\nclass SessionFSSetProviderConventions(Enum):\n \"\"\"Path conventions used by this filesystem\"\"\"\n\n POSIX = \"posix\"\n WINDOWS = \"windows\"\n\n@dataclass\nclass SessionFSSetProviderResult:\n success: bool\n \"\"\"Whether the provider was set successfully\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionFSSetProviderResult':\n assert isinstance(obj, dict)\n success = from_bool(obj.get(\"success\"))\n return SessionFSSetProviderResult(success)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"success\"] = from_bool(self.success)\n return result\n\n@dataclass\nclass SessionFSStatRequest:\n path: str\n \"\"\"Path using SessionFs conventions\"\"\"\n\n session_id: str\n \"\"\"Target session identifier\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionFSStatRequest':\n assert isinstance(obj, dict)\n path = from_str(obj.get(\"path\"))\n session_id = from_str(obj.get(\"sessionId\"))\n return SessionFSStatRequest(path, session_id)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"path\"] = from_str(self.path)\n result[\"sessionId\"] = from_str(self.session_id)\n return result\n\n@dataclass\nclass SessionFSWriteFileRequest:\n content: str\n \"\"\"Content to write\"\"\"\n\n path: str\n \"\"\"Path using SessionFs conventions\"\"\"\n\n session_id: str\n \"\"\"Target session identifier\"\"\"\n\n mode: int | None = None\n \"\"\"Optional POSIX-style mode for newly created files\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionFSWriteFileRequest':\n assert isinstance(obj, dict)\n content = from_str(obj.get(\"content\"))\n path = from_str(obj.get(\"path\"))\n session_id = from_str(obj.get(\"sessionId\"))\n mode = from_union([from_int, from_none], obj.get(\"mode\"))\n return SessionFSWriteFileRequest(content, path, session_id, mode)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"content\"] = from_str(self.content)\n result[\"path\"] = from_str(self.path)\n result[\"sessionId\"] = from_str(self.session_id)\n if self.mode is not None:\n result[\"mode\"] = from_union([from_int, from_none], self.mode)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass SessionsForkRequest:\n session_id: str\n \"\"\"Source session ID to fork from\"\"\"\n\n to_event_id: str | None = None\n \"\"\"Optional event ID boundary. When provided, the fork includes only events before this ID\n (exclusive). When omitted, all events are included.\n \"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionsForkRequest':\n assert isinstance(obj, dict)\n session_id = from_str(obj.get(\"sessionId\"))\n to_event_id = from_union([from_str, from_none], obj.get(\"toEventId\"))\n return SessionsForkRequest(session_id, to_event_id)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"sessionId\"] = from_str(self.session_id)\n if self.to_event_id is not None:\n result[\"toEventId\"] = from_union([from_str, from_none], self.to_event_id)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass SessionsForkResult:\n session_id: str\n \"\"\"The new forked session's ID\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionsForkResult':\n assert isinstance(obj, dict)\n session_id = from_str(obj.get(\"sessionId\"))\n return SessionsForkResult(session_id)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"sessionId\"] = from_str(self.session_id)\n return result\n\n@dataclass\nclass ShellExecRequest:\n command: str\n \"\"\"Shell command to execute\"\"\"\n\n cwd: str | None = None\n \"\"\"Working directory (defaults to session working directory)\"\"\"\n\n timeout: int | None = None\n \"\"\"Timeout in milliseconds (default: 30000)\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ShellExecRequest':\n assert isinstance(obj, dict)\n command = from_str(obj.get(\"command\"))\n cwd = from_union([from_str, from_none], obj.get(\"cwd\"))\n timeout = from_union([from_int, from_none], obj.get(\"timeout\"))\n return ShellExecRequest(command, cwd, timeout)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"command\"] = from_str(self.command)\n if self.cwd is not None:\n result[\"cwd\"] = from_union([from_str, from_none], self.cwd)\n if self.timeout is not None:\n result[\"timeout\"] = from_union([from_int, from_none], self.timeout)\n return result\n\n@dataclass\nclass ShellExecResult:\n process_id: str\n \"\"\"Unique identifier for tracking streamed output\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ShellExecResult':\n assert isinstance(obj, dict)\n process_id = from_str(obj.get(\"processId\"))\n return ShellExecResult(process_id)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"processId\"] = from_str(self.process_id)\n return result\n\nclass ShellKillSignal(Enum):\n \"\"\"Signal to send (default: SIGTERM)\"\"\"\n\n SIGINT = \"SIGINT\"\n SIGKILL = \"SIGKILL\"\n SIGTERM = \"SIGTERM\"\n\n@dataclass\nclass ShellKillResult:\n killed: bool\n \"\"\"Whether the signal was sent successfully\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ShellKillResult':\n assert isinstance(obj, dict)\n killed = from_bool(obj.get(\"killed\"))\n return ShellKillResult(killed)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"killed\"] = from_bool(self.killed)\n return result\n\n@dataclass\nclass Skill:\n description: str\n \"\"\"Description of what the skill does\"\"\"\n\n enabled: bool\n \"\"\"Whether the skill is currently enabled\"\"\"\n\n name: str\n \"\"\"Unique identifier for the skill\"\"\"\n\n source: str\n \"\"\"Source location type (e.g., project, personal, plugin)\"\"\"\n\n user_invocable: bool\n \"\"\"Whether the skill can be invoked by the user as a slash command\"\"\"\n\n path: str | None = None\n \"\"\"Absolute path to the skill file\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'Skill':\n assert isinstance(obj, dict)\n description = from_str(obj.get(\"description\"))\n enabled = from_bool(obj.get(\"enabled\"))\n name = from_str(obj.get(\"name\"))\n source = from_str(obj.get(\"source\"))\n user_invocable = from_bool(obj.get(\"userInvocable\"))\n path = from_union([from_str, from_none], obj.get(\"path\"))\n return Skill(description, enabled, name, source, user_invocable, path)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"description\"] = from_str(self.description)\n result[\"enabled\"] = from_bool(self.enabled)\n result[\"name\"] = from_str(self.name)\n result[\"source\"] = from_str(self.source)\n result[\"userInvocable\"] = from_bool(self.user_invocable)\n if self.path is not None:\n result[\"path\"] = from_union([from_str, from_none], self.path)\n return result\n\n@dataclass\nclass SkillsConfigSetDisabledSkillsRequest:\n disabled_skills: list[str]\n \"\"\"List of skill names to disable\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SkillsConfigSetDisabledSkillsRequest':\n assert isinstance(obj, dict)\n disabled_skills = from_list(from_str, obj.get(\"disabledSkills\"))\n return SkillsConfigSetDisabledSkillsRequest(disabled_skills)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"disabledSkills\"] = from_list(from_str, self.disabled_skills)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass SkillsDisableRequest:\n name: str\n \"\"\"Name of the skill to disable\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SkillsDisableRequest':\n assert isinstance(obj, dict)\n name = from_str(obj.get(\"name\"))\n return SkillsDisableRequest(name)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"name\"] = from_str(self.name)\n return result\n\n@dataclass\nclass SkillsDiscoverRequest:\n project_paths: list[str] | None = None\n \"\"\"Optional list of project directory paths to scan for project-scoped skills\"\"\"\n\n skill_directories: list[str] | None = None\n \"\"\"Optional list of additional skill directory paths to include\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SkillsDiscoverRequest':\n assert isinstance(obj, dict)\n project_paths = from_union([lambda x: from_list(from_str, x), from_none], obj.get(\"projectPaths\"))\n skill_directories = from_union([lambda x: from_list(from_str, x), from_none], obj.get(\"skillDirectories\"))\n return SkillsDiscoverRequest(project_paths, skill_directories)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.project_paths is not None:\n result[\"projectPaths\"] = from_union([lambda x: from_list(from_str, x), from_none], self.project_paths)\n if self.skill_directories is not None:\n result[\"skillDirectories\"] = from_union([lambda x: from_list(from_str, x), from_none], self.skill_directories)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass SkillsEnableRequest:\n name: str\n \"\"\"Name of the skill to enable\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SkillsEnableRequest':\n assert isinstance(obj, dict)\n name = from_str(obj.get(\"name\"))\n return SkillsEnableRequest(name)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"name\"] = from_str(self.name)\n return result\n\nclass TaskInfoExecutionMode(Enum):\n \"\"\"How the agent is currently being managed by the runtime\n\n Whether the shell command is currently sync-waited or background-managed\n \"\"\"\n BACKGROUND = \"background\"\n SYNC = \"sync\"\n\nclass TaskInfoStatus(Enum):\n \"\"\"Current lifecycle status of the task\"\"\"\n\n CANCELLED = \"cancelled\"\n COMPLETED = \"completed\"\n FAILED = \"failed\"\n IDLE = \"idle\"\n RUNNING = \"running\"\n\nclass TaskAgentInfoType(Enum):\n AGENT = \"agent\"\n\nclass TaskShellInfoAttachmentMode(Enum):\n \"\"\"Whether the shell runs inside a managed PTY session or as an independent background\n process\n \"\"\"\n ATTACHED = \"attached\"\n DETACHED = \"detached\"\n\nclass TaskInfoType(Enum):\n AGENT = \"agent\"\n SHELL = \"shell\"\n\nclass TaskShellInfoType(Enum):\n SHELL = \"shell\"\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass TasksCancelRequest:\n id: str\n \"\"\"Task identifier\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'TasksCancelRequest':\n assert isinstance(obj, dict)\n id = from_str(obj.get(\"id\"))\n return TasksCancelRequest(id)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"id\"] = from_str(self.id)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass TasksCancelResult:\n cancelled: bool\n \"\"\"Whether the task was successfully cancelled\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'TasksCancelResult':\n assert isinstance(obj, dict)\n cancelled = from_bool(obj.get(\"cancelled\"))\n return TasksCancelResult(cancelled)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"cancelled\"] = from_bool(self.cancelled)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass TasksPromoteToBackgroundRequest:\n id: str\n \"\"\"Task identifier\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'TasksPromoteToBackgroundRequest':\n assert isinstance(obj, dict)\n id = from_str(obj.get(\"id\"))\n return TasksPromoteToBackgroundRequest(id)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"id\"] = from_str(self.id)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass TasksPromoteToBackgroundResult:\n promoted: bool\n \"\"\"Whether the task was successfully promoted to background mode\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'TasksPromoteToBackgroundResult':\n assert isinstance(obj, dict)\n promoted = from_bool(obj.get(\"promoted\"))\n return TasksPromoteToBackgroundResult(promoted)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"promoted\"] = from_bool(self.promoted)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass TasksRemoveRequest:\n id: str\n \"\"\"Task identifier\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'TasksRemoveRequest':\n assert isinstance(obj, dict)\n id = from_str(obj.get(\"id\"))\n return TasksRemoveRequest(id)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"id\"] = from_str(self.id)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass TasksRemoveResult:\n removed: bool\n \"\"\"Whether the task was removed. Returns false if the task does not exist or is still\n running/idle (cancel it first).\n \"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'TasksRemoveResult':\n assert isinstance(obj, dict)\n removed = from_bool(obj.get(\"removed\"))\n return TasksRemoveResult(removed)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"removed\"] = from_bool(self.removed)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass TasksStartAgentRequest:\n agent_type: str\n \"\"\"Type of agent to start (e.g., 'explore', 'task', 'general-purpose')\"\"\"\n\n name: str\n \"\"\"Short name for the agent, used to generate a human-readable ID\"\"\"\n\n prompt: str\n \"\"\"Task prompt for the agent\"\"\"\n\n description: str | None = None\n \"\"\"Short description of the task\"\"\"\n\n model: str | None = None\n \"\"\"Optional model override\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'TasksStartAgentRequest':\n assert isinstance(obj, dict)\n agent_type = from_str(obj.get(\"agentType\"))\n name = from_str(obj.get(\"name\"))\n prompt = from_str(obj.get(\"prompt\"))\n description = from_union([from_str, from_none], obj.get(\"description\"))\n model = from_union([from_str, from_none], obj.get(\"model\"))\n return TasksStartAgentRequest(agent_type, name, prompt, description, model)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"agentType\"] = from_str(self.agent_type)\n result[\"name\"] = from_str(self.name)\n result[\"prompt\"] = from_str(self.prompt)\n if self.description is not None:\n result[\"description\"] = from_union([from_str, from_none], self.description)\n if self.model is not None:\n result[\"model\"] = from_union([from_str, from_none], self.model)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass TasksStartAgentResult:\n agent_id: str\n \"\"\"Generated agent ID for the background task\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'TasksStartAgentResult':\n assert isinstance(obj, dict)\n agent_id = from_str(obj.get(\"agentId\"))\n return TasksStartAgentResult(agent_id)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"agentId\"] = from_str(self.agent_id)\n return result\n\n@dataclass\nclass Tool:\n description: str\n \"\"\"Description of what the tool does\"\"\"\n\n name: str\n \"\"\"Tool identifier (e.g., \"bash\", \"grep\", \"str_replace_editor\")\"\"\"\n\n instructions: str | None = None\n \"\"\"Optional instructions for how to use this tool effectively\"\"\"\n\n namespaced_name: str | None = None\n \"\"\"Optional namespaced name for declarative filtering (e.g., \"playwright/navigate\" for MCP\n tools)\n \"\"\"\n parameters: dict[str, Any] | None = None\n \"\"\"JSON Schema for the tool's input parameters\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'Tool':\n assert isinstance(obj, dict)\n description = from_str(obj.get(\"description\"))\n name = from_str(obj.get(\"name\"))\n instructions = from_union([from_str, from_none], obj.get(\"instructions\"))\n namespaced_name = from_union([from_str, from_none], obj.get(\"namespacedName\"))\n parameters = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get(\"parameters\"))\n return Tool(description, name, instructions, namespaced_name, parameters)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"description\"] = from_str(self.description)\n result[\"name\"] = from_str(self.name)\n if self.instructions is not None:\n result[\"instructions\"] = from_union([from_str, from_none], self.instructions)\n if self.namespaced_name is not None:\n result[\"namespacedName\"] = from_union([from_str, from_none], self.namespaced_name)\n if self.parameters is not None:\n result[\"parameters\"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.parameters)\n return result\n\n@dataclass\nclass ToolsListRequest:\n model: str | None = None\n \"\"\"Optional model ID — when provided, the returned tool list reflects model-specific\n overrides\n \"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ToolsListRequest':\n assert isinstance(obj, dict)\n model = from_union([from_str, from_none], obj.get(\"model\"))\n return ToolsListRequest(model)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.model is not None:\n result[\"model\"] = from_union([from_str, from_none], self.model)\n return result\n\n@dataclass\nclass UIElicitationArrayAnyOfFieldItemsAnyOf:\n const: str\n title: str\n\n @staticmethod\n def from_dict(obj: Any) -> 'UIElicitationArrayAnyOfFieldItemsAnyOf':\n assert isinstance(obj, dict)\n const = from_str(obj.get(\"const\"))\n title = from_str(obj.get(\"title\"))\n return UIElicitationArrayAnyOfFieldItemsAnyOf(const, title)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"const\"] = from_str(self.const)\n result[\"title\"] = from_str(self.title)\n return result\n\nclass UIElicitationArrayAnyOfFieldType(Enum):\n ARRAY = \"array\"\n\nclass UIElicitationArrayEnumFieldItemsType(Enum):\n STRING = \"string\"\n\nclass UIElicitationSchemaPropertyStringFormat(Enum):\n DATE = \"date\"\n DATE_TIME = \"date-time\"\n EMAIL = \"email\"\n URI = \"uri\"\n\n@dataclass\nclass UIElicitationStringOneOfFieldOneOf:\n const: str\n title: str\n\n @staticmethod\n def from_dict(obj: Any) -> 'UIElicitationStringOneOfFieldOneOf':\n assert isinstance(obj, dict)\n const = from_str(obj.get(\"const\"))\n title = from_str(obj.get(\"title\"))\n return UIElicitationStringOneOfFieldOneOf(const, title)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"const\"] = from_str(self.const)\n result[\"title\"] = from_str(self.title)\n return result\n\nclass UIElicitationSchemaPropertyType(Enum):\n ARRAY = \"array\"\n BOOLEAN = \"boolean\"\n INTEGER = \"integer\"\n NUMBER = \"number\"\n STRING = \"string\"\n\nclass UIElicitationSchemaType(Enum):\n OBJECT = \"object\"\n\nclass UIElicitationResponseAction(Enum):\n \"\"\"The user's response: accept (submitted), decline (rejected), or cancel (dismissed)\"\"\"\n\n ACCEPT = \"accept\"\n CANCEL = \"cancel\"\n DECLINE = \"decline\"\n\n@dataclass\nclass UIElicitationResult:\n success: bool\n \"\"\"Whether the response was accepted. False if the request was already resolved by another\n client.\n \"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'UIElicitationResult':\n assert isinstance(obj, dict)\n success = from_bool(obj.get(\"success\"))\n return UIElicitationResult(success)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"success\"] = from_bool(self.success)\n return result\n\nclass UIElicitationSchemaPropertyBooleanType(Enum):\n BOOLEAN = \"boolean\"\n\nclass UIElicitationSchemaPropertyNumberType(Enum):\n INTEGER = \"integer\"\n NUMBER = \"number\"\n\n@dataclass\nclass UsageMetricsCodeChanges:\n \"\"\"Aggregated code change metrics\"\"\"\n\n files_modified_count: int\n \"\"\"Number of distinct files modified\"\"\"\n\n lines_added: int\n \"\"\"Total lines of code added\"\"\"\n\n lines_removed: int\n \"\"\"Total lines of code removed\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'UsageMetricsCodeChanges':\n assert isinstance(obj, dict)\n files_modified_count = from_int(obj.get(\"filesModifiedCount\"))\n lines_added = from_int(obj.get(\"linesAdded\"))\n lines_removed = from_int(obj.get(\"linesRemoved\"))\n return UsageMetricsCodeChanges(files_modified_count, lines_added, lines_removed)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"filesModifiedCount\"] = from_int(self.files_modified_count)\n result[\"linesAdded\"] = from_int(self.lines_added)\n result[\"linesRemoved\"] = from_int(self.lines_removed)\n return result\n\n@dataclass\nclass UsageMetricsModelMetricRequests:\n \"\"\"Request count and cost metrics for this model\"\"\"\n\n cost: float\n \"\"\"User-initiated premium request cost (with multiplier applied)\"\"\"\n\n count: int\n \"\"\"Number of API requests made with this model\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'UsageMetricsModelMetricRequests':\n assert isinstance(obj, dict)\n cost = from_float(obj.get(\"cost\"))\n count = from_int(obj.get(\"count\"))\n return UsageMetricsModelMetricRequests(cost, count)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"cost\"] = to_float(self.cost)\n result[\"count\"] = from_int(self.count)\n return result\n\n@dataclass\nclass UsageMetricsModelMetricTokenDetail:\n token_count: int\n \"\"\"Accumulated token count for this token type\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'UsageMetricsModelMetricTokenDetail':\n assert isinstance(obj, dict)\n token_count = from_int(obj.get(\"tokenCount\"))\n return UsageMetricsModelMetricTokenDetail(token_count)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"tokenCount\"] = from_int(self.token_count)\n return result\n\n@dataclass\nclass UsageMetricsModelMetricUsage:\n \"\"\"Token usage metrics for this model\"\"\"\n\n cache_read_tokens: int\n \"\"\"Total tokens read from prompt cache\"\"\"\n\n cache_write_tokens: int\n \"\"\"Total tokens written to prompt cache\"\"\"\n\n input_tokens: int\n \"\"\"Total input tokens consumed\"\"\"\n\n output_tokens: int\n \"\"\"Total output tokens produced\"\"\"\n\n reasoning_tokens: int | None = None\n \"\"\"Total output tokens used for reasoning\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'UsageMetricsModelMetricUsage':\n assert isinstance(obj, dict)\n cache_read_tokens = from_int(obj.get(\"cacheReadTokens\"))\n cache_write_tokens = from_int(obj.get(\"cacheWriteTokens\"))\n input_tokens = from_int(obj.get(\"inputTokens\"))\n output_tokens = from_int(obj.get(\"outputTokens\"))\n reasoning_tokens = from_union([from_int, from_none], obj.get(\"reasoningTokens\"))\n return UsageMetricsModelMetricUsage(cache_read_tokens, cache_write_tokens, input_tokens, output_tokens, reasoning_tokens)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"cacheReadTokens\"] = from_int(self.cache_read_tokens)\n result[\"cacheWriteTokens\"] = from_int(self.cache_write_tokens)\n result[\"inputTokens\"] = from_int(self.input_tokens)\n result[\"outputTokens\"] = from_int(self.output_tokens)\n if self.reasoning_tokens is not None:\n result[\"reasoningTokens\"] = from_union([from_int, from_none], self.reasoning_tokens)\n return result\n\n@dataclass\nclass UsageMetricsTokenDetail:\n token_count: int\n \"\"\"Accumulated token count for this token type\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'UsageMetricsTokenDetail':\n assert isinstance(obj, dict)\n token_count = from_int(obj.get(\"tokenCount\"))\n return UsageMetricsTokenDetail(token_count)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"tokenCount\"] = from_int(self.token_count)\n return result\n\n@dataclass\nclass WorkspacesCreateFileRequest:\n content: str\n \"\"\"File content to write as a UTF-8 string\"\"\"\n\n path: str\n \"\"\"Relative path within the workspace files directory\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'WorkspacesCreateFileRequest':\n assert isinstance(obj, dict)\n content = from_str(obj.get(\"content\"))\n path = from_str(obj.get(\"path\"))\n return WorkspacesCreateFileRequest(content, path)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"content\"] = from_str(self.content)\n result[\"path\"] = from_str(self.path)\n return result\n\nclass HostType(Enum):\n ADO = \"ado\"\n GITHUB = \"github\"\n\nclass SessionSyncLevel(Enum):\n LOCAL = \"local\"\n REPO_AND_USER = \"repo_and_user\"\n USER = \"user\"\n\n@dataclass\nclass WorkspacesListFilesResult:\n files: list[str]\n \"\"\"Relative file paths in the workspace files directory\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'WorkspacesListFilesResult':\n assert isinstance(obj, dict)\n files = from_list(from_str, obj.get(\"files\"))\n return WorkspacesListFilesResult(files)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"files\"] = from_list(from_str, self.files)\n return result\n\n@dataclass\nclass WorkspacesReadFileRequest:\n path: str\n \"\"\"Relative path within the workspace files directory\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'WorkspacesReadFileRequest':\n assert isinstance(obj, dict)\n path = from_str(obj.get(\"path\"))\n return WorkspacesReadFileRequest(path)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"path\"] = from_str(self.path)\n return result\n\n@dataclass\nclass WorkspacesReadFileResult:\n content: str\n \"\"\"File content as a UTF-8 string\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'WorkspacesReadFileResult':\n assert isinstance(obj, dict)\n content = from_str(obj.get(\"content\"))\n return WorkspacesReadFileResult(content)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"content\"] = from_str(self.content)\n return result\n\n@dataclass\nclass AccountGetQuotaResult:\n quota_snapshots: dict[str, AccountQuotaSnapshot]\n \"\"\"Quota snapshots keyed by type (e.g., chat, completions, premium_interactions)\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'AccountGetQuotaResult':\n assert isinstance(obj, dict)\n quota_snapshots = from_dict(AccountQuotaSnapshot.from_dict, obj.get(\"quotaSnapshots\"))\n return AccountGetQuotaResult(quota_snapshots)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"quotaSnapshots\"] = from_dict(lambda x: to_class(AccountQuotaSnapshot, x), self.quota_snapshots)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass AgentGetCurrentResult:\n agent: AgentInfo | None = None\n \"\"\"Currently selected custom agent, or null if using the default agent\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'AgentGetCurrentResult':\n assert isinstance(obj, dict)\n agent = from_union([AgentInfo.from_dict, from_none], obj.get(\"agent\"))\n return AgentGetCurrentResult(agent)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.agent is not None:\n result[\"agent\"] = from_union([lambda x: to_class(AgentInfo, x), from_none], self.agent)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass AgentList:\n agents: list[AgentInfo]\n \"\"\"Available custom agents\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'AgentList':\n assert isinstance(obj, dict)\n agents = from_list(AgentInfo.from_dict, obj.get(\"agents\"))\n return AgentList(agents)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"agents\"] = from_list(lambda x: to_class(AgentInfo, x), self.agents)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass AgentReloadResult:\n agents: list[AgentInfo]\n \"\"\"Reloaded custom agents\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'AgentReloadResult':\n assert isinstance(obj, dict)\n agents = from_list(AgentInfo.from_dict, obj.get(\"agents\"))\n return AgentReloadResult(agents)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"agents\"] = from_list(lambda x: to_class(AgentInfo, x), self.agents)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass AgentSelectResult:\n agent: AgentInfo\n \"\"\"The newly selected custom agent\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'AgentSelectResult':\n assert isinstance(obj, dict)\n agent = AgentInfo.from_dict(obj.get(\"agent\"))\n return AgentSelectResult(agent)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"agent\"] = to_class(AgentInfo, self.agent)\n return result\n\n@dataclass\nclass SessionAuthStatus:\n is_authenticated: bool\n \"\"\"Whether the session has resolved authentication\"\"\"\n\n auth_type: AuthInfoType | None = None\n \"\"\"Authentication type\"\"\"\n\n copilot_plan: str | None = None\n \"\"\"Copilot plan tier (e.g., individual_pro, business)\"\"\"\n\n host: str | None = None\n \"\"\"Authentication host URL\"\"\"\n\n login: str | None = None\n \"\"\"Authenticated login/username, if available\"\"\"\n\n status_message: str | None = None\n \"\"\"Human-readable authentication status description\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionAuthStatus':\n assert isinstance(obj, dict)\n is_authenticated = from_bool(obj.get(\"isAuthenticated\"))\n auth_type = from_union([AuthInfoType, from_none], obj.get(\"authType\"))\n copilot_plan = from_union([from_str, from_none], obj.get(\"copilotPlan\"))\n host = from_union([from_str, from_none], obj.get(\"host\"))\n login = from_union([from_str, from_none], obj.get(\"login\"))\n status_message = from_union([from_str, from_none], obj.get(\"statusMessage\"))\n return SessionAuthStatus(is_authenticated, auth_type, copilot_plan, host, login, status_message)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"isAuthenticated\"] = from_bool(self.is_authenticated)\n if self.auth_type is not None:\n result[\"authType\"] = from_union([lambda x: to_enum(AuthInfoType, x), from_none], self.auth_type)\n if self.copilot_plan is not None:\n result[\"copilotPlan\"] = from_union([from_str, from_none], self.copilot_plan)\n if self.host is not None:\n result[\"host\"] = from_union([from_str, from_none], self.host)\n if self.login is not None:\n result[\"login\"] = from_union([from_str, from_none], self.login)\n if self.status_message is not None:\n result[\"statusMessage\"] = from_union([from_str, from_none], self.status_message)\n return result\n\n@dataclass\nclass DiscoveredMCPServer:\n enabled: bool\n \"\"\"Whether the server is enabled (not in the disabled list)\"\"\"\n\n name: str\n \"\"\"Server name (config key)\"\"\"\n\n source: MCPServerSource\n \"\"\"Configuration source\"\"\"\n\n type: DiscoveredMCPServerType | None = None\n \"\"\"Server transport type: stdio, http, sse, or memory (local configs are normalized to stdio)\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'DiscoveredMCPServer':\n assert isinstance(obj, dict)\n enabled = from_bool(obj.get(\"enabled\"))\n name = from_str(obj.get(\"name\"))\n source = MCPServerSource(obj.get(\"source\"))\n type = from_union([DiscoveredMCPServerType, from_none], obj.get(\"type\"))\n return DiscoveredMCPServer(enabled, name, source, type)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"enabled\"] = from_bool(self.enabled)\n result[\"name\"] = from_str(self.name)\n result[\"source\"] = to_enum(MCPServerSource, self.source)\n if self.type is not None:\n result[\"type\"] = from_union([lambda x: to_enum(DiscoveredMCPServerType, x), from_none], self.type)\n return result\n\n@dataclass\nclass Extension:\n id: str\n \"\"\"Source-qualified ID (e.g., 'project:my-ext', 'user:auth-helper')\"\"\"\n\n name: str\n \"\"\"Extension name (directory name)\"\"\"\n\n source: ExtensionSource\n \"\"\"Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/)\"\"\"\n\n status: ExtensionStatus\n \"\"\"Current status: running, disabled, failed, or starting\"\"\"\n\n pid: int | None = None\n \"\"\"Process ID if the extension is running\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'Extension':\n assert isinstance(obj, dict)\n id = from_str(obj.get(\"id\"))\n name = from_str(obj.get(\"name\"))\n source = ExtensionSource(obj.get(\"source\"))\n status = ExtensionStatus(obj.get(\"status\"))\n pid = from_union([from_int, from_none], obj.get(\"pid\"))\n return Extension(id, name, source, status, pid)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"id\"] = from_str(self.id)\n result[\"name\"] = from_str(self.name)\n result[\"source\"] = to_enum(ExtensionSource, self.source)\n result[\"status\"] = to_enum(ExtensionStatus, self.status)\n if self.pid is not None:\n result[\"pid\"] = from_union([from_int, from_none], self.pid)\n return result\n\n@dataclass\nclass ExternalToolTextResultForLlmContentResourceLinkIcon:\n \"\"\"Icon image for a resource\"\"\"\n\n src: str\n \"\"\"URL or path to the icon image\"\"\"\n\n mime_type: str | None = None\n \"\"\"MIME type of the icon image\"\"\"\n\n sizes: list[str] | None = None\n \"\"\"Available icon sizes (e.g., ['16x16', '32x32'])\"\"\"\n\n theme: ExternalToolTextResultForLlmContentResourceLinkIconTheme | None = None\n \"\"\"Theme variant this icon is intended for\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentResourceLinkIcon':\n assert isinstance(obj, dict)\n src = from_str(obj.get(\"src\"))\n mime_type = from_union([from_str, from_none], obj.get(\"mimeType\"))\n sizes = from_union([lambda x: from_list(from_str, x), from_none], obj.get(\"sizes\"))\n theme = from_union([ExternalToolTextResultForLlmContentResourceLinkIconTheme, from_none], obj.get(\"theme\"))\n return ExternalToolTextResultForLlmContentResourceLinkIcon(src, mime_type, sizes, theme)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"src\"] = from_str(self.src)\n if self.mime_type is not None:\n result[\"mimeType\"] = from_union([from_str, from_none], self.mime_type)\n if self.sizes is not None:\n result[\"sizes\"] = from_union([lambda x: from_list(from_str, x), from_none], self.sizes)\n if self.theme is not None:\n result[\"theme\"] = from_union([lambda x: to_enum(ExternalToolTextResultForLlmContentResourceLinkIconTheme, x), from_none], self.theme)\n return result\n\n@dataclass\nclass ExternalToolTextResultForLlmContentAudio:\n \"\"\"Audio content block with base64-encoded data\"\"\"\n\n data: str\n \"\"\"Base64-encoded audio data\"\"\"\n\n mime_type: str\n \"\"\"MIME type of the audio (e.g., audio/wav, audio/mpeg)\"\"\"\n\n type: ExternalToolTextResultForLlmContentAudioType\n \"\"\"Content block type discriminator\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentAudio':\n assert isinstance(obj, dict)\n data = from_str(obj.get(\"data\"))\n mime_type = from_str(obj.get(\"mimeType\"))\n type = ExternalToolTextResultForLlmContentAudioType(obj.get(\"type\"))\n return ExternalToolTextResultForLlmContentAudio(data, mime_type, type)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"data\"] = from_str(self.data)\n result[\"mimeType\"] = from_str(self.mime_type)\n result[\"type\"] = to_enum(ExternalToolTextResultForLlmContentAudioType, self.type)\n return result\n\n@dataclass\nclass ExternalToolTextResultForLlmContentImage:\n \"\"\"Image content block with base64-encoded data\"\"\"\n\n data: str\n \"\"\"Base64-encoded image data\"\"\"\n\n mime_type: str\n \"\"\"MIME type of the image (e.g., image/png, image/jpeg)\"\"\"\n\n type: ExternalToolTextResultForLlmContentImageType\n \"\"\"Content block type discriminator\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentImage':\n assert isinstance(obj, dict)\n data = from_str(obj.get(\"data\"))\n mime_type = from_str(obj.get(\"mimeType\"))\n type = ExternalToolTextResultForLlmContentImageType(obj.get(\"type\"))\n return ExternalToolTextResultForLlmContentImage(data, mime_type, type)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"data\"] = from_str(self.data)\n result[\"mimeType\"] = from_str(self.mime_type)\n result[\"type\"] = to_enum(ExternalToolTextResultForLlmContentImageType, self.type)\n return result\n\n@dataclass\nclass ExternalToolTextResultForLlmContentResource:\n \"\"\"Embedded resource content block with inline text or binary data\"\"\"\n\n resource: ExternalToolTextResultForLlmContentResourceDetails\n \"\"\"The embedded resource contents, either text or base64-encoded binary\"\"\"\n\n type: ExternalToolTextResultForLlmContentResourceType\n \"\"\"Content block type discriminator\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentResource':\n assert isinstance(obj, dict)\n resource = ExternalToolTextResultForLlmContentResourceDetails.from_dict(obj.get(\"resource\"))\n type = ExternalToolTextResultForLlmContentResourceType(obj.get(\"type\"))\n return ExternalToolTextResultForLlmContentResource(resource, type)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"resource\"] = to_class(ExternalToolTextResultForLlmContentResourceDetails, self.resource)\n result[\"type\"] = to_enum(ExternalToolTextResultForLlmContentResourceType, self.type)\n return result\n\n@dataclass\nclass ExternalToolTextResultForLlmContentTerminal:\n \"\"\"Terminal/shell output content block with optional exit code and working directory\"\"\"\n\n text: str\n \"\"\"Terminal/shell output text\"\"\"\n\n type: ExternalToolTextResultForLlmContentTerminalType\n \"\"\"Content block type discriminator\"\"\"\n\n cwd: str | None = None\n \"\"\"Working directory where the command was executed\"\"\"\n\n exit_code: float | None = None\n \"\"\"Process exit code, if the command has completed\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentTerminal':\n assert isinstance(obj, dict)\n text = from_str(obj.get(\"text\"))\n type = ExternalToolTextResultForLlmContentTerminalType(obj.get(\"type\"))\n cwd = from_union([from_str, from_none], obj.get(\"cwd\"))\n exit_code = from_union([from_float, from_none], obj.get(\"exitCode\"))\n return ExternalToolTextResultForLlmContentTerminal(text, type, cwd, exit_code)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"text\"] = from_str(self.text)\n result[\"type\"] = to_enum(ExternalToolTextResultForLlmContentTerminalType, self.type)\n if self.cwd is not None:\n result[\"cwd\"] = from_union([from_str, from_none], self.cwd)\n if self.exit_code is not None:\n result[\"exitCode\"] = from_union([to_float, from_none], self.exit_code)\n return result\n\n@dataclass\nclass ExternalToolTextResultForLlmContentText:\n \"\"\"Plain text content block\"\"\"\n\n text: str\n \"\"\"The text content\"\"\"\n\n type: ExternalToolTextResultForLlmContentTextType\n \"\"\"Content block type discriminator\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentText':\n assert isinstance(obj, dict)\n text = from_str(obj.get(\"text\"))\n type = ExternalToolTextResultForLlmContentTextType(obj.get(\"type\"))\n return ExternalToolTextResultForLlmContentText(text, type)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"text\"] = from_str(self.text)\n result[\"type\"] = to_enum(ExternalToolTextResultForLlmContentTextType, self.type)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass HistoryCompactResult:\n messages_removed: int\n \"\"\"Number of messages removed during compaction\"\"\"\n\n success: bool\n \"\"\"Whether compaction completed successfully\"\"\"\n\n tokens_removed: int\n \"\"\"Number of tokens freed by compaction\"\"\"\n\n context_window: HistoryCompactContextWindow | None = None\n \"\"\"Post-compaction context window usage breakdown\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'HistoryCompactResult':\n assert isinstance(obj, dict)\n messages_removed = from_int(obj.get(\"messagesRemoved\"))\n success = from_bool(obj.get(\"success\"))\n tokens_removed = from_int(obj.get(\"tokensRemoved\"))\n context_window = from_union([HistoryCompactContextWindow.from_dict, from_none], obj.get(\"contextWindow\"))\n return HistoryCompactResult(messages_removed, success, tokens_removed, context_window)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"messagesRemoved\"] = from_int(self.messages_removed)\n result[\"success\"] = from_bool(self.success)\n result[\"tokensRemoved\"] = from_int(self.tokens_removed)\n if self.context_window is not None:\n result[\"contextWindow\"] = from_union([lambda x: to_class(HistoryCompactContextWindow, x), from_none], self.context_window)\n return result\n\n@dataclass\nclass InstructionsSources:\n content: str\n \"\"\"Raw content of the instruction file\"\"\"\n\n id: str\n \"\"\"Unique identifier for this source (used for toggling)\"\"\"\n\n label: str\n \"\"\"Human-readable label\"\"\"\n\n location: InstructionsSourcesLocation\n \"\"\"Where this source lives — used for UI grouping\"\"\"\n\n source_path: str\n \"\"\"File path relative to repo or absolute for home\"\"\"\n\n type: InstructionsSourcesType\n \"\"\"Category of instruction source — used for merge logic\"\"\"\n\n apply_to: str | None = None\n \"\"\"Glob pattern from frontmatter — when set, this instruction applies only to matching files\"\"\"\n\n description: str | None = None\n \"\"\"Short description (body after frontmatter) for use in instruction tables\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'InstructionsSources':\n assert isinstance(obj, dict)\n content = from_str(obj.get(\"content\"))\n id = from_str(obj.get(\"id\"))\n label = from_str(obj.get(\"label\"))\n location = InstructionsSourcesLocation(obj.get(\"location\"))\n source_path = from_str(obj.get(\"sourcePath\"))\n type = InstructionsSourcesType(obj.get(\"type\"))\n apply_to = from_union([from_str, from_none], obj.get(\"applyTo\"))\n description = from_union([from_str, from_none], obj.get(\"description\"))\n return InstructionsSources(content, id, label, location, source_path, type, apply_to, description)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"content\"] = from_str(self.content)\n result[\"id\"] = from_str(self.id)\n result[\"label\"] = from_str(self.label)\n result[\"location\"] = to_enum(InstructionsSourcesLocation, self.location)\n result[\"sourcePath\"] = from_str(self.source_path)\n result[\"type\"] = to_enum(InstructionsSourcesType, self.type)\n if self.apply_to is not None:\n result[\"applyTo\"] = from_union([from_str, from_none], self.apply_to)\n if self.description is not None:\n result[\"description\"] = from_union([from_str, from_none], self.description)\n return result\n\n@dataclass\nclass LogRequest:\n message: str\n \"\"\"Human-readable message\"\"\"\n\n ephemeral: bool | None = None\n \"\"\"When true, the message is transient and not persisted to the session event log on disk\"\"\"\n\n level: SessionLogLevel | None = None\n \"\"\"Log severity level. Determines how the message is displayed in the timeline. Defaults to\n \"info\".\n \"\"\"\n url: str | None = None\n \"\"\"Optional URL the user can open in their browser for more details\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'LogRequest':\n assert isinstance(obj, dict)\n message = from_str(obj.get(\"message\"))\n ephemeral = from_union([from_bool, from_none], obj.get(\"ephemeral\"))\n level = from_union([SessionLogLevel, from_none], obj.get(\"level\"))\n url = from_union([from_str, from_none], obj.get(\"url\"))\n return LogRequest(message, ephemeral, level, url)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"message\"] = from_str(self.message)\n if self.ephemeral is not None:\n result[\"ephemeral\"] = from_union([from_bool, from_none], self.ephemeral)\n if self.level is not None:\n result[\"level\"] = from_union([lambda x: to_enum(SessionLogLevel, x), from_none], self.level)\n if self.url is not None:\n result[\"url\"] = from_union([from_str, from_none], self.url)\n return result\n\n@dataclass\nclass MCPServerConfig:\n \"\"\"MCP server configuration (local/stdio or remote/http)\"\"\"\n\n args: list[str] | None = None\n command: str | None = None\n cwd: str | None = None\n env: dict[str, str] | None = None\n filter_mapping: dict[str, FilterMappingString] | FilterMappingString | None = None\n is_default_server: bool | None = None\n timeout: int | None = None\n \"\"\"Timeout in milliseconds for tool calls to this server.\"\"\"\n\n tools: list[str] | None = None\n \"\"\"Tools to include. Defaults to all tools if not specified.\"\"\"\n\n type: MCPServerConfigType | None = None\n \"\"\"Remote transport type. Defaults to \"http\" when omitted.\"\"\"\n\n headers: dict[str, str] | None = None\n oauth_client_id: str | None = None\n oauth_grant_type: MCPServerConfigHTTPOauthGrantType | None = None\n oauth_public_client: bool | None = None\n url: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> 'MCPServerConfig':\n assert isinstance(obj, dict)\n args = from_union([lambda x: from_list(from_str, x), from_none], obj.get(\"args\"))\n command = from_union([from_str, from_none], obj.get(\"command\"))\n cwd = from_union([from_str, from_none], obj.get(\"cwd\"))\n env = from_union([lambda x: from_dict(from_str, x), from_none], obj.get(\"env\"))\n filter_mapping = from_union([lambda x: from_dict(FilterMappingString, x), FilterMappingString, from_none], obj.get(\"filterMapping\"))\n is_default_server = from_union([from_bool, from_none], obj.get(\"isDefaultServer\"))\n timeout = from_union([from_int, from_none], obj.get(\"timeout\"))\n tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get(\"tools\"))\n type = from_union([MCPServerConfigType, from_none], obj.get(\"type\"))\n headers = from_union([lambda x: from_dict(from_str, x), from_none], obj.get(\"headers\"))\n oauth_client_id = from_union([from_str, from_none], obj.get(\"oauthClientId\"))\n oauth_grant_type = from_union([MCPServerConfigHTTPOauthGrantType, from_none], obj.get(\"oauthGrantType\"))\n oauth_public_client = from_union([from_bool, from_none], obj.get(\"oauthPublicClient\"))\n url = from_union([from_str, from_none], obj.get(\"url\"))\n return MCPServerConfig(args, command, cwd, env, filter_mapping, is_default_server, timeout, tools, type, headers, oauth_client_id, oauth_grant_type, oauth_public_client, url)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.args is not None:\n result[\"args\"] = from_union([lambda x: from_list(from_str, x), from_none], self.args)\n if self.command is not None:\n result[\"command\"] = from_union([from_str, from_none], self.command)\n if self.cwd is not None:\n result[\"cwd\"] = from_union([from_str, from_none], self.cwd)\n if self.env is not None:\n result[\"env\"] = from_union([lambda x: from_dict(from_str, x), from_none], self.env)\n if self.filter_mapping is not None:\n result[\"filterMapping\"] = from_union([lambda x: from_dict(lambda x: to_enum(FilterMappingString, x), x), lambda x: to_enum(FilterMappingString, x), from_none], self.filter_mapping)\n if self.is_default_server is not None:\n result[\"isDefaultServer\"] = from_union([from_bool, from_none], self.is_default_server)\n if self.timeout is not None:\n result[\"timeout\"] = from_union([from_int, from_none], self.timeout)\n if self.tools is not None:\n result[\"tools\"] = from_union([lambda x: from_list(from_str, x), from_none], self.tools)\n if self.type is not None:\n result[\"type\"] = from_union([lambda x: to_enum(MCPServerConfigType, x), from_none], self.type)\n if self.headers is not None:\n result[\"headers\"] = from_union([lambda x: from_dict(from_str, x), from_none], self.headers)\n if self.oauth_client_id is not None:\n result[\"oauthClientId\"] = from_union([from_str, from_none], self.oauth_client_id)\n if self.oauth_grant_type is not None:\n result[\"oauthGrantType\"] = from_union([lambda x: to_enum(MCPServerConfigHTTPOauthGrantType, x), from_none], self.oauth_grant_type)\n if self.oauth_public_client is not None:\n result[\"oauthPublicClient\"] = from_union([from_bool, from_none], self.oauth_public_client)\n if self.url is not None:\n result[\"url\"] = from_union([from_str, from_none], self.url)\n return result\n\n@dataclass\nclass MCPServer:\n name: str\n \"\"\"Server name (config key)\"\"\"\n\n status: MCPServerStatus\n \"\"\"Connection status: connected, failed, needs-auth, pending, disabled, or not_configured\"\"\"\n\n error: str | None = None\n \"\"\"Error message if the server failed to connect\"\"\"\n\n source: MCPServerSource | None = None\n \"\"\"Configuration source: user, workspace, plugin, or builtin\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'MCPServer':\n assert isinstance(obj, dict)\n name = from_str(obj.get(\"name\"))\n status = MCPServerStatus(obj.get(\"status\"))\n error = from_union([from_str, from_none], obj.get(\"error\"))\n source = from_union([MCPServerSource, from_none], obj.get(\"source\"))\n return MCPServer(name, status, error, source)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"name\"] = from_str(self.name)\n result[\"status\"] = to_enum(MCPServerStatus, self.status)\n if self.error is not None:\n result[\"error\"] = from_union([from_str, from_none], self.error)\n if self.source is not None:\n result[\"source\"] = from_union([lambda x: to_enum(MCPServerSource, x), from_none], self.source)\n return result\n\n@dataclass\nclass MCPServerConfigHTTP:\n url: str\n filter_mapping: dict[str, FilterMappingString] | FilterMappingString | None = None\n headers: dict[str, str] | None = None\n is_default_server: bool | None = None\n oauth_client_id: str | None = None\n oauth_grant_type: MCPServerConfigHTTPOauthGrantType | None = None\n oauth_public_client: bool | None = None\n timeout: int | None = None\n \"\"\"Timeout in milliseconds for tool calls to this server.\"\"\"\n\n tools: list[str] | None = None\n \"\"\"Tools to include. Defaults to all tools if not specified.\"\"\"\n\n type: MCPServerConfigHTTPType | None = None\n \"\"\"Remote transport type. Defaults to \"http\" when omitted.\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'MCPServerConfigHTTP':\n assert isinstance(obj, dict)\n url = from_str(obj.get(\"url\"))\n filter_mapping = from_union([lambda x: from_dict(FilterMappingString, x), FilterMappingString, from_none], obj.get(\"filterMapping\"))\n headers = from_union([lambda x: from_dict(from_str, x), from_none], obj.get(\"headers\"))\n is_default_server = from_union([from_bool, from_none], obj.get(\"isDefaultServer\"))\n oauth_client_id = from_union([from_str, from_none], obj.get(\"oauthClientId\"))\n oauth_grant_type = from_union([MCPServerConfigHTTPOauthGrantType, from_none], obj.get(\"oauthGrantType\"))\n oauth_public_client = from_union([from_bool, from_none], obj.get(\"oauthPublicClient\"))\n timeout = from_union([from_int, from_none], obj.get(\"timeout\"))\n tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get(\"tools\"))\n type = from_union([MCPServerConfigHTTPType, from_none], obj.get(\"type\"))\n return MCPServerConfigHTTP(url, filter_mapping, headers, is_default_server, oauth_client_id, oauth_grant_type, oauth_public_client, timeout, tools, type)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"url\"] = from_str(self.url)\n if self.filter_mapping is not None:\n result[\"filterMapping\"] = from_union([lambda x: from_dict(lambda x: to_enum(FilterMappingString, x), x), lambda x: to_enum(FilterMappingString, x), from_none], self.filter_mapping)\n if self.headers is not None:\n result[\"headers\"] = from_union([lambda x: from_dict(from_str, x), from_none], self.headers)\n if self.is_default_server is not None:\n result[\"isDefaultServer\"] = from_union([from_bool, from_none], self.is_default_server)\n if self.oauth_client_id is not None:\n result[\"oauthClientId\"] = from_union([from_str, from_none], self.oauth_client_id)\n if self.oauth_grant_type is not None:\n result[\"oauthGrantType\"] = from_union([lambda x: to_enum(MCPServerConfigHTTPOauthGrantType, x), from_none], self.oauth_grant_type)\n if self.oauth_public_client is not None:\n result[\"oauthPublicClient\"] = from_union([from_bool, from_none], self.oauth_public_client)\n if self.timeout is not None:\n result[\"timeout\"] = from_union([from_int, from_none], self.timeout)\n if self.tools is not None:\n result[\"tools\"] = from_union([lambda x: from_list(from_str, x), from_none], self.tools)\n if self.type is not None:\n result[\"type\"] = from_union([lambda x: to_enum(MCPServerConfigHTTPType, x), from_none], self.type)\n return result\n\n@dataclass\nclass MCPServerConfigLocal:\n args: list[str]\n command: str\n cwd: str | None = None\n env: dict[str, str] | None = None\n filter_mapping: dict[str, FilterMappingString] | FilterMappingString | None = None\n is_default_server: bool | None = None\n timeout: int | None = None\n \"\"\"Timeout in milliseconds for tool calls to this server.\"\"\"\n\n tools: list[str] | None = None\n \"\"\"Tools to include. Defaults to all tools if not specified.\"\"\"\n\n type: MCPServerConfigLocalType | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> 'MCPServerConfigLocal':\n assert isinstance(obj, dict)\n args = from_list(from_str, obj.get(\"args\"))\n command = from_str(obj.get(\"command\"))\n cwd = from_union([from_str, from_none], obj.get(\"cwd\"))\n env = from_union([lambda x: from_dict(from_str, x), from_none], obj.get(\"env\"))\n filter_mapping = from_union([lambda x: from_dict(FilterMappingString, x), FilterMappingString, from_none], obj.get(\"filterMapping\"))\n is_default_server = from_union([from_bool, from_none], obj.get(\"isDefaultServer\"))\n timeout = from_union([from_int, from_none], obj.get(\"timeout\"))\n tools = from_union([lambda x: from_list(from_str, x), from_none], obj.get(\"tools\"))\n type = from_union([MCPServerConfigLocalType, from_none], obj.get(\"type\"))\n return MCPServerConfigLocal(args, command, cwd, env, filter_mapping, is_default_server, timeout, tools, type)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"args\"] = from_list(from_str, self.args)\n result[\"command\"] = from_str(self.command)\n if self.cwd is not None:\n result[\"cwd\"] = from_union([from_str, from_none], self.cwd)\n if self.env is not None:\n result[\"env\"] = from_union([lambda x: from_dict(from_str, x), from_none], self.env)\n if self.filter_mapping is not None:\n result[\"filterMapping\"] = from_union([lambda x: from_dict(lambda x: to_enum(FilterMappingString, x), x), lambda x: to_enum(FilterMappingString, x), from_none], self.filter_mapping)\n if self.is_default_server is not None:\n result[\"isDefaultServer\"] = from_union([from_bool, from_none], self.is_default_server)\n if self.timeout is not None:\n result[\"timeout\"] = from_union([from_int, from_none], self.timeout)\n if self.tools is not None:\n result[\"tools\"] = from_union([lambda x: from_list(from_str, x), from_none], self.tools)\n if self.type is not None:\n result[\"type\"] = from_union([lambda x: to_enum(MCPServerConfigLocalType, x), from_none], self.type)\n return result\n\n@dataclass\nclass ModeSetRequest:\n mode: SessionMode\n \"\"\"The agent mode. Valid values: \"interactive\", \"plan\", \"autopilot\".\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ModeSetRequest':\n assert isinstance(obj, dict)\n mode = SessionMode(obj.get(\"mode\"))\n return ModeSetRequest(mode)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"mode\"] = to_enum(SessionMode, self.mode)\n return result\n\n@dataclass\nclass ModelCapabilitiesLimits:\n \"\"\"Token limits for prompts, outputs, and context window\"\"\"\n\n max_context_window_tokens: int | None = None\n \"\"\"Maximum total context window size in tokens\"\"\"\n\n max_output_tokens: int | None = None\n \"\"\"Maximum number of output/completion tokens\"\"\"\n\n max_prompt_tokens: int | None = None\n \"\"\"Maximum number of prompt/input tokens\"\"\"\n\n vision: ModelCapabilitiesLimitsVision | None = None\n \"\"\"Vision-specific limits\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ModelCapabilitiesLimits':\n assert isinstance(obj, dict)\n max_context_window_tokens = from_union([from_int, from_none], obj.get(\"max_context_window_tokens\"))\n max_output_tokens = from_union([from_int, from_none], obj.get(\"max_output_tokens\"))\n max_prompt_tokens = from_union([from_int, from_none], obj.get(\"max_prompt_tokens\"))\n vision = from_union([ModelCapabilitiesLimitsVision.from_dict, from_none], obj.get(\"vision\"))\n return ModelCapabilitiesLimits(max_context_window_tokens, max_output_tokens, max_prompt_tokens, vision)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.max_context_window_tokens is not None:\n result[\"max_context_window_tokens\"] = from_union([from_int, from_none], self.max_context_window_tokens)\n if self.max_output_tokens is not None:\n result[\"max_output_tokens\"] = from_union([from_int, from_none], self.max_output_tokens)\n if self.max_prompt_tokens is not None:\n result[\"max_prompt_tokens\"] = from_union([from_int, from_none], self.max_prompt_tokens)\n if self.vision is not None:\n result[\"vision\"] = from_union([lambda x: to_class(ModelCapabilitiesLimitsVision, x), from_none], self.vision)\n return result\n\n@dataclass\nclass ModelCapabilitiesOverrideLimits:\n \"\"\"Token limits for prompts, outputs, and context window\"\"\"\n\n max_context_window_tokens: int | None = None\n \"\"\"Maximum total context window size in tokens\"\"\"\n\n max_output_tokens: int | None = None\n max_prompt_tokens: int | None = None\n vision: ModelCapabilitiesOverrideLimitsVision | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> 'ModelCapabilitiesOverrideLimits':\n assert isinstance(obj, dict)\n max_context_window_tokens = from_union([from_int, from_none], obj.get(\"max_context_window_tokens\"))\n max_output_tokens = from_union([from_int, from_none], obj.get(\"max_output_tokens\"))\n max_prompt_tokens = from_union([from_int, from_none], obj.get(\"max_prompt_tokens\"))\n vision = from_union([ModelCapabilitiesOverrideLimitsVision.from_dict, from_none], obj.get(\"vision\"))\n return ModelCapabilitiesOverrideLimits(max_context_window_tokens, max_output_tokens, max_prompt_tokens, vision)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.max_context_window_tokens is not None:\n result[\"max_context_window_tokens\"] = from_union([from_int, from_none], self.max_context_window_tokens)\n if self.max_output_tokens is not None:\n result[\"max_output_tokens\"] = from_union([from_int, from_none], self.max_output_tokens)\n if self.max_prompt_tokens is not None:\n result[\"max_prompt_tokens\"] = from_union([from_int, from_none], self.max_prompt_tokens)\n if self.vision is not None:\n result[\"vision\"] = from_union([lambda x: to_class(ModelCapabilitiesOverrideLimitsVision, x), from_none], self.vision)\n return result\n\n@dataclass\nclass PermissionDecisionApproveForIonApproval:\n \"\"\"The approval to add as a session-scoped rule\n\n The approval to persist for this location\n \"\"\"\n kind: ApprovalKind\n command_identifiers: list[str] | None = None\n server_name: str | None = None\n tool_name: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveForIonApproval':\n assert isinstance(obj, dict)\n kind = ApprovalKind(obj.get(\"kind\"))\n command_identifiers = from_union([lambda x: from_list(from_str, x), from_none], obj.get(\"commandIdentifiers\"))\n server_name = from_union([from_str, from_none], obj.get(\"serverName\"))\n tool_name = from_union([from_none, from_str], obj.get(\"toolName\"))\n return PermissionDecisionApproveForIonApproval(kind, command_identifiers, server_name, tool_name)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(ApprovalKind, self.kind)\n if self.command_identifiers is not None:\n result[\"commandIdentifiers\"] = from_union([lambda x: from_list(from_str, x), from_none], self.command_identifiers)\n if self.server_name is not None:\n result[\"serverName\"] = from_union([from_str, from_none], self.server_name)\n if self.tool_name is not None:\n result[\"toolName\"] = from_union([from_none, from_str], self.tool_name)\n return result\n\n@dataclass\nclass PermissionDecisionApproveForLocationApproval:\n \"\"\"The approval to persist for this location\"\"\"\n\n kind: ApprovalKind\n command_identifiers: list[str] | None = None\n server_name: str | None = None\n tool_name: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApproval':\n assert isinstance(obj, dict)\n kind = ApprovalKind(obj.get(\"kind\"))\n command_identifiers = from_union([lambda x: from_list(from_str, x), from_none], obj.get(\"commandIdentifiers\"))\n server_name = from_union([from_str, from_none], obj.get(\"serverName\"))\n tool_name = from_union([from_none, from_str], obj.get(\"toolName\"))\n return PermissionDecisionApproveForLocationApproval(kind, command_identifiers, server_name, tool_name)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(ApprovalKind, self.kind)\n if self.command_identifiers is not None:\n result[\"commandIdentifiers\"] = from_union([lambda x: from_list(from_str, x), from_none], self.command_identifiers)\n if self.server_name is not None:\n result[\"serverName\"] = from_union([from_str, from_none], self.server_name)\n if self.tool_name is not None:\n result[\"toolName\"] = from_union([from_none, from_str], self.tool_name)\n return result\n\n@dataclass\nclass PermissionDecisionApproveForSessionApproval:\n \"\"\"The approval to add as a session-scoped rule\"\"\"\n\n kind: ApprovalKind\n command_identifiers: list[str] | None = None\n server_name: str | None = None\n tool_name: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApproval':\n assert isinstance(obj, dict)\n kind = ApprovalKind(obj.get(\"kind\"))\n command_identifiers = from_union([lambda x: from_list(from_str, x), from_none], obj.get(\"commandIdentifiers\"))\n server_name = from_union([from_str, from_none], obj.get(\"serverName\"))\n tool_name = from_union([from_none, from_str], obj.get(\"toolName\"))\n return PermissionDecisionApproveForSessionApproval(kind, command_identifiers, server_name, tool_name)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(ApprovalKind, self.kind)\n if self.command_identifiers is not None:\n result[\"commandIdentifiers\"] = from_union([lambda x: from_list(from_str, x), from_none], self.command_identifiers)\n if self.server_name is not None:\n result[\"serverName\"] = from_union([from_str, from_none], self.server_name)\n if self.tool_name is not None:\n result[\"toolName\"] = from_union([from_none, from_str], self.tool_name)\n return result\n\n@dataclass\nclass PermissionDecisionApproveForLocationApprovalCommands:\n command_identifiers: list[str]\n kind: PermissionDecisionApproveForLocationApprovalCommandsKind\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalCommands':\n assert isinstance(obj, dict)\n command_identifiers = from_list(from_str, obj.get(\"commandIdentifiers\"))\n kind = PermissionDecisionApproveForLocationApprovalCommandsKind(obj.get(\"kind\"))\n return PermissionDecisionApproveForLocationApprovalCommands(command_identifiers, kind)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"commandIdentifiers\"] = from_list(from_str, self.command_identifiers)\n result[\"kind\"] = to_enum(PermissionDecisionApproveForLocationApprovalCommandsKind, self.kind)\n return result\n\n@dataclass\nclass PermissionDecisionApproveForSessionApprovalCommands:\n command_identifiers: list[str]\n kind: PermissionDecisionApproveForLocationApprovalCommandsKind\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalCommands':\n assert isinstance(obj, dict)\n command_identifiers = from_list(from_str, obj.get(\"commandIdentifiers\"))\n kind = PermissionDecisionApproveForLocationApprovalCommandsKind(obj.get(\"kind\"))\n return PermissionDecisionApproveForSessionApprovalCommands(command_identifiers, kind)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"commandIdentifiers\"] = from_list(from_str, self.command_identifiers)\n result[\"kind\"] = to_enum(PermissionDecisionApproveForLocationApprovalCommandsKind, self.kind)\n return result\n\n@dataclass\nclass PermissionDecisionApproveForLocationApprovalCustomTool:\n kind: PermissionDecisionApproveForLocationApprovalCustomToolKind\n tool_name: str\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalCustomTool':\n assert isinstance(obj, dict)\n kind = PermissionDecisionApproveForLocationApprovalCustomToolKind(obj.get(\"kind\"))\n tool_name = from_str(obj.get(\"toolName\"))\n return PermissionDecisionApproveForLocationApprovalCustomTool(kind, tool_name)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionDecisionApproveForLocationApprovalCustomToolKind, self.kind)\n result[\"toolName\"] = from_str(self.tool_name)\n return result\n\n@dataclass\nclass PermissionDecisionApproveForSessionApprovalCustomTool:\n kind: PermissionDecisionApproveForLocationApprovalCustomToolKind\n tool_name: str\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalCustomTool':\n assert isinstance(obj, dict)\n kind = PermissionDecisionApproveForLocationApprovalCustomToolKind(obj.get(\"kind\"))\n tool_name = from_str(obj.get(\"toolName\"))\n return PermissionDecisionApproveForSessionApprovalCustomTool(kind, tool_name)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionDecisionApproveForLocationApprovalCustomToolKind, self.kind)\n result[\"toolName\"] = from_str(self.tool_name)\n return result\n\n@dataclass\nclass PermissionDecisionApproveForLocationApprovalMCP:\n kind: PermissionDecisionApproveForLocationApprovalMCPKind\n server_name: str\n tool_name: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalMCP':\n assert isinstance(obj, dict)\n kind = PermissionDecisionApproveForLocationApprovalMCPKind(obj.get(\"kind\"))\n server_name = from_str(obj.get(\"serverName\"))\n tool_name = from_union([from_none, from_str], obj.get(\"toolName\"))\n return PermissionDecisionApproveForLocationApprovalMCP(kind, server_name, tool_name)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionDecisionApproveForLocationApprovalMCPKind, self.kind)\n result[\"serverName\"] = from_str(self.server_name)\n result[\"toolName\"] = from_union([from_none, from_str], self.tool_name)\n return result\n\n@dataclass\nclass PermissionDecisionApproveForSessionApprovalMCP:\n kind: PermissionDecisionApproveForLocationApprovalMCPKind\n server_name: str\n tool_name: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalMCP':\n assert isinstance(obj, dict)\n kind = PermissionDecisionApproveForLocationApprovalMCPKind(obj.get(\"kind\"))\n server_name = from_str(obj.get(\"serverName\"))\n tool_name = from_union([from_none, from_str], obj.get(\"toolName\"))\n return PermissionDecisionApproveForSessionApprovalMCP(kind, server_name, tool_name)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionDecisionApproveForLocationApprovalMCPKind, self.kind)\n result[\"serverName\"] = from_str(self.server_name)\n result[\"toolName\"] = from_union([from_none, from_str], self.tool_name)\n return result\n\n@dataclass\nclass PermissionDecisionApproveForLocationApprovalMCPSampling:\n kind: PermissionDecisionApproveForLocationApprovalMCPSamplingKind\n server_name: str\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalMCPSampling':\n assert isinstance(obj, dict)\n kind = PermissionDecisionApproveForLocationApprovalMCPSamplingKind(obj.get(\"kind\"))\n server_name = from_str(obj.get(\"serverName\"))\n return PermissionDecisionApproveForLocationApprovalMCPSampling(kind, server_name)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionDecisionApproveForLocationApprovalMCPSamplingKind, self.kind)\n result[\"serverName\"] = from_str(self.server_name)\n return result\n\n@dataclass\nclass PermissionDecisionApproveForSessionApprovalMCPSampling:\n kind: PermissionDecisionApproveForLocationApprovalMCPSamplingKind\n server_name: str\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalMCPSampling':\n assert isinstance(obj, dict)\n kind = PermissionDecisionApproveForLocationApprovalMCPSamplingKind(obj.get(\"kind\"))\n server_name = from_str(obj.get(\"serverName\"))\n return PermissionDecisionApproveForSessionApprovalMCPSampling(kind, server_name)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionDecisionApproveForLocationApprovalMCPSamplingKind, self.kind)\n result[\"serverName\"] = from_str(self.server_name)\n return result\n\n@dataclass\nclass PermissionDecisionApproveForLocationApprovalMemory:\n kind: PermissionDecisionApproveForLocationApprovalMemoryKind\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalMemory':\n assert isinstance(obj, dict)\n kind = PermissionDecisionApproveForLocationApprovalMemoryKind(obj.get(\"kind\"))\n return PermissionDecisionApproveForLocationApprovalMemory(kind)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionDecisionApproveForLocationApprovalMemoryKind, self.kind)\n return result\n\n@dataclass\nclass PermissionDecisionApproveForSessionApprovalMemory:\n kind: PermissionDecisionApproveForLocationApprovalMemoryKind\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalMemory':\n assert isinstance(obj, dict)\n kind = PermissionDecisionApproveForLocationApprovalMemoryKind(obj.get(\"kind\"))\n return PermissionDecisionApproveForSessionApprovalMemory(kind)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionDecisionApproveForLocationApprovalMemoryKind, self.kind)\n return result\n\n@dataclass\nclass PermissionDecisionApproveForLocationApprovalRead:\n kind: PermissionDecisionApproveForLocationApprovalReadKind\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalRead':\n assert isinstance(obj, dict)\n kind = PermissionDecisionApproveForLocationApprovalReadKind(obj.get(\"kind\"))\n return PermissionDecisionApproveForLocationApprovalRead(kind)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionDecisionApproveForLocationApprovalReadKind, self.kind)\n return result\n\n@dataclass\nclass PermissionDecisionApproveForSessionApprovalRead:\n kind: PermissionDecisionApproveForLocationApprovalReadKind\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalRead':\n assert isinstance(obj, dict)\n kind = PermissionDecisionApproveForLocationApprovalReadKind(obj.get(\"kind\"))\n return PermissionDecisionApproveForSessionApprovalRead(kind)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionDecisionApproveForLocationApprovalReadKind, self.kind)\n return result\n\n@dataclass\nclass PermissionDecisionApproveForLocationApprovalWrite:\n kind: PermissionDecisionApproveForLocationApprovalWriteKind\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocationApprovalWrite':\n assert isinstance(obj, dict)\n kind = PermissionDecisionApproveForLocationApprovalWriteKind(obj.get(\"kind\"))\n return PermissionDecisionApproveForLocationApprovalWrite(kind)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionDecisionApproveForLocationApprovalWriteKind, self.kind)\n return result\n\n@dataclass\nclass PermissionDecisionApproveForSessionApprovalWrite:\n kind: PermissionDecisionApproveForLocationApprovalWriteKind\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveForSessionApprovalWrite':\n assert isinstance(obj, dict)\n kind = PermissionDecisionApproveForLocationApprovalWriteKind(obj.get(\"kind\"))\n return PermissionDecisionApproveForSessionApprovalWrite(kind)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionDecisionApproveForLocationApprovalWriteKind, self.kind)\n return result\n\n@dataclass\nclass PermissionDecisionApproveOnce:\n kind: PermissionDecisionApproveOnceKind\n \"\"\"The permission request was approved for this one instance\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveOnce':\n assert isinstance(obj, dict)\n kind = PermissionDecisionApproveOnceKind(obj.get(\"kind\"))\n return PermissionDecisionApproveOnce(kind)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionDecisionApproveOnceKind, self.kind)\n return result\n\n@dataclass\nclass PermissionDecisionApprovePermanently:\n domain: str\n \"\"\"The URL domain to approve permanently\"\"\"\n\n kind: PermissionDecisionApprovePermanentlyKind\n \"\"\"Approved and persisted across sessions\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApprovePermanently':\n assert isinstance(obj, dict)\n domain = from_str(obj.get(\"domain\"))\n kind = PermissionDecisionApprovePermanentlyKind(obj.get(\"kind\"))\n return PermissionDecisionApprovePermanently(domain, kind)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"domain\"] = from_str(self.domain)\n result[\"kind\"] = to_enum(PermissionDecisionApprovePermanentlyKind, self.kind)\n return result\n\n@dataclass\nclass PermissionDecisionReject:\n kind: PermissionDecisionRejectKind\n \"\"\"Denied by the user during an interactive prompt\"\"\"\n\n feedback: str | None = None\n \"\"\"Optional feedback from the user explaining the denial\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionReject':\n assert isinstance(obj, dict)\n kind = PermissionDecisionRejectKind(obj.get(\"kind\"))\n feedback = from_union([from_str, from_none], obj.get(\"feedback\"))\n return PermissionDecisionReject(kind, feedback)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionDecisionRejectKind, self.kind)\n if self.feedback is not None:\n result[\"feedback\"] = from_union([from_str, from_none], self.feedback)\n return result\n\n@dataclass\nclass PermissionDecisionUserNotAvailable:\n kind: PermissionDecisionUserNotAvailableKind\n \"\"\"Denied because user confirmation was unavailable\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionUserNotAvailable':\n assert isinstance(obj, dict)\n kind = PermissionDecisionUserNotAvailableKind(obj.get(\"kind\"))\n return PermissionDecisionUserNotAvailable(kind)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionDecisionUserNotAvailableKind, self.kind)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass PluginList:\n plugins: list[Plugin]\n \"\"\"Installed plugins\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'PluginList':\n assert isinstance(obj, dict)\n plugins = from_list(Plugin.from_dict, obj.get(\"plugins\"))\n return PluginList(plugins)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"plugins\"] = from_list(lambda x: to_class(Plugin, x), self.plugins)\n return result\n\n@dataclass\nclass ServerSkillList:\n skills: list[ServerSkill]\n \"\"\"All discovered skills across all sources\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ServerSkillList':\n assert isinstance(obj, dict)\n skills = from_list(ServerSkill.from_dict, obj.get(\"skills\"))\n return ServerSkillList(skills)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"skills\"] = from_list(lambda x: to_class(ServerSkill, x), self.skills)\n return result\n\n@dataclass\nclass SessionFSError:\n \"\"\"Describes a filesystem error.\"\"\"\n\n code: SessionFSErrorCode\n \"\"\"Error classification\"\"\"\n\n message: str | None = None\n \"\"\"Free-form detail about the error, for logging/diagnostics\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionFSError':\n assert isinstance(obj, dict)\n code = SessionFSErrorCode(obj.get(\"code\"))\n message = from_union([from_str, from_none], obj.get(\"message\"))\n return SessionFSError(code, message)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"code\"] = to_enum(SessionFSErrorCode, self.code)\n if self.message is not None:\n result[\"message\"] = from_union([from_str, from_none], self.message)\n return result\n\n@dataclass\nclass SessionFSReaddirWithTypesEntry:\n name: str\n \"\"\"Entry name\"\"\"\n\n type: SessionFSReaddirWithTypesEntryType\n \"\"\"Entry type\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionFSReaddirWithTypesEntry':\n assert isinstance(obj, dict)\n name = from_str(obj.get(\"name\"))\n type = SessionFSReaddirWithTypesEntryType(obj.get(\"type\"))\n return SessionFSReaddirWithTypesEntry(name, type)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"name\"] = from_str(self.name)\n result[\"type\"] = to_enum(SessionFSReaddirWithTypesEntryType, self.type)\n return result\n\n@dataclass\nclass SessionFSSetProviderRequest:\n conventions: SessionFSSetProviderConventions\n \"\"\"Path conventions used by this filesystem\"\"\"\n\n initial_cwd: str\n \"\"\"Initial working directory for sessions\"\"\"\n\n session_state_path: str\n \"\"\"Path within each session's SessionFs where the runtime stores files for that session\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionFSSetProviderRequest':\n assert isinstance(obj, dict)\n conventions = SessionFSSetProviderConventions(obj.get(\"conventions\"))\n initial_cwd = from_str(obj.get(\"initialCwd\"))\n session_state_path = from_str(obj.get(\"sessionStatePath\"))\n return SessionFSSetProviderRequest(conventions, initial_cwd, session_state_path)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"conventions\"] = to_enum(SessionFSSetProviderConventions, self.conventions)\n result[\"initialCwd\"] = from_str(self.initial_cwd)\n result[\"sessionStatePath\"] = from_str(self.session_state_path)\n return result\n\n@dataclass\nclass ShellKillRequest:\n process_id: str\n \"\"\"Process identifier returned by shell.exec\"\"\"\n\n signal: ShellKillSignal | None = None\n \"\"\"Signal to send (default: SIGTERM)\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ShellKillRequest':\n assert isinstance(obj, dict)\n process_id = from_str(obj.get(\"processId\"))\n signal = from_union([ShellKillSignal, from_none], obj.get(\"signal\"))\n return ShellKillRequest(process_id, signal)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"processId\"] = from_str(self.process_id)\n if self.signal is not None:\n result[\"signal\"] = from_union([lambda x: to_enum(ShellKillSignal, x), from_none], self.signal)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass SkillList:\n skills: list[Skill]\n \"\"\"Available skills\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SkillList':\n assert isinstance(obj, dict)\n skills = from_list(Skill.from_dict, obj.get(\"skills\"))\n return SkillList(skills)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"skills\"] = from_list(lambda x: to_class(Skill, x), self.skills)\n return result\n\n@dataclass\nclass TaskShellInfo:\n attachment_mode: TaskShellInfoAttachmentMode\n \"\"\"Whether the shell runs inside a managed PTY session or as an independent background\n process\n \"\"\"\n command: str\n \"\"\"Command being executed\"\"\"\n\n description: str\n \"\"\"Short description of the task\"\"\"\n\n id: str\n \"\"\"Unique task identifier\"\"\"\n\n started_at: datetime\n \"\"\"ISO 8601 timestamp when the task was started\"\"\"\n\n status: TaskInfoStatus\n \"\"\"Current lifecycle status of the task\"\"\"\n\n type: TaskShellInfoType\n \"\"\"Task kind\"\"\"\n\n can_promote_to_background: bool | None = None\n \"\"\"Whether this shell task can be promoted to background mode\"\"\"\n\n completed_at: datetime | None = None\n \"\"\"ISO 8601 timestamp when the task finished\"\"\"\n\n execution_mode: TaskInfoExecutionMode | None = None\n \"\"\"Whether the shell command is currently sync-waited or background-managed\"\"\"\n\n log_path: str | None = None\n \"\"\"Path to the detached shell log, when available\"\"\"\n\n pid: int | None = None\n \"\"\"Process ID when available\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'TaskShellInfo':\n assert isinstance(obj, dict)\n attachment_mode = TaskShellInfoAttachmentMode(obj.get(\"attachmentMode\"))\n command = from_str(obj.get(\"command\"))\n description = from_str(obj.get(\"description\"))\n id = from_str(obj.get(\"id\"))\n started_at = from_datetime(obj.get(\"startedAt\"))\n status = TaskInfoStatus(obj.get(\"status\"))\n type = TaskShellInfoType(obj.get(\"type\"))\n can_promote_to_background = from_union([from_bool, from_none], obj.get(\"canPromoteToBackground\"))\n completed_at = from_union([from_datetime, from_none], obj.get(\"completedAt\"))\n execution_mode = from_union([TaskInfoExecutionMode, from_none], obj.get(\"executionMode\"))\n log_path = from_union([from_str, from_none], obj.get(\"logPath\"))\n pid = from_union([from_int, from_none], obj.get(\"pid\"))\n return TaskShellInfo(attachment_mode, command, description, id, started_at, status, type, can_promote_to_background, completed_at, execution_mode, log_path, pid)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"attachmentMode\"] = to_enum(TaskShellInfoAttachmentMode, self.attachment_mode)\n result[\"command\"] = from_str(self.command)\n result[\"description\"] = from_str(self.description)\n result[\"id\"] = from_str(self.id)\n result[\"startedAt\"] = self.started_at.isoformat()\n result[\"status\"] = to_enum(TaskInfoStatus, self.status)\n result[\"type\"] = to_enum(TaskShellInfoType, self.type)\n if self.can_promote_to_background is not None:\n result[\"canPromoteToBackground\"] = from_union([from_bool, from_none], self.can_promote_to_background)\n if self.completed_at is not None:\n result[\"completedAt\"] = from_union([lambda x: x.isoformat(), from_none], self.completed_at)\n if self.execution_mode is not None:\n result[\"executionMode\"] = from_union([lambda x: to_enum(TaskInfoExecutionMode, x), from_none], self.execution_mode)\n if self.log_path is not None:\n result[\"logPath\"] = from_union([from_str, from_none], self.log_path)\n if self.pid is not None:\n result[\"pid\"] = from_union([from_int, from_none], self.pid)\n return result\n\n@dataclass\nclass ToolList:\n tools: list[Tool]\n \"\"\"List of available built-in tools with metadata\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ToolList':\n assert isinstance(obj, dict)\n tools = from_list(Tool.from_dict, obj.get(\"tools\"))\n return ToolList(tools)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"tools\"] = from_list(lambda x: to_class(Tool, x), self.tools)\n return result\n\n@dataclass\nclass UIElicitationArrayAnyOfFieldItems:\n any_of: list[UIElicitationArrayAnyOfFieldItemsAnyOf]\n\n @staticmethod\n def from_dict(obj: Any) -> 'UIElicitationArrayAnyOfFieldItems':\n assert isinstance(obj, dict)\n any_of = from_list(UIElicitationArrayAnyOfFieldItemsAnyOf.from_dict, obj.get(\"anyOf\"))\n return UIElicitationArrayAnyOfFieldItems(any_of)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"anyOf\"] = from_list(lambda x: to_class(UIElicitationArrayAnyOfFieldItemsAnyOf, x), self.any_of)\n return result\n\n@dataclass\nclass UIElicitationArrayEnumFieldItems:\n enum: list[str]\n type: UIElicitationArrayEnumFieldItemsType\n\n @staticmethod\n def from_dict(obj: Any) -> 'UIElicitationArrayEnumFieldItems':\n assert isinstance(obj, dict)\n enum = from_list(from_str, obj.get(\"enum\"))\n type = UIElicitationArrayEnumFieldItemsType(obj.get(\"type\"))\n return UIElicitationArrayEnumFieldItems(enum, type)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"enum\"] = from_list(from_str, self.enum)\n result[\"type\"] = to_enum(UIElicitationArrayEnumFieldItemsType, self.type)\n return result\n\n@dataclass\nclass UIElicitationArrayFieldItems:\n enum: list[str] | None = None\n type: UIElicitationArrayEnumFieldItemsType | None = None\n any_of: list[UIElicitationArrayAnyOfFieldItemsAnyOf] | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> 'UIElicitationArrayFieldItems':\n assert isinstance(obj, dict)\n enum = from_union([lambda x: from_list(from_str, x), from_none], obj.get(\"enum\"))\n type = from_union([UIElicitationArrayEnumFieldItemsType, from_none], obj.get(\"type\"))\n any_of = from_union([lambda x: from_list(UIElicitationArrayAnyOfFieldItemsAnyOf.from_dict, x), from_none], obj.get(\"anyOf\"))\n return UIElicitationArrayFieldItems(enum, type, any_of)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.enum is not None:\n result[\"enum\"] = from_union([lambda x: from_list(from_str, x), from_none], self.enum)\n if self.type is not None:\n result[\"type\"] = from_union([lambda x: to_enum(UIElicitationArrayEnumFieldItemsType, x), from_none], self.type)\n if self.any_of is not None:\n result[\"anyOf\"] = from_union([lambda x: from_list(lambda x: to_class(UIElicitationArrayAnyOfFieldItemsAnyOf, x), x), from_none], self.any_of)\n return result\n\n@dataclass\nclass UIElicitationStringEnumField:\n enum: list[str]\n type: UIElicitationArrayEnumFieldItemsType\n default: str | None = None\n description: str | None = None\n enum_names: list[str] | None = None\n title: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> 'UIElicitationStringEnumField':\n assert isinstance(obj, dict)\n enum = from_list(from_str, obj.get(\"enum\"))\n type = UIElicitationArrayEnumFieldItemsType(obj.get(\"type\"))\n default = from_union([from_str, from_none], obj.get(\"default\"))\n description = from_union([from_str, from_none], obj.get(\"description\"))\n enum_names = from_union([lambda x: from_list(from_str, x), from_none], obj.get(\"enumNames\"))\n title = from_union([from_str, from_none], obj.get(\"title\"))\n return UIElicitationStringEnumField(enum, type, default, description, enum_names, title)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"enum\"] = from_list(from_str, self.enum)\n result[\"type\"] = to_enum(UIElicitationArrayEnumFieldItemsType, self.type)\n if self.default is not None:\n result[\"default\"] = from_union([from_str, from_none], self.default)\n if self.description is not None:\n result[\"description\"] = from_union([from_str, from_none], self.description)\n if self.enum_names is not None:\n result[\"enumNames\"] = from_union([lambda x: from_list(from_str, x), from_none], self.enum_names)\n if self.title is not None:\n result[\"title\"] = from_union([from_str, from_none], self.title)\n return result\n\n@dataclass\nclass UIElicitationSchemaPropertyString:\n type: UIElicitationArrayEnumFieldItemsType\n default: str | None = None\n description: str | None = None\n format: UIElicitationSchemaPropertyStringFormat | None = None\n max_length: float | None = None\n min_length: float | None = None\n title: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> 'UIElicitationSchemaPropertyString':\n assert isinstance(obj, dict)\n type = UIElicitationArrayEnumFieldItemsType(obj.get(\"type\"))\n default = from_union([from_str, from_none], obj.get(\"default\"))\n description = from_union([from_str, from_none], obj.get(\"description\"))\n format = from_union([UIElicitationSchemaPropertyStringFormat, from_none], obj.get(\"format\"))\n max_length = from_union([from_float, from_none], obj.get(\"maxLength\"))\n min_length = from_union([from_float, from_none], obj.get(\"minLength\"))\n title = from_union([from_str, from_none], obj.get(\"title\"))\n return UIElicitationSchemaPropertyString(type, default, description, format, max_length, min_length, title)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"type\"] = to_enum(UIElicitationArrayEnumFieldItemsType, self.type)\n if self.default is not None:\n result[\"default\"] = from_union([from_str, from_none], self.default)\n if self.description is not None:\n result[\"description\"] = from_union([from_str, from_none], self.description)\n if self.format is not None:\n result[\"format\"] = from_union([lambda x: to_enum(UIElicitationSchemaPropertyStringFormat, x), from_none], self.format)\n if self.max_length is not None:\n result[\"maxLength\"] = from_union([to_float, from_none], self.max_length)\n if self.min_length is not None:\n result[\"minLength\"] = from_union([to_float, from_none], self.min_length)\n if self.title is not None:\n result[\"title\"] = from_union([from_str, from_none], self.title)\n return result\n\n@dataclass\nclass UIElicitationStringOneOfField:\n one_of: list[UIElicitationStringOneOfFieldOneOf]\n type: UIElicitationArrayEnumFieldItemsType\n default: str | None = None\n description: str | None = None\n title: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> 'UIElicitationStringOneOfField':\n assert isinstance(obj, dict)\n one_of = from_list(UIElicitationStringOneOfFieldOneOf.from_dict, obj.get(\"oneOf\"))\n type = UIElicitationArrayEnumFieldItemsType(obj.get(\"type\"))\n default = from_union([from_str, from_none], obj.get(\"default\"))\n description = from_union([from_str, from_none], obj.get(\"description\"))\n title = from_union([from_str, from_none], obj.get(\"title\"))\n return UIElicitationStringOneOfField(one_of, type, default, description, title)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"oneOf\"] = from_list(lambda x: to_class(UIElicitationStringOneOfFieldOneOf, x), self.one_of)\n result[\"type\"] = to_enum(UIElicitationArrayEnumFieldItemsType, self.type)\n if self.default is not None:\n result[\"default\"] = from_union([from_str, from_none], self.default)\n if self.description is not None:\n result[\"description\"] = from_union([from_str, from_none], self.description)\n if self.title is not None:\n result[\"title\"] = from_union([from_str, from_none], self.title)\n return result\n\n@dataclass\nclass UIElicitationResponse:\n \"\"\"The elicitation response (accept with form values, decline, or cancel)\"\"\"\n\n action: UIElicitationResponseAction\n \"\"\"The user's response: accept (submitted), decline (rejected), or cancel (dismissed)\"\"\"\n\n content: dict[str, float | bool | list[str] | str] | None = None\n \"\"\"The form values submitted by the user (present when action is 'accept')\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'UIElicitationResponse':\n assert isinstance(obj, dict)\n action = UIElicitationResponseAction(obj.get(\"action\"))\n content = from_union([lambda x: from_dict(lambda x: from_union([from_float, from_bool, lambda x: from_list(from_str, x), from_str], x), x), from_none], obj.get(\"content\"))\n return UIElicitationResponse(action, content)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"action\"] = to_enum(UIElicitationResponseAction, self.action)\n if self.content is not None:\n result[\"content\"] = from_union([lambda x: from_dict(lambda x: from_union([to_float, from_bool, lambda x: from_list(from_str, x), from_str], x), x), from_none], self.content)\n return result\n\n@dataclass\nclass UIElicitationSchemaPropertyBoolean:\n type: UIElicitationSchemaPropertyBooleanType\n default: bool | None = None\n description: str | None = None\n title: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> 'UIElicitationSchemaPropertyBoolean':\n assert isinstance(obj, dict)\n type = UIElicitationSchemaPropertyBooleanType(obj.get(\"type\"))\n default = from_union([from_bool, from_none], obj.get(\"default\"))\n description = from_union([from_str, from_none], obj.get(\"description\"))\n title = from_union([from_str, from_none], obj.get(\"title\"))\n return UIElicitationSchemaPropertyBoolean(type, default, description, title)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"type\"] = to_enum(UIElicitationSchemaPropertyBooleanType, self.type)\n if self.default is not None:\n result[\"default\"] = from_union([from_bool, from_none], self.default)\n if self.description is not None:\n result[\"description\"] = from_union([from_str, from_none], self.description)\n if self.title is not None:\n result[\"title\"] = from_union([from_str, from_none], self.title)\n return result\n\n@dataclass\nclass UIElicitationSchemaPropertyNumber:\n type: UIElicitationSchemaPropertyNumberType\n default: float | None = None\n description: str | None = None\n maximum: float | None = None\n minimum: float | None = None\n title: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> 'UIElicitationSchemaPropertyNumber':\n assert isinstance(obj, dict)\n type = UIElicitationSchemaPropertyNumberType(obj.get(\"type\"))\n default = from_union([from_float, from_none], obj.get(\"default\"))\n description = from_union([from_str, from_none], obj.get(\"description\"))\n maximum = from_union([from_float, from_none], obj.get(\"maximum\"))\n minimum = from_union([from_float, from_none], obj.get(\"minimum\"))\n title = from_union([from_str, from_none], obj.get(\"title\"))\n return UIElicitationSchemaPropertyNumber(type, default, description, maximum, minimum, title)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"type\"] = to_enum(UIElicitationSchemaPropertyNumberType, self.type)\n if self.default is not None:\n result[\"default\"] = from_union([to_float, from_none], self.default)\n if self.description is not None:\n result[\"description\"] = from_union([from_str, from_none], self.description)\n if self.maximum is not None:\n result[\"maximum\"] = from_union([to_float, from_none], self.maximum)\n if self.minimum is not None:\n result[\"minimum\"] = from_union([to_float, from_none], self.minimum)\n if self.title is not None:\n result[\"title\"] = from_union([from_str, from_none], self.title)\n return result\n\n@dataclass\nclass UsageMetricsModelMetric:\n requests: UsageMetricsModelMetricRequests\n \"\"\"Request count and cost metrics for this model\"\"\"\n\n usage: UsageMetricsModelMetricUsage\n \"\"\"Token usage metrics for this model\"\"\"\n\n token_details: dict[str, UsageMetricsModelMetricTokenDetail] | None = None\n \"\"\"Token count details per type\"\"\"\n\n total_nano_aiu: int | None = None\n \"\"\"Accumulated nano-AI units cost for this model\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'UsageMetricsModelMetric':\n assert isinstance(obj, dict)\n requests = UsageMetricsModelMetricRequests.from_dict(obj.get(\"requests\"))\n usage = UsageMetricsModelMetricUsage.from_dict(obj.get(\"usage\"))\n token_details = from_union([lambda x: from_dict(UsageMetricsModelMetricTokenDetail.from_dict, x), from_none], obj.get(\"tokenDetails\"))\n total_nano_aiu = from_union([from_int, from_none], obj.get(\"totalNanoAiu\"))\n return UsageMetricsModelMetric(requests, usage, token_details, total_nano_aiu)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"requests\"] = to_class(UsageMetricsModelMetricRequests, self.requests)\n result[\"usage\"] = to_class(UsageMetricsModelMetricUsage, self.usage)\n if self.token_details is not None:\n result[\"tokenDetails\"] = from_union([lambda x: from_dict(lambda x: to_class(UsageMetricsModelMetricTokenDetail, x), x), from_none], self.token_details)\n if self.total_nano_aiu is not None:\n result[\"totalNanoAiu\"] = from_union([from_int, from_none], self.total_nano_aiu)\n return result\n\n@dataclass\nclass Workspace:\n id: UUID\n branch: str | None = None\n chronicle_sync_dismissed: bool | None = None\n created_at: datetime | None = None\n cwd: str | None = None\n git_root: str | None = None\n host_type: HostType | None = None\n mc_last_event_id: str | None = None\n mc_session_id: str | None = None\n mc_task_id: str | None = None\n name: str | None = None\n remote_steerable: bool | None = None\n repository: str | None = None\n session_sync_level: SessionSyncLevel | None = None\n summary: str | None = None\n summary_count: int | None = None\n updated_at: datetime | None = None\n user_named: bool | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> 'Workspace':\n assert isinstance(obj, dict)\n id = UUID(obj.get(\"id\"))\n branch = from_union([from_str, from_none], obj.get(\"branch\"))\n chronicle_sync_dismissed = from_union([from_bool, from_none], obj.get(\"chronicle_sync_dismissed\"))\n created_at = from_union([from_datetime, from_none], obj.get(\"created_at\"))\n cwd = from_union([from_str, from_none], obj.get(\"cwd\"))\n git_root = from_union([from_str, from_none], obj.get(\"git_root\"))\n host_type = from_union([HostType, from_none], obj.get(\"host_type\"))\n mc_last_event_id = from_union([from_str, from_none], obj.get(\"mc_last_event_id\"))\n mc_session_id = from_union([from_str, from_none], obj.get(\"mc_session_id\"))\n mc_task_id = from_union([from_str, from_none], obj.get(\"mc_task_id\"))\n name = from_union([from_str, from_none], obj.get(\"name\"))\n remote_steerable = from_union([from_bool, from_none], obj.get(\"remote_steerable\"))\n repository = from_union([from_str, from_none], obj.get(\"repository\"))\n session_sync_level = from_union([SessionSyncLevel, from_none], obj.get(\"session_sync_level\"))\n summary = from_union([from_str, from_none], obj.get(\"summary\"))\n summary_count = from_union([from_int, from_none], obj.get(\"summary_count\"))\n updated_at = from_union([from_datetime, from_none], obj.get(\"updated_at\"))\n user_named = from_union([from_bool, from_none], obj.get(\"user_named\"))\n return Workspace(id, branch, chronicle_sync_dismissed, created_at, cwd, git_root, host_type, mc_last_event_id, mc_session_id, mc_task_id, name, remote_steerable, repository, session_sync_level, summary, summary_count, updated_at, user_named)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"id\"] = str(self.id)\n if self.branch is not None:\n result[\"branch\"] = from_union([from_str, from_none], self.branch)\n if self.chronicle_sync_dismissed is not None:\n result[\"chronicle_sync_dismissed\"] = from_union([from_bool, from_none], self.chronicle_sync_dismissed)\n if self.created_at is not None:\n result[\"created_at\"] = from_union([lambda x: x.isoformat(), from_none], self.created_at)\n if self.cwd is not None:\n result[\"cwd\"] = from_union([from_str, from_none], self.cwd)\n if self.git_root is not None:\n result[\"git_root\"] = from_union([from_str, from_none], self.git_root)\n if self.host_type is not None:\n result[\"host_type\"] = from_union([lambda x: to_enum(HostType, x), from_none], self.host_type)\n if self.mc_last_event_id is not None:\n result[\"mc_last_event_id\"] = from_union([from_str, from_none], self.mc_last_event_id)\n if self.mc_session_id is not None:\n result[\"mc_session_id\"] = from_union([from_str, from_none], self.mc_session_id)\n if self.mc_task_id is not None:\n result[\"mc_task_id\"] = from_union([from_str, from_none], self.mc_task_id)\n if self.name is not None:\n result[\"name\"] = from_union([from_str, from_none], self.name)\n if self.remote_steerable is not None:\n result[\"remote_steerable\"] = from_union([from_bool, from_none], self.remote_steerable)\n if self.repository is not None:\n result[\"repository\"] = from_union([from_str, from_none], self.repository)\n if self.session_sync_level is not None:\n result[\"session_sync_level\"] = from_union([lambda x: to_enum(SessionSyncLevel, x), from_none], self.session_sync_level)\n if self.summary is not None:\n result[\"summary\"] = from_union([from_str, from_none], self.summary)\n if self.summary_count is not None:\n result[\"summary_count\"] = from_union([from_int, from_none], self.summary_count)\n if self.updated_at is not None:\n result[\"updated_at\"] = from_union([lambda x: x.isoformat(), from_none], self.updated_at)\n if self.user_named is not None:\n result[\"user_named\"] = from_union([from_bool, from_none], self.user_named)\n return result\n\n@dataclass\nclass MCPDiscoverResult:\n servers: list[DiscoveredMCPServer]\n \"\"\"MCP servers discovered from all sources\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'MCPDiscoverResult':\n assert isinstance(obj, dict)\n servers = from_list(DiscoveredMCPServer.from_dict, obj.get(\"servers\"))\n return MCPDiscoverResult(servers)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"servers\"] = from_list(lambda x: to_class(DiscoveredMCPServer, x), self.servers)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass ExtensionList:\n extensions: list[Extension]\n \"\"\"Discovered extensions and their current status\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ExtensionList':\n assert isinstance(obj, dict)\n extensions = from_list(Extension.from_dict, obj.get(\"extensions\"))\n return ExtensionList(extensions)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"extensions\"] = from_list(lambda x: to_class(Extension, x), self.extensions)\n return result\n\n@dataclass\nclass ExternalToolTextResultForLlmContent:\n \"\"\"A content block within a tool result, which may be text, terminal output, image, audio,\n or a resource\n\n Plain text content block\n\n Terminal/shell output content block with optional exit code and working directory\n\n Image content block with base64-encoded data\n\n Audio content block with base64-encoded data\n\n Resource link content block referencing an external resource\n\n Embedded resource content block with inline text or binary data\n \"\"\"\n type: ExternalToolTextResultForLlmContentType\n \"\"\"Content block type discriminator\"\"\"\n\n text: str | None = None\n \"\"\"The text content\n\n Terminal/shell output text\n \"\"\"\n cwd: str | None = None\n \"\"\"Working directory where the command was executed\"\"\"\n\n exit_code: float | None = None\n \"\"\"Process exit code, if the command has completed\"\"\"\n\n data: str | None = None\n \"\"\"Base64-encoded image data\n\n Base64-encoded audio data\n \"\"\"\n mime_type: str | None = None\n \"\"\"MIME type of the image (e.g., image/png, image/jpeg)\n\n MIME type of the audio (e.g., audio/wav, audio/mpeg)\n\n MIME type of the resource content\n \"\"\"\n description: str | None = None\n \"\"\"Human-readable description of the resource\"\"\"\n\n icons: list[ExternalToolTextResultForLlmContentResourceLinkIcon] | None = None\n \"\"\"Icons associated with this resource\"\"\"\n\n name: str | None = None\n \"\"\"Resource name identifier\"\"\"\n\n size: float | None = None\n \"\"\"Size of the resource in bytes\"\"\"\n\n title: str | None = None\n \"\"\"Human-readable display title for the resource\"\"\"\n\n uri: str | None = None\n \"\"\"URI identifying the resource\"\"\"\n\n resource: ExternalToolTextResultForLlmContentResourceDetails | None = None\n \"\"\"The embedded resource contents, either text or base64-encoded binary\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContent':\n assert isinstance(obj, dict)\n type = ExternalToolTextResultForLlmContentType(obj.get(\"type\"))\n text = from_union([from_str, from_none], obj.get(\"text\"))\n cwd = from_union([from_str, from_none], obj.get(\"cwd\"))\n exit_code = from_union([from_float, from_none], obj.get(\"exitCode\"))\n data = from_union([from_str, from_none], obj.get(\"data\"))\n mime_type = from_union([from_str, from_none], obj.get(\"mimeType\"))\n description = from_union([from_str, from_none], obj.get(\"description\"))\n icons = from_union([lambda x: from_list(ExternalToolTextResultForLlmContentResourceLinkIcon.from_dict, x), from_none], obj.get(\"icons\"))\n name = from_union([from_str, from_none], obj.get(\"name\"))\n size = from_union([from_float, from_none], obj.get(\"size\"))\n title = from_union([from_str, from_none], obj.get(\"title\"))\n uri = from_union([from_str, from_none], obj.get(\"uri\"))\n resource = from_union([ExternalToolTextResultForLlmContentResourceDetails.from_dict, from_none], obj.get(\"resource\"))\n return ExternalToolTextResultForLlmContent(type, text, cwd, exit_code, data, mime_type, description, icons, name, size, title, uri, resource)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"type\"] = to_enum(ExternalToolTextResultForLlmContentType, self.type)\n if self.text is not None:\n result[\"text\"] = from_union([from_str, from_none], self.text)\n if self.cwd is not None:\n result[\"cwd\"] = from_union([from_str, from_none], self.cwd)\n if self.exit_code is not None:\n result[\"exitCode\"] = from_union([to_float, from_none], self.exit_code)\n if self.data is not None:\n result[\"data\"] = from_union([from_str, from_none], self.data)\n if self.mime_type is not None:\n result[\"mimeType\"] = from_union([from_str, from_none], self.mime_type)\n if self.description is not None:\n result[\"description\"] = from_union([from_str, from_none], self.description)\n if self.icons is not None:\n result[\"icons\"] = from_union([lambda x: from_list(lambda x: to_class(ExternalToolTextResultForLlmContentResourceLinkIcon, x), x), from_none], self.icons)\n if self.name is not None:\n result[\"name\"] = from_union([from_str, from_none], self.name)\n if self.size is not None:\n result[\"size\"] = from_union([to_float, from_none], self.size)\n if self.title is not None:\n result[\"title\"] = from_union([from_str, from_none], self.title)\n if self.uri is not None:\n result[\"uri\"] = from_union([from_str, from_none], self.uri)\n if self.resource is not None:\n result[\"resource\"] = from_union([lambda x: to_class(ExternalToolTextResultForLlmContentResourceDetails, x), from_none], self.resource)\n return result\n\n@dataclass\nclass ExternalToolTextResultForLlmContentResourceLink:\n \"\"\"Resource link content block referencing an external resource\"\"\"\n\n name: str\n \"\"\"Resource name identifier\"\"\"\n\n type: ExternalToolTextResultForLlmContentResourceLinkType\n \"\"\"Content block type discriminator\"\"\"\n\n uri: str\n \"\"\"URI identifying the resource\"\"\"\n\n description: str | None = None\n \"\"\"Human-readable description of the resource\"\"\"\n\n icons: list[ExternalToolTextResultForLlmContentResourceLinkIcon] | None = None\n \"\"\"Icons associated with this resource\"\"\"\n\n mime_type: str | None = None\n \"\"\"MIME type of the resource content\"\"\"\n\n size: float | None = None\n \"\"\"Size of the resource in bytes\"\"\"\n\n title: str | None = None\n \"\"\"Human-readable display title for the resource\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ExternalToolTextResultForLlmContentResourceLink':\n assert isinstance(obj, dict)\n name = from_str(obj.get(\"name\"))\n type = ExternalToolTextResultForLlmContentResourceLinkType(obj.get(\"type\"))\n uri = from_str(obj.get(\"uri\"))\n description = from_union([from_str, from_none], obj.get(\"description\"))\n icons = from_union([lambda x: from_list(ExternalToolTextResultForLlmContentResourceLinkIcon.from_dict, x), from_none], obj.get(\"icons\"))\n mime_type = from_union([from_str, from_none], obj.get(\"mimeType\"))\n size = from_union([from_float, from_none], obj.get(\"size\"))\n title = from_union([from_str, from_none], obj.get(\"title\"))\n return ExternalToolTextResultForLlmContentResourceLink(name, type, uri, description, icons, mime_type, size, title)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"name\"] = from_str(self.name)\n result[\"type\"] = to_enum(ExternalToolTextResultForLlmContentResourceLinkType, self.type)\n result[\"uri\"] = from_str(self.uri)\n if self.description is not None:\n result[\"description\"] = from_union([from_str, from_none], self.description)\n if self.icons is not None:\n result[\"icons\"] = from_union([lambda x: from_list(lambda x: to_class(ExternalToolTextResultForLlmContentResourceLinkIcon, x), x), from_none], self.icons)\n if self.mime_type is not None:\n result[\"mimeType\"] = from_union([from_str, from_none], self.mime_type)\n if self.size is not None:\n result[\"size\"] = from_union([to_float, from_none], self.size)\n if self.title is not None:\n result[\"title\"] = from_union([from_str, from_none], self.title)\n return result\n\n@dataclass\nclass InstructionsGetSourcesResult:\n sources: list[InstructionsSources]\n \"\"\"Instruction sources for the session\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'InstructionsGetSourcesResult':\n assert isinstance(obj, dict)\n sources = from_list(InstructionsSources.from_dict, obj.get(\"sources\"))\n return InstructionsGetSourcesResult(sources)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"sources\"] = from_list(lambda x: to_class(InstructionsSources, x), self.sources)\n return result\n\n@dataclass\nclass MCPConfigAddRequest:\n config: MCPServerConfig\n \"\"\"MCP server configuration (local/stdio or remote/http)\"\"\"\n\n name: str\n \"\"\"Unique name for the MCP server\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'MCPConfigAddRequest':\n assert isinstance(obj, dict)\n config = MCPServerConfig.from_dict(obj.get(\"config\"))\n name = from_str(obj.get(\"name\"))\n return MCPConfigAddRequest(config, name)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"config\"] = to_class(MCPServerConfig, self.config)\n result[\"name\"] = from_str(self.name)\n return result\n\n@dataclass\nclass MCPConfigList:\n servers: dict[str, MCPServerConfig]\n \"\"\"All MCP servers from user config, keyed by name\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'MCPConfigList':\n assert isinstance(obj, dict)\n servers = from_dict(MCPServerConfig.from_dict, obj.get(\"servers\"))\n return MCPConfigList(servers)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"servers\"] = from_dict(lambda x: to_class(MCPServerConfig, x), self.servers)\n return result\n\n@dataclass\nclass MCPConfigUpdateRequest:\n config: MCPServerConfig\n \"\"\"MCP server configuration (local/stdio or remote/http)\"\"\"\n\n name: str\n \"\"\"Name of the MCP server to update\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'MCPConfigUpdateRequest':\n assert isinstance(obj, dict)\n config = MCPServerConfig.from_dict(obj.get(\"config\"))\n name = from_str(obj.get(\"name\"))\n return MCPConfigUpdateRequest(config, name)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"config\"] = to_class(MCPServerConfig, self.config)\n result[\"name\"] = from_str(self.name)\n return result\n\n@dataclass\nclass MCPServerList:\n servers: list[MCPServer]\n \"\"\"Configured MCP servers\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'MCPServerList':\n assert isinstance(obj, dict)\n servers = from_list(MCPServer.from_dict, obj.get(\"servers\"))\n return MCPServerList(servers)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"servers\"] = from_list(lambda x: to_class(MCPServer, x), self.servers)\n return result\n\n@dataclass\nclass ModelCapabilitiesOverride:\n \"\"\"Override individual model capabilities resolved by the runtime\"\"\"\n\n limits: ModelCapabilitiesOverrideLimits | None = None\n \"\"\"Token limits for prompts, outputs, and context window\"\"\"\n\n supports: ModelCapabilitiesOverrideSupports | None = None\n \"\"\"Feature flags indicating what the model supports\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ModelCapabilitiesOverride':\n assert isinstance(obj, dict)\n limits = from_union([ModelCapabilitiesOverrideLimits.from_dict, from_none], obj.get(\"limits\"))\n supports = from_union([ModelCapabilitiesOverrideSupports.from_dict, from_none], obj.get(\"supports\"))\n return ModelCapabilitiesOverride(limits, supports)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.limits is not None:\n result[\"limits\"] = from_union([lambda x: to_class(ModelCapabilitiesOverrideLimits, x), from_none], self.limits)\n if self.supports is not None:\n result[\"supports\"] = from_union([lambda x: to_class(ModelCapabilitiesOverrideSupports, x), from_none], self.supports)\n return result\n\n@dataclass\nclass PermissionDecision:\n kind: PermissionDecisionKind\n \"\"\"The permission request was approved for this one instance\n\n Approved and remembered for the rest of the session\n\n Approved and persisted for this project location\n\n Approved and persisted across sessions\n\n Denied by the user during an interactive prompt\n\n Denied because user confirmation was unavailable\n \"\"\"\n approval: PermissionDecisionApproveForIonApproval | None = None\n \"\"\"The approval to add as a session-scoped rule\n\n The approval to persist for this location\n \"\"\"\n domain: str | None = None\n \"\"\"The URL domain to approve for this session\n\n The URL domain to approve permanently\n \"\"\"\n location_key: str | None = None\n \"\"\"The location key (git root or cwd) to persist the approval to\"\"\"\n\n feedback: str | None = None\n \"\"\"Optional feedback from the user explaining the denial\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecision':\n assert isinstance(obj, dict)\n kind = PermissionDecisionKind(obj.get(\"kind\"))\n approval = from_union([PermissionDecisionApproveForIonApproval.from_dict, from_none], obj.get(\"approval\"))\n domain = from_union([from_str, from_none], obj.get(\"domain\"))\n location_key = from_union([from_str, from_none], obj.get(\"locationKey\"))\n feedback = from_union([from_str, from_none], obj.get(\"feedback\"))\n return PermissionDecision(kind, approval, domain, location_key, feedback)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionDecisionKind, self.kind)\n if self.approval is not None:\n result[\"approval\"] = from_union([lambda x: to_class(PermissionDecisionApproveForIonApproval, x), from_none], self.approval)\n if self.domain is not None:\n result[\"domain\"] = from_union([from_str, from_none], self.domain)\n if self.location_key is not None:\n result[\"locationKey\"] = from_union([from_str, from_none], self.location_key)\n if self.feedback is not None:\n result[\"feedback\"] = from_union([from_str, from_none], self.feedback)\n return result\n\n@dataclass\nclass PermissionDecisionApproveForLocation:\n approval: PermissionDecisionApproveForLocationApproval\n \"\"\"The approval to persist for this location\"\"\"\n\n kind: PermissionDecisionApproveForLocationKind\n \"\"\"Approved and persisted for this project location\"\"\"\n\n location_key: str\n \"\"\"The location key (git root or cwd) to persist the approval to\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveForLocation':\n assert isinstance(obj, dict)\n approval = PermissionDecisionApproveForLocationApproval.from_dict(obj.get(\"approval\"))\n kind = PermissionDecisionApproveForLocationKind(obj.get(\"kind\"))\n location_key = from_str(obj.get(\"locationKey\"))\n return PermissionDecisionApproveForLocation(approval, kind, location_key)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"approval\"] = to_class(PermissionDecisionApproveForLocationApproval, self.approval)\n result[\"kind\"] = to_enum(PermissionDecisionApproveForLocationKind, self.kind)\n result[\"locationKey\"] = from_str(self.location_key)\n return result\n\n@dataclass\nclass PermissionDecisionApproveForSession:\n kind: PermissionDecisionApproveForSessionKind\n \"\"\"Approved and remembered for the rest of the session\"\"\"\n\n approval: PermissionDecisionApproveForSessionApproval | None = None\n \"\"\"The approval to add as a session-scoped rule\"\"\"\n\n domain: str | None = None\n \"\"\"The URL domain to approve for this session\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionApproveForSession':\n assert isinstance(obj, dict)\n kind = PermissionDecisionApproveForSessionKind(obj.get(\"kind\"))\n approval = from_union([PermissionDecisionApproveForSessionApproval.from_dict, from_none], obj.get(\"approval\"))\n domain = from_union([from_str, from_none], obj.get(\"domain\"))\n return PermissionDecisionApproveForSession(kind, approval, domain)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionDecisionApproveForSessionKind, self.kind)\n if self.approval is not None:\n result[\"approval\"] = from_union([lambda x: to_class(PermissionDecisionApproveForSessionApproval, x), from_none], self.approval)\n if self.domain is not None:\n result[\"domain\"] = from_union([from_str, from_none], self.domain)\n return result\n\n@dataclass\nclass SessionFSReadFileResult:\n content: str\n \"\"\"File content as UTF-8 string\"\"\"\n\n error: SessionFSError | None = None\n \"\"\"Describes a filesystem error.\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionFSReadFileResult':\n assert isinstance(obj, dict)\n content = from_str(obj.get(\"content\"))\n error = from_union([SessionFSError.from_dict, from_none], obj.get(\"error\"))\n return SessionFSReadFileResult(content, error)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"content\"] = from_str(self.content)\n if self.error is not None:\n result[\"error\"] = from_union([lambda x: to_class(SessionFSError, x), from_none], self.error)\n return result\n\n@dataclass\nclass SessionFSReaddirResult:\n entries: list[str]\n \"\"\"Entry names in the directory\"\"\"\n\n error: SessionFSError | None = None\n \"\"\"Describes a filesystem error.\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionFSReaddirResult':\n assert isinstance(obj, dict)\n entries = from_list(from_str, obj.get(\"entries\"))\n error = from_union([SessionFSError.from_dict, from_none], obj.get(\"error\"))\n return SessionFSReaddirResult(entries, error)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"entries\"] = from_list(from_str, self.entries)\n if self.error is not None:\n result[\"error\"] = from_union([lambda x: to_class(SessionFSError, x), from_none], self.error)\n return result\n\n@dataclass\nclass SessionFSStatResult:\n birthtime: datetime\n \"\"\"ISO 8601 timestamp of creation\"\"\"\n\n is_directory: bool\n \"\"\"Whether the path is a directory\"\"\"\n\n is_file: bool\n \"\"\"Whether the path is a file\"\"\"\n\n mtime: datetime\n \"\"\"ISO 8601 timestamp of last modification\"\"\"\n\n size: int\n \"\"\"File size in bytes\"\"\"\n\n error: SessionFSError | None = None\n \"\"\"Describes a filesystem error.\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionFSStatResult':\n assert isinstance(obj, dict)\n birthtime = from_datetime(obj.get(\"birthtime\"))\n is_directory = from_bool(obj.get(\"isDirectory\"))\n is_file = from_bool(obj.get(\"isFile\"))\n mtime = from_datetime(obj.get(\"mtime\"))\n size = from_int(obj.get(\"size\"))\n error = from_union([SessionFSError.from_dict, from_none], obj.get(\"error\"))\n return SessionFSStatResult(birthtime, is_directory, is_file, mtime, size, error)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"birthtime\"] = self.birthtime.isoformat()\n result[\"isDirectory\"] = from_bool(self.is_directory)\n result[\"isFile\"] = from_bool(self.is_file)\n result[\"mtime\"] = self.mtime.isoformat()\n result[\"size\"] = from_int(self.size)\n if self.error is not None:\n result[\"error\"] = from_union([lambda x: to_class(SessionFSError, x), from_none], self.error)\n return result\n\n@dataclass\nclass SessionFSReaddirWithTypesResult:\n entries: list[SessionFSReaddirWithTypesEntry]\n \"\"\"Directory entries with type information\"\"\"\n\n error: SessionFSError | None = None\n \"\"\"Describes a filesystem error.\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'SessionFSReaddirWithTypesResult':\n assert isinstance(obj, dict)\n entries = from_list(SessionFSReaddirWithTypesEntry.from_dict, obj.get(\"entries\"))\n error = from_union([SessionFSError.from_dict, from_none], obj.get(\"error\"))\n return SessionFSReaddirWithTypesResult(entries, error)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"entries\"] = from_list(lambda x: to_class(SessionFSReaddirWithTypesEntry, x), self.entries)\n if self.error is not None:\n result[\"error\"] = from_union([lambda x: to_class(SessionFSError, x), from_none], self.error)\n return result\n\n@dataclass\nclass UIElicitationArrayAnyOfField:\n items: UIElicitationArrayAnyOfFieldItems\n type: UIElicitationArrayAnyOfFieldType\n default: list[str] | None = None\n description: str | None = None\n max_items: float | None = None\n min_items: float | None = None\n title: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> 'UIElicitationArrayAnyOfField':\n assert isinstance(obj, dict)\n items = UIElicitationArrayAnyOfFieldItems.from_dict(obj.get(\"items\"))\n type = UIElicitationArrayAnyOfFieldType(obj.get(\"type\"))\n default = from_union([lambda x: from_list(from_str, x), from_none], obj.get(\"default\"))\n description = from_union([from_str, from_none], obj.get(\"description\"))\n max_items = from_union([from_float, from_none], obj.get(\"maxItems\"))\n min_items = from_union([from_float, from_none], obj.get(\"minItems\"))\n title = from_union([from_str, from_none], obj.get(\"title\"))\n return UIElicitationArrayAnyOfField(items, type, default, description, max_items, min_items, title)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"items\"] = to_class(UIElicitationArrayAnyOfFieldItems, self.items)\n result[\"type\"] = to_enum(UIElicitationArrayAnyOfFieldType, self.type)\n if self.default is not None:\n result[\"default\"] = from_union([lambda x: from_list(from_str, x), from_none], self.default)\n if self.description is not None:\n result[\"description\"] = from_union([from_str, from_none], self.description)\n if self.max_items is not None:\n result[\"maxItems\"] = from_union([to_float, from_none], self.max_items)\n if self.min_items is not None:\n result[\"minItems\"] = from_union([to_float, from_none], self.min_items)\n if self.title is not None:\n result[\"title\"] = from_union([from_str, from_none], self.title)\n return result\n\n@dataclass\nclass UIElicitationArrayEnumField:\n items: UIElicitationArrayEnumFieldItems\n type: UIElicitationArrayAnyOfFieldType\n default: list[str] | None = None\n description: str | None = None\n max_items: float | None = None\n min_items: float | None = None\n title: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> 'UIElicitationArrayEnumField':\n assert isinstance(obj, dict)\n items = UIElicitationArrayEnumFieldItems.from_dict(obj.get(\"items\"))\n type = UIElicitationArrayAnyOfFieldType(obj.get(\"type\"))\n default = from_union([lambda x: from_list(from_str, x), from_none], obj.get(\"default\"))\n description = from_union([from_str, from_none], obj.get(\"description\"))\n max_items = from_union([from_float, from_none], obj.get(\"maxItems\"))\n min_items = from_union([from_float, from_none], obj.get(\"minItems\"))\n title = from_union([from_str, from_none], obj.get(\"title\"))\n return UIElicitationArrayEnumField(items, type, default, description, max_items, min_items, title)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"items\"] = to_class(UIElicitationArrayEnumFieldItems, self.items)\n result[\"type\"] = to_enum(UIElicitationArrayAnyOfFieldType, self.type)\n if self.default is not None:\n result[\"default\"] = from_union([lambda x: from_list(from_str, x), from_none], self.default)\n if self.description is not None:\n result[\"description\"] = from_union([from_str, from_none], self.description)\n if self.max_items is not None:\n result[\"maxItems\"] = from_union([to_float, from_none], self.max_items)\n if self.min_items is not None:\n result[\"minItems\"] = from_union([to_float, from_none], self.min_items)\n if self.title is not None:\n result[\"title\"] = from_union([from_str, from_none], self.title)\n return result\n\n@dataclass\nclass UIElicitationSchemaProperty:\n type: UIElicitationSchemaPropertyType\n default: float | bool | list[str] | str | None = None\n description: str | None = None\n enum: list[str] | None = None\n enum_names: list[str] | None = None\n title: str | None = None\n one_of: list[UIElicitationStringOneOfFieldOneOf] | None = None\n items: UIElicitationArrayFieldItems | None = None\n max_items: float | None = None\n min_items: float | None = None\n format: UIElicitationSchemaPropertyStringFormat | None = None\n max_length: float | None = None\n min_length: float | None = None\n maximum: float | None = None\n minimum: float | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> 'UIElicitationSchemaProperty':\n assert isinstance(obj, dict)\n type = UIElicitationSchemaPropertyType(obj.get(\"type\"))\n default = from_union([from_float, from_bool, lambda x: from_list(from_str, x), from_str, from_none], obj.get(\"default\"))\n description = from_union([from_str, from_none], obj.get(\"description\"))\n enum = from_union([lambda x: from_list(from_str, x), from_none], obj.get(\"enum\"))\n enum_names = from_union([lambda x: from_list(from_str, x), from_none], obj.get(\"enumNames\"))\n title = from_union([from_str, from_none], obj.get(\"title\"))\n one_of = from_union([lambda x: from_list(UIElicitationStringOneOfFieldOneOf.from_dict, x), from_none], obj.get(\"oneOf\"))\n items = from_union([UIElicitationArrayFieldItems.from_dict, from_none], obj.get(\"items\"))\n max_items = from_union([from_float, from_none], obj.get(\"maxItems\"))\n min_items = from_union([from_float, from_none], obj.get(\"minItems\"))\n format = from_union([UIElicitationSchemaPropertyStringFormat, from_none], obj.get(\"format\"))\n max_length = from_union([from_float, from_none], obj.get(\"maxLength\"))\n min_length = from_union([from_float, from_none], obj.get(\"minLength\"))\n maximum = from_union([from_float, from_none], obj.get(\"maximum\"))\n minimum = from_union([from_float, from_none], obj.get(\"minimum\"))\n return UIElicitationSchemaProperty(type, default, description, enum, enum_names, title, one_of, items, max_items, min_items, format, max_length, min_length, maximum, minimum)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"type\"] = to_enum(UIElicitationSchemaPropertyType, self.type)\n if self.default is not None:\n result[\"default\"] = from_union([to_float, from_bool, lambda x: from_list(from_str, x), from_str, from_none], self.default)\n if self.description is not None:\n result[\"description\"] = from_union([from_str, from_none], self.description)\n if self.enum is not None:\n result[\"enum\"] = from_union([lambda x: from_list(from_str, x), from_none], self.enum)\n if self.enum_names is not None:\n result[\"enumNames\"] = from_union([lambda x: from_list(from_str, x), from_none], self.enum_names)\n if self.title is not None:\n result[\"title\"] = from_union([from_str, from_none], self.title)\n if self.one_of is not None:\n result[\"oneOf\"] = from_union([lambda x: from_list(lambda x: to_class(UIElicitationStringOneOfFieldOneOf, x), x), from_none], self.one_of)\n if self.items is not None:\n result[\"items\"] = from_union([lambda x: to_class(UIElicitationArrayFieldItems, x), from_none], self.items)\n if self.max_items is not None:\n result[\"maxItems\"] = from_union([to_float, from_none], self.max_items)\n if self.min_items is not None:\n result[\"minItems\"] = from_union([to_float, from_none], self.min_items)\n if self.format is not None:\n result[\"format\"] = from_union([lambda x: to_enum(UIElicitationSchemaPropertyStringFormat, x), from_none], self.format)\n if self.max_length is not None:\n result[\"maxLength\"] = from_union([to_float, from_none], self.max_length)\n if self.min_length is not None:\n result[\"minLength\"] = from_union([to_float, from_none], self.min_length)\n if self.maximum is not None:\n result[\"maximum\"] = from_union([to_float, from_none], self.maximum)\n if self.minimum is not None:\n result[\"minimum\"] = from_union([to_float, from_none], self.minimum)\n return result\n\n@dataclass\nclass UIHandlePendingElicitationRequest:\n request_id: str\n \"\"\"The unique request ID from the elicitation.requested event\"\"\"\n\n result: UIElicitationResponse\n \"\"\"The elicitation response (accept with form values, decline, or cancel)\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'UIHandlePendingElicitationRequest':\n assert isinstance(obj, dict)\n request_id = from_str(obj.get(\"requestId\"))\n result = UIElicitationResponse.from_dict(obj.get(\"result\"))\n return UIHandlePendingElicitationRequest(request_id, result)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"requestId\"] = from_str(self.request_id)\n result[\"result\"] = to_class(UIElicitationResponse, self.result)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass UsageGetMetricsResult:\n code_changes: UsageMetricsCodeChanges\n \"\"\"Aggregated code change metrics\"\"\"\n\n last_call_input_tokens: int\n \"\"\"Input tokens from the most recent main-agent API call\"\"\"\n\n last_call_output_tokens: int\n \"\"\"Output tokens from the most recent main-agent API call\"\"\"\n\n model_metrics: dict[str, UsageMetricsModelMetric]\n \"\"\"Per-model token and request metrics, keyed by model identifier\"\"\"\n\n session_start_time: int\n \"\"\"Session start timestamp (epoch milliseconds)\"\"\"\n\n total_api_duration_ms: float\n \"\"\"Total time spent in model API calls (milliseconds)\"\"\"\n\n total_premium_request_cost: float\n \"\"\"Total user-initiated premium request cost across all models (may be fractional due to\n multipliers)\n \"\"\"\n total_user_requests: int\n \"\"\"Raw count of user-initiated API requests\"\"\"\n\n current_model: str | None = None\n \"\"\"Currently active model identifier\"\"\"\n\n token_details: dict[str, UsageMetricsTokenDetail] | None = None\n \"\"\"Session-wide per-token-type accumulated token counts\"\"\"\n\n total_nano_aiu: int | None = None\n \"\"\"Session-wide accumulated nano-AI units cost\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'UsageGetMetricsResult':\n assert isinstance(obj, dict)\n code_changes = UsageMetricsCodeChanges.from_dict(obj.get(\"codeChanges\"))\n last_call_input_tokens = from_int(obj.get(\"lastCallInputTokens\"))\n last_call_output_tokens = from_int(obj.get(\"lastCallOutputTokens\"))\n model_metrics = from_dict(UsageMetricsModelMetric.from_dict, obj.get(\"modelMetrics\"))\n session_start_time = from_int(obj.get(\"sessionStartTime\"))\n total_api_duration_ms = from_float(obj.get(\"totalApiDurationMs\"))\n total_premium_request_cost = from_float(obj.get(\"totalPremiumRequestCost\"))\n total_user_requests = from_int(obj.get(\"totalUserRequests\"))\n current_model = from_union([from_str, from_none], obj.get(\"currentModel\"))\n token_details = from_union([lambda x: from_dict(UsageMetricsTokenDetail.from_dict, x), from_none], obj.get(\"tokenDetails\"))\n total_nano_aiu = from_union([from_int, from_none], obj.get(\"totalNanoAiu\"))\n return UsageGetMetricsResult(code_changes, last_call_input_tokens, last_call_output_tokens, model_metrics, session_start_time, total_api_duration_ms, total_premium_request_cost, total_user_requests, current_model, token_details, total_nano_aiu)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"codeChanges\"] = to_class(UsageMetricsCodeChanges, self.code_changes)\n result[\"lastCallInputTokens\"] = from_int(self.last_call_input_tokens)\n result[\"lastCallOutputTokens\"] = from_int(self.last_call_output_tokens)\n result[\"modelMetrics\"] = from_dict(lambda x: to_class(UsageMetricsModelMetric, x), self.model_metrics)\n result[\"sessionStartTime\"] = from_int(self.session_start_time)\n result[\"totalApiDurationMs\"] = to_float(self.total_api_duration_ms)\n result[\"totalPremiumRequestCost\"] = to_float(self.total_premium_request_cost)\n result[\"totalUserRequests\"] = from_int(self.total_user_requests)\n if self.current_model is not None:\n result[\"currentModel\"] = from_union([from_str, from_none], self.current_model)\n if self.token_details is not None:\n result[\"tokenDetails\"] = from_union([lambda x: from_dict(lambda x: to_class(UsageMetricsTokenDetail, x), x), from_none], self.token_details)\n if self.total_nano_aiu is not None:\n result[\"totalNanoAiu\"] = from_union([from_int, from_none], self.total_nano_aiu)\n return result\n\n@dataclass\nclass WorkspacesGetWorkspaceResult:\n workspace: Workspace | None = None\n \"\"\"Current workspace metadata, or null if not available\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'WorkspacesGetWorkspaceResult':\n assert isinstance(obj, dict)\n workspace = from_union([Workspace.from_dict, from_none], obj.get(\"workspace\"))\n return WorkspacesGetWorkspaceResult(workspace)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"workspace\"] = from_union([lambda x: to_class(Workspace, x), from_none], self.workspace)\n return result\n\n@dataclass\nclass ExternalToolTextResultForLlm:\n \"\"\"Expanded external tool result payload\"\"\"\n\n text_result_for_llm: str\n \"\"\"Text result returned to the model\"\"\"\n\n contents: list[ExternalToolTextResultForLlmContent] | None = None\n \"\"\"Structured content blocks from the tool\"\"\"\n\n error: str | None = None\n \"\"\"Optional error message for failed executions\"\"\"\n\n result_type: str | None = None\n \"\"\"Execution outcome classification. Optional for back-compat; normalized to 'success' (or\n 'failure' when error is present) when missing or unrecognized.\n \"\"\"\n session_log: str | None = None\n \"\"\"Detailed log content for timeline display\"\"\"\n\n tool_telemetry: dict[str, Any] | None = None\n \"\"\"Optional tool-specific telemetry\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ExternalToolTextResultForLlm':\n assert isinstance(obj, dict)\n text_result_for_llm = from_str(obj.get(\"textResultForLlm\"))\n contents = from_union([lambda x: from_list(ExternalToolTextResultForLlmContent.from_dict, x), from_none], obj.get(\"contents\"))\n error = from_union([from_str, from_none], obj.get(\"error\"))\n result_type = from_union([from_str, from_none], obj.get(\"resultType\"))\n session_log = from_union([from_str, from_none], obj.get(\"sessionLog\"))\n tool_telemetry = from_union([lambda x: from_dict(lambda x: x, x), from_none], obj.get(\"toolTelemetry\"))\n return ExternalToolTextResultForLlm(text_result_for_llm, contents, error, result_type, session_log, tool_telemetry)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"textResultForLlm\"] = from_str(self.text_result_for_llm)\n if self.contents is not None:\n result[\"contents\"] = from_union([lambda x: from_list(lambda x: to_class(ExternalToolTextResultForLlmContent, x), x), from_none], self.contents)\n if self.error is not None:\n result[\"error\"] = from_union([from_str, from_none], self.error)\n if self.result_type is not None:\n result[\"resultType\"] = from_union([from_str, from_none], self.result_type)\n if self.session_log is not None:\n result[\"sessionLog\"] = from_union([from_str, from_none], self.session_log)\n if self.tool_telemetry is not None:\n result[\"toolTelemetry\"] = from_union([lambda x: from_dict(lambda x: x, x), from_none], self.tool_telemetry)\n return result\n\n@dataclass\nclass PermissionDecisionRequest:\n request_id: str\n \"\"\"Request ID of the pending permission request\"\"\"\n\n result: PermissionDecision\n\n @staticmethod\n def from_dict(obj: Any) -> 'PermissionDecisionRequest':\n assert isinstance(obj, dict)\n request_id = from_str(obj.get(\"requestId\"))\n result = PermissionDecision.from_dict(obj.get(\"result\"))\n return PermissionDecisionRequest(request_id, result)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"requestId\"] = from_str(self.request_id)\n result[\"result\"] = to_class(PermissionDecision, self.result)\n return result\n\n@dataclass\nclass UIElicitationSchema:\n \"\"\"JSON Schema describing the form fields to present to the user\"\"\"\n\n properties: dict[str, UIElicitationSchemaProperty]\n \"\"\"Form field definitions, keyed by field name\"\"\"\n\n type: UIElicitationSchemaType\n \"\"\"Schema type indicator (always 'object')\"\"\"\n\n required: list[str] | None = None\n \"\"\"List of required field names\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'UIElicitationSchema':\n assert isinstance(obj, dict)\n properties = from_dict(UIElicitationSchemaProperty.from_dict, obj.get(\"properties\"))\n type = UIElicitationSchemaType(obj.get(\"type\"))\n required = from_union([lambda x: from_list(from_str, x), from_none], obj.get(\"required\"))\n return UIElicitationSchema(properties, type, required)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"properties\"] = from_dict(lambda x: to_class(UIElicitationSchemaProperty, x), self.properties)\n result[\"type\"] = to_enum(UIElicitationSchemaType, self.type)\n if self.required is not None:\n result[\"required\"] = from_union([lambda x: from_list(from_str, x), from_none], self.required)\n return result\n\n@dataclass\nclass HandlePendingToolCallRequest:\n request_id: str\n \"\"\"Request ID of the pending tool call\"\"\"\n\n error: str | None = None\n \"\"\"Error message if the tool call failed\"\"\"\n\n result: ExternalToolTextResultForLlm | str | None = None\n \"\"\"Tool call result (string or expanded result object)\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'HandlePendingToolCallRequest':\n assert isinstance(obj, dict)\n request_id = from_str(obj.get(\"requestId\"))\n error = from_union([from_str, from_none], obj.get(\"error\"))\n result = from_union([ExternalToolTextResultForLlm.from_dict, from_str, from_none], obj.get(\"result\"))\n return HandlePendingToolCallRequest(request_id, error, result)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"requestId\"] = from_str(self.request_id)\n if self.error is not None:\n result[\"error\"] = from_union([from_str, from_none], self.error)\n if self.result is not None:\n result[\"result\"] = from_union([lambda x: to_class(ExternalToolTextResultForLlm, x), from_str, from_none], self.result)\n return result\n\n@dataclass\nclass UIElicitationRequest:\n message: str\n \"\"\"Message describing what information is needed from the user\"\"\"\n\n requested_schema: UIElicitationSchema\n \"\"\"JSON Schema describing the form fields to present to the user\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'UIElicitationRequest':\n assert isinstance(obj, dict)\n message = from_str(obj.get(\"message\"))\n requested_schema = UIElicitationSchema.from_dict(obj.get(\"requestedSchema\"))\n return UIElicitationRequest(message, requested_schema)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"message\"] = from_str(self.message)\n result[\"requestedSchema\"] = to_class(UIElicitationSchema, self.requested_schema)\n return result\n\n@dataclass\nclass ModelCapabilities:\n \"\"\"Model capabilities and limits\"\"\"\n\n limits: ModelCapabilitiesLimits | None = None\n \"\"\"Token limits for prompts, outputs, and context window\"\"\"\n\n supports: ModelCapabilitiesSupports | None = None\n \"\"\"Feature flags indicating what the model supports\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ModelCapabilities':\n assert isinstance(obj, dict)\n limits = from_union([ModelCapabilitiesLimits.from_dict, from_none], obj.get(\"limits\"))\n supports = from_union([ModelCapabilitiesSupports.from_dict, from_none], obj.get(\"supports\"))\n return ModelCapabilities(limits, supports)\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.limits is not None:\n result[\"limits\"] = from_union([lambda x: to_class(ModelCapabilitiesLimits, x), from_none], self.limits)\n if self.supports is not None:\n result[\"supports\"] = from_union([lambda x: to_class(ModelCapabilitiesSupports, x), from_none], self.supports)\n return result\n\n@dataclass\nclass Model:\n capabilities: ModelCapabilities\n \"\"\"Model capabilities and limits\"\"\"\n\n id: str\n \"\"\"Model identifier (e.g., \"claude-sonnet-4.5\")\"\"\"\n\n name: str\n \"\"\"Display name\"\"\"\n\n billing: ModelBilling | None = None\n \"\"\"Billing information\"\"\"\n\n default_reasoning_effort: str | None = None\n \"\"\"Default reasoning effort level (only present if model supports reasoning effort)\"\"\"\n\n policy: ModelPolicy | None = None\n \"\"\"Policy state (if applicable)\"\"\"\n\n supported_reasoning_efforts: list[str] | None = None\n \"\"\"Supported reasoning effort levels (only present if model supports reasoning effort)\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'Model':\n assert isinstance(obj, dict)\n capabilities = ModelCapabilities.from_dict(obj.get(\"capabilities\"))\n id = from_str(obj.get(\"id\"))\n name = from_str(obj.get(\"name\"))\n billing = from_union([ModelBilling.from_dict, from_none], obj.get(\"billing\"))\n default_reasoning_effort = from_union([from_str, from_none], obj.get(\"defaultReasoningEffort\"))\n policy = from_union([ModelPolicy.from_dict, from_none], obj.get(\"policy\"))\n supported_reasoning_efforts = from_union([lambda x: from_list(from_str, x), from_none], obj.get(\"supportedReasoningEfforts\"))\n return Model(capabilities, id, name, billing, default_reasoning_effort, policy, supported_reasoning_efforts)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"capabilities\"] = to_class(ModelCapabilities, self.capabilities)\n result[\"id\"] = from_str(self.id)\n result[\"name\"] = from_str(self.name)\n if self.billing is not None:\n result[\"billing\"] = from_union([lambda x: to_class(ModelBilling, x), from_none], self.billing)\n if self.default_reasoning_effort is not None:\n result[\"defaultReasoningEffort\"] = from_union([from_str, from_none], self.default_reasoning_effort)\n if self.policy is not None:\n result[\"policy\"] = from_union([lambda x: to_class(ModelPolicy, x), from_none], self.policy)\n if self.supported_reasoning_efforts is not None:\n result[\"supportedReasoningEfforts\"] = from_union([lambda x: from_list(from_str, x), from_none], self.supported_reasoning_efforts)\n return result\n\n@dataclass\nclass ModelList:\n models: list[Model]\n \"\"\"List of available models with full metadata\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ModelList':\n assert isinstance(obj, dict)\n models = from_list(Model.from_dict, obj.get(\"models\"))\n return ModelList(models)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"models\"] = from_list(lambda x: to_class(Model, x), self.models)\n return result\n\n@dataclass\nclass ModelSwitchToRequest:\n model_id: str\n \"\"\"Model identifier to switch to\"\"\"\n\n model_capabilities: ModelCapabilitiesOverride | None = None\n \"\"\"Override individual model capabilities resolved by the runtime\"\"\"\n\n reasoning_effort: str | None = None\n \"\"\"Reasoning effort level to use for the model\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'ModelSwitchToRequest':\n assert isinstance(obj, dict)\n model_id = from_str(obj.get(\"modelId\"))\n model_capabilities = from_union([ModelCapabilitiesOverride.from_dict, from_none], obj.get(\"modelCapabilities\"))\n reasoning_effort = from_union([from_str, from_none], obj.get(\"reasoningEffort\"))\n return ModelSwitchToRequest(model_id, model_capabilities, reasoning_effort)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"modelId\"] = from_str(self.model_id)\n if self.model_capabilities is not None:\n result[\"modelCapabilities\"] = from_union([lambda x: to_class(ModelCapabilitiesOverride, x), from_none], self.model_capabilities)\n if self.reasoning_effort is not None:\n result[\"reasoningEffort\"] = from_union([from_str, from_none], self.reasoning_effort)\n return result\n\n@dataclass\nclass TaskAgentInfo:\n agent_type: str\n \"\"\"Type of agent running this task\"\"\"\n\n description: str\n \"\"\"Short description of the task\"\"\"\n\n id: str\n \"\"\"Unique task identifier\"\"\"\n\n prompt: str\n \"\"\"Prompt passed to the agent\"\"\"\n\n started_at: datetime\n \"\"\"ISO 8601 timestamp when the task was started\"\"\"\n\n status: TaskInfoStatus\n \"\"\"Current lifecycle status of the task\"\"\"\n\n tool_call_id: str\n \"\"\"Tool call ID associated with this agent task\"\"\"\n\n type: TaskAgentInfoType\n \"\"\"Task kind\"\"\"\n\n active_started_at: datetime | None = None\n \"\"\"ISO 8601 timestamp when the current active period began\"\"\"\n\n active_time_ms: int | None = None\n \"\"\"Accumulated active execution time in milliseconds\"\"\"\n\n can_promote_to_background: bool | None = None\n \"\"\"Whether the task is currently in the original sync wait and can be moved to background\n mode. False once it is already backgrounded, idle, finished, or no longer has a\n promotable sync waiter.\n \"\"\"\n completed_at: datetime | None = None\n \"\"\"ISO 8601 timestamp when the task finished\"\"\"\n\n error: str | None = None\n \"\"\"Error message when the task failed\"\"\"\n\n execution_mode: TaskInfoExecutionMode | None = None\n \"\"\"How the agent is currently being managed by the runtime\"\"\"\n\n idle_since: datetime | None = None\n \"\"\"ISO 8601 timestamp when the agent entered idle state\"\"\"\n\n latest_response: str | None = None\n \"\"\"Most recent response text from the agent\"\"\"\n\n model: str | None = None\n \"\"\"Model used for the task when specified\"\"\"\n\n result: str | None = None\n \"\"\"Result text from the task when available\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'TaskAgentInfo':\n assert isinstance(obj, dict)\n agent_type = from_str(obj.get(\"agentType\"))\n description = from_str(obj.get(\"description\"))\n id = from_str(obj.get(\"id\"))\n prompt = from_str(obj.get(\"prompt\"))\n started_at = from_datetime(obj.get(\"startedAt\"))\n status = TaskInfoStatus(obj.get(\"status\"))\n tool_call_id = from_str(obj.get(\"toolCallId\"))\n type = TaskAgentInfoType(obj.get(\"type\"))\n active_started_at = from_union([from_datetime, from_none], obj.get(\"activeStartedAt\"))\n active_time_ms = from_union([from_int, from_none], obj.get(\"activeTimeMs\"))\n can_promote_to_background = from_union([from_bool, from_none], obj.get(\"canPromoteToBackground\"))\n completed_at = from_union([from_datetime, from_none], obj.get(\"completedAt\"))\n error = from_union([from_str, from_none], obj.get(\"error\"))\n execution_mode = from_union([TaskInfoExecutionMode, from_none], obj.get(\"executionMode\"))\n idle_since = from_union([from_datetime, from_none], obj.get(\"idleSince\"))\n latest_response = from_union([from_str, from_none], obj.get(\"latestResponse\"))\n model = from_union([from_str, from_none], obj.get(\"model\"))\n result = from_union([from_str, from_none], obj.get(\"result\"))\n return TaskAgentInfo(agent_type, description, id, prompt, started_at, status, tool_call_id, type, active_started_at, active_time_ms, can_promote_to_background, completed_at, error, execution_mode, idle_since, latest_response, model, result)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"agentType\"] = from_str(self.agent_type)\n result[\"description\"] = from_str(self.description)\n result[\"id\"] = from_str(self.id)\n result[\"prompt\"] = from_str(self.prompt)\n result[\"startedAt\"] = self.started_at.isoformat()\n result[\"status\"] = to_enum(TaskInfoStatus, self.status)\n result[\"toolCallId\"] = from_str(self.tool_call_id)\n result[\"type\"] = to_enum(TaskAgentInfoType, self.type)\n if self.active_started_at is not None:\n result[\"activeStartedAt\"] = from_union([lambda x: x.isoformat(), from_none], self.active_started_at)\n if self.active_time_ms is not None:\n result[\"activeTimeMs\"] = from_union([from_int, from_none], self.active_time_ms)\n if self.can_promote_to_background is not None:\n result[\"canPromoteToBackground\"] = from_union([from_bool, from_none], self.can_promote_to_background)\n if self.completed_at is not None:\n result[\"completedAt\"] = from_union([lambda x: x.isoformat(), from_none], self.completed_at)\n if self.error is not None:\n result[\"error\"] = from_union([from_str, from_none], self.error)\n if self.execution_mode is not None:\n result[\"executionMode\"] = from_union([lambda x: to_enum(TaskInfoExecutionMode, x), from_none], self.execution_mode)\n if self.idle_since is not None:\n result[\"idleSince\"] = from_union([lambda x: x.isoformat(), from_none], self.idle_since)\n if self.latest_response is not None:\n result[\"latestResponse\"] = from_union([from_str, from_none], self.latest_response)\n if self.model is not None:\n result[\"model\"] = from_union([from_str, from_none], self.model)\n if self.result is not None:\n result[\"result\"] = from_union([from_str, from_none], self.result)\n return result\n\n@dataclass\nclass TaskInfo:\n description: str\n \"\"\"Short description of the task\"\"\"\n\n id: str\n \"\"\"Unique task identifier\"\"\"\n\n started_at: datetime\n \"\"\"ISO 8601 timestamp when the task was started\"\"\"\n\n status: TaskInfoStatus\n \"\"\"Current lifecycle status of the task\"\"\"\n\n type: TaskInfoType\n \"\"\"Task kind\"\"\"\n\n active_started_at: datetime | None = None\n \"\"\"ISO 8601 timestamp when the current active period began\"\"\"\n\n active_time_ms: int | None = None\n \"\"\"Accumulated active execution time in milliseconds\"\"\"\n\n agent_type: str | None = None\n \"\"\"Type of agent running this task\"\"\"\n\n can_promote_to_background: bool | None = None\n \"\"\"Whether the task is currently in the original sync wait and can be moved to background\n mode. False once it is already backgrounded, idle, finished, or no longer has a\n promotable sync waiter.\n\n Whether this shell task can be promoted to background mode\n \"\"\"\n completed_at: datetime | None = None\n \"\"\"ISO 8601 timestamp when the task finished\"\"\"\n\n error: str | None = None\n \"\"\"Error message when the task failed\"\"\"\n\n execution_mode: TaskInfoExecutionMode | None = None\n \"\"\"How the agent is currently being managed by the runtime\n\n Whether the shell command is currently sync-waited or background-managed\n \"\"\"\n idle_since: datetime | None = None\n \"\"\"ISO 8601 timestamp when the agent entered idle state\"\"\"\n\n latest_response: str | None = None\n \"\"\"Most recent response text from the agent\"\"\"\n\n model: str | None = None\n \"\"\"Model used for the task when specified\"\"\"\n\n prompt: str | None = None\n \"\"\"Prompt passed to the agent\"\"\"\n\n result: str | None = None\n \"\"\"Result text from the task when available\"\"\"\n\n tool_call_id: str | None = None\n \"\"\"Tool call ID associated with this agent task\"\"\"\n\n attachment_mode: TaskShellInfoAttachmentMode | None = None\n \"\"\"Whether the shell runs inside a managed PTY session or as an independent background\n process\n \"\"\"\n command: str | None = None\n \"\"\"Command being executed\"\"\"\n\n log_path: str | None = None\n \"\"\"Path to the detached shell log, when available\"\"\"\n\n pid: int | None = None\n \"\"\"Process ID when available\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'TaskInfo':\n assert isinstance(obj, dict)\n description = from_str(obj.get(\"description\"))\n id = from_str(obj.get(\"id\"))\n started_at = from_datetime(obj.get(\"startedAt\"))\n status = TaskInfoStatus(obj.get(\"status\"))\n type = TaskInfoType(obj.get(\"type\"))\n active_started_at = from_union([from_datetime, from_none], obj.get(\"activeStartedAt\"))\n active_time_ms = from_union([from_int, from_none], obj.get(\"activeTimeMs\"))\n agent_type = from_union([from_str, from_none], obj.get(\"agentType\"))\n can_promote_to_background = from_union([from_bool, from_none], obj.get(\"canPromoteToBackground\"))\n completed_at = from_union([from_datetime, from_none], obj.get(\"completedAt\"))\n error = from_union([from_str, from_none], obj.get(\"error\"))\n execution_mode = from_union([TaskInfoExecutionMode, from_none], obj.get(\"executionMode\"))\n idle_since = from_union([from_datetime, from_none], obj.get(\"idleSince\"))\n latest_response = from_union([from_str, from_none], obj.get(\"latestResponse\"))\n model = from_union([from_str, from_none], obj.get(\"model\"))\n prompt = from_union([from_str, from_none], obj.get(\"prompt\"))\n result = from_union([from_str, from_none], obj.get(\"result\"))\n tool_call_id = from_union([from_str, from_none], obj.get(\"toolCallId\"))\n attachment_mode = from_union([TaskShellInfoAttachmentMode, from_none], obj.get(\"attachmentMode\"))\n command = from_union([from_str, from_none], obj.get(\"command\"))\n log_path = from_union([from_str, from_none], obj.get(\"logPath\"))\n pid = from_union([from_int, from_none], obj.get(\"pid\"))\n return TaskInfo(description, id, started_at, status, type, active_started_at, active_time_ms, agent_type, can_promote_to_background, completed_at, error, execution_mode, idle_since, latest_response, model, prompt, result, tool_call_id, attachment_mode, command, log_path, pid)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"description\"] = from_str(self.description)\n result[\"id\"] = from_str(self.id)\n result[\"startedAt\"] = self.started_at.isoformat()\n result[\"status\"] = to_enum(TaskInfoStatus, self.status)\n result[\"type\"] = to_enum(TaskInfoType, self.type)\n if self.active_started_at is not None:\n result[\"activeStartedAt\"] = from_union([lambda x: x.isoformat(), from_none], self.active_started_at)\n if self.active_time_ms is not None:\n result[\"activeTimeMs\"] = from_union([from_int, from_none], self.active_time_ms)\n if self.agent_type is not None:\n result[\"agentType\"] = from_union([from_str, from_none], self.agent_type)\n if self.can_promote_to_background is not None:\n result[\"canPromoteToBackground\"] = from_union([from_bool, from_none], self.can_promote_to_background)\n if self.completed_at is not None:\n result[\"completedAt\"] = from_union([lambda x: x.isoformat(), from_none], self.completed_at)\n if self.error is not None:\n result[\"error\"] = from_union([from_str, from_none], self.error)\n if self.execution_mode is not None:\n result[\"executionMode\"] = from_union([lambda x: to_enum(TaskInfoExecutionMode, x), from_none], self.execution_mode)\n if self.idle_since is not None:\n result[\"idleSince\"] = from_union([lambda x: x.isoformat(), from_none], self.idle_since)\n if self.latest_response is not None:\n result[\"latestResponse\"] = from_union([from_str, from_none], self.latest_response)\n if self.model is not None:\n result[\"model\"] = from_union([from_str, from_none], self.model)\n if self.prompt is not None:\n result[\"prompt\"] = from_union([from_str, from_none], self.prompt)\n if self.result is not None:\n result[\"result\"] = from_union([from_str, from_none], self.result)\n if self.tool_call_id is not None:\n result[\"toolCallId\"] = from_union([from_str, from_none], self.tool_call_id)\n if self.attachment_mode is not None:\n result[\"attachmentMode\"] = from_union([lambda x: to_enum(TaskShellInfoAttachmentMode, x), from_none], self.attachment_mode)\n if self.command is not None:\n result[\"command\"] = from_union([from_str, from_none], self.command)\n if self.log_path is not None:\n result[\"logPath\"] = from_union([from_str, from_none], self.log_path)\n if self.pid is not None:\n result[\"pid\"] = from_union([from_int, from_none], self.pid)\n return result\n\n# Experimental: this type is part of an experimental API and may change or be removed.\n@dataclass\nclass TaskList:\n tasks: list[TaskInfo]\n \"\"\"Currently tracked tasks\"\"\"\n\n @staticmethod\n def from_dict(obj: Any) -> 'TaskList':\n assert isinstance(obj, dict)\n tasks = from_list(TaskInfo.from_dict, obj.get(\"tasks\"))\n return TaskList(tasks)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"tasks\"] = from_list(lambda x: to_class(TaskInfo, x), self.tasks)\n return result\n\n@dataclass\nclass RPC:\n account_get_quota_request: AccountGetQuotaRequest\n account_get_quota_result: AccountGetQuotaResult\n account_quota_snapshot: AccountQuotaSnapshot\n agent_get_current_result: AgentGetCurrentResult\n agent_info: AgentInfo\n agent_list: AgentList\n agent_reload_result: AgentReloadResult\n agent_select_request: AgentSelectRequest\n agent_select_result: AgentSelectResult\n auth_info_type: AuthInfoType\n commands_handle_pending_command_request: CommandsHandlePendingCommandRequest\n commands_handle_pending_command_result: CommandsHandlePendingCommandResult\n current_model: CurrentModel\n discovered_mcp_server: DiscoveredMCPServer\n discovered_mcp_server_source: MCPServerSource\n discovered_mcp_server_type: DiscoveredMCPServerType\n embedded_blob_resource_contents: EmbeddedBlobResourceContents\n embedded_text_resource_contents: EmbeddedTextResourceContents\n extension: Extension\n extension_list: ExtensionList\n extensions_disable_request: ExtensionsDisableRequest\n extensions_enable_request: ExtensionsEnableRequest\n extension_source: ExtensionSource\n extension_status: ExtensionStatus\n external_tool_result: ExternalToolTextResultForLlm | str\n external_tool_text_result_for_llm: ExternalToolTextResultForLlm\n external_tool_text_result_for_llm_content: ExternalToolTextResultForLlmContent\n external_tool_text_result_for_llm_content_audio: ExternalToolTextResultForLlmContentAudio\n external_tool_text_result_for_llm_content_image: ExternalToolTextResultForLlmContentImage\n external_tool_text_result_for_llm_content_resource: ExternalToolTextResultForLlmContentResource\n external_tool_text_result_for_llm_content_resource_details: ExternalToolTextResultForLlmContentResourceDetails\n external_tool_text_result_for_llm_content_resource_link: ExternalToolTextResultForLlmContentResourceLink\n external_tool_text_result_for_llm_content_resource_link_icon: ExternalToolTextResultForLlmContentResourceLinkIcon\n external_tool_text_result_for_llm_content_resource_link_icon_theme: ExternalToolTextResultForLlmContentResourceLinkIconTheme\n external_tool_text_result_for_llm_content_terminal: ExternalToolTextResultForLlmContentTerminal\n external_tool_text_result_for_llm_content_text: ExternalToolTextResultForLlmContentText\n filter_mapping: dict[str, FilterMappingString] | FilterMappingString\n filter_mapping_string: FilterMappingString\n filter_mapping_value: FilterMappingString\n fleet_start_request: FleetStartRequest\n fleet_start_result: FleetStartResult\n handle_pending_tool_call_request: HandlePendingToolCallRequest\n handle_pending_tool_call_result: HandlePendingToolCallResult\n history_compact_context_window: HistoryCompactContextWindow\n history_compact_result: HistoryCompactResult\n history_truncate_request: HistoryTruncateRequest\n history_truncate_result: HistoryTruncateResult\n instructions_get_sources_result: InstructionsGetSourcesResult\n instructions_sources: InstructionsSources\n instructions_sources_location: InstructionsSourcesLocation\n instructions_sources_type: InstructionsSourcesType\n log_request: LogRequest\n log_result: LogResult\n mcp_config_add_request: MCPConfigAddRequest\n mcp_config_disable_request: MCPConfigDisableRequest\n mcp_config_enable_request: MCPConfigEnableRequest\n mcp_config_list: MCPConfigList\n mcp_config_remove_request: MCPConfigRemoveRequest\n mcp_config_update_request: MCPConfigUpdateRequest\n mcp_disable_request: MCPDisableRequest\n mcp_discover_request: MCPDiscoverRequest\n mcp_discover_result: MCPDiscoverResult\n mcp_enable_request: MCPEnableRequest\n mcp_oauth_login_request: MCPOauthLoginRequest\n mcp_oauth_login_result: MCPOauthLoginResult\n mcp_server: MCPServer\n mcp_server_config: MCPServerConfig\n mcp_server_config_http: MCPServerConfigHTTP\n mcp_server_config_http_oauth_grant_type: MCPServerConfigHTTPOauthGrantType\n mcp_server_config_http_type: MCPServerConfigHTTPType\n mcp_server_config_local: MCPServerConfigLocal\n mcp_server_config_local_type: MCPServerConfigLocalType\n mcp_server_list: MCPServerList\n mcp_server_source: MCPServerSource\n mcp_server_status: MCPServerStatus\n model: Model\n model_billing: ModelBilling\n model_capabilities: ModelCapabilities\n model_capabilities_limits: ModelCapabilitiesLimits\n model_capabilities_limits_vision: ModelCapabilitiesLimitsVision\n model_capabilities_override: ModelCapabilitiesOverride\n model_capabilities_override_limits: ModelCapabilitiesOverrideLimits\n model_capabilities_override_limits_vision: ModelCapabilitiesOverrideLimitsVision\n model_capabilities_override_supports: ModelCapabilitiesOverrideSupports\n model_capabilities_supports: ModelCapabilitiesSupports\n model_list: ModelList\n model_policy: ModelPolicy\n models_list_request: ModelsListRequest\n model_switch_to_request: ModelSwitchToRequest\n model_switch_to_result: ModelSwitchToResult\n mode_set_request: ModeSetRequest\n name_get_result: NameGetResult\n name_set_request: NameSetRequest\n permission_decision: PermissionDecision\n permission_decision_approve_for_location: PermissionDecisionApproveForLocation\n permission_decision_approve_for_location_approval: PermissionDecisionApproveForLocationApproval\n permission_decision_approve_for_location_approval_commands: PermissionDecisionApproveForLocationApprovalCommands\n permission_decision_approve_for_location_approval_custom_tool: PermissionDecisionApproveForLocationApprovalCustomTool\n permission_decision_approve_for_location_approval_mcp: PermissionDecisionApproveForLocationApprovalMCP\n permission_decision_approve_for_location_approval_mcp_sampling: PermissionDecisionApproveForLocationApprovalMCPSampling\n permission_decision_approve_for_location_approval_memory: PermissionDecisionApproveForLocationApprovalMemory\n permission_decision_approve_for_location_approval_read: PermissionDecisionApproveForLocationApprovalRead\n permission_decision_approve_for_location_approval_write: PermissionDecisionApproveForLocationApprovalWrite\n permission_decision_approve_for_session: PermissionDecisionApproveForSession\n permission_decision_approve_for_session_approval: PermissionDecisionApproveForSessionApproval\n permission_decision_approve_for_session_approval_commands: PermissionDecisionApproveForSessionApprovalCommands\n permission_decision_approve_for_session_approval_custom_tool: PermissionDecisionApproveForSessionApprovalCustomTool\n permission_decision_approve_for_session_approval_mcp: PermissionDecisionApproveForSessionApprovalMCP\n permission_decision_approve_for_session_approval_mcp_sampling: PermissionDecisionApproveForSessionApprovalMCPSampling\n permission_decision_approve_for_session_approval_memory: PermissionDecisionApproveForSessionApprovalMemory\n permission_decision_approve_for_session_approval_read: PermissionDecisionApproveForSessionApprovalRead\n permission_decision_approve_for_session_approval_write: PermissionDecisionApproveForSessionApprovalWrite\n permission_decision_approve_once: PermissionDecisionApproveOnce\n permission_decision_approve_permanently: PermissionDecisionApprovePermanently\n permission_decision_reject: PermissionDecisionReject\n permission_decision_request: PermissionDecisionRequest\n permission_decision_user_not_available: PermissionDecisionUserNotAvailable\n permission_request_result: PermissionRequestResult\n permissions_reset_session_approvals_request: PermissionsResetSessionApprovalsRequest\n permissions_reset_session_approvals_result: PermissionsResetSessionApprovalsResult\n permissions_set_approve_all_request: PermissionsSetApproveAllRequest\n permissions_set_approve_all_result: PermissionsSetApproveAllResult\n ping_request: PingRequest\n ping_result: PingResult\n plan_read_result: PlanReadResult\n plan_update_request: PlanUpdateRequest\n plugin: Plugin\n plugin_list: PluginList\n server_skill: ServerSkill\n server_skill_list: ServerSkillList\n session_auth_status: SessionAuthStatus\n session_fs_append_file_request: SessionFSAppendFileRequest\n session_fs_error: SessionFSError\n session_fs_error_code: SessionFSErrorCode\n session_fs_exists_request: SessionFSExistsRequest\n session_fs_exists_result: SessionFSExistsResult\n session_fs_mkdir_request: SessionFSMkdirRequest\n session_fs_readdir_request: SessionFSReaddirRequest\n session_fs_readdir_result: SessionFSReaddirResult\n session_fs_readdir_with_types_entry: SessionFSReaddirWithTypesEntry\n session_fs_readdir_with_types_entry_type: SessionFSReaddirWithTypesEntryType\n session_fs_readdir_with_types_request: SessionFSReaddirWithTypesRequest\n session_fs_readdir_with_types_result: SessionFSReaddirWithTypesResult\n session_fs_read_file_request: SessionFSReadFileRequest\n session_fs_read_file_result: SessionFSReadFileResult\n session_fs_rename_request: SessionFSRenameRequest\n session_fs_rm_request: SessionFSRmRequest\n session_fs_set_provider_conventions: SessionFSSetProviderConventions\n session_fs_set_provider_request: SessionFSSetProviderRequest\n session_fs_set_provider_result: SessionFSSetProviderResult\n session_fs_stat_request: SessionFSStatRequest\n session_fs_stat_result: SessionFSStatResult\n session_fs_write_file_request: SessionFSWriteFileRequest\n session_log_level: SessionLogLevel\n session_mode: SessionMode\n sessions_fork_request: SessionsForkRequest\n sessions_fork_result: SessionsForkResult\n shell_exec_request: ShellExecRequest\n shell_exec_result: ShellExecResult\n shell_kill_request: ShellKillRequest\n shell_kill_result: ShellKillResult\n shell_kill_signal: ShellKillSignal\n skill: Skill\n skill_list: SkillList\n skills_config_set_disabled_skills_request: SkillsConfigSetDisabledSkillsRequest\n skills_disable_request: SkillsDisableRequest\n skills_discover_request: SkillsDiscoverRequest\n skills_enable_request: SkillsEnableRequest\n task_agent_info: TaskAgentInfo\n task_agent_info_execution_mode: TaskInfoExecutionMode\n task_agent_info_status: TaskInfoStatus\n task_info: TaskInfo\n task_list: TaskList\n tasks_cancel_request: TasksCancelRequest\n tasks_cancel_result: TasksCancelResult\n task_shell_info: TaskShellInfo\n task_shell_info_attachment_mode: TaskShellInfoAttachmentMode\n task_shell_info_execution_mode: TaskInfoExecutionMode\n task_shell_info_status: TaskInfoStatus\n tasks_promote_to_background_request: TasksPromoteToBackgroundRequest\n tasks_promote_to_background_result: TasksPromoteToBackgroundResult\n tasks_remove_request: TasksRemoveRequest\n tasks_remove_result: TasksRemoveResult\n tasks_start_agent_request: TasksStartAgentRequest\n tasks_start_agent_result: TasksStartAgentResult\n tool: Tool\n tool_list: ToolList\n tools_list_request: ToolsListRequest\n ui_elicitation_array_any_of_field: UIElicitationArrayAnyOfField\n ui_elicitation_array_any_of_field_items: UIElicitationArrayAnyOfFieldItems\n ui_elicitation_array_any_of_field_items_any_of: UIElicitationArrayAnyOfFieldItemsAnyOf\n ui_elicitation_array_enum_field: UIElicitationArrayEnumField\n ui_elicitation_array_enum_field_items: UIElicitationArrayEnumFieldItems\n ui_elicitation_field_value: float | bool | list[str] | str\n ui_elicitation_request: UIElicitationRequest\n ui_elicitation_response: UIElicitationResponse\n ui_elicitation_response_action: UIElicitationResponseAction\n ui_elicitation_response_content: dict[str, float | bool | list[str] | str]\n ui_elicitation_result: UIElicitationResult\n ui_elicitation_schema: UIElicitationSchema\n ui_elicitation_schema_property: UIElicitationSchemaProperty\n ui_elicitation_schema_property_boolean: UIElicitationSchemaPropertyBoolean\n ui_elicitation_schema_property_number: UIElicitationSchemaPropertyNumber\n ui_elicitation_schema_property_number_type: UIElicitationSchemaPropertyNumberType\n ui_elicitation_schema_property_string: UIElicitationSchemaPropertyString\n ui_elicitation_schema_property_string_format: UIElicitationSchemaPropertyStringFormat\n ui_elicitation_string_enum_field: UIElicitationStringEnumField\n ui_elicitation_string_one_of_field: UIElicitationStringOneOfField\n ui_elicitation_string_one_of_field_one_of: UIElicitationStringOneOfFieldOneOf\n ui_handle_pending_elicitation_request: UIHandlePendingElicitationRequest\n usage_get_metrics_result: UsageGetMetricsResult\n usage_metrics_code_changes: UsageMetricsCodeChanges\n usage_metrics_model_metric: UsageMetricsModelMetric\n usage_metrics_model_metric_requests: UsageMetricsModelMetricRequests\n usage_metrics_model_metric_token_detail: UsageMetricsModelMetricTokenDetail\n usage_metrics_model_metric_usage: UsageMetricsModelMetricUsage\n usage_metrics_token_detail: UsageMetricsTokenDetail\n workspaces_create_file_request: WorkspacesCreateFileRequest\n workspaces_get_workspace_result: WorkspacesGetWorkspaceResult\n workspaces_list_files_result: WorkspacesListFilesResult\n workspaces_read_file_request: WorkspacesReadFileRequest\n workspaces_read_file_result: WorkspacesReadFileResult\n\n @staticmethod\n def from_dict(obj: Any) -> 'RPC':\n assert isinstance(obj, dict)\n account_get_quota_request = AccountGetQuotaRequest.from_dict(obj.get(\"AccountGetQuotaRequest\"))\n account_get_quota_result = AccountGetQuotaResult.from_dict(obj.get(\"AccountGetQuotaResult\"))\n account_quota_snapshot = AccountQuotaSnapshot.from_dict(obj.get(\"AccountQuotaSnapshot\"))\n agent_get_current_result = AgentGetCurrentResult.from_dict(obj.get(\"AgentGetCurrentResult\"))\n agent_info = AgentInfo.from_dict(obj.get(\"AgentInfo\"))\n agent_list = AgentList.from_dict(obj.get(\"AgentList\"))\n agent_reload_result = AgentReloadResult.from_dict(obj.get(\"AgentReloadResult\"))\n agent_select_request = AgentSelectRequest.from_dict(obj.get(\"AgentSelectRequest\"))\n agent_select_result = AgentSelectResult.from_dict(obj.get(\"AgentSelectResult\"))\n auth_info_type = AuthInfoType(obj.get(\"AuthInfoType\"))\n commands_handle_pending_command_request = CommandsHandlePendingCommandRequest.from_dict(obj.get(\"CommandsHandlePendingCommandRequest\"))\n commands_handle_pending_command_result = CommandsHandlePendingCommandResult.from_dict(obj.get(\"CommandsHandlePendingCommandResult\"))\n current_model = CurrentModel.from_dict(obj.get(\"CurrentModel\"))\n discovered_mcp_server = DiscoveredMCPServer.from_dict(obj.get(\"DiscoveredMcpServer\"))\n discovered_mcp_server_source = MCPServerSource(obj.get(\"DiscoveredMcpServerSource\"))\n discovered_mcp_server_type = DiscoveredMCPServerType(obj.get(\"DiscoveredMcpServerType\"))\n embedded_blob_resource_contents = EmbeddedBlobResourceContents.from_dict(obj.get(\"EmbeddedBlobResourceContents\"))\n embedded_text_resource_contents = EmbeddedTextResourceContents.from_dict(obj.get(\"EmbeddedTextResourceContents\"))\n extension = Extension.from_dict(obj.get(\"Extension\"))\n extension_list = ExtensionList.from_dict(obj.get(\"ExtensionList\"))\n extensions_disable_request = ExtensionsDisableRequest.from_dict(obj.get(\"ExtensionsDisableRequest\"))\n extensions_enable_request = ExtensionsEnableRequest.from_dict(obj.get(\"ExtensionsEnableRequest\"))\n extension_source = ExtensionSource(obj.get(\"ExtensionSource\"))\n extension_status = ExtensionStatus(obj.get(\"ExtensionStatus\"))\n external_tool_result = from_union([ExternalToolTextResultForLlm.from_dict, from_str], obj.get(\"ExternalToolResult\"))\n external_tool_text_result_for_llm = ExternalToolTextResultForLlm.from_dict(obj.get(\"ExternalToolTextResultForLlm\"))\n external_tool_text_result_for_llm_content = ExternalToolTextResultForLlmContent.from_dict(obj.get(\"ExternalToolTextResultForLlmContent\"))\n external_tool_text_result_for_llm_content_audio = ExternalToolTextResultForLlmContentAudio.from_dict(obj.get(\"ExternalToolTextResultForLlmContentAudio\"))\n external_tool_text_result_for_llm_content_image = ExternalToolTextResultForLlmContentImage.from_dict(obj.get(\"ExternalToolTextResultForLlmContentImage\"))\n external_tool_text_result_for_llm_content_resource = ExternalToolTextResultForLlmContentResource.from_dict(obj.get(\"ExternalToolTextResultForLlmContentResource\"))\n external_tool_text_result_for_llm_content_resource_details = ExternalToolTextResultForLlmContentResourceDetails.from_dict(obj.get(\"ExternalToolTextResultForLlmContentResourceDetails\"))\n external_tool_text_result_for_llm_content_resource_link = ExternalToolTextResultForLlmContentResourceLink.from_dict(obj.get(\"ExternalToolTextResultForLlmContentResourceLink\"))\n external_tool_text_result_for_llm_content_resource_link_icon = ExternalToolTextResultForLlmContentResourceLinkIcon.from_dict(obj.get(\"ExternalToolTextResultForLlmContentResourceLinkIcon\"))\n external_tool_text_result_for_llm_content_resource_link_icon_theme = ExternalToolTextResultForLlmContentResourceLinkIconTheme(obj.get(\"ExternalToolTextResultForLlmContentResourceLinkIconTheme\"))\n external_tool_text_result_for_llm_content_terminal = ExternalToolTextResultForLlmContentTerminal.from_dict(obj.get(\"ExternalToolTextResultForLlmContentTerminal\"))\n external_tool_text_result_for_llm_content_text = ExternalToolTextResultForLlmContentText.from_dict(obj.get(\"ExternalToolTextResultForLlmContentText\"))\n filter_mapping = from_union([lambda x: from_dict(FilterMappingString, x), FilterMappingString], obj.get(\"FilterMapping\"))\n filter_mapping_string = FilterMappingString(obj.get(\"FilterMappingString\"))\n filter_mapping_value = FilterMappingString(obj.get(\"FilterMappingValue\"))\n fleet_start_request = FleetStartRequest.from_dict(obj.get(\"FleetStartRequest\"))\n fleet_start_result = FleetStartResult.from_dict(obj.get(\"FleetStartResult\"))\n handle_pending_tool_call_request = HandlePendingToolCallRequest.from_dict(obj.get(\"HandlePendingToolCallRequest\"))\n handle_pending_tool_call_result = HandlePendingToolCallResult.from_dict(obj.get(\"HandlePendingToolCallResult\"))\n history_compact_context_window = HistoryCompactContextWindow.from_dict(obj.get(\"HistoryCompactContextWindow\"))\n history_compact_result = HistoryCompactResult.from_dict(obj.get(\"HistoryCompactResult\"))\n history_truncate_request = HistoryTruncateRequest.from_dict(obj.get(\"HistoryTruncateRequest\"))\n history_truncate_result = HistoryTruncateResult.from_dict(obj.get(\"HistoryTruncateResult\"))\n instructions_get_sources_result = InstructionsGetSourcesResult.from_dict(obj.get(\"InstructionsGetSourcesResult\"))\n instructions_sources = InstructionsSources.from_dict(obj.get(\"InstructionsSources\"))\n instructions_sources_location = InstructionsSourcesLocation(obj.get(\"InstructionsSourcesLocation\"))\n instructions_sources_type = InstructionsSourcesType(obj.get(\"InstructionsSourcesType\"))\n log_request = LogRequest.from_dict(obj.get(\"LogRequest\"))\n log_result = LogResult.from_dict(obj.get(\"LogResult\"))\n mcp_config_add_request = MCPConfigAddRequest.from_dict(obj.get(\"McpConfigAddRequest\"))\n mcp_config_disable_request = MCPConfigDisableRequest.from_dict(obj.get(\"McpConfigDisableRequest\"))\n mcp_config_enable_request = MCPConfigEnableRequest.from_dict(obj.get(\"McpConfigEnableRequest\"))\n mcp_config_list = MCPConfigList.from_dict(obj.get(\"McpConfigList\"))\n mcp_config_remove_request = MCPConfigRemoveRequest.from_dict(obj.get(\"McpConfigRemoveRequest\"))\n mcp_config_update_request = MCPConfigUpdateRequest.from_dict(obj.get(\"McpConfigUpdateRequest\"))\n mcp_disable_request = MCPDisableRequest.from_dict(obj.get(\"McpDisableRequest\"))\n mcp_discover_request = MCPDiscoverRequest.from_dict(obj.get(\"McpDiscoverRequest\"))\n mcp_discover_result = MCPDiscoverResult.from_dict(obj.get(\"McpDiscoverResult\"))\n mcp_enable_request = MCPEnableRequest.from_dict(obj.get(\"McpEnableRequest\"))\n mcp_oauth_login_request = MCPOauthLoginRequest.from_dict(obj.get(\"McpOauthLoginRequest\"))\n mcp_oauth_login_result = MCPOauthLoginResult.from_dict(obj.get(\"McpOauthLoginResult\"))\n mcp_server = MCPServer.from_dict(obj.get(\"McpServer\"))\n mcp_server_config = MCPServerConfig.from_dict(obj.get(\"McpServerConfig\"))\n mcp_server_config_http = MCPServerConfigHTTP.from_dict(obj.get(\"McpServerConfigHttp\"))\n mcp_server_config_http_oauth_grant_type = MCPServerConfigHTTPOauthGrantType(obj.get(\"McpServerConfigHttpOauthGrantType\"))\n mcp_server_config_http_type = MCPServerConfigHTTPType(obj.get(\"McpServerConfigHttpType\"))\n mcp_server_config_local = MCPServerConfigLocal.from_dict(obj.get(\"McpServerConfigLocal\"))\n mcp_server_config_local_type = MCPServerConfigLocalType(obj.get(\"McpServerConfigLocalType\"))\n mcp_server_list = MCPServerList.from_dict(obj.get(\"McpServerList\"))\n mcp_server_source = MCPServerSource(obj.get(\"McpServerSource\"))\n mcp_server_status = MCPServerStatus(obj.get(\"McpServerStatus\"))\n model = Model.from_dict(obj.get(\"Model\"))\n model_billing = ModelBilling.from_dict(obj.get(\"ModelBilling\"))\n model_capabilities = ModelCapabilities.from_dict(obj.get(\"ModelCapabilities\"))\n model_capabilities_limits = ModelCapabilitiesLimits.from_dict(obj.get(\"ModelCapabilitiesLimits\"))\n model_capabilities_limits_vision = ModelCapabilitiesLimitsVision.from_dict(obj.get(\"ModelCapabilitiesLimitsVision\"))\n model_capabilities_override = ModelCapabilitiesOverride.from_dict(obj.get(\"ModelCapabilitiesOverride\"))\n model_capabilities_override_limits = ModelCapabilitiesOverrideLimits.from_dict(obj.get(\"ModelCapabilitiesOverrideLimits\"))\n model_capabilities_override_limits_vision = ModelCapabilitiesOverrideLimitsVision.from_dict(obj.get(\"ModelCapabilitiesOverrideLimitsVision\"))\n model_capabilities_override_supports = ModelCapabilitiesOverrideSupports.from_dict(obj.get(\"ModelCapabilitiesOverrideSupports\"))\n model_capabilities_supports = ModelCapabilitiesSupports.from_dict(obj.get(\"ModelCapabilitiesSupports\"))\n model_list = ModelList.from_dict(obj.get(\"ModelList\"))\n model_policy = ModelPolicy.from_dict(obj.get(\"ModelPolicy\"))\n models_list_request = ModelsListRequest.from_dict(obj.get(\"ModelsListRequest\"))\n model_switch_to_request = ModelSwitchToRequest.from_dict(obj.get(\"ModelSwitchToRequest\"))\n model_switch_to_result = ModelSwitchToResult.from_dict(obj.get(\"ModelSwitchToResult\"))\n mode_set_request = ModeSetRequest.from_dict(obj.get(\"ModeSetRequest\"))\n name_get_result = NameGetResult.from_dict(obj.get(\"NameGetResult\"))\n name_set_request = NameSetRequest.from_dict(obj.get(\"NameSetRequest\"))\n permission_decision = PermissionDecision.from_dict(obj.get(\"PermissionDecision\"))\n permission_decision_approve_for_location = PermissionDecisionApproveForLocation.from_dict(obj.get(\"PermissionDecisionApproveForLocation\"))\n permission_decision_approve_for_location_approval = PermissionDecisionApproveForLocationApproval.from_dict(obj.get(\"PermissionDecisionApproveForLocationApproval\"))\n permission_decision_approve_for_location_approval_commands = PermissionDecisionApproveForLocationApprovalCommands.from_dict(obj.get(\"PermissionDecisionApproveForLocationApprovalCommands\"))\n permission_decision_approve_for_location_approval_custom_tool = PermissionDecisionApproveForLocationApprovalCustomTool.from_dict(obj.get(\"PermissionDecisionApproveForLocationApprovalCustomTool\"))\n permission_decision_approve_for_location_approval_mcp = PermissionDecisionApproveForLocationApprovalMCP.from_dict(obj.get(\"PermissionDecisionApproveForLocationApprovalMcp\"))\n permission_decision_approve_for_location_approval_mcp_sampling = PermissionDecisionApproveForLocationApprovalMCPSampling.from_dict(obj.get(\"PermissionDecisionApproveForLocationApprovalMcpSampling\"))\n permission_decision_approve_for_location_approval_memory = PermissionDecisionApproveForLocationApprovalMemory.from_dict(obj.get(\"PermissionDecisionApproveForLocationApprovalMemory\"))\n permission_decision_approve_for_location_approval_read = PermissionDecisionApproveForLocationApprovalRead.from_dict(obj.get(\"PermissionDecisionApproveForLocationApprovalRead\"))\n permission_decision_approve_for_location_approval_write = PermissionDecisionApproveForLocationApprovalWrite.from_dict(obj.get(\"PermissionDecisionApproveForLocationApprovalWrite\"))\n permission_decision_approve_for_session = PermissionDecisionApproveForSession.from_dict(obj.get(\"PermissionDecisionApproveForSession\"))\n permission_decision_approve_for_session_approval = PermissionDecisionApproveForSessionApproval.from_dict(obj.get(\"PermissionDecisionApproveForSessionApproval\"))\n permission_decision_approve_for_session_approval_commands = PermissionDecisionApproveForSessionApprovalCommands.from_dict(obj.get(\"PermissionDecisionApproveForSessionApprovalCommands\"))\n permission_decision_approve_for_session_approval_custom_tool = PermissionDecisionApproveForSessionApprovalCustomTool.from_dict(obj.get(\"PermissionDecisionApproveForSessionApprovalCustomTool\"))\n permission_decision_approve_for_session_approval_mcp = PermissionDecisionApproveForSessionApprovalMCP.from_dict(obj.get(\"PermissionDecisionApproveForSessionApprovalMcp\"))\n permission_decision_approve_for_session_approval_mcp_sampling = PermissionDecisionApproveForSessionApprovalMCPSampling.from_dict(obj.get(\"PermissionDecisionApproveForSessionApprovalMcpSampling\"))\n permission_decision_approve_for_session_approval_memory = PermissionDecisionApproveForSessionApprovalMemory.from_dict(obj.get(\"PermissionDecisionApproveForSessionApprovalMemory\"))\n permission_decision_approve_for_session_approval_read = PermissionDecisionApproveForSessionApprovalRead.from_dict(obj.get(\"PermissionDecisionApproveForSessionApprovalRead\"))\n permission_decision_approve_for_session_approval_write = PermissionDecisionApproveForSessionApprovalWrite.from_dict(obj.get(\"PermissionDecisionApproveForSessionApprovalWrite\"))\n permission_decision_approve_once = PermissionDecisionApproveOnce.from_dict(obj.get(\"PermissionDecisionApproveOnce\"))\n permission_decision_approve_permanently = PermissionDecisionApprovePermanently.from_dict(obj.get(\"PermissionDecisionApprovePermanently\"))\n permission_decision_reject = PermissionDecisionReject.from_dict(obj.get(\"PermissionDecisionReject\"))\n permission_decision_request = PermissionDecisionRequest.from_dict(obj.get(\"PermissionDecisionRequest\"))\n permission_decision_user_not_available = PermissionDecisionUserNotAvailable.from_dict(obj.get(\"PermissionDecisionUserNotAvailable\"))\n permission_request_result = PermissionRequestResult.from_dict(obj.get(\"PermissionRequestResult\"))\n permissions_reset_session_approvals_request = PermissionsResetSessionApprovalsRequest.from_dict(obj.get(\"PermissionsResetSessionApprovalsRequest\"))\n permissions_reset_session_approvals_result = PermissionsResetSessionApprovalsResult.from_dict(obj.get(\"PermissionsResetSessionApprovalsResult\"))\n permissions_set_approve_all_request = PermissionsSetApproveAllRequest.from_dict(obj.get(\"PermissionsSetApproveAllRequest\"))\n permissions_set_approve_all_result = PermissionsSetApproveAllResult.from_dict(obj.get(\"PermissionsSetApproveAllResult\"))\n ping_request = PingRequest.from_dict(obj.get(\"PingRequest\"))\n ping_result = PingResult.from_dict(obj.get(\"PingResult\"))\n plan_read_result = PlanReadResult.from_dict(obj.get(\"PlanReadResult\"))\n plan_update_request = PlanUpdateRequest.from_dict(obj.get(\"PlanUpdateRequest\"))\n plugin = Plugin.from_dict(obj.get(\"Plugin\"))\n plugin_list = PluginList.from_dict(obj.get(\"PluginList\"))\n server_skill = ServerSkill.from_dict(obj.get(\"ServerSkill\"))\n server_skill_list = ServerSkillList.from_dict(obj.get(\"ServerSkillList\"))\n session_auth_status = SessionAuthStatus.from_dict(obj.get(\"SessionAuthStatus\"))\n session_fs_append_file_request = SessionFSAppendFileRequest.from_dict(obj.get(\"SessionFsAppendFileRequest\"))\n session_fs_error = SessionFSError.from_dict(obj.get(\"SessionFsError\"))\n session_fs_error_code = SessionFSErrorCode(obj.get(\"SessionFsErrorCode\"))\n session_fs_exists_request = SessionFSExistsRequest.from_dict(obj.get(\"SessionFsExistsRequest\"))\n session_fs_exists_result = SessionFSExistsResult.from_dict(obj.get(\"SessionFsExistsResult\"))\n session_fs_mkdir_request = SessionFSMkdirRequest.from_dict(obj.get(\"SessionFsMkdirRequest\"))\n session_fs_readdir_request = SessionFSReaddirRequest.from_dict(obj.get(\"SessionFsReaddirRequest\"))\n session_fs_readdir_result = SessionFSReaddirResult.from_dict(obj.get(\"SessionFsReaddirResult\"))\n session_fs_readdir_with_types_entry = SessionFSReaddirWithTypesEntry.from_dict(obj.get(\"SessionFsReaddirWithTypesEntry\"))\n session_fs_readdir_with_types_entry_type = SessionFSReaddirWithTypesEntryType(obj.get(\"SessionFsReaddirWithTypesEntryType\"))\n session_fs_readdir_with_types_request = SessionFSReaddirWithTypesRequest.from_dict(obj.get(\"SessionFsReaddirWithTypesRequest\"))\n session_fs_readdir_with_types_result = SessionFSReaddirWithTypesResult.from_dict(obj.get(\"SessionFsReaddirWithTypesResult\"))\n session_fs_read_file_request = SessionFSReadFileRequest.from_dict(obj.get(\"SessionFsReadFileRequest\"))\n session_fs_read_file_result = SessionFSReadFileResult.from_dict(obj.get(\"SessionFsReadFileResult\"))\n session_fs_rename_request = SessionFSRenameRequest.from_dict(obj.get(\"SessionFsRenameRequest\"))\n session_fs_rm_request = SessionFSRmRequest.from_dict(obj.get(\"SessionFsRmRequest\"))\n session_fs_set_provider_conventions = SessionFSSetProviderConventions(obj.get(\"SessionFsSetProviderConventions\"))\n session_fs_set_provider_request = SessionFSSetProviderRequest.from_dict(obj.get(\"SessionFsSetProviderRequest\"))\n session_fs_set_provider_result = SessionFSSetProviderResult.from_dict(obj.get(\"SessionFsSetProviderResult\"))\n session_fs_stat_request = SessionFSStatRequest.from_dict(obj.get(\"SessionFsStatRequest\"))\n session_fs_stat_result = SessionFSStatResult.from_dict(obj.get(\"SessionFsStatResult\"))\n session_fs_write_file_request = SessionFSWriteFileRequest.from_dict(obj.get(\"SessionFsWriteFileRequest\"))\n session_log_level = SessionLogLevel(obj.get(\"SessionLogLevel\"))\n session_mode = SessionMode(obj.get(\"SessionMode\"))\n sessions_fork_request = SessionsForkRequest.from_dict(obj.get(\"SessionsForkRequest\"))\n sessions_fork_result = SessionsForkResult.from_dict(obj.get(\"SessionsForkResult\"))\n shell_exec_request = ShellExecRequest.from_dict(obj.get(\"ShellExecRequest\"))\n shell_exec_result = ShellExecResult.from_dict(obj.get(\"ShellExecResult\"))\n shell_kill_request = ShellKillRequest.from_dict(obj.get(\"ShellKillRequest\"))\n shell_kill_result = ShellKillResult.from_dict(obj.get(\"ShellKillResult\"))\n shell_kill_signal = ShellKillSignal(obj.get(\"ShellKillSignal\"))\n skill = Skill.from_dict(obj.get(\"Skill\"))\n skill_list = SkillList.from_dict(obj.get(\"SkillList\"))\n skills_config_set_disabled_skills_request = SkillsConfigSetDisabledSkillsRequest.from_dict(obj.get(\"SkillsConfigSetDisabledSkillsRequest\"))\n skills_disable_request = SkillsDisableRequest.from_dict(obj.get(\"SkillsDisableRequest\"))\n skills_discover_request = SkillsDiscoverRequest.from_dict(obj.get(\"SkillsDiscoverRequest\"))\n skills_enable_request = SkillsEnableRequest.from_dict(obj.get(\"SkillsEnableRequest\"))\n task_agent_info = TaskAgentInfo.from_dict(obj.get(\"TaskAgentInfo\"))\n task_agent_info_execution_mode = TaskInfoExecutionMode(obj.get(\"TaskAgentInfoExecutionMode\"))\n task_agent_info_status = TaskInfoStatus(obj.get(\"TaskAgentInfoStatus\"))\n task_info = TaskInfo.from_dict(obj.get(\"TaskInfo\"))\n task_list = TaskList.from_dict(obj.get(\"TaskList\"))\n tasks_cancel_request = TasksCancelRequest.from_dict(obj.get(\"TasksCancelRequest\"))\n tasks_cancel_result = TasksCancelResult.from_dict(obj.get(\"TasksCancelResult\"))\n task_shell_info = TaskShellInfo.from_dict(obj.get(\"TaskShellInfo\"))\n task_shell_info_attachment_mode = TaskShellInfoAttachmentMode(obj.get(\"TaskShellInfoAttachmentMode\"))\n task_shell_info_execution_mode = TaskInfoExecutionMode(obj.get(\"TaskShellInfoExecutionMode\"))\n task_shell_info_status = TaskInfoStatus(obj.get(\"TaskShellInfoStatus\"))\n tasks_promote_to_background_request = TasksPromoteToBackgroundRequest.from_dict(obj.get(\"TasksPromoteToBackgroundRequest\"))\n tasks_promote_to_background_result = TasksPromoteToBackgroundResult.from_dict(obj.get(\"TasksPromoteToBackgroundResult\"))\n tasks_remove_request = TasksRemoveRequest.from_dict(obj.get(\"TasksRemoveRequest\"))\n tasks_remove_result = TasksRemoveResult.from_dict(obj.get(\"TasksRemoveResult\"))\n tasks_start_agent_request = TasksStartAgentRequest.from_dict(obj.get(\"TasksStartAgentRequest\"))\n tasks_start_agent_result = TasksStartAgentResult.from_dict(obj.get(\"TasksStartAgentResult\"))\n tool = Tool.from_dict(obj.get(\"Tool\"))\n tool_list = ToolList.from_dict(obj.get(\"ToolList\"))\n tools_list_request = ToolsListRequest.from_dict(obj.get(\"ToolsListRequest\"))\n ui_elicitation_array_any_of_field = UIElicitationArrayAnyOfField.from_dict(obj.get(\"UIElicitationArrayAnyOfField\"))\n ui_elicitation_array_any_of_field_items = UIElicitationArrayAnyOfFieldItems.from_dict(obj.get(\"UIElicitationArrayAnyOfFieldItems\"))\n ui_elicitation_array_any_of_field_items_any_of = UIElicitationArrayAnyOfFieldItemsAnyOf.from_dict(obj.get(\"UIElicitationArrayAnyOfFieldItemsAnyOf\"))\n ui_elicitation_array_enum_field = UIElicitationArrayEnumField.from_dict(obj.get(\"UIElicitationArrayEnumField\"))\n ui_elicitation_array_enum_field_items = UIElicitationArrayEnumFieldItems.from_dict(obj.get(\"UIElicitationArrayEnumFieldItems\"))\n ui_elicitation_field_value = from_union([from_float, from_bool, lambda x: from_list(from_str, x), from_str], obj.get(\"UIElicitationFieldValue\"))\n ui_elicitation_request = UIElicitationRequest.from_dict(obj.get(\"UIElicitationRequest\"))\n ui_elicitation_response = UIElicitationResponse.from_dict(obj.get(\"UIElicitationResponse\"))\n ui_elicitation_response_action = UIElicitationResponseAction(obj.get(\"UIElicitationResponseAction\"))\n ui_elicitation_response_content = from_dict(lambda x: from_union([from_float, from_bool, lambda x: from_list(from_str, x), from_str], x), obj.get(\"UIElicitationResponseContent\"))\n ui_elicitation_result = UIElicitationResult.from_dict(obj.get(\"UIElicitationResult\"))\n ui_elicitation_schema = UIElicitationSchema.from_dict(obj.get(\"UIElicitationSchema\"))\n ui_elicitation_schema_property = UIElicitationSchemaProperty.from_dict(obj.get(\"UIElicitationSchemaProperty\"))\n ui_elicitation_schema_property_boolean = UIElicitationSchemaPropertyBoolean.from_dict(obj.get(\"UIElicitationSchemaPropertyBoolean\"))\n ui_elicitation_schema_property_number = UIElicitationSchemaPropertyNumber.from_dict(obj.get(\"UIElicitationSchemaPropertyNumber\"))\n ui_elicitation_schema_property_number_type = UIElicitationSchemaPropertyNumberType(obj.get(\"UIElicitationSchemaPropertyNumberType\"))\n ui_elicitation_schema_property_string = UIElicitationSchemaPropertyString.from_dict(obj.get(\"UIElicitationSchemaPropertyString\"))\n ui_elicitation_schema_property_string_format = UIElicitationSchemaPropertyStringFormat(obj.get(\"UIElicitationSchemaPropertyStringFormat\"))\n ui_elicitation_string_enum_field = UIElicitationStringEnumField.from_dict(obj.get(\"UIElicitationStringEnumField\"))\n ui_elicitation_string_one_of_field = UIElicitationStringOneOfField.from_dict(obj.get(\"UIElicitationStringOneOfField\"))\n ui_elicitation_string_one_of_field_one_of = UIElicitationStringOneOfFieldOneOf.from_dict(obj.get(\"UIElicitationStringOneOfFieldOneOf\"))\n ui_handle_pending_elicitation_request = UIHandlePendingElicitationRequest.from_dict(obj.get(\"UIHandlePendingElicitationRequest\"))\n usage_get_metrics_result = UsageGetMetricsResult.from_dict(obj.get(\"UsageGetMetricsResult\"))\n usage_metrics_code_changes = UsageMetricsCodeChanges.from_dict(obj.get(\"UsageMetricsCodeChanges\"))\n usage_metrics_model_metric = UsageMetricsModelMetric.from_dict(obj.get(\"UsageMetricsModelMetric\"))\n usage_metrics_model_metric_requests = UsageMetricsModelMetricRequests.from_dict(obj.get(\"UsageMetricsModelMetricRequests\"))\n usage_metrics_model_metric_token_detail = UsageMetricsModelMetricTokenDetail.from_dict(obj.get(\"UsageMetricsModelMetricTokenDetail\"))\n usage_metrics_model_metric_usage = UsageMetricsModelMetricUsage.from_dict(obj.get(\"UsageMetricsModelMetricUsage\"))\n usage_metrics_token_detail = UsageMetricsTokenDetail.from_dict(obj.get(\"UsageMetricsTokenDetail\"))\n workspaces_create_file_request = WorkspacesCreateFileRequest.from_dict(obj.get(\"WorkspacesCreateFileRequest\"))\n workspaces_get_workspace_result = WorkspacesGetWorkspaceResult.from_dict(obj.get(\"WorkspacesGetWorkspaceResult\"))\n workspaces_list_files_result = WorkspacesListFilesResult.from_dict(obj.get(\"WorkspacesListFilesResult\"))\n workspaces_read_file_request = WorkspacesReadFileRequest.from_dict(obj.get(\"WorkspacesReadFileRequest\"))\n workspaces_read_file_result = WorkspacesReadFileResult.from_dict(obj.get(\"WorkspacesReadFileResult\"))\n return RPC(account_get_quota_request, account_get_quota_result, account_quota_snapshot, agent_get_current_result, agent_info, agent_list, agent_reload_result, agent_select_request, agent_select_result, auth_info_type, commands_handle_pending_command_request, commands_handle_pending_command_result, current_model, discovered_mcp_server, discovered_mcp_server_source, discovered_mcp_server_type, embedded_blob_resource_contents, embedded_text_resource_contents, extension, extension_list, extensions_disable_request, extensions_enable_request, extension_source, extension_status, external_tool_result, external_tool_text_result_for_llm, external_tool_text_result_for_llm_content, external_tool_text_result_for_llm_content_audio, external_tool_text_result_for_llm_content_image, external_tool_text_result_for_llm_content_resource, external_tool_text_result_for_llm_content_resource_details, external_tool_text_result_for_llm_content_resource_link, external_tool_text_result_for_llm_content_resource_link_icon, external_tool_text_result_for_llm_content_resource_link_icon_theme, external_tool_text_result_for_llm_content_terminal, external_tool_text_result_for_llm_content_text, filter_mapping, filter_mapping_string, filter_mapping_value, fleet_start_request, fleet_start_result, handle_pending_tool_call_request, handle_pending_tool_call_result, history_compact_context_window, history_compact_result, history_truncate_request, history_truncate_result, instructions_get_sources_result, instructions_sources, instructions_sources_location, instructions_sources_type, log_request, log_result, mcp_config_add_request, mcp_config_disable_request, mcp_config_enable_request, mcp_config_list, mcp_config_remove_request, mcp_config_update_request, mcp_disable_request, mcp_discover_request, mcp_discover_result, mcp_enable_request, mcp_oauth_login_request, mcp_oauth_login_result, mcp_server, mcp_server_config, mcp_server_config_http, mcp_server_config_http_oauth_grant_type, mcp_server_config_http_type, mcp_server_config_local, mcp_server_config_local_type, mcp_server_list, mcp_server_source, mcp_server_status, model, model_billing, model_capabilities, model_capabilities_limits, model_capabilities_limits_vision, model_capabilities_override, model_capabilities_override_limits, model_capabilities_override_limits_vision, model_capabilities_override_supports, model_capabilities_supports, model_list, model_policy, models_list_request, model_switch_to_request, model_switch_to_result, mode_set_request, name_get_result, name_set_request, permission_decision, permission_decision_approve_for_location, permission_decision_approve_for_location_approval, permission_decision_approve_for_location_approval_commands, permission_decision_approve_for_location_approval_custom_tool, permission_decision_approve_for_location_approval_mcp, permission_decision_approve_for_location_approval_mcp_sampling, permission_decision_approve_for_location_approval_memory, permission_decision_approve_for_location_approval_read, permission_decision_approve_for_location_approval_write, permission_decision_approve_for_session, permission_decision_approve_for_session_approval, permission_decision_approve_for_session_approval_commands, permission_decision_approve_for_session_approval_custom_tool, permission_decision_approve_for_session_approval_mcp, permission_decision_approve_for_session_approval_mcp_sampling, permission_decision_approve_for_session_approval_memory, permission_decision_approve_for_session_approval_read, permission_decision_approve_for_session_approval_write, permission_decision_approve_once, permission_decision_approve_permanently, permission_decision_reject, permission_decision_request, permission_decision_user_not_available, permission_request_result, permissions_reset_session_approvals_request, permissions_reset_session_approvals_result, permissions_set_approve_all_request, permissions_set_approve_all_result, ping_request, ping_result, plan_read_result, plan_update_request, plugin, plugin_list, server_skill, server_skill_list, session_auth_status, session_fs_append_file_request, session_fs_error, session_fs_error_code, session_fs_exists_request, session_fs_exists_result, session_fs_mkdir_request, session_fs_readdir_request, session_fs_readdir_result, session_fs_readdir_with_types_entry, session_fs_readdir_with_types_entry_type, session_fs_readdir_with_types_request, session_fs_readdir_with_types_result, session_fs_read_file_request, session_fs_read_file_result, session_fs_rename_request, session_fs_rm_request, session_fs_set_provider_conventions, session_fs_set_provider_request, session_fs_set_provider_result, session_fs_stat_request, session_fs_stat_result, session_fs_write_file_request, session_log_level, session_mode, sessions_fork_request, sessions_fork_result, shell_exec_request, shell_exec_result, shell_kill_request, shell_kill_result, shell_kill_signal, skill, skill_list, skills_config_set_disabled_skills_request, skills_disable_request, skills_discover_request, skills_enable_request, task_agent_info, task_agent_info_execution_mode, task_agent_info_status, task_info, task_list, tasks_cancel_request, tasks_cancel_result, task_shell_info, task_shell_info_attachment_mode, task_shell_info_execution_mode, task_shell_info_status, tasks_promote_to_background_request, tasks_promote_to_background_result, tasks_remove_request, tasks_remove_result, tasks_start_agent_request, tasks_start_agent_result, tool, tool_list, tools_list_request, ui_elicitation_array_any_of_field, ui_elicitation_array_any_of_field_items, ui_elicitation_array_any_of_field_items_any_of, ui_elicitation_array_enum_field, ui_elicitation_array_enum_field_items, ui_elicitation_field_value, ui_elicitation_request, ui_elicitation_response, ui_elicitation_response_action, ui_elicitation_response_content, ui_elicitation_result, ui_elicitation_schema, ui_elicitation_schema_property, ui_elicitation_schema_property_boolean, ui_elicitation_schema_property_number, ui_elicitation_schema_property_number_type, ui_elicitation_schema_property_string, ui_elicitation_schema_property_string_format, ui_elicitation_string_enum_field, ui_elicitation_string_one_of_field, ui_elicitation_string_one_of_field_one_of, ui_handle_pending_elicitation_request, usage_get_metrics_result, usage_metrics_code_changes, usage_metrics_model_metric, usage_metrics_model_metric_requests, usage_metrics_model_metric_token_detail, usage_metrics_model_metric_usage, usage_metrics_token_detail, workspaces_create_file_request, workspaces_get_workspace_result, workspaces_list_files_result, workspaces_read_file_request, workspaces_read_file_result)\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"AccountGetQuotaRequest\"] = to_class(AccountGetQuotaRequest, self.account_get_quota_request)\n result[\"AccountGetQuotaResult\"] = to_class(AccountGetQuotaResult, self.account_get_quota_result)\n result[\"AccountQuotaSnapshot\"] = to_class(AccountQuotaSnapshot, self.account_quota_snapshot)\n result[\"AgentGetCurrentResult\"] = to_class(AgentGetCurrentResult, self.agent_get_current_result)\n result[\"AgentInfo\"] = to_class(AgentInfo, self.agent_info)\n result[\"AgentList\"] = to_class(AgentList, self.agent_list)\n result[\"AgentReloadResult\"] = to_class(AgentReloadResult, self.agent_reload_result)\n result[\"AgentSelectRequest\"] = to_class(AgentSelectRequest, self.agent_select_request)\n result[\"AgentSelectResult\"] = to_class(AgentSelectResult, self.agent_select_result)\n result[\"AuthInfoType\"] = to_enum(AuthInfoType, self.auth_info_type)\n result[\"CommandsHandlePendingCommandRequest\"] = to_class(CommandsHandlePendingCommandRequest, self.commands_handle_pending_command_request)\n result[\"CommandsHandlePendingCommandResult\"] = to_class(CommandsHandlePendingCommandResult, self.commands_handle_pending_command_result)\n result[\"CurrentModel\"] = to_class(CurrentModel, self.current_model)\n result[\"DiscoveredMcpServer\"] = to_class(DiscoveredMCPServer, self.discovered_mcp_server)\n result[\"DiscoveredMcpServerSource\"] = to_enum(MCPServerSource, self.discovered_mcp_server_source)\n result[\"DiscoveredMcpServerType\"] = to_enum(DiscoveredMCPServerType, self.discovered_mcp_server_type)\n result[\"EmbeddedBlobResourceContents\"] = to_class(EmbeddedBlobResourceContents, self.embedded_blob_resource_contents)\n result[\"EmbeddedTextResourceContents\"] = to_class(EmbeddedTextResourceContents, self.embedded_text_resource_contents)\n result[\"Extension\"] = to_class(Extension, self.extension)\n result[\"ExtensionList\"] = to_class(ExtensionList, self.extension_list)\n result[\"ExtensionsDisableRequest\"] = to_class(ExtensionsDisableRequest, self.extensions_disable_request)\n result[\"ExtensionsEnableRequest\"] = to_class(ExtensionsEnableRequest, self.extensions_enable_request)\n result[\"ExtensionSource\"] = to_enum(ExtensionSource, self.extension_source)\n result[\"ExtensionStatus\"] = to_enum(ExtensionStatus, self.extension_status)\n result[\"ExternalToolResult\"] = from_union([lambda x: to_class(ExternalToolTextResultForLlm, x), from_str], self.external_tool_result)\n result[\"ExternalToolTextResultForLlm\"] = to_class(ExternalToolTextResultForLlm, self.external_tool_text_result_for_llm)\n result[\"ExternalToolTextResultForLlmContent\"] = to_class(ExternalToolTextResultForLlmContent, self.external_tool_text_result_for_llm_content)\n result[\"ExternalToolTextResultForLlmContentAudio\"] = to_class(ExternalToolTextResultForLlmContentAudio, self.external_tool_text_result_for_llm_content_audio)\n result[\"ExternalToolTextResultForLlmContentImage\"] = to_class(ExternalToolTextResultForLlmContentImage, self.external_tool_text_result_for_llm_content_image)\n result[\"ExternalToolTextResultForLlmContentResource\"] = to_class(ExternalToolTextResultForLlmContentResource, self.external_tool_text_result_for_llm_content_resource)\n result[\"ExternalToolTextResultForLlmContentResourceDetails\"] = to_class(ExternalToolTextResultForLlmContentResourceDetails, self.external_tool_text_result_for_llm_content_resource_details)\n result[\"ExternalToolTextResultForLlmContentResourceLink\"] = to_class(ExternalToolTextResultForLlmContentResourceLink, self.external_tool_text_result_for_llm_content_resource_link)\n result[\"ExternalToolTextResultForLlmContentResourceLinkIcon\"] = to_class(ExternalToolTextResultForLlmContentResourceLinkIcon, self.external_tool_text_result_for_llm_content_resource_link_icon)\n result[\"ExternalToolTextResultForLlmContentResourceLinkIconTheme\"] = to_enum(ExternalToolTextResultForLlmContentResourceLinkIconTheme, self.external_tool_text_result_for_llm_content_resource_link_icon_theme)\n result[\"ExternalToolTextResultForLlmContentTerminal\"] = to_class(ExternalToolTextResultForLlmContentTerminal, self.external_tool_text_result_for_llm_content_terminal)\n result[\"ExternalToolTextResultForLlmContentText\"] = to_class(ExternalToolTextResultForLlmContentText, self.external_tool_text_result_for_llm_content_text)\n result[\"FilterMapping\"] = from_union([lambda x: from_dict(lambda x: to_enum(FilterMappingString, x), x), lambda x: to_enum(FilterMappingString, x)], self.filter_mapping)\n result[\"FilterMappingString\"] = to_enum(FilterMappingString, self.filter_mapping_string)\n result[\"FilterMappingValue\"] = to_enum(FilterMappingString, self.filter_mapping_value)\n result[\"FleetStartRequest\"] = to_class(FleetStartRequest, self.fleet_start_request)\n result[\"FleetStartResult\"] = to_class(FleetStartResult, self.fleet_start_result)\n result[\"HandlePendingToolCallRequest\"] = to_class(HandlePendingToolCallRequest, self.handle_pending_tool_call_request)\n result[\"HandlePendingToolCallResult\"] = to_class(HandlePendingToolCallResult, self.handle_pending_tool_call_result)\n result[\"HistoryCompactContextWindow\"] = to_class(HistoryCompactContextWindow, self.history_compact_context_window)\n result[\"HistoryCompactResult\"] = to_class(HistoryCompactResult, self.history_compact_result)\n result[\"HistoryTruncateRequest\"] = to_class(HistoryTruncateRequest, self.history_truncate_request)\n result[\"HistoryTruncateResult\"] = to_class(HistoryTruncateResult, self.history_truncate_result)\n result[\"InstructionsGetSourcesResult\"] = to_class(InstructionsGetSourcesResult, self.instructions_get_sources_result)\n result[\"InstructionsSources\"] = to_class(InstructionsSources, self.instructions_sources)\n result[\"InstructionsSourcesLocation\"] = to_enum(InstructionsSourcesLocation, self.instructions_sources_location)\n result[\"InstructionsSourcesType\"] = to_enum(InstructionsSourcesType, self.instructions_sources_type)\n result[\"LogRequest\"] = to_class(LogRequest, self.log_request)\n result[\"LogResult\"] = to_class(LogResult, self.log_result)\n result[\"McpConfigAddRequest\"] = to_class(MCPConfigAddRequest, self.mcp_config_add_request)\n result[\"McpConfigDisableRequest\"] = to_class(MCPConfigDisableRequest, self.mcp_config_disable_request)\n result[\"McpConfigEnableRequest\"] = to_class(MCPConfigEnableRequest, self.mcp_config_enable_request)\n result[\"McpConfigList\"] = to_class(MCPConfigList, self.mcp_config_list)\n result[\"McpConfigRemoveRequest\"] = to_class(MCPConfigRemoveRequest, self.mcp_config_remove_request)\n result[\"McpConfigUpdateRequest\"] = to_class(MCPConfigUpdateRequest, self.mcp_config_update_request)\n result[\"McpDisableRequest\"] = to_class(MCPDisableRequest, self.mcp_disable_request)\n result[\"McpDiscoverRequest\"] = to_class(MCPDiscoverRequest, self.mcp_discover_request)\n result[\"McpDiscoverResult\"] = to_class(MCPDiscoverResult, self.mcp_discover_result)\n result[\"McpEnableRequest\"] = to_class(MCPEnableRequest, self.mcp_enable_request)\n result[\"McpOauthLoginRequest\"] = to_class(MCPOauthLoginRequest, self.mcp_oauth_login_request)\n result[\"McpOauthLoginResult\"] = to_class(MCPOauthLoginResult, self.mcp_oauth_login_result)\n result[\"McpServer\"] = to_class(MCPServer, self.mcp_server)\n result[\"McpServerConfig\"] = to_class(MCPServerConfig, self.mcp_server_config)\n result[\"McpServerConfigHttp\"] = to_class(MCPServerConfigHTTP, self.mcp_server_config_http)\n result[\"McpServerConfigHttpOauthGrantType\"] = to_enum(MCPServerConfigHTTPOauthGrantType, self.mcp_server_config_http_oauth_grant_type)\n result[\"McpServerConfigHttpType\"] = to_enum(MCPServerConfigHTTPType, self.mcp_server_config_http_type)\n result[\"McpServerConfigLocal\"] = to_class(MCPServerConfigLocal, self.mcp_server_config_local)\n result[\"McpServerConfigLocalType\"] = to_enum(MCPServerConfigLocalType, self.mcp_server_config_local_type)\n result[\"McpServerList\"] = to_class(MCPServerList, self.mcp_server_list)\n result[\"McpServerSource\"] = to_enum(MCPServerSource, self.mcp_server_source)\n result[\"McpServerStatus\"] = to_enum(MCPServerStatus, self.mcp_server_status)\n result[\"Model\"] = to_class(Model, self.model)\n result[\"ModelBilling\"] = to_class(ModelBilling, self.model_billing)\n result[\"ModelCapabilities\"] = to_class(ModelCapabilities, self.model_capabilities)\n result[\"ModelCapabilitiesLimits\"] = to_class(ModelCapabilitiesLimits, self.model_capabilities_limits)\n result[\"ModelCapabilitiesLimitsVision\"] = to_class(ModelCapabilitiesLimitsVision, self.model_capabilities_limits_vision)\n result[\"ModelCapabilitiesOverride\"] = to_class(ModelCapabilitiesOverride, self.model_capabilities_override)\n result[\"ModelCapabilitiesOverrideLimits\"] = to_class(ModelCapabilitiesOverrideLimits, self.model_capabilities_override_limits)\n result[\"ModelCapabilitiesOverrideLimitsVision\"] = to_class(ModelCapabilitiesOverrideLimitsVision, self.model_capabilities_override_limits_vision)\n result[\"ModelCapabilitiesOverrideSupports\"] = to_class(ModelCapabilitiesOverrideSupports, self.model_capabilities_override_supports)\n result[\"ModelCapabilitiesSupports\"] = to_class(ModelCapabilitiesSupports, self.model_capabilities_supports)\n result[\"ModelList\"] = to_class(ModelList, self.model_list)\n result[\"ModelPolicy\"] = to_class(ModelPolicy, self.model_policy)\n result[\"ModelsListRequest\"] = to_class(ModelsListRequest, self.models_list_request)\n result[\"ModelSwitchToRequest\"] = to_class(ModelSwitchToRequest, self.model_switch_to_request)\n result[\"ModelSwitchToResult\"] = to_class(ModelSwitchToResult, self.model_switch_to_result)\n result[\"ModeSetRequest\"] = to_class(ModeSetRequest, self.mode_set_request)\n result[\"NameGetResult\"] = to_class(NameGetResult, self.name_get_result)\n result[\"NameSetRequest\"] = to_class(NameSetRequest, self.name_set_request)\n result[\"PermissionDecision\"] = to_class(PermissionDecision, self.permission_decision)\n result[\"PermissionDecisionApproveForLocation\"] = to_class(PermissionDecisionApproveForLocation, self.permission_decision_approve_for_location)\n result[\"PermissionDecisionApproveForLocationApproval\"] = to_class(PermissionDecisionApproveForLocationApproval, self.permission_decision_approve_for_location_approval)\n result[\"PermissionDecisionApproveForLocationApprovalCommands\"] = to_class(PermissionDecisionApproveForLocationApprovalCommands, self.permission_decision_approve_for_location_approval_commands)\n result[\"PermissionDecisionApproveForLocationApprovalCustomTool\"] = to_class(PermissionDecisionApproveForLocationApprovalCustomTool, self.permission_decision_approve_for_location_approval_custom_tool)\n result[\"PermissionDecisionApproveForLocationApprovalMcp\"] = to_class(PermissionDecisionApproveForLocationApprovalMCP, self.permission_decision_approve_for_location_approval_mcp)\n result[\"PermissionDecisionApproveForLocationApprovalMcpSampling\"] = to_class(PermissionDecisionApproveForLocationApprovalMCPSampling, self.permission_decision_approve_for_location_approval_mcp_sampling)\n result[\"PermissionDecisionApproveForLocationApprovalMemory\"] = to_class(PermissionDecisionApproveForLocationApprovalMemory, self.permission_decision_approve_for_location_approval_memory)\n result[\"PermissionDecisionApproveForLocationApprovalRead\"] = to_class(PermissionDecisionApproveForLocationApprovalRead, self.permission_decision_approve_for_location_approval_read)\n result[\"PermissionDecisionApproveForLocationApprovalWrite\"] = to_class(PermissionDecisionApproveForLocationApprovalWrite, self.permission_decision_approve_for_location_approval_write)\n result[\"PermissionDecisionApproveForSession\"] = to_class(PermissionDecisionApproveForSession, self.permission_decision_approve_for_session)\n result[\"PermissionDecisionApproveForSessionApproval\"] = to_class(PermissionDecisionApproveForSessionApproval, self.permission_decision_approve_for_session_approval)\n result[\"PermissionDecisionApproveForSessionApprovalCommands\"] = to_class(PermissionDecisionApproveForSessionApprovalCommands, self.permission_decision_approve_for_session_approval_commands)\n result[\"PermissionDecisionApproveForSessionApprovalCustomTool\"] = to_class(PermissionDecisionApproveForSessionApprovalCustomTool, self.permission_decision_approve_for_session_approval_custom_tool)\n result[\"PermissionDecisionApproveForSessionApprovalMcp\"] = to_class(PermissionDecisionApproveForSessionApprovalMCP, self.permission_decision_approve_for_session_approval_mcp)\n result[\"PermissionDecisionApproveForSessionApprovalMcpSampling\"] = to_class(PermissionDecisionApproveForSessionApprovalMCPSampling, self.permission_decision_approve_for_session_approval_mcp_sampling)\n result[\"PermissionDecisionApproveForSessionApprovalMemory\"] = to_class(PermissionDecisionApproveForSessionApprovalMemory, self.permission_decision_approve_for_session_approval_memory)\n result[\"PermissionDecisionApproveForSessionApprovalRead\"] = to_class(PermissionDecisionApproveForSessionApprovalRead, self.permission_decision_approve_for_session_approval_read)\n result[\"PermissionDecisionApproveForSessionApprovalWrite\"] = to_class(PermissionDecisionApproveForSessionApprovalWrite, self.permission_decision_approve_for_session_approval_write)\n result[\"PermissionDecisionApproveOnce\"] = to_class(PermissionDecisionApproveOnce, self.permission_decision_approve_once)\n result[\"PermissionDecisionApprovePermanently\"] = to_class(PermissionDecisionApprovePermanently, self.permission_decision_approve_permanently)\n result[\"PermissionDecisionReject\"] = to_class(PermissionDecisionReject, self.permission_decision_reject)\n result[\"PermissionDecisionRequest\"] = to_class(PermissionDecisionRequest, self.permission_decision_request)\n result[\"PermissionDecisionUserNotAvailable\"] = to_class(PermissionDecisionUserNotAvailable, self.permission_decision_user_not_available)\n result[\"PermissionRequestResult\"] = to_class(PermissionRequestResult, self.permission_request_result)\n result[\"PermissionsResetSessionApprovalsRequest\"] = to_class(PermissionsResetSessionApprovalsRequest, self.permissions_reset_session_approvals_request)\n result[\"PermissionsResetSessionApprovalsResult\"] = to_class(PermissionsResetSessionApprovalsResult, self.permissions_reset_session_approvals_result)\n result[\"PermissionsSetApproveAllRequest\"] = to_class(PermissionsSetApproveAllRequest, self.permissions_set_approve_all_request)\n result[\"PermissionsSetApproveAllResult\"] = to_class(PermissionsSetApproveAllResult, self.permissions_set_approve_all_result)\n result[\"PingRequest\"] = to_class(PingRequest, self.ping_request)\n result[\"PingResult\"] = to_class(PingResult, self.ping_result)\n result[\"PlanReadResult\"] = to_class(PlanReadResult, self.plan_read_result)\n result[\"PlanUpdateRequest\"] = to_class(PlanUpdateRequest, self.plan_update_request)\n result[\"Plugin\"] = to_class(Plugin, self.plugin)\n result[\"PluginList\"] = to_class(PluginList, self.plugin_list)\n result[\"ServerSkill\"] = to_class(ServerSkill, self.server_skill)\n result[\"ServerSkillList\"] = to_class(ServerSkillList, self.server_skill_list)\n result[\"SessionAuthStatus\"] = to_class(SessionAuthStatus, self.session_auth_status)\n result[\"SessionFsAppendFileRequest\"] = to_class(SessionFSAppendFileRequest, self.session_fs_append_file_request)\n result[\"SessionFsError\"] = to_class(SessionFSError, self.session_fs_error)\n result[\"SessionFsErrorCode\"] = to_enum(SessionFSErrorCode, self.session_fs_error_code)\n result[\"SessionFsExistsRequest\"] = to_class(SessionFSExistsRequest, self.session_fs_exists_request)\n result[\"SessionFsExistsResult\"] = to_class(SessionFSExistsResult, self.session_fs_exists_result)\n result[\"SessionFsMkdirRequest\"] = to_class(SessionFSMkdirRequest, self.session_fs_mkdir_request)\n result[\"SessionFsReaddirRequest\"] = to_class(SessionFSReaddirRequest, self.session_fs_readdir_request)\n result[\"SessionFsReaddirResult\"] = to_class(SessionFSReaddirResult, self.session_fs_readdir_result)\n result[\"SessionFsReaddirWithTypesEntry\"] = to_class(SessionFSReaddirWithTypesEntry, self.session_fs_readdir_with_types_entry)\n result[\"SessionFsReaddirWithTypesEntryType\"] = to_enum(SessionFSReaddirWithTypesEntryType, self.session_fs_readdir_with_types_entry_type)\n result[\"SessionFsReaddirWithTypesRequest\"] = to_class(SessionFSReaddirWithTypesRequest, self.session_fs_readdir_with_types_request)\n result[\"SessionFsReaddirWithTypesResult\"] = to_class(SessionFSReaddirWithTypesResult, self.session_fs_readdir_with_types_result)\n result[\"SessionFsReadFileRequest\"] = to_class(SessionFSReadFileRequest, self.session_fs_read_file_request)\n result[\"SessionFsReadFileResult\"] = to_class(SessionFSReadFileResult, self.session_fs_read_file_result)\n result[\"SessionFsRenameRequest\"] = to_class(SessionFSRenameRequest, self.session_fs_rename_request)\n result[\"SessionFsRmRequest\"] = to_class(SessionFSRmRequest, self.session_fs_rm_request)\n result[\"SessionFsSetProviderConventions\"] = to_enum(SessionFSSetProviderConventions, self.session_fs_set_provider_conventions)\n result[\"SessionFsSetProviderRequest\"] = to_class(SessionFSSetProviderRequest, self.session_fs_set_provider_request)\n result[\"SessionFsSetProviderResult\"] = to_class(SessionFSSetProviderResult, self.session_fs_set_provider_result)\n result[\"SessionFsStatRequest\"] = to_class(SessionFSStatRequest, self.session_fs_stat_request)\n result[\"SessionFsStatResult\"] = to_class(SessionFSStatResult, self.session_fs_stat_result)\n result[\"SessionFsWriteFileRequest\"] = to_class(SessionFSWriteFileRequest, self.session_fs_write_file_request)\n result[\"SessionLogLevel\"] = to_enum(SessionLogLevel, self.session_log_level)\n result[\"SessionMode\"] = to_enum(SessionMode, self.session_mode)\n result[\"SessionsForkRequest\"] = to_class(SessionsForkRequest, self.sessions_fork_request)\n result[\"SessionsForkResult\"] = to_class(SessionsForkResult, self.sessions_fork_result)\n result[\"ShellExecRequest\"] = to_class(ShellExecRequest, self.shell_exec_request)\n result[\"ShellExecResult\"] = to_class(ShellExecResult, self.shell_exec_result)\n result[\"ShellKillRequest\"] = to_class(ShellKillRequest, self.shell_kill_request)\n result[\"ShellKillResult\"] = to_class(ShellKillResult, self.shell_kill_result)\n result[\"ShellKillSignal\"] = to_enum(ShellKillSignal, self.shell_kill_signal)\n result[\"Skill\"] = to_class(Skill, self.skill)\n result[\"SkillList\"] = to_class(SkillList, self.skill_list)\n result[\"SkillsConfigSetDisabledSkillsRequest\"] = to_class(SkillsConfigSetDisabledSkillsRequest, self.skills_config_set_disabled_skills_request)\n result[\"SkillsDisableRequest\"] = to_class(SkillsDisableRequest, self.skills_disable_request)\n result[\"SkillsDiscoverRequest\"] = to_class(SkillsDiscoverRequest, self.skills_discover_request)\n result[\"SkillsEnableRequest\"] = to_class(SkillsEnableRequest, self.skills_enable_request)\n result[\"TaskAgentInfo\"] = to_class(TaskAgentInfo, self.task_agent_info)\n result[\"TaskAgentInfoExecutionMode\"] = to_enum(TaskInfoExecutionMode, self.task_agent_info_execution_mode)\n result[\"TaskAgentInfoStatus\"] = to_enum(TaskInfoStatus, self.task_agent_info_status)\n result[\"TaskInfo\"] = to_class(TaskInfo, self.task_info)\n result[\"TaskList\"] = to_class(TaskList, self.task_list)\n result[\"TasksCancelRequest\"] = to_class(TasksCancelRequest, self.tasks_cancel_request)\n result[\"TasksCancelResult\"] = to_class(TasksCancelResult, self.tasks_cancel_result)\n result[\"TaskShellInfo\"] = to_class(TaskShellInfo, self.task_shell_info)\n result[\"TaskShellInfoAttachmentMode\"] = to_enum(TaskShellInfoAttachmentMode, self.task_shell_info_attachment_mode)\n result[\"TaskShellInfoExecutionMode\"] = to_enum(TaskInfoExecutionMode, self.task_shell_info_execution_mode)\n result[\"TaskShellInfoStatus\"] = to_enum(TaskInfoStatus, self.task_shell_info_status)\n result[\"TasksPromoteToBackgroundRequest\"] = to_class(TasksPromoteToBackgroundRequest, self.tasks_promote_to_background_request)\n result[\"TasksPromoteToBackgroundResult\"] = to_class(TasksPromoteToBackgroundResult, self.tasks_promote_to_background_result)\n result[\"TasksRemoveRequest\"] = to_class(TasksRemoveRequest, self.tasks_remove_request)\n result[\"TasksRemoveResult\"] = to_class(TasksRemoveResult, self.tasks_remove_result)\n result[\"TasksStartAgentRequest\"] = to_class(TasksStartAgentRequest, self.tasks_start_agent_request)\n result[\"TasksStartAgentResult\"] = to_class(TasksStartAgentResult, self.tasks_start_agent_result)\n result[\"Tool\"] = to_class(Tool, self.tool)\n result[\"ToolList\"] = to_class(ToolList, self.tool_list)\n result[\"ToolsListRequest\"] = to_class(ToolsListRequest, self.tools_list_request)\n result[\"UIElicitationArrayAnyOfField\"] = to_class(UIElicitationArrayAnyOfField, self.ui_elicitation_array_any_of_field)\n result[\"UIElicitationArrayAnyOfFieldItems\"] = to_class(UIElicitationArrayAnyOfFieldItems, self.ui_elicitation_array_any_of_field_items)\n result[\"UIElicitationArrayAnyOfFieldItemsAnyOf\"] = to_class(UIElicitationArrayAnyOfFieldItemsAnyOf, self.ui_elicitation_array_any_of_field_items_any_of)\n result[\"UIElicitationArrayEnumField\"] = to_class(UIElicitationArrayEnumField, self.ui_elicitation_array_enum_field)\n result[\"UIElicitationArrayEnumFieldItems\"] = to_class(UIElicitationArrayEnumFieldItems, self.ui_elicitation_array_enum_field_items)\n result[\"UIElicitationFieldValue\"] = from_union([to_float, from_bool, lambda x: from_list(from_str, x), from_str], self.ui_elicitation_field_value)\n result[\"UIElicitationRequest\"] = to_class(UIElicitationRequest, self.ui_elicitation_request)\n result[\"UIElicitationResponse\"] = to_class(UIElicitationResponse, self.ui_elicitation_response)\n result[\"UIElicitationResponseAction\"] = to_enum(UIElicitationResponseAction, self.ui_elicitation_response_action)\n result[\"UIElicitationResponseContent\"] = from_dict(lambda x: from_union([to_float, from_bool, lambda x: from_list(from_str, x), from_str], x), self.ui_elicitation_response_content)\n result[\"UIElicitationResult\"] = to_class(UIElicitationResult, self.ui_elicitation_result)\n result[\"UIElicitationSchema\"] = to_class(UIElicitationSchema, self.ui_elicitation_schema)\n result[\"UIElicitationSchemaProperty\"] = to_class(UIElicitationSchemaProperty, self.ui_elicitation_schema_property)\n result[\"UIElicitationSchemaPropertyBoolean\"] = to_class(UIElicitationSchemaPropertyBoolean, self.ui_elicitation_schema_property_boolean)\n result[\"UIElicitationSchemaPropertyNumber\"] = to_class(UIElicitationSchemaPropertyNumber, self.ui_elicitation_schema_property_number)\n result[\"UIElicitationSchemaPropertyNumberType\"] = to_enum(UIElicitationSchemaPropertyNumberType, self.ui_elicitation_schema_property_number_type)\n result[\"UIElicitationSchemaPropertyString\"] = to_class(UIElicitationSchemaPropertyString, self.ui_elicitation_schema_property_string)\n result[\"UIElicitationSchemaPropertyStringFormat\"] = to_enum(UIElicitationSchemaPropertyStringFormat, self.ui_elicitation_schema_property_string_format)\n result[\"UIElicitationStringEnumField\"] = to_class(UIElicitationStringEnumField, self.ui_elicitation_string_enum_field)\n result[\"UIElicitationStringOneOfField\"] = to_class(UIElicitationStringOneOfField, self.ui_elicitation_string_one_of_field)\n result[\"UIElicitationStringOneOfFieldOneOf\"] = to_class(UIElicitationStringOneOfFieldOneOf, self.ui_elicitation_string_one_of_field_one_of)\n result[\"UIHandlePendingElicitationRequest\"] = to_class(UIHandlePendingElicitationRequest, self.ui_handle_pending_elicitation_request)\n result[\"UsageGetMetricsResult\"] = to_class(UsageGetMetricsResult, self.usage_get_metrics_result)\n result[\"UsageMetricsCodeChanges\"] = to_class(UsageMetricsCodeChanges, self.usage_metrics_code_changes)\n result[\"UsageMetricsModelMetric\"] = to_class(UsageMetricsModelMetric, self.usage_metrics_model_metric)\n result[\"UsageMetricsModelMetricRequests\"] = to_class(UsageMetricsModelMetricRequests, self.usage_metrics_model_metric_requests)\n result[\"UsageMetricsModelMetricTokenDetail\"] = to_class(UsageMetricsModelMetricTokenDetail, self.usage_metrics_model_metric_token_detail)\n result[\"UsageMetricsModelMetricUsage\"] = to_class(UsageMetricsModelMetricUsage, self.usage_metrics_model_metric_usage)\n result[\"UsageMetricsTokenDetail\"] = to_class(UsageMetricsTokenDetail, self.usage_metrics_token_detail)\n result[\"WorkspacesCreateFileRequest\"] = to_class(WorkspacesCreateFileRequest, self.workspaces_create_file_request)\n result[\"WorkspacesGetWorkspaceResult\"] = to_class(WorkspacesGetWorkspaceResult, self.workspaces_get_workspace_result)\n result[\"WorkspacesListFilesResult\"] = to_class(WorkspacesListFilesResult, self.workspaces_list_files_result)\n result[\"WorkspacesReadFileRequest\"] = to_class(WorkspacesReadFileRequest, self.workspaces_read_file_request)\n result[\"WorkspacesReadFileResult\"] = to_class(WorkspacesReadFileResult, self.workspaces_read_file_result)\n return result\n\ndef rpc_from_dict(s: Any) -> RPC:\n return RPC.from_dict(s)\n\ndef rpc_to_dict(x: RPC) -> Any:\n return to_class(RPC, x)\n\n\ndef _timeout_kwargs(timeout: float | None) -> dict:\n \"\"\"Build keyword arguments for optional timeout forwarding.\"\"\"\n if timeout is not None:\n return {\"timeout\": timeout}\n return {}\n\ndef _patch_model_capabilities(data: dict) -> dict:\n \"\"\"Ensure model capabilities have required fields.\n\n TODO: Remove once the runtime schema correctly marks these fields as optional.\n Some models (e.g. embedding models) may omit 'limits' or 'supports' in their\n capabilities, or omit 'max_context_window_tokens' within limits. The generated\n deserializer requires these fields, so we supply defaults here.\n \"\"\"\n for model in data.get(\"models\", []):\n caps = model.get(\"capabilities\")\n if caps is None:\n model[\"capabilities\"] = {\"supports\": {}, \"limits\": {\"max_context_window_tokens\": 0}}\n continue\n if \"supports\" not in caps:\n caps[\"supports\"] = {}\n if \"limits\" not in caps:\n caps[\"limits\"] = {\"max_context_window_tokens\": 0}\n elif \"max_context_window_tokens\" not in caps[\"limits\"]:\n caps[\"limits\"][\"max_context_window_tokens\"] = 0\n return data\n\n\nclass ServerModelsApi:\n def __init__(self, client: \"JsonRpcClient\"):\n self._client = client\n\n async def list(self, params: ModelsListRequest | None = None, *, timeout: float | None = None) -> ModelList:\n params_dict = {k: v for k, v in params.to_dict().items() if v is not None} if params is not None else {}\n return ModelList.from_dict(_patch_model_capabilities(await self._client.request(\"models.list\", params_dict, **_timeout_kwargs(timeout))))\n\n\nclass ServerToolsApi:\n def __init__(self, client: \"JsonRpcClient\"):\n self._client = client\n\n async def list(self, params: ToolsListRequest, *, timeout: float | None = None) -> ToolList:\n params_dict = {k: v for k, v in params.to_dict().items() if v is not None}\n return ToolList.from_dict(await self._client.request(\"tools.list\", params_dict, **_timeout_kwargs(timeout)))\n\n\nclass ServerAccountApi:\n def __init__(self, client: \"JsonRpcClient\"):\n self._client = client\n\n async def get_quota(self, params: AccountGetQuotaRequest | None = None, *, timeout: float | None = None) -> AccountGetQuotaResult:\n params_dict = {k: v for k, v in params.to_dict().items() if v is not None} if params is not None else {}\n return AccountGetQuotaResult.from_dict(await self._client.request(\"account.getQuota\", params_dict, **_timeout_kwargs(timeout)))\n\n\nclass ServerMcpConfigApi:\n def __init__(self, client: \"JsonRpcClient\"):\n self._client = client\n\n async def list(self, *, timeout: float | None = None) -> MCPConfigList:\n return MCPConfigList.from_dict(await self._client.request(\"mcp.config.list\", {}, **_timeout_kwargs(timeout)))\n\n async def add(self, params: MCPConfigAddRequest, *, timeout: float | None = None) -> None:\n params_dict = {k: v for k, v in params.to_dict().items() if v is not None}\n await self._client.request(\"mcp.config.add\", params_dict, **_timeout_kwargs(timeout))\n\n async def update(self, params: MCPConfigUpdateRequest, *, timeout: float | None = None) -> None:\n params_dict = {k: v for k, v in params.to_dict().items() if v is not None}\n await self._client.request(\"mcp.config.update\", params_dict, **_timeout_kwargs(timeout))\n\n async def remove(self, params: MCPConfigRemoveRequest, *, timeout: float | None = None) -> None:\n params_dict = {k: v for k, v in params.to_dict().items() if v is not None}\n await self._client.request(\"mcp.config.remove\", params_dict, **_timeout_kwargs(timeout))\n\n async def enable(self, params: MCPConfigEnableRequest, *, timeout: float | None = None) -> None:\n params_dict = {k: v for k, v in params.to_dict().items() if v is not None}\n await self._client.request(\"mcp.config.enable\", params_dict, **_timeout_kwargs(timeout))\n\n async def disable(self, params: MCPConfigDisableRequest, *, timeout: float | None = None) -> None:\n params_dict = {k: v for k, v in params.to_dict().items() if v is not None}\n await self._client.request(\"mcp.config.disable\", params_dict, **_timeout_kwargs(timeout))\n\n\nclass ServerMcpApi:\n def __init__(self, client: \"JsonRpcClient\"):\n self._client = client\n self.config = ServerMcpConfigApi(client)\n\n async def discover(self, params: MCPDiscoverRequest, *, timeout: float | None = None) -> MCPDiscoverResult:\n params_dict = {k: v for k, v in params.to_dict().items() if v is not None}\n return MCPDiscoverResult.from_dict(await self._client.request(\"mcp.discover\", params_dict, **_timeout_kwargs(timeout)))\n\n\nclass ServerSkillsConfigApi:\n def __init__(self, client: \"JsonRpcClient\"):\n self._client = client\n\n async def set_disabled_skills(self, params: SkillsConfigSetDisabledSkillsRequest, *, timeout: float | None = None) -> None:\n params_dict = {k: v for k, v in params.to_dict().items() if v is not None}\n await self._client.request(\"skills.config.setDisabledSkills\", params_dict, **_timeout_kwargs(timeout))\n\n\nclass ServerSkillsApi:\n def __init__(self, client: \"JsonRpcClient\"):\n self._client = client\n self.config = ServerSkillsConfigApi(client)\n\n async def discover(self, params: SkillsDiscoverRequest, *, timeout: float | None = None) -> ServerSkillList:\n params_dict = {k: v for k, v in params.to_dict().items() if v is not None}\n return ServerSkillList.from_dict(await self._client.request(\"skills.discover\", params_dict, **_timeout_kwargs(timeout)))\n\n\nclass ServerSessionFsApi:\n def __init__(self, client: \"JsonRpcClient\"):\n self._client = client\n\n async def set_provider(self, params: SessionFSSetProviderRequest, *, timeout: float | None = None) -> SessionFSSetProviderResult:\n params_dict = {k: v for k, v in params.to_dict().items() if v is not None}\n return SessionFSSetProviderResult.from_dict(await self._client.request(\"sessionFs.setProvider\", params_dict, **_timeout_kwargs(timeout)))\n\n\n# Experimental: this API group is experimental and may change or be removed.\nclass ServerSessionsApi:\n def __init__(self, client: \"JsonRpcClient\"):\n self._client = client\n\n async def fork(self, params: SessionsForkRequest, *, timeout: float | None = None) -> SessionsForkResult:\n params_dict = {k: v for k, v in params.to_dict().items() if v is not None}\n return SessionsForkResult.from_dict(await self._client.request(\"sessions.fork\", params_dict, **_timeout_kwargs(timeout)))\n\n\nclass ServerRpc:\n \"\"\"Typed server-scoped RPC methods.\"\"\"\n def __init__(self, client: \"JsonRpcClient\"):\n self._client = client\n self.models = ServerModelsApi(client)\n self.tools = ServerToolsApi(client)\n self.account = ServerAccountApi(client)\n self.mcp = ServerMcpApi(client)\n self.skills = ServerSkillsApi(client)\n self.session_fs = ServerSessionFsApi(client)\n self.sessions = ServerSessionsApi(client)\n\n async def ping(self, params: PingRequest, *, timeout: float | None = None) -> PingResult:\n params_dict = {k: v for k, v in params.to_dict().items() if v is not None}\n return PingResult.from_dict(await self._client.request(\"ping\", params_dict, **_timeout_kwargs(timeout)))\n\n\nclass AuthApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def get_status(self, *, timeout: float | None = None) -> SessionAuthStatus:\n return SessionAuthStatus.from_dict(await self._client.request(\"session.auth.getStatus\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout)))\n\n\nclass ModelApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def get_current(self, *, timeout: float | None = None) -> CurrentModel:\n return CurrentModel.from_dict(await self._client.request(\"session.model.getCurrent\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout)))\n\n async def switch_to(self, params: ModelSwitchToRequest, *, timeout: float | None = None) -> ModelSwitchToResult:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n return ModelSwitchToResult.from_dict(await self._client.request(\"session.model.switchTo\", params_dict, **_timeout_kwargs(timeout)))\n\n\nclass ModeApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def get(self, *, timeout: float | None = None) -> SessionMode:\n return SessionMode(await self._client.request(\"session.mode.get\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout)))\n\n async def set(self, params: ModeSetRequest, *, timeout: float | None = None) -> None:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n await self._client.request(\"session.mode.set\", params_dict, **_timeout_kwargs(timeout))\n\n\nclass NameApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def get(self, *, timeout: float | None = None) -> NameGetResult:\n return NameGetResult.from_dict(await self._client.request(\"session.name.get\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout)))\n\n async def set(self, params: NameSetRequest, *, timeout: float | None = None) -> None:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n await self._client.request(\"session.name.set\", params_dict, **_timeout_kwargs(timeout))\n\n\nclass PlanApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def read(self, *, timeout: float | None = None) -> PlanReadResult:\n return PlanReadResult.from_dict(await self._client.request(\"session.plan.read\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout)))\n\n async def update(self, params: PlanUpdateRequest, *, timeout: float | None = None) -> None:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n await self._client.request(\"session.plan.update\", params_dict, **_timeout_kwargs(timeout))\n\n async def delete(self, *, timeout: float | None = None) -> None:\n await self._client.request(\"session.plan.delete\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout))\n\n\nclass WorkspacesApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def get_workspace(self, *, timeout: float | None = None) -> WorkspacesGetWorkspaceResult:\n return WorkspacesGetWorkspaceResult.from_dict(await self._client.request(\"session.workspaces.getWorkspace\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout)))\n\n async def list_files(self, *, timeout: float | None = None) -> WorkspacesListFilesResult:\n return WorkspacesListFilesResult.from_dict(await self._client.request(\"session.workspaces.listFiles\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout)))\n\n async def read_file(self, params: WorkspacesReadFileRequest, *, timeout: float | None = None) -> WorkspacesReadFileResult:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n return WorkspacesReadFileResult.from_dict(await self._client.request(\"session.workspaces.readFile\", params_dict, **_timeout_kwargs(timeout)))\n\n async def create_file(self, params: WorkspacesCreateFileRequest, *, timeout: float | None = None) -> None:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n await self._client.request(\"session.workspaces.createFile\", params_dict, **_timeout_kwargs(timeout))\n\n\nclass InstructionsApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def get_sources(self, *, timeout: float | None = None) -> InstructionsGetSourcesResult:\n return InstructionsGetSourcesResult.from_dict(await self._client.request(\"session.instructions.getSources\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout)))\n\n\n# Experimental: this API group is experimental and may change or be removed.\nclass FleetApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def start(self, params: FleetStartRequest, *, timeout: float | None = None) -> FleetStartResult:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n return FleetStartResult.from_dict(await self._client.request(\"session.fleet.start\", params_dict, **_timeout_kwargs(timeout)))\n\n\n# Experimental: this API group is experimental and may change or be removed.\nclass AgentApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def list(self, *, timeout: float | None = None) -> AgentList:\n return AgentList.from_dict(await self._client.request(\"session.agent.list\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout)))\n\n async def get_current(self, *, timeout: float | None = None) -> AgentGetCurrentResult:\n return AgentGetCurrentResult.from_dict(await self._client.request(\"session.agent.getCurrent\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout)))\n\n async def select(self, params: AgentSelectRequest, *, timeout: float | None = None) -> AgentSelectResult:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n return AgentSelectResult.from_dict(await self._client.request(\"session.agent.select\", params_dict, **_timeout_kwargs(timeout)))\n\n async def deselect(self, *, timeout: float | None = None) -> None:\n await self._client.request(\"session.agent.deselect\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout))\n\n async def reload(self, *, timeout: float | None = None) -> AgentReloadResult:\n return AgentReloadResult.from_dict(await self._client.request(\"session.agent.reload\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout)))\n\n\n# Experimental: this API group is experimental and may change or be removed.\nclass TasksApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def start_agent(self, params: TasksStartAgentRequest, *, timeout: float | None = None) -> TasksStartAgentResult:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n return TasksStartAgentResult.from_dict(await self._client.request(\"session.tasks.startAgent\", params_dict, **_timeout_kwargs(timeout)))\n\n async def list(self, *, timeout: float | None = None) -> TaskList:\n return TaskList.from_dict(await self._client.request(\"session.tasks.list\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout)))\n\n async def promote_to_background(self, params: TasksPromoteToBackgroundRequest, *, timeout: float | None = None) -> TasksPromoteToBackgroundResult:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n return TasksPromoteToBackgroundResult.from_dict(await self._client.request(\"session.tasks.promoteToBackground\", params_dict, **_timeout_kwargs(timeout)))\n\n async def cancel(self, params: TasksCancelRequest, *, timeout: float | None = None) -> TasksCancelResult:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n return TasksCancelResult.from_dict(await self._client.request(\"session.tasks.cancel\", params_dict, **_timeout_kwargs(timeout)))\n\n async def remove(self, params: TasksRemoveRequest, *, timeout: float | None = None) -> TasksRemoveResult:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n return TasksRemoveResult.from_dict(await self._client.request(\"session.tasks.remove\", params_dict, **_timeout_kwargs(timeout)))\n\n\n# Experimental: this API group is experimental and may change or be removed.\nclass SkillsApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def list(self, *, timeout: float | None = None) -> SkillList:\n return SkillList.from_dict(await self._client.request(\"session.skills.list\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout)))\n\n async def enable(self, params: SkillsEnableRequest, *, timeout: float | None = None) -> None:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n await self._client.request(\"session.skills.enable\", params_dict, **_timeout_kwargs(timeout))\n\n async def disable(self, params: SkillsDisableRequest, *, timeout: float | None = None) -> None:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n await self._client.request(\"session.skills.disable\", params_dict, **_timeout_kwargs(timeout))\n\n async def reload(self, *, timeout: float | None = None) -> None:\n await self._client.request(\"session.skills.reload\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout))\n\n\n# Experimental: this API group is experimental and may change or be removed.\nclass McpOauthApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def login(self, params: MCPOauthLoginRequest, *, timeout: float | None = None) -> MCPOauthLoginResult:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n return MCPOauthLoginResult.from_dict(await self._client.request(\"session.mcp.oauth.login\", params_dict, **_timeout_kwargs(timeout)))\n\n\n# Experimental: this API group is experimental and may change or be removed.\nclass McpApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n self.oauth = McpOauthApi(client, session_id)\n\n async def list(self, *, timeout: float | None = None) -> MCPServerList:\n return MCPServerList.from_dict(await self._client.request(\"session.mcp.list\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout)))\n\n async def enable(self, params: MCPEnableRequest, *, timeout: float | None = None) -> None:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n await self._client.request(\"session.mcp.enable\", params_dict, **_timeout_kwargs(timeout))\n\n async def disable(self, params: MCPDisableRequest, *, timeout: float | None = None) -> None:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n await self._client.request(\"session.mcp.disable\", params_dict, **_timeout_kwargs(timeout))\n\n async def reload(self, *, timeout: float | None = None) -> None:\n await self._client.request(\"session.mcp.reload\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout))\n\n\n# Experimental: this API group is experimental and may change or be removed.\nclass PluginsApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def list(self, *, timeout: float | None = None) -> PluginList:\n return PluginList.from_dict(await self._client.request(\"session.plugins.list\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout)))\n\n\n# Experimental: this API group is experimental and may change or be removed.\nclass ExtensionsApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def list(self, *, timeout: float | None = None) -> ExtensionList:\n return ExtensionList.from_dict(await self._client.request(\"session.extensions.list\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout)))\n\n async def enable(self, params: ExtensionsEnableRequest, *, timeout: float | None = None) -> None:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n await self._client.request(\"session.extensions.enable\", params_dict, **_timeout_kwargs(timeout))\n\n async def disable(self, params: ExtensionsDisableRequest, *, timeout: float | None = None) -> None:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n await self._client.request(\"session.extensions.disable\", params_dict, **_timeout_kwargs(timeout))\n\n async def reload(self, *, timeout: float | None = None) -> None:\n await self._client.request(\"session.extensions.reload\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout))\n\n\nclass ToolsApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def handle_pending_tool_call(self, params: HandlePendingToolCallRequest, *, timeout: float | None = None) -> HandlePendingToolCallResult:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n return HandlePendingToolCallResult.from_dict(await self._client.request(\"session.tools.handlePendingToolCall\", params_dict, **_timeout_kwargs(timeout)))\n\n\nclass CommandsApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def handle_pending_command(self, params: CommandsHandlePendingCommandRequest, *, timeout: float | None = None) -> CommandsHandlePendingCommandResult:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n return CommandsHandlePendingCommandResult.from_dict(await self._client.request(\"session.commands.handlePendingCommand\", params_dict, **_timeout_kwargs(timeout)))\n\n\nclass UiApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def elicitation(self, params: UIElicitationRequest, *, timeout: float | None = None) -> UIElicitationResponse:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n return UIElicitationResponse.from_dict(await self._client.request(\"session.ui.elicitation\", params_dict, **_timeout_kwargs(timeout)))\n\n async def handle_pending_elicitation(self, params: UIHandlePendingElicitationRequest, *, timeout: float | None = None) -> UIElicitationResult:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n return UIElicitationResult.from_dict(await self._client.request(\"session.ui.handlePendingElicitation\", params_dict, **_timeout_kwargs(timeout)))\n\n\nclass PermissionsApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def handle_pending_permission_request(self, params: PermissionDecisionRequest, *, timeout: float | None = None) -> PermissionRequestResult:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n return PermissionRequestResult.from_dict(await self._client.request(\"session.permissions.handlePendingPermissionRequest\", params_dict, **_timeout_kwargs(timeout)))\n\n async def set_approve_all(self, params: PermissionsSetApproveAllRequest, *, timeout: float | None = None) -> PermissionsSetApproveAllResult:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n return PermissionsSetApproveAllResult.from_dict(await self._client.request(\"session.permissions.setApproveAll\", params_dict, **_timeout_kwargs(timeout)))\n\n async def reset_session_approvals(self, *, timeout: float | None = None) -> PermissionsResetSessionApprovalsResult:\n return PermissionsResetSessionApprovalsResult.from_dict(await self._client.request(\"session.permissions.resetSessionApprovals\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout)))\n\n\nclass ShellApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def exec(self, params: ShellExecRequest, *, timeout: float | None = None) -> ShellExecResult:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n return ShellExecResult.from_dict(await self._client.request(\"session.shell.exec\", params_dict, **_timeout_kwargs(timeout)))\n\n async def kill(self, params: ShellKillRequest, *, timeout: float | None = None) -> ShellKillResult:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n return ShellKillResult.from_dict(await self._client.request(\"session.shell.kill\", params_dict, **_timeout_kwargs(timeout)))\n\n\n# Experimental: this API group is experimental and may change or be removed.\nclass HistoryApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def compact(self, *, timeout: float | None = None) -> HistoryCompactResult:\n return HistoryCompactResult.from_dict(await self._client.request(\"session.history.compact\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout)))\n\n async def truncate(self, params: HistoryTruncateRequest, *, timeout: float | None = None) -> HistoryTruncateResult:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n return HistoryTruncateResult.from_dict(await self._client.request(\"session.history.truncate\", params_dict, **_timeout_kwargs(timeout)))\n\n\n# Experimental: this API group is experimental and may change or be removed.\nclass UsageApi:\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n\n async def get_metrics(self, *, timeout: float | None = None) -> UsageGetMetricsResult:\n return UsageGetMetricsResult.from_dict(await self._client.request(\"session.usage.getMetrics\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout)))\n\n\nclass SessionRpc:\n \"\"\"Typed session-scoped RPC methods.\"\"\"\n def __init__(self, client: \"JsonRpcClient\", session_id: str):\n self._client = client\n self._session_id = session_id\n self.auth = AuthApi(client, session_id)\n self.model = ModelApi(client, session_id)\n self.mode = ModeApi(client, session_id)\n self.name = NameApi(client, session_id)\n self.plan = PlanApi(client, session_id)\n self.workspaces = WorkspacesApi(client, session_id)\n self.instructions = InstructionsApi(client, session_id)\n self.fleet = FleetApi(client, session_id)\n self.agent = AgentApi(client, session_id)\n self.tasks = TasksApi(client, session_id)\n self.skills = SkillsApi(client, session_id)\n self.mcp = McpApi(client, session_id)\n self.plugins = PluginsApi(client, session_id)\n self.extensions = ExtensionsApi(client, session_id)\n self.tools = ToolsApi(client, session_id)\n self.commands = CommandsApi(client, session_id)\n self.ui = UiApi(client, session_id)\n self.permissions = PermissionsApi(client, session_id)\n self.shell = ShellApi(client, session_id)\n self.history = HistoryApi(client, session_id)\n self.usage = UsageApi(client, session_id)\n\n async def suspend(self, *, timeout: float | None = None) -> None:\n await self._client.request(\"session.suspend\", {\"sessionId\": self._session_id}, **_timeout_kwargs(timeout))\n\n async def log(self, params: LogRequest, *, timeout: float | None = None) -> LogResult:\n params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}\n params_dict[\"sessionId\"] = self._session_id\n return LogResult.from_dict(await self._client.request(\"session.log\", params_dict, **_timeout_kwargs(timeout)))\n\n\nclass SessionFsHandler(Protocol):\n async def read_file(self, params: SessionFSReadFileRequest) -> SessionFSReadFileResult:\n pass\n async def write_file(self, params: SessionFSWriteFileRequest) -> SessionFSError | None:\n pass\n async def append_file(self, params: SessionFSAppendFileRequest) -> SessionFSError | None:\n pass\n async def exists(self, params: SessionFSExistsRequest) -> SessionFSExistsResult:\n pass\n async def stat(self, params: SessionFSStatRequest) -> SessionFSStatResult:\n pass\n async def mkdir(self, params: SessionFSMkdirRequest) -> SessionFSError | None:\n pass\n async def readdir(self, params: SessionFSReaddirRequest) -> SessionFSReaddirResult:\n pass\n async def readdir_with_types(self, params: SessionFSReaddirWithTypesRequest) -> SessionFSReaddirWithTypesResult:\n pass\n async def rm(self, params: SessionFSRmRequest) -> SessionFSError | None:\n pass\n async def rename(self, params: SessionFSRenameRequest) -> SessionFSError | None:\n pass\n\n@dataclass\nclass ClientSessionApiHandlers:\n session_fs: SessionFsHandler | None = None\n\ndef register_client_session_api_handlers(\n client: \"JsonRpcClient\",\n get_handlers: Callable[[str], ClientSessionApiHandlers],\n) -> None:\n \"\"\"Register client-session request handlers on a JSON-RPC connection.\"\"\"\n async def handle_session_fs_read_file(params: dict) -> dict | None:\n request = SessionFSReadFileRequest.from_dict(params)\n handler = get_handlers(request.session_id).session_fs\n if handler is None: raise RuntimeError(f\"No session_fs handler registered for session: {request.session_id}\")\n result = await handler.read_file(request)\n return result.to_dict()\n client.set_request_handler(\"sessionFs.readFile\", handle_session_fs_read_file)\n async def handle_session_fs_write_file(params: dict) -> dict | None:\n request = SessionFSWriteFileRequest.from_dict(params)\n handler = get_handlers(request.session_id).session_fs\n if handler is None: raise RuntimeError(f\"No session_fs handler registered for session: {request.session_id}\")\n result = await handler.write_file(request)\n return result.to_dict() if result is not None else None\n client.set_request_handler(\"sessionFs.writeFile\", handle_session_fs_write_file)\n async def handle_session_fs_append_file(params: dict) -> dict | None:\n request = SessionFSAppendFileRequest.from_dict(params)\n handler = get_handlers(request.session_id).session_fs\n if handler is None: raise RuntimeError(f\"No session_fs handler registered for session: {request.session_id}\")\n result = await handler.append_file(request)\n return result.to_dict() if result is not None else None\n client.set_request_handler(\"sessionFs.appendFile\", handle_session_fs_append_file)\n async def handle_session_fs_exists(params: dict) -> dict | None:\n request = SessionFSExistsRequest.from_dict(params)\n handler = get_handlers(request.session_id).session_fs\n if handler is None: raise RuntimeError(f\"No session_fs handler registered for session: {request.session_id}\")\n result = await handler.exists(request)\n return result.to_dict()\n client.set_request_handler(\"sessionFs.exists\", handle_session_fs_exists)\n async def handle_session_fs_stat(params: dict) -> dict | None:\n request = SessionFSStatRequest.from_dict(params)\n handler = get_handlers(request.session_id).session_fs\n if handler is None: raise RuntimeError(f\"No session_fs handler registered for session: {request.session_id}\")\n result = await handler.stat(request)\n return result.to_dict()\n client.set_request_handler(\"sessionFs.stat\", handle_session_fs_stat)\n async def handle_session_fs_mkdir(params: dict) -> dict | None:\n request = SessionFSMkdirRequest.from_dict(params)\n handler = get_handlers(request.session_id).session_fs\n if handler is None: raise RuntimeError(f\"No session_fs handler registered for session: {request.session_id}\")\n result = await handler.mkdir(request)\n return result.to_dict() if result is not None else None\n client.set_request_handler(\"sessionFs.mkdir\", handle_session_fs_mkdir)\n async def handle_session_fs_readdir(params: dict) -> dict | None:\n request = SessionFSReaddirRequest.from_dict(params)\n handler = get_handlers(request.session_id).session_fs\n if handler is None: raise RuntimeError(f\"No session_fs handler registered for session: {request.session_id}\")\n result = await handler.readdir(request)\n return result.to_dict()\n client.set_request_handler(\"sessionFs.readdir\", handle_session_fs_readdir)\n async def handle_session_fs_readdir_with_types(params: dict) -> dict | None:\n request = SessionFSReaddirWithTypesRequest.from_dict(params)\n handler = get_handlers(request.session_id).session_fs\n if handler is None: raise RuntimeError(f\"No session_fs handler registered for session: {request.session_id}\")\n result = await handler.readdir_with_types(request)\n return result.to_dict()\n client.set_request_handler(\"sessionFs.readdirWithTypes\", handle_session_fs_readdir_with_types)\n async def handle_session_fs_rm(params: dict) -> dict | None:\n request = SessionFSRmRequest.from_dict(params)\n handler = get_handlers(request.session_id).session_fs\n if handler is None: raise RuntimeError(f\"No session_fs handler registered for session: {request.session_id}\")\n result = await handler.rm(request)\n return result.to_dict() if result is not None else None\n client.set_request_handler(\"sessionFs.rm\", handle_session_fs_rm)\n async def handle_session_fs_rename(params: dict) -> dict | None:\n request = SessionFSRenameRequest.from_dict(params)\n handler = get_handlers(request.session_id).session_fs\n if handler is None: raise RuntimeError(f\"No session_fs handler registered for session: {request.session_id}\")\n result = await handler.rename(request)\n return result.to_dict() if result is not None else None\n client.set_request_handler(\"sessionFs.rename\", handle_session_fs_rename)\n" }, { "path": "python/copilot/generated/session_events.py", "content": "\"\"\"\nAUTO-GENERATED FILE - DO NOT EDIT\nGenerated from: session-events.schema.json\n\"\"\"\n\nfrom __future__ import annotations\n\nfrom collections.abc import Callable\nfrom dataclasses import dataclass\nfrom datetime import datetime\nfrom enum import Enum\nfrom typing import Any, TypeVar, cast\nfrom uuid import UUID\n\nimport dateutil.parser\n\nT = TypeVar(\"T\")\nEnumT = TypeVar(\"EnumT\", bound=Enum)\n\n\ndef from_str(x: Any) -> str:\n assert isinstance(x, str)\n return x\n\n\ndef from_int(x: Any) -> int:\n assert isinstance(x, int) and not isinstance(x, bool)\n return x\n\n\ndef to_int(x: Any) -> int:\n assert isinstance(x, int) and not isinstance(x, bool)\n return x\n\n\ndef from_float(x: Any) -> float:\n assert isinstance(x, (float, int)) and not isinstance(x, bool)\n return float(x)\n\n\ndef to_float(x: Any) -> float:\n assert isinstance(x, (float, int)) and not isinstance(x, bool)\n return float(x)\n\n\ndef from_bool(x: Any) -> bool:\n assert isinstance(x, bool)\n return x\n\n\ndef from_none(x: Any) -> Any:\n assert x is None\n return x\n\n\ndef from_union(fs: list[Callable[[Any], T]], x: Any) -> T:\n for f in fs:\n try:\n return f(x)\n except Exception:\n pass\n assert False\n\n\ndef from_list(f: Callable[[Any], T], x: Any) -> list[T]:\n assert isinstance(x, list)\n return [f(item) for item in x]\n\n\ndef from_dict(f: Callable[[Any], T], x: Any) -> dict[str, T]:\n assert isinstance(x, dict)\n return {key: f(value) for key, value in x.items()}\n\n\ndef from_datetime(x: Any) -> datetime:\n return dateutil.parser.parse(from_str(x))\n\n\ndef to_datetime(x: datetime) -> str:\n return x.isoformat()\n\n\ndef from_uuid(x: Any) -> UUID:\n return UUID(from_str(x))\n\n\ndef to_uuid(x: UUID) -> str:\n return str(x)\n\n\ndef parse_enum(c: type[EnumT], x: Any) -> EnumT:\n assert isinstance(x, str)\n return c(x)\n\n\ndef to_class(c: type[T], x: Any) -> dict:\n assert isinstance(x, c)\n return cast(Any, x).to_dict()\n\n\ndef to_enum(c: type[EnumT], x: Any) -> str:\n assert isinstance(x, c)\n return cast(str, x.value)\n\n\nclass SessionEventType(Enum):\n SESSION_START = \"session.start\"\n SESSION_RESUME = \"session.resume\"\n SESSION_REMOTE_STEERABLE_CHANGED = \"session.remote_steerable_changed\"\n SESSION_ERROR = \"session.error\"\n SESSION_IDLE = \"session.idle\"\n SESSION_TITLE_CHANGED = \"session.title_changed\"\n SESSION_INFO = \"session.info\"\n SESSION_WARNING = \"session.warning\"\n SESSION_MODEL_CHANGE = \"session.model_change\"\n SESSION_MODE_CHANGED = \"session.mode_changed\"\n SESSION_PLAN_CHANGED = \"session.plan_changed\"\n SESSION_WORKSPACE_FILE_CHANGED = \"session.workspace_file_changed\"\n SESSION_HANDOFF = \"session.handoff\"\n SESSION_TRUNCATION = \"session.truncation\"\n SESSION_SNAPSHOT_REWIND = \"session.snapshot_rewind\"\n SESSION_SHUTDOWN = \"session.shutdown\"\n SESSION_CONTEXT_CHANGED = \"session.context_changed\"\n SESSION_USAGE_INFO = \"session.usage_info\"\n SESSION_COMPACTION_START = \"session.compaction_start\"\n SESSION_COMPACTION_COMPLETE = \"session.compaction_complete\"\n SESSION_TASK_COMPLETE = \"session.task_complete\"\n USER_MESSAGE = \"user.message\"\n PENDING_MESSAGES_MODIFIED = \"pending_messages.modified\"\n ASSISTANT_TURN_START = \"assistant.turn_start\"\n ASSISTANT_INTENT = \"assistant.intent\"\n ASSISTANT_REASONING = \"assistant.reasoning\"\n ASSISTANT_REASONING_DELTA = \"assistant.reasoning_delta\"\n ASSISTANT_STREAMING_DELTA = \"assistant.streaming_delta\"\n ASSISTANT_MESSAGE = \"assistant.message\"\n ASSISTANT_MESSAGE_START = \"assistant.message_start\"\n ASSISTANT_MESSAGE_DELTA = \"assistant.message_delta\"\n ASSISTANT_TURN_END = \"assistant.turn_end\"\n ASSISTANT_USAGE = \"assistant.usage\"\n MODEL_CALL_FAILURE = \"model.call_failure\"\n ABORT = \"abort\"\n TOOL_USER_REQUESTED = \"tool.user_requested\"\n TOOL_EXECUTION_START = \"tool.execution_start\"\n TOOL_EXECUTION_PARTIAL_RESULT = \"tool.execution_partial_result\"\n TOOL_EXECUTION_PROGRESS = \"tool.execution_progress\"\n TOOL_EXECUTION_COMPLETE = \"tool.execution_complete\"\n SKILL_INVOKED = \"skill.invoked\"\n SUBAGENT_STARTED = \"subagent.started\"\n SUBAGENT_COMPLETED = \"subagent.completed\"\n SUBAGENT_FAILED = \"subagent.failed\"\n SUBAGENT_SELECTED = \"subagent.selected\"\n SUBAGENT_DESELECTED = \"subagent.deselected\"\n HOOK_START = \"hook.start\"\n HOOK_END = \"hook.end\"\n SYSTEM_MESSAGE = \"system.message\"\n SYSTEM_NOTIFICATION = \"system.notification\"\n PERMISSION_REQUESTED = \"permission.requested\"\n PERMISSION_COMPLETED = \"permission.completed\"\n USER_INPUT_REQUESTED = \"user_input.requested\"\n USER_INPUT_COMPLETED = \"user_input.completed\"\n ELICITATION_REQUESTED = \"elicitation.requested\"\n ELICITATION_COMPLETED = \"elicitation.completed\"\n SAMPLING_REQUESTED = \"sampling.requested\"\n SAMPLING_COMPLETED = \"sampling.completed\"\n MCP_OAUTH_REQUIRED = \"mcp.oauth_required\"\n MCP_OAUTH_COMPLETED = \"mcp.oauth_completed\"\n EXTERNAL_TOOL_REQUESTED = \"external_tool.requested\"\n EXTERNAL_TOOL_COMPLETED = \"external_tool.completed\"\n COMMAND_QUEUED = \"command.queued\"\n COMMAND_EXECUTE = \"command.execute\"\n COMMAND_COMPLETED = \"command.completed\"\n AUTO_MODE_SWITCH_REQUESTED = \"auto_mode_switch.requested\"\n AUTO_MODE_SWITCH_COMPLETED = \"auto_mode_switch.completed\"\n COMMANDS_CHANGED = \"commands.changed\"\n CAPABILITIES_CHANGED = \"capabilities.changed\"\n EXIT_PLAN_MODE_REQUESTED = \"exit_plan_mode.requested\"\n EXIT_PLAN_MODE_COMPLETED = \"exit_plan_mode.completed\"\n SESSION_TOOLS_UPDATED = \"session.tools_updated\"\n SESSION_BACKGROUND_TASKS_CHANGED = \"session.background_tasks_changed\"\n SESSION_SKILLS_LOADED = \"session.skills_loaded\"\n SESSION_CUSTOM_AGENTS_UPDATED = \"session.custom_agents_updated\"\n SESSION_MCP_SERVERS_LOADED = \"session.mcp_servers_loaded\"\n SESSION_MCP_SERVER_STATUS_CHANGED = \"session.mcp_server_status_changed\"\n SESSION_EXTENSIONS_LOADED = \"session.extensions_loaded\"\n UNKNOWN = \"unknown\"\n\n @classmethod\n def _missing_(cls, value: object) -> \"SessionEventType\":\n return cls.UNKNOWN\n\n\n@dataclass\nclass RawSessionEventData:\n raw: Any\n\n @staticmethod\n def from_dict(obj: Any) -> \"RawSessionEventData\":\n return RawSessionEventData(obj)\n\n def to_dict(self) -> Any:\n return self.raw\n\n\ndef _compat_to_python_key(name: str) -> str:\n normalized = name.replace(\".\", \"_\")\n result: list[str] = []\n for index, char in enumerate(normalized):\n if char.isupper() and index > 0 and (not normalized[index - 1].isupper() or (index + 1 < len(normalized) and normalized[index + 1].islower())):\n result.append(\"_\")\n result.append(char.lower())\n return \"\".join(result)\n\n\ndef _compat_to_json_key(name: str) -> str:\n parts = name.split(\"_\")\n if not parts:\n return name\n return parts[0] + \"\".join(part[:1].upper() + part[1:] for part in parts[1:])\n\n\ndef _compat_to_json_value(value: Any) -> Any:\n if hasattr(value, \"to_dict\"):\n return cast(Any, value).to_dict()\n if isinstance(value, Enum):\n return value.value\n if isinstance(value, datetime):\n return value.isoformat()\n if isinstance(value, UUID):\n return str(value)\n if isinstance(value, list):\n return [_compat_to_json_value(item) for item in value]\n if isinstance(value, dict):\n return {key: _compat_to_json_value(item) for key, item in value.items()}\n return value\n\n\ndef _compat_from_json_value(value: Any) -> Any:\n return value\n\n\nclass Data:\n \"\"\"Backward-compatible shim for manually constructed event payloads.\"\"\"\n\n def __init__(self, **kwargs: Any):\n self._values = {key: _compat_from_json_value(value) for key, value in kwargs.items()}\n for key, value in self._values.items():\n setattr(self, key, value)\n\n @staticmethod\n def from_dict(obj: Any) -> \"Data\":\n assert isinstance(obj, dict)\n return Data(**{_compat_to_python_key(key): _compat_from_json_value(value) for key, value in obj.items()})\n\n def to_dict(self) -> dict:\n return {_compat_to_json_key(key): _compat_to_json_value(value) for key, value in self._values.items() if value is not None}\n\n\n@dataclass\nclass AbortData:\n \"Turn abort information including the reason for termination\"\n reason: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"AbortData\":\n assert isinstance(obj, dict)\n reason = from_str(obj.get(\"reason\"))\n return AbortData(\n reason=reason,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"reason\"] = from_str(self.reason)\n return result\n\n\n@dataclass\nclass AssistantIntentData:\n \"Agent intent description for current activity or plan\"\n intent: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"AssistantIntentData\":\n assert isinstance(obj, dict)\n intent = from_str(obj.get(\"intent\"))\n return AssistantIntentData(\n intent=intent,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"intent\"] = from_str(self.intent)\n return result\n\n\n@dataclass\nclass AssistantMessageData:\n \"Assistant response containing text content, optional tool requests, and interaction metadata\"\n content: str\n message_id: str\n encrypted_content: str | None = None\n interaction_id: str | None = None\n output_tokens: float | None = None\n # Deprecated: this field is deprecated.\n parent_tool_call_id: str | None = None\n phase: str | None = None\n reasoning_opaque: str | None = None\n reasoning_text: str | None = None\n request_id: str | None = None\n tool_requests: list[AssistantMessageToolRequest] | None = None\n turn_id: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"AssistantMessageData\":\n assert isinstance(obj, dict)\n content = from_str(obj.get(\"content\"))\n message_id = from_str(obj.get(\"messageId\"))\n encrypted_content = from_union([from_none, from_str], obj.get(\"encryptedContent\"))\n interaction_id = from_union([from_none, from_str], obj.get(\"interactionId\"))\n output_tokens = from_union([from_none, from_float], obj.get(\"outputTokens\"))\n parent_tool_call_id = from_union([from_none, from_str], obj.get(\"parentToolCallId\"))\n phase = from_union([from_none, from_str], obj.get(\"phase\"))\n reasoning_opaque = from_union([from_none, from_str], obj.get(\"reasoningOpaque\"))\n reasoning_text = from_union([from_none, from_str], obj.get(\"reasoningText\"))\n request_id = from_union([from_none, from_str], obj.get(\"requestId\"))\n tool_requests = from_union([from_none, lambda x: from_list(AssistantMessageToolRequest.from_dict, x)], obj.get(\"toolRequests\"))\n turn_id = from_union([from_none, from_str], obj.get(\"turnId\"))\n return AssistantMessageData(\n content=content,\n message_id=message_id,\n encrypted_content=encrypted_content,\n interaction_id=interaction_id,\n output_tokens=output_tokens,\n parent_tool_call_id=parent_tool_call_id,\n phase=phase,\n reasoning_opaque=reasoning_opaque,\n reasoning_text=reasoning_text,\n request_id=request_id,\n tool_requests=tool_requests,\n turn_id=turn_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"content\"] = from_str(self.content)\n result[\"messageId\"] = from_str(self.message_id)\n if self.encrypted_content is not None:\n result[\"encryptedContent\"] = from_union([from_none, from_str], self.encrypted_content)\n if self.interaction_id is not None:\n result[\"interactionId\"] = from_union([from_none, from_str], self.interaction_id)\n if self.output_tokens is not None:\n result[\"outputTokens\"] = from_union([from_none, to_float], self.output_tokens)\n if self.parent_tool_call_id is not None:\n result[\"parentToolCallId\"] = from_union([from_none, from_str], self.parent_tool_call_id)\n if self.phase is not None:\n result[\"phase\"] = from_union([from_none, from_str], self.phase)\n if self.reasoning_opaque is not None:\n result[\"reasoningOpaque\"] = from_union([from_none, from_str], self.reasoning_opaque)\n if self.reasoning_text is not None:\n result[\"reasoningText\"] = from_union([from_none, from_str], self.reasoning_text)\n if self.request_id is not None:\n result[\"requestId\"] = from_union([from_none, from_str], self.request_id)\n if self.tool_requests is not None:\n result[\"toolRequests\"] = from_union([from_none, lambda x: from_list(lambda x: to_class(AssistantMessageToolRequest, x), x)], self.tool_requests)\n if self.turn_id is not None:\n result[\"turnId\"] = from_union([from_none, from_str], self.turn_id)\n return result\n\n\n@dataclass\nclass AssistantMessageDeltaData:\n \"Streaming assistant message delta for incremental response updates\"\n delta_content: str\n message_id: str\n # Deprecated: this field is deprecated.\n parent_tool_call_id: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"AssistantMessageDeltaData\":\n assert isinstance(obj, dict)\n delta_content = from_str(obj.get(\"deltaContent\"))\n message_id = from_str(obj.get(\"messageId\"))\n parent_tool_call_id = from_union([from_none, from_str], obj.get(\"parentToolCallId\"))\n return AssistantMessageDeltaData(\n delta_content=delta_content,\n message_id=message_id,\n parent_tool_call_id=parent_tool_call_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"deltaContent\"] = from_str(self.delta_content)\n result[\"messageId\"] = from_str(self.message_id)\n if self.parent_tool_call_id is not None:\n result[\"parentToolCallId\"] = from_union([from_none, from_str], self.parent_tool_call_id)\n return result\n\n\n@dataclass\nclass AssistantMessageStartData:\n \"Streaming assistant message start metadata\"\n message_id: str\n phase: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"AssistantMessageStartData\":\n assert isinstance(obj, dict)\n message_id = from_str(obj.get(\"messageId\"))\n phase = from_union([from_none, from_str], obj.get(\"phase\"))\n return AssistantMessageStartData(\n message_id=message_id,\n phase=phase,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"messageId\"] = from_str(self.message_id)\n if self.phase is not None:\n result[\"phase\"] = from_union([from_none, from_str], self.phase)\n return result\n\n\n@dataclass\nclass AssistantMessageToolRequest:\n \"A tool invocation request from the assistant\"\n name: str\n tool_call_id: str\n arguments: Any = None\n intention_summary: str | None = None\n mcp_server_name: str | None = None\n tool_title: str | None = None\n type: AssistantMessageToolRequestType | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"AssistantMessageToolRequest\":\n assert isinstance(obj, dict)\n name = from_str(obj.get(\"name\"))\n tool_call_id = from_str(obj.get(\"toolCallId\"))\n arguments = obj.get(\"arguments\")\n intention_summary = from_union([from_none, from_str], obj.get(\"intentionSummary\"))\n mcp_server_name = from_union([from_none, from_str], obj.get(\"mcpServerName\"))\n tool_title = from_union([from_none, from_str], obj.get(\"toolTitle\"))\n type = from_union([from_none, lambda x: parse_enum(AssistantMessageToolRequestType, x)], obj.get(\"type\"))\n return AssistantMessageToolRequest(\n name=name,\n tool_call_id=tool_call_id,\n arguments=arguments,\n intention_summary=intention_summary,\n mcp_server_name=mcp_server_name,\n tool_title=tool_title,\n type=type,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"name\"] = from_str(self.name)\n result[\"toolCallId\"] = from_str(self.tool_call_id)\n if self.arguments is not None:\n result[\"arguments\"] = self.arguments\n if self.intention_summary is not None:\n result[\"intentionSummary\"] = from_union([from_none, from_str], self.intention_summary)\n if self.mcp_server_name is not None:\n result[\"mcpServerName\"] = from_union([from_none, from_str], self.mcp_server_name)\n if self.tool_title is not None:\n result[\"toolTitle\"] = from_union([from_none, from_str], self.tool_title)\n if self.type is not None:\n result[\"type\"] = from_union([from_none, lambda x: to_enum(AssistantMessageToolRequestType, x)], self.type)\n return result\n\n\n@dataclass\nclass AssistantReasoningData:\n \"Assistant reasoning content for timeline display with complete thinking text\"\n content: str\n reasoning_id: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"AssistantReasoningData\":\n assert isinstance(obj, dict)\n content = from_str(obj.get(\"content\"))\n reasoning_id = from_str(obj.get(\"reasoningId\"))\n return AssistantReasoningData(\n content=content,\n reasoning_id=reasoning_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"content\"] = from_str(self.content)\n result[\"reasoningId\"] = from_str(self.reasoning_id)\n return result\n\n\n@dataclass\nclass AssistantReasoningDeltaData:\n \"Streaming reasoning delta for incremental extended thinking updates\"\n delta_content: str\n reasoning_id: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"AssistantReasoningDeltaData\":\n assert isinstance(obj, dict)\n delta_content = from_str(obj.get(\"deltaContent\"))\n reasoning_id = from_str(obj.get(\"reasoningId\"))\n return AssistantReasoningDeltaData(\n delta_content=delta_content,\n reasoning_id=reasoning_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"deltaContent\"] = from_str(self.delta_content)\n result[\"reasoningId\"] = from_str(self.reasoning_id)\n return result\n\n\n@dataclass\nclass AssistantStreamingDeltaData:\n \"Streaming response progress with cumulative byte count\"\n total_response_size_bytes: float\n\n @staticmethod\n def from_dict(obj: Any) -> \"AssistantStreamingDeltaData\":\n assert isinstance(obj, dict)\n total_response_size_bytes = from_float(obj.get(\"totalResponseSizeBytes\"))\n return AssistantStreamingDeltaData(\n total_response_size_bytes=total_response_size_bytes,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"totalResponseSizeBytes\"] = to_float(self.total_response_size_bytes)\n return result\n\n\n@dataclass\nclass AssistantTurnEndData:\n \"Turn completion metadata including the turn identifier\"\n turn_id: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"AssistantTurnEndData\":\n assert isinstance(obj, dict)\n turn_id = from_str(obj.get(\"turnId\"))\n return AssistantTurnEndData(\n turn_id=turn_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"turnId\"] = from_str(self.turn_id)\n return result\n\n\n@dataclass\nclass AssistantTurnStartData:\n \"Turn initialization metadata including identifier and interaction tracking\"\n turn_id: str\n interaction_id: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"AssistantTurnStartData\":\n assert isinstance(obj, dict)\n turn_id = from_str(obj.get(\"turnId\"))\n interaction_id = from_union([from_none, from_str], obj.get(\"interactionId\"))\n return AssistantTurnStartData(\n turn_id=turn_id,\n interaction_id=interaction_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"turnId\"] = from_str(self.turn_id)\n if self.interaction_id is not None:\n result[\"interactionId\"] = from_union([from_none, from_str], self.interaction_id)\n return result\n\n\n@dataclass\nclass AssistantUsageCopilotUsage:\n \"Per-request cost and usage data from the CAPI copilot_usage response field\"\n token_details: list[AssistantUsageCopilotUsageTokenDetail]\n total_nano_aiu: float\n\n @staticmethod\n def from_dict(obj: Any) -> \"AssistantUsageCopilotUsage\":\n assert isinstance(obj, dict)\n token_details = from_list(AssistantUsageCopilotUsageTokenDetail.from_dict, obj.get(\"tokenDetails\"))\n total_nano_aiu = from_float(obj.get(\"totalNanoAiu\"))\n return AssistantUsageCopilotUsage(\n token_details=token_details,\n total_nano_aiu=total_nano_aiu,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"tokenDetails\"] = from_list(lambda x: to_class(AssistantUsageCopilotUsageTokenDetail, x), self.token_details)\n result[\"totalNanoAiu\"] = to_float(self.total_nano_aiu)\n return result\n\n\n@dataclass\nclass AssistantUsageCopilotUsageTokenDetail:\n \"Token usage detail for a single billing category\"\n batch_size: float\n cost_per_batch: float\n token_count: float\n token_type: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"AssistantUsageCopilotUsageTokenDetail\":\n assert isinstance(obj, dict)\n batch_size = from_float(obj.get(\"batchSize\"))\n cost_per_batch = from_float(obj.get(\"costPerBatch\"))\n token_count = from_float(obj.get(\"tokenCount\"))\n token_type = from_str(obj.get(\"tokenType\"))\n return AssistantUsageCopilotUsageTokenDetail(\n batch_size=batch_size,\n cost_per_batch=cost_per_batch,\n token_count=token_count,\n token_type=token_type,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"batchSize\"] = to_float(self.batch_size)\n result[\"costPerBatch\"] = to_float(self.cost_per_batch)\n result[\"tokenCount\"] = to_float(self.token_count)\n result[\"tokenType\"] = from_str(self.token_type)\n return result\n\n\n@dataclass\nclass AssistantUsageData:\n \"LLM API call usage metrics including tokens, costs, quotas, and billing information\"\n model: str\n api_call_id: str | None = None\n cache_read_tokens: float | None = None\n cache_write_tokens: float | None = None\n copilot_usage: AssistantUsageCopilotUsage | None = None\n cost: float | None = None\n duration: float | None = None\n initiator: str | None = None\n input_tokens: float | None = None\n inter_token_latency_ms: float | None = None\n output_tokens: float | None = None\n # Deprecated: this field is deprecated.\n parent_tool_call_id: str | None = None\n provider_call_id: str | None = None\n quota_snapshots: dict[str, AssistantUsageQuotaSnapshot] | None = None\n reasoning_effort: str | None = None\n reasoning_tokens: float | None = None\n ttft_ms: float | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"AssistantUsageData\":\n assert isinstance(obj, dict)\n model = from_str(obj.get(\"model\"))\n api_call_id = from_union([from_none, from_str], obj.get(\"apiCallId\"))\n cache_read_tokens = from_union([from_none, from_float], obj.get(\"cacheReadTokens\"))\n cache_write_tokens = from_union([from_none, from_float], obj.get(\"cacheWriteTokens\"))\n copilot_usage = from_union([from_none, AssistantUsageCopilotUsage.from_dict], obj.get(\"copilotUsage\"))\n cost = from_union([from_none, from_float], obj.get(\"cost\"))\n duration = from_union([from_none, from_float], obj.get(\"duration\"))\n initiator = from_union([from_none, from_str], obj.get(\"initiator\"))\n input_tokens = from_union([from_none, from_float], obj.get(\"inputTokens\"))\n inter_token_latency_ms = from_union([from_none, from_float], obj.get(\"interTokenLatencyMs\"))\n output_tokens = from_union([from_none, from_float], obj.get(\"outputTokens\"))\n parent_tool_call_id = from_union([from_none, from_str], obj.get(\"parentToolCallId\"))\n provider_call_id = from_union([from_none, from_str], obj.get(\"providerCallId\"))\n quota_snapshots = from_union([from_none, lambda x: from_dict(AssistantUsageQuotaSnapshot.from_dict, x)], obj.get(\"quotaSnapshots\"))\n reasoning_effort = from_union([from_none, from_str], obj.get(\"reasoningEffort\"))\n reasoning_tokens = from_union([from_none, from_float], obj.get(\"reasoningTokens\"))\n ttft_ms = from_union([from_none, from_float], obj.get(\"ttftMs\"))\n return AssistantUsageData(\n model=model,\n api_call_id=api_call_id,\n cache_read_tokens=cache_read_tokens,\n cache_write_tokens=cache_write_tokens,\n copilot_usage=copilot_usage,\n cost=cost,\n duration=duration,\n initiator=initiator,\n input_tokens=input_tokens,\n inter_token_latency_ms=inter_token_latency_ms,\n output_tokens=output_tokens,\n parent_tool_call_id=parent_tool_call_id,\n provider_call_id=provider_call_id,\n quota_snapshots=quota_snapshots,\n reasoning_effort=reasoning_effort,\n reasoning_tokens=reasoning_tokens,\n ttft_ms=ttft_ms,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"model\"] = from_str(self.model)\n if self.api_call_id is not None:\n result[\"apiCallId\"] = from_union([from_none, from_str], self.api_call_id)\n if self.cache_read_tokens is not None:\n result[\"cacheReadTokens\"] = from_union([from_none, to_float], self.cache_read_tokens)\n if self.cache_write_tokens is not None:\n result[\"cacheWriteTokens\"] = from_union([from_none, to_float], self.cache_write_tokens)\n if self.copilot_usage is not None:\n result[\"copilotUsage\"] = from_union([from_none, lambda x: to_class(AssistantUsageCopilotUsage, x)], self.copilot_usage)\n if self.cost is not None:\n result[\"cost\"] = from_union([from_none, to_float], self.cost)\n if self.duration is not None:\n result[\"duration\"] = from_union([from_none, to_float], self.duration)\n if self.initiator is not None:\n result[\"initiator\"] = from_union([from_none, from_str], self.initiator)\n if self.input_tokens is not None:\n result[\"inputTokens\"] = from_union([from_none, to_float], self.input_tokens)\n if self.inter_token_latency_ms is not None:\n result[\"interTokenLatencyMs\"] = from_union([from_none, to_float], self.inter_token_latency_ms)\n if self.output_tokens is not None:\n result[\"outputTokens\"] = from_union([from_none, to_float], self.output_tokens)\n if self.parent_tool_call_id is not None:\n result[\"parentToolCallId\"] = from_union([from_none, from_str], self.parent_tool_call_id)\n if self.provider_call_id is not None:\n result[\"providerCallId\"] = from_union([from_none, from_str], self.provider_call_id)\n if self.quota_snapshots is not None:\n result[\"quotaSnapshots\"] = from_union([from_none, lambda x: from_dict(lambda x: to_class(AssistantUsageQuotaSnapshot, x), x)], self.quota_snapshots)\n if self.reasoning_effort is not None:\n result[\"reasoningEffort\"] = from_union([from_none, from_str], self.reasoning_effort)\n if self.reasoning_tokens is not None:\n result[\"reasoningTokens\"] = from_union([from_none, to_float], self.reasoning_tokens)\n if self.ttft_ms is not None:\n result[\"ttftMs\"] = from_union([from_none, to_float], self.ttft_ms)\n return result\n\n\n@dataclass\nclass AssistantUsageQuotaSnapshot:\n entitlement_requests: float\n is_unlimited_entitlement: bool\n overage: float\n overage_allowed_with_exhausted_quota: bool\n remaining_percentage: float\n usage_allowed_with_exhausted_quota: bool\n used_requests: float\n reset_date: datetime | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"AssistantUsageQuotaSnapshot\":\n assert isinstance(obj, dict)\n entitlement_requests = from_float(obj.get(\"entitlementRequests\"))\n is_unlimited_entitlement = from_bool(obj.get(\"isUnlimitedEntitlement\"))\n overage = from_float(obj.get(\"overage\"))\n overage_allowed_with_exhausted_quota = from_bool(obj.get(\"overageAllowedWithExhaustedQuota\"))\n remaining_percentage = from_float(obj.get(\"remainingPercentage\"))\n usage_allowed_with_exhausted_quota = from_bool(obj.get(\"usageAllowedWithExhaustedQuota\"))\n used_requests = from_float(obj.get(\"usedRequests\"))\n reset_date = from_union([from_none, from_datetime], obj.get(\"resetDate\"))\n return AssistantUsageQuotaSnapshot(\n entitlement_requests=entitlement_requests,\n is_unlimited_entitlement=is_unlimited_entitlement,\n overage=overage,\n overage_allowed_with_exhausted_quota=overage_allowed_with_exhausted_quota,\n remaining_percentage=remaining_percentage,\n usage_allowed_with_exhausted_quota=usage_allowed_with_exhausted_quota,\n used_requests=used_requests,\n reset_date=reset_date,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"entitlementRequests\"] = to_float(self.entitlement_requests)\n result[\"isUnlimitedEntitlement\"] = from_bool(self.is_unlimited_entitlement)\n result[\"overage\"] = to_float(self.overage)\n result[\"overageAllowedWithExhaustedQuota\"] = from_bool(self.overage_allowed_with_exhausted_quota)\n result[\"remainingPercentage\"] = to_float(self.remaining_percentage)\n result[\"usageAllowedWithExhaustedQuota\"] = from_bool(self.usage_allowed_with_exhausted_quota)\n result[\"usedRequests\"] = to_float(self.used_requests)\n if self.reset_date is not None:\n result[\"resetDate\"] = from_union([from_none, to_datetime], self.reset_date)\n return result\n\n\n@dataclass\nclass AutoModeSwitchCompletedData:\n \"Auto mode switch completion notification\"\n request_id: str\n response: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"AutoModeSwitchCompletedData\":\n assert isinstance(obj, dict)\n request_id = from_str(obj.get(\"requestId\"))\n response = from_str(obj.get(\"response\"))\n return AutoModeSwitchCompletedData(\n request_id=request_id,\n response=response,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"requestId\"] = from_str(self.request_id)\n result[\"response\"] = from_str(self.response)\n return result\n\n\n@dataclass\nclass AutoModeSwitchRequestedData:\n \"Auto mode switch request notification requiring user approval\"\n request_id: str\n error_code: str | None = None\n retry_after_seconds: float | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"AutoModeSwitchRequestedData\":\n assert isinstance(obj, dict)\n request_id = from_str(obj.get(\"requestId\"))\n error_code = from_union([from_none, from_str], obj.get(\"errorCode\"))\n retry_after_seconds = from_union([from_none, from_float], obj.get(\"retryAfterSeconds\"))\n return AutoModeSwitchRequestedData(\n request_id=request_id,\n error_code=error_code,\n retry_after_seconds=retry_after_seconds,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"requestId\"] = from_str(self.request_id)\n if self.error_code is not None:\n result[\"errorCode\"] = from_union([from_none, from_str], self.error_code)\n if self.retry_after_seconds is not None:\n result[\"retryAfterSeconds\"] = from_union([from_none, to_float], self.retry_after_seconds)\n return result\n\n\n@dataclass\nclass CapabilitiesChangedData:\n \"Session capability change notification\"\n ui: CapabilitiesChangedUI | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"CapabilitiesChangedData\":\n assert isinstance(obj, dict)\n ui = from_union([from_none, CapabilitiesChangedUI.from_dict], obj.get(\"ui\"))\n return CapabilitiesChangedData(\n ui=ui,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.ui is not None:\n result[\"ui\"] = from_union([from_none, lambda x: to_class(CapabilitiesChangedUI, x)], self.ui)\n return result\n\n\n@dataclass\nclass CapabilitiesChangedUI:\n \"UI capability changes\"\n elicitation: bool | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"CapabilitiesChangedUI\":\n assert isinstance(obj, dict)\n elicitation = from_union([from_none, from_bool], obj.get(\"elicitation\"))\n return CapabilitiesChangedUI(\n elicitation=elicitation,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.elicitation is not None:\n result[\"elicitation\"] = from_union([from_none, from_bool], self.elicitation)\n return result\n\n\n@dataclass\nclass CommandCompletedData:\n \"Queued command completion notification signaling UI dismissal\"\n request_id: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"CommandCompletedData\":\n assert isinstance(obj, dict)\n request_id = from_str(obj.get(\"requestId\"))\n return CommandCompletedData(\n request_id=request_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"requestId\"] = from_str(self.request_id)\n return result\n\n\n@dataclass\nclass CommandExecuteData:\n \"Registered command dispatch request routed to the owning client\"\n args: str\n command: str\n command_name: str\n request_id: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"CommandExecuteData\":\n assert isinstance(obj, dict)\n args = from_str(obj.get(\"args\"))\n command = from_str(obj.get(\"command\"))\n command_name = from_str(obj.get(\"commandName\"))\n request_id = from_str(obj.get(\"requestId\"))\n return CommandExecuteData(\n args=args,\n command=command,\n command_name=command_name,\n request_id=request_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"args\"] = from_str(self.args)\n result[\"command\"] = from_str(self.command)\n result[\"commandName\"] = from_str(self.command_name)\n result[\"requestId\"] = from_str(self.request_id)\n return result\n\n\n@dataclass\nclass CommandQueuedData:\n \"Queued slash command dispatch request for client execution\"\n command: str\n request_id: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"CommandQueuedData\":\n assert isinstance(obj, dict)\n command = from_str(obj.get(\"command\"))\n request_id = from_str(obj.get(\"requestId\"))\n return CommandQueuedData(\n command=command,\n request_id=request_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"command\"] = from_str(self.command)\n result[\"requestId\"] = from_str(self.request_id)\n return result\n\n\n@dataclass\nclass CommandsChangedCommand:\n name: str\n description: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"CommandsChangedCommand\":\n assert isinstance(obj, dict)\n name = from_str(obj.get(\"name\"))\n description = from_union([from_none, from_str], obj.get(\"description\"))\n return CommandsChangedCommand(\n name=name,\n description=description,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"name\"] = from_str(self.name)\n if self.description is not None:\n result[\"description\"] = from_union([from_none, from_str], self.description)\n return result\n\n\n@dataclass\nclass CommandsChangedData:\n \"SDK command registration change notification\"\n commands: list[CommandsChangedCommand]\n\n @staticmethod\n def from_dict(obj: Any) -> \"CommandsChangedData\":\n assert isinstance(obj, dict)\n commands = from_list(CommandsChangedCommand.from_dict, obj.get(\"commands\"))\n return CommandsChangedData(\n commands=commands,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"commands\"] = from_list(lambda x: to_class(CommandsChangedCommand, x), self.commands)\n return result\n\n\n@dataclass\nclass CompactionCompleteCompactionTokensUsed:\n \"Token usage breakdown for the compaction LLM call (aligned with assistant.usage format)\"\n cache_read_tokens: float | None = None\n cache_write_tokens: float | None = None\n copilot_usage: CompactionCompleteCompactionTokensUsedCopilotUsage | None = None\n duration: float | None = None\n input_tokens: float | None = None\n model: str | None = None\n output_tokens: float | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"CompactionCompleteCompactionTokensUsed\":\n assert isinstance(obj, dict)\n cache_read_tokens = from_union([from_none, from_float], obj.get(\"cacheReadTokens\"))\n cache_write_tokens = from_union([from_none, from_float], obj.get(\"cacheWriteTokens\"))\n copilot_usage = from_union([from_none, CompactionCompleteCompactionTokensUsedCopilotUsage.from_dict], obj.get(\"copilotUsage\"))\n duration = from_union([from_none, from_float], obj.get(\"duration\"))\n input_tokens = from_union([from_none, from_float], obj.get(\"inputTokens\"))\n model = from_union([from_none, from_str], obj.get(\"model\"))\n output_tokens = from_union([from_none, from_float], obj.get(\"outputTokens\"))\n return CompactionCompleteCompactionTokensUsed(\n cache_read_tokens=cache_read_tokens,\n cache_write_tokens=cache_write_tokens,\n copilot_usage=copilot_usage,\n duration=duration,\n input_tokens=input_tokens,\n model=model,\n output_tokens=output_tokens,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.cache_read_tokens is not None:\n result[\"cacheReadTokens\"] = from_union([from_none, to_float], self.cache_read_tokens)\n if self.cache_write_tokens is not None:\n result[\"cacheWriteTokens\"] = from_union([from_none, to_float], self.cache_write_tokens)\n if self.copilot_usage is not None:\n result[\"copilotUsage\"] = from_union([from_none, lambda x: to_class(CompactionCompleteCompactionTokensUsedCopilotUsage, x)], self.copilot_usage)\n if self.duration is not None:\n result[\"duration\"] = from_union([from_none, to_float], self.duration)\n if self.input_tokens is not None:\n result[\"inputTokens\"] = from_union([from_none, to_float], self.input_tokens)\n if self.model is not None:\n result[\"model\"] = from_union([from_none, from_str], self.model)\n if self.output_tokens is not None:\n result[\"outputTokens\"] = from_union([from_none, to_float], self.output_tokens)\n return result\n\n\n@dataclass\nclass CompactionCompleteCompactionTokensUsedCopilotUsage:\n \"Per-request cost and usage data from the CAPI copilot_usage response field\"\n token_details: list[CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail]\n total_nano_aiu: float\n\n @staticmethod\n def from_dict(obj: Any) -> \"CompactionCompleteCompactionTokensUsedCopilotUsage\":\n assert isinstance(obj, dict)\n token_details = from_list(CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail.from_dict, obj.get(\"tokenDetails\"))\n total_nano_aiu = from_float(obj.get(\"totalNanoAiu\"))\n return CompactionCompleteCompactionTokensUsedCopilotUsage(\n token_details=token_details,\n total_nano_aiu=total_nano_aiu,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"tokenDetails\"] = from_list(lambda x: to_class(CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail, x), self.token_details)\n result[\"totalNanoAiu\"] = to_float(self.total_nano_aiu)\n return result\n\n\n@dataclass\nclass CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail:\n \"Token usage detail for a single billing category\"\n batch_size: float\n cost_per_batch: float\n token_count: float\n token_type: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail\":\n assert isinstance(obj, dict)\n batch_size = from_float(obj.get(\"batchSize\"))\n cost_per_batch = from_float(obj.get(\"costPerBatch\"))\n token_count = from_float(obj.get(\"tokenCount\"))\n token_type = from_str(obj.get(\"tokenType\"))\n return CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail(\n batch_size=batch_size,\n cost_per_batch=cost_per_batch,\n token_count=token_count,\n token_type=token_type,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"batchSize\"] = to_float(self.batch_size)\n result[\"costPerBatch\"] = to_float(self.cost_per_batch)\n result[\"tokenCount\"] = to_float(self.token_count)\n result[\"tokenType\"] = from_str(self.token_type)\n return result\n\n\n@dataclass\nclass CustomAgentsUpdatedAgent:\n description: str\n display_name: str\n id: str\n name: str\n source: str\n tools: list[str]\n user_invocable: bool\n model: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"CustomAgentsUpdatedAgent\":\n assert isinstance(obj, dict)\n description = from_str(obj.get(\"description\"))\n display_name = from_str(obj.get(\"displayName\"))\n id = from_str(obj.get(\"id\"))\n name = from_str(obj.get(\"name\"))\n source = from_str(obj.get(\"source\"))\n tools = from_list(from_str, obj.get(\"tools\"))\n user_invocable = from_bool(obj.get(\"userInvocable\"))\n model = from_union([from_none, from_str], obj.get(\"model\"))\n return CustomAgentsUpdatedAgent(\n description=description,\n display_name=display_name,\n id=id,\n name=name,\n source=source,\n tools=tools,\n user_invocable=user_invocable,\n model=model,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"description\"] = from_str(self.description)\n result[\"displayName\"] = from_str(self.display_name)\n result[\"id\"] = from_str(self.id)\n result[\"name\"] = from_str(self.name)\n result[\"source\"] = from_str(self.source)\n result[\"tools\"] = from_list(from_str, self.tools)\n result[\"userInvocable\"] = from_bool(self.user_invocable)\n if self.model is not None:\n result[\"model\"] = from_union([from_none, from_str], self.model)\n return result\n\n\n@dataclass\nclass ElicitationCompletedData:\n \"Elicitation request completion with the user's response\"\n request_id: str\n action: ElicitationCompletedAction | None = None\n content: dict[str, Any] | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"ElicitationCompletedData\":\n assert isinstance(obj, dict)\n request_id = from_str(obj.get(\"requestId\"))\n action = from_union([from_none, lambda x: parse_enum(ElicitationCompletedAction, x)], obj.get(\"action\"))\n content = from_union([from_none, lambda x: from_dict(lambda x: x, x)], obj.get(\"content\"))\n return ElicitationCompletedData(\n request_id=request_id,\n action=action,\n content=content,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"requestId\"] = from_str(self.request_id)\n if self.action is not None:\n result[\"action\"] = from_union([from_none, lambda x: to_enum(ElicitationCompletedAction, x)], self.action)\n if self.content is not None:\n result[\"content\"] = from_union([from_none, lambda x: from_dict(lambda x: x, x)], self.content)\n return result\n\n\n@dataclass\nclass ElicitationRequestedData:\n \"Elicitation request; may be form-based (structured input) or URL-based (browser redirect)\"\n message: str\n request_id: str\n elicitation_source: str | None = None\n mode: ElicitationRequestedMode | None = None\n requested_schema: ElicitationRequestedSchema | None = None\n tool_call_id: str | None = None\n url: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"ElicitationRequestedData\":\n assert isinstance(obj, dict)\n message = from_str(obj.get(\"message\"))\n request_id = from_str(obj.get(\"requestId\"))\n elicitation_source = from_union([from_none, from_str], obj.get(\"elicitationSource\"))\n mode = from_union([from_none, lambda x: parse_enum(ElicitationRequestedMode, x)], obj.get(\"mode\"))\n requested_schema = from_union([from_none, ElicitationRequestedSchema.from_dict], obj.get(\"requestedSchema\"))\n tool_call_id = from_union([from_none, from_str], obj.get(\"toolCallId\"))\n url = from_union([from_none, from_str], obj.get(\"url\"))\n return ElicitationRequestedData(\n message=message,\n request_id=request_id,\n elicitation_source=elicitation_source,\n mode=mode,\n requested_schema=requested_schema,\n tool_call_id=tool_call_id,\n url=url,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"message\"] = from_str(self.message)\n result[\"requestId\"] = from_str(self.request_id)\n if self.elicitation_source is not None:\n result[\"elicitationSource\"] = from_union([from_none, from_str], self.elicitation_source)\n if self.mode is not None:\n result[\"mode\"] = from_union([from_none, lambda x: to_enum(ElicitationRequestedMode, x)], self.mode)\n if self.requested_schema is not None:\n result[\"requestedSchema\"] = from_union([from_none, lambda x: to_class(ElicitationRequestedSchema, x)], self.requested_schema)\n if self.tool_call_id is not None:\n result[\"toolCallId\"] = from_union([from_none, from_str], self.tool_call_id)\n if self.url is not None:\n result[\"url\"] = from_union([from_none, from_str], self.url)\n return result\n\n\n@dataclass\nclass ElicitationRequestedSchema:\n \"JSON Schema describing the form fields to present to the user (form mode only)\"\n properties: dict[str, Any]\n type: str\n required: list[str] | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"ElicitationRequestedSchema\":\n assert isinstance(obj, dict)\n properties = from_dict(lambda x: x, obj.get(\"properties\"))\n type = from_str(obj.get(\"type\"))\n required = from_union([from_none, lambda x: from_list(from_str, x)], obj.get(\"required\"))\n return ElicitationRequestedSchema(\n properties=properties,\n type=type,\n required=required,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"properties\"] = from_dict(lambda x: x, self.properties)\n result[\"type\"] = from_str(self.type)\n if self.required is not None:\n result[\"required\"] = from_union([from_none, lambda x: from_list(from_str, x)], self.required)\n return result\n\n\n@dataclass\nclass ExitPlanModeCompletedData:\n \"Plan mode exit completion with the user's approval decision and optional feedback\"\n request_id: str\n approved: bool | None = None\n auto_approve_edits: bool | None = None\n feedback: str | None = None\n selected_action: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"ExitPlanModeCompletedData\":\n assert isinstance(obj, dict)\n request_id = from_str(obj.get(\"requestId\"))\n approved = from_union([from_none, from_bool], obj.get(\"approved\"))\n auto_approve_edits = from_union([from_none, from_bool], obj.get(\"autoApproveEdits\"))\n feedback = from_union([from_none, from_str], obj.get(\"feedback\"))\n selected_action = from_union([from_none, from_str], obj.get(\"selectedAction\"))\n return ExitPlanModeCompletedData(\n request_id=request_id,\n approved=approved,\n auto_approve_edits=auto_approve_edits,\n feedback=feedback,\n selected_action=selected_action,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"requestId\"] = from_str(self.request_id)\n if self.approved is not None:\n result[\"approved\"] = from_union([from_none, from_bool], self.approved)\n if self.auto_approve_edits is not None:\n result[\"autoApproveEdits\"] = from_union([from_none, from_bool], self.auto_approve_edits)\n if self.feedback is not None:\n result[\"feedback\"] = from_union([from_none, from_str], self.feedback)\n if self.selected_action is not None:\n result[\"selectedAction\"] = from_union([from_none, from_str], self.selected_action)\n return result\n\n\n@dataclass\nclass ExitPlanModeRequestedData:\n \"Plan approval request with plan content and available user actions\"\n actions: list[str]\n plan_content: str\n recommended_action: str\n request_id: str\n summary: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"ExitPlanModeRequestedData\":\n assert isinstance(obj, dict)\n actions = from_list(from_str, obj.get(\"actions\"))\n plan_content = from_str(obj.get(\"planContent\"))\n recommended_action = from_str(obj.get(\"recommendedAction\"))\n request_id = from_str(obj.get(\"requestId\"))\n summary = from_str(obj.get(\"summary\"))\n return ExitPlanModeRequestedData(\n actions=actions,\n plan_content=plan_content,\n recommended_action=recommended_action,\n request_id=request_id,\n summary=summary,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"actions\"] = from_list(from_str, self.actions)\n result[\"planContent\"] = from_str(self.plan_content)\n result[\"recommendedAction\"] = from_str(self.recommended_action)\n result[\"requestId\"] = from_str(self.request_id)\n result[\"summary\"] = from_str(self.summary)\n return result\n\n\n@dataclass\nclass ExtensionsLoadedExtension:\n id: str\n name: str\n source: ExtensionsLoadedExtensionSource\n status: ExtensionsLoadedExtensionStatus\n\n @staticmethod\n def from_dict(obj: Any) -> \"ExtensionsLoadedExtension\":\n assert isinstance(obj, dict)\n id = from_str(obj.get(\"id\"))\n name = from_str(obj.get(\"name\"))\n source = parse_enum(ExtensionsLoadedExtensionSource, obj.get(\"source\"))\n status = parse_enum(ExtensionsLoadedExtensionStatus, obj.get(\"status\"))\n return ExtensionsLoadedExtension(\n id=id,\n name=name,\n source=source,\n status=status,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"id\"] = from_str(self.id)\n result[\"name\"] = from_str(self.name)\n result[\"source\"] = to_enum(ExtensionsLoadedExtensionSource, self.source)\n result[\"status\"] = to_enum(ExtensionsLoadedExtensionStatus, self.status)\n return result\n\n\n@dataclass\nclass ExternalToolCompletedData:\n \"External tool completion notification signaling UI dismissal\"\n request_id: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"ExternalToolCompletedData\":\n assert isinstance(obj, dict)\n request_id = from_str(obj.get(\"requestId\"))\n return ExternalToolCompletedData(\n request_id=request_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"requestId\"] = from_str(self.request_id)\n return result\n\n\n@dataclass\nclass ExternalToolRequestedData:\n \"External tool invocation request for client-side tool execution\"\n request_id: str\n session_id: str\n tool_call_id: str\n tool_name: str\n arguments: Any = None\n traceparent: str | None = None\n tracestate: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"ExternalToolRequestedData\":\n assert isinstance(obj, dict)\n request_id = from_str(obj.get(\"requestId\"))\n session_id = from_str(obj.get(\"sessionId\"))\n tool_call_id = from_str(obj.get(\"toolCallId\"))\n tool_name = from_str(obj.get(\"toolName\"))\n arguments = obj.get(\"arguments\")\n traceparent = from_union([from_none, from_str], obj.get(\"traceparent\"))\n tracestate = from_union([from_none, from_str], obj.get(\"tracestate\"))\n return ExternalToolRequestedData(\n request_id=request_id,\n session_id=session_id,\n tool_call_id=tool_call_id,\n tool_name=tool_name,\n arguments=arguments,\n traceparent=traceparent,\n tracestate=tracestate,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"requestId\"] = from_str(self.request_id)\n result[\"sessionId\"] = from_str(self.session_id)\n result[\"toolCallId\"] = from_str(self.tool_call_id)\n result[\"toolName\"] = from_str(self.tool_name)\n if self.arguments is not None:\n result[\"arguments\"] = self.arguments\n if self.traceparent is not None:\n result[\"traceparent\"] = from_union([from_none, from_str], self.traceparent)\n if self.tracestate is not None:\n result[\"tracestate\"] = from_union([from_none, from_str], self.tracestate)\n return result\n\n\n@dataclass\nclass HandoffRepository:\n \"Repository context for the handed-off session\"\n name: str\n owner: str\n branch: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"HandoffRepository\":\n assert isinstance(obj, dict)\n name = from_str(obj.get(\"name\"))\n owner = from_str(obj.get(\"owner\"))\n branch = from_union([from_none, from_str], obj.get(\"branch\"))\n return HandoffRepository(\n name=name,\n owner=owner,\n branch=branch,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"name\"] = from_str(self.name)\n result[\"owner\"] = from_str(self.owner)\n if self.branch is not None:\n result[\"branch\"] = from_union([from_none, from_str], self.branch)\n return result\n\n\n@dataclass\nclass HookEndData:\n \"Hook invocation completion details including output, success status, and error information\"\n hook_invocation_id: str\n hook_type: str\n success: bool\n error: HookEndError | None = None\n output: Any = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"HookEndData\":\n assert isinstance(obj, dict)\n hook_invocation_id = from_str(obj.get(\"hookInvocationId\"))\n hook_type = from_str(obj.get(\"hookType\"))\n success = from_bool(obj.get(\"success\"))\n error = from_union([from_none, HookEndError.from_dict], obj.get(\"error\"))\n output = obj.get(\"output\")\n return HookEndData(\n hook_invocation_id=hook_invocation_id,\n hook_type=hook_type,\n success=success,\n error=error,\n output=output,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"hookInvocationId\"] = from_str(self.hook_invocation_id)\n result[\"hookType\"] = from_str(self.hook_type)\n result[\"success\"] = from_bool(self.success)\n if self.error is not None:\n result[\"error\"] = from_union([from_none, lambda x: to_class(HookEndError, x)], self.error)\n if self.output is not None:\n result[\"output\"] = self.output\n return result\n\n\n@dataclass\nclass HookEndError:\n \"Error details when the hook failed\"\n message: str\n stack: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"HookEndError\":\n assert isinstance(obj, dict)\n message = from_str(obj.get(\"message\"))\n stack = from_union([from_none, from_str], obj.get(\"stack\"))\n return HookEndError(\n message=message,\n stack=stack,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"message\"] = from_str(self.message)\n if self.stack is not None:\n result[\"stack\"] = from_union([from_none, from_str], self.stack)\n return result\n\n\n@dataclass\nclass HookStartData:\n \"Hook invocation start details including type and input data\"\n hook_invocation_id: str\n hook_type: str\n input: Any = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"HookStartData\":\n assert isinstance(obj, dict)\n hook_invocation_id = from_str(obj.get(\"hookInvocationId\"))\n hook_type = from_str(obj.get(\"hookType\"))\n input = obj.get(\"input\")\n return HookStartData(\n hook_invocation_id=hook_invocation_id,\n hook_type=hook_type,\n input=input,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"hookInvocationId\"] = from_str(self.hook_invocation_id)\n result[\"hookType\"] = from_str(self.hook_type)\n if self.input is not None:\n result[\"input\"] = self.input\n return result\n\n\n@dataclass\nclass McpOauthCompletedData:\n \"MCP OAuth request completion notification\"\n request_id: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"McpOauthCompletedData\":\n assert isinstance(obj, dict)\n request_id = from_str(obj.get(\"requestId\"))\n return McpOauthCompletedData(\n request_id=request_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"requestId\"] = from_str(self.request_id)\n return result\n\n\n@dataclass\nclass McpOauthRequiredData:\n \"OAuth authentication request for an MCP server\"\n request_id: str\n server_name: str\n server_url: str\n static_client_config: McpOauthRequiredStaticClientConfig | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"McpOauthRequiredData\":\n assert isinstance(obj, dict)\n request_id = from_str(obj.get(\"requestId\"))\n server_name = from_str(obj.get(\"serverName\"))\n server_url = from_str(obj.get(\"serverUrl\"))\n static_client_config = from_union([from_none, McpOauthRequiredStaticClientConfig.from_dict], obj.get(\"staticClientConfig\"))\n return McpOauthRequiredData(\n request_id=request_id,\n server_name=server_name,\n server_url=server_url,\n static_client_config=static_client_config,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"requestId\"] = from_str(self.request_id)\n result[\"serverName\"] = from_str(self.server_name)\n result[\"serverUrl\"] = from_str(self.server_url)\n if self.static_client_config is not None:\n result[\"staticClientConfig\"] = from_union([from_none, lambda x: to_class(McpOauthRequiredStaticClientConfig, x)], self.static_client_config)\n return result\n\n\n@dataclass\nclass McpOauthRequiredStaticClientConfig:\n \"Static OAuth client configuration, if the server specifies one\"\n client_id: str\n grant_type: str | None = None\n public_client: bool | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"McpOauthRequiredStaticClientConfig\":\n assert isinstance(obj, dict)\n client_id = from_str(obj.get(\"clientId\"))\n grant_type = from_union([from_none, from_str], obj.get(\"grantType\"))\n public_client = from_union([from_none, from_bool], obj.get(\"publicClient\"))\n return McpOauthRequiredStaticClientConfig(\n client_id=client_id,\n grant_type=grant_type,\n public_client=public_client,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"clientId\"] = from_str(self.client_id)\n if self.grant_type is not None:\n result[\"grantType\"] = from_union([from_none, from_str], self.grant_type)\n if self.public_client is not None:\n result[\"publicClient\"] = from_union([from_none, from_bool], self.public_client)\n return result\n\n\n@dataclass\nclass McpServersLoadedServer:\n name: str\n status: McpServersLoadedServerStatus\n error: str | None = None\n source: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"McpServersLoadedServer\":\n assert isinstance(obj, dict)\n name = from_str(obj.get(\"name\"))\n status = parse_enum(McpServersLoadedServerStatus, obj.get(\"status\"))\n error = from_union([from_none, from_str], obj.get(\"error\"))\n source = from_union([from_none, from_str], obj.get(\"source\"))\n return McpServersLoadedServer(\n name=name,\n status=status,\n error=error,\n source=source,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"name\"] = from_str(self.name)\n result[\"status\"] = to_enum(McpServersLoadedServerStatus, self.status)\n if self.error is not None:\n result[\"error\"] = from_union([from_none, from_str], self.error)\n if self.source is not None:\n result[\"source\"] = from_union([from_none, from_str], self.source)\n return result\n\n\n@dataclass\nclass ModelCallFailureData:\n \"Failed LLM API call metadata for telemetry\"\n source: ModelCallFailureSource\n api_call_id: str | None = None\n duration_ms: float | None = None\n error_message: str | None = None\n initiator: str | None = None\n model: str | None = None\n provider_call_id: str | None = None\n status_code: int | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"ModelCallFailureData\":\n assert isinstance(obj, dict)\n source = parse_enum(ModelCallFailureSource, obj.get(\"source\"))\n api_call_id = from_union([from_none, from_str], obj.get(\"apiCallId\"))\n duration_ms = from_union([from_none, from_float], obj.get(\"durationMs\"))\n error_message = from_union([from_none, from_str], obj.get(\"errorMessage\"))\n initiator = from_union([from_none, from_str], obj.get(\"initiator\"))\n model = from_union([from_none, from_str], obj.get(\"model\"))\n provider_call_id = from_union([from_none, from_str], obj.get(\"providerCallId\"))\n status_code = from_union([from_none, from_int], obj.get(\"statusCode\"))\n return ModelCallFailureData(\n source=source,\n api_call_id=api_call_id,\n duration_ms=duration_ms,\n error_message=error_message,\n initiator=initiator,\n model=model,\n provider_call_id=provider_call_id,\n status_code=status_code,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"source\"] = to_enum(ModelCallFailureSource, self.source)\n if self.api_call_id is not None:\n result[\"apiCallId\"] = from_union([from_none, from_str], self.api_call_id)\n if self.duration_ms is not None:\n result[\"durationMs\"] = from_union([from_none, to_float], self.duration_ms)\n if self.error_message is not None:\n result[\"errorMessage\"] = from_union([from_none, from_str], self.error_message)\n if self.initiator is not None:\n result[\"initiator\"] = from_union([from_none, from_str], self.initiator)\n if self.model is not None:\n result[\"model\"] = from_union([from_none, from_str], self.model)\n if self.provider_call_id is not None:\n result[\"providerCallId\"] = from_union([from_none, from_str], self.provider_call_id)\n if self.status_code is not None:\n result[\"statusCode\"] = from_union([from_none, to_int], self.status_code)\n return result\n\n\n@dataclass\nclass PendingMessagesModifiedData:\n \"Empty payload; the event signals that the pending message queue has changed\"\n @staticmethod\n def from_dict(obj: Any) -> \"PendingMessagesModifiedData\":\n assert isinstance(obj, dict)\n return PendingMessagesModifiedData()\n\n def to_dict(self) -> dict:\n return {}\n\n\n@dataclass\nclass PermissionCompletedData:\n \"Permission request completion notification signaling UI dismissal\"\n request_id: str\n result: PermissionResult\n tool_call_id: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"PermissionCompletedData\":\n assert isinstance(obj, dict)\n request_id = from_str(obj.get(\"requestId\"))\n result = PermissionResult.from_dict(obj.get(\"result\"))\n tool_call_id = from_union([from_none, from_str], obj.get(\"toolCallId\"))\n return PermissionCompletedData(\n request_id=request_id,\n result=result,\n tool_call_id=tool_call_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"requestId\"] = from_str(self.request_id)\n result[\"result\"] = to_class(PermissionResult, self.result)\n if self.tool_call_id is not None:\n result[\"toolCallId\"] = from_union([from_none, from_str], self.tool_call_id)\n return result\n\n\n@dataclass\nclass PermissionPromptRequest:\n \"Derived user-facing permission prompt details for UI consumers\"\n kind: PermissionPromptRequestKind\n access_kind: PermissionPromptRequestPathAccessKind | None = None\n action: PermissionPromptRequestMemoryAction | None = None\n args: Any | None = None\n can_offer_session_approval: bool | None = None\n citations: str | None = None\n command_identifiers: list[str] | None = None\n diff: str | None = None\n direction: PermissionPromptRequestMemoryDirection | None = None\n fact: str | None = None\n file_name: str | None = None\n full_command_text: str | None = None\n hook_message: str | None = None\n intention: str | None = None\n new_file_contents: str | None = None\n path: str | None = None\n paths: list[str] | None = None\n reason: str | None = None\n server_name: str | None = None\n subject: str | None = None\n tool_args: Any = None\n tool_call_id: str | None = None\n tool_description: str | None = None\n tool_name: str | None = None\n tool_title: str | None = None\n url: str | None = None\n warning: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"PermissionPromptRequest\":\n assert isinstance(obj, dict)\n kind = parse_enum(PermissionPromptRequestKind, obj.get(\"kind\"))\n access_kind = from_union([from_none, lambda x: parse_enum(PermissionPromptRequestPathAccessKind, x)], obj.get(\"accessKind\"))\n action = from_union([from_none, lambda x: parse_enum(PermissionPromptRequestMemoryAction, x)], obj.get(\"action\", \"store\"))\n args = from_union([from_none, lambda x: x], obj.get(\"args\"))\n can_offer_session_approval = from_union([from_none, from_bool], obj.get(\"canOfferSessionApproval\"))\n citations = from_union([from_none, from_str], obj.get(\"citations\"))\n command_identifiers = from_union([from_none, lambda x: from_list(from_str, x)], obj.get(\"commandIdentifiers\"))\n diff = from_union([from_none, from_str], obj.get(\"diff\"))\n direction = from_union([from_none, lambda x: parse_enum(PermissionPromptRequestMemoryDirection, x)], obj.get(\"direction\"))\n fact = from_union([from_none, from_str], obj.get(\"fact\"))\n file_name = from_union([from_none, from_str], obj.get(\"fileName\"))\n full_command_text = from_union([from_none, from_str], obj.get(\"fullCommandText\"))\n hook_message = from_union([from_none, from_str], obj.get(\"hookMessage\"))\n intention = from_union([from_none, from_str], obj.get(\"intention\"))\n new_file_contents = from_union([from_none, from_str], obj.get(\"newFileContents\"))\n path = from_union([from_none, from_str], obj.get(\"path\"))\n paths = from_union([from_none, lambda x: from_list(from_str, x)], obj.get(\"paths\"))\n reason = from_union([from_none, from_str], obj.get(\"reason\"))\n server_name = from_union([from_none, from_str], obj.get(\"serverName\"))\n subject = from_union([from_none, from_str], obj.get(\"subject\"))\n tool_args = obj.get(\"toolArgs\")\n tool_call_id = from_union([from_none, from_str], obj.get(\"toolCallId\"))\n tool_description = from_union([from_none, from_str], obj.get(\"toolDescription\"))\n tool_name = from_union([from_none, from_str], obj.get(\"toolName\"))\n tool_title = from_union([from_none, from_str], obj.get(\"toolTitle\"))\n url = from_union([from_none, from_str], obj.get(\"url\"))\n warning = from_union([from_none, from_str], obj.get(\"warning\"))\n return PermissionPromptRequest(\n kind=kind,\n access_kind=access_kind,\n action=action,\n args=args,\n can_offer_session_approval=can_offer_session_approval,\n citations=citations,\n command_identifiers=command_identifiers,\n diff=diff,\n direction=direction,\n fact=fact,\n file_name=file_name,\n full_command_text=full_command_text,\n hook_message=hook_message,\n intention=intention,\n new_file_contents=new_file_contents,\n path=path,\n paths=paths,\n reason=reason,\n server_name=server_name,\n subject=subject,\n tool_args=tool_args,\n tool_call_id=tool_call_id,\n tool_description=tool_description,\n tool_name=tool_name,\n tool_title=tool_title,\n url=url,\n warning=warning,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionPromptRequestKind, self.kind)\n if self.access_kind is not None:\n result[\"accessKind\"] = from_union([from_none, lambda x: to_enum(PermissionPromptRequestPathAccessKind, x)], self.access_kind)\n if self.action is not None:\n result[\"action\"] = from_union([from_none, lambda x: to_enum(PermissionPromptRequestMemoryAction, x)], self.action)\n if self.args is not None:\n result[\"args\"] = from_union([from_none, lambda x: x], self.args)\n if self.can_offer_session_approval is not None:\n result[\"canOfferSessionApproval\"] = from_union([from_none, from_bool], self.can_offer_session_approval)\n if self.citations is not None:\n result[\"citations\"] = from_union([from_none, from_str], self.citations)\n if self.command_identifiers is not None:\n result[\"commandIdentifiers\"] = from_union([from_none, lambda x: from_list(from_str, x)], self.command_identifiers)\n if self.diff is not None:\n result[\"diff\"] = from_union([from_none, from_str], self.diff)\n if self.direction is not None:\n result[\"direction\"] = from_union([from_none, lambda x: to_enum(PermissionPromptRequestMemoryDirection, x)], self.direction)\n if self.fact is not None:\n result[\"fact\"] = from_union([from_none, from_str], self.fact)\n if self.file_name is not None:\n result[\"fileName\"] = from_union([from_none, from_str], self.file_name)\n if self.full_command_text is not None:\n result[\"fullCommandText\"] = from_union([from_none, from_str], self.full_command_text)\n if self.hook_message is not None:\n result[\"hookMessage\"] = from_union([from_none, from_str], self.hook_message)\n if self.intention is not None:\n result[\"intention\"] = from_union([from_none, from_str], self.intention)\n if self.new_file_contents is not None:\n result[\"newFileContents\"] = from_union([from_none, from_str], self.new_file_contents)\n if self.path is not None:\n result[\"path\"] = from_union([from_none, from_str], self.path)\n if self.paths is not None:\n result[\"paths\"] = from_union([from_none, lambda x: from_list(from_str, x)], self.paths)\n if self.reason is not None:\n result[\"reason\"] = from_union([from_none, from_str], self.reason)\n if self.server_name is not None:\n result[\"serverName\"] = from_union([from_none, from_str], self.server_name)\n if self.subject is not None:\n result[\"subject\"] = from_union([from_none, from_str], self.subject)\n if self.tool_args is not None:\n result[\"toolArgs\"] = self.tool_args\n if self.tool_call_id is not None:\n result[\"toolCallId\"] = from_union([from_none, from_str], self.tool_call_id)\n if self.tool_description is not None:\n result[\"toolDescription\"] = from_union([from_none, from_str], self.tool_description)\n if self.tool_name is not None:\n result[\"toolName\"] = from_union([from_none, from_str], self.tool_name)\n if self.tool_title is not None:\n result[\"toolTitle\"] = from_union([from_none, from_str], self.tool_title)\n if self.url is not None:\n result[\"url\"] = from_union([from_none, from_str], self.url)\n if self.warning is not None:\n result[\"warning\"] = from_union([from_none, from_str], self.warning)\n return result\n\n\n@dataclass\nclass PermissionRequest:\n \"Details of the permission being requested\"\n kind: PermissionRequestKind\n action: PermissionRequestMemoryAction | None = None\n args: Any = None\n can_offer_session_approval: bool | None = None\n citations: str | None = None\n commands: list[PermissionRequestShellCommand] | None = None\n diff: str | None = None\n direction: PermissionRequestMemoryDirection | None = None\n fact: str | None = None\n file_name: str | None = None\n full_command_text: str | None = None\n has_write_file_redirection: bool | None = None\n hook_message: str | None = None\n intention: str | None = None\n new_file_contents: str | None = None\n path: str | None = None\n possible_paths: list[str] | None = None\n possible_urls: list[PermissionRequestShellPossibleUrl] | None = None\n read_only: bool | None = None\n reason: str | None = None\n server_name: str | None = None\n subject: str | None = None\n tool_args: Any = None\n tool_call_id: str | None = None\n tool_description: str | None = None\n tool_name: str | None = None\n tool_title: str | None = None\n url: str | None = None\n warning: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"PermissionRequest\":\n assert isinstance(obj, dict)\n kind = parse_enum(PermissionRequestKind, obj.get(\"kind\"))\n action = from_union([from_none, lambda x: parse_enum(PermissionRequestMemoryAction, x)], obj.get(\"action\", \"store\"))\n args = obj.get(\"args\")\n can_offer_session_approval = from_union([from_none, from_bool], obj.get(\"canOfferSessionApproval\"))\n citations = from_union([from_none, from_str], obj.get(\"citations\"))\n commands = from_union([from_none, lambda x: from_list(PermissionRequestShellCommand.from_dict, x)], obj.get(\"commands\"))\n diff = from_union([from_none, from_str], obj.get(\"diff\"))\n direction = from_union([from_none, lambda x: parse_enum(PermissionRequestMemoryDirection, x)], obj.get(\"direction\"))\n fact = from_union([from_none, from_str], obj.get(\"fact\"))\n file_name = from_union([from_none, from_str], obj.get(\"fileName\"))\n full_command_text = from_union([from_none, from_str], obj.get(\"fullCommandText\"))\n has_write_file_redirection = from_union([from_none, from_bool], obj.get(\"hasWriteFileRedirection\"))\n hook_message = from_union([from_none, from_str], obj.get(\"hookMessage\"))\n intention = from_union([from_none, from_str], obj.get(\"intention\"))\n new_file_contents = from_union([from_none, from_str], obj.get(\"newFileContents\"))\n path = from_union([from_none, from_str], obj.get(\"path\"))\n possible_paths = from_union([from_none, lambda x: from_list(from_str, x)], obj.get(\"possiblePaths\"))\n possible_urls = from_union([from_none, lambda x: from_list(PermissionRequestShellPossibleUrl.from_dict, x)], obj.get(\"possibleUrls\"))\n read_only = from_union([from_none, from_bool], obj.get(\"readOnly\"))\n reason = from_union([from_none, from_str], obj.get(\"reason\"))\n server_name = from_union([from_none, from_str], obj.get(\"serverName\"))\n subject = from_union([from_none, from_str], obj.get(\"subject\"))\n tool_args = obj.get(\"toolArgs\")\n tool_call_id = from_union([from_none, from_str], obj.get(\"toolCallId\"))\n tool_description = from_union([from_none, from_str], obj.get(\"toolDescription\"))\n tool_name = from_union([from_none, from_str], obj.get(\"toolName\"))\n tool_title = from_union([from_none, from_str], obj.get(\"toolTitle\"))\n url = from_union([from_none, from_str], obj.get(\"url\"))\n warning = from_union([from_none, from_str], obj.get(\"warning\"))\n return PermissionRequest(\n kind=kind,\n action=action,\n args=args,\n can_offer_session_approval=can_offer_session_approval,\n citations=citations,\n commands=commands,\n diff=diff,\n direction=direction,\n fact=fact,\n file_name=file_name,\n full_command_text=full_command_text,\n has_write_file_redirection=has_write_file_redirection,\n hook_message=hook_message,\n intention=intention,\n new_file_contents=new_file_contents,\n path=path,\n possible_paths=possible_paths,\n possible_urls=possible_urls,\n read_only=read_only,\n reason=reason,\n server_name=server_name,\n subject=subject,\n tool_args=tool_args,\n tool_call_id=tool_call_id,\n tool_description=tool_description,\n tool_name=tool_name,\n tool_title=tool_title,\n url=url,\n warning=warning,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionRequestKind, self.kind)\n if self.action is not None:\n result[\"action\"] = from_union([from_none, lambda x: to_enum(PermissionRequestMemoryAction, x)], self.action)\n if self.args is not None:\n result[\"args\"] = self.args\n if self.can_offer_session_approval is not None:\n result[\"canOfferSessionApproval\"] = from_union([from_none, from_bool], self.can_offer_session_approval)\n if self.citations is not None:\n result[\"citations\"] = from_union([from_none, from_str], self.citations)\n if self.commands is not None:\n result[\"commands\"] = from_union([from_none, lambda x: from_list(lambda x: to_class(PermissionRequestShellCommand, x), x)], self.commands)\n if self.diff is not None:\n result[\"diff\"] = from_union([from_none, from_str], self.diff)\n if self.direction is not None:\n result[\"direction\"] = from_union([from_none, lambda x: to_enum(PermissionRequestMemoryDirection, x)], self.direction)\n if self.fact is not None:\n result[\"fact\"] = from_union([from_none, from_str], self.fact)\n if self.file_name is not None:\n result[\"fileName\"] = from_union([from_none, from_str], self.file_name)\n if self.full_command_text is not None:\n result[\"fullCommandText\"] = from_union([from_none, from_str], self.full_command_text)\n if self.has_write_file_redirection is not None:\n result[\"hasWriteFileRedirection\"] = from_union([from_none, from_bool], self.has_write_file_redirection)\n if self.hook_message is not None:\n result[\"hookMessage\"] = from_union([from_none, from_str], self.hook_message)\n if self.intention is not None:\n result[\"intention\"] = from_union([from_none, from_str], self.intention)\n if self.new_file_contents is not None:\n result[\"newFileContents\"] = from_union([from_none, from_str], self.new_file_contents)\n if self.path is not None:\n result[\"path\"] = from_union([from_none, from_str], self.path)\n if self.possible_paths is not None:\n result[\"possiblePaths\"] = from_union([from_none, lambda x: from_list(from_str, x)], self.possible_paths)\n if self.possible_urls is not None:\n result[\"possibleUrls\"] = from_union([from_none, lambda x: from_list(lambda x: to_class(PermissionRequestShellPossibleUrl, x), x)], self.possible_urls)\n if self.read_only is not None:\n result[\"readOnly\"] = from_union([from_none, from_bool], self.read_only)\n if self.reason is not None:\n result[\"reason\"] = from_union([from_none, from_str], self.reason)\n if self.server_name is not None:\n result[\"serverName\"] = from_union([from_none, from_str], self.server_name)\n if self.subject is not None:\n result[\"subject\"] = from_union([from_none, from_str], self.subject)\n if self.tool_args is not None:\n result[\"toolArgs\"] = self.tool_args\n if self.tool_call_id is not None:\n result[\"toolCallId\"] = from_union([from_none, from_str], self.tool_call_id)\n if self.tool_description is not None:\n result[\"toolDescription\"] = from_union([from_none, from_str], self.tool_description)\n if self.tool_name is not None:\n result[\"toolName\"] = from_union([from_none, from_str], self.tool_name)\n if self.tool_title is not None:\n result[\"toolTitle\"] = from_union([from_none, from_str], self.tool_title)\n if self.url is not None:\n result[\"url\"] = from_union([from_none, from_str], self.url)\n if self.warning is not None:\n result[\"warning\"] = from_union([from_none, from_str], self.warning)\n return result\n\n\n@dataclass\nclass PermissionRequestShellCommand:\n identifier: str\n read_only: bool\n\n @staticmethod\n def from_dict(obj: Any) -> \"PermissionRequestShellCommand\":\n assert isinstance(obj, dict)\n identifier = from_str(obj.get(\"identifier\"))\n read_only = from_bool(obj.get(\"readOnly\"))\n return PermissionRequestShellCommand(\n identifier=identifier,\n read_only=read_only,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"identifier\"] = from_str(self.identifier)\n result[\"readOnly\"] = from_bool(self.read_only)\n return result\n\n\n@dataclass\nclass PermissionRequestShellPossibleUrl:\n url: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"PermissionRequestShellPossibleUrl\":\n assert isinstance(obj, dict)\n url = from_str(obj.get(\"url\"))\n return PermissionRequestShellPossibleUrl(\n url=url,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"url\"] = from_str(self.url)\n return result\n\n\n@dataclass\nclass PermissionRequestedData:\n \"Permission request notification requiring client approval with request details\"\n permission_request: PermissionRequest\n request_id: str\n prompt_request: PermissionPromptRequest | None = None\n resolved_by_hook: bool | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"PermissionRequestedData\":\n assert isinstance(obj, dict)\n permission_request = PermissionRequest.from_dict(obj.get(\"permissionRequest\"))\n request_id = from_str(obj.get(\"requestId\"))\n prompt_request = from_union([from_none, PermissionPromptRequest.from_dict], obj.get(\"promptRequest\"))\n resolved_by_hook = from_union([from_none, from_bool], obj.get(\"resolvedByHook\"))\n return PermissionRequestedData(\n permission_request=permission_request,\n request_id=request_id,\n prompt_request=prompt_request,\n resolved_by_hook=resolved_by_hook,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"permissionRequest\"] = to_class(PermissionRequest, self.permission_request)\n result[\"requestId\"] = from_str(self.request_id)\n if self.prompt_request is not None:\n result[\"promptRequest\"] = from_union([from_none, lambda x: to_class(PermissionPromptRequest, x)], self.prompt_request)\n if self.resolved_by_hook is not None:\n result[\"resolvedByHook\"] = from_union([from_none, from_bool], self.resolved_by_hook)\n return result\n\n\n@dataclass\nclass PermissionResult:\n \"The result of the permission request\"\n kind: PermissionResultKind\n approval: UserToolSessionApproval | None = None\n feedback: str | None = None\n force_reject: bool | None = None\n interrupt: bool | None = None\n location_key: str | None = None\n message: str | None = None\n path: str | None = None\n reason: str | None = None\n rules: list[PermissionRule] | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"PermissionResult\":\n assert isinstance(obj, dict)\n kind = parse_enum(PermissionResultKind, obj.get(\"kind\"))\n approval = from_union([from_none, UserToolSessionApproval.from_dict], obj.get(\"approval\"))\n feedback = from_union([from_none, from_str], obj.get(\"feedback\"))\n force_reject = from_union([from_none, from_bool], obj.get(\"forceReject\"))\n interrupt = from_union([from_none, from_bool], obj.get(\"interrupt\"))\n location_key = from_union([from_none, from_str], obj.get(\"locationKey\"))\n message = from_union([from_none, from_str], obj.get(\"message\"))\n path = from_union([from_none, from_str], obj.get(\"path\"))\n reason = from_union([from_none, from_str], obj.get(\"reason\"))\n rules = from_union([from_none, lambda x: from_list(PermissionRule.from_dict, x)], obj.get(\"rules\"))\n return PermissionResult(\n kind=kind,\n approval=approval,\n feedback=feedback,\n force_reject=force_reject,\n interrupt=interrupt,\n location_key=location_key,\n message=message,\n path=path,\n reason=reason,\n rules=rules,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(PermissionResultKind, self.kind)\n if self.approval is not None:\n result[\"approval\"] = from_union([from_none, lambda x: to_class(UserToolSessionApproval, x)], self.approval)\n if self.feedback is not None:\n result[\"feedback\"] = from_union([from_none, from_str], self.feedback)\n if self.force_reject is not None:\n result[\"forceReject\"] = from_union([from_none, from_bool], self.force_reject)\n if self.interrupt is not None:\n result[\"interrupt\"] = from_union([from_none, from_bool], self.interrupt)\n if self.location_key is not None:\n result[\"locationKey\"] = from_union([from_none, from_str], self.location_key)\n if self.message is not None:\n result[\"message\"] = from_union([from_none, from_str], self.message)\n if self.path is not None:\n result[\"path\"] = from_union([from_none, from_str], self.path)\n if self.reason is not None:\n result[\"reason\"] = from_union([from_none, from_str], self.reason)\n if self.rules is not None:\n result[\"rules\"] = from_union([from_none, lambda x: from_list(lambda x: to_class(PermissionRule, x), x)], self.rules)\n return result\n\n\n@dataclass\nclass PermissionRule:\n argument: str | None\n kind: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"PermissionRule\":\n assert isinstance(obj, dict)\n argument = from_union([from_none, from_str], obj.get(\"argument\"))\n kind = from_str(obj.get(\"kind\"))\n return PermissionRule(\n argument=argument,\n kind=kind,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"argument\"] = from_union([from_none, from_str], self.argument)\n result[\"kind\"] = from_str(self.kind)\n return result\n\n\n@dataclass\nclass SamplingCompletedData:\n \"Sampling request completion notification signaling UI dismissal\"\n request_id: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"SamplingCompletedData\":\n assert isinstance(obj, dict)\n request_id = from_str(obj.get(\"requestId\"))\n return SamplingCompletedData(\n request_id=request_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"requestId\"] = from_str(self.request_id)\n return result\n\n\n@dataclass\nclass SamplingRequestedData:\n \"Sampling request from an MCP server; contains the server name and a requestId for correlation\"\n mcp_request_id: Any\n request_id: str\n server_name: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"SamplingRequestedData\":\n assert isinstance(obj, dict)\n mcp_request_id = obj.get(\"mcpRequestId\")\n request_id = from_str(obj.get(\"requestId\"))\n server_name = from_str(obj.get(\"serverName\"))\n return SamplingRequestedData(\n mcp_request_id=mcp_request_id,\n request_id=request_id,\n server_name=server_name,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"mcpRequestId\"] = self.mcp_request_id\n result[\"requestId\"] = from_str(self.request_id)\n result[\"serverName\"] = from_str(self.server_name)\n return result\n\n\n@dataclass\nclass SessionBackgroundTasksChangedData:\n @staticmethod\n def from_dict(obj: Any) -> \"SessionBackgroundTasksChangedData\":\n assert isinstance(obj, dict)\n return SessionBackgroundTasksChangedData()\n\n def to_dict(self) -> dict:\n return {}\n\n\n@dataclass\nclass SessionCompactionCompleteData:\n \"Conversation compaction results including success status, metrics, and optional error details\"\n success: bool\n checkpoint_number: float | None = None\n checkpoint_path: str | None = None\n compaction_tokens_used: CompactionCompleteCompactionTokensUsed | None = None\n conversation_tokens: float | None = None\n error: str | None = None\n messages_removed: float | None = None\n post_compaction_tokens: float | None = None\n pre_compaction_messages_length: float | None = None\n pre_compaction_tokens: float | None = None\n request_id: str | None = None\n summary_content: str | None = None\n system_tokens: float | None = None\n tokens_removed: float | None = None\n tool_definitions_tokens: float | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionCompactionCompleteData\":\n assert isinstance(obj, dict)\n success = from_bool(obj.get(\"success\"))\n checkpoint_number = from_union([from_none, from_float], obj.get(\"checkpointNumber\"))\n checkpoint_path = from_union([from_none, from_str], obj.get(\"checkpointPath\"))\n compaction_tokens_used = from_union([from_none, CompactionCompleteCompactionTokensUsed.from_dict], obj.get(\"compactionTokensUsed\"))\n conversation_tokens = from_union([from_none, from_float], obj.get(\"conversationTokens\"))\n error = from_union([from_none, from_str], obj.get(\"error\"))\n messages_removed = from_union([from_none, from_float], obj.get(\"messagesRemoved\"))\n post_compaction_tokens = from_union([from_none, from_float], obj.get(\"postCompactionTokens\"))\n pre_compaction_messages_length = from_union([from_none, from_float], obj.get(\"preCompactionMessagesLength\"))\n pre_compaction_tokens = from_union([from_none, from_float], obj.get(\"preCompactionTokens\"))\n request_id = from_union([from_none, from_str], obj.get(\"requestId\"))\n summary_content = from_union([from_none, from_str], obj.get(\"summaryContent\"))\n system_tokens = from_union([from_none, from_float], obj.get(\"systemTokens\"))\n tokens_removed = from_union([from_none, from_float], obj.get(\"tokensRemoved\"))\n tool_definitions_tokens = from_union([from_none, from_float], obj.get(\"toolDefinitionsTokens\"))\n return SessionCompactionCompleteData(\n success=success,\n checkpoint_number=checkpoint_number,\n checkpoint_path=checkpoint_path,\n compaction_tokens_used=compaction_tokens_used,\n conversation_tokens=conversation_tokens,\n error=error,\n messages_removed=messages_removed,\n post_compaction_tokens=post_compaction_tokens,\n pre_compaction_messages_length=pre_compaction_messages_length,\n pre_compaction_tokens=pre_compaction_tokens,\n request_id=request_id,\n summary_content=summary_content,\n system_tokens=system_tokens,\n tokens_removed=tokens_removed,\n tool_definitions_tokens=tool_definitions_tokens,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"success\"] = from_bool(self.success)\n if self.checkpoint_number is not None:\n result[\"checkpointNumber\"] = from_union([from_none, to_float], self.checkpoint_number)\n if self.checkpoint_path is not None:\n result[\"checkpointPath\"] = from_union([from_none, from_str], self.checkpoint_path)\n if self.compaction_tokens_used is not None:\n result[\"compactionTokensUsed\"] = from_union([from_none, lambda x: to_class(CompactionCompleteCompactionTokensUsed, x)], self.compaction_tokens_used)\n if self.conversation_tokens is not None:\n result[\"conversationTokens\"] = from_union([from_none, to_float], self.conversation_tokens)\n if self.error is not None:\n result[\"error\"] = from_union([from_none, from_str], self.error)\n if self.messages_removed is not None:\n result[\"messagesRemoved\"] = from_union([from_none, to_float], self.messages_removed)\n if self.post_compaction_tokens is not None:\n result[\"postCompactionTokens\"] = from_union([from_none, to_float], self.post_compaction_tokens)\n if self.pre_compaction_messages_length is not None:\n result[\"preCompactionMessagesLength\"] = from_union([from_none, to_float], self.pre_compaction_messages_length)\n if self.pre_compaction_tokens is not None:\n result[\"preCompactionTokens\"] = from_union([from_none, to_float], self.pre_compaction_tokens)\n if self.request_id is not None:\n result[\"requestId\"] = from_union([from_none, from_str], self.request_id)\n if self.summary_content is not None:\n result[\"summaryContent\"] = from_union([from_none, from_str], self.summary_content)\n if self.system_tokens is not None:\n result[\"systemTokens\"] = from_union([from_none, to_float], self.system_tokens)\n if self.tokens_removed is not None:\n result[\"tokensRemoved\"] = from_union([from_none, to_float], self.tokens_removed)\n if self.tool_definitions_tokens is not None:\n result[\"toolDefinitionsTokens\"] = from_union([from_none, to_float], self.tool_definitions_tokens)\n return result\n\n\n@dataclass\nclass SessionCompactionStartData:\n \"Context window breakdown at the start of LLM-powered conversation compaction\"\n conversation_tokens: float | None = None\n system_tokens: float | None = None\n tool_definitions_tokens: float | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionCompactionStartData\":\n assert isinstance(obj, dict)\n conversation_tokens = from_union([from_none, from_float], obj.get(\"conversationTokens\"))\n system_tokens = from_union([from_none, from_float], obj.get(\"systemTokens\"))\n tool_definitions_tokens = from_union([from_none, from_float], obj.get(\"toolDefinitionsTokens\"))\n return SessionCompactionStartData(\n conversation_tokens=conversation_tokens,\n system_tokens=system_tokens,\n tool_definitions_tokens=tool_definitions_tokens,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.conversation_tokens is not None:\n result[\"conversationTokens\"] = from_union([from_none, to_float], self.conversation_tokens)\n if self.system_tokens is not None:\n result[\"systemTokens\"] = from_union([from_none, to_float], self.system_tokens)\n if self.tool_definitions_tokens is not None:\n result[\"toolDefinitionsTokens\"] = from_union([from_none, to_float], self.tool_definitions_tokens)\n return result\n\n\n@dataclass\nclass SessionContextChangedData:\n \"Working directory and git context at session start\"\n cwd: str\n base_commit: str | None = None\n branch: str | None = None\n git_root: str | None = None\n head_commit: str | None = None\n host_type: WorkingDirectoryContextHostType | None = None\n repository: str | None = None\n repository_host: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionContextChangedData\":\n assert isinstance(obj, dict)\n cwd = from_str(obj.get(\"cwd\"))\n base_commit = from_union([from_none, from_str], obj.get(\"baseCommit\"))\n branch = from_union([from_none, from_str], obj.get(\"branch\"))\n git_root = from_union([from_none, from_str], obj.get(\"gitRoot\"))\n head_commit = from_union([from_none, from_str], obj.get(\"headCommit\"))\n host_type = from_union([from_none, lambda x: parse_enum(WorkingDirectoryContextHostType, x)], obj.get(\"hostType\"))\n repository = from_union([from_none, from_str], obj.get(\"repository\"))\n repository_host = from_union([from_none, from_str], obj.get(\"repositoryHost\"))\n return SessionContextChangedData(\n cwd=cwd,\n base_commit=base_commit,\n branch=branch,\n git_root=git_root,\n head_commit=head_commit,\n host_type=host_type,\n repository=repository,\n repository_host=repository_host,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"cwd\"] = from_str(self.cwd)\n if self.base_commit is not None:\n result[\"baseCommit\"] = from_union([from_none, from_str], self.base_commit)\n if self.branch is not None:\n result[\"branch\"] = from_union([from_none, from_str], self.branch)\n if self.git_root is not None:\n result[\"gitRoot\"] = from_union([from_none, from_str], self.git_root)\n if self.head_commit is not None:\n result[\"headCommit\"] = from_union([from_none, from_str], self.head_commit)\n if self.host_type is not None:\n result[\"hostType\"] = from_union([from_none, lambda x: to_enum(WorkingDirectoryContextHostType, x)], self.host_type)\n if self.repository is not None:\n result[\"repository\"] = from_union([from_none, from_str], self.repository)\n if self.repository_host is not None:\n result[\"repositoryHost\"] = from_union([from_none, from_str], self.repository_host)\n return result\n\n\n@dataclass\nclass SessionCustomAgentsUpdatedData:\n agents: list[CustomAgentsUpdatedAgent]\n errors: list[str]\n warnings: list[str]\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionCustomAgentsUpdatedData\":\n assert isinstance(obj, dict)\n agents = from_list(CustomAgentsUpdatedAgent.from_dict, obj.get(\"agents\"))\n errors = from_list(from_str, obj.get(\"errors\"))\n warnings = from_list(from_str, obj.get(\"warnings\"))\n return SessionCustomAgentsUpdatedData(\n agents=agents,\n errors=errors,\n warnings=warnings,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"agents\"] = from_list(lambda x: to_class(CustomAgentsUpdatedAgent, x), self.agents)\n result[\"errors\"] = from_list(from_str, self.errors)\n result[\"warnings\"] = from_list(from_str, self.warnings)\n return result\n\n\n@dataclass\nclass SessionErrorData:\n \"Error details for timeline display including message and optional diagnostic information\"\n error_type: str\n message: str\n eligible_for_auto_switch: bool | None = None\n error_code: str | None = None\n provider_call_id: str | None = None\n stack: str | None = None\n status_code: int | None = None\n url: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionErrorData\":\n assert isinstance(obj, dict)\n error_type = from_str(obj.get(\"errorType\"))\n message = from_str(obj.get(\"message\"))\n eligible_for_auto_switch = from_union([from_none, from_bool], obj.get(\"eligibleForAutoSwitch\"))\n error_code = from_union([from_none, from_str], obj.get(\"errorCode\"))\n provider_call_id = from_union([from_none, from_str], obj.get(\"providerCallId\"))\n stack = from_union([from_none, from_str], obj.get(\"stack\"))\n status_code = from_union([from_none, from_int], obj.get(\"statusCode\"))\n url = from_union([from_none, from_str], obj.get(\"url\"))\n return SessionErrorData(\n error_type=error_type,\n message=message,\n eligible_for_auto_switch=eligible_for_auto_switch,\n error_code=error_code,\n provider_call_id=provider_call_id,\n stack=stack,\n status_code=status_code,\n url=url,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"errorType\"] = from_str(self.error_type)\n result[\"message\"] = from_str(self.message)\n if self.eligible_for_auto_switch is not None:\n result[\"eligibleForAutoSwitch\"] = from_union([from_none, from_bool], self.eligible_for_auto_switch)\n if self.error_code is not None:\n result[\"errorCode\"] = from_union([from_none, from_str], self.error_code)\n if self.provider_call_id is not None:\n result[\"providerCallId\"] = from_union([from_none, from_str], self.provider_call_id)\n if self.stack is not None:\n result[\"stack\"] = from_union([from_none, from_str], self.stack)\n if self.status_code is not None:\n result[\"statusCode\"] = from_union([from_none, to_int], self.status_code)\n if self.url is not None:\n result[\"url\"] = from_union([from_none, from_str], self.url)\n return result\n\n\n@dataclass\nclass SessionExtensionsLoadedData:\n extensions: list[ExtensionsLoadedExtension]\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionExtensionsLoadedData\":\n assert isinstance(obj, dict)\n extensions = from_list(ExtensionsLoadedExtension.from_dict, obj.get(\"extensions\"))\n return SessionExtensionsLoadedData(\n extensions=extensions,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"extensions\"] = from_list(lambda x: to_class(ExtensionsLoadedExtension, x), self.extensions)\n return result\n\n\n@dataclass\nclass SessionHandoffData:\n \"Session handoff metadata including source, context, and repository information\"\n handoff_time: datetime\n source_type: HandoffSourceType\n context: str | None = None\n host: str | None = None\n remote_session_id: str | None = None\n repository: HandoffRepository | None = None\n summary: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionHandoffData\":\n assert isinstance(obj, dict)\n handoff_time = from_datetime(obj.get(\"handoffTime\"))\n source_type = parse_enum(HandoffSourceType, obj.get(\"sourceType\"))\n context = from_union([from_none, from_str], obj.get(\"context\"))\n host = from_union([from_none, from_str], obj.get(\"host\"))\n remote_session_id = from_union([from_none, from_str], obj.get(\"remoteSessionId\"))\n repository = from_union([from_none, HandoffRepository.from_dict], obj.get(\"repository\"))\n summary = from_union([from_none, from_str], obj.get(\"summary\"))\n return SessionHandoffData(\n handoff_time=handoff_time,\n source_type=source_type,\n context=context,\n host=host,\n remote_session_id=remote_session_id,\n repository=repository,\n summary=summary,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"handoffTime\"] = to_datetime(self.handoff_time)\n result[\"sourceType\"] = to_enum(HandoffSourceType, self.source_type)\n if self.context is not None:\n result[\"context\"] = from_union([from_none, from_str], self.context)\n if self.host is not None:\n result[\"host\"] = from_union([from_none, from_str], self.host)\n if self.remote_session_id is not None:\n result[\"remoteSessionId\"] = from_union([from_none, from_str], self.remote_session_id)\n if self.repository is not None:\n result[\"repository\"] = from_union([from_none, lambda x: to_class(HandoffRepository, x)], self.repository)\n if self.summary is not None:\n result[\"summary\"] = from_union([from_none, from_str], self.summary)\n return result\n\n\n@dataclass\nclass SessionIdleData:\n \"Payload indicating the session is idle with no background agents in flight\"\n aborted: bool | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionIdleData\":\n assert isinstance(obj, dict)\n aborted = from_union([from_none, from_bool], obj.get(\"aborted\"))\n return SessionIdleData(\n aborted=aborted,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.aborted is not None:\n result[\"aborted\"] = from_union([from_none, from_bool], self.aborted)\n return result\n\n\n@dataclass\nclass SessionInfoData:\n \"Informational message for timeline display with categorization\"\n info_type: str\n message: str\n tip: str | None = None\n url: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionInfoData\":\n assert isinstance(obj, dict)\n info_type = from_str(obj.get(\"infoType\"))\n message = from_str(obj.get(\"message\"))\n tip = from_union([from_none, from_str], obj.get(\"tip\"))\n url = from_union([from_none, from_str], obj.get(\"url\"))\n return SessionInfoData(\n info_type=info_type,\n message=message,\n tip=tip,\n url=url,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"infoType\"] = from_str(self.info_type)\n result[\"message\"] = from_str(self.message)\n if self.tip is not None:\n result[\"tip\"] = from_union([from_none, from_str], self.tip)\n if self.url is not None:\n result[\"url\"] = from_union([from_none, from_str], self.url)\n return result\n\n\n@dataclass\nclass SessionMcpServerStatusChangedData:\n server_name: str\n status: McpServerStatusChangedStatus\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionMcpServerStatusChangedData\":\n assert isinstance(obj, dict)\n server_name = from_str(obj.get(\"serverName\"))\n status = parse_enum(McpServerStatusChangedStatus, obj.get(\"status\"))\n return SessionMcpServerStatusChangedData(\n server_name=server_name,\n status=status,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"serverName\"] = from_str(self.server_name)\n result[\"status\"] = to_enum(McpServerStatusChangedStatus, self.status)\n return result\n\n\n@dataclass\nclass SessionMcpServersLoadedData:\n servers: list[McpServersLoadedServer]\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionMcpServersLoadedData\":\n assert isinstance(obj, dict)\n servers = from_list(McpServersLoadedServer.from_dict, obj.get(\"servers\"))\n return SessionMcpServersLoadedData(\n servers=servers,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"servers\"] = from_list(lambda x: to_class(McpServersLoadedServer, x), self.servers)\n return result\n\n\n@dataclass\nclass SessionModeChangedData:\n \"Agent mode change details including previous and new modes\"\n new_mode: str\n previous_mode: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionModeChangedData\":\n assert isinstance(obj, dict)\n new_mode = from_str(obj.get(\"newMode\"))\n previous_mode = from_str(obj.get(\"previousMode\"))\n return SessionModeChangedData(\n new_mode=new_mode,\n previous_mode=previous_mode,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"newMode\"] = from_str(self.new_mode)\n result[\"previousMode\"] = from_str(self.previous_mode)\n return result\n\n\n@dataclass\nclass SessionModelChangeData:\n \"Model change details including previous and new model identifiers\"\n new_model: str\n cause: str | None = None\n previous_model: str | None = None\n previous_reasoning_effort: str | None = None\n reasoning_effort: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionModelChangeData\":\n assert isinstance(obj, dict)\n new_model = from_str(obj.get(\"newModel\"))\n cause = from_union([from_none, from_str], obj.get(\"cause\"))\n previous_model = from_union([from_none, from_str], obj.get(\"previousModel\"))\n previous_reasoning_effort = from_union([from_none, from_str], obj.get(\"previousReasoningEffort\"))\n reasoning_effort = from_union([from_none, from_str], obj.get(\"reasoningEffort\"))\n return SessionModelChangeData(\n new_model=new_model,\n cause=cause,\n previous_model=previous_model,\n previous_reasoning_effort=previous_reasoning_effort,\n reasoning_effort=reasoning_effort,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"newModel\"] = from_str(self.new_model)\n if self.cause is not None:\n result[\"cause\"] = from_union([from_none, from_str], self.cause)\n if self.previous_model is not None:\n result[\"previousModel\"] = from_union([from_none, from_str], self.previous_model)\n if self.previous_reasoning_effort is not None:\n result[\"previousReasoningEffort\"] = from_union([from_none, from_str], self.previous_reasoning_effort)\n if self.reasoning_effort is not None:\n result[\"reasoningEffort\"] = from_union([from_none, from_str], self.reasoning_effort)\n return result\n\n\n@dataclass\nclass SessionPlanChangedData:\n \"Plan file operation details indicating what changed\"\n operation: PlanChangedOperation\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionPlanChangedData\":\n assert isinstance(obj, dict)\n operation = parse_enum(PlanChangedOperation, obj.get(\"operation\"))\n return SessionPlanChangedData(\n operation=operation,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"operation\"] = to_enum(PlanChangedOperation, self.operation)\n return result\n\n\n@dataclass\nclass SessionRemoteSteerableChangedData:\n \"Notifies Mission Control that the session's remote steering capability has changed\"\n remote_steerable: bool\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionRemoteSteerableChangedData\":\n assert isinstance(obj, dict)\n remote_steerable = from_bool(obj.get(\"remoteSteerable\"))\n return SessionRemoteSteerableChangedData(\n remote_steerable=remote_steerable,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"remoteSteerable\"] = from_bool(self.remote_steerable)\n return result\n\n\n@dataclass\nclass SessionResumeData:\n \"Session resume metadata including current context and event count\"\n event_count: float\n resume_time: datetime\n already_in_use: bool | None = None\n context: WorkingDirectoryContext | None = None\n continue_pending_work: bool | None = None\n reasoning_effort: str | None = None\n remote_steerable: bool | None = None\n selected_model: str | None = None\n session_was_active: bool | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionResumeData\":\n assert isinstance(obj, dict)\n event_count = from_float(obj.get(\"eventCount\"))\n resume_time = from_datetime(obj.get(\"resumeTime\"))\n already_in_use = from_union([from_none, from_bool], obj.get(\"alreadyInUse\"))\n context = from_union([from_none, WorkingDirectoryContext.from_dict], obj.get(\"context\"))\n continue_pending_work = from_union([from_none, from_bool], obj.get(\"continuePendingWork\"))\n reasoning_effort = from_union([from_none, from_str], obj.get(\"reasoningEffort\"))\n remote_steerable = from_union([from_none, from_bool], obj.get(\"remoteSteerable\"))\n selected_model = from_union([from_none, from_str], obj.get(\"selectedModel\"))\n session_was_active = from_union([from_none, from_bool], obj.get(\"sessionWasActive\"))\n return SessionResumeData(\n event_count=event_count,\n resume_time=resume_time,\n already_in_use=already_in_use,\n context=context,\n continue_pending_work=continue_pending_work,\n reasoning_effort=reasoning_effort,\n remote_steerable=remote_steerable,\n selected_model=selected_model,\n session_was_active=session_was_active,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"eventCount\"] = to_float(self.event_count)\n result[\"resumeTime\"] = to_datetime(self.resume_time)\n if self.already_in_use is not None:\n result[\"alreadyInUse\"] = from_union([from_none, from_bool], self.already_in_use)\n if self.context is not None:\n result[\"context\"] = from_union([from_none, lambda x: to_class(WorkingDirectoryContext, x)], self.context)\n if self.continue_pending_work is not None:\n result[\"continuePendingWork\"] = from_union([from_none, from_bool], self.continue_pending_work)\n if self.reasoning_effort is not None:\n result[\"reasoningEffort\"] = from_union([from_none, from_str], self.reasoning_effort)\n if self.remote_steerable is not None:\n result[\"remoteSteerable\"] = from_union([from_none, from_bool], self.remote_steerable)\n if self.selected_model is not None:\n result[\"selectedModel\"] = from_union([from_none, from_str], self.selected_model)\n if self.session_was_active is not None:\n result[\"sessionWasActive\"] = from_union([from_none, from_bool], self.session_was_active)\n return result\n\n\n@dataclass\nclass SessionShutdownData:\n \"Session termination metrics including usage statistics, code changes, and shutdown reason\"\n code_changes: ShutdownCodeChanges\n model_metrics: dict[str, ShutdownModelMetric]\n session_start_time: float\n shutdown_type: ShutdownType\n total_api_duration_ms: float\n total_premium_requests: float\n conversation_tokens: float | None = None\n current_model: str | None = None\n current_tokens: float | None = None\n error_reason: str | None = None\n system_tokens: float | None = None\n token_details: dict[str, ShutdownTokenDetail] | None = None\n tool_definitions_tokens: float | None = None\n total_nano_aiu: float | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionShutdownData\":\n assert isinstance(obj, dict)\n code_changes = ShutdownCodeChanges.from_dict(obj.get(\"codeChanges\"))\n model_metrics = from_dict(ShutdownModelMetric.from_dict, obj.get(\"modelMetrics\"))\n session_start_time = from_float(obj.get(\"sessionStartTime\"))\n shutdown_type = parse_enum(ShutdownType, obj.get(\"shutdownType\"))\n total_api_duration_ms = from_float(obj.get(\"totalApiDurationMs\"))\n total_premium_requests = from_float(obj.get(\"totalPremiumRequests\"))\n conversation_tokens = from_union([from_none, from_float], obj.get(\"conversationTokens\"))\n current_model = from_union([from_none, from_str], obj.get(\"currentModel\"))\n current_tokens = from_union([from_none, from_float], obj.get(\"currentTokens\"))\n error_reason = from_union([from_none, from_str], obj.get(\"errorReason\"))\n system_tokens = from_union([from_none, from_float], obj.get(\"systemTokens\"))\n token_details = from_union([from_none, lambda x: from_dict(ShutdownTokenDetail.from_dict, x)], obj.get(\"tokenDetails\"))\n tool_definitions_tokens = from_union([from_none, from_float], obj.get(\"toolDefinitionsTokens\"))\n total_nano_aiu = from_union([from_none, from_float], obj.get(\"totalNanoAiu\"))\n return SessionShutdownData(\n code_changes=code_changes,\n model_metrics=model_metrics,\n session_start_time=session_start_time,\n shutdown_type=shutdown_type,\n total_api_duration_ms=total_api_duration_ms,\n total_premium_requests=total_premium_requests,\n conversation_tokens=conversation_tokens,\n current_model=current_model,\n current_tokens=current_tokens,\n error_reason=error_reason,\n system_tokens=system_tokens,\n token_details=token_details,\n tool_definitions_tokens=tool_definitions_tokens,\n total_nano_aiu=total_nano_aiu,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"codeChanges\"] = to_class(ShutdownCodeChanges, self.code_changes)\n result[\"modelMetrics\"] = from_dict(lambda x: to_class(ShutdownModelMetric, x), self.model_metrics)\n result[\"sessionStartTime\"] = to_float(self.session_start_time)\n result[\"shutdownType\"] = to_enum(ShutdownType, self.shutdown_type)\n result[\"totalApiDurationMs\"] = to_float(self.total_api_duration_ms)\n result[\"totalPremiumRequests\"] = to_float(self.total_premium_requests)\n if self.conversation_tokens is not None:\n result[\"conversationTokens\"] = from_union([from_none, to_float], self.conversation_tokens)\n if self.current_model is not None:\n result[\"currentModel\"] = from_union([from_none, from_str], self.current_model)\n if self.current_tokens is not None:\n result[\"currentTokens\"] = from_union([from_none, to_float], self.current_tokens)\n if self.error_reason is not None:\n result[\"errorReason\"] = from_union([from_none, from_str], self.error_reason)\n if self.system_tokens is not None:\n result[\"systemTokens\"] = from_union([from_none, to_float], self.system_tokens)\n if self.token_details is not None:\n result[\"tokenDetails\"] = from_union([from_none, lambda x: from_dict(lambda x: to_class(ShutdownTokenDetail, x), x)], self.token_details)\n if self.tool_definitions_tokens is not None:\n result[\"toolDefinitionsTokens\"] = from_union([from_none, to_float], self.tool_definitions_tokens)\n if self.total_nano_aiu is not None:\n result[\"totalNanoAiu\"] = from_union([from_none, to_float], self.total_nano_aiu)\n return result\n\n\n@dataclass\nclass SessionSkillsLoadedData:\n skills: list[SkillsLoadedSkill]\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionSkillsLoadedData\":\n assert isinstance(obj, dict)\n skills = from_list(SkillsLoadedSkill.from_dict, obj.get(\"skills\"))\n return SessionSkillsLoadedData(\n skills=skills,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"skills\"] = from_list(lambda x: to_class(SkillsLoadedSkill, x), self.skills)\n return result\n\n\n@dataclass\nclass SessionSnapshotRewindData:\n \"Session rewind details including target event and count of removed events\"\n events_removed: float\n up_to_event_id: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionSnapshotRewindData\":\n assert isinstance(obj, dict)\n events_removed = from_float(obj.get(\"eventsRemoved\"))\n up_to_event_id = from_str(obj.get(\"upToEventId\"))\n return SessionSnapshotRewindData(\n events_removed=events_removed,\n up_to_event_id=up_to_event_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"eventsRemoved\"] = to_float(self.events_removed)\n result[\"upToEventId\"] = from_str(self.up_to_event_id)\n return result\n\n\n@dataclass\nclass SessionStartData:\n \"Session initialization metadata including context and configuration\"\n copilot_version: str\n producer: str\n session_id: str\n start_time: datetime\n version: float\n already_in_use: bool | None = None\n context: WorkingDirectoryContext | None = None\n reasoning_effort: str | None = None\n remote_steerable: bool | None = None\n selected_model: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionStartData\":\n assert isinstance(obj, dict)\n copilot_version = from_str(obj.get(\"copilotVersion\"))\n producer = from_str(obj.get(\"producer\"))\n session_id = from_str(obj.get(\"sessionId\"))\n start_time = from_datetime(obj.get(\"startTime\"))\n version = from_float(obj.get(\"version\"))\n already_in_use = from_union([from_none, from_bool], obj.get(\"alreadyInUse\"))\n context = from_union([from_none, WorkingDirectoryContext.from_dict], obj.get(\"context\"))\n reasoning_effort = from_union([from_none, from_str], obj.get(\"reasoningEffort\"))\n remote_steerable = from_union([from_none, from_bool], obj.get(\"remoteSteerable\"))\n selected_model = from_union([from_none, from_str], obj.get(\"selectedModel\"))\n return SessionStartData(\n copilot_version=copilot_version,\n producer=producer,\n session_id=session_id,\n start_time=start_time,\n version=version,\n already_in_use=already_in_use,\n context=context,\n reasoning_effort=reasoning_effort,\n remote_steerable=remote_steerable,\n selected_model=selected_model,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"copilotVersion\"] = from_str(self.copilot_version)\n result[\"producer\"] = from_str(self.producer)\n result[\"sessionId\"] = from_str(self.session_id)\n result[\"startTime\"] = to_datetime(self.start_time)\n result[\"version\"] = to_float(self.version)\n if self.already_in_use is not None:\n result[\"alreadyInUse\"] = from_union([from_none, from_bool], self.already_in_use)\n if self.context is not None:\n result[\"context\"] = from_union([from_none, lambda x: to_class(WorkingDirectoryContext, x)], self.context)\n if self.reasoning_effort is not None:\n result[\"reasoningEffort\"] = from_union([from_none, from_str], self.reasoning_effort)\n if self.remote_steerable is not None:\n result[\"remoteSteerable\"] = from_union([from_none, from_bool], self.remote_steerable)\n if self.selected_model is not None:\n result[\"selectedModel\"] = from_union([from_none, from_str], self.selected_model)\n return result\n\n\n@dataclass\nclass SessionTaskCompleteData:\n \"Task completion notification with summary from the agent\"\n success: bool | None = None\n summary: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionTaskCompleteData\":\n assert isinstance(obj, dict)\n success = from_union([from_none, from_bool], obj.get(\"success\"))\n summary = from_union([from_none, from_str], obj.get(\"summary\", \"\"))\n return SessionTaskCompleteData(\n success=success,\n summary=summary,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.success is not None:\n result[\"success\"] = from_union([from_none, from_bool], self.success)\n if self.summary is not None:\n result[\"summary\"] = from_union([from_none, from_str], self.summary)\n return result\n\n\n@dataclass\nclass SessionTitleChangedData:\n \"Session title change payload containing the new display title\"\n title: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionTitleChangedData\":\n assert isinstance(obj, dict)\n title = from_str(obj.get(\"title\"))\n return SessionTitleChangedData(\n title=title,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"title\"] = from_str(self.title)\n return result\n\n\n@dataclass\nclass SessionToolsUpdatedData:\n model: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionToolsUpdatedData\":\n assert isinstance(obj, dict)\n model = from_str(obj.get(\"model\"))\n return SessionToolsUpdatedData(\n model=model,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"model\"] = from_str(self.model)\n return result\n\n\n@dataclass\nclass SessionTruncationData:\n \"Conversation truncation statistics including token counts and removed content metrics\"\n messages_removed_during_truncation: float\n performed_by: str\n post_truncation_messages_length: float\n post_truncation_tokens_in_messages: float\n pre_truncation_messages_length: float\n pre_truncation_tokens_in_messages: float\n token_limit: float\n tokens_removed_during_truncation: float\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionTruncationData\":\n assert isinstance(obj, dict)\n messages_removed_during_truncation = from_float(obj.get(\"messagesRemovedDuringTruncation\"))\n performed_by = from_str(obj.get(\"performedBy\"))\n post_truncation_messages_length = from_float(obj.get(\"postTruncationMessagesLength\"))\n post_truncation_tokens_in_messages = from_float(obj.get(\"postTruncationTokensInMessages\"))\n pre_truncation_messages_length = from_float(obj.get(\"preTruncationMessagesLength\"))\n pre_truncation_tokens_in_messages = from_float(obj.get(\"preTruncationTokensInMessages\"))\n token_limit = from_float(obj.get(\"tokenLimit\"))\n tokens_removed_during_truncation = from_float(obj.get(\"tokensRemovedDuringTruncation\"))\n return SessionTruncationData(\n messages_removed_during_truncation=messages_removed_during_truncation,\n performed_by=performed_by,\n post_truncation_messages_length=post_truncation_messages_length,\n post_truncation_tokens_in_messages=post_truncation_tokens_in_messages,\n pre_truncation_messages_length=pre_truncation_messages_length,\n pre_truncation_tokens_in_messages=pre_truncation_tokens_in_messages,\n token_limit=token_limit,\n tokens_removed_during_truncation=tokens_removed_during_truncation,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"messagesRemovedDuringTruncation\"] = to_float(self.messages_removed_during_truncation)\n result[\"performedBy\"] = from_str(self.performed_by)\n result[\"postTruncationMessagesLength\"] = to_float(self.post_truncation_messages_length)\n result[\"postTruncationTokensInMessages\"] = to_float(self.post_truncation_tokens_in_messages)\n result[\"preTruncationMessagesLength\"] = to_float(self.pre_truncation_messages_length)\n result[\"preTruncationTokensInMessages\"] = to_float(self.pre_truncation_tokens_in_messages)\n result[\"tokenLimit\"] = to_float(self.token_limit)\n result[\"tokensRemovedDuringTruncation\"] = to_float(self.tokens_removed_during_truncation)\n return result\n\n\n@dataclass\nclass SessionUsageInfoData:\n \"Current context window usage statistics including token and message counts\"\n current_tokens: float\n messages_length: float\n token_limit: float\n conversation_tokens: float | None = None\n is_initial: bool | None = None\n system_tokens: float | None = None\n tool_definitions_tokens: float | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionUsageInfoData\":\n assert isinstance(obj, dict)\n current_tokens = from_float(obj.get(\"currentTokens\"))\n messages_length = from_float(obj.get(\"messagesLength\"))\n token_limit = from_float(obj.get(\"tokenLimit\"))\n conversation_tokens = from_union([from_none, from_float], obj.get(\"conversationTokens\"))\n is_initial = from_union([from_none, from_bool], obj.get(\"isInitial\"))\n system_tokens = from_union([from_none, from_float], obj.get(\"systemTokens\"))\n tool_definitions_tokens = from_union([from_none, from_float], obj.get(\"toolDefinitionsTokens\"))\n return SessionUsageInfoData(\n current_tokens=current_tokens,\n messages_length=messages_length,\n token_limit=token_limit,\n conversation_tokens=conversation_tokens,\n is_initial=is_initial,\n system_tokens=system_tokens,\n tool_definitions_tokens=tool_definitions_tokens,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"currentTokens\"] = to_float(self.current_tokens)\n result[\"messagesLength\"] = to_float(self.messages_length)\n result[\"tokenLimit\"] = to_float(self.token_limit)\n if self.conversation_tokens is not None:\n result[\"conversationTokens\"] = from_union([from_none, to_float], self.conversation_tokens)\n if self.is_initial is not None:\n result[\"isInitial\"] = from_union([from_none, from_bool], self.is_initial)\n if self.system_tokens is not None:\n result[\"systemTokens\"] = from_union([from_none, to_float], self.system_tokens)\n if self.tool_definitions_tokens is not None:\n result[\"toolDefinitionsTokens\"] = from_union([from_none, to_float], self.tool_definitions_tokens)\n return result\n\n\n@dataclass\nclass SessionWarningData:\n \"Warning message for timeline display with categorization\"\n message: str\n warning_type: str\n url: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionWarningData\":\n assert isinstance(obj, dict)\n message = from_str(obj.get(\"message\"))\n warning_type = from_str(obj.get(\"warningType\"))\n url = from_union([from_none, from_str], obj.get(\"url\"))\n return SessionWarningData(\n message=message,\n warning_type=warning_type,\n url=url,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"message\"] = from_str(self.message)\n result[\"warningType\"] = from_str(self.warning_type)\n if self.url is not None:\n result[\"url\"] = from_union([from_none, from_str], self.url)\n return result\n\n\n@dataclass\nclass SessionWorkspaceFileChangedData:\n \"Workspace file change details including path and operation type\"\n operation: WorkspaceFileChangedOperation\n path: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionWorkspaceFileChangedData\":\n assert isinstance(obj, dict)\n operation = parse_enum(WorkspaceFileChangedOperation, obj.get(\"operation\"))\n path = from_str(obj.get(\"path\"))\n return SessionWorkspaceFileChangedData(\n operation=operation,\n path=path,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"operation\"] = to_enum(WorkspaceFileChangedOperation, self.operation)\n result[\"path\"] = from_str(self.path)\n return result\n\n\n@dataclass\nclass ShutdownCodeChanges:\n \"Aggregate code change metrics for the session\"\n files_modified: list[str]\n lines_added: float\n lines_removed: float\n\n @staticmethod\n def from_dict(obj: Any) -> \"ShutdownCodeChanges\":\n assert isinstance(obj, dict)\n files_modified = from_list(from_str, obj.get(\"filesModified\"))\n lines_added = from_float(obj.get(\"linesAdded\"))\n lines_removed = from_float(obj.get(\"linesRemoved\"))\n return ShutdownCodeChanges(\n files_modified=files_modified,\n lines_added=lines_added,\n lines_removed=lines_removed,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"filesModified\"] = from_list(from_str, self.files_modified)\n result[\"linesAdded\"] = to_float(self.lines_added)\n result[\"linesRemoved\"] = to_float(self.lines_removed)\n return result\n\n\n@dataclass\nclass ShutdownModelMetric:\n requests: ShutdownModelMetricRequests\n usage: ShutdownModelMetricUsage\n token_details: dict[str, ShutdownModelMetricTokenDetail] | None = None\n total_nano_aiu: float | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"ShutdownModelMetric\":\n assert isinstance(obj, dict)\n requests = ShutdownModelMetricRequests.from_dict(obj.get(\"requests\"))\n usage = ShutdownModelMetricUsage.from_dict(obj.get(\"usage\"))\n token_details = from_union([from_none, lambda x: from_dict(ShutdownModelMetricTokenDetail.from_dict, x)], obj.get(\"tokenDetails\"))\n total_nano_aiu = from_union([from_none, from_float], obj.get(\"totalNanoAiu\"))\n return ShutdownModelMetric(\n requests=requests,\n usage=usage,\n token_details=token_details,\n total_nano_aiu=total_nano_aiu,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"requests\"] = to_class(ShutdownModelMetricRequests, self.requests)\n result[\"usage\"] = to_class(ShutdownModelMetricUsage, self.usage)\n if self.token_details is not None:\n result[\"tokenDetails\"] = from_union([from_none, lambda x: from_dict(lambda x: to_class(ShutdownModelMetricTokenDetail, x), x)], self.token_details)\n if self.total_nano_aiu is not None:\n result[\"totalNanoAiu\"] = from_union([from_none, to_float], self.total_nano_aiu)\n return result\n\n\n@dataclass\nclass ShutdownModelMetricRequests:\n \"Request count and cost metrics\"\n cost: float\n count: float\n\n @staticmethod\n def from_dict(obj: Any) -> \"ShutdownModelMetricRequests\":\n assert isinstance(obj, dict)\n cost = from_float(obj.get(\"cost\"))\n count = from_float(obj.get(\"count\"))\n return ShutdownModelMetricRequests(\n cost=cost,\n count=count,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"cost\"] = to_float(self.cost)\n result[\"count\"] = to_float(self.count)\n return result\n\n\n@dataclass\nclass ShutdownModelMetricTokenDetail:\n token_count: float\n\n @staticmethod\n def from_dict(obj: Any) -> \"ShutdownModelMetricTokenDetail\":\n assert isinstance(obj, dict)\n token_count = from_float(obj.get(\"tokenCount\"))\n return ShutdownModelMetricTokenDetail(\n token_count=token_count,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"tokenCount\"] = to_float(self.token_count)\n return result\n\n\n@dataclass\nclass ShutdownModelMetricUsage:\n \"Token usage breakdown\"\n cache_read_tokens: float\n cache_write_tokens: float\n input_tokens: float\n output_tokens: float\n reasoning_tokens: float | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"ShutdownModelMetricUsage\":\n assert isinstance(obj, dict)\n cache_read_tokens = from_float(obj.get(\"cacheReadTokens\"))\n cache_write_tokens = from_float(obj.get(\"cacheWriteTokens\"))\n input_tokens = from_float(obj.get(\"inputTokens\"))\n output_tokens = from_float(obj.get(\"outputTokens\"))\n reasoning_tokens = from_union([from_none, from_float], obj.get(\"reasoningTokens\"))\n return ShutdownModelMetricUsage(\n cache_read_tokens=cache_read_tokens,\n cache_write_tokens=cache_write_tokens,\n input_tokens=input_tokens,\n output_tokens=output_tokens,\n reasoning_tokens=reasoning_tokens,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"cacheReadTokens\"] = to_float(self.cache_read_tokens)\n result[\"cacheWriteTokens\"] = to_float(self.cache_write_tokens)\n result[\"inputTokens\"] = to_float(self.input_tokens)\n result[\"outputTokens\"] = to_float(self.output_tokens)\n if self.reasoning_tokens is not None:\n result[\"reasoningTokens\"] = from_union([from_none, to_float], self.reasoning_tokens)\n return result\n\n\n@dataclass\nclass ShutdownTokenDetail:\n token_count: float\n\n @staticmethod\n def from_dict(obj: Any) -> \"ShutdownTokenDetail\":\n assert isinstance(obj, dict)\n token_count = from_float(obj.get(\"tokenCount\"))\n return ShutdownTokenDetail(\n token_count=token_count,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"tokenCount\"] = to_float(self.token_count)\n return result\n\n\n@dataclass\nclass SkillInvokedData:\n \"Skill invocation details including content, allowed tools, and plugin metadata\"\n content: str\n name: str\n path: str\n allowed_tools: list[str] | None = None\n description: str | None = None\n plugin_name: str | None = None\n plugin_version: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SkillInvokedData\":\n assert isinstance(obj, dict)\n content = from_str(obj.get(\"content\"))\n name = from_str(obj.get(\"name\"))\n path = from_str(obj.get(\"path\"))\n allowed_tools = from_union([from_none, lambda x: from_list(from_str, x)], obj.get(\"allowedTools\"))\n description = from_union([from_none, from_str], obj.get(\"description\"))\n plugin_name = from_union([from_none, from_str], obj.get(\"pluginName\"))\n plugin_version = from_union([from_none, from_str], obj.get(\"pluginVersion\"))\n return SkillInvokedData(\n content=content,\n name=name,\n path=path,\n allowed_tools=allowed_tools,\n description=description,\n plugin_name=plugin_name,\n plugin_version=plugin_version,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"content\"] = from_str(self.content)\n result[\"name\"] = from_str(self.name)\n result[\"path\"] = from_str(self.path)\n if self.allowed_tools is not None:\n result[\"allowedTools\"] = from_union([from_none, lambda x: from_list(from_str, x)], self.allowed_tools)\n if self.description is not None:\n result[\"description\"] = from_union([from_none, from_str], self.description)\n if self.plugin_name is not None:\n result[\"pluginName\"] = from_union([from_none, from_str], self.plugin_name)\n if self.plugin_version is not None:\n result[\"pluginVersion\"] = from_union([from_none, from_str], self.plugin_version)\n return result\n\n\n@dataclass\nclass SkillsLoadedSkill:\n description: str\n enabled: bool\n name: str\n source: str\n user_invocable: bool\n path: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SkillsLoadedSkill\":\n assert isinstance(obj, dict)\n description = from_str(obj.get(\"description\"))\n enabled = from_bool(obj.get(\"enabled\"))\n name = from_str(obj.get(\"name\"))\n source = from_str(obj.get(\"source\"))\n user_invocable = from_bool(obj.get(\"userInvocable\"))\n path = from_union([from_none, from_str], obj.get(\"path\"))\n return SkillsLoadedSkill(\n description=description,\n enabled=enabled,\n name=name,\n source=source,\n user_invocable=user_invocable,\n path=path,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"description\"] = from_str(self.description)\n result[\"enabled\"] = from_bool(self.enabled)\n result[\"name\"] = from_str(self.name)\n result[\"source\"] = from_str(self.source)\n result[\"userInvocable\"] = from_bool(self.user_invocable)\n if self.path is not None:\n result[\"path\"] = from_union([from_none, from_str], self.path)\n return result\n\n\n@dataclass\nclass SubagentCompletedData:\n \"Sub-agent completion details for successful execution\"\n agent_display_name: str\n agent_name: str\n tool_call_id: str\n duration_ms: float | None = None\n model: str | None = None\n total_tokens: float | None = None\n total_tool_calls: float | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SubagentCompletedData\":\n assert isinstance(obj, dict)\n agent_display_name = from_str(obj.get(\"agentDisplayName\"))\n agent_name = from_str(obj.get(\"agentName\"))\n tool_call_id = from_str(obj.get(\"toolCallId\"))\n duration_ms = from_union([from_none, from_float], obj.get(\"durationMs\"))\n model = from_union([from_none, from_str], obj.get(\"model\"))\n total_tokens = from_union([from_none, from_float], obj.get(\"totalTokens\"))\n total_tool_calls = from_union([from_none, from_float], obj.get(\"totalToolCalls\"))\n return SubagentCompletedData(\n agent_display_name=agent_display_name,\n agent_name=agent_name,\n tool_call_id=tool_call_id,\n duration_ms=duration_ms,\n model=model,\n total_tokens=total_tokens,\n total_tool_calls=total_tool_calls,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"agentDisplayName\"] = from_str(self.agent_display_name)\n result[\"agentName\"] = from_str(self.agent_name)\n result[\"toolCallId\"] = from_str(self.tool_call_id)\n if self.duration_ms is not None:\n result[\"durationMs\"] = from_union([from_none, to_float], self.duration_ms)\n if self.model is not None:\n result[\"model\"] = from_union([from_none, from_str], self.model)\n if self.total_tokens is not None:\n result[\"totalTokens\"] = from_union([from_none, to_float], self.total_tokens)\n if self.total_tool_calls is not None:\n result[\"totalToolCalls\"] = from_union([from_none, to_float], self.total_tool_calls)\n return result\n\n\n@dataclass\nclass SubagentDeselectedData:\n \"Empty payload; the event signals that the custom agent was deselected, returning to the default agent\"\n @staticmethod\n def from_dict(obj: Any) -> \"SubagentDeselectedData\":\n assert isinstance(obj, dict)\n return SubagentDeselectedData()\n\n def to_dict(self) -> dict:\n return {}\n\n\n@dataclass\nclass SubagentFailedData:\n \"Sub-agent failure details including error message and agent information\"\n agent_display_name: str\n agent_name: str\n error: str\n tool_call_id: str\n duration_ms: float | None = None\n model: str | None = None\n total_tokens: float | None = None\n total_tool_calls: float | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SubagentFailedData\":\n assert isinstance(obj, dict)\n agent_display_name = from_str(obj.get(\"agentDisplayName\"))\n agent_name = from_str(obj.get(\"agentName\"))\n error = from_str(obj.get(\"error\"))\n tool_call_id = from_str(obj.get(\"toolCallId\"))\n duration_ms = from_union([from_none, from_float], obj.get(\"durationMs\"))\n model = from_union([from_none, from_str], obj.get(\"model\"))\n total_tokens = from_union([from_none, from_float], obj.get(\"totalTokens\"))\n total_tool_calls = from_union([from_none, from_float], obj.get(\"totalToolCalls\"))\n return SubagentFailedData(\n agent_display_name=agent_display_name,\n agent_name=agent_name,\n error=error,\n tool_call_id=tool_call_id,\n duration_ms=duration_ms,\n model=model,\n total_tokens=total_tokens,\n total_tool_calls=total_tool_calls,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"agentDisplayName\"] = from_str(self.agent_display_name)\n result[\"agentName\"] = from_str(self.agent_name)\n result[\"error\"] = from_str(self.error)\n result[\"toolCallId\"] = from_str(self.tool_call_id)\n if self.duration_ms is not None:\n result[\"durationMs\"] = from_union([from_none, to_float], self.duration_ms)\n if self.model is not None:\n result[\"model\"] = from_union([from_none, from_str], self.model)\n if self.total_tokens is not None:\n result[\"totalTokens\"] = from_union([from_none, to_float], self.total_tokens)\n if self.total_tool_calls is not None:\n result[\"totalToolCalls\"] = from_union([from_none, to_float], self.total_tool_calls)\n return result\n\n\n@dataclass\nclass SubagentSelectedData:\n \"Custom agent selection details including name and available tools\"\n agent_display_name: str\n agent_name: str\n tools: list[str] | None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SubagentSelectedData\":\n assert isinstance(obj, dict)\n agent_display_name = from_str(obj.get(\"agentDisplayName\"))\n agent_name = from_str(obj.get(\"agentName\"))\n tools = from_union([from_none, lambda x: from_list(from_str, x)], obj.get(\"tools\"))\n return SubagentSelectedData(\n agent_display_name=agent_display_name,\n agent_name=agent_name,\n tools=tools,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"agentDisplayName\"] = from_str(self.agent_display_name)\n result[\"agentName\"] = from_str(self.agent_name)\n result[\"tools\"] = from_union([from_none, lambda x: from_list(from_str, x)], self.tools)\n return result\n\n\n@dataclass\nclass SubagentStartedData:\n \"Sub-agent startup details including parent tool call and agent information\"\n agent_description: str\n agent_display_name: str\n agent_name: str\n tool_call_id: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"SubagentStartedData\":\n assert isinstance(obj, dict)\n agent_description = from_str(obj.get(\"agentDescription\"))\n agent_display_name = from_str(obj.get(\"agentDisplayName\"))\n agent_name = from_str(obj.get(\"agentName\"))\n tool_call_id = from_str(obj.get(\"toolCallId\"))\n return SubagentStartedData(\n agent_description=agent_description,\n agent_display_name=agent_display_name,\n agent_name=agent_name,\n tool_call_id=tool_call_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"agentDescription\"] = from_str(self.agent_description)\n result[\"agentDisplayName\"] = from_str(self.agent_display_name)\n result[\"agentName\"] = from_str(self.agent_name)\n result[\"toolCallId\"] = from_str(self.tool_call_id)\n return result\n\n\n@dataclass\nclass SystemMessageData:\n \"System/developer instruction content with role and optional template metadata\"\n content: str\n role: SystemMessageRole\n metadata: SystemMessageMetadata | None = None\n name: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SystemMessageData\":\n assert isinstance(obj, dict)\n content = from_str(obj.get(\"content\"))\n role = parse_enum(SystemMessageRole, obj.get(\"role\"))\n metadata = from_union([from_none, SystemMessageMetadata.from_dict], obj.get(\"metadata\"))\n name = from_union([from_none, from_str], obj.get(\"name\"))\n return SystemMessageData(\n content=content,\n role=role,\n metadata=metadata,\n name=name,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"content\"] = from_str(self.content)\n result[\"role\"] = to_enum(SystemMessageRole, self.role)\n if self.metadata is not None:\n result[\"metadata\"] = from_union([from_none, lambda x: to_class(SystemMessageMetadata, x)], self.metadata)\n if self.name is not None:\n result[\"name\"] = from_union([from_none, from_str], self.name)\n return result\n\n\n@dataclass\nclass SystemMessageMetadata:\n \"Metadata about the prompt template and its construction\"\n prompt_version: str | None = None\n variables: dict[str, Any] | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SystemMessageMetadata\":\n assert isinstance(obj, dict)\n prompt_version = from_union([from_none, from_str], obj.get(\"promptVersion\"))\n variables = from_union([from_none, lambda x: from_dict(lambda x: x, x)], obj.get(\"variables\"))\n return SystemMessageMetadata(\n prompt_version=prompt_version,\n variables=variables,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n if self.prompt_version is not None:\n result[\"promptVersion\"] = from_union([from_none, from_str], self.prompt_version)\n if self.variables is not None:\n result[\"variables\"] = from_union([from_none, lambda x: from_dict(lambda x: x, x)], self.variables)\n return result\n\n\n@dataclass\nclass SystemNotification:\n \"Structured metadata identifying what triggered this notification\"\n type: SystemNotificationType\n agent_id: str | None = None\n agent_type: str | None = None\n description: str | None = None\n entry_id: str | None = None\n exit_code: float | None = None\n prompt: str | None = None\n sender_name: str | None = None\n sender_type: str | None = None\n shell_id: str | None = None\n source_path: str | None = None\n status: SystemNotificationAgentCompletedStatus | None = None\n summary: str | None = None\n trigger_file: str | None = None\n trigger_tool: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SystemNotification\":\n assert isinstance(obj, dict)\n type = parse_enum(SystemNotificationType, obj.get(\"type\"))\n agent_id = from_union([from_none, from_str], obj.get(\"agentId\"))\n agent_type = from_union([from_none, from_str], obj.get(\"agentType\"))\n description = from_union([from_none, from_str], obj.get(\"description\"))\n entry_id = from_union([from_none, from_str], obj.get(\"entryId\"))\n exit_code = from_union([from_none, from_float], obj.get(\"exitCode\"))\n prompt = from_union([from_none, from_str], obj.get(\"prompt\"))\n sender_name = from_union([from_none, from_str], obj.get(\"senderName\"))\n sender_type = from_union([from_none, from_str], obj.get(\"senderType\"))\n shell_id = from_union([from_none, from_str], obj.get(\"shellId\"))\n source_path = from_union([from_none, from_str], obj.get(\"sourcePath\"))\n status = from_union([from_none, lambda x: parse_enum(SystemNotificationAgentCompletedStatus, x)], obj.get(\"status\"))\n summary = from_union([from_none, from_str], obj.get(\"summary\"))\n trigger_file = from_union([from_none, from_str], obj.get(\"triggerFile\"))\n trigger_tool = from_union([from_none, from_str], obj.get(\"triggerTool\"))\n return SystemNotification(\n type=type,\n agent_id=agent_id,\n agent_type=agent_type,\n description=description,\n entry_id=entry_id,\n exit_code=exit_code,\n prompt=prompt,\n sender_name=sender_name,\n sender_type=sender_type,\n shell_id=shell_id,\n source_path=source_path,\n status=status,\n summary=summary,\n trigger_file=trigger_file,\n trigger_tool=trigger_tool,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"type\"] = to_enum(SystemNotificationType, self.type)\n if self.agent_id is not None:\n result[\"agentId\"] = from_union([from_none, from_str], self.agent_id)\n if self.agent_type is not None:\n result[\"agentType\"] = from_union([from_none, from_str], self.agent_type)\n if self.description is not None:\n result[\"description\"] = from_union([from_none, from_str], self.description)\n if self.entry_id is not None:\n result[\"entryId\"] = from_union([from_none, from_str], self.entry_id)\n if self.exit_code is not None:\n result[\"exitCode\"] = from_union([from_none, to_float], self.exit_code)\n if self.prompt is not None:\n result[\"prompt\"] = from_union([from_none, from_str], self.prompt)\n if self.sender_name is not None:\n result[\"senderName\"] = from_union([from_none, from_str], self.sender_name)\n if self.sender_type is not None:\n result[\"senderType\"] = from_union([from_none, from_str], self.sender_type)\n if self.shell_id is not None:\n result[\"shellId\"] = from_union([from_none, from_str], self.shell_id)\n if self.source_path is not None:\n result[\"sourcePath\"] = from_union([from_none, from_str], self.source_path)\n if self.status is not None:\n result[\"status\"] = from_union([from_none, lambda x: to_enum(SystemNotificationAgentCompletedStatus, x)], self.status)\n if self.summary is not None:\n result[\"summary\"] = from_union([from_none, from_str], self.summary)\n if self.trigger_file is not None:\n result[\"triggerFile\"] = from_union([from_none, from_str], self.trigger_file)\n if self.trigger_tool is not None:\n result[\"triggerTool\"] = from_union([from_none, from_str], self.trigger_tool)\n return result\n\n\n@dataclass\nclass SystemNotificationData:\n \"System-generated notification for runtime events like background task completion\"\n content: str\n kind: SystemNotification\n\n @staticmethod\n def from_dict(obj: Any) -> \"SystemNotificationData\":\n assert isinstance(obj, dict)\n content = from_str(obj.get(\"content\"))\n kind = SystemNotification.from_dict(obj.get(\"kind\"))\n return SystemNotificationData(\n content=content,\n kind=kind,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"content\"] = from_str(self.content)\n result[\"kind\"] = to_class(SystemNotification, self.kind)\n return result\n\n\n@dataclass\nclass ToolExecutionCompleteContent:\n \"A content block within a tool result, which may be text, terminal output, image, audio, or a resource\"\n type: ToolExecutionCompleteContentType\n cwd: str | None = None\n data: str | None = None\n description: str | None = None\n exit_code: float | None = None\n icons: list[ToolExecutionCompleteContentResourceLinkIcon] | None = None\n mime_type: str | None = None\n name: str | None = None\n resource: Any = None\n size: float | None = None\n text: str | None = None\n title: str | None = None\n uri: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"ToolExecutionCompleteContent\":\n assert isinstance(obj, dict)\n type = parse_enum(ToolExecutionCompleteContentType, obj.get(\"type\"))\n cwd = from_union([from_none, from_str], obj.get(\"cwd\"))\n data = from_union([from_none, from_str], obj.get(\"data\"))\n description = from_union([from_none, from_str], obj.get(\"description\"))\n exit_code = from_union([from_none, from_float], obj.get(\"exitCode\"))\n icons = from_union([from_none, lambda x: from_list(ToolExecutionCompleteContentResourceLinkIcon.from_dict, x)], obj.get(\"icons\"))\n mime_type = from_union([from_none, from_str], obj.get(\"mimeType\"))\n name = from_union([from_none, from_str], obj.get(\"name\"))\n resource = obj.get(\"resource\")\n size = from_union([from_none, from_float], obj.get(\"size\"))\n text = from_union([from_none, from_str], obj.get(\"text\"))\n title = from_union([from_none, from_str], obj.get(\"title\"))\n uri = from_union([from_none, from_str], obj.get(\"uri\"))\n return ToolExecutionCompleteContent(\n type=type,\n cwd=cwd,\n data=data,\n description=description,\n exit_code=exit_code,\n icons=icons,\n mime_type=mime_type,\n name=name,\n resource=resource,\n size=size,\n text=text,\n title=title,\n uri=uri,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"type\"] = to_enum(ToolExecutionCompleteContentType, self.type)\n if self.cwd is not None:\n result[\"cwd\"] = from_union([from_none, from_str], self.cwd)\n if self.data is not None:\n result[\"data\"] = from_union([from_none, from_str], self.data)\n if self.description is not None:\n result[\"description\"] = from_union([from_none, from_str], self.description)\n if self.exit_code is not None:\n result[\"exitCode\"] = from_union([from_none, to_float], self.exit_code)\n if self.icons is not None:\n result[\"icons\"] = from_union([from_none, lambda x: from_list(lambda x: to_class(ToolExecutionCompleteContentResourceLinkIcon, x), x)], self.icons)\n if self.mime_type is not None:\n result[\"mimeType\"] = from_union([from_none, from_str], self.mime_type)\n if self.name is not None:\n result[\"name\"] = from_union([from_none, from_str], self.name)\n if self.resource is not None:\n result[\"resource\"] = self.resource\n if self.size is not None:\n result[\"size\"] = from_union([from_none, to_float], self.size)\n if self.text is not None:\n result[\"text\"] = from_union([from_none, from_str], self.text)\n if self.title is not None:\n result[\"title\"] = from_union([from_none, from_str], self.title)\n if self.uri is not None:\n result[\"uri\"] = from_union([from_none, from_str], self.uri)\n return result\n\n\n@dataclass\nclass ToolExecutionCompleteContentResourceLinkIcon:\n \"Icon image for a resource\"\n src: str\n mime_type: str | None = None\n sizes: list[str] | None = None\n theme: ToolExecutionCompleteContentResourceLinkIconTheme | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"ToolExecutionCompleteContentResourceLinkIcon\":\n assert isinstance(obj, dict)\n src = from_str(obj.get(\"src\"))\n mime_type = from_union([from_none, from_str], obj.get(\"mimeType\"))\n sizes = from_union([from_none, lambda x: from_list(from_str, x)], obj.get(\"sizes\"))\n theme = from_union([from_none, lambda x: parse_enum(ToolExecutionCompleteContentResourceLinkIconTheme, x)], obj.get(\"theme\"))\n return ToolExecutionCompleteContentResourceLinkIcon(\n src=src,\n mime_type=mime_type,\n sizes=sizes,\n theme=theme,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"src\"] = from_str(self.src)\n if self.mime_type is not None:\n result[\"mimeType\"] = from_union([from_none, from_str], self.mime_type)\n if self.sizes is not None:\n result[\"sizes\"] = from_union([from_none, lambda x: from_list(from_str, x)], self.sizes)\n if self.theme is not None:\n result[\"theme\"] = from_union([from_none, lambda x: to_enum(ToolExecutionCompleteContentResourceLinkIconTheme, x)], self.theme)\n return result\n\n\n@dataclass\nclass ToolExecutionCompleteData:\n \"Tool execution completion results including success status, detailed output, and error information\"\n success: bool\n tool_call_id: str\n error: ToolExecutionCompleteError | None = None\n interaction_id: str | None = None\n is_user_requested: bool | None = None\n model: str | None = None\n # Deprecated: this field is deprecated.\n parent_tool_call_id: str | None = None\n result: ToolExecutionCompleteResult | None = None\n tool_telemetry: dict[str, Any] | None = None\n turn_id: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"ToolExecutionCompleteData\":\n assert isinstance(obj, dict)\n success = from_bool(obj.get(\"success\"))\n tool_call_id = from_str(obj.get(\"toolCallId\"))\n error = from_union([from_none, ToolExecutionCompleteError.from_dict], obj.get(\"error\"))\n interaction_id = from_union([from_none, from_str], obj.get(\"interactionId\"))\n is_user_requested = from_union([from_none, from_bool], obj.get(\"isUserRequested\"))\n model = from_union([from_none, from_str], obj.get(\"model\"))\n parent_tool_call_id = from_union([from_none, from_str], obj.get(\"parentToolCallId\"))\n result = from_union([from_none, ToolExecutionCompleteResult.from_dict], obj.get(\"result\"))\n tool_telemetry = from_union([from_none, lambda x: from_dict(lambda x: x, x)], obj.get(\"toolTelemetry\"))\n turn_id = from_union([from_none, from_str], obj.get(\"turnId\"))\n return ToolExecutionCompleteData(\n success=success,\n tool_call_id=tool_call_id,\n error=error,\n interaction_id=interaction_id,\n is_user_requested=is_user_requested,\n model=model,\n parent_tool_call_id=parent_tool_call_id,\n result=result,\n tool_telemetry=tool_telemetry,\n turn_id=turn_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"success\"] = from_bool(self.success)\n result[\"toolCallId\"] = from_str(self.tool_call_id)\n if self.error is not None:\n result[\"error\"] = from_union([from_none, lambda x: to_class(ToolExecutionCompleteError, x)], self.error)\n if self.interaction_id is not None:\n result[\"interactionId\"] = from_union([from_none, from_str], self.interaction_id)\n if self.is_user_requested is not None:\n result[\"isUserRequested\"] = from_union([from_none, from_bool], self.is_user_requested)\n if self.model is not None:\n result[\"model\"] = from_union([from_none, from_str], self.model)\n if self.parent_tool_call_id is not None:\n result[\"parentToolCallId\"] = from_union([from_none, from_str], self.parent_tool_call_id)\n if self.result is not None:\n result[\"result\"] = from_union([from_none, lambda x: to_class(ToolExecutionCompleteResult, x)], self.result)\n if self.tool_telemetry is not None:\n result[\"toolTelemetry\"] = from_union([from_none, lambda x: from_dict(lambda x: x, x)], self.tool_telemetry)\n if self.turn_id is not None:\n result[\"turnId\"] = from_union([from_none, from_str], self.turn_id)\n return result\n\n\n@dataclass\nclass ToolExecutionCompleteError:\n \"Error details when the tool execution failed\"\n message: str\n code: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"ToolExecutionCompleteError\":\n assert isinstance(obj, dict)\n message = from_str(obj.get(\"message\"))\n code = from_union([from_none, from_str], obj.get(\"code\"))\n return ToolExecutionCompleteError(\n message=message,\n code=code,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"message\"] = from_str(self.message)\n if self.code is not None:\n result[\"code\"] = from_union([from_none, from_str], self.code)\n return result\n\n\n@dataclass\nclass ToolExecutionCompleteResult:\n \"Tool execution result on success\"\n content: str\n contents: list[ToolExecutionCompleteContent] | None = None\n detailed_content: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"ToolExecutionCompleteResult\":\n assert isinstance(obj, dict)\n content = from_str(obj.get(\"content\"))\n contents = from_union([from_none, lambda x: from_list(ToolExecutionCompleteContent.from_dict, x)], obj.get(\"contents\"))\n detailed_content = from_union([from_none, from_str], obj.get(\"detailedContent\"))\n return ToolExecutionCompleteResult(\n content=content,\n contents=contents,\n detailed_content=detailed_content,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"content\"] = from_str(self.content)\n if self.contents is not None:\n result[\"contents\"] = from_union([from_none, lambda x: from_list(lambda x: to_class(ToolExecutionCompleteContent, x), x)], self.contents)\n if self.detailed_content is not None:\n result[\"detailedContent\"] = from_union([from_none, from_str], self.detailed_content)\n return result\n\n\n@dataclass\nclass ToolExecutionPartialResultData:\n \"Streaming tool execution output for incremental result display\"\n partial_output: str\n tool_call_id: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"ToolExecutionPartialResultData\":\n assert isinstance(obj, dict)\n partial_output = from_str(obj.get(\"partialOutput\"))\n tool_call_id = from_str(obj.get(\"toolCallId\"))\n return ToolExecutionPartialResultData(\n partial_output=partial_output,\n tool_call_id=tool_call_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"partialOutput\"] = from_str(self.partial_output)\n result[\"toolCallId\"] = from_str(self.tool_call_id)\n return result\n\n\n@dataclass\nclass ToolExecutionProgressData:\n \"Tool execution progress notification with status message\"\n progress_message: str\n tool_call_id: str\n\n @staticmethod\n def from_dict(obj: Any) -> \"ToolExecutionProgressData\":\n assert isinstance(obj, dict)\n progress_message = from_str(obj.get(\"progressMessage\"))\n tool_call_id = from_str(obj.get(\"toolCallId\"))\n return ToolExecutionProgressData(\n progress_message=progress_message,\n tool_call_id=tool_call_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"progressMessage\"] = from_str(self.progress_message)\n result[\"toolCallId\"] = from_str(self.tool_call_id)\n return result\n\n\n@dataclass\nclass ToolExecutionStartData:\n \"Tool execution startup details including MCP server information when applicable\"\n tool_call_id: str\n tool_name: str\n arguments: Any = None\n mcp_server_name: str | None = None\n mcp_tool_name: str | None = None\n # Deprecated: this field is deprecated.\n parent_tool_call_id: str | None = None\n turn_id: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"ToolExecutionStartData\":\n assert isinstance(obj, dict)\n tool_call_id = from_str(obj.get(\"toolCallId\"))\n tool_name = from_str(obj.get(\"toolName\"))\n arguments = obj.get(\"arguments\")\n mcp_server_name = from_union([from_none, from_str], obj.get(\"mcpServerName\"))\n mcp_tool_name = from_union([from_none, from_str], obj.get(\"mcpToolName\"))\n parent_tool_call_id = from_union([from_none, from_str], obj.get(\"parentToolCallId\"))\n turn_id = from_union([from_none, from_str], obj.get(\"turnId\"))\n return ToolExecutionStartData(\n tool_call_id=tool_call_id,\n tool_name=tool_name,\n arguments=arguments,\n mcp_server_name=mcp_server_name,\n mcp_tool_name=mcp_tool_name,\n parent_tool_call_id=parent_tool_call_id,\n turn_id=turn_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"toolCallId\"] = from_str(self.tool_call_id)\n result[\"toolName\"] = from_str(self.tool_name)\n if self.arguments is not None:\n result[\"arguments\"] = self.arguments\n if self.mcp_server_name is not None:\n result[\"mcpServerName\"] = from_union([from_none, from_str], self.mcp_server_name)\n if self.mcp_tool_name is not None:\n result[\"mcpToolName\"] = from_union([from_none, from_str], self.mcp_tool_name)\n if self.parent_tool_call_id is not None:\n result[\"parentToolCallId\"] = from_union([from_none, from_str], self.parent_tool_call_id)\n if self.turn_id is not None:\n result[\"turnId\"] = from_union([from_none, from_str], self.turn_id)\n return result\n\n\n@dataclass\nclass ToolUserRequestedData:\n \"User-initiated tool invocation request with tool name and arguments\"\n tool_call_id: str\n tool_name: str\n arguments: Any = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"ToolUserRequestedData\":\n assert isinstance(obj, dict)\n tool_call_id = from_str(obj.get(\"toolCallId\"))\n tool_name = from_str(obj.get(\"toolName\"))\n arguments = obj.get(\"arguments\")\n return ToolUserRequestedData(\n tool_call_id=tool_call_id,\n tool_name=tool_name,\n arguments=arguments,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"toolCallId\"] = from_str(self.tool_call_id)\n result[\"toolName\"] = from_str(self.tool_name)\n if self.arguments is not None:\n result[\"arguments\"] = self.arguments\n return result\n\n\n@dataclass\nclass UserInputCompletedData:\n \"User input request completion with the user's response\"\n request_id: str\n answer: str | None = None\n was_freeform: bool | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"UserInputCompletedData\":\n assert isinstance(obj, dict)\n request_id = from_str(obj.get(\"requestId\"))\n answer = from_union([from_none, from_str], obj.get(\"answer\"))\n was_freeform = from_union([from_none, from_bool], obj.get(\"wasFreeform\"))\n return UserInputCompletedData(\n request_id=request_id,\n answer=answer,\n was_freeform=was_freeform,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"requestId\"] = from_str(self.request_id)\n if self.answer is not None:\n result[\"answer\"] = from_union([from_none, from_str], self.answer)\n if self.was_freeform is not None:\n result[\"wasFreeform\"] = from_union([from_none, from_bool], self.was_freeform)\n return result\n\n\n@dataclass\nclass UserInputRequestedData:\n \"User input request notification with question and optional predefined choices\"\n question: str\n request_id: str\n allow_freeform: bool | None = None\n choices: list[str] | None = None\n tool_call_id: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"UserInputRequestedData\":\n assert isinstance(obj, dict)\n question = from_str(obj.get(\"question\"))\n request_id = from_str(obj.get(\"requestId\"))\n allow_freeform = from_union([from_none, from_bool], obj.get(\"allowFreeform\"))\n choices = from_union([from_none, lambda x: from_list(from_str, x)], obj.get(\"choices\"))\n tool_call_id = from_union([from_none, from_str], obj.get(\"toolCallId\"))\n return UserInputRequestedData(\n question=question,\n request_id=request_id,\n allow_freeform=allow_freeform,\n choices=choices,\n tool_call_id=tool_call_id,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"question\"] = from_str(self.question)\n result[\"requestId\"] = from_str(self.request_id)\n if self.allow_freeform is not None:\n result[\"allowFreeform\"] = from_union([from_none, from_bool], self.allow_freeform)\n if self.choices is not None:\n result[\"choices\"] = from_union([from_none, lambda x: from_list(from_str, x)], self.choices)\n if self.tool_call_id is not None:\n result[\"toolCallId\"] = from_union([from_none, from_str], self.tool_call_id)\n return result\n\n\n@dataclass\nclass UserMessageAttachment:\n \"A user message attachment — a file, directory, code selection, blob, or GitHub reference\"\n type: UserMessageAttachmentType\n data: str | None = None\n display_name: str | None = None\n file_path: str | None = None\n line_range: UserMessageAttachmentFileLineRange | None = None\n mime_type: str | None = None\n number: float | None = None\n path: str | None = None\n reference_type: UserMessageAttachmentGithubReferenceType | None = None\n selection: UserMessageAttachmentSelectionDetails | None = None\n state: str | None = None\n text: str | None = None\n title: str | None = None\n url: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"UserMessageAttachment\":\n assert isinstance(obj, dict)\n type = parse_enum(UserMessageAttachmentType, obj.get(\"type\"))\n data = from_union([from_none, from_str], obj.get(\"data\"))\n display_name = from_union([from_none, from_str], obj.get(\"displayName\"))\n file_path = from_union([from_none, from_str], obj.get(\"filePath\"))\n line_range = from_union([from_none, UserMessageAttachmentFileLineRange.from_dict], obj.get(\"lineRange\"))\n mime_type = from_union([from_none, from_str], obj.get(\"mimeType\"))\n number = from_union([from_none, from_float], obj.get(\"number\"))\n path = from_union([from_none, from_str], obj.get(\"path\"))\n reference_type = from_union([from_none, lambda x: parse_enum(UserMessageAttachmentGithubReferenceType, x)], obj.get(\"referenceType\"))\n selection = from_union([from_none, UserMessageAttachmentSelectionDetails.from_dict], obj.get(\"selection\"))\n state = from_union([from_none, from_str], obj.get(\"state\"))\n text = from_union([from_none, from_str], obj.get(\"text\"))\n title = from_union([from_none, from_str], obj.get(\"title\"))\n url = from_union([from_none, from_str], obj.get(\"url\"))\n return UserMessageAttachment(\n type=type,\n data=data,\n display_name=display_name,\n file_path=file_path,\n line_range=line_range,\n mime_type=mime_type,\n number=number,\n path=path,\n reference_type=reference_type,\n selection=selection,\n state=state,\n text=text,\n title=title,\n url=url,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"type\"] = to_enum(UserMessageAttachmentType, self.type)\n if self.data is not None:\n result[\"data\"] = from_union([from_none, from_str], self.data)\n if self.display_name is not None:\n result[\"displayName\"] = from_union([from_none, from_str], self.display_name)\n if self.file_path is not None:\n result[\"filePath\"] = from_union([from_none, from_str], self.file_path)\n if self.line_range is not None:\n result[\"lineRange\"] = from_union([from_none, lambda x: to_class(UserMessageAttachmentFileLineRange, x)], self.line_range)\n if self.mime_type is not None:\n result[\"mimeType\"] = from_union([from_none, from_str], self.mime_type)\n if self.number is not None:\n result[\"number\"] = from_union([from_none, to_float], self.number)\n if self.path is not None:\n result[\"path\"] = from_union([from_none, from_str], self.path)\n if self.reference_type is not None:\n result[\"referenceType\"] = from_union([from_none, lambda x: to_enum(UserMessageAttachmentGithubReferenceType, x)], self.reference_type)\n if self.selection is not None:\n result[\"selection\"] = from_union([from_none, lambda x: to_class(UserMessageAttachmentSelectionDetails, x)], self.selection)\n if self.state is not None:\n result[\"state\"] = from_union([from_none, from_str], self.state)\n if self.text is not None:\n result[\"text\"] = from_union([from_none, from_str], self.text)\n if self.title is not None:\n result[\"title\"] = from_union([from_none, from_str], self.title)\n if self.url is not None:\n result[\"url\"] = from_union([from_none, from_str], self.url)\n return result\n\n\n@dataclass\nclass UserMessageAttachmentFileLineRange:\n \"Optional line range to scope the attachment to a specific section of the file\"\n end: float\n start: float\n\n @staticmethod\n def from_dict(obj: Any) -> \"UserMessageAttachmentFileLineRange\":\n assert isinstance(obj, dict)\n end = from_float(obj.get(\"end\"))\n start = from_float(obj.get(\"start\"))\n return UserMessageAttachmentFileLineRange(\n end=end,\n start=start,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"end\"] = to_float(self.end)\n result[\"start\"] = to_float(self.start)\n return result\n\n\n@dataclass\nclass UserMessageAttachmentSelectionDetails:\n \"Position range of the selection within the file\"\n end: UserMessageAttachmentSelectionDetailsEnd\n start: UserMessageAttachmentSelectionDetailsStart\n\n @staticmethod\n def from_dict(obj: Any) -> \"UserMessageAttachmentSelectionDetails\":\n assert isinstance(obj, dict)\n end = UserMessageAttachmentSelectionDetailsEnd.from_dict(obj.get(\"end\"))\n start = UserMessageAttachmentSelectionDetailsStart.from_dict(obj.get(\"start\"))\n return UserMessageAttachmentSelectionDetails(\n end=end,\n start=start,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"end\"] = to_class(UserMessageAttachmentSelectionDetailsEnd, self.end)\n result[\"start\"] = to_class(UserMessageAttachmentSelectionDetailsStart, self.start)\n return result\n\n\n@dataclass\nclass UserMessageAttachmentSelectionDetailsEnd:\n \"End position of the selection\"\n character: float\n line: float\n\n @staticmethod\n def from_dict(obj: Any) -> \"UserMessageAttachmentSelectionDetailsEnd\":\n assert isinstance(obj, dict)\n character = from_float(obj.get(\"character\"))\n line = from_float(obj.get(\"line\"))\n return UserMessageAttachmentSelectionDetailsEnd(\n character=character,\n line=line,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"character\"] = to_float(self.character)\n result[\"line\"] = to_float(self.line)\n return result\n\n\n@dataclass\nclass UserMessageAttachmentSelectionDetailsStart:\n \"Start position of the selection\"\n character: float\n line: float\n\n @staticmethod\n def from_dict(obj: Any) -> \"UserMessageAttachmentSelectionDetailsStart\":\n assert isinstance(obj, dict)\n character = from_float(obj.get(\"character\"))\n line = from_float(obj.get(\"line\"))\n return UserMessageAttachmentSelectionDetailsStart(\n character=character,\n line=line,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"character\"] = to_float(self.character)\n result[\"line\"] = to_float(self.line)\n return result\n\n\n@dataclass\nclass UserMessageData:\n content: str\n agent_mode: UserMessageAgentMode | None = None\n attachments: list[UserMessageAttachment] | None = None\n interaction_id: str | None = None\n native_document_path_fallback_paths: list[str] | None = None\n parent_agent_task_id: str | None = None\n source: str | None = None\n supported_native_document_mime_types: list[str] | None = None\n transformed_content: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"UserMessageData\":\n assert isinstance(obj, dict)\n content = from_str(obj.get(\"content\"))\n agent_mode = from_union([from_none, lambda x: parse_enum(UserMessageAgentMode, x)], obj.get(\"agentMode\"))\n attachments = from_union([from_none, lambda x: from_list(UserMessageAttachment.from_dict, x)], obj.get(\"attachments\"))\n interaction_id = from_union([from_none, from_str], obj.get(\"interactionId\"))\n native_document_path_fallback_paths = from_union([from_none, lambda x: from_list(from_str, x)], obj.get(\"nativeDocumentPathFallbackPaths\"))\n parent_agent_task_id = from_union([from_none, from_str], obj.get(\"parentAgentTaskId\"))\n source = from_union([from_none, from_str], obj.get(\"source\"))\n supported_native_document_mime_types = from_union([from_none, lambda x: from_list(from_str, x)], obj.get(\"supportedNativeDocumentMimeTypes\"))\n transformed_content = from_union([from_none, from_str], obj.get(\"transformedContent\"))\n return UserMessageData(\n content=content,\n agent_mode=agent_mode,\n attachments=attachments,\n interaction_id=interaction_id,\n native_document_path_fallback_paths=native_document_path_fallback_paths,\n parent_agent_task_id=parent_agent_task_id,\n source=source,\n supported_native_document_mime_types=supported_native_document_mime_types,\n transformed_content=transformed_content,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"content\"] = from_str(self.content)\n if self.agent_mode is not None:\n result[\"agentMode\"] = from_union([from_none, lambda x: to_enum(UserMessageAgentMode, x)], self.agent_mode)\n if self.attachments is not None:\n result[\"attachments\"] = from_union([from_none, lambda x: from_list(lambda x: to_class(UserMessageAttachment, x), x)], self.attachments)\n if self.interaction_id is not None:\n result[\"interactionId\"] = from_union([from_none, from_str], self.interaction_id)\n if self.native_document_path_fallback_paths is not None:\n result[\"nativeDocumentPathFallbackPaths\"] = from_union([from_none, lambda x: from_list(from_str, x)], self.native_document_path_fallback_paths)\n if self.parent_agent_task_id is not None:\n result[\"parentAgentTaskId\"] = from_union([from_none, from_str], self.parent_agent_task_id)\n if self.source is not None:\n result[\"source\"] = from_union([from_none, from_str], self.source)\n if self.supported_native_document_mime_types is not None:\n result[\"supportedNativeDocumentMimeTypes\"] = from_union([from_none, lambda x: from_list(from_str, x)], self.supported_native_document_mime_types)\n if self.transformed_content is not None:\n result[\"transformedContent\"] = from_union([from_none, from_str], self.transformed_content)\n return result\n\n\n@dataclass\nclass UserToolSessionApproval:\n \"The approval to add as a session-scoped rule\"\n kind: UserToolSessionApprovalKind\n command_identifiers: list[str] | None = None\n server_name: str | None = None\n tool_name: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"UserToolSessionApproval\":\n assert isinstance(obj, dict)\n kind = parse_enum(UserToolSessionApprovalKind, obj.get(\"kind\"))\n command_identifiers = from_union([from_none, lambda x: from_list(from_str, x)], obj.get(\"commandIdentifiers\"))\n server_name = from_union([from_none, from_str], obj.get(\"serverName\"))\n tool_name = from_union([from_none, from_str], obj.get(\"toolName\"))\n return UserToolSessionApproval(\n kind=kind,\n command_identifiers=command_identifiers,\n server_name=server_name,\n tool_name=tool_name,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"kind\"] = to_enum(UserToolSessionApprovalKind, self.kind)\n if self.command_identifiers is not None:\n result[\"commandIdentifiers\"] = from_union([from_none, lambda x: from_list(from_str, x)], self.command_identifiers)\n if self.server_name is not None:\n result[\"serverName\"] = from_union([from_none, from_str], self.server_name)\n if self.tool_name is not None:\n result[\"toolName\"] = from_union([from_none, from_str], self.tool_name)\n return result\n\n\n@dataclass\nclass WorkingDirectoryContext:\n \"Working directory and git context at session start\"\n cwd: str\n base_commit: str | None = None\n branch: str | None = None\n git_root: str | None = None\n head_commit: str | None = None\n host_type: WorkingDirectoryContextHostType | None = None\n repository: str | None = None\n repository_host: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"WorkingDirectoryContext\":\n assert isinstance(obj, dict)\n cwd = from_str(obj.get(\"cwd\"))\n base_commit = from_union([from_none, from_str], obj.get(\"baseCommit\"))\n branch = from_union([from_none, from_str], obj.get(\"branch\"))\n git_root = from_union([from_none, from_str], obj.get(\"gitRoot\"))\n head_commit = from_union([from_none, from_str], obj.get(\"headCommit\"))\n host_type = from_union([from_none, lambda x: parse_enum(WorkingDirectoryContextHostType, x)], obj.get(\"hostType\"))\n repository = from_union([from_none, from_str], obj.get(\"repository\"))\n repository_host = from_union([from_none, from_str], obj.get(\"repositoryHost\"))\n return WorkingDirectoryContext(\n cwd=cwd,\n base_commit=base_commit,\n branch=branch,\n git_root=git_root,\n head_commit=head_commit,\n host_type=host_type,\n repository=repository,\n repository_host=repository_host,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"cwd\"] = from_str(self.cwd)\n if self.base_commit is not None:\n result[\"baseCommit\"] = from_union([from_none, from_str], self.base_commit)\n if self.branch is not None:\n result[\"branch\"] = from_union([from_none, from_str], self.branch)\n if self.git_root is not None:\n result[\"gitRoot\"] = from_union([from_none, from_str], self.git_root)\n if self.head_commit is not None:\n result[\"headCommit\"] = from_union([from_none, from_str], self.head_commit)\n if self.host_type is not None:\n result[\"hostType\"] = from_union([from_none, lambda x: to_enum(WorkingDirectoryContextHostType, x)], self.host_type)\n if self.repository is not None:\n result[\"repository\"] = from_union([from_none, from_str], self.repository)\n if self.repository_host is not None:\n result[\"repositoryHost\"] = from_union([from_none, from_str], self.repository_host)\n return result\n\n\nclass AssistantMessageToolRequestType(Enum):\n \"Tool call type: \\\"function\\\" for standard tool calls, \\\"custom\\\" for grammar-based tool calls. Defaults to \\\"function\\\" when absent.\"\n FUNCTION = \"function\"\n CUSTOM = \"custom\"\n\n\nclass ElicitationCompletedAction(Enum):\n \"The user action: \\\"accept\\\" (submitted form), \\\"decline\\\" (explicitly refused), or \\\"cancel\\\" (dismissed)\"\n ACCEPT = \"accept\"\n DECLINE = \"decline\"\n CANCEL = \"cancel\"\n\n\nclass ElicitationRequestedMode(Enum):\n \"Elicitation mode; \\\"form\\\" for structured input, \\\"url\\\" for browser-based. Defaults to \\\"form\\\" when absent.\"\n FORM = \"form\"\n URL = \"url\"\n\n\nclass ExtensionsLoadedExtensionSource(Enum):\n \"Discovery source\"\n PROJECT = \"project\"\n USER = \"user\"\n\n\nclass ExtensionsLoadedExtensionStatus(Enum):\n \"Current status: running, disabled, failed, or starting\"\n RUNNING = \"running\"\n DISABLED = \"disabled\"\n FAILED = \"failed\"\n STARTING = \"starting\"\n\n\nclass HandoffSourceType(Enum):\n \"Origin type of the session being handed off\"\n REMOTE = \"remote\"\n LOCAL = \"local\"\n\n\nclass McpServerStatusChangedStatus(Enum):\n \"New connection status: connected, failed, needs-auth, pending, disabled, or not_configured\"\n CONNECTED = \"connected\"\n FAILED = \"failed\"\n NEEDS_AUTH = \"needs-auth\"\n PENDING = \"pending\"\n DISABLED = \"disabled\"\n NOT_CONFIGURED = \"not_configured\"\n\n\nclass McpServersLoadedServerStatus(Enum):\n \"Connection status: connected, failed, needs-auth, pending, disabled, or not_configured\"\n CONNECTED = \"connected\"\n FAILED = \"failed\"\n NEEDS_AUTH = \"needs-auth\"\n PENDING = \"pending\"\n DISABLED = \"disabled\"\n NOT_CONFIGURED = \"not_configured\"\n\n\nclass ModelCallFailureSource(Enum):\n \"Where the failed model call originated\"\n TOP_LEVEL = \"top_level\"\n SUBAGENT = \"subagent\"\n MCP_SAMPLING = \"mcp_sampling\"\n\n\nclass PermissionPromptRequestKind(Enum):\n \"Derived user-facing permission prompt details for UI consumers discriminator\"\n COMMANDS = \"commands\"\n WRITE = \"write\"\n READ = \"read\"\n MCP = \"mcp\"\n URL = \"url\"\n MEMORY = \"memory\"\n CUSTOM_TOOL = \"custom-tool\"\n PATH = \"path\"\n HOOK = \"hook\"\n\n\nclass PermissionPromptRequestMemoryAction(Enum):\n \"Whether this is a store or vote memory operation\"\n STORE = \"store\"\n VOTE = \"vote\"\n\n\nclass PermissionPromptRequestMemoryDirection(Enum):\n \"Vote direction (vote only)\"\n UPVOTE = \"upvote\"\n DOWNVOTE = \"downvote\"\n\n\nclass PermissionPromptRequestPathAccessKind(Enum):\n \"Underlying permission kind that needs path approval\"\n READ = \"read\"\n SHELL = \"shell\"\n WRITE = \"write\"\n\n\nclass PermissionRequestKind(Enum):\n \"Details of the permission being requested discriminator\"\n SHELL = \"shell\"\n WRITE = \"write\"\n READ = \"read\"\n MCP = \"mcp\"\n URL = \"url\"\n MEMORY = \"memory\"\n CUSTOM_TOOL = \"custom-tool\"\n HOOK = \"hook\"\n\n\nclass PermissionRequestMemoryAction(Enum):\n \"Whether this is a store or vote memory operation\"\n STORE = \"store\"\n VOTE = \"vote\"\n\n\nclass PermissionRequestMemoryDirection(Enum):\n \"Vote direction (vote only)\"\n UPVOTE = \"upvote\"\n DOWNVOTE = \"downvote\"\n\n\nclass PermissionResultKind(Enum):\n \"The result of the permission request discriminator\"\n APPROVED = \"approved\"\n APPROVED_FOR_SESSION = \"approved-for-session\"\n APPROVED_FOR_LOCATION = \"approved-for-location\"\n CANCELLED = \"cancelled\"\n DENIED_BY_RULES = \"denied-by-rules\"\n DENIED_NO_APPROVAL_RULE_AND_COULD_NOT_REQUEST_FROM_USER = \"denied-no-approval-rule-and-could-not-request-from-user\"\n DENIED_INTERACTIVELY_BY_USER = \"denied-interactively-by-user\"\n DENIED_BY_CONTENT_EXCLUSION_POLICY = \"denied-by-content-exclusion-policy\"\n DENIED_BY_PERMISSION_REQUEST_HOOK = \"denied-by-permission-request-hook\"\n\n\nclass PlanChangedOperation(Enum):\n \"The type of operation performed on the plan file\"\n CREATE = \"create\"\n UPDATE = \"update\"\n DELETE = \"delete\"\n\n\nclass ShutdownType(Enum):\n \"Whether the session ended normally (\\\"routine\\\") or due to a crash/fatal error (\\\"error\\\")\"\n ROUTINE = \"routine\"\n ERROR = \"error\"\n\n\nclass SystemMessageRole(Enum):\n \"Message role: \\\"system\\\" for system prompts, \\\"developer\\\" for developer-injected instructions\"\n SYSTEM = \"system\"\n DEVELOPER = \"developer\"\n\n\nclass SystemNotificationAgentCompletedStatus(Enum):\n \"Whether the agent completed successfully or failed\"\n COMPLETED = \"completed\"\n FAILED = \"failed\"\n\n\nclass SystemNotificationType(Enum):\n \"Structured metadata identifying what triggered this notification discriminator\"\n AGENT_COMPLETED = \"agent_completed\"\n AGENT_IDLE = \"agent_idle\"\n NEW_INBOX_MESSAGE = \"new_inbox_message\"\n SHELL_COMPLETED = \"shell_completed\"\n SHELL_DETACHED_COMPLETED = \"shell_detached_completed\"\n INSTRUCTION_DISCOVERED = \"instruction_discovered\"\n\n\nclass ToolExecutionCompleteContentResourceLinkIconTheme(Enum):\n \"Theme variant this icon is intended for\"\n LIGHT = \"light\"\n DARK = \"dark\"\n\n\nclass ToolExecutionCompleteContentType(Enum):\n \"A content block within a tool result, which may be text, terminal output, image, audio, or a resource discriminator\"\n TEXT = \"text\"\n TERMINAL = \"terminal\"\n IMAGE = \"image\"\n AUDIO = \"audio\"\n RESOURCE_LINK = \"resource_link\"\n RESOURCE = \"resource\"\n\n\nclass UserMessageAgentMode(Enum):\n \"The agent mode that was active when this message was sent\"\n INTERACTIVE = \"interactive\"\n PLAN = \"plan\"\n AUTOPILOT = \"autopilot\"\n SHELL = \"shell\"\n\n\nclass UserMessageAttachmentGithubReferenceType(Enum):\n \"Type of GitHub reference\"\n ISSUE = \"issue\"\n PR = \"pr\"\n DISCUSSION = \"discussion\"\n\n\nclass UserMessageAttachmentType(Enum):\n \"A user message attachment — a file, directory, code selection, blob, or GitHub reference discriminator\"\n FILE = \"file\"\n DIRECTORY = \"directory\"\n SELECTION = \"selection\"\n GITHUB_REFERENCE = \"github_reference\"\n BLOB = \"blob\"\n\n\nclass UserToolSessionApprovalKind(Enum):\n \"The approval to add as a session-scoped rule discriminator\"\n COMMANDS = \"commands\"\n READ = \"read\"\n WRITE = \"write\"\n MCP = \"mcp\"\n MEMORY = \"memory\"\n CUSTOM_TOOL = \"custom-tool\"\n\n\nclass WorkingDirectoryContextHostType(Enum):\n \"Hosting platform type of the repository (github or ado)\"\n GITHUB = \"github\"\n ADO = \"ado\"\n\n\nclass WorkspaceFileChangedOperation(Enum):\n \"Whether the file was newly created or updated\"\n CREATE = \"create\"\n UPDATE = \"update\"\n\n\nSessionEventData = SessionStartData | SessionResumeData | SessionRemoteSteerableChangedData | SessionErrorData | SessionIdleData | SessionTitleChangedData | SessionInfoData | SessionWarningData | SessionModelChangeData | SessionModeChangedData | SessionPlanChangedData | SessionWorkspaceFileChangedData | SessionHandoffData | SessionTruncationData | SessionSnapshotRewindData | SessionShutdownData | SessionContextChangedData | SessionUsageInfoData | SessionCompactionStartData | SessionCompactionCompleteData | SessionTaskCompleteData | UserMessageData | PendingMessagesModifiedData | AssistantTurnStartData | AssistantIntentData | AssistantReasoningData | AssistantReasoningDeltaData | AssistantStreamingDeltaData | AssistantMessageData | AssistantMessageStartData | AssistantMessageDeltaData | AssistantTurnEndData | AssistantUsageData | ModelCallFailureData | AbortData | ToolUserRequestedData | ToolExecutionStartData | ToolExecutionPartialResultData | ToolExecutionProgressData | ToolExecutionCompleteData | SkillInvokedData | SubagentStartedData | SubagentCompletedData | SubagentFailedData | SubagentSelectedData | SubagentDeselectedData | HookStartData | HookEndData | SystemMessageData | SystemNotificationData | PermissionRequestedData | PermissionCompletedData | UserInputRequestedData | UserInputCompletedData | ElicitationRequestedData | ElicitationCompletedData | SamplingRequestedData | SamplingCompletedData | McpOauthRequiredData | McpOauthCompletedData | ExternalToolRequestedData | ExternalToolCompletedData | CommandQueuedData | CommandExecuteData | CommandCompletedData | AutoModeSwitchRequestedData | AutoModeSwitchCompletedData | CommandsChangedData | CapabilitiesChangedData | ExitPlanModeRequestedData | ExitPlanModeCompletedData | SessionToolsUpdatedData | SessionBackgroundTasksChangedData | SessionSkillsLoadedData | SessionCustomAgentsUpdatedData | SessionMcpServersLoadedData | SessionMcpServerStatusChangedData | SessionExtensionsLoadedData | RawSessionEventData | Data\n\n\n@dataclass\nclass SessionEvent:\n data: SessionEventData\n id: UUID\n timestamp: datetime\n type: SessionEventType\n agent_id: str | None = None\n ephemeral: bool | None = None\n parent_id: UUID | None = None\n raw_type: str | None = None\n\n @staticmethod\n def from_dict(obj: Any) -> \"SessionEvent\":\n assert isinstance(obj, dict)\n raw_type = from_str(obj.get(\"type\"))\n event_type = SessionEventType(raw_type)\n agent_id = from_union([from_none, from_str], obj.get(\"agentId\"))\n ephemeral = from_union([from_none, from_bool], obj.get(\"ephemeral\"))\n id = from_uuid(obj.get(\"id\"))\n parent_id = from_union([from_none, from_uuid], obj.get(\"parentId\"))\n timestamp = from_datetime(obj.get(\"timestamp\"))\n data_obj = obj.get(\"data\")\n match event_type:\n case SessionEventType.SESSION_START: data = SessionStartData.from_dict(data_obj)\n case SessionEventType.SESSION_RESUME: data = SessionResumeData.from_dict(data_obj)\n case SessionEventType.SESSION_REMOTE_STEERABLE_CHANGED: data = SessionRemoteSteerableChangedData.from_dict(data_obj)\n case SessionEventType.SESSION_ERROR: data = SessionErrorData.from_dict(data_obj)\n case SessionEventType.SESSION_IDLE: data = SessionIdleData.from_dict(data_obj)\n case SessionEventType.SESSION_TITLE_CHANGED: data = SessionTitleChangedData.from_dict(data_obj)\n case SessionEventType.SESSION_INFO: data = SessionInfoData.from_dict(data_obj)\n case SessionEventType.SESSION_WARNING: data = SessionWarningData.from_dict(data_obj)\n case SessionEventType.SESSION_MODEL_CHANGE: data = SessionModelChangeData.from_dict(data_obj)\n case SessionEventType.SESSION_MODE_CHANGED: data = SessionModeChangedData.from_dict(data_obj)\n case SessionEventType.SESSION_PLAN_CHANGED: data = SessionPlanChangedData.from_dict(data_obj)\n case SessionEventType.SESSION_WORKSPACE_FILE_CHANGED: data = SessionWorkspaceFileChangedData.from_dict(data_obj)\n case SessionEventType.SESSION_HANDOFF: data = SessionHandoffData.from_dict(data_obj)\n case SessionEventType.SESSION_TRUNCATION: data = SessionTruncationData.from_dict(data_obj)\n case SessionEventType.SESSION_SNAPSHOT_REWIND: data = SessionSnapshotRewindData.from_dict(data_obj)\n case SessionEventType.SESSION_SHUTDOWN: data = SessionShutdownData.from_dict(data_obj)\n case SessionEventType.SESSION_CONTEXT_CHANGED: data = SessionContextChangedData.from_dict(data_obj)\n case SessionEventType.SESSION_USAGE_INFO: data = SessionUsageInfoData.from_dict(data_obj)\n case SessionEventType.SESSION_COMPACTION_START: data = SessionCompactionStartData.from_dict(data_obj)\n case SessionEventType.SESSION_COMPACTION_COMPLETE: data = SessionCompactionCompleteData.from_dict(data_obj)\n case SessionEventType.SESSION_TASK_COMPLETE: data = SessionTaskCompleteData.from_dict(data_obj)\n case SessionEventType.USER_MESSAGE: data = UserMessageData.from_dict(data_obj)\n case SessionEventType.PENDING_MESSAGES_MODIFIED: data = PendingMessagesModifiedData.from_dict(data_obj)\n case SessionEventType.ASSISTANT_TURN_START: data = AssistantTurnStartData.from_dict(data_obj)\n case SessionEventType.ASSISTANT_INTENT: data = AssistantIntentData.from_dict(data_obj)\n case SessionEventType.ASSISTANT_REASONING: data = AssistantReasoningData.from_dict(data_obj)\n case SessionEventType.ASSISTANT_REASONING_DELTA: data = AssistantReasoningDeltaData.from_dict(data_obj)\n case SessionEventType.ASSISTANT_STREAMING_DELTA: data = AssistantStreamingDeltaData.from_dict(data_obj)\n case SessionEventType.ASSISTANT_MESSAGE: data = AssistantMessageData.from_dict(data_obj)\n case SessionEventType.ASSISTANT_MESSAGE_START: data = AssistantMessageStartData.from_dict(data_obj)\n case SessionEventType.ASSISTANT_MESSAGE_DELTA: data = AssistantMessageDeltaData.from_dict(data_obj)\n case SessionEventType.ASSISTANT_TURN_END: data = AssistantTurnEndData.from_dict(data_obj)\n case SessionEventType.ASSISTANT_USAGE: data = AssistantUsageData.from_dict(data_obj)\n case SessionEventType.MODEL_CALL_FAILURE: data = ModelCallFailureData.from_dict(data_obj)\n case SessionEventType.ABORT: data = AbortData.from_dict(data_obj)\n case SessionEventType.TOOL_USER_REQUESTED: data = ToolUserRequestedData.from_dict(data_obj)\n case SessionEventType.TOOL_EXECUTION_START: data = ToolExecutionStartData.from_dict(data_obj)\n case SessionEventType.TOOL_EXECUTION_PARTIAL_RESULT: data = ToolExecutionPartialResultData.from_dict(data_obj)\n case SessionEventType.TOOL_EXECUTION_PROGRESS: data = ToolExecutionProgressData.from_dict(data_obj)\n case SessionEventType.TOOL_EXECUTION_COMPLETE: data = ToolExecutionCompleteData.from_dict(data_obj)\n case SessionEventType.SKILL_INVOKED: data = SkillInvokedData.from_dict(data_obj)\n case SessionEventType.SUBAGENT_STARTED: data = SubagentStartedData.from_dict(data_obj)\n case SessionEventType.SUBAGENT_COMPLETED: data = SubagentCompletedData.from_dict(data_obj)\n case SessionEventType.SUBAGENT_FAILED: data = SubagentFailedData.from_dict(data_obj)\n case SessionEventType.SUBAGENT_SELECTED: data = SubagentSelectedData.from_dict(data_obj)\n case SessionEventType.SUBAGENT_DESELECTED: data = SubagentDeselectedData.from_dict(data_obj)\n case SessionEventType.HOOK_START: data = HookStartData.from_dict(data_obj)\n case SessionEventType.HOOK_END: data = HookEndData.from_dict(data_obj)\n case SessionEventType.SYSTEM_MESSAGE: data = SystemMessageData.from_dict(data_obj)\n case SessionEventType.SYSTEM_NOTIFICATION: data = SystemNotificationData.from_dict(data_obj)\n case SessionEventType.PERMISSION_REQUESTED: data = PermissionRequestedData.from_dict(data_obj)\n case SessionEventType.PERMISSION_COMPLETED: data = PermissionCompletedData.from_dict(data_obj)\n case SessionEventType.USER_INPUT_REQUESTED: data = UserInputRequestedData.from_dict(data_obj)\n case SessionEventType.USER_INPUT_COMPLETED: data = UserInputCompletedData.from_dict(data_obj)\n case SessionEventType.ELICITATION_REQUESTED: data = ElicitationRequestedData.from_dict(data_obj)\n case SessionEventType.ELICITATION_COMPLETED: data = ElicitationCompletedData.from_dict(data_obj)\n case SessionEventType.SAMPLING_REQUESTED: data = SamplingRequestedData.from_dict(data_obj)\n case SessionEventType.SAMPLING_COMPLETED: data = SamplingCompletedData.from_dict(data_obj)\n case SessionEventType.MCP_OAUTH_REQUIRED: data = McpOauthRequiredData.from_dict(data_obj)\n case SessionEventType.MCP_OAUTH_COMPLETED: data = McpOauthCompletedData.from_dict(data_obj)\n case SessionEventType.EXTERNAL_TOOL_REQUESTED: data = ExternalToolRequestedData.from_dict(data_obj)\n case SessionEventType.EXTERNAL_TOOL_COMPLETED: data = ExternalToolCompletedData.from_dict(data_obj)\n case SessionEventType.COMMAND_QUEUED: data = CommandQueuedData.from_dict(data_obj)\n case SessionEventType.COMMAND_EXECUTE: data = CommandExecuteData.from_dict(data_obj)\n case SessionEventType.COMMAND_COMPLETED: data = CommandCompletedData.from_dict(data_obj)\n case SessionEventType.AUTO_MODE_SWITCH_REQUESTED: data = AutoModeSwitchRequestedData.from_dict(data_obj)\n case SessionEventType.AUTO_MODE_SWITCH_COMPLETED: data = AutoModeSwitchCompletedData.from_dict(data_obj)\n case SessionEventType.COMMANDS_CHANGED: data = CommandsChangedData.from_dict(data_obj)\n case SessionEventType.CAPABILITIES_CHANGED: data = CapabilitiesChangedData.from_dict(data_obj)\n case SessionEventType.EXIT_PLAN_MODE_REQUESTED: data = ExitPlanModeRequestedData.from_dict(data_obj)\n case SessionEventType.EXIT_PLAN_MODE_COMPLETED: data = ExitPlanModeCompletedData.from_dict(data_obj)\n case SessionEventType.SESSION_TOOLS_UPDATED: data = SessionToolsUpdatedData.from_dict(data_obj)\n case SessionEventType.SESSION_BACKGROUND_TASKS_CHANGED: data = SessionBackgroundTasksChangedData.from_dict(data_obj)\n case SessionEventType.SESSION_SKILLS_LOADED: data = SessionSkillsLoadedData.from_dict(data_obj)\n case SessionEventType.SESSION_CUSTOM_AGENTS_UPDATED: data = SessionCustomAgentsUpdatedData.from_dict(data_obj)\n case SessionEventType.SESSION_MCP_SERVERS_LOADED: data = SessionMcpServersLoadedData.from_dict(data_obj)\n case SessionEventType.SESSION_MCP_SERVER_STATUS_CHANGED: data = SessionMcpServerStatusChangedData.from_dict(data_obj)\n case SessionEventType.SESSION_EXTENSIONS_LOADED: data = SessionExtensionsLoadedData.from_dict(data_obj)\n case _: data = RawSessionEventData.from_dict(data_obj)\n return SessionEvent(\n data=data,\n id=id,\n timestamp=timestamp,\n type=event_type,\n agent_id=agent_id,\n ephemeral=ephemeral,\n parent_id=parent_id,\n raw_type=raw_type if event_type == SessionEventType.UNKNOWN else None,\n )\n\n def to_dict(self) -> dict:\n result: dict = {}\n result[\"data\"] = self.data.to_dict()\n result[\"id\"] = to_uuid(self.id)\n result[\"timestamp\"] = to_datetime(self.timestamp)\n result[\"type\"] = self.raw_type if self.type == SessionEventType.UNKNOWN and self.raw_type is not None else to_enum(SessionEventType, self.type)\n if self.agent_id is not None:\n result[\"agentId\"] = from_union([from_none, from_str], self.agent_id)\n if self.ephemeral is not None:\n result[\"ephemeral\"] = from_union([from_none, from_bool], self.ephemeral)\n result[\"parentId\"] = from_union([from_none, to_uuid], self.parent_id)\n return result\n\n\ndef session_event_from_dict(s: Any) -> SessionEvent:\n return SessionEvent.from_dict(s)\n\n\ndef session_event_to_dict(x: SessionEvent) -> Any:\n return x.to_dict()\n\n" }, { "path": "python/copilot/py.typed", "content": "\n" }, { "path": "python/copilot/session.py", "content": "\"\"\"\nCopilot Session - represents a single conversation session with the Copilot CLI.\n\nThis module provides the CopilotSession class for managing individual\nconversation sessions with the Copilot CLI, along with all session-related\nconfiguration and handler types.\n\"\"\"\n\nfrom __future__ import annotations\n\nimport asyncio\nimport functools\nimport inspect\nimport os\nimport pathlib\nimport threading\nfrom collections.abc import Awaitable, Callable\nfrom dataclasses import dataclass\nfrom types import TracebackType\nfrom typing import TYPE_CHECKING, Any, Literal, NotRequired, Required, TypedDict, cast\n\nfrom ._jsonrpc import JsonRpcError, ProcessExitedError\nfrom ._telemetry import get_trace_context, trace_context\nfrom .generated.rpc import (\n ClientSessionApiHandlers,\n CommandsHandlePendingCommandRequest,\n ExternalToolTextResultForLlm,\n HandlePendingToolCallRequest,\n LogRequest,\n ModelSwitchToRequest,\n PermissionDecision,\n PermissionDecisionKind,\n PermissionDecisionRequest,\n SessionLogLevel,\n SessionRpc,\n UIElicitationRequest,\n UIElicitationResponse,\n UIElicitationResponseAction,\n UIElicitationSchema,\n UIElicitationSchemaProperty,\n UIElicitationSchemaPropertyType,\n UIElicitationSchemaType,\n UIHandlePendingElicitationRequest,\n)\nfrom .generated.rpc import ModelCapabilitiesOverride as _RpcModelCapabilitiesOverride\nfrom .generated.session_events import (\n AssistantMessageData,\n CapabilitiesChangedData,\n CommandExecuteData,\n ElicitationRequestedData,\n ExternalToolRequestedData,\n PermissionRequest,\n PermissionRequestedData,\n SessionErrorData,\n SessionEvent,\n SessionIdleData,\n session_event_from_dict,\n)\nfrom .tools import Tool, ToolHandler, ToolInvocation, ToolResult\n\nif TYPE_CHECKING:\n from .client import ModelCapabilitiesOverride\n from .session_fs_provider import SessionFsProvider\n\n# Re-export SessionEvent under an alias used internally\nSessionEventTypeAlias = SessionEvent\n\n# ============================================================================\n# Reasoning Effort\n# ============================================================================\n\nReasoningEffort = Literal[\"low\", \"medium\", \"high\", \"xhigh\"]\nSessionFsConventions = Literal[\"posix\", \"windows\"]\n\n\nclass SessionFsConfig(TypedDict):\n initial_cwd: str\n session_state_path: str\n conventions: SessionFsConventions\n\n\n# ============================================================================\n# Attachment Types\n# ============================================================================\n\n\nclass SelectionRange(TypedDict):\n line: int\n character: int\n\n\nclass Selection(TypedDict):\n start: SelectionRange\n end: SelectionRange\n\n\nclass FileAttachment(TypedDict):\n \"\"\"File attachment.\"\"\"\n\n type: Literal[\"file\"]\n path: str\n displayName: NotRequired[str]\n\n\nclass DirectoryAttachment(TypedDict):\n \"\"\"Directory attachment.\"\"\"\n\n type: Literal[\"directory\"]\n path: str\n displayName: NotRequired[str]\n\n\nclass SelectionAttachment(TypedDict):\n \"\"\"Selection attachment with text from a file.\"\"\"\n\n type: Literal[\"selection\"]\n filePath: str\n displayName: str\n selection: NotRequired[Selection]\n text: NotRequired[str]\n\n\nclass BlobAttachment(TypedDict):\n \"\"\"Inline base64-encoded content attachment (e.g. images).\"\"\"\n\n type: Literal[\"blob\"]\n data: str\n \"\"\"Base64-encoded content\"\"\"\n mimeType: str\n \"\"\"MIME type of the inline data\"\"\"\n displayName: NotRequired[str]\n\n\nAttachment = FileAttachment | DirectoryAttachment | SelectionAttachment | BlobAttachment\n\n# ============================================================================\n# System Message Configuration\n# ============================================================================\n\n\nclass SystemMessageAppendConfig(TypedDict, total=False):\n \"\"\"\n Append mode: Use CLI foundation with optional appended content.\n \"\"\"\n\n mode: NotRequired[Literal[\"append\"]]\n content: NotRequired[str]\n\n\nclass SystemMessageReplaceConfig(TypedDict):\n \"\"\"\n Replace mode: Use caller-provided system message entirely.\n Removes all SDK guardrails including security restrictions.\n \"\"\"\n\n mode: Literal[\"replace\"]\n content: str\n\n\n# Known system prompt section identifiers for the \"customize\" mode.\n\nSectionTransformFn = Callable[[str], str | Awaitable[str]]\n\"\"\"Transform callback: receives current section content, returns new content.\"\"\"\n\nSectionOverrideAction = Literal[\"replace\", \"remove\", \"append\", \"prepend\"] | SectionTransformFn\n\"\"\"Override action: a string literal for static overrides, or a callback for transforms.\"\"\"\n\nSystemPromptSection = Literal[\n \"identity\",\n \"tone\",\n \"tool_efficiency\",\n \"environment_context\",\n \"code_change_rules\",\n \"guidelines\",\n \"safety\",\n \"tool_instructions\",\n \"custom_instructions\",\n \"last_instructions\",\n]\n\nSYSTEM_PROMPT_SECTIONS: dict[SystemPromptSection, str] = {\n \"identity\": \"Agent identity preamble and mode statement\",\n \"tone\": \"Response style, conciseness rules, output formatting preferences\",\n \"tool_efficiency\": \"Tool usage patterns, parallel calling, batching guidelines\",\n \"environment_context\": \"CWD, OS, git root, directory listing, available tools\",\n \"code_change_rules\": \"Coding rules, linting/testing, ecosystem tools, style\",\n \"guidelines\": \"Tips, behavioral best practices, behavioral guidelines\",\n \"safety\": \"Environment limitations, prohibited actions, security policies\",\n \"tool_instructions\": \"Per-tool usage instructions\",\n \"custom_instructions\": \"Repository and organization custom instructions\",\n \"last_instructions\": (\n \"End-of-prompt instructions: parallel tool calling, persistence, task completion\"\n ),\n}\n\n\nclass SectionOverride(TypedDict, total=False):\n \"\"\"Override operation for a single system prompt section.\"\"\"\n\n action: Required[SectionOverrideAction]\n content: NotRequired[str]\n\n\nclass SystemMessageCustomizeConfig(TypedDict, total=False):\n \"\"\"\n Customize mode: Override individual sections of the system prompt.\n Keeps the SDK-managed prompt structure while allowing targeted modifications.\n \"\"\"\n\n mode: Required[Literal[\"customize\"]]\n sections: NotRequired[dict[SystemPromptSection, SectionOverride]]\n content: NotRequired[str]\n\n\nSystemMessageConfig = (\n SystemMessageAppendConfig | SystemMessageReplaceConfig | SystemMessageCustomizeConfig\n)\n\n# ============================================================================\n# Permission Types\n# ============================================================================\n\nPermissionRequestResultKind = Literal[\n \"approve-once\",\n \"reject\",\n \"user-not-available\",\n \"no-result\",\n]\n\n\n@dataclass\nclass PermissionRequestResult:\n \"\"\"Result of a permission request.\"\"\"\n\n kind: PermissionRequestResultKind = \"user-not-available\"\n\n\n_PermissionHandlerFn = Callable[\n [PermissionRequest, dict[str, str]],\n PermissionRequestResult | Awaitable[PermissionRequestResult],\n]\n\n\nclass PermissionHandler:\n @staticmethod\n def approve_all(\n request: PermissionRequest, invocation: dict[str, str]\n ) -> PermissionRequestResult:\n return PermissionRequestResult(kind=\"approve-once\")\n\n\n# ============================================================================\n# User Input Request Types\n# ============================================================================\n\n\nclass UserInputRequest(TypedDict, total=False):\n \"\"\"Request for user input from the agent (enables ask_user tool)\"\"\"\n\n question: str\n choices: list[str]\n allowFreeform: bool\n\n\nclass UserInputResponse(TypedDict):\n \"\"\"Response to a user input request\"\"\"\n\n answer: str\n wasFreeform: bool\n\n\nUserInputHandler = Callable[\n [UserInputRequest, dict[str, str]],\n UserInputResponse | Awaitable[UserInputResponse],\n]\n\n# ============================================================================\n# Command Types\n# ============================================================================\n\n\n@dataclass\nclass CommandContext:\n \"\"\"Context passed to a command handler when a command is executed.\"\"\"\n\n session_id: str\n \"\"\"Session ID where the command was invoked.\"\"\"\n command: str\n \"\"\"The full command text (e.g. ``\"/deploy production\"``).\"\"\"\n command_name: str\n \"\"\"Command name without leading ``/``.\"\"\"\n args: str\n \"\"\"Raw argument string after the command name.\"\"\"\n\n\nCommandHandler = Callable[[CommandContext], Awaitable[None] | None]\n\"\"\"Handler invoked when a registered command is executed by a user.\"\"\"\n\n\n@dataclass\nclass CommandDefinition:\n \"\"\"Definition of a slash command registered with the session.\n\n When the CLI is running with a TUI, registered commands appear as\n ``/commandName`` for the user to invoke.\n \"\"\"\n\n name: str\n \"\"\"Command name (without leading ``/``).\"\"\"\n handler: CommandHandler\n \"\"\"Handler invoked when the command is executed.\"\"\"\n description: str | None = None\n \"\"\"Human-readable description shown in command completion UI.\"\"\"\n\n\n# ============================================================================\n# Session Capabilities\n# ============================================================================\n\n\nclass SessionUiCapabilities(TypedDict, total=False):\n \"\"\"UI capabilities reported by the CLI host.\"\"\"\n\n elicitation: bool\n \"\"\"Whether the host supports interactive elicitation dialogs.\"\"\"\n\n\nclass SessionCapabilities(TypedDict, total=False):\n \"\"\"Capabilities reported by the CLI host for this session.\"\"\"\n\n ui: SessionUiCapabilities\n\n\n# ============================================================================\n# Elicitation Types (client → server)\n# ============================================================================\n\nElicitationFieldValue = str | float | bool | list[str]\n\"\"\"Possible value types in elicitation form content.\"\"\"\n\n\nclass ElicitationResult(TypedDict, total=False):\n \"\"\"Result returned from an elicitation request.\"\"\"\n\n action: Required[Literal[\"accept\", \"decline\", \"cancel\"]]\n \"\"\"User action: ``\"accept\"`` (submitted), ``\"decline\"`` (rejected),\n or ``\"cancel\"`` (dismissed).\"\"\"\n content: dict[str, ElicitationFieldValue]\n \"\"\"Form values submitted by the user (present when action is ``\"accept\"``).\"\"\"\n\n\nclass ElicitationParams(TypedDict):\n \"\"\"Parameters for a raw elicitation request.\"\"\"\n\n message: str\n \"\"\"Message describing what information is needed from the user.\"\"\"\n requestedSchema: dict[str, Any]\n \"\"\"JSON Schema describing the form fields to present.\"\"\"\n\n\nclass InputOptions(TypedDict, total=False):\n \"\"\"Options for the ``input()`` convenience method.\"\"\"\n\n title: str\n \"\"\"Title label for the input field.\"\"\"\n description: str\n \"\"\"Descriptive text shown below the field.\"\"\"\n minLength: int\n \"\"\"Minimum text length.\"\"\"\n maxLength: int\n \"\"\"Maximum text length.\"\"\"\n format: str\n \"\"\"Input format hint (e.g. ``\"email\"``, ``\"uri\"``, ``\"date\"``).\"\"\"\n default: str\n \"\"\"Default value for the input field.\"\"\"\n\n\n# ============================================================================\n# Elicitation Types (server → client callback)\n# ============================================================================\n\n\nclass ElicitationContext(TypedDict, total=False):\n \"\"\"Context for an elicitation handler invocation, combining the request data\n with session context. Mirrors the single-argument pattern of CommandContext.\"\"\"\n\n session_id: Required[str]\n \"\"\"Identifier of the session that triggered the elicitation request.\"\"\"\n message: Required[str]\n \"\"\"Message describing what information is needed from the user.\"\"\"\n requestedSchema: dict[str, Any]\n \"\"\"JSON Schema describing the form fields to present.\"\"\"\n mode: Literal[\"form\", \"url\"]\n \"\"\"Elicitation mode: ``\"form\"`` for structured input, ``\"url\"`` for browser redirect.\"\"\"\n elicitationSource: str\n \"\"\"The source that initiated the request (e.g. MCP server name).\"\"\"\n url: str\n \"\"\"URL to open in the browser (when mode is ``\"url\"``).\"\"\"\n\n\nElicitationHandler = Callable[\n [ElicitationContext],\n ElicitationResult | Awaitable[ElicitationResult],\n]\n\"\"\"Handler invoked when the server dispatches an elicitation request to this client.\"\"\"\n\nCreateSessionFsHandler = Callable[[\"CopilotSession\"], \"SessionFsProvider\"]\n\n\n# ============================================================================\n# Session UI API\n# ============================================================================\n\n\nclass SessionUiApi:\n \"\"\"Interactive UI methods for showing dialogs to the user.\n\n Only available when the CLI host supports elicitation\n (``session.capabilities[\"ui\"][\"elicitation\"] is True``).\n\n Obtained via :attr:`CopilotSession.ui`.\n \"\"\"\n\n def __init__(self, session: CopilotSession) -> None:\n self._session = session\n\n async def elicitation(self, params: ElicitationParams) -> ElicitationResult:\n \"\"\"Shows a generic elicitation dialog with a custom schema.\n\n Args:\n params: Elicitation parameters including message and requestedSchema.\n\n Returns:\n The user's response (action + optional content).\n\n Raises:\n RuntimeError: If the host does not support elicitation.\n \"\"\"\n self._session._assert_elicitation()\n rpc_result = await self._session.rpc.ui.elicitation(\n UIElicitationRequest(\n message=params[\"message\"],\n requested_schema=UIElicitationSchema.from_dict(params[\"requestedSchema\"]),\n )\n )\n result: ElicitationResult = {\"action\": rpc_result.action.value}\n if rpc_result.content is not None:\n result[\"content\"] = rpc_result.content\n return result\n\n async def confirm(self, message: str) -> bool:\n \"\"\"Shows a confirmation dialog and returns the user's boolean answer.\n\n Args:\n message: The question to ask the user.\n\n Returns:\n ``True`` if the user accepted, ``False`` otherwise.\n\n Raises:\n RuntimeError: If the host does not support elicitation.\n \"\"\"\n self._session._assert_elicitation()\n rpc_result = await self._session.rpc.ui.elicitation(\n UIElicitationRequest(\n message=message,\n requested_schema=UIElicitationSchema(\n type=UIElicitationSchemaType.OBJECT,\n properties={\n \"confirmed\": UIElicitationSchemaProperty(\n type=UIElicitationSchemaPropertyType.BOOLEAN,\n default=True,\n ),\n },\n required=[\"confirmed\"],\n ),\n )\n )\n return (\n rpc_result.action == UIElicitationResponseAction.ACCEPT\n and rpc_result.content is not None\n and rpc_result.content.get(\"confirmed\") is True\n )\n\n async def select(self, message: str, options: list[str]) -> str | None:\n \"\"\"Shows a selection dialog with a list of options.\n\n Args:\n message: Instruction to show the user.\n options: List of choices the user can pick from.\n\n Returns:\n The selected string, or ``None`` if the user declined/cancelled.\n\n Raises:\n RuntimeError: If the host does not support elicitation.\n \"\"\"\n self._session._assert_elicitation()\n rpc_result = await self._session.rpc.ui.elicitation(\n UIElicitationRequest(\n message=message,\n requested_schema=UIElicitationSchema(\n type=UIElicitationSchemaType.OBJECT,\n properties={\n \"selection\": UIElicitationSchemaProperty(\n type=UIElicitationSchemaPropertyType.STRING,\n enum=options,\n ),\n },\n required=[\"selection\"],\n ),\n )\n )\n if (\n rpc_result.action == UIElicitationResponseAction.ACCEPT\n and rpc_result.content is not None\n and rpc_result.content.get(\"selection\") is not None\n ):\n return str(rpc_result.content[\"selection\"])\n return None\n\n async def input(self, message: str, options: InputOptions | None = None) -> str | None:\n \"\"\"Shows a text input dialog.\n\n Args:\n message: Instruction to show the user.\n options: Optional constraints for the input field.\n\n Returns:\n The entered text, or ``None`` if the user declined/cancelled.\n\n Raises:\n RuntimeError: If the host does not support elicitation.\n \"\"\"\n self._session._assert_elicitation()\n field: dict[str, Any] = {\"type\": \"string\"}\n if options:\n for key in (\"title\", \"description\", \"minLength\", \"maxLength\", \"format\", \"default\"):\n if key in options:\n field[key] = options[key]\n\n rpc_result = await self._session.rpc.ui.elicitation(\n UIElicitationRequest(\n message=message,\n requested_schema=UIElicitationSchema.from_dict(\n {\n \"type\": \"object\",\n \"properties\": {\"value\": field},\n \"required\": [\"value\"],\n }\n ),\n )\n )\n if (\n rpc_result.action == UIElicitationResponseAction.ACCEPT\n and rpc_result.content is not None\n and rpc_result.content.get(\"value\") is not None\n ):\n return str(rpc_result.content[\"value\"])\n return None\n\n\n# ============================================================================\n# Hook Types\n# ============================================================================\n\n\nclass BaseHookInput(TypedDict):\n \"\"\"Base interface for all hook inputs\"\"\"\n\n timestamp: int\n cwd: str\n\n\nclass PreToolUseHookInput(TypedDict):\n \"\"\"Input for pre-tool-use hook\"\"\"\n\n timestamp: int\n cwd: str\n toolName: str\n toolArgs: Any\n\n\nclass PreToolUseHookOutput(TypedDict, total=False):\n \"\"\"Output for pre-tool-use hook\"\"\"\n\n permissionDecision: Literal[\"allow\", \"deny\", \"ask\"]\n permissionDecisionReason: str\n modifiedArgs: Any\n additionalContext: str\n suppressOutput: bool\n\n\nPreToolUseHandler = Callable[\n [PreToolUseHookInput, dict[str, str]],\n PreToolUseHookOutput | None | Awaitable[PreToolUseHookOutput | None],\n]\n\n\nclass PostToolUseHookInput(TypedDict):\n \"\"\"Input for post-tool-use hook\"\"\"\n\n timestamp: int\n cwd: str\n toolName: str\n toolArgs: Any\n toolResult: Any\n\n\nclass PostToolUseHookOutput(TypedDict, total=False):\n \"\"\"Output for post-tool-use hook\"\"\"\n\n modifiedResult: Any\n additionalContext: str\n suppressOutput: bool\n\n\nPostToolUseHandler = Callable[\n [PostToolUseHookInput, dict[str, str]],\n PostToolUseHookOutput | None | Awaitable[PostToolUseHookOutput | None],\n]\n\n\nclass UserPromptSubmittedHookInput(TypedDict):\n \"\"\"Input for user-prompt-submitted hook\"\"\"\n\n timestamp: int\n cwd: str\n prompt: str\n\n\nclass UserPromptSubmittedHookOutput(TypedDict, total=False):\n \"\"\"Output for user-prompt-submitted hook\"\"\"\n\n modifiedPrompt: str\n additionalContext: str\n suppressOutput: bool\n\n\nUserPromptSubmittedHandler = Callable[\n [UserPromptSubmittedHookInput, dict[str, str]],\n UserPromptSubmittedHookOutput | None | Awaitable[UserPromptSubmittedHookOutput | None],\n]\n\n\nclass SessionStartHookInput(TypedDict):\n \"\"\"Input for session-start hook\"\"\"\n\n timestamp: int\n cwd: str\n source: Literal[\"startup\", \"resume\", \"new\"]\n initialPrompt: NotRequired[str]\n\n\nclass SessionStartHookOutput(TypedDict, total=False):\n \"\"\"Output for session-start hook\"\"\"\n\n additionalContext: str\n modifiedConfig: dict[str, Any]\n\n\nSessionStartHandler = Callable[\n [SessionStartHookInput, dict[str, str]],\n SessionStartHookOutput | None | Awaitable[SessionStartHookOutput | None],\n]\n\n\nclass SessionEndHookInput(TypedDict):\n \"\"\"Input for session-end hook\"\"\"\n\n timestamp: int\n cwd: str\n reason: Literal[\"complete\", \"error\", \"abort\", \"timeout\", \"user_exit\"]\n finalMessage: NotRequired[str]\n error: NotRequired[str]\n\n\nclass SessionEndHookOutput(TypedDict, total=False):\n \"\"\"Output for session-end hook\"\"\"\n\n suppressOutput: bool\n cleanupActions: list[str]\n sessionSummary: str\n\n\nSessionEndHandler = Callable[\n [SessionEndHookInput, dict[str, str]],\n SessionEndHookOutput | None | Awaitable[SessionEndHookOutput | None],\n]\n\n\nclass ErrorOccurredHookInput(TypedDict):\n \"\"\"Input for error-occurred hook\"\"\"\n\n timestamp: int\n cwd: str\n error: str\n errorContext: Literal[\"model_call\", \"tool_execution\", \"system\", \"user_input\"]\n recoverable: bool\n\n\nclass ErrorOccurredHookOutput(TypedDict, total=False):\n \"\"\"Output for error-occurred hook\"\"\"\n\n suppressOutput: bool\n errorHandling: Literal[\"retry\", \"skip\", \"abort\"]\n retryCount: int\n userNotification: str\n\n\nErrorOccurredHandler = Callable[\n [ErrorOccurredHookInput, dict[str, str]],\n ErrorOccurredHookOutput | None | Awaitable[ErrorOccurredHookOutput | None],\n]\n\n\nclass SessionHooks(TypedDict, total=False):\n \"\"\"Configuration for session hooks\"\"\"\n\n on_pre_tool_use: PreToolUseHandler\n on_post_tool_use: PostToolUseHandler\n on_user_prompt_submitted: UserPromptSubmittedHandler\n on_session_start: SessionStartHandler\n on_session_end: SessionEndHandler\n on_error_occurred: ErrorOccurredHandler\n\n\n# ============================================================================\n# MCP Server Configuration Types\n# ============================================================================\n\n\nclass MCPStdioServerConfig(TypedDict, total=False):\n \"\"\"Configuration for a local/stdio MCP server.\"\"\"\n\n tools: list[str] # List of tools to include. [] means none. \"*\" means all.\n type: NotRequired[Literal[\"local\", \"stdio\"]] # Server type\n timeout: NotRequired[int] # Timeout in milliseconds\n command: str # Command to run\n args: list[str] # Command arguments\n env: NotRequired[dict[str, str]] # Environment variables\n cwd: NotRequired[str] # Working directory\n\n\nclass MCPHTTPServerConfig(TypedDict, total=False):\n \"\"\"Configuration for a remote MCP server (HTTP or SSE).\"\"\"\n\n tools: list[str] # List of tools to include. [] means none. \"*\" means all.\n type: Literal[\"http\", \"sse\"] # Server type\n timeout: NotRequired[int] # Timeout in milliseconds\n url: str # URL of the remote server\n headers: NotRequired[dict[str, str]] # HTTP headers\n\n\nMCPServerConfig = MCPStdioServerConfig | MCPHTTPServerConfig\n\n# ============================================================================\n# Custom Agent Configuration Types\n# ============================================================================\n\n\nclass CustomAgentConfig(TypedDict, total=False):\n \"\"\"Configuration for a custom agent.\"\"\"\n\n name: str # Unique name of the custom agent\n display_name: NotRequired[str] # Display name for UI purposes\n description: NotRequired[str] # Description of what the agent does\n # List of tool names the agent can use\n tools: NotRequired[list[str] | None]\n prompt: str # The prompt content for the agent\n # MCP servers specific to agent\n mcp_servers: NotRequired[dict[str, MCPServerConfig]]\n infer: NotRequired[bool] # Whether agent is available for model inference\n # Skill names to preload into this agent's context at startup (opt-in; omit for none)\n skills: NotRequired[list[str]]\n\n\nclass DefaultAgentConfig(TypedDict, total=False):\n \"\"\"Configuration for the default agent.\n\n The default agent is the built-in agent that handles turns\n when no custom agent is selected.\n \"\"\"\n\n # List of tool names to exclude from the default agent.\n # These tools remain available to custom sub-agents that reference them.\n excluded_tools: list[str]\n\n\nclass InfiniteSessionConfig(TypedDict, total=False):\n \"\"\"\n Configuration for infinite sessions with automatic context compaction\n and workspace persistence.\n\n When enabled, sessions automatically manage context window limits through\n background compaction and persist state to a workspace directory.\n \"\"\"\n\n # Whether infinite sessions are enabled (default: True)\n enabled: bool\n # Context utilization threshold (0.0-1.0) at which background compaction starts.\n # Compaction runs asynchronously, allowing the session to continue processing.\n # Default: 0.80\n background_compaction_threshold: float\n # Context utilization threshold (0.0-1.0) at which the session blocks until\n # compaction completes. This prevents context overflow when compaction hasn't\n # finished in time. Default: 0.95\n buffer_exhaustion_threshold: float\n\n\n# ============================================================================\n# Session Configuration\n# ============================================================================\n\n\nclass AzureProviderOptions(TypedDict, total=False):\n \"\"\"Azure-specific provider configuration\"\"\"\n\n api_version: str # Azure API version. Defaults to \"2024-10-21\".\n\n\nclass ProviderConfig(TypedDict, total=False):\n \"\"\"Configuration for a custom API provider\"\"\"\n\n type: Literal[\"openai\", \"azure\", \"anthropic\"]\n wire_api: Literal[\"completions\", \"responses\"]\n base_url: str\n api_key: str\n # Bearer token for authentication. Sets the Authorization header directly.\n # Use this for services requiring bearer token auth instead of API key.\n # Takes precedence over api_key when both are set.\n bearer_token: str\n azure: AzureProviderOptions # Azure-specific options\n headers: dict[str, str]\n\n\nclass SessionConfig(TypedDict, total=False):\n \"\"\"Configuration for creating a session\"\"\"\n\n session_id: str # Optional custom session ID\n # Client name to identify the application using the SDK.\n # Included in the User-Agent header for API requests.\n client_name: str\n model: str # Model to use for this session. Use client.list_models() to see available models.\n # Reasoning effort level for models that support it.\n # Only valid for models where capabilities.supports.reasoning_effort is True.\n reasoning_effort: ReasoningEffort\n tools: list[Tool]\n system_message: SystemMessageConfig # System message configuration\n # List of tool names to allow (takes precedence over excluded_tools)\n available_tools: list[str]\n # List of tool names to disable (ignored if available_tools is set)\n excluded_tools: list[str]\n # Handler for permission requests from the server\n on_permission_request: _PermissionHandlerFn\n # Handler for user input requests from the agent (enables ask_user tool)\n on_user_input_request: UserInputHandler\n # Hook handlers for intercepting session lifecycle events\n hooks: SessionHooks\n # Working directory for the session. Tool operations will be relative to this directory.\n working_directory: str\n # Custom provider configuration (BYOK - Bring Your Own Key)\n provider: ProviderConfig\n # Enable streaming of assistant message and reasoning chunks\n # When True, assistant.message_delta and assistant.reasoning_delta events\n # with delta_content are sent as the response is generated\n streaming: bool\n # Include sub-agent streaming events in the event stream. When True, streaming\n # delta events from sub-agents (e.g., assistant.message_delta,\n # assistant.reasoning_delta, assistant.streaming_delta with agentId set) are\n # forwarded to this connection. When False, only non-streaming sub-agent events\n # and subagent.* lifecycle events are forwarded; streaming deltas from sub-agents\n # are suppressed. Defaults to True.\n include_sub_agent_streaming_events: bool\n # MCP server configurations for the session\n mcp_servers: dict[str, MCPServerConfig]\n # Custom agent configurations for the session\n custom_agents: list[CustomAgentConfig]\n # Configuration for the default agent.\n # Use excluded_tools to hide tools from the default agent\n # while keeping them available to sub-agents.\n default_agent: DefaultAgentConfig\n # Name of the custom agent to activate when the session starts.\n # Must match the name of one of the agents in custom_agents.\n agent: str\n # Override the default configuration directory location.\n # When specified, the session will use this directory for storing config and state.\n config_dir: str\n # Directories to load skills from\n skill_directories: list[str]\n # List of skill names to disable\n disabled_skills: list[str]\n # Infinite session configuration for persistent workspaces and automatic compaction.\n # When enabled (default), sessions automatically manage context limits and persist state.\n # Set to {\"enabled\": False} to disable.\n infinite_sessions: InfiniteSessionConfig\n # Optional event handler that is registered on the session before the\n # session.create RPC is issued, ensuring early events (e.g. session.start)\n # are delivered. Equivalent to calling session.on(handler) immediately\n # after creation, but executes earlier in the lifecycle so no events are missed.\n on_event: Callable[[SessionEvent], None]\n # Slash commands to register with the session.\n # When the CLI has a TUI, each command appears as /name for the user to invoke.\n commands: list[CommandDefinition]\n # Handler for elicitation requests from the server.\n # When provided, the server calls back to this client for form-based UI dialogs.\n on_elicitation_request: ElicitationHandler\n # Handler factory for session-scoped sessionFs operations.\n create_session_fs_handler: CreateSessionFsHandler\n\n\nclass ResumeSessionConfig(TypedDict, total=False):\n \"\"\"Configuration for resuming a session\"\"\"\n\n # Client name to identify the application using the SDK.\n # Included in the User-Agent header for API requests.\n client_name: str\n # Model to use for this session. Can change the model when resuming.\n model: str\n tools: list[Tool]\n system_message: SystemMessageConfig # System message configuration\n # List of tool names to allow (takes precedence over excluded_tools)\n available_tools: list[str]\n # List of tool names to disable (ignored if available_tools is set)\n excluded_tools: list[str]\n provider: ProviderConfig\n # Reasoning effort level for models that support it.\n reasoning_effort: ReasoningEffort\n on_permission_request: _PermissionHandlerFn\n # Handler for user input requestsfrom the agent (enables ask_user tool)\n on_user_input_request: UserInputHandler\n # Hook handlers for intercepting session lifecycle events\n hooks: SessionHooks\n # Working directory for the session. Tool operations will be relative to this directory.\n working_directory: str\n # Override the default configuration directory location.\n config_dir: str\n # Enable streaming of assistant message chunks\n streaming: bool\n # Include sub-agent streaming events in the event stream. When True, streaming\n # delta events from sub-agents (e.g., assistant.message_delta,\n # assistant.reasoning_delta, assistant.streaming_delta with agentId set) are\n # forwarded to this connection. When False, only non-streaming sub-agent events\n # and subagent.* lifecycle events are forwarded; streaming deltas from sub-agents\n # are suppressed. Defaults to True.\n include_sub_agent_streaming_events: bool\n # MCP server configurations for the session\n mcp_servers: dict[str, MCPServerConfig]\n # Custom agent configurations for the session\n custom_agents: list[CustomAgentConfig]\n # Configuration for the default agent.\n default_agent: DefaultAgentConfig\n # Name of the custom agent to activate when the session starts.\n # Must match the name of one of the agents in custom_agents.\n agent: str\n # Directories to load skills from\n skill_directories: list[str]\n # List of skill names to disable\n disabled_skills: list[str]\n # Infinite session configuration for persistent workspaces and automatic compaction.\n infinite_sessions: InfiniteSessionConfig\n # When True, skips emitting the session.resume event.\n # Useful for reconnecting to a session without triggering resume-related side effects.\n disable_resume: bool\n # When True, instructs the runtime to continue any tool calls or permission prompts\n # that were still pending when the session was last suspended. When False (the\n # default), the runtime treats pending work as interrupted on resume.\n #\n # For permission requests, the runtime re-emits ``permission.requested`` so the\n # registered ``on_permission_request`` handler can re-prompt; for external tool\n # calls, the consumer is expected to supply the result via the corresponding\n # low-level RPC method.\n continue_pending_work: bool\n # Optional event handler registered before the session.resume RPC is issued,\n # ensuring early events are delivered. See SessionConfig.on_event.\n on_event: Callable[[SessionEvent], None]\n # Slash commands to register with the session.\n commands: list[CommandDefinition]\n # Handler for elicitation requests from the server.\n on_elicitation_request: ElicitationHandler\n # Handler factory for session-scoped sessionFs operations.\n create_session_fs_handler: CreateSessionFsHandler\n\n\nSessionEventHandler = Callable[[SessionEvent], None]\n\n\nclass CopilotSession:\n \"\"\"\n Represents a single conversation session with the Copilot CLI.\n\n A session maintains conversation state, handles events, and manages tool execution.\n Sessions are created via :meth:`CopilotClient.create_session` or resumed via\n :meth:`CopilotClient.resume_session`.\n\n The session provides methods to send messages, subscribe to events, retrieve\n conversation history, and manage the session lifecycle.\n\n Attributes:\n session_id: The unique identifier for this session.\n\n Example:\n >>> async with await client.create_session(\n ... on_permission_request=PermissionHandler.approve_all,\n ... ) as session:\n ... # Subscribe to events\n ... unsubscribe = session.on(lambda event: print(event.type))\n ...\n ... # Send a message\n ... await session.send(\"Hello, world!\")\n ...\n ... # Clean up\n ... unsubscribe()\n \"\"\"\n\n def __init__(\n self, session_id: str, client: Any, workspace_path: os.PathLike[str] | str | None = None\n ):\n \"\"\"\n Initialize a new CopilotSession.\n\n Note:\n This constructor is internal. Use :meth:`CopilotClient.create_session`\n to create sessions.\n\n Args:\n session_id: The unique identifier for this session.\n client: The internal client connection to the Copilot CLI.\n workspace_path: Path to the session workspace directory\n (when infinite sessions enabled).\n \"\"\"\n self.session_id = session_id\n self._client = client\n self._workspace_path = os.fsdecode(workspace_path) if workspace_path is not None else None\n self._event_handlers: set[Callable[[SessionEvent], None]] = set()\n self._event_handlers_lock = threading.Lock()\n self._tool_handlers: dict[str, ToolHandler] = {}\n self._tool_handlers_lock = threading.Lock()\n self._permission_handler: _PermissionHandlerFn | None = None\n self._permission_handler_lock = threading.Lock()\n self._user_input_handler: UserInputHandler | None = None\n self._user_input_handler_lock = threading.Lock()\n self._hooks: SessionHooks | None = None\n self._hooks_lock = threading.Lock()\n self._transform_callbacks: dict[str, SectionTransformFn] | None = None\n self._transform_callbacks_lock = threading.Lock()\n self._command_handlers: dict[str, CommandHandler] = {}\n self._command_handlers_lock = threading.Lock()\n self._elicitation_handler: ElicitationHandler | None = None\n self._elicitation_handler_lock = threading.Lock()\n self._capabilities: SessionCapabilities = {}\n self._client_session_apis = ClientSessionApiHandlers()\n self._rpc: SessionRpc | None = None\n self._destroyed = False\n\n @property\n def rpc(self) -> SessionRpc:\n \"\"\"Typed session-scoped RPC methods.\"\"\"\n if self._rpc is None:\n self._rpc = SessionRpc(self._client, self.session_id)\n return self._rpc\n\n @property\n def capabilities(self) -> SessionCapabilities:\n \"\"\"Host capabilities reported when the session was created or resumed.\n\n Use this to check feature support before calling capability-gated APIs.\n \"\"\"\n return self._capabilities\n\n @property\n def ui(self) -> SessionUiApi:\n \"\"\"Interactive UI methods for showing dialogs to the user.\n\n Only available when the CLI host supports elicitation\n (``session.capabilities.get(\"ui\", {}).get(\"elicitation\") is True``).\n\n Example:\n >>> ui_caps = session.capabilities.get(\"ui\", {})\n >>> if ui_caps.get(\"elicitation\"):\n ... ok = await session.ui.confirm(\"Deploy to production?\")\n \"\"\"\n return SessionUiApi(self)\n\n @functools.cached_property\n def workspace_path(self) -> pathlib.Path | None:\n \"\"\"\n Path to the session workspace directory when infinite sessions are enabled.\n\n Contains checkpoints/, plan.md, and files/ subdirectories.\n None if infinite sessions are disabled.\n \"\"\"\n # Done as a property as self._workspace_path is directly set from a server\n # response post-init. So it was either make sure all places directly setting\n # the attribute handle the None case appropriately, use a setter for the\n # attribute to do the conversion, or just do the conversion lazily via a getter.\n return pathlib.Path(self._workspace_path) if self._workspace_path else None\n\n async def send(\n self,\n prompt: str,\n *,\n attachments: list[Attachment] | None = None,\n mode: Literal[\"enqueue\", \"immediate\"] | None = None,\n request_headers: dict[str, str] | None = None,\n ) -> str:\n \"\"\"\n Send a message to this session.\n\n The message is processed asynchronously. Subscribe to events via :meth:`on`\n to receive streaming responses and other session events. Use\n :meth:`send_and_wait` to block until the assistant finishes processing.\n\n Args:\n prompt: The message text to send.\n attachments: Optional file, directory, or selection attachments.\n mode: Message delivery mode (``\"enqueue\"`` or ``\"immediate\"``).\n request_headers: Optional per-turn HTTP headers for outbound model requests.\n\n Returns:\n The message ID assigned by the server, which can be used to correlate events.\n\n Raises:\n Exception: If the session has been disconnected or the connection fails.\n\n Example:\n >>> message_id = await session.send(\n ... \"Explain this code\",\n ... attachments=[{\"type\": \"file\", \"path\": \"./src/main.py\"}],\n ... )\n \"\"\"\n params: dict[str, Any] = {\n \"sessionId\": self.session_id,\n \"prompt\": prompt,\n }\n if attachments is not None:\n params[\"attachments\"] = attachments\n if mode is not None:\n params[\"mode\"] = mode\n if request_headers is not None:\n params[\"requestHeaders\"] = request_headers\n params.update(get_trace_context())\n\n response = await self._client.request(\"session.send\", params)\n return response[\"messageId\"]\n\n async def send_and_wait(\n self,\n prompt: str,\n *,\n attachments: list[Attachment] | None = None,\n mode: Literal[\"enqueue\", \"immediate\"] | None = None,\n request_headers: dict[str, str] | None = None,\n timeout: float = 60.0,\n ) -> SessionEvent | None:\n \"\"\"\n Send a message to this session and wait until the session becomes idle.\n\n This is a convenience method that combines :meth:`send` with waiting for\n the session.idle event. Use this when you want to block until the assistant\n has finished processing the message.\n\n Events are still delivered to handlers registered via :meth:`on` while waiting.\n\n Args:\n prompt: The message text to send.\n attachments: Optional file, directory, or selection attachments.\n mode: Message delivery mode (``\"enqueue\"`` or ``\"immediate\"``).\n request_headers: Optional per-turn HTTP headers for outbound model requests.\n timeout: Timeout in seconds (default: 60). Controls how long to wait;\n does not abort in-flight agent work.\n\n Returns:\n The final assistant message event, or None if none was received.\n\n Raises:\n TimeoutError: If the timeout is reached before session becomes idle.\n Exception: If the session has been disconnected or the connection fails.\n\n Example:\n >>> from copilot.generated.session_events import AssistantMessageData\n >>> response = await session.send_and_wait(\"What is 2+2?\")\n >>> if response:\n ... match response.data:\n ... case AssistantMessageData() as data:\n ... print(data.content)\n \"\"\"\n idle_event = asyncio.Event()\n error_event: Exception | None = None\n last_assistant_message: SessionEvent | None = None\n\n def handler(event: SessionEventTypeAlias) -> None:\n nonlocal last_assistant_message, error_event\n match event.data:\n case AssistantMessageData():\n last_assistant_message = event\n case SessionIdleData():\n idle_event.set()\n case SessionErrorData() as data:\n error_event = Exception(f\"Session error: {data.message or str(data)}\")\n idle_event.set()\n\n unsubscribe = self.on(handler)\n try:\n await self.send(\n prompt,\n attachments=attachments,\n mode=mode,\n request_headers=request_headers,\n )\n await asyncio.wait_for(idle_event.wait(), timeout=timeout)\n if error_event:\n raise error_event\n return last_assistant_message\n except TimeoutError:\n raise TimeoutError(f\"Timeout after {timeout}s waiting for session.idle\")\n finally:\n unsubscribe()\n\n def on(self, handler: Callable[[SessionEvent], None]) -> Callable[[], None]:\n \"\"\"\n Subscribe to events from this session.\n\n Events include assistant messages, tool executions, errors, and session\n state changes. Multiple handlers can be registered and will all receive\n events.\n\n Args:\n handler: A callback function that receives session events. The function\n takes a single :class:`SessionEvent` argument and returns None.\n\n Returns:\n A function that, when called, unsubscribes the handler.\n\n Example:\n >>> from copilot.generated.session_events import AssistantMessageData, SessionErrorData\n >>> def handle_event(event):\n ... match event.data:\n ... case AssistantMessageData() as data:\n ... print(f\"Assistant: {data.content}\")\n ... case SessionErrorData() as data:\n ... print(f\"Error: {data.message}\")\n >>> unsubscribe = session.on(handle_event)\n >>> # Later, to stop receiving events:\n >>> unsubscribe()\n \"\"\"\n with self._event_handlers_lock:\n self._event_handlers.add(handler)\n\n def unsubscribe():\n with self._event_handlers_lock:\n self._event_handlers.discard(handler)\n\n return unsubscribe\n\n def _dispatch_event(self, event: SessionEvent) -> None:\n \"\"\"\n Dispatch an event to all registered handlers.\n\n Broadcast request events (external_tool.requested, permission.requested) are handled\n internally before being forwarded to user handlers.\n\n Note:\n This method is internal and should not be called directly.\n\n Args:\n event: The session event to dispatch to all handlers.\n \"\"\"\n # Handle broadcast request events (protocol v3) before dispatching to user handlers.\n # Fire-and-forget: the response is sent asynchronously via RPC.\n self._handle_broadcast_event(event)\n\n with self._event_handlers_lock:\n handlers = list(self._event_handlers)\n\n for handler in handlers:\n try:\n handler(event)\n except Exception as e:\n print(f\"Error in session event handler: {e}\")\n\n def _handle_broadcast_event(self, event: SessionEvent) -> None:\n \"\"\"Handle broadcast request events by executing local handlers and responding via RPC.\n\n Implements the protocol v3 broadcast model where tool calls and permission requests\n are broadcast as session events to all clients.\n \"\"\"\n match event.data:\n case ExternalToolRequestedData() as data:\n request_id = data.request_id\n tool_name = data.tool_name\n if not request_id or not tool_name:\n return\n\n handler = self._get_tool_handler(tool_name)\n if not handler:\n return # This client doesn't handle this tool; another client will.\n\n tool_call_id = data.tool_call_id or \"\"\n arguments = data.arguments\n tp = getattr(data, \"traceparent\", None)\n ts = getattr(data, \"tracestate\", None)\n asyncio.ensure_future(\n self._execute_tool_and_respond(\n request_id, tool_name, tool_call_id, arguments, handler, tp, ts\n )\n )\n\n case PermissionRequestedData() as data:\n request_id = data.request_id\n permission_request = data.permission_request\n if not request_id or not permission_request:\n return\n\n resolved_by_hook = getattr(data, \"resolved_by_hook\", None)\n if resolved_by_hook:\n return # Already resolved by a permissionRequest hook; no client action needed.\n\n with self._permission_handler_lock:\n perm_handler = self._permission_handler\n if not perm_handler:\n return # This client doesn't handle permissions; another client will.\n\n asyncio.ensure_future(\n self._execute_permission_and_respond(\n request_id, permission_request, perm_handler\n )\n )\n\n case CommandExecuteData() as data:\n request_id = data.request_id\n command_name = data.command_name\n command = data.command\n args = data.args\n if not request_id or not command_name:\n return\n asyncio.ensure_future(\n self._execute_command_and_respond(\n request_id, command_name, command or \"\", args or \"\"\n )\n )\n\n case ElicitationRequestedData() as data:\n with self._elicitation_handler_lock:\n handler = self._elicitation_handler\n if not handler:\n return\n request_id = data.request_id\n if not request_id:\n return\n context: ElicitationContext = {\n \"session_id\": self.session_id,\n \"message\": data.message or \"\",\n }\n if data.requested_schema is not None:\n context[\"requestedSchema\"] = data.requested_schema.to_dict()\n if data.mode is not None:\n context[\"mode\"] = data.mode.value\n if data.elicitation_source is not None:\n context[\"elicitationSource\"] = data.elicitation_source\n if data.url is not None:\n context[\"url\"] = data.url\n asyncio.ensure_future(self._handle_elicitation_request(context, request_id))\n\n case CapabilitiesChangedData() as data:\n cap: SessionCapabilities = {}\n if data.ui is not None:\n ui_cap: SessionUiCapabilities = {}\n if data.ui.elicitation is not None:\n ui_cap[\"elicitation\"] = data.ui.elicitation\n cap[\"ui\"] = ui_cap\n self._capabilities = {**self._capabilities, **cap}\n\n async def _execute_tool_and_respond(\n self,\n request_id: str,\n tool_name: str,\n tool_call_id: str,\n arguments: Any,\n handler: ToolHandler,\n traceparent: str | None = None,\n tracestate: str | None = None,\n ) -> None:\n \"\"\"Execute a tool handler and send the result back via HandlePendingToolCall RPC.\"\"\"\n try:\n invocation = ToolInvocation(\n session_id=self.session_id,\n tool_call_id=tool_call_id,\n tool_name=tool_name,\n arguments=arguments,\n )\n\n with trace_context(traceparent, tracestate):\n result = handler(invocation)\n if inspect.isawaitable(result):\n result = await result\n\n tool_result: ToolResult\n if result is None:\n tool_result = ToolResult(\n text_result_for_llm=\"Tool returned no result.\",\n result_type=\"failure\",\n error=\"tool returned no result\",\n tool_telemetry={},\n )\n else:\n tool_result = result # type: ignore[assignment]\n\n # Exception-originated failures (from define_tool's exception handler) are\n # sent via the top-level error param so the CLI formats them with its\n # standard \"Failed to execute...\" message. Deliberate user-returned\n # failures send the full structured result to preserve metadata.\n if tool_result._from_exception:\n await self.rpc.tools.handle_pending_tool_call(\n HandlePendingToolCallRequest(\n request_id=request_id,\n error=tool_result.error,\n )\n )\n else:\n await self.rpc.tools.handle_pending_tool_call(\n HandlePendingToolCallRequest(\n request_id=request_id,\n result=ExternalToolTextResultForLlm(\n text_result_for_llm=tool_result.text_result_for_llm,\n error=tool_result.error,\n result_type=tool_result.result_type,\n tool_telemetry=tool_result.tool_telemetry,\n ),\n )\n )\n except Exception as exc:\n try:\n await self.rpc.tools.handle_pending_tool_call(\n HandlePendingToolCallRequest(\n request_id=request_id,\n error=str(exc),\n )\n )\n except (JsonRpcError, ProcessExitedError, OSError):\n pass # Connection lost or RPC error — nothing we can do\n\n async def _execute_permission_and_respond(\n self,\n request_id: str,\n permission_request: Any,\n handler: _PermissionHandlerFn,\n ) -> None:\n \"\"\"Execute a permission handler and respond via RPC.\"\"\"\n try:\n result = handler(permission_request, {\"session_id\": self.session_id})\n if inspect.isawaitable(result):\n result = await result\n\n result = cast(PermissionRequestResult, result)\n if result.kind == \"no-result\":\n return\n\n perm_result = PermissionDecision(\n kind=PermissionDecisionKind(result.kind),\n )\n\n await self.rpc.permissions.handle_pending_permission_request(\n PermissionDecisionRequest(\n request_id=request_id,\n result=perm_result,\n )\n )\n except Exception:\n try:\n await self.rpc.permissions.handle_pending_permission_request(\n PermissionDecisionRequest(\n request_id=request_id,\n result=PermissionDecision(\n kind=PermissionDecisionKind.USER_NOT_AVAILABLE,\n ),\n )\n )\n except (JsonRpcError, ProcessExitedError, OSError):\n pass # Connection lost or RPC error — nothing we can do\n\n async def _execute_command_and_respond(\n self,\n request_id: str,\n command_name: str,\n command: str,\n args: str,\n ) -> None:\n \"\"\"Execute a command handler and send the result back via RPC.\"\"\"\n with self._command_handlers_lock:\n handler = self._command_handlers.get(command_name)\n\n if not handler:\n try:\n await self.rpc.commands.handle_pending_command(\n CommandsHandlePendingCommandRequest(\n request_id=request_id,\n error=f\"Unknown command: {command_name}\",\n )\n )\n except (JsonRpcError, ProcessExitedError, OSError):\n pass # Connection lost — nothing we can do\n return\n\n try:\n ctx = CommandContext(\n session_id=self.session_id,\n command=command,\n command_name=command_name,\n args=args,\n )\n result = handler(ctx)\n if inspect.isawaitable(result):\n await result\n await self.rpc.commands.handle_pending_command(\n CommandsHandlePendingCommandRequest(request_id=request_id)\n )\n except Exception as exc:\n message = str(exc)\n try:\n await self.rpc.commands.handle_pending_command(\n CommandsHandlePendingCommandRequest(\n request_id=request_id,\n error=message,\n )\n )\n except (JsonRpcError, ProcessExitedError, OSError):\n pass # Connection lost — nothing we can do\n\n async def _handle_elicitation_request(\n self,\n context: ElicitationContext,\n request_id: str,\n ) -> None:\n \"\"\"Handle an elicitation.requested broadcast event.\n\n Invokes the registered handler and responds via handlePendingElicitation RPC.\n Auto-cancels on error so the server doesn't hang.\n \"\"\"\n with self._elicitation_handler_lock:\n handler = self._elicitation_handler\n if not handler:\n return\n try:\n result = handler(context)\n if inspect.isawaitable(result):\n result = await result\n result = cast(ElicitationResult, result)\n action_val = result.get(\"action\", \"cancel\")\n rpc_result = UIElicitationResponse(\n action=UIElicitationResponseAction(action_val),\n content=result.get(\"content\"),\n )\n await self.rpc.ui.handle_pending_elicitation(\n UIHandlePendingElicitationRequest(\n request_id=request_id,\n result=rpc_result,\n )\n )\n except Exception:\n # Handler failed — attempt to cancel so the request doesn't hang\n try:\n await self.rpc.ui.handle_pending_elicitation(\n UIHandlePendingElicitationRequest(\n request_id=request_id,\n result=UIElicitationResponse(\n action=UIElicitationResponseAction.CANCEL,\n ),\n )\n )\n except (JsonRpcError, ProcessExitedError, OSError):\n pass # Connection lost or RPC error — nothing we can do\n\n def _assert_elicitation(self) -> None:\n \"\"\"Raises if the host does not support elicitation.\"\"\"\n ui_caps = self._capabilities.get(\"ui\", {})\n if not ui_caps.get(\"elicitation\"):\n raise RuntimeError(\n \"Elicitation is not supported by the host. \"\n \"Check session.capabilities before calling UI methods.\"\n )\n\n def _register_commands(self, commands: list[CommandDefinition] | None) -> None:\n \"\"\"Register command handlers for this session.\n\n Args:\n commands: A list of CommandDefinition objects, or None to clear all commands.\n \"\"\"\n with self._command_handlers_lock:\n self._command_handlers.clear()\n if not commands:\n return\n for cmd in commands:\n self._command_handlers[cmd.name] = cmd.handler\n\n def _register_elicitation_handler(self, handler: ElicitationHandler | None) -> None:\n \"\"\"Register the elicitation handler for this session.\n\n Args:\n handler: The handler to invoke when the server dispatches an\n elicitation request, or None to remove the handler.\n \"\"\"\n with self._elicitation_handler_lock:\n self._elicitation_handler = handler\n\n def _set_capabilities(self, capabilities: SessionCapabilities | None) -> None:\n \"\"\"Set the host capabilities for this session.\n\n Args:\n capabilities: The capabilities object from the create/resume response.\n \"\"\"\n self._capabilities: SessionCapabilities = capabilities if capabilities is not None else {}\n\n def _register_tools(self, tools: list[Tool] | None) -> None:\n \"\"\"\n Register custom tool handlers for this session.\n\n Tools allow the assistant to execute custom functions. When the assistant\n invokes a tool, the corresponding handler is called with the tool arguments.\n\n Note:\n This method is internal. Tools are typically registered when creating\n a session via :meth:`CopilotClient.create_session`.\n\n Args:\n tools: A list of Tool objects with their handlers, or None to clear\n all registered tools.\n \"\"\"\n with self._tool_handlers_lock:\n self._tool_handlers.clear()\n if not tools:\n return\n for tool in tools:\n if not tool.name or not tool.handler:\n continue\n self._tool_handlers[tool.name] = tool.handler\n\n def _get_tool_handler(self, name: str) -> ToolHandler | None:\n \"\"\"\n Retrieve a registered tool handler by name.\n\n Note:\n This method is internal and should not be called directly.\n\n Args:\n name: The name of the tool to retrieve.\n\n Returns:\n The tool handler if found, or None if no handler is registered\n for the given name.\n \"\"\"\n with self._tool_handlers_lock:\n return self._tool_handlers.get(name)\n\n def _register_permission_handler(self, handler: _PermissionHandlerFn | None) -> None:\n \"\"\"\n Register a handler for permission requests.\n\n When the assistant needs permission to perform certain actions (e.g.,\n file operations), this handler is called to approve or deny the request.\n\n Note:\n This method is internal. Permission handlers are typically registered\n when creating a session via :meth:`CopilotClient.create_session`.\n\n Args:\n handler: The permission handler function, or None to remove the handler.\n \"\"\"\n with self._permission_handler_lock:\n self._permission_handler = handler\n\n async def _handle_permission_request(\n self, request: PermissionRequest\n ) -> PermissionRequestResult:\n \"\"\"\n Handle a permission request from the Copilot CLI.\n\n Note:\n This method is internal and should not be called directly.\n\n Args:\n request: The permission request data from the CLI.\n\n Returns:\n A dictionary containing the permission decision with a \"kind\" key.\n \"\"\"\n with self._permission_handler_lock:\n handler = self._permission_handler\n\n if not handler:\n # No handler registered, deny permission\n return PermissionRequestResult()\n\n try:\n result = handler(request, {\"session_id\": self.session_id})\n if inspect.isawaitable(result):\n result = await result\n return cast(PermissionRequestResult, result)\n except Exception: # pylint: disable=broad-except\n # Handler failed, deny permission\n return PermissionRequestResult()\n\n def _register_user_input_handler(self, handler: UserInputHandler | None) -> None:\n \"\"\"\n Register a handler for user input requests.\n\n When the agent needs input from the user (via ask_user tool),\n this handler is called to provide the response.\n\n Note:\n This method is internal. User input handlers are typically registered\n when creating a session via :meth:`CopilotClient.create_session`.\n\n Args:\n handler: The user input handler function, or None to remove the handler.\n \"\"\"\n with self._user_input_handler_lock:\n self._user_input_handler = handler\n\n async def _handle_user_input_request(self, request: dict) -> UserInputResponse:\n \"\"\"\n Handle a user input request from the Copilot CLI.\n\n Note:\n This method is internal and should not be called directly.\n\n Args:\n request: The user input request data from the CLI.\n\n Returns:\n A dictionary containing the user's response.\n \"\"\"\n with self._user_input_handler_lock:\n handler = self._user_input_handler\n\n if not handler:\n raise RuntimeError(\"User input requested but no handler registered\")\n\n try:\n result = handler(\n UserInputRequest(\n question=request.get(\"question\", \"\"),\n choices=request.get(\"choices\") or [],\n allowFreeform=request.get(\"allowFreeform\", True),\n ),\n {\"session_id\": self.session_id},\n )\n if inspect.isawaitable(result):\n result = await result\n return cast(UserInputResponse, result)\n except Exception:\n raise\n\n def _register_transform_callbacks(\n self, callbacks: dict[str, SectionTransformFn] | None\n ) -> None:\n \"\"\"Register transform callbacks for system message sections.\"\"\"\n with self._transform_callbacks_lock:\n self._transform_callbacks = callbacks\n\n def _register_hooks(self, hooks: SessionHooks | None) -> None:\n \"\"\"\n Register hook handlers for session lifecycle events.\n\n Hooks allow custom logic to be executed at various points during\n the session lifecycle (before/after tool use, session start/end, etc.).\n\n Note:\n This method is internal. Hooks are typically registered\n when creating a session via :meth:`CopilotClient.create_session`.\n\n Args:\n hooks: The hooks configuration object, or None to remove all hooks.\n \"\"\"\n with self._hooks_lock:\n self._hooks = hooks\n\n async def _handle_system_message_transform(\n self, sections: dict[str, dict[str, str]]\n ) -> dict[str, dict[str, dict[str, str]]]:\n \"\"\"Handle a systemMessage.transform request from the runtime.\"\"\"\n with self._transform_callbacks_lock:\n callbacks = self._transform_callbacks\n\n result: dict[str, dict[str, str]] = {}\n for section_id, section_data in sections.items():\n content = section_data.get(\"content\", \"\")\n callback = callbacks.get(section_id) if callbacks else None\n if callback:\n try:\n transformed = callback(content)\n if inspect.isawaitable(transformed):\n transformed = await transformed\n result[section_id] = {\"content\": str(transformed)}\n except Exception:\n result[section_id] = {\"content\": content}\n else:\n result[section_id] = {\"content\": content}\n return {\"sections\": result}\n\n async def _handle_hooks_invoke(self, hook_type: str, input_data: Any) -> Any:\n \"\"\"\n Handle a hooks invocation from the Copilot CLI.\n\n Note:\n This method is internal and should not be called directly.\n\n Args:\n hook_type: The type of hook being invoked.\n input_data: The input data for the hook.\n\n Returns:\n The hook output, or None if no handler is registered.\n \"\"\"\n with self._hooks_lock:\n hooks = self._hooks\n\n if not hooks:\n return None\n\n handler_map = {\n \"preToolUse\": hooks.get(\"on_pre_tool_use\"),\n \"postToolUse\": hooks.get(\"on_post_tool_use\"),\n \"userPromptSubmitted\": hooks.get(\"on_user_prompt_submitted\"),\n \"sessionStart\": hooks.get(\"on_session_start\"),\n \"sessionEnd\": hooks.get(\"on_session_end\"),\n \"errorOccurred\": hooks.get(\"on_error_occurred\"),\n }\n\n handler = handler_map.get(hook_type)\n if not handler:\n return None\n\n try:\n result = handler(input_data, {\"session_id\": self.session_id})\n if inspect.isawaitable(result):\n result = await result\n return result\n except Exception: # pylint: disable=broad-except\n # Hook failed, return None\n return None\n\n async def get_messages(self) -> list[SessionEvent]:\n \"\"\"\n Retrieve all events and messages from this session's history.\n\n This returns the complete conversation history including user messages,\n assistant responses, tool executions, and other session events.\n\n Returns:\n A list of all session events in chronological order.\n\n Raises:\n Exception: If the session has been disconnected or the connection fails.\n\n Example:\n >>> from copilot.generated.session_events import AssistantMessageData\n >>> events = await session.get_messages()\n >>> for event in events:\n ... match event.data:\n ... case AssistantMessageData() as data:\n ... print(f\"Assistant: {data.content}\")\n \"\"\"\n response = await self._client.request(\"session.getMessages\", {\"sessionId\": self.session_id})\n # Convert dict events to SessionEvent objects\n events_dicts = response[\"events\"]\n return [session_event_from_dict(event_dict) for event_dict in events_dicts]\n\n async def disconnect(self) -> None:\n \"\"\"\n Disconnect this session and release all in-memory resources (event handlers,\n tool handlers, permission handlers).\n\n Session state on disk (conversation history, planning state, artifacts)\n is preserved, so the conversation can be resumed later by calling\n :meth:`CopilotClient.resume_session` with the session ID. To\n permanently remove all session data including files on disk, use\n :meth:`CopilotClient.delete_session` instead.\n\n After calling this method, the session object can no longer be used.\n\n This method is idempotent—calling it multiple times is safe and will\n not raise an error if the session is already disconnected.\n\n Raises:\n Exception: If the connection fails (on first disconnect call).\n\n Example:\n >>> # Clean up when done — session can still be resumed later\n >>> await session.disconnect()\n \"\"\"\n # Ensure that the check and update of _destroyed are atomic so that\n # only the first caller proceeds to send the destroy RPC.\n with self._event_handlers_lock:\n if self._destroyed:\n return\n self._destroyed = True\n\n try:\n await self._client.request(\"session.destroy\", {\"sessionId\": self.session_id})\n finally:\n # Clear handlers even if the request fails.\n with self._event_handlers_lock:\n self._event_handlers.clear()\n with self._tool_handlers_lock:\n self._tool_handlers.clear()\n with self._permission_handler_lock:\n self._permission_handler = None\n with self._command_handlers_lock:\n self._command_handlers.clear()\n with self._elicitation_handler_lock:\n self._elicitation_handler = None\n\n async def destroy(self) -> None:\n \"\"\"\n .. deprecated::\n Use :meth:`disconnect` instead. This method will be removed in a future release.\n\n Disconnect this session and release all in-memory resources.\n Session data on disk is preserved for later resumption.\n\n Raises:\n Exception: If the connection fails.\n \"\"\"\n import warnings\n\n warnings.warn(\n \"destroy() is deprecated, use disconnect() instead\",\n DeprecationWarning,\n stacklevel=2,\n )\n await self.disconnect()\n\n async def __aenter__(self) -> CopilotSession:\n \"\"\"Enable use as an async context manager.\"\"\"\n return self\n\n async def __aexit__(\n self,\n exc_type: type[BaseException] | None = None,\n exc_val: BaseException | None = None,\n exc_tb: TracebackType | None = None,\n ) -> None:\n \"\"\"\n Exit the async context manager.\n\n Automatically disconnects the session and releases all associated resources.\n \"\"\"\n await self.disconnect()\n\n async def abort(self) -> None:\n \"\"\"\n Abort the currently processing message in this session.\n\n Use this to cancel a long-running request. The session remains valid\n and can continue to be used for new messages.\n\n Raises:\n Exception: If the session has been disconnected or the connection fails.\n\n Example:\n >>> import asyncio\n >>>\n >>> # Start a long-running request\n >>> task = asyncio.create_task(session.send(\"Write a very long story...\"))\n >>>\n >>> # Abort after 5 seconds\n >>> await asyncio.sleep(5)\n >>> await session.abort()\n \"\"\"\n await self._client.request(\"session.abort\", {\"sessionId\": self.session_id})\n\n async def set_model(\n self,\n model: str,\n *,\n reasoning_effort: str | None = None,\n model_capabilities: ModelCapabilitiesOverride | None = None,\n ) -> None:\n \"\"\"\n Change the model for this session.\n\n The new model takes effect for the next message. Conversation history\n is preserved.\n\n Args:\n model: Model ID to switch to (e.g., \"gpt-4.1\", \"claude-sonnet-4\").\n reasoning_effort: Optional reasoning effort level for the new model\n (e.g., \"low\", \"medium\", \"high\", \"xhigh\").\n model_capabilities: Override individual model capabilities resolved by the runtime.\n\n Raises:\n Exception: If the session has been destroyed or the connection fails.\n\n Example:\n >>> await session.set_model(\"gpt-4.1\")\n >>> await session.set_model(\"claude-sonnet-4.6\", reasoning_effort=\"high\")\n \"\"\"\n rpc_caps = None\n if model_capabilities is not None:\n from .client import _capabilities_to_dict\n\n rpc_caps = _RpcModelCapabilitiesOverride.from_dict(\n _capabilities_to_dict(model_capabilities)\n )\n await self.rpc.model.switch_to(\n ModelSwitchToRequest(\n model_id=model,\n reasoning_effort=reasoning_effort,\n model_capabilities=rpc_caps,\n )\n )\n\n async def log(\n self,\n message: str,\n *,\n level: str | None = None,\n ephemeral: bool | None = None,\n ) -> None:\n \"\"\"\n Log a message to the session timeline.\n\n The message appears in the session event stream and is visible to SDK consumers\n and (for non-ephemeral messages) persisted to the session event log on disk.\n\n Args:\n message: The human-readable message to log.\n level: Log severity level (\"info\", \"warning\", \"error\"). Defaults to \"info\".\n ephemeral: When True, the message is transient and not persisted to disk.\n\n Raises:\n Exception: If the session has been destroyed or the connection fails.\n\n Example:\n >>> await session.log(\"Processing started\")\n >>> await session.log(\"Something looks off\", level=\"warning\")\n >>> await session.log(\"Operation failed\", level=\"error\")\n >>> await session.log(\"Temporary status update\", ephemeral=True)\n \"\"\"\n params = LogRequest(\n message=message,\n level=SessionLogLevel(level) if level is not None else None,\n ephemeral=ephemeral,\n )\n await self.rpc.log(params)\n" }, { "path": "python/copilot/session_fs_provider.py", "content": "# --------------------------------------------------------------------------------------------\n# Copyright (c) Microsoft Corporation. All rights reserved.\n# --------------------------------------------------------------------------------------------\n\n\"\"\"Idiomatic base class for session filesystem providers.\n\nSubclasses override the abstract methods using standard Python patterns:\nraise on error, return values directly. The :func:`create_session_fs_adapter`\nfunction wraps a provider into the generated :class:`SessionFsHandler`\nprotocol expected by the SDK, converting exceptions into\n:class:`SessionFSError` results.\n\nErrors whose ``errno`` matches :data:`errno.ENOENT` are mapped to the\n``ENOENT`` error code; all others map to ``UNKNOWN``.\n\"\"\"\n\nfrom __future__ import annotations\n\nimport abc\nimport errno\nfrom collections.abc import Sequence\nfrom dataclasses import dataclass\nfrom datetime import UTC, datetime\n\nfrom .generated.rpc import (\n SessionFSError,\n SessionFSErrorCode,\n SessionFSExistsResult,\n SessionFsHandler,\n SessionFSReaddirResult,\n SessionFSReaddirWithTypesEntry,\n SessionFSReaddirWithTypesResult,\n SessionFSReadFileResult,\n SessionFSStatResult,\n)\n\n\n@dataclass\nclass SessionFsFileInfo:\n \"\"\"File metadata returned by :meth:`SessionFsProvider.stat`.\"\"\"\n\n is_file: bool\n is_directory: bool\n size: int\n mtime: datetime\n birthtime: datetime\n\n\nclass SessionFsProvider(abc.ABC):\n \"\"\"Abstract base class for session filesystem providers.\n\n Subclasses implement the abstract methods below using idiomatic Python:\n raise exceptions on errors and return values directly. Use\n :func:`create_session_fs_adapter` to wrap a provider into the RPC\n handler protocol.\n \"\"\"\n\n @abc.abstractmethod\n async def read_file(self, path: str) -> str:\n \"\"\"Read the full content of a file. Raise if the file does not exist.\"\"\"\n\n @abc.abstractmethod\n async def write_file(self, path: str, content: str, mode: int | None = None) -> None:\n \"\"\"Write *content* to a file, creating parent directories if needed.\"\"\"\n\n @abc.abstractmethod\n async def append_file(self, path: str, content: str, mode: int | None = None) -> None:\n \"\"\"Append *content* to a file, creating parent directories if needed.\"\"\"\n\n @abc.abstractmethod\n async def exists(self, path: str) -> bool:\n \"\"\"Return whether *path* exists.\"\"\"\n\n @abc.abstractmethod\n async def stat(self, path: str) -> SessionFsFileInfo:\n \"\"\"Return metadata for *path*. Raise if it does not exist.\"\"\"\n\n @abc.abstractmethod\n async def mkdir(self, path: str, recursive: bool, mode: int | None = None) -> None:\n \"\"\"Create a directory. If *recursive* is ``True``, create parents.\"\"\"\n\n @abc.abstractmethod\n async def readdir(self, path: str) -> list[str]:\n \"\"\"List entry names in a directory. Raise if it does not exist.\"\"\"\n\n @abc.abstractmethod\n async def readdir_with_types(self, path: str) -> Sequence[SessionFSReaddirWithTypesEntry]:\n \"\"\"List entries with type info. Raise if the directory does not exist.\"\"\"\n\n @abc.abstractmethod\n async def rm(self, path: str, recursive: bool, force: bool) -> None:\n \"\"\"Remove a file or directory.\"\"\"\n\n @abc.abstractmethod\n async def rename(self, src: str, dest: str) -> None:\n \"\"\"Rename / move a file or directory.\"\"\"\n\n\ndef create_session_fs_adapter(provider: SessionFsProvider) -> SessionFsHandler:\n \"\"\"Wrap a :class:`SessionFsProvider` into a :class:`SessionFsHandler`.\n\n The adapter catches exceptions thrown by the provider and converts them\n into :class:`SessionFSError` results expected by the runtime.\n \"\"\"\n return _SessionFsAdapter(provider)\n\n\nclass _SessionFsAdapter:\n \"\"\"Internal adapter that bridges SessionFsProvider → SessionFsHandler.\"\"\"\n\n def __init__(self, provider: SessionFsProvider) -> None:\n self._p = provider\n\n async def read_file(self, params: object) -> SessionFSReadFileResult:\n try:\n content = await self._p.read_file(params.path) # type: ignore[attr-defined]\n return SessionFSReadFileResult.from_dict({\"content\": content})\n except Exception as exc:\n err = _to_session_fs_error(exc)\n return SessionFSReadFileResult.from_dict({\"content\": \"\", \"error\": err.to_dict()})\n\n async def write_file(self, params: object) -> SessionFSError | None:\n try:\n await self._p.write_file(params.path, params.content, getattr(params, \"mode\", None)) # type: ignore[attr-defined]\n return None\n except Exception as exc:\n return _to_session_fs_error(exc)\n\n async def append_file(self, params: object) -> SessionFSError | None:\n try:\n await self._p.append_file(params.path, params.content, getattr(params, \"mode\", None)) # type: ignore[attr-defined]\n return None\n except Exception as exc:\n return _to_session_fs_error(exc)\n\n async def exists(self, params: object) -> SessionFSExistsResult:\n try:\n result = await self._p.exists(params.path) # type: ignore[attr-defined]\n return SessionFSExistsResult.from_dict({\"exists\": result})\n except Exception:\n return SessionFSExistsResult.from_dict({\"exists\": False})\n\n async def stat(self, params: object) -> SessionFSStatResult:\n try:\n info = await self._p.stat(params.path) # type: ignore[attr-defined]\n return SessionFSStatResult(\n is_file=info.is_file,\n is_directory=info.is_directory,\n size=info.size,\n mtime=info.mtime,\n birthtime=info.birthtime,\n )\n except Exception as exc:\n now = datetime.now(UTC)\n err = _to_session_fs_error(exc)\n return SessionFSStatResult(\n is_file=False,\n is_directory=False,\n size=0,\n mtime=now,\n birthtime=now,\n error=err,\n )\n\n async def mkdir(self, params: object) -> SessionFSError | None:\n try:\n await self._p.mkdir(\n params.path, # type: ignore[attr-defined]\n getattr(params, \"recursive\", False),\n getattr(params, \"mode\", None),\n )\n return None\n except Exception as exc:\n return _to_session_fs_error(exc)\n\n async def readdir(self, params: object) -> SessionFSReaddirResult:\n try:\n entries = await self._p.readdir(params.path) # type: ignore[attr-defined]\n return SessionFSReaddirResult.from_dict({\"entries\": entries})\n except Exception as exc:\n err = _to_session_fs_error(exc)\n return SessionFSReaddirResult.from_dict({\"entries\": [], \"error\": err.to_dict()})\n\n async def readdir_with_types(self, params: object) -> SessionFSReaddirWithTypesResult:\n try:\n entries = await self._p.readdir_with_types(params.path) # type: ignore[attr-defined]\n return SessionFSReaddirWithTypesResult(entries=list(entries))\n except Exception as exc:\n err = _to_session_fs_error(exc)\n return SessionFSReaddirWithTypesResult.from_dict(\n {\"entries\": [], \"error\": err.to_dict()}\n )\n\n async def rm(self, params: object) -> SessionFSError | None:\n try:\n await self._p.rm(\n params.path, # type: ignore[attr-defined]\n getattr(params, \"recursive\", False),\n getattr(params, \"force\", False),\n )\n return None\n except Exception as exc:\n return _to_session_fs_error(exc)\n\n async def rename(self, params: object) -> SessionFSError | None:\n try:\n await self._p.rename(params.src, params.dest) # type: ignore[attr-defined]\n return None\n except Exception as exc:\n return _to_session_fs_error(exc)\n\n\ndef _to_session_fs_error(exc: Exception) -> SessionFSError:\n code = SessionFSErrorCode.ENOENT if _is_enoent(exc) else SessionFSErrorCode.UNKNOWN\n return SessionFSError(code=code, message=str(exc))\n\n\ndef _is_enoent(exc: Exception) -> bool:\n if isinstance(exc, FileNotFoundError):\n return True\n if isinstance(exc, OSError) and exc.errno == errno.ENOENT:\n return True\n return False\n" }, { "path": "python/copilot/tools.py", "content": "\"\"\"\nTool definition utilities for the Copilot SDK.\n\nProvides a decorator-based API for defining tools with automatic JSON schema\ngeneration from Pydantic models.\n\"\"\"\n\nfrom __future__ import annotations\n\nimport inspect\nimport json\nfrom collections.abc import Awaitable, Callable\nfrom dataclasses import dataclass, field\nfrom typing import Any, Literal, TypeVar, get_type_hints, overload\n\nfrom pydantic import BaseModel\n\nToolResultType = Literal[\"success\", \"failure\", \"rejected\", \"denied\", \"timeout\"]\n\n\n@dataclass\nclass ToolBinaryResult:\n \"\"\"Binary content returned by a tool.\"\"\"\n\n data: str = \"\"\n mime_type: str = \"\"\n type: str = \"\"\n description: str = \"\"\n\n\n@dataclass\nclass ToolResult:\n \"\"\"Result of a tool invocation.\"\"\"\n\n text_result_for_llm: str = \"\"\n result_type: ToolResultType = \"success\"\n error: str | None = None\n binary_results_for_llm: list[ToolBinaryResult] | None = None\n session_log: str | None = None\n tool_telemetry: dict[str, Any] | None = None\n _from_exception: bool = field(default=False, repr=False)\n\n\n@dataclass\nclass ToolInvocation:\n \"\"\"Context passed to a tool handler when invoked.\"\"\"\n\n session_id: str = \"\"\n tool_call_id: str = \"\"\n tool_name: str = \"\"\n arguments: Any = None\n\n\nToolHandler = Callable[[ToolInvocation], ToolResult | Awaitable[ToolResult]]\n\n\n@dataclass\nclass Tool:\n name: str\n description: str\n handler: ToolHandler\n parameters: dict[str, Any] | None = None\n overrides_built_in_tool: bool = False\n skip_permission: bool = False\n\n\nT = TypeVar(\"T\", bound=BaseModel)\nR = TypeVar(\"R\")\n\n\n@overload\ndef define_tool(\n name: str | None = None,\n *,\n description: str | None = None,\n overrides_built_in_tool: bool = False,\n skip_permission: bool = False,\n) -> Callable[[Callable[..., Any]], Tool]: ...\n\n\n@overload\ndef define_tool(\n name: str,\n *,\n description: str | None = None,\n handler: Callable[[T, ToolInvocation], R],\n params_type: type[T],\n overrides_built_in_tool: bool = False,\n skip_permission: bool = False,\n) -> Tool: ...\n\n\ndef define_tool(\n name: str | None = None,\n *,\n description: str | None = None,\n handler: Callable[[Any, ToolInvocation], Any] | None = None,\n params_type: type[BaseModel] | None = None,\n overrides_built_in_tool: bool = False,\n skip_permission: bool = False,\n) -> Tool | Callable[[Callable[[Any, ToolInvocation], Any]], Tool]:\n \"\"\"\n Define a tool with automatic JSON schema generation from Pydantic models.\n\n Can be used as a decorator or as a function:\n\n Decorator usage (recommended):\n\n from pydantic import BaseModel, Field\n\n class LookupIssueParams(BaseModel):\n id: str = Field(description=\"Issue identifier\")\n\n @define_tool(description=\"Fetch issue details\")\n def lookup_issue(params: LookupIssueParams) -> str:\n return fetch_issue(params.id).summary\n\n Function usage:\n\n tool = define_tool(\n \"lookup_issue\",\n description=\"Fetch issue details\",\n handler=lambda params, inv: fetch_issue(params.id).summary,\n params_type=LookupIssueParams\n )\n\n Args:\n name: The tool name (defaults to function name)\n description: Description of what the tool does (shown to the LLM)\n handler: Optional handler function (if not using as decorator)\n params_type: Optional Pydantic model type for parameters (inferred from\n type hints when using as decorator)\n overrides_built_in_tool: When True, explicitly indicates this tool is intended\n to override a built-in tool of the same name. If not set and the\n name clashes with a built-in tool, the runtime will return an error.\n skip_permission: When True, the tool can execute without a permission prompt.\n\n Returns:\n A Tool instance\n \"\"\"\n\n def decorator(fn: Callable[..., Any]) -> Tool:\n tool_name = name if name is not None else getattr(fn, \"__name__\", \"unknown\")\n\n sig = inspect.signature(fn)\n param_names = list(sig.parameters.keys())\n hints = get_type_hints(fn)\n num_params = len(param_names)\n\n # Detect handler signature:\n # - 0 params: handler()\n # - 1 param, ToolInvocation: handler(invocation)\n # - 1 param, Pydantic: handler(params)\n # - 2 params: handler(params, invocation)\n ptype = params_type\n first_param_type = hints.get(param_names[0]) if param_names else None\n\n if num_params == 0:\n takes_params = False\n takes_invocation = False\n elif num_params == 1 and first_param_type is ToolInvocation:\n takes_params = False\n takes_invocation = True\n else:\n takes_params = True\n takes_invocation = num_params >= 2\n if ptype is None and _is_pydantic_model(first_param_type):\n ptype = first_param_type\n\n # Generate schema from Pydantic model\n schema = None\n if ptype is not None and _is_pydantic_model(ptype):\n schema = ptype.model_json_schema()\n\n async def wrapped_handler(invocation: ToolInvocation) -> ToolResult:\n try:\n # Build args based on detected signature\n call_args = []\n if takes_params:\n args = invocation.arguments or {}\n if ptype is not None and _is_pydantic_model(ptype):\n call_args.append(ptype.model_validate(args))\n else:\n call_args.append(args)\n if takes_invocation:\n call_args.append(invocation)\n\n result = fn(*call_args)\n\n if inspect.isawaitable(result):\n result = await result\n\n return _normalize_result(result)\n\n except Exception as exc:\n # Don't expose detailed error information to the LLM for security reasons.\n # The actual error is stored in the 'error' field for debugging.\n return ToolResult(\n text_result_for_llm=(\n \"Invoking this tool produced an error. \"\n \"Detailed information is not available.\"\n ),\n result_type=\"failure\",\n error=str(exc),\n tool_telemetry={},\n _from_exception=True,\n )\n\n return Tool(\n name=tool_name,\n description=description or \"\",\n parameters=schema,\n handler=wrapped_handler,\n overrides_built_in_tool=overrides_built_in_tool,\n skip_permission=skip_permission,\n )\n\n # If handler is provided, call decorator immediately\n if handler is not None:\n if name is None:\n raise ValueError(\"name is required when using define_tool with handler=\")\n return decorator(handler)\n\n # Otherwise return decorator for @define_tool(...) usage\n return decorator\n\n\ndef _is_pydantic_model(t: Any) -> bool:\n \"\"\"Check if a type is a Pydantic BaseModel subclass.\"\"\"\n try:\n return isinstance(t, type) and issubclass(t, BaseModel)\n except TypeError:\n return False\n\n\ndef _normalize_result(result: Any) -> ToolResult:\n \"\"\"\n Convert any return value to a ToolResult.\n\n - None returns empty success\n - Strings pass through directly\n - ToolResult passes through\n - Everything else gets JSON-serialized (with Pydantic support)\n \"\"\"\n if result is None:\n return ToolResult(\n text_result_for_llm=\"\",\n result_type=\"success\",\n )\n\n # ToolResult dataclass passes through directly\n if isinstance(result, ToolResult):\n return result\n\n # Strings pass through directly\n if isinstance(result, str):\n return ToolResult(\n text_result_for_llm=result,\n result_type=\"success\",\n )\n\n # Everything else gets JSON-serialized (with Pydantic model support)\n def default(obj: Any) -> Any:\n if isinstance(obj, BaseModel):\n return obj.model_dump()\n raise TypeError(f\"Object of type {type(obj).__name__} is not JSON serializable\")\n\n try:\n json_str = json.dumps(result, default=default)\n except (TypeError, ValueError) as exc:\n raise TypeError(f\"Failed to serialize tool result: {exc}\") from exc\n\n return ToolResult(\n text_result_for_llm=json_str,\n result_type=\"success\",\n )\n\n\ndef convert_mcp_call_tool_result(call_result: dict[str, Any]) -> ToolResult:\n \"\"\"Convert an MCP CallToolResult dict into a ToolResult.\"\"\"\n text_parts: list[str] = []\n binary_results: list[ToolBinaryResult] = []\n\n for block in call_result[\"content\"]:\n block_type = block.get(\"type\")\n if block_type == \"text\":\n text = block.get(\"text\", \"\")\n if isinstance(text, str):\n text_parts.append(text)\n elif block_type == \"image\":\n data = block.get(\"data\", \"\")\n mime_type = block.get(\"mimeType\", \"\")\n if isinstance(data, str) and data and isinstance(mime_type, str):\n binary_results.append(\n ToolBinaryResult(\n data=data,\n mime_type=mime_type,\n type=\"image\",\n )\n )\n elif block_type == \"resource\":\n resource = block.get(\"resource\", {})\n if not isinstance(resource, dict):\n continue\n text = resource.get(\"text\")\n if isinstance(text, str) and text:\n text_parts.append(text)\n blob = resource.get(\"blob\")\n if isinstance(blob, str) and blob:\n mime_type = resource.get(\"mimeType\", \"application/octet-stream\")\n uri = resource.get(\"uri\", \"\")\n binary_results.append(\n ToolBinaryResult(\n data=blob,\n mime_type=mime_type\n if isinstance(mime_type, str)\n else \"application/octet-stream\",\n type=\"resource\",\n description=uri if isinstance(uri, str) else \"\",\n )\n )\n\n return ToolResult(\n text_result_for_llm=\"\\n\".join(text_parts),\n result_type=\"failure\" if call_result.get(\"isError\") is True else \"success\",\n binary_results_for_llm=binary_results if binary_results else None,\n )\n" }, { "path": "python/e2e/__init__.py", "content": "\"\"\"E2E tests for the Python SDK.\"\"\"\n" }, { "path": "python/e2e/conftest.py", "content": "\"\"\"Shared pytest fixtures for e2e tests.\"\"\"\n\nimport pytest\nimport pytest_asyncio\n\nfrom .testharness import E2ETestContext\n\n\n@pytest.hookimpl(tryfirst=True, hookwrapper=True)\ndef pytest_runtest_makereport(item, call):\n \"\"\"Track test failures to avoid writing corrupted snapshots.\"\"\"\n outcome = yield\n rep = outcome.get_result()\n if rep.when == \"call\" and rep.failed:\n # Store on the item's stash so the fixture can access it\n item.session.stash.setdefault(\"any_test_failed\", False)\n item.session.stash[\"any_test_failed\"] = True\n\n\n@pytest_asyncio.fixture(scope=\"module\", loop_scope=\"module\")\nasync def ctx(request):\n \"\"\"Create and teardown a test context shared across all tests in this module.\"\"\"\n context = E2ETestContext()\n await context.setup()\n yield context\n any_failed = request.session.stash.get(\"any_test_failed\", False)\n await context.teardown(test_failed=any_failed)\n\n\n@pytest_asyncio.fixture(autouse=True, loop_scope=\"module\")\nasync def configure_test(request, ctx):\n \"\"\"Automatically configure the proxy for each test.\"\"\"\n # Extract test file name from module\n # (e.g., \"test_session\" -> \"session\", \"test_session_e2e\" -> \"session\")\n module_name = request.module.__name__.split(\".\")[-1]\n if module_name.startswith(\"test_\"):\n test_file = module_name[5:] # Remove \"test_\" prefix\n else:\n test_file = module_name\n if test_file.endswith(\"_e2e\"):\n test_file = test_file[:-4] # Remove \"_e2e\" suffix for snapshot folder compatibility\n\n # Extract test name (e.g., \"test_should_create_sessions\" -> \"should_create_sessions\")\n test_name = request.node.name\n if test_name.startswith(\"test_\"):\n test_name = test_name[5:] # Remove \"test_\" prefix\n\n await ctx.configure_for_test(test_file, test_name)\n yield\n" }, { "path": "python/e2e/test_agent_and_compact_rpc_e2e.py", "content": "\"\"\"E2E tests for Agent Selection and Session Compaction RPC APIs.\"\"\"\n\nimport pytest\n\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\nfrom copilot.generated.rpc import AgentSelectRequest\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import CLI_PATH, E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nclass TestAgentSelectionRpc:\n @pytest.mark.asyncio\n async def test_should_list_available_custom_agents(self):\n \"\"\"Test listing available custom agents via RPC.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n custom_agents=[\n {\n \"name\": \"test-agent\",\n \"display_name\": \"Test Agent\",\n \"description\": \"A test agent\",\n \"prompt\": \"You are a test agent.\",\n },\n {\n \"name\": \"another-agent\",\n \"display_name\": \"Another Agent\",\n \"description\": \"Another test agent\",\n \"prompt\": \"You are another agent.\",\n },\n ],\n )\n\n result = await session.rpc.agent.list()\n assert result.agents is not None\n assert len(result.agents) == 2\n assert result.agents[0].name == \"test-agent\"\n assert result.agents[0].display_name == \"Test Agent\"\n assert result.agents[0].description == \"A test agent\"\n assert result.agents[1].name == \"another-agent\"\n\n await session.disconnect()\n await client.stop()\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_should_return_null_when_no_agent_is_selected(self):\n \"\"\"Test getCurrent returns null when no agent is selected.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n custom_agents=[\n {\n \"name\": \"test-agent\",\n \"display_name\": \"Test Agent\",\n \"description\": \"A test agent\",\n \"prompt\": \"You are a test agent.\",\n }\n ],\n )\n\n result = await session.rpc.agent.get_current()\n assert result.agent is None\n\n await session.disconnect()\n await client.stop()\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_should_select_and_get_current_agent(self):\n \"\"\"Test selecting an agent and verifying getCurrent returns it.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n custom_agents=[\n {\n \"name\": \"test-agent\",\n \"display_name\": \"Test Agent\",\n \"description\": \"A test agent\",\n \"prompt\": \"You are a test agent.\",\n }\n ],\n )\n\n # Select the agent\n select_result = await session.rpc.agent.select(AgentSelectRequest(name=\"test-agent\"))\n assert select_result.agent is not None\n assert select_result.agent.name == \"test-agent\"\n assert select_result.agent.display_name == \"Test Agent\"\n\n # Verify getCurrent returns the selected agent\n current_result = await session.rpc.agent.get_current()\n assert current_result.agent is not None\n assert current_result.agent.name == \"test-agent\"\n\n await session.disconnect()\n await client.stop()\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_should_deselect_current_agent(self):\n \"\"\"Test deselecting the current agent.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n custom_agents=[\n {\n \"name\": \"test-agent\",\n \"display_name\": \"Test Agent\",\n \"description\": \"A test agent\",\n \"prompt\": \"You are a test agent.\",\n }\n ],\n )\n\n # Select then deselect\n await session.rpc.agent.select(AgentSelectRequest(name=\"test-agent\"))\n await session.rpc.agent.deselect()\n\n # Verify no agent is selected\n current_result = await session.rpc.agent.get_current()\n assert current_result.agent is None\n\n await session.disconnect()\n await client.stop()\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_should_return_empty_list_when_no_custom_agents_configured(self):\n \"\"\"Test listing agents returns no custom agents when none configured.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n result = await session.rpc.agent.list()\n # The CLI may return built-in/default agents even when no custom agents\n # are configured. Verify no custom test agents appear in the list.\n custom_names = {\"test-agent\", \"another-agent\"}\n for agent in result.agents:\n assert agent.name not in custom_names, (\n f\"Expected no custom agents, but found {agent.name!r}\"\n )\n\n await session.disconnect()\n await client.stop()\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_should_call_agent_reload(self):\n \"\"\"Test reloading agents via RPC.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n custom_agents=[\n {\n \"name\": \"reload-test-agent\",\n \"display_name\": \"Reload Agent\",\n \"description\": \"An agent used to validate reload\",\n \"prompt\": \"You are a reload test agent.\",\n }\n ],\n )\n\n before = await session.rpc.agent.list()\n assert any(agent.name == \"reload-test-agent\" for agent in before.agents)\n\n # Reload should succeed and return some agent set. The CLI currently\n # drops session-configured CustomAgents on reload, so we don't\n # require the reload-test-agent to remain present after reload.\n result = await session.rpc.agent.reload()\n assert result.agents is not None\n\n await session.disconnect()\n await client.stop()\n finally:\n await client.force_stop()\n\n\nclass TestSessionCompactionRpc:\n @pytest.mark.asyncio\n async def test_should_compact_session_history_after_messages(self, ctx: E2ETestContext):\n \"\"\"Test compacting session history via RPC.\"\"\"\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n # Send a message to create some history\n await session.send_and_wait(\"What is 2+2?\")\n\n # Compact the session\n result = await session.rpc.history.compact()\n assert isinstance(result.success, bool)\n assert isinstance(result.tokens_removed, (int, float))\n assert isinstance(result.messages_removed, (int, float))\n\n await session.disconnect()\n" }, { "path": "python/e2e/test_ask_user_e2e.py", "content": "\"\"\"\nTests for user input (ask_user) functionality\n\"\"\"\n\nimport pytest\n\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nclass TestAskUser:\n async def test_should_invoke_user_input_handler_when_model_uses_ask_user_tool(\n self, ctx: E2ETestContext\n ):\n \"\"\"Test that user input handler is invoked when model uses ask_user tool\"\"\"\n user_input_requests = []\n\n async def on_user_input_request(request, invocation):\n user_input_requests.append(request)\n assert invocation[\"session_id\"] == session.session_id\n\n # Return the first choice if available, otherwise a freeform answer\n choices = request.get(\"choices\")\n return {\n \"answer\": choices[0] if choices else \"freeform answer\",\n \"wasFreeform\": not bool(choices),\n }\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n on_user_input_request=on_user_input_request,\n )\n\n await session.send_and_wait(\n \"Ask me to choose between 'Option A' and 'Option B' using the ask_user \"\n \"tool. Wait for my response before continuing.\"\n )\n\n # Should have received at least one user input request\n assert len(user_input_requests) > 0\n\n # The request should have a question\n assert any(\n req.get(\"question\") and len(req.get(\"question\")) > 0 for req in user_input_requests\n )\n\n await session.disconnect()\n\n async def test_should_receive_choices_in_user_input_request(self, ctx: E2ETestContext):\n \"\"\"Test that choices are received in user input request\"\"\"\n user_input_requests = []\n\n async def on_user_input_request(request, invocation):\n user_input_requests.append(request)\n # Pick the first choice\n choices = request.get(\"choices\")\n return {\n \"answer\": choices[0] if choices else \"default\",\n \"wasFreeform\": False,\n }\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n on_user_input_request=on_user_input_request,\n )\n\n await session.send_and_wait(\n \"Use the ask_user tool to ask me to pick between exactly two options: \"\n \"'Red' and 'Blue'. These should be provided as choices. Wait for my answer.\"\n )\n\n # Should have received a request\n assert len(user_input_requests) > 0\n\n # At least one request should have choices\n request_with_choices = next(\n (req for req in user_input_requests if req.get(\"choices\") and len(req[\"choices\"]) > 0),\n None,\n )\n assert request_with_choices is not None\n\n await session.disconnect()\n\n async def test_should_handle_freeform_user_input_response(self, ctx: E2ETestContext):\n \"\"\"Test that freeform user input responses work\"\"\"\n user_input_requests = []\n freeform_answer = \"This is my custom freeform answer that was not in the choices\"\n\n async def on_user_input_request(request, invocation):\n user_input_requests.append(request)\n # Return a freeform answer (not from choices)\n return {\n \"answer\": freeform_answer,\n \"wasFreeform\": True,\n }\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n on_user_input_request=on_user_input_request,\n )\n\n response = await session.send_and_wait(\n \"Ask me a question using ask_user and then include my answer in your \"\n \"response. The question should be 'What is your favorite color?'\"\n )\n\n # Should have received a request\n assert len(user_input_requests) > 0\n\n # The model's response should reference the freeform answer we provided\n # (This is a soft check since the model may paraphrase)\n assert response is not None\n\n await session.disconnect()\n" }, { "path": "python/e2e/test_builtin_tools_e2e.py", "content": "\"\"\"Smoke E2E coverage for Copilot CLI built-in tools.\"\"\"\n\nfrom __future__ import annotations\n\nimport os\nimport re\nfrom pathlib import Path\n\nimport pytest\n\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nclass TestBuiltinTools:\n async def test_should_capture_exit_code_in_output(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n try:\n message = await session.send_and_wait(\n \"Run 'echo hello && echo world'. Tell me the exact output.\"\n )\n content = message.data.content if message else \"\"\n assert \"hello\" in content\n assert \"world\" in content\n finally:\n await session.disconnect()\n\n @pytest.mark.skipif(\n os.name == \"nt\",\n reason=\"The stderr prompt uses bash syntax and is skipped by the TS suite on Windows.\",\n )\n async def test_should_capture_stderr_output(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n try:\n message = await session.send_and_wait(\n \"Run 'echo error_msg >&2; echo ok' and tell me what stderr said. \"\n \"Reply with just the stderr content.\"\n )\n assert message is not None\n assert \"error_msg\" in message.data.content\n finally:\n await session.disconnect()\n\n async def test_should_read_file_with_line_range(self, ctx: E2ETestContext):\n Path(ctx.work_dir, \"lines.txt\").write_text(\n \"line1\\nline2\\nline3\\nline4\\nline5\\n\", encoding=\"utf-8\", newline=\"\\n\"\n )\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n try:\n message = await session.send_and_wait(\n \"Read lines 2 through 4 of the file 'lines.txt' in this directory. \"\n \"Tell me what those lines contain.\"\n )\n content = message.data.content if message else \"\"\n assert \"line2\" in content\n assert \"line4\" in content\n finally:\n await session.disconnect()\n\n async def test_should_handle_nonexistent_file_gracefully(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n try:\n message = await session.send_and_wait(\n \"Try to read the file 'does_not_exist.txt'. \"\n \"If it doesn't exist, say 'FILE_NOT_FOUND'.\"\n )\n content = message.data.content if message else \"\"\n assert re.search(\n r\"NOT.FOUND|NOT.EXIST|NO.SUCH|FILE_NOT_FOUND|DOES.NOT.EXIST|ERROR\",\n content,\n re.IGNORECASE,\n )\n finally:\n await session.disconnect()\n\n async def test_should_edit_a_file_successfully(self, ctx: E2ETestContext):\n Path(ctx.work_dir, \"edit_me.txt\").write_text(\n \"Hello World\\nGoodbye World\\n\", encoding=\"utf-8\", newline=\"\\n\"\n )\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n try:\n message = await session.send_and_wait(\n \"Edit the file 'edit_me.txt': replace 'Hello World' with \"\n \"'Hi Universe'. Then read it back and tell me its contents.\"\n )\n assert message is not None\n assert \"Hi Universe\" in message.data.content\n finally:\n await session.disconnect()\n\n async def test_should_create_a_new_file(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n try:\n message = await session.send_and_wait(\n \"Create a file called 'new_file.txt' with the content \"\n \"'Created by test'. Then read it back to confirm.\"\n )\n assert message is not None\n assert \"Created by test\" in message.data.content\n finally:\n await session.disconnect()\n\n async def test_should_search_for_patterns_in_files(self, ctx: E2ETestContext):\n Path(ctx.work_dir, \"data.txt\").write_text(\n \"apple\\nbanana\\napricot\\ncherry\\n\", encoding=\"utf-8\", newline=\"\\n\"\n )\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n try:\n message = await session.send_and_wait(\n \"Search for lines starting with 'ap' in the file 'data.txt'. \"\n \"Tell me which lines matched.\"\n )\n content = message.data.content if message else \"\"\n assert \"apple\" in content\n assert \"apricot\" in content\n finally:\n await session.disconnect()\n\n async def test_should_find_files_by_pattern(self, ctx: E2ETestContext):\n src_dir = Path(ctx.work_dir, \"src\")\n src_dir.mkdir()\n Path(src_dir, \"index.ts\").write_text(\"export const index = 1;\", encoding=\"utf-8\")\n Path(ctx.work_dir, \"README.md\").write_text(\"# Readme\", encoding=\"utf-8\")\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n try:\n message = await session.send_and_wait(\n \"Find all .ts files in this directory (recursively). List the filenames you found.\"\n )\n assert message is not None\n assert \"index.ts\" in message.data.content\n finally:\n await session.disconnect()\n" }, { "path": "python/e2e/test_client_api_e2e.py", "content": "\"\"\"\nTests for client-scoped session-management APIs:\n``delete_session``, ``get_session_metadata``, ``get_last_session_id``,\n``get_foreground_session_id``, and ``set_foreground_session_id``.\n\nThe file is named ``test_client_api`` so the conftest snapshot resolver picks\nup the ``test/snapshots/client_api`` folder shared with the C# suite\n(``ClientSessionManagementTests.cs``).\n\"\"\"\n\nfrom __future__ import annotations\n\nimport pytest\n\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nclass TestClientApi:\n async def test_should_delete_session_by_id(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n session_id = session.session_id\n await session.send_and_wait(\"Say OK.\")\n await session.disconnect()\n await ctx.client.delete_session(session_id)\n\n metadata = await ctx.client.get_session_metadata(session_id)\n assert metadata is None\n\n async def test_should_report_error_when_deleting_unknown_session_id(self, ctx: E2ETestContext):\n await ctx.client.start()\n\n with pytest.raises(Exception) as exc_info:\n await ctx.client.delete_session(\"00000000-0000-0000-0000-000000000000\")\n assert \"session file not found\" in str(exc_info.value).lower()\n\n async def test_should_get_null_last_session_id_before_any_sessions_exist(\n self, ctx: E2ETestContext\n ):\n await ctx.client.start()\n result = await ctx.client.get_last_session_id()\n assert result is None\n\n async def test_should_track_last_session_id_after_session_created(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n await session.send_and_wait(\"Say OK.\")\n session_id = session.session_id\n await session.disconnect()\n\n last_id = await ctx.client.get_last_session_id()\n assert last_id == session_id\n\n async def test_should_get_null_foreground_session_id_in_headless_mode(\n self, ctx: E2ETestContext\n ):\n await ctx.client.start()\n session_id = await ctx.client.get_foreground_session_id()\n assert session_id is None\n\n async def test_should_report_error_when_setting_foreground_session_in_headless_mode(\n self, ctx: E2ETestContext\n ):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n with pytest.raises(Exception) as exc_info:\n await ctx.client.set_foreground_session_id(session.session_id)\n err = str(exc_info.value).lower()\n assert \"tui\" in err or \"server\" in err\n finally:\n await session.disconnect()\n" }, { "path": "python/e2e/test_client_e2e.py", "content": "\"\"\"E2E Client Tests\"\"\"\n\nimport pytest\n\nfrom copilot import CopilotClient\nfrom copilot.client import (\n ModelCapabilities,\n ModelInfo,\n ModelLimits,\n ModelSupports,\n StopError,\n SubprocessConfig,\n)\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import CLI_PATH\n\n\nclass TestClient:\n @pytest.mark.asyncio\n async def test_should_start_and_connect_to_server_using_stdio(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n assert client.get_state() == \"connected\"\n\n pong = await client.ping(\"test message\")\n assert pong.message == \"pong: test message\"\n assert pong.timestamp >= 0\n\n await client.stop()\n assert client.get_state() == \"disconnected\"\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_should_start_and_connect_to_server_using_tcp(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=False))\n\n try:\n await client.start()\n assert client.get_state() == \"connected\"\n\n pong = await client.ping(\"test message\")\n assert pong.message == \"pong: test message\"\n assert pong.timestamp >= 0\n\n await client.stop()\n assert client.get_state() == \"disconnected\"\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_should_raise_exception_group_on_failed_cleanup(self):\n import asyncio\n\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n\n try:\n await client.create_session(on_permission_request=PermissionHandler.approve_all)\n\n # Kill the server process to force cleanup to fail\n process = client._process\n assert process is not None\n process.kill()\n await asyncio.sleep(0.1)\n\n try:\n await client.stop()\n except ExceptionGroup as exc:\n assert len(exc.exceptions) > 0\n assert isinstance(exc.exceptions[0], StopError)\n assert \"Failed to disconnect session\" in exc.exceptions[0].message\n else:\n assert client.get_state() == \"disconnected\"\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_should_force_stop_without_cleanup(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n\n await client.create_session(on_permission_request=PermissionHandler.approve_all)\n await client.force_stop()\n assert client.get_state() == \"disconnected\"\n\n @pytest.mark.asyncio\n async def test_should_get_status_with_version_and_protocol_info(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n\n status = await client.get_status()\n assert hasattr(status, \"version\")\n assert isinstance(status.version, str)\n assert hasattr(status, \"protocolVersion\")\n assert isinstance(status.protocolVersion, int)\n assert status.protocolVersion >= 1\n\n await client.stop()\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_should_get_auth_status(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n\n auth_status = await client.get_auth_status()\n assert hasattr(auth_status, \"isAuthenticated\")\n assert isinstance(auth_status.isAuthenticated, bool)\n if auth_status.isAuthenticated:\n assert hasattr(auth_status, \"authType\")\n assert hasattr(auth_status, \"statusMessage\")\n\n await client.stop()\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_should_list_models_when_authenticated(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n\n auth_status = await client.get_auth_status()\n if not auth_status.isAuthenticated:\n # Skip if not authenticated - models.list requires auth\n await client.stop()\n return\n\n models = await client.list_models()\n assert isinstance(models, list)\n if len(models) > 0:\n model = models[0]\n assert hasattr(model, \"id\")\n assert hasattr(model, \"name\")\n assert hasattr(model, \"capabilities\")\n assert hasattr(model.capabilities, \"supports\")\n assert hasattr(model.capabilities, \"limits\")\n\n await client.stop()\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_should_cache_models_list(self):\n \"\"\"Test that list_models caches results to avoid rate limiting\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n\n auth_status = await client.get_auth_status()\n if not auth_status.isAuthenticated:\n # Skip if not authenticated - models.list requires auth\n await client.stop()\n return\n\n # First call should fetch from backend\n models1 = await client.list_models()\n assert isinstance(models1, list)\n\n # Second call should return from cache (different list object but same content)\n models2 = await client.list_models()\n assert models2 is not models1, \"Should return a copy, not the same object\"\n assert len(models2) == len(models1), \"Cached results should have same content\"\n if len(models1) > 0:\n assert models1[0].id == models2[0].id, \"Cached models should match\"\n\n # After stopping, cache should be cleared\n await client.stop()\n\n # Restart and verify cache is empty\n await client.start()\n\n # Check authentication again after restart\n auth_status = await client.get_auth_status()\n if not auth_status.isAuthenticated:\n await client.stop()\n return\n\n models3 = await client.list_models()\n assert models3 is not models1, \"Cache should be cleared after disconnect\"\n\n await client.stop()\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_should_report_error_with_stderr_when_cli_fails_to_start(self):\n \"\"\"Test that CLI startup errors include stderr output in the error message.\"\"\"\n client = CopilotClient(\n SubprocessConfig(\n cli_path=CLI_PATH,\n cli_args=[\"--nonexistent-flag-for-testing\"],\n use_stdio=True,\n )\n )\n\n try:\n with pytest.raises(RuntimeError) as exc_info:\n await client.start()\n\n error_message = str(exc_info.value)\n # Verify we get the stderr output in the error message\n assert \"stderr\" in error_message, (\n f\"Expected error to contain 'stderr', got: {error_message}\"\n )\n assert \"nonexistent\" in error_message, (\n f\"Expected error to contain 'nonexistent', got: {error_message}\"\n )\n\n # Verify subsequent calls also fail (don't hang)\n with pytest.raises(Exception) as exc_info2:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n await session.send(\"test\")\n # Error message varies by platform (EINVAL on Windows, EPIPE on Linux)\n error_msg = str(exc_info2.value).lower()\n assert \"invalid\" in error_msg or \"pipe\" in error_msg or \"closed\" in error_msg\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_should_not_throw_when_disposing_session_after_stopping_client(self):\n \"\"\"Disconnecting a session after the client is stopped must not raise.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n # Stop the client first; subsequent session disconnect should be harmless.\n await client.stop()\n\n # Should not raise.\n await session.disconnect()\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_should_throw_when_create_session_called_without_permission_handler(self):\n \"\"\"`create_session` requires an `on_permission_request` handler.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n with pytest.raises((TypeError, ValueError)) as exc_info:\n await client.create_session() # type: ignore[call-arg]\n\n message = str(exc_info.value)\n # Accept either 'on_permission_request' missing-arg or runtime validation error.\n assert \"on_permission_request\" in message or \"permission\" in message.lower(), (\n f\"Expected message to reference permission handler, got: {message}\"\n )\n\n await client.stop()\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_should_throw_when_resume_session_called_without_permission_handler(self):\n \"\"\"`resume_session` requires an `on_permission_request` handler.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n with pytest.raises((TypeError, ValueError)) as exc_info:\n await client.resume_session(\"some-session-id\") # type: ignore[call-arg]\n\n message = str(exc_info.value)\n assert \"on_permission_request\" in message or \"permission\" in message.lower(), (\n f\"Expected message to reference permission handler, got: {message}\"\n )\n\n await client.stop()\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_list_models_with_custom_handler_calls_handler(self):\n \"\"\"A custom `on_list_models` handler is invoked instead of the CLI RPC.\"\"\"\n custom_models = [\n ModelInfo(\n id=\"my-custom-model\",\n name=\"My Custom Model\",\n capabilities=ModelCapabilities(\n supports=ModelSupports(vision=False, reasoning_effort=False),\n limits=ModelLimits(max_context_window_tokens=128000),\n ),\n )\n ]\n\n call_count = 0\n\n def on_list_models():\n nonlocal call_count\n call_count += 1\n return custom_models\n\n client = CopilotClient(\n SubprocessConfig(cli_path=CLI_PATH, use_stdio=True),\n on_list_models=on_list_models,\n )\n\n try:\n await client.start()\n\n models = await client.list_models()\n assert call_count == 1\n assert len(models) == 1\n assert models[0].id == \"my-custom-model\"\n\n await client.stop()\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_list_models_with_custom_handler_works_without_start(self):\n \"\"\"The custom `on_list_models` handler is callable even before `start()`.\"\"\"\n custom_models = [\n ModelInfo(\n id=\"no-start-model\",\n name=\"No Start Model\",\n capabilities=ModelCapabilities(\n supports=ModelSupports(vision=False, reasoning_effort=False),\n limits=ModelLimits(max_context_window_tokens=128000),\n ),\n )\n ]\n\n call_count = 0\n\n def on_list_models():\n nonlocal call_count\n call_count += 1\n return custom_models\n\n client = CopilotClient(\n SubprocessConfig(cli_path=CLI_PATH, use_stdio=True),\n on_list_models=on_list_models,\n )\n\n try:\n models = await client.list_models()\n assert call_count == 1\n assert len(models) == 1\n assert models[0].id == \"no-start-model\"\n finally:\n await client.force_stop()\n" }, { "path": "python/e2e/test_client_lifecycle_e2e.py", "content": "\"\"\"\nClient lifecycle tests covering ``client.on(...)`` lifecycle event subscriptions\nand connection-state transitions across ``start``/``stop``.\n\nMirrors ``dotnet/test/ClientLifecycleTests.cs`` plus the existing ``client_lifecycle``\nnodejs scenarios so the YAML snapshots under ``test/snapshots/client_lifecycle/``\ncan be reused.\n\"\"\"\n\nfrom __future__ import annotations\n\nimport asyncio\nimport os\n\nimport pytest\n\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\ndef _make_isolated_client(ctx: E2ETestContext) -> CopilotClient:\n \"\"\"Build a client with the same isolated env as ctx.client but disjoint state.\n\n Used to exercise lifecycle tests that need a known-empty state directory\n or that explicitly drive start/stop transitions.\n \"\"\"\n github_token = (\n \"fake-token-for-e2e-tests\" if os.environ.get(\"GITHUB_ACTIONS\") == \"true\" else None\n )\n return CopilotClient(\n SubprocessConfig(\n cli_path=ctx.cli_path,\n cwd=ctx.work_dir,\n env=ctx.get_env(),\n github_token=github_token,\n )\n )\n\n\nclass TestClientLifecycle:\n async def test_should_return_last_session_id_after_sending_a_message(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n await session.send_and_wait(\"Say hello\")\n # Allow session metadata to flush to disk.\n await asyncio.sleep(0.5)\n\n last_id = await ctx.client.get_last_session_id()\n assert last_id\n finally:\n await session.disconnect()\n\n async def test_should_emit_session_lifecycle_events(self, ctx: E2ETestContext):\n events: list = []\n unsubscribe = ctx.client.on(events.append)\n try:\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n await session.send_and_wait(\"Say hello\")\n await asyncio.sleep(0.5)\n\n if events:\n matching = [e for e in events if e.sessionId == session.session_id]\n assert matching, \"Expected at least one lifecycle event for this session\"\n finally:\n await session.disconnect()\n finally:\n unsubscribe()\n\n async def test_should_receive_session_created_lifecycle_event(self, ctx: E2ETestContext):\n loop = asyncio.get_event_loop()\n created: asyncio.Future = loop.create_future()\n\n def handler(event):\n if event.type == \"session.created\" and not created.done():\n created.set_result(event)\n\n unsubscribe = ctx.client.on(handler)\n try:\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n event = await asyncio.wait_for(created, 10.0)\n assert event.type == \"session.created\"\n assert event.sessionId == session.session_id\n finally:\n await session.disconnect()\n finally:\n unsubscribe()\n\n async def test_should_filter_session_lifecycle_events_by_type(self, ctx: E2ETestContext):\n loop = asyncio.get_event_loop()\n created: asyncio.Future = loop.create_future()\n\n def handler(event):\n if not created.done():\n created.set_result(event)\n\n unsubscribe = ctx.client.on(\"session.created\", handler)\n try:\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n event = await asyncio.wait_for(created, 10.0)\n assert event.type == \"session.created\"\n assert event.sessionId == session.session_id\n finally:\n await session.disconnect()\n finally:\n unsubscribe()\n\n async def test_disposing_lifecycle_subscription_stops_receiving_events(\n self, ctx: E2ETestContext\n ):\n loop = asyncio.get_event_loop()\n unsubscribed_count = 0\n\n def disposed_handler(_event):\n nonlocal unsubscribed_count\n unsubscribed_count += 1\n\n unsubscribe_disposed = ctx.client.on(disposed_handler)\n unsubscribe_disposed() # Immediately dispose first subscription.\n\n active_event: asyncio.Future = loop.create_future()\n unsubscribe_active = ctx.client.on(\n \"session.created\",\n lambda evt: active_event.set_result(evt) if not active_event.done() else None,\n )\n try:\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n event = await asyncio.wait_for(active_event, 10.0)\n assert event.sessionId == session.session_id\n assert unsubscribed_count == 0, \"Disposed handler should not have fired\"\n finally:\n await session.disconnect()\n finally:\n unsubscribe_active()\n\n async def test_stop_disconnects_client_and_disposes_rpc_surface(self, ctx: E2ETestContext):\n client = _make_isolated_client(ctx)\n await client.start()\n try:\n assert client.get_state() == \"connected\"\n finally:\n await client.stop()\n\n assert client.get_state() == \"disconnected\"\n\n with pytest.raises(RuntimeError):\n _ = client.rpc\n" }, { "path": "python/e2e/test_client_options_e2e.py", "content": "\"\"\"\nE2E coverage for ``CopilotClient`` configuration options exposed via\n``SubprocessConfig`` and ``CopilotClient(..., auto_start=...)``.\n\nMirrors ``dotnet/test/ClientOptionsTests.cs``. The two CliUrl-conflict tests\n(``Should_Throw_When_GitHubToken_Used_With_CliUrl`` and\n``Should_Throw_When_UseLoggedInUser_Used_With_CliUrl``) have no Python\nequivalent because Python's ``ExternalServerConfig`` does not accept\n``github_token`` / ``use_logged_in_user`` fields at all (so the conflict cannot\nbe expressed in code), and the configurations are therefore intentionally\nomitted.\n\"\"\"\n\nfrom __future__ import annotations\n\nimport json\nimport os\nimport socket\n\nimport pytest\n\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\nfrom copilot.generated.rpc import PingRequest\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\ndef _make_subprocess_config(ctx: E2ETestContext, **overrides) -> SubprocessConfig:\n base = {\n \"cli_path\": ctx.cli_path,\n \"cwd\": ctx.work_dir,\n \"env\": ctx.get_env(),\n \"github_token\": (\n \"fake-token-for-e2e-tests\" if os.environ.get(\"GITHUB_ACTIONS\") == \"true\" else None\n ),\n }\n base.update(overrides)\n return SubprocessConfig(**base)\n\n\ndef _get_available_port() -> int:\n with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:\n sock.bind((\"127.0.0.1\", 0))\n return sock.getsockname()[1]\n\n\n# ------------------- A scriptable fake CLI to capture process options -------------------\n\nFAKE_STDIO_CLI_SCRIPT = r\"\"\"\nconst fs = require(\"fs\");\n\nconst captureIndex = process.argv.indexOf(\"--capture-file\");\nconst captureFile = captureIndex >= 0 ? process.argv[captureIndex + 1] : undefined;\nconst requests = [];\n\nfunction saveCapture() {\n if (!captureFile) {\n return;\n }\n fs.writeFileSync(captureFile, JSON.stringify({\n args: process.argv.slice(2),\n cwd: process.cwd(),\n requests,\n env: {\n COPILOT_SDK_AUTH_TOKEN: process.env.COPILOT_SDK_AUTH_TOKEN,\n COPILOT_OTEL_ENABLED: process.env.COPILOT_OTEL_ENABLED,\n OTEL_EXPORTER_OTLP_ENDPOINT: process.env.OTEL_EXPORTER_OTLP_ENDPOINT,\n COPILOT_OTEL_FILE_EXPORTER_PATH: process.env.COPILOT_OTEL_FILE_EXPORTER_PATH,\n COPILOT_OTEL_EXPORTER_TYPE: process.env.COPILOT_OTEL_EXPORTER_TYPE,\n COPILOT_OTEL_SOURCE_NAME: process.env.COPILOT_OTEL_SOURCE_NAME,\n OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT:\n process.env.OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT,\n },\n }));\n}\n\nsaveCapture();\n\nlet buffer = Buffer.alloc(0);\nprocess.stdin.on(\"data\", chunk => {\n buffer = Buffer.concat([buffer, chunk]);\n processBuffer();\n});\nprocess.stdin.resume();\n\nfunction processBuffer() {\n while (true) {\n const headerEnd = buffer.indexOf(\"\\r\\n\\r\\n\");\n if (headerEnd < 0) return;\n const header = buffer.subarray(0, headerEnd).toString(\"utf8\");\n const match = /Content-Length:\\s*(\\d+)/i.exec(header);\n if (!match) throw new Error(\"Missing Content-Length header\");\n const length = Number(match[1]);\n const bodyStart = headerEnd + 4;\n const bodyEnd = bodyStart + length;\n if (buffer.length < bodyEnd) return;\n const body = buffer.subarray(bodyStart, bodyEnd).toString(\"utf8\");\n buffer = buffer.subarray(bodyEnd);\n handleMessage(JSON.parse(body));\n }\n}\n\nfunction handleMessage(message) {\n if (!Object.prototype.hasOwnProperty.call(message, \"id\")) {\n return;\n }\n requests.push({ method: message.method, params: message.params });\n saveCapture();\n if (message.method === \"ping\") {\n writeResponse(message.id, { message: \"pong\", protocolVersion: 3, timestamp: Date.now() });\n return;\n }\n if (message.method === \"session.create\") {\n const sessionId = message.params?.sessionId ?? \"fake-session\";\n writeResponse(message.id, { sessionId, workspacePath: null, capabilities: null });\n return;\n }\n writeResponse(message.id, {});\n}\n\nfunction writeResponse(id, result) {\n const body = JSON.stringify({ jsonrpc: \"2.0\", id, result });\n process.stdout.write(`Content-Length: ${Buffer.byteLength(body, \"utf8\")}\\r\\n\\r\\n${body}`);\n}\n\"\"\"\n\n\ndef _assert_arg_value(args: list[str], name: str, expected_value: str) -> None:\n assert name in args, f\"Expected argument '{name}' was not present. Args: {args}\"\n index = args.index(name)\n assert index + 1 < len(args), f\"Expected argument '{name}' to have a value.\"\n assert args[index + 1] == expected_value\n\n\nclass TestClientOptions:\n async def test_autostart_false_requires_explicit_start(self, ctx: E2ETestContext):\n client = CopilotClient(_make_subprocess_config(ctx), auto_start=False)\n try:\n assert client.get_state() == \"disconnected\"\n\n with pytest.raises(RuntimeError) as exc_info:\n await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n # Python raises \"Client not connected\" — equivalent intent to C#'s \"StartAsync\".\n assert (\n \"not connected\" in str(exc_info.value).lower()\n or \"start\" in str(exc_info.value).lower()\n )\n\n await client.start()\n assert client.get_state() == \"connected\"\n\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n assert session.session_id\n await session.disconnect()\n finally:\n await client.stop()\n\n async def test_should_listen_on_configured_tcp_port(self, ctx: E2ETestContext):\n port = _get_available_port()\n client = CopilotClient(_make_subprocess_config(ctx, use_stdio=False, port=port))\n try:\n await client.start()\n assert client.get_state() == \"connected\"\n assert client.actual_port == port\n\n response = await client.rpc.ping(PingRequest(message=\"fixed-port\"))\n assert \"pong\" in response.message\n finally:\n await client.stop()\n\n async def test_should_use_client_cwd_for_default_workingdirectory(self, ctx: E2ETestContext):\n client_cwd = os.path.join(ctx.work_dir, \"client-cwd\")\n os.makedirs(client_cwd, exist_ok=True)\n with open(os.path.join(client_cwd, \"marker.txt\"), \"w\") as f:\n f.write(\"I am in the client cwd\")\n\n client = CopilotClient(_make_subprocess_config(ctx, cwd=client_cwd))\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n message = await session.send_and_wait(\n \"Read the file marker.txt and tell me what it says\"\n )\n assert \"client cwd\" in (message.data.content or \"\")\n finally:\n await session.disconnect()\n finally:\n await client.stop()\n\n async def test_should_propagate_process_options_to_spawned_cli(self, ctx: E2ETestContext):\n cli_path = os.path.join(ctx.work_dir, \"fake-cli.js\")\n capture_path = os.path.join(ctx.work_dir, \"fake-cli-capture.json\")\n telemetry_path = os.path.join(ctx.work_dir, \"telemetry.jsonl\")\n with open(cli_path, \"w\") as f:\n f.write(FAKE_STDIO_CLI_SCRIPT)\n\n client = CopilotClient(\n _make_subprocess_config(\n ctx,\n cli_path=cli_path,\n cli_args=[\"--capture-file\", capture_path],\n github_token=\"process-option-token\",\n log_level=\"debug\",\n session_idle_timeout_seconds=17,\n telemetry={\n \"otlp_endpoint\": \"http://127.0.0.1:4318\",\n \"file_path\": telemetry_path,\n \"exporter_type\": \"file\",\n \"source_name\": \"python-sdk-e2e\",\n \"capture_content\": True,\n },\n use_logged_in_user=False,\n ),\n auto_start=False,\n )\n try:\n await client.start()\n\n with open(capture_path) as f:\n capture = json.load(f)\n\n args = capture[\"args\"]\n env = capture[\"env\"]\n\n _assert_arg_value(args, \"--log-level\", \"debug\")\n assert \"--stdio\" in args\n _assert_arg_value(args, \"--auth-token-env\", \"COPILOT_SDK_AUTH_TOKEN\")\n assert \"--no-auto-login\" in args\n _assert_arg_value(args, \"--session-idle-timeout\", \"17\")\n assert os.path.realpath(capture[\"cwd\"]) == os.path.realpath(ctx.work_dir)\n\n assert env[\"COPILOT_SDK_AUTH_TOKEN\"] == \"process-option-token\"\n assert env[\"COPILOT_OTEL_ENABLED\"] == \"true\"\n assert env[\"OTEL_EXPORTER_OTLP_ENDPOINT\"] == \"http://127.0.0.1:4318\"\n assert env[\"COPILOT_OTEL_FILE_EXPORTER_PATH\"] == telemetry_path\n assert env[\"COPILOT_OTEL_EXPORTER_TYPE\"] == \"file\"\n assert env[\"COPILOT_OTEL_SOURCE_NAME\"] == \"python-sdk-e2e\"\n assert env[\"OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT\"] == \"true\"\n\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n enable_config_discovery=True,\n include_sub_agent_streaming_events=False,\n )\n try:\n with open(capture_path) as f:\n capture = json.load(f)\n create_request = next(\n r for r in capture[\"requests\"] if r[\"method\"] == \"session.create\"\n )\n params = create_request[\"params\"]\n assert params[\"enableConfigDiscovery\"] is True\n assert params[\"includeSubAgentStreamingEvents\"] is False\n finally:\n await session.disconnect()\n finally:\n try:\n await client.stop()\n except Exception:\n await client.force_stop()\n\n\n# ---------------------------------------------------------------------------\n# Unit-style tests mirroring the property-only tests in\n# dotnet/test/ClientOptionsTests.cs. These exercise the SubprocessConfig\n# dataclass shape only — no client / proxy required.\n# ---------------------------------------------------------------------------\n\n\nclass TestSubprocessConfigOptions:\n \"\"\"Mirrors the unit-style ClientOptions tests in the C# baseline.\"\"\"\n\n async def test_should_accept_github_token_option(self):\n # Mirrors: Should_Accept_GitHubToken_Option\n config = SubprocessConfig(github_token=\"gho_test_token\")\n assert config.github_token == \"gho_test_token\"\n\n async def test_should_default_use_logged_in_user_to_none(self):\n # Mirrors: Should_Default_UseLoggedInUser_To_Null\n config = SubprocessConfig()\n assert config.use_logged_in_user is None\n\n async def test_should_allow_explicit_use_logged_in_user_false(self):\n # Mirrors: Should_Allow_Explicit_UseLoggedInUser_False\n config = SubprocessConfig(use_logged_in_user=False)\n assert config.use_logged_in_user is False\n\n async def test_should_allow_explicit_use_logged_in_user_true_with_github_token(self):\n # Mirrors: Should_Allow_Explicit_UseLoggedInUser_True_With_GitHubToken\n config = SubprocessConfig(github_token=\"gho_test_token\", use_logged_in_user=True)\n assert config.use_logged_in_user is True\n assert config.github_token == \"gho_test_token\"\n\n # NOTE: Should_Throw_When_GitHubToken_Used_With_CliUrl and\n # Should_Throw_When_UseLoggedInUser_Used_With_CliUrl from the C# baseline\n # do not apply to Python: ExternalServerConfig has no github_token /\n # use_logged_in_user fields at all (they live only on SubprocessConfig),\n # so the conflicting configuration is impossible to express.\n\n async def test_should_default_session_idle_timeout_seconds_to_none(self):\n # Mirrors: Should_Default_SessionIdleTimeoutSeconds_To_Null\n config = SubprocessConfig()\n assert config.session_idle_timeout_seconds is None\n\n async def test_should_accept_session_idle_timeout_seconds_option(self):\n # Mirrors: Should_Accept_SessionIdleTimeoutSeconds_Option\n config = SubprocessConfig(session_idle_timeout_seconds=600)\n assert config.session_idle_timeout_seconds == 600\n" }, { "path": "python/e2e/test_commands_e2e.py", "content": "\"\"\"E2E Commands Tests\n\nMirrors nodejs/test/e2e/commands.test.ts\n\nMulti-client test: a second client joining a session with commands should\ntrigger a ``commands.changed`` broadcast event visible to the first client.\n\"\"\"\n\nimport asyncio\nimport contextlib\nimport os\nimport shutil\nimport tempfile\n\nimport pytest\nimport pytest_asyncio\n\nfrom copilot import CopilotClient\nfrom copilot.client import ExternalServerConfig, SubprocessConfig\nfrom copilot.session import CommandDefinition, PermissionHandler\n\nfrom .testharness.context import SNAPSHOTS_DIR, get_cli_path_for_tests\nfrom .testharness.proxy import CapiProxy\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\n# ---------------------------------------------------------------------------\n# Multi-client context (TCP mode) — same pattern as test_multi_client.py\n# ---------------------------------------------------------------------------\n\n\nclass CommandsMultiClientContext:\n \"\"\"Test context that manages two clients connected to the same CLI server.\"\"\"\n\n def __init__(self):\n self.cli_path: str = \"\"\n self.home_dir: str = \"\"\n self.work_dir: str = \"\"\n self.proxy_url: str = \"\"\n self._proxy: CapiProxy | None = None\n self._client1: CopilotClient | None = None\n self._client2: CopilotClient | None = None\n\n async def setup(self):\n self.cli_path = get_cli_path_for_tests()\n self.home_dir = os.path.realpath(tempfile.mkdtemp(prefix=\"copilot-cmd-config-\"))\n self.work_dir = os.path.realpath(tempfile.mkdtemp(prefix=\"copilot-cmd-work-\"))\n\n self._proxy = CapiProxy()\n self.proxy_url = await self._proxy.start()\n\n github_token = (\n \"fake-token-for-e2e-tests\" if os.environ.get(\"GITHUB_ACTIONS\") == \"true\" else None\n )\n\n # Client 1 uses TCP mode so a second client can connect\n self._client1 = CopilotClient(\n SubprocessConfig(\n cli_path=self.cli_path,\n cwd=self.work_dir,\n env=self._get_env(),\n use_stdio=False,\n github_token=github_token,\n )\n )\n\n # Trigger connection to get the port\n init_session = await self._client1.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n await init_session.disconnect()\n\n actual_port = self._client1.actual_port\n assert actual_port is not None\n\n self._client2 = CopilotClient(ExternalServerConfig(url=f\"localhost:{actual_port}\"))\n\n async def teardown(self, test_failed: bool = False):\n for c in (self._client2, self._client1):\n if c:\n try:\n await c.stop()\n except Exception:\n pass # Best-effort cleanup during teardown\n self._client1 = self._client2 = None\n\n if self._proxy:\n await self._proxy.stop(skip_writing_cache=test_failed)\n self._proxy = None\n\n for d in (self.home_dir, self.work_dir):\n if d and os.path.exists(d):\n shutil.rmtree(d, ignore_errors=True)\n\n async def configure_for_test(self, test_file: str, test_name: str):\n import re\n\n sanitized_name = re.sub(r\"[^a-zA-Z0-9]\", \"_\", test_name).lower()\n snapshot_path = SNAPSHOTS_DIR / test_file / f\"{sanitized_name}.yaml\"\n if self._proxy:\n await self._proxy.configure(str(snapshot_path.resolve()), self.work_dir)\n from pathlib import Path\n\n for d in (self.home_dir, self.work_dir):\n for item in Path(d).iterdir():\n if item.is_dir():\n shutil.rmtree(item, ignore_errors=True)\n else:\n with contextlib.suppress(OSError):\n item.unlink(missing_ok=True)\n\n def _get_env(self) -> dict:\n env = os.environ.copy()\n env.update(\n {\n \"COPILOT_API_URL\": self.proxy_url,\n \"COPILOT_HOME\": self.home_dir,\n \"XDG_CONFIG_HOME\": self.home_dir,\n \"XDG_STATE_HOME\": self.home_dir,\n }\n )\n return env\n\n @property\n def client1(self) -> CopilotClient:\n assert self._client1 is not None\n return self._client1\n\n @property\n def client2(self) -> CopilotClient:\n assert self._client2 is not None\n return self._client2\n\n\n# ---------------------------------------------------------------------------\n# Fixtures\n# ---------------------------------------------------------------------------\n\n\n@pytest.hookimpl(tryfirst=True, hookwrapper=True)\ndef pytest_runtest_makereport(item, call):\n outcome = yield\n rep = outcome.get_result()\n if rep.when == \"call\" and rep.failed:\n item.session.stash.setdefault(\"any_test_failed\", False)\n item.session.stash[\"any_test_failed\"] = True\n\n\n@pytest_asyncio.fixture(scope=\"module\", loop_scope=\"module\")\nasync def mctx(request):\n context = CommandsMultiClientContext()\n await context.setup()\n yield context\n any_failed = request.session.stash.get(\"any_test_failed\", False)\n await context.teardown(test_failed=any_failed)\n\n\n@pytest_asyncio.fixture(autouse=True, loop_scope=\"module\")\nasync def configure_cmd_test(request):\n # Only configure the proxy when the test actually uses the multi-client\n # context fixture (mctx). Tests using the standard ctx fixture\n # configure their own proxy via conftest.py.\n if \"mctx\" not in request.fixturenames:\n yield\n return\n\n mctx_value = request.getfixturevalue(\"mctx\")\n test_name = request.node.name\n if test_name.startswith(\"test_\"):\n test_name = test_name[5:]\n await mctx_value.configure_for_test(\"multi_client\", test_name)\n yield\n\n\n# ---------------------------------------------------------------------------\n# Tests\n# ---------------------------------------------------------------------------\n\n\nclass TestCommands:\n async def test_client_receives_commands_changed_when_another_client_joins(\n self, mctx: CommandsMultiClientContext\n ):\n \"\"\"Client receives commands.changed when another client joins with commands.\"\"\"\n # Client 1 creates a session without commands\n session1 = await mctx.client1.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n\n # Listen for the commands.changed event\n commands_changed = asyncio.Event()\n commands_data: dict = {}\n\n def on_event(event):\n if event.type.value == \"commands.changed\":\n commands_data[\"commands\"] = getattr(event.data, \"commands\", None)\n commands_changed.set()\n\n session1.on(on_event)\n\n # Client 2 joins the same session with commands\n session2 = await mctx.client2.resume_session(\n session1.session_id,\n on_permission_request=PermissionHandler.approve_all,\n commands=[\n CommandDefinition(\n name=\"deploy\",\n description=\"Deploy the app\",\n handler=lambda ctx: None,\n ),\n ],\n )\n\n # Wait for the commands.changed event (with timeout)\n await asyncio.wait_for(commands_changed.wait(), timeout=15.0)\n\n # Verify the event contains the deploy command\n assert commands_data.get(\"commands\") is not None\n cmd_names = [c.name for c in commands_data[\"commands\"]]\n assert \"deploy\" in cmd_names\n\n await session2.disconnect()\n\n\nclass TestCommandsLifecycle:\n \"\"\"Single-session command lifecycle tests using the shared ctx fixture.\"\"\"\n\n async def test_session_with_commands_creates_successfully(self, ctx):\n from .testharness import E2ETestContext\n\n assert isinstance(ctx, E2ETestContext)\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n commands=[\n CommandDefinition(\n name=\"deploy\",\n description=\"Deploy the app\",\n handler=lambda _: None,\n ),\n CommandDefinition(name=\"rollback\", handler=lambda _: None),\n ],\n )\n try:\n assert session is not None\n assert session.session_id\n finally:\n await session.disconnect()\n\n async def test_session_with_commands_resumes_successfully(self, ctx):\n session1 = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n session_id = session1.session_id\n\n session2 = await ctx.client.resume_session(\n session_id,\n on_permission_request=PermissionHandler.approve_all,\n commands=[\n CommandDefinition(\n name=\"deploy\",\n description=\"Deploy\",\n handler=lambda _: None,\n ),\n ],\n )\n try:\n assert session2 is not None\n assert session2.session_id == session_id\n finally:\n await session2.disconnect()\n await session1.disconnect()\n\n async def test_session_with_no_commands_creates_successfully(self, ctx):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n assert session is not None\n finally:\n await session.disconnect()\n" }, { "path": "python/e2e/test_compaction_e2e.py", "content": "\"\"\"E2E Compaction Tests\"\"\"\n\nimport pytest\n\nfrom copilot.generated.session_events import SessionEventType\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import E2ETestContext\n\npytestmark = [\n pytest.mark.asyncio(loop_scope=\"module\"),\n pytest.mark.skip(\n reason=\"Compaction tests are skipped due to flakiness — re-enable once stabilized\"\n ),\n]\n\n\nclass TestCompaction:\n @pytest.mark.timeout(120)\n async def test_should_trigger_compaction_with_low_threshold_and_emit_events(\n self, ctx: E2ETestContext\n ):\n # Create session with very low compaction thresholds to trigger compaction quickly\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n infinite_sessions={\n \"enabled\": True,\n # Trigger background compaction at 0.5% context usage (~1000 tokens)\n \"background_compaction_threshold\": 0.005,\n # Block at 1% to ensure compaction runs\n \"buffer_exhaustion_threshold\": 0.01,\n },\n )\n\n compaction_start_events = []\n compaction_complete_events = []\n\n def on_event(event):\n if event.type == SessionEventType.SESSION_COMPACTION_START:\n compaction_start_events.append(event)\n if event.type == SessionEventType.SESSION_COMPACTION_COMPLETE:\n compaction_complete_events.append(event)\n\n session.on(on_event)\n\n # Send multiple messages to fill up the context window\n await session.send_and_wait(\"Tell me a story about a dragon. Be detailed.\")\n await session.send_and_wait(\n \"Continue the story with more details about the dragon's castle.\"\n )\n await session.send_and_wait(\"Now describe the dragon's treasure in great detail.\")\n\n # Should have triggered compaction at least once\n assert len(compaction_start_events) >= 1, \"Expected at least 1 compaction_start event\"\n assert len(compaction_complete_events) >= 1, \"Expected at least 1 compaction_complete event\"\n\n # Compaction should have succeeded\n last_complete = compaction_complete_events[-1]\n assert last_complete.data.success is True, \"Expected compaction to succeed\"\n\n # Should have removed some tokens\n if last_complete.data.tokens_removed is not None:\n assert last_complete.data.tokens_removed > 0, \"Expected tokensRemoved > 0\"\n\n # Verify the session still works after compaction\n answer = await session.send_and_wait(\"What was the story about?\")\n assert answer is not None\n assert answer.data.content is not None\n # Should remember it was about a dragon (context preserved via summary)\n assert \"dragon\" in answer.data.content.lower()\n\n async def test_should_not_emit_compaction_events_when_infinite_sessions_disabled(\n self, ctx: E2ETestContext\n ):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n infinite_sessions={\"enabled\": False},\n )\n\n compaction_events = []\n\n def on_event(event):\n if event.type in (\n SessionEventType.SESSION_COMPACTION_START,\n SessionEventType.SESSION_COMPACTION_COMPLETE,\n ):\n compaction_events.append(event)\n\n session.on(on_event)\n\n await session.send_and_wait(\"What is 2+2?\")\n\n # Should not have any compaction events when disabled\n assert len(compaction_events) == 0, \"Expected no compaction events when disabled\"\n" }, { "path": "python/e2e/test_error_resilience_e2e.py", "content": "\"\"\"E2E tests for session lifecycle error handling.\"\"\"\n\nfrom __future__ import annotations\n\nimport pytest\n\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nclass TestErrorResilience:\n async def test_should_throw_when_sending_to_disconnected_session(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n await session.disconnect()\n\n with pytest.raises(Exception):\n await session.send_and_wait(\"Hello\")\n\n async def test_should_throw_when_getting_messages_from_disconnected_session(\n self, ctx: E2ETestContext\n ):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n await session.disconnect()\n\n with pytest.raises(Exception):\n await session.get_messages()\n\n async def test_should_handle_double_abort_without_error(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n try:\n await session.abort()\n await session.abort()\n finally:\n await session.disconnect()\n\n async def test_should_throw_when_resuming_non_existent_session(self, ctx: E2ETestContext):\n with pytest.raises(Exception):\n await ctx.client.resume_session(\n \"non-existent-session-id-12345\",\n on_permission_request=PermissionHandler.approve_all,\n )\n" }, { "path": "python/e2e/test_event_fidelity_e2e.py", "content": "\"\"\"E2E tests for session event ordering and required event fields.\"\"\"\n\nfrom __future__ import annotations\n\nfrom pathlib import Path\n\nimport pytest\n\nfrom copilot.generated.session_events import (\n AssistantMessageData,\n ToolExecutionCompleteData,\n ToolExecutionStartData,\n UserMessageData,\n)\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nclass TestEventFidelity:\n async def test_should_emit_events_in_correct_order_for_tool_using_conversation(\n self, ctx: E2ETestContext\n ):\n Path(ctx.work_dir, \"hello.txt\").write_text(\"Hello World\", encoding=\"utf-8\")\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n events = []\n unsubscribe = session.on(events.append)\n try:\n await session.send_and_wait(\"Read the file 'hello.txt' and tell me its contents.\")\n\n types = [event.type.value for event in events]\n\n assert \"user.message\" in types\n assert \"assistant.message\" in types\n\n user_idx = types.index(\"user.message\")\n assistant_idx = len(types) - 1 - types[::-1].index(\"assistant.message\")\n assert user_idx < assistant_idx\n\n idle_idx = len(types) - 1 - types[::-1].index(\"session.idle\")\n assert idle_idx == len(types) - 1\n finally:\n unsubscribe()\n await session.disconnect()\n\n async def test_should_include_valid_fields_on_all_events(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n events = []\n unsubscribe = session.on(events.append)\n try:\n await session.send_and_wait(\"What is 5+5? Reply with just the number.\")\n\n for event in events:\n assert event.id is not None\n assert str(event.id)\n assert event.timestamp is not None\n\n user_event = next(\n (event for event in events if isinstance(event.data, UserMessageData)), None\n )\n assert user_event is not None\n assert user_event.data.content\n\n assistant_event = next(\n (event for event in events if isinstance(event.data, AssistantMessageData)),\n None,\n )\n assert assistant_event is not None\n assert assistant_event.data.message_id\n assert assistant_event.data.content is not None\n finally:\n unsubscribe()\n await session.disconnect()\n\n async def test_should_emit_tool_execution_events_with_correct_fields(self, ctx: E2ETestContext):\n Path(ctx.work_dir, \"data.txt\").write_text(\"test data\", encoding=\"utf-8\")\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n events = []\n unsubscribe = session.on(events.append)\n try:\n await session.send_and_wait(\"Read the file 'data.txt'.\")\n\n tool_starts = [\n event for event in events if isinstance(event.data, ToolExecutionStartData)\n ]\n tool_completes = [\n event for event in events if isinstance(event.data, ToolExecutionCompleteData)\n ]\n\n assert len(tool_starts) >= 1\n assert len(tool_completes) >= 1\n\n assert tool_starts[0].data.tool_call_id\n assert tool_starts[0].data.tool_name\n assert tool_completes[0].data.tool_call_id\n finally:\n unsubscribe()\n await session.disconnect()\n\n async def test_should_emit_assistant_message_with_messageid(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n events = []\n unsubscribe = session.on(events.append)\n try:\n await session.send_and_wait(\"Say 'pong'.\")\n\n assistant_events = [\n event for event in events if isinstance(event.data, AssistantMessageData)\n ]\n assert len(assistant_events) >= 1\n\n message = assistant_events[0]\n assert message.data.message_id\n assert \"pong\" in message.data.content\n finally:\n unsubscribe()\n await session.disconnect()\n" }, { "path": "python/e2e/test_hooks_e2e.py", "content": "\"\"\"\nTests for session hooks functionality\n\"\"\"\n\nimport os\n\nimport pytest\n\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import E2ETestContext\nfrom .testharness.helper import write_file\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nclass TestHooks:\n async def test_should_invoke_pretooluse_hook_when_model_runs_a_tool(self, ctx: E2ETestContext):\n \"\"\"Test that preToolUse hook is invoked when model runs a tool\"\"\"\n pre_tool_use_inputs = []\n\n async def on_pre_tool_use(input_data, invocation):\n pre_tool_use_inputs.append(input_data)\n assert invocation[\"session_id\"] == session.session_id\n # Allow the tool to run\n return {\"permissionDecision\": \"allow\"}\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n hooks={\"on_pre_tool_use\": on_pre_tool_use},\n )\n\n # Create a file for the model to read\n write_file(ctx.work_dir, \"hello.txt\", \"Hello from the test!\")\n\n await session.send_and_wait(\"Read the contents of hello.txt and tell me what it says\")\n\n # Should have received at least one preToolUse hook call\n assert len(pre_tool_use_inputs) > 0\n\n # Should have received the tool name\n assert any(inp.get(\"toolName\") for inp in pre_tool_use_inputs)\n\n await session.disconnect()\n\n async def test_should_invoke_posttooluse_hook_after_model_runs_a_tool(\n self, ctx: E2ETestContext\n ):\n \"\"\"Test that postToolUse hook is invoked after model runs a tool\"\"\"\n post_tool_use_inputs = []\n\n async def on_post_tool_use(input_data, invocation):\n post_tool_use_inputs.append(input_data)\n assert invocation[\"session_id\"] == session.session_id\n return None\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n hooks={\"on_post_tool_use\": on_post_tool_use},\n )\n\n # Create a file for the model to read\n write_file(ctx.work_dir, \"world.txt\", \"World from the test!\")\n\n await session.send_and_wait(\"Read the contents of world.txt and tell me what it says\")\n\n # Should have received at least one postToolUse hook call\n assert len(post_tool_use_inputs) > 0\n\n # Should have received the tool name and result\n assert any(inp.get(\"toolName\") for inp in post_tool_use_inputs)\n assert any(inp.get(\"toolResult\") is not None for inp in post_tool_use_inputs)\n\n await session.disconnect()\n\n async def test_should_invoke_both_pretooluse_and_posttooluse_hooks_for_a_single_tool_call(\n self, ctx: E2ETestContext\n ):\n \"\"\"Test that both preToolUse and postToolUse hooks fire for the same tool call\"\"\"\n pre_tool_use_inputs = []\n post_tool_use_inputs = []\n\n async def on_pre_tool_use(input_data, invocation):\n pre_tool_use_inputs.append(input_data)\n return {\"permissionDecision\": \"allow\"}\n\n async def on_post_tool_use(input_data, invocation):\n post_tool_use_inputs.append(input_data)\n return None\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n hooks={\n \"on_pre_tool_use\": on_pre_tool_use,\n \"on_post_tool_use\": on_post_tool_use,\n },\n )\n\n write_file(ctx.work_dir, \"both.txt\", \"Testing both hooks!\")\n\n await session.send_and_wait(\"Read the contents of both.txt\")\n\n # Both hooks should have been called\n assert len(pre_tool_use_inputs) > 0\n assert len(post_tool_use_inputs) > 0\n\n # The same tool should appear in both\n pre_tool_names = [inp.get(\"toolName\") for inp in pre_tool_use_inputs]\n post_tool_names = [inp.get(\"toolName\") for inp in post_tool_use_inputs]\n common_tool = next((name for name in pre_tool_names if name in post_tool_names), None)\n assert common_tool is not None\n\n await session.disconnect()\n\n async def test_should_deny_tool_execution_when_pretooluse_returns_deny(\n self, ctx: E2ETestContext\n ):\n \"\"\"Test that returning deny in preToolUse prevents tool execution\"\"\"\n pre_tool_use_inputs = []\n\n async def on_pre_tool_use(input_data, invocation):\n pre_tool_use_inputs.append(input_data)\n # Deny all tool calls\n return {\"permissionDecision\": \"deny\"}\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n hooks={\"on_pre_tool_use\": on_pre_tool_use},\n )\n\n # Create a file\n original_content = \"Original content that should not be modified\"\n write_file(ctx.work_dir, \"protected.txt\", original_content)\n\n response = await session.send_and_wait(\n \"Edit protected.txt and replace 'Original' with 'Modified'\"\n )\n\n # The hook should have been called\n assert len(pre_tool_use_inputs) > 0\n\n # The response should indicate the tool was denied (behavior may vary)\n # At minimum, we verify the hook was invoked\n assert response is not None\n\n # Strengthen: verify the actual deny behavior — the protected file was NOT\n # modified by the runtime even though the LLM tried to edit it. The\n # pre-tool-use hook denial blocks tool execution before it can mutate state.\n with open(os.path.join(ctx.work_dir, \"protected.txt\")) as f:\n actual_content = f.read()\n assert actual_content == original_content, (\n f\"protected.txt should be unchanged after deny; got: {actual_content!r}\"\n )\n\n await session.disconnect()\n" }, { "path": "python/e2e/test_hooks_extended_e2e.py", "content": "\"\"\"\nExtended hook lifecycle tests that mirror dotnet/test/HookLifecycleAndOutputTests.cs.\n\nE2E coverage for every handler exposed on ``SessionHooks``:\n``on_pre_tool_use``, ``on_post_tool_use``, ``on_user_prompt_submitted``,\n``on_session_start``, ``on_session_end``, ``on_error_occurred``. Output-shape\nbehavior (modifiedPrompt / additionalContext / errorHandling / modifiedArgs /\nmodifiedResult / sessionSummary) is asserted alongside hook invocation.\n\"\"\"\n\nfrom __future__ import annotations\n\nimport asyncio\n\nimport pytest\n\nfrom copilot.session import PermissionHandler\nfrom copilot.tools import Tool, ToolInvocation, ToolResult\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nclass TestHooksExtended:\n async def test_should_invoke_userpromptsubmitted_hook_and_modify_prompt(\n self, ctx: E2ETestContext\n ):\n inputs: list[dict] = []\n\n async def on_user_prompt_submitted(input_data, invocation):\n inputs.append(input_data)\n assert invocation[\"session_id\"]\n return {\"modifiedPrompt\": \"Reply with exactly: HOOKED_PROMPT\"}\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n hooks={\"on_user_prompt_submitted\": on_user_prompt_submitted},\n )\n try:\n response = await session.send_and_wait(\"Say something else\")\n assert inputs\n assert \"Say something else\" in inputs[0].get(\"prompt\", \"\")\n assert \"HOOKED_PROMPT\" in (response.data.content or \"\")\n finally:\n await session.disconnect()\n\n async def test_should_invoke_sessionstart_hook(self, ctx: E2ETestContext):\n inputs: list[dict] = []\n\n async def on_session_start(input_data, invocation):\n inputs.append(input_data)\n assert invocation[\"session_id\"]\n return {\"additionalContext\": \"Session start hook context.\"}\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n hooks={\"on_session_start\": on_session_start},\n )\n try:\n await session.send_and_wait(\"Say hi\")\n assert inputs\n assert inputs[0].get(\"source\") == \"new\"\n assert inputs[0].get(\"cwd\")\n finally:\n await session.disconnect()\n\n async def test_should_invoke_sessionend_hook(self, ctx: E2ETestContext):\n inputs: list[dict] = []\n hook_invoked: asyncio.Future = asyncio.get_event_loop().create_future()\n\n async def on_session_end(input_data, invocation):\n inputs.append(input_data)\n if not hook_invoked.done():\n hook_invoked.set_result(input_data)\n assert invocation[\"session_id\"]\n return {\"sessionSummary\": \"session ended\"}\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n hooks={\"on_session_end\": on_session_end},\n )\n await session.send_and_wait(\"Say bye\")\n await session.disconnect()\n await asyncio.wait_for(hook_invoked, 10.0)\n assert inputs\n\n async def test_should_register_erroroccurred_hook(self, ctx: E2ETestContext):\n inputs: list[dict] = []\n\n async def on_error_occurred(input_data, invocation):\n inputs.append(input_data)\n assert invocation[\"session_id\"]\n return {\"errorHandling\": \"skip\"}\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n hooks={\"on_error_occurred\": on_error_occurred},\n )\n try:\n await session.send_and_wait(\"Say hi\")\n # Registration-only test: a healthy turn shouldn't fire OnErrorOccurred.\n assert not inputs\n assert session.session_id\n finally:\n await session.disconnect()\n\n async def test_should_allow_pretooluse_to_return_modifiedargs_and_suppressoutput(\n self, ctx: E2ETestContext\n ):\n inputs: list[dict] = []\n\n def echo_value(invocation: ToolInvocation) -> ToolResult:\n args = invocation.arguments or {}\n return ToolResult(text_result_for_llm=str(args.get(\"value\", \"\")))\n\n async def on_pre_tool_use(input_data, invocation):\n inputs.append(input_data)\n if input_data.get(\"toolName\") != \"echo_value\":\n return {\"permissionDecision\": \"allow\"}\n return {\n \"permissionDecision\": \"allow\",\n \"modifiedArgs\": {\"value\": \"modified by hook\"},\n \"suppressOutput\": False,\n }\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n tools=[\n Tool(\n name=\"echo_value\",\n description=\"Echoes the supplied value\",\n parameters={\n \"type\": \"object\",\n \"properties\": {\n \"value\": {\n \"type\": \"string\",\n \"description\": \"Value to echo\",\n }\n },\n \"required\": [\"value\"],\n },\n handler=echo_value,\n )\n ],\n hooks={\"on_pre_tool_use\": on_pre_tool_use},\n )\n try:\n response = await session.send_and_wait(\n \"Call echo_value with value 'original', then reply with the result.\"\n )\n assert inputs\n assert any(inp.get(\"toolName\") == \"echo_value\" for inp in inputs)\n assert \"modified by hook\" in (response.data.content or \"\")\n finally:\n await session.disconnect()\n\n async def test_should_allow_posttooluse_to_return_modifiedresult(self, ctx: E2ETestContext):\n inputs: list[dict] = []\n\n async def on_post_tool_use(input_data, invocation):\n inputs.append(input_data)\n if input_data.get(\"toolName\") != \"report_intent\":\n return None\n return {\n \"modifiedResult\": \"modified by post hook\",\n \"suppressOutput\": False,\n }\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n available_tools=[\"report_intent\"],\n hooks={\"on_post_tool_use\": on_post_tool_use},\n )\n try:\n response = await session.send_and_wait(\n \"Call the report_intent tool with intent 'Testing post hook', then reply done.\"\n )\n assert any(inp.get(\"toolName\") == \"report_intent\" for inp in inputs)\n assert (response.data.content or \"\").strip().rstrip(\".\") in {\"Done\", \"done\"}\n finally:\n await session.disconnect()\n" }, { "path": "python/e2e/test_mcp_and_agents_e2e.py", "content": "\"\"\"\nTests for MCP servers and custom agents functionality\n\"\"\"\n\nfrom pathlib import Path\n\nimport pytest\n\nfrom copilot.session import CustomAgentConfig, MCPServerConfig, PermissionHandler\n\nfrom .testharness import E2ETestContext, get_final_assistant_message\n\nTEST_MCP_SERVER = str(\n (Path(__file__).parents[2] / \"test\" / \"harness\" / \"test-mcp-server.mjs\").resolve()\n)\nTEST_HARNESS_DIR = str((Path(__file__).parents[2] / \"test\" / \"harness\").resolve())\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nclass TestMCPServers:\n async def test_should_accept_mcp_server_configuration_on_session_create(\n self, ctx: E2ETestContext\n ):\n \"\"\"Test that MCP server configuration is accepted on session create\"\"\"\n mcp_servers: dict[str, MCPServerConfig] = {\n \"test-server\": {\n \"command\": \"echo\",\n \"args\": [\"hello\"],\n \"tools\": [\"*\"],\n }\n }\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all, mcp_servers=mcp_servers\n )\n\n assert session.session_id is not None\n\n # Simple interaction to verify session works\n message = await session.send_and_wait(\"What is 2+2?\")\n assert message is not None\n assert \"4\" in message.data.content\n\n await session.disconnect()\n\n async def test_should_accept_mcp_server_configuration_on_session_resume(\n self, ctx: E2ETestContext\n ):\n \"\"\"Test that MCP server configuration is accepted on session resume\"\"\"\n # Create a session first\n session1 = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n session_id = session1.session_id\n await session1.send_and_wait(\"What is 1+1?\")\n\n # Resume with MCP servers\n mcp_servers: dict[str, MCPServerConfig] = {\n \"test-server\": {\n \"command\": \"echo\",\n \"args\": [\"hello\"],\n \"tools\": [\"*\"],\n }\n }\n\n session2 = await ctx.client.resume_session(\n session_id,\n on_permission_request=PermissionHandler.approve_all,\n mcp_servers=mcp_servers,\n )\n\n assert session2.session_id == session_id\n\n message = await session2.send_and_wait(\"What is 3+3?\")\n assert message is not None\n assert \"6\" in message.data.content\n\n await session2.disconnect()\n\n async def test_should_pass_literal_env_values_to_mcp_server_subprocess(\n self, ctx: E2ETestContext\n ):\n \"\"\"Test that env values are passed as literals to MCP server subprocess\"\"\"\n mcp_servers: dict[str, MCPServerConfig] = {\n \"env-echo\": {\n \"command\": \"node\",\n \"args\": [TEST_MCP_SERVER],\n \"tools\": [\"*\"],\n \"env\": {\"TEST_SECRET\": \"hunter2\"},\n \"cwd\": TEST_HARNESS_DIR,\n }\n }\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all, mcp_servers=mcp_servers\n )\n\n assert session.session_id is not None\n\n message = await session.send_and_wait(\n \"Use the env-echo/get_env tool to read the TEST_SECRET \"\n \"environment variable. Reply with just the value, nothing else.\"\n )\n assert message is not None\n assert \"hunter2\" in message.data.content\n\n await session.disconnect()\n\n\nclass TestCustomAgents:\n async def test_should_accept_custom_agent_configuration_on_session_create(\n self, ctx: E2ETestContext\n ):\n \"\"\"Test that custom agent configuration is accepted on session create\"\"\"\n custom_agents: list[CustomAgentConfig] = [\n {\n \"name\": \"test-agent\",\n \"display_name\": \"Test Agent\",\n \"description\": \"A test agent for SDK testing\",\n \"prompt\": \"You are a helpful test agent.\",\n \"infer\": True,\n }\n ]\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all, custom_agents=custom_agents\n )\n\n assert session.session_id is not None\n\n # Simple interaction to verify session works\n message = await session.send_and_wait(\"What is 5+5?\")\n assert message is not None\n assert \"10\" in message.data.content\n\n await session.disconnect()\n\n async def test_should_accept_custom_agent_configuration_on_session_resume(\n self, ctx: E2ETestContext\n ):\n \"\"\"Test that custom agent configuration is accepted on session resume\"\"\"\n # Create a session first\n session1 = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n session_id = session1.session_id\n await session1.send_and_wait(\"What is 1+1?\")\n\n # Resume with custom agents\n custom_agents: list[CustomAgentConfig] = [\n {\n \"name\": \"resume-agent\",\n \"display_name\": \"Resume Agent\",\n \"description\": \"An agent added on resume\",\n \"prompt\": \"You are a resume test agent.\",\n }\n ]\n\n session2 = await ctx.client.resume_session(\n session_id,\n on_permission_request=PermissionHandler.approve_all,\n custom_agents=custom_agents,\n )\n\n assert session2.session_id == session_id\n\n message = await session2.send_and_wait(\"What is 6+6?\")\n assert message is not None\n assert \"12\" in message.data.content\n\n await session2.disconnect()\n\n async def test_should_handle_multiple_mcp_servers(self, ctx: E2ETestContext):\n \"\"\"Multiple MCP servers can be configured at once.\"\"\"\n mcp_servers: dict[str, MCPServerConfig] = {\n \"server1\": {\"command\": \"echo\", \"args\": [\"server1\"], \"tools\": [\"*\"]},\n \"server2\": {\"command\": \"echo\", \"args\": [\"server2\"], \"tools\": [\"*\"]},\n }\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n mcp_servers=mcp_servers,\n )\n try:\n assert session.session_id is not None\n import re\n\n assert re.match(r\"^[a-f0-9-]+$\", session.session_id)\n finally:\n await session.disconnect()\n\n\nclass TestCombinedConfiguration:\n async def test_should_accept_both_mcp_servers_and_custom_agents(self, ctx: E2ETestContext):\n \"\"\"Test that both MCP servers and custom agents can be configured together\"\"\"\n mcp_servers: dict[str, MCPServerConfig] = {\n \"shared-server\": {\n \"command\": \"echo\",\n \"args\": [\"shared\"],\n \"tools\": [\"*\"],\n }\n }\n\n custom_agents: list[CustomAgentConfig] = [\n {\n \"name\": \"combined-agent\",\n \"display_name\": \"Combined Agent\",\n \"description\": \"An agent using shared MCP servers\",\n \"prompt\": \"You are a combined test agent.\",\n }\n ]\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n mcp_servers=mcp_servers,\n custom_agents=custom_agents,\n )\n\n assert session.session_id is not None\n\n await session.send(\"What is 7+7?\")\n message = await get_final_assistant_message(session)\n assert \"14\" in message.data.content\n\n await session.disconnect()\n\n async def test_should_handle_custom_agent_with_tools_configuration(self, ctx: E2ETestContext):\n \"\"\"A custom agent can advertise specific tools.\"\"\"\n custom_agents: list[CustomAgentConfig] = [\n {\n \"name\": \"tool-agent\",\n \"display_name\": \"Tool Agent\",\n \"description\": \"An agent with specific tools\",\n \"prompt\": \"You are an agent with specific tools.\",\n \"tools\": [\"bash\", \"edit\"],\n \"infer\": True,\n }\n ]\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n custom_agents=custom_agents,\n )\n try:\n import re\n\n assert session.session_id is not None\n assert re.match(r\"^[a-f0-9-]+$\", session.session_id)\n finally:\n await session.disconnect()\n\n async def test_should_handle_custom_agent_with_mcp_servers(self, ctx: E2ETestContext):\n \"\"\"A custom agent can declare its own MCP servers.\"\"\"\n custom_agents: list[CustomAgentConfig] = [\n {\n \"name\": \"mcp-agent\",\n \"display_name\": \"MCP Agent\",\n \"description\": \"An agent with its own MCP servers\",\n \"prompt\": \"You are an agent with MCP servers.\",\n \"mcp_servers\": {\n \"agent-server\": {\n \"command\": \"echo\",\n \"args\": [\"agent-mcp\"],\n \"tools\": [\"*\"],\n }\n },\n }\n ]\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n custom_agents=custom_agents,\n )\n try:\n import re\n\n assert session.session_id is not None\n assert re.match(r\"^[a-f0-9-]+$\", session.session_id)\n finally:\n await session.disconnect()\n\n async def test_should_handle_multiple_custom_agents(self, ctx: E2ETestContext):\n \"\"\"Multiple custom agents can be configured at once.\"\"\"\n custom_agents: list[CustomAgentConfig] = [\n {\n \"name\": \"agent1\",\n \"display_name\": \"Agent One\",\n \"description\": \"First agent\",\n \"prompt\": \"You are agent one.\",\n },\n {\n \"name\": \"agent2\",\n \"display_name\": \"Agent Two\",\n \"description\": \"Second agent\",\n \"prompt\": \"You are agent two.\",\n \"infer\": False,\n },\n ]\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n custom_agents=custom_agents,\n )\n try:\n import re\n\n assert session.session_id is not None\n assert re.match(r\"^[a-f0-9-]+$\", session.session_id)\n finally:\n await session.disconnect()\n" }, { "path": "python/e2e/test_multi_client_e2e.py", "content": "\"\"\"E2E Multi-Client Broadcast Tests\n\nTests that verify the protocol v3 broadcast model works correctly when\nmultiple clients are connected to the same CLI server session.\n\"\"\"\n\nimport asyncio\nimport contextlib\nimport os\nimport shutil\nimport tempfile\n\nimport pytest\nimport pytest_asyncio\nfrom pydantic import BaseModel, Field\n\nfrom copilot import CopilotClient, define_tool\nfrom copilot.client import ExternalServerConfig, SubprocessConfig\nfrom copilot.session import PermissionHandler, PermissionRequestResult\nfrom copilot.tools import ToolInvocation\n\nfrom .testharness import get_final_assistant_message\nfrom .testharness.proxy import CapiProxy\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nclass MultiClientContext:\n \"\"\"Extended test context that manages two clients connected to the same CLI server.\"\"\"\n\n def __init__(self):\n self.cli_path: str = \"\"\n self.home_dir: str = \"\"\n self.work_dir: str = \"\"\n self.proxy_url: str = \"\"\n self._proxy: CapiProxy | None = None\n self._client1: CopilotClient | None = None\n self._client2: CopilotClient | None = None\n\n async def setup(self):\n from .testharness.context import get_cli_path_for_tests\n\n self.cli_path = get_cli_path_for_tests()\n self.home_dir = os.path.realpath(tempfile.mkdtemp(prefix=\"copilot-multi-config-\"))\n self.work_dir = os.path.realpath(tempfile.mkdtemp(prefix=\"copilot-multi-work-\"))\n\n self._proxy = CapiProxy()\n self.proxy_url = await self._proxy.start()\n\n github_token = (\n \"fake-token-for-e2e-tests\" if os.environ.get(\"GITHUB_ACTIONS\") == \"true\" else None\n )\n\n # Client 1 uses TCP mode so a second client can connect to the same server\n self._client1 = CopilotClient(\n SubprocessConfig(\n cli_path=self.cli_path,\n cwd=self.work_dir,\n env=self.get_env(),\n use_stdio=False,\n github_token=github_token,\n )\n )\n\n # Trigger connection by creating and disconnecting an init session\n init_session = await self._client1.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n await init_session.disconnect()\n\n # Read the actual port from client 1 and create client 2\n actual_port = self._client1.actual_port\n assert actual_port is not None, \"Client 1 should have an actual port after connecting\"\n\n self._client2 = CopilotClient(ExternalServerConfig(url=f\"localhost:{actual_port}\"))\n\n async def teardown(self, test_failed: bool = False):\n if self._client2:\n try:\n await self._client2.stop()\n except Exception:\n pass\n self._client2 = None\n\n if self._client1:\n try:\n await self._client1.stop()\n except Exception:\n pass\n self._client1 = None\n\n if self._proxy:\n await self._proxy.stop(skip_writing_cache=test_failed)\n self._proxy = None\n\n if self.home_dir and os.path.exists(self.home_dir):\n shutil.rmtree(self.home_dir, ignore_errors=True)\n if self.work_dir and os.path.exists(self.work_dir):\n shutil.rmtree(self.work_dir, ignore_errors=True)\n\n async def configure_for_test(self, test_file: str, test_name: str):\n import re\n\n sanitized_name = re.sub(r\"[^a-zA-Z0-9]\", \"_\", test_name).lower()\n # Use the same snapshot directory structure as the standard context\n from .testharness.context import SNAPSHOTS_DIR\n\n snapshot_path = SNAPSHOTS_DIR / test_file / f\"{sanitized_name}.yaml\"\n abs_snapshot_path = str(snapshot_path.resolve())\n\n if self._proxy:\n await self._proxy.configure(abs_snapshot_path, self.work_dir)\n\n # Clear temp directories between tests; tolerate Windows holding the\n # SQLite session-store.db open briefly after the CLI subprocess exits.\n from pathlib import Path\n\n for base_dir in (self.home_dir, self.work_dir):\n for item in Path(base_dir).iterdir():\n if item.is_dir():\n shutil.rmtree(item, ignore_errors=True)\n else:\n with contextlib.suppress(OSError):\n item.unlink(missing_ok=True)\n\n def get_env(self) -> dict:\n env = os.environ.copy()\n env.update(\n {\n \"COPILOT_API_URL\": self.proxy_url,\n \"COPILOT_HOME\": self.home_dir,\n \"XDG_CONFIG_HOME\": self.home_dir,\n \"XDG_STATE_HOME\": self.home_dir,\n }\n )\n return env\n\n @property\n def client1(self) -> CopilotClient:\n if not self._client1:\n raise RuntimeError(\"Context not set up\")\n return self._client1\n\n @property\n def client2(self) -> CopilotClient:\n if not self._client2:\n raise RuntimeError(\"Context not set up\")\n return self._client2\n\n\n@pytest.hookimpl(tryfirst=True, hookwrapper=True)\ndef pytest_runtest_makereport(item, call):\n outcome = yield\n rep = outcome.get_result()\n if rep.when == \"call\" and rep.failed:\n item.session.stash.setdefault(\"any_test_failed\", False)\n item.session.stash[\"any_test_failed\"] = True\n\n\n@pytest_asyncio.fixture(scope=\"module\", loop_scope=\"module\")\nasync def mctx(request):\n \"\"\"Multi-client test context fixture.\"\"\"\n context = MultiClientContext()\n await context.setup()\n yield context\n any_failed = request.session.stash.get(\"any_test_failed\", False)\n await context.teardown(test_failed=any_failed)\n\n\n@pytest_asyncio.fixture(autouse=True, loop_scope=\"module\")\nasync def configure_multi_test(request, mctx):\n \"\"\"Automatically configure the proxy for each test.\"\"\"\n module_name = request.module.__name__.split(\".\")[-1]\n test_file = module_name[5:] if module_name.startswith(\"test_\") else module_name\n if test_file.endswith(\"_e2e\"):\n test_file = test_file[:-4] # Snapshot-folder compatibility with pre-rename layout\n test_name = request.node.name\n if test_name.startswith(\"test_\"):\n test_name = test_name[5:]\n await mctx.configure_for_test(test_file, test_name)\n yield\n\n\nclass TestMultiClientBroadcast:\n async def test_both_clients_see_tool_request_and_completion_events(\n self, mctx: MultiClientContext\n ):\n \"\"\"Both clients see tool request and completion events.\"\"\"\n\n class SeedParams(BaseModel):\n seed: str = Field(description=\"A seed value\")\n\n @define_tool(\"magic_number\", description=\"Returns a magic number\")\n def magic_number(params: SeedParams, invocation: ToolInvocation) -> str:\n return f\"MAGIC_{params.seed}_42\"\n\n # Client 1 creates a session with a custom tool\n session1 = await mctx.client1.create_session(\n on_permission_request=PermissionHandler.approve_all, tools=[magic_number]\n )\n\n # Client 2 resumes with NO tools — should not overwrite client 1's tools\n session2 = await mctx.client2.resume_session(\n session1.session_id, on_permission_request=PermissionHandler.approve_all\n )\n client1_events = []\n client2_events = []\n session1.on(lambda event: client1_events.append(event))\n session2.on(lambda event: client2_events.append(event))\n\n # Send a prompt that triggers the custom tool\n await session1.send(\"Use the magic_number tool with seed 'hello' and tell me the result\")\n response = await get_final_assistant_message(session1)\n assert \"MAGIC_hello_42\" in (response.data.content or \"\")\n\n # Both clients should have seen the external_tool.requested event\n c1_tool_requested = [e for e in client1_events if e.type.value == \"external_tool.requested\"]\n c2_tool_requested = [e for e in client2_events if e.type.value == \"external_tool.requested\"]\n assert len(c1_tool_requested) > 0\n assert len(c2_tool_requested) > 0\n\n # Both clients should have seen the external_tool.completed event\n c1_tool_completed = [e for e in client1_events if e.type.value == \"external_tool.completed\"]\n c2_tool_completed = [e for e in client2_events if e.type.value == \"external_tool.completed\"]\n assert len(c1_tool_completed) > 0\n assert len(c2_tool_completed) > 0\n\n await session2.disconnect()\n\n async def test_one_client_approves_permission_and_both_see_the_result(\n self, mctx: MultiClientContext\n ):\n \"\"\"One client approves a permission request and both see the result.\"\"\"\n permission_requests = []\n\n # Client 1 creates a session and manually approves permission requests\n session1 = await mctx.client1.create_session(\n on_permission_request=lambda request, invocation: (\n permission_requests.append(request) or PermissionRequestResult(kind=\"approve-once\")\n ),\n )\n\n # Client 2 resumes — its handler never resolves, so only client 1's approval takes effect\n session2 = await mctx.client2.resume_session(\n session1.session_id,\n on_permission_request=lambda request, invocation: asyncio.Future(),\n )\n\n client1_events = []\n client2_events = []\n session1.on(lambda event: client1_events.append(event))\n session2.on(lambda event: client2_events.append(event))\n\n # Send a prompt that triggers a write operation (requires permission)\n await session1.send(\"Create a file called hello.txt containing the text 'hello world'\")\n response = await get_final_assistant_message(session1)\n assert response.data.content\n\n # Client 1 should have handled permission requests\n assert len(permission_requests) > 0\n\n # Both clients should have seen permission.requested events\n c1_perm_requested = [e for e in client1_events if e.type.value == \"permission.requested\"]\n c2_perm_requested = [e for e in client2_events if e.type.value == \"permission.requested\"]\n assert len(c1_perm_requested) > 0\n assert len(c2_perm_requested) > 0\n\n # Both clients should have seen permission.completed events with approved result\n c1_perm_completed = [e for e in client1_events if e.type.value == \"permission.completed\"]\n c2_perm_completed = [e for e in client2_events if e.type.value == \"permission.completed\"]\n assert len(c1_perm_completed) > 0\n assert len(c2_perm_completed) > 0\n for event in c1_perm_completed + c2_perm_completed:\n assert event.data.result.kind.value == \"approved\"\n\n await session2.disconnect()\n\n async def test_one_client_rejects_permission_and_both_see_the_result(\n self, mctx: MultiClientContext\n ):\n \"\"\"One client rejects a permission request and both see the result.\"\"\"\n # Client 1 creates a session and denies all permission requests\n session1 = await mctx.client1.create_session(\n on_permission_request=lambda request, invocation: PermissionRequestResult(\n kind=\"reject\"\n ),\n )\n\n # Client 2 resumes — its handler never resolves\n session2 = await mctx.client2.resume_session(\n session1.session_id,\n on_permission_request=lambda request, invocation: asyncio.Future(),\n )\n\n client1_events = []\n client2_events = []\n session1.on(lambda event: client1_events.append(event))\n session2.on(lambda event: client2_events.append(event))\n\n # Create a file that the agent will try to edit\n test_file = os.path.join(mctx.work_dir, \"protected.txt\")\n with open(test_file, \"w\") as f:\n f.write(\"protected content\")\n\n await session1.send(\"Edit protected.txt and replace 'protected' with 'hacked'.\")\n await get_final_assistant_message(session1)\n\n # Verify the file was NOT modified (permission was denied)\n with open(test_file) as f:\n content = f.read()\n assert content == \"protected content\"\n\n # Both clients should have seen permission.requested and permission.completed\n c1_perm_requested = [e for e in client1_events if e.type.value == \"permission.requested\"]\n c2_perm_requested = [e for e in client2_events if e.type.value == \"permission.requested\"]\n assert len(c1_perm_requested) > 0\n assert len(c2_perm_requested) > 0\n\n # Both clients should see the denial\n c1_perm_completed = [e for e in client1_events if e.type.value == \"permission.completed\"]\n c2_perm_completed = [e for e in client2_events if e.type.value == \"permission.completed\"]\n assert len(c1_perm_completed) > 0\n assert len(c2_perm_completed) > 0\n for event in c1_perm_completed + c2_perm_completed:\n assert event.data.result.kind.value == \"denied-interactively-by-user\"\n\n await session2.disconnect()\n\n @pytest.mark.timeout(90)\n async def test_two_clients_register_different_tools_and_agent_uses_both(\n self, mctx: MultiClientContext\n ):\n \"\"\"Two clients register different tools and agent uses both.\"\"\"\n\n class CountryCodeParams(BaseModel):\n model_config = {\"populate_by_name\": True}\n country_code: str = Field(alias=\"countryCode\", description=\"A two-letter country code\")\n\n @define_tool(\"city_lookup\", description=\"Returns a city name for a given country code\")\n def city_lookup(params: CountryCodeParams, invocation: ToolInvocation) -> str:\n return f\"CITY_FOR_{params.country_code}\"\n\n @define_tool(\"currency_lookup\", description=\"Returns a currency for a given country code\")\n def currency_lookup(params: CountryCodeParams, invocation: ToolInvocation) -> str:\n return f\"CURRENCY_FOR_{params.country_code}\"\n\n # Client 1 creates a session with tool A\n session1 = await mctx.client1.create_session(\n on_permission_request=PermissionHandler.approve_all, tools=[city_lookup]\n )\n\n # Client 2 resumes with tool B (different tool, union should have both)\n session2 = await mctx.client2.resume_session(\n session1.session_id,\n on_permission_request=PermissionHandler.approve_all,\n tools=[currency_lookup],\n )\n\n # Send prompts sequentially to avoid nondeterministic tool_call ordering\n await session1.send(\n \"Use the city_lookup tool with countryCode 'US' and tell me the result.\"\n )\n response1 = await get_final_assistant_message(session1)\n assert \"CITY_FOR_US\" in (response1.data.content or \"\")\n\n await session1.send(\n \"Now use the currency_lookup tool with countryCode 'US' and tell me the result.\"\n )\n response2 = await get_final_assistant_message(session1)\n assert \"CURRENCY_FOR_US\" in (response2.data.content or \"\")\n\n await session2.disconnect()\n\n @pytest.mark.timeout(90)\n @pytest.mark.skip(\n reason=\"Flaky on CI: Python TCP socket close detection is too slow for snapshot replay\"\n )\n async def test_disconnecting_client_removes_its_tools(self, mctx: MultiClientContext):\n \"\"\"Disconnecting a client removes its tools from the session.\"\"\"\n\n class InputParams(BaseModel):\n input: str = Field(description=\"Input value\")\n\n @define_tool(\"stable_tool\", description=\"A tool that persists across disconnects\")\n def stable_tool(params: InputParams, invocation: ToolInvocation) -> str:\n return f\"STABLE_{params.input}\"\n\n @define_tool(\n \"ephemeral_tool\",\n description=\"A tool that will disappear when its client disconnects\",\n )\n def ephemeral_tool(params: InputParams, invocation: ToolInvocation) -> str:\n return f\"EPHEMERAL_{params.input}\"\n\n # Client 1 creates a session with stable_tool\n session1 = await mctx.client1.create_session(\n on_permission_request=PermissionHandler.approve_all, tools=[stable_tool]\n )\n\n # Client 2 resumes with ephemeral_tool\n await mctx.client2.resume_session(\n session1.session_id,\n on_permission_request=PermissionHandler.approve_all,\n tools=[ephemeral_tool],\n )\n\n # Verify both tools work before disconnect.\n # Sequential prompts avoid nondeterministic tool_call ordering.\n await session1.send(\"Use the stable_tool with input 'test1' and tell me the result.\")\n stable_response = await get_final_assistant_message(session1)\n assert \"STABLE_test1\" in (stable_response.data.content or \"\")\n\n await session1.send(\"Use the ephemeral_tool with input 'test2' and tell me the result.\")\n ephemeral_response = await get_final_assistant_message(session1)\n assert \"EPHEMERAL_test2\" in (ephemeral_response.data.content or \"\")\n\n # Force disconnect client 2 without destroying the shared session\n await mctx.client2.force_stop()\n\n # Give the server time to process the connection close and remove tools\n await asyncio.sleep(0.5)\n\n # Recreate client2 for future tests (but don't rejoin the session)\n actual_port = mctx.client1.actual_port\n mctx._client2 = CopilotClient(ExternalServerConfig(url=f\"localhost:{actual_port}\"))\n\n # Now only stable_tool should be available\n await session1.send(\n \"Use the stable_tool with input 'still_here'.\"\n \" Also try using ephemeral_tool\"\n \" if it is available.\"\n )\n after_response = await get_final_assistant_message(session1)\n assert \"STABLE_still_here\" in (after_response.data.content or \"\")\n # ephemeral_tool should NOT have produced a result\n assert \"EPHEMERAL_\" not in (after_response.data.content or \"\")\n" }, { "path": "python/e2e/test_multi_turn_e2e.py", "content": "\"\"\"E2E tests for multi-turn tool-result continuity.\"\"\"\n\nfrom __future__ import annotations\n\nfrom pathlib import Path\n\nimport pytest\n\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nclass TestMultiTurn:\n async def test_should_use_tool_results_from_previous_turns(self, ctx: E2ETestContext):\n Path(ctx.work_dir, \"secret.txt\").write_text(\"The magic number is 42.\", encoding=\"utf-8\")\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n try:\n first_message = await session.send_and_wait(\n \"Read the file 'secret.txt' and tell me what the magic number is.\"\n )\n assert first_message is not None\n assert \"42\" in first_message.data.content\n\n second_message = await session.send_and_wait(\n \"What is that magic number multiplied by 2?\"\n )\n assert second_message is not None\n assert \"84\" in second_message.data.content\n finally:\n await session.disconnect()\n\n async def test_should_handle_file_creation_then_reading_across_turns(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n try:\n await session.send_and_wait(\n \"Create a file called 'greeting.txt' with the content 'Hello from multi-turn test'.\"\n )\n\n message = await session.send_and_wait(\n \"Read the file 'greeting.txt' and tell me its exact contents.\"\n )\n assert message is not None\n assert \"Hello from multi-turn test\" in message.data.content\n finally:\n await session.disconnect()\n" }, { "path": "python/e2e/test_pending_work_resume_e2e.py", "content": "\"\"\"\nE2E coverage for the ``continue_pending_work`` resume flow.\n\nMirrors ``dotnet/test/PendingWorkResumeTests.cs``: starts a session that gets\nsuspended mid-turn (with a pending permission request, a pending external tool\nrequest, or parallel pending external tools), then resumes it on a new client\nwith ``continue_pending_work=True`` and confirms the runtime hands the new\nclient the original work to satisfy.\n\"\"\"\n\nfrom __future__ import annotations\n\nimport asyncio\nimport os\nfrom typing import Any\n\nimport pytest\n\nfrom copilot import CopilotClient\nfrom copilot.client import ExternalServerConfig, SubprocessConfig\nfrom copilot.generated.rpc import HandlePendingToolCallRequest, PermissionDecisionRequest\nfrom copilot.session import PermissionHandler, PermissionRequestResult\nfrom copilot.tools import Tool, ToolInvocation, ToolResult\n\nfrom .testharness import E2ETestContext, get_final_assistant_message\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\nPENDING_WORK_TIMEOUT = 60.0\n\n\ndef _make_subprocess_client(ctx: E2ETestContext, *, use_stdio: bool = True) -> CopilotClient:\n github_token = (\n \"fake-token-for-e2e-tests\" if os.environ.get(\"GITHUB_ACTIONS\") == \"true\" else None\n )\n return CopilotClient(\n SubprocessConfig(\n cli_path=ctx.cli_path,\n cwd=ctx.work_dir,\n env=ctx.get_env(),\n github_token=github_token,\n use_stdio=use_stdio,\n )\n )\n\n\ndef _make_pending_tool(name: str, handler) -> Tool:\n \"\"\"Wrap an args-style handler ``handler(dict) -> str | Awaitable[str]`` as a Tool.\"\"\"\n\n async def wrapped(invocation: ToolInvocation) -> ToolResult:\n args = invocation.arguments or {}\n result = handler(args)\n if asyncio.iscoroutine(result):\n result = await result\n return ToolResult(text_result_for_llm=str(result))\n\n return Tool(\n name=name,\n description=\"Looks up a value after resumption\",\n parameters={\n \"type\": \"object\",\n \"properties\": {\n \"value\": {\n \"type\": \"string\",\n \"description\": \"Value to look up\",\n }\n },\n \"required\": [\"value\"],\n },\n handler=wrapped,\n )\n\n\nasync def _wait_for_external_tool_requests(\n session, tool_names: list[str], timeout: float = PENDING_WORK_TIMEOUT\n) -> dict[str, Any]:\n \"\"\"Wait for ExternalToolRequested events for the named tools.\"\"\"\n expected = set(tool_names)\n seen: dict[str, Any] = {}\n completed: asyncio.Future = asyncio.get_event_loop().create_future()\n\n def on_event(event):\n if completed.done():\n return\n if event.type.value == \"external_tool.requested\":\n tool_name = event.data.tool_name\n if tool_name in expected and tool_name not in seen:\n seen[tool_name] = event\n if len(seen) == len(expected):\n completed.set_result(dict(seen))\n elif event.type.value == \"session.error\":\n msg = event.data.message or \"session error\"\n completed.set_exception(RuntimeError(msg))\n\n unsubscribe = session.on(on_event)\n try:\n return await asyncio.wait_for(completed, timeout=timeout)\n finally:\n unsubscribe()\n\n\nasync def _wait_for_permission_request(session, timeout: float = PENDING_WORK_TIMEOUT) -> Any:\n completed: asyncio.Future = asyncio.get_event_loop().create_future()\n\n def on_event(event):\n if completed.done():\n return\n if event.type.value == \"permission.requested\":\n completed.set_result(event)\n elif event.type.value == \"session.error\":\n msg = event.data.message or \"session error\"\n completed.set_exception(RuntimeError(msg))\n\n unsubscribe = session.on(on_event)\n try:\n return await asyncio.wait_for(completed, timeout=timeout)\n finally:\n unsubscribe()\n\n\nasync def _safe_force_stop(client: CopilotClient) -> None:\n try:\n await client.stop()\n except Exception:\n await client.force_stop()\n\n\nclass TestPendingWorkResume:\n async def test_should_continue_pending_permission_request_after_resume(\n self, ctx: E2ETestContext\n ):\n # Spawn a TCP server that both the suspended and resumed clients connect to.\n server = _make_subprocess_client(ctx, use_stdio=False)\n await server.start()\n try:\n cli_url = f\"localhost:{server.actual_port}\"\n\n release_original: asyncio.Future = asyncio.get_event_loop().create_future()\n captured_request: asyncio.Future = asyncio.get_event_loop().create_future()\n resumed_tool_invoked = False\n\n async def hold_permission(request, _invocation):\n if not captured_request.done():\n captured_request.set_result(request)\n return await release_original\n\n def original_tool_handler(args):\n return f\"ORIGINAL_SHOULD_NOT_RUN_{args.get('value', '')}\"\n\n suspended_client = CopilotClient(ExternalServerConfig(url=cli_url))\n session1 = await suspended_client.create_session(\n on_permission_request=hold_permission,\n tools=[_make_pending_tool(\"resume_permission_tool\", original_tool_handler)],\n )\n session_id = session1.session_id\n\n try:\n permission_event_task = asyncio.create_task(_wait_for_permission_request(session1))\n await session1.send(\n \"Use resume_permission_tool with value 'alpha', then reply with the result.\"\n )\n _ = await captured_request\n permission_event = await permission_event_task\n\n # Force-stop the suspended client without releasing the in-flight\n # permission so the request remains pending in the runtime.\n await suspended_client.force_stop()\n\n def resumed_tool_handler(args):\n nonlocal resumed_tool_invoked\n resumed_tool_invoked = True\n return f\"PERMISSION_RESUMED_{args['value'].upper()}\"\n\n resumed_client = CopilotClient(ExternalServerConfig(url=cli_url))\n try:\n session2 = await resumed_client.resume_session(\n session_id,\n on_permission_request=lambda req, inv: PermissionRequestResult(\n kind=\"user-not-available\"\n ),\n continue_pending_work=True,\n tools=[_make_pending_tool(\"resume_permission_tool\", resumed_tool_handler)],\n )\n\n permission_result = (\n await session2.rpc.permissions.handle_pending_permission_request(\n PermissionDecisionRequest.from_dict(\n {\n \"requestId\": permission_event.data.request_id,\n \"result\": {\"kind\": \"approve-once\"},\n }\n )\n )\n )\n assert permission_result.success\n\n answer = await get_final_assistant_message(\n session2, timeout=PENDING_WORK_TIMEOUT\n )\n\n assert resumed_tool_invoked\n assert \"PERMISSION_RESUMED_ALPHA\" in (answer.data.content or \"\")\n await session2.disconnect()\n finally:\n await _safe_force_stop(resumed_client)\n finally:\n if not release_original.done():\n release_original.set_result(PermissionRequestResult(kind=\"user-not-available\"))\n finally:\n await _safe_force_stop(server)\n\n async def test_should_continue_pending_external_tool_request_after_resume(\n self, ctx: E2ETestContext\n ):\n server = _make_subprocess_client(ctx, use_stdio=False)\n await server.start()\n try:\n cli_url = f\"localhost:{server.actual_port}\"\n\n tool_started: asyncio.Future = asyncio.get_event_loop().create_future()\n release_original: asyncio.Future = asyncio.get_event_loop().create_future()\n\n async def blocking_external_tool(args):\n value = args[\"value\"]\n if not tool_started.done():\n tool_started.set_result(value)\n return await release_original\n\n suspended_client = CopilotClient(ExternalServerConfig(url=cli_url))\n session1 = await suspended_client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n tools=[_make_pending_tool(\"resume_external_tool\", blocking_external_tool)],\n )\n session_id = session1.session_id\n\n try:\n tool_request_task = asyncio.create_task(\n _wait_for_external_tool_requests(session1, [\"resume_external_tool\"])\n )\n await session1.send(\n \"Use resume_external_tool with value 'beta', then reply with the result.\"\n )\n tool_events = await tool_request_task\n assert (await asyncio.wait_for(tool_started, PENDING_WORK_TIMEOUT)) == \"beta\"\n\n await suspended_client.force_stop()\n\n resumed_client = CopilotClient(ExternalServerConfig(url=cli_url))\n try:\n session2 = await resumed_client.resume_session(\n session_id,\n on_permission_request=PermissionHandler.approve_all,\n continue_pending_work=True,\n )\n\n tool_result = await session2.rpc.tools.handle_pending_tool_call(\n HandlePendingToolCallRequest(\n request_id=tool_events[\"resume_external_tool\"].data.request_id,\n result=\"EXTERNAL_RESUMED_BETA\",\n )\n )\n assert tool_result.success\n\n answer = await get_final_assistant_message(\n session2, timeout=PENDING_WORK_TIMEOUT\n )\n assert \"EXTERNAL_RESUMED_BETA\" in (answer.data.content or \"\")\n\n await session2.disconnect()\n finally:\n await _safe_force_stop(resumed_client)\n finally:\n if not release_original.done():\n release_original.set_result(\"ORIGINAL_SHOULD_NOT_WIN\")\n finally:\n await _safe_force_stop(server)\n\n async def test_should_continue_parallel_pending_external_tool_requests_after_resume(\n self, ctx: E2ETestContext\n ):\n server = _make_subprocess_client(ctx, use_stdio=False)\n await server.start()\n try:\n cli_url = f\"localhost:{server.actual_port}\"\n\n tool_a_started: asyncio.Future = asyncio.get_event_loop().create_future()\n tool_b_started: asyncio.Future = asyncio.get_event_loop().create_future()\n release_a: asyncio.Future = asyncio.get_event_loop().create_future()\n release_b: asyncio.Future = asyncio.get_event_loop().create_future()\n\n async def tool_a(args):\n if not tool_a_started.done():\n tool_a_started.set_result(args[\"value\"])\n return await release_a\n\n async def tool_b(args):\n if not tool_b_started.done():\n tool_b_started.set_result(args[\"value\"])\n return await release_b\n\n suspended_client = CopilotClient(ExternalServerConfig(url=cli_url))\n session1 = await suspended_client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n tools=[\n _make_pending_tool(\"pending_lookup_a\", tool_a),\n _make_pending_tool(\"pending_lookup_b\", tool_b),\n ],\n )\n session_id = session1.session_id\n\n try:\n tool_requests_task = asyncio.create_task(\n _wait_for_external_tool_requests(\n session1, [\"pending_lookup_a\", \"pending_lookup_b\"]\n )\n )\n await session1.send(\n \"Call pending_lookup_a with value 'alpha' and \"\n \"pending_lookup_b with value 'beta', then reply with both results.\"\n )\n tool_events = await tool_requests_task\n await asyncio.wait_for(\n asyncio.gather(tool_a_started, tool_b_started), PENDING_WORK_TIMEOUT\n )\n assert tool_a_started.result() == \"alpha\"\n assert tool_b_started.result() == \"beta\"\n\n await suspended_client.force_stop()\n\n resumed_client = CopilotClient(ExternalServerConfig(url=cli_url))\n try:\n session2 = await resumed_client.resume_session(\n session_id,\n on_permission_request=PermissionHandler.approve_all,\n continue_pending_work=True,\n )\n\n result_b = await session2.rpc.tools.handle_pending_tool_call(\n HandlePendingToolCallRequest(\n request_id=tool_events[\"pending_lookup_b\"].data.request_id,\n result=\"PARALLEL_B_BETA\",\n )\n )\n assert result_b.success\n result_a = await session2.rpc.tools.handle_pending_tool_call(\n HandlePendingToolCallRequest(\n request_id=tool_events[\"pending_lookup_a\"].data.request_id,\n result=\"PARALLEL_A_ALPHA\",\n )\n )\n assert result_a.success\n\n answer = await get_final_assistant_message(\n session2, timeout=PENDING_WORK_TIMEOUT\n )\n content = answer.data.content or \"\"\n assert \"PARALLEL_A_ALPHA\" in content\n assert \"PARALLEL_B_BETA\" in content\n\n await session2.disconnect()\n finally:\n await _safe_force_stop(resumed_client)\n finally:\n if not release_a.done():\n release_a.set_result(\"ORIGINAL_A_SHOULD_NOT_WIN\")\n if not release_b.done():\n release_b.set_result(\"ORIGINAL_B_SHOULD_NOT_WIN\")\n finally:\n await _safe_force_stop(server)\n\n async def test_should_resume_successfully_when_no_pending_work_exists(\n self, ctx: E2ETestContext\n ):\n server = _make_subprocess_client(ctx, use_stdio=False)\n await server.start()\n try:\n cli_url = f\"localhost:{server.actual_port}\"\n\n first_client = CopilotClient(ExternalServerConfig(url=cli_url))\n try:\n first_session = await first_client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n session_id = first_session.session_id\n first_answer = await first_session.send_and_wait(\n \"Reply with exactly: NO_PENDING_TURN_ONE\"\n )\n assert \"NO_PENDING_TURN_ONE\" in (first_answer.data.content or \"\")\n await first_session.disconnect()\n finally:\n await _safe_force_stop(first_client)\n\n resumed_client = CopilotClient(ExternalServerConfig(url=cli_url))\n try:\n resumed_session = await resumed_client.resume_session(\n session_id,\n on_permission_request=PermissionHandler.approve_all,\n continue_pending_work=True,\n )\n follow_up = await resumed_session.send_and_wait(\n \"Reply with exactly: NO_PENDING_TURN_TWO\"\n )\n assert \"NO_PENDING_TURN_TWO\" in (follow_up.data.content or \"\")\n await resumed_session.disconnect()\n finally:\n await _safe_force_stop(resumed_client)\n finally:\n await _safe_force_stop(server)\n" }, { "path": "python/e2e/test_per_session_auth_e2e.py", "content": "\"\"\"E2E Per-session GitHub auth tests\"\"\"\n\nimport pytest\n\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\n@pytest.fixture(scope=\"module\")\nasync def auth_ctx(ctx: E2ETestContext):\n \"\"\"Configure per-token user responses on the proxy before tests run.\"\"\"\n proxy_url = ctx.proxy_url\n\n # Redirect GitHub API calls to the proxy so per-session auth token\n # resolution (fetchCopilotUser) is intercepted. Must be set before the\n # CLI subprocess is spawned (i.e., before the first create_session call).\n ctx.client._config.env[\"COPILOT_DEBUG_GITHUB_API_URL\"] = proxy_url\n\n await ctx.set_copilot_user_by_token(\n \"token-alice\",\n {\n \"login\": \"alice\",\n \"copilot_plan\": \"individual_pro\",\n \"endpoints\": {\n \"api\": proxy_url,\n \"telemetry\": \"https://localhost:1/telemetry\",\n },\n \"analytics_tracking_id\": \"alice-tracking-id\",\n },\n )\n\n await ctx.set_copilot_user_by_token(\n \"token-bob\",\n {\n \"login\": \"bob\",\n \"copilot_plan\": \"business\",\n \"endpoints\": {\n \"api\": proxy_url,\n \"telemetry\": \"https://localhost:1/telemetry\",\n },\n \"analytics_tracking_id\": \"bob-tracking-id\",\n },\n )\n\n return ctx\n\n\nclass TestPerSessionAuth:\n async def test_should_create_session_with_github_token_and_check_auth_status(\n self, auth_ctx: E2ETestContext\n ):\n session = await auth_ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n github_token=\"token-alice\",\n )\n\n auth_status = await session.rpc.auth.get_status()\n assert auth_status.is_authenticated is True\n assert auth_status.login == \"alice\"\n assert auth_status.copilot_plan == \"individual_pro\"\n\n await session.disconnect()\n\n async def test_should_isolate_auth_between_sessions_with_different_tokens(\n self, auth_ctx: E2ETestContext\n ):\n session_a = await auth_ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n github_token=\"token-alice\",\n )\n session_b = await auth_ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n github_token=\"token-bob\",\n )\n\n status_a = await session_a.rpc.auth.get_status()\n status_b = await session_b.rpc.auth.get_status()\n\n assert status_a.is_authenticated is True\n assert status_a.login == \"alice\"\n assert status_a.copilot_plan == \"individual_pro\"\n\n assert status_b.is_authenticated is True\n assert status_b.login == \"bob\"\n assert status_b.copilot_plan == \"business\"\n\n await session_a.disconnect()\n await session_b.disconnect()\n\n async def test_should_return_unauthenticated_when_no_token_provided(\n self, auth_ctx: E2ETestContext\n ):\n session = await auth_ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n\n auth_status = await session.rpc.auth.get_status()\n # Without a per-session token, there is no per-session identity.\n # In CI the process-level fake token may still authenticate globally,\n # so we check login rather than is_authenticated. On some platforms\n # the absence of a login may surface as None, on others as an empty string.\n assert not auth_status.login\n\n await session.disconnect()\n\n async def test_should_error_when_creating_session_with_invalid_token(\n self, auth_ctx: E2ETestContext\n ):\n with pytest.raises(Exception):\n await auth_ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n github_token=\"invalid-token-12345\",\n )\n" }, { "path": "python/e2e/test_permissions_e2e.py", "content": "\"\"\"\nTests for permission callback functionality\n\"\"\"\n\nimport asyncio\n\nimport pytest\n\nfrom copilot.generated.session_events import (\n PermissionRequest,\n SessionIdleData,\n ToolExecutionCompleteData,\n)\nfrom copilot.session import PermissionHandler, PermissionRequestResult\n\nfrom .testharness import E2ETestContext\nfrom .testharness.helper import read_file, write_file\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nclass TestPermissions:\n async def test_should_invoke_permission_handler_for_write_operations(self, ctx: E2ETestContext):\n \"\"\"Test that permission handler is invoked for write operations\"\"\"\n permission_requests = []\n\n def on_permission_request(\n request: PermissionRequest, invocation: dict\n ) -> PermissionRequestResult:\n permission_requests.append(request)\n assert invocation[\"session_id\"] == session.session_id\n return PermissionRequestResult(kind=\"approve-once\")\n\n session = await ctx.client.create_session(on_permission_request=on_permission_request)\n\n write_file(ctx.work_dir, \"test.txt\", \"original content\")\n\n await session.send_and_wait(\"Edit test.txt and replace 'original' with 'modified'\")\n\n # Should have received at least one permission request\n assert len(permission_requests) > 0\n\n # Should include write permission request\n write_requests = [req for req in permission_requests if req.kind.value == \"write\"]\n assert len(write_requests) > 0\n\n await session.disconnect()\n\n async def test_should_deny_permission_when_handler_returns_denied(self, ctx: E2ETestContext):\n \"\"\"Test denying permissions\"\"\"\n\n def on_permission_request(\n request: PermissionRequest, invocation: dict\n ) -> PermissionRequestResult:\n return PermissionRequestResult(kind=\"reject\")\n\n session = await ctx.client.create_session(on_permission_request=on_permission_request)\n\n original_content = \"protected content\"\n write_file(ctx.work_dir, \"protected.txt\", original_content)\n\n await session.send_and_wait(\"Edit protected.txt and replace 'protected' with 'hacked'.\")\n\n # Verify the file was NOT modified\n content = read_file(ctx.work_dir, \"protected.txt\")\n assert content == original_content\n\n await session.disconnect()\n\n async def test_should_deny_tool_operations_when_handler_explicitly_denies(\n self, ctx: E2ETestContext\n ):\n \"\"\"Test that tool operations are denied when handler explicitly denies\"\"\"\n\n def deny_all(request, invocation):\n return PermissionRequestResult()\n\n session = await ctx.client.create_session(on_permission_request=deny_all)\n\n denied_events = []\n done_event = asyncio.Event()\n\n def on_event(event):\n match event.data:\n case ToolExecutionCompleteData(success=False) as data:\n error = data.error\n msg = (\n error\n if isinstance(error, str)\n else (getattr(error, \"message\", None) if error is not None else None)\n )\n if msg and \"Permission denied\" in msg:\n denied_events.append(event)\n case SessionIdleData():\n done_event.set()\n\n session.on(on_event)\n\n await session.send(\"Run 'node --version'\")\n await asyncio.wait_for(done_event.wait(), timeout=60)\n\n assert len(denied_events) > 0\n\n await session.disconnect()\n\n async def test_should_deny_tool_operations_when_handler_explicitly_denies_after_resume(\n self, ctx: E2ETestContext\n ):\n \"\"\"Test that tool operations are denied after resume when handler explicitly denies\"\"\"\n session1 = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n session_id = session1.session_id\n await session1.send_and_wait(\"What is 1+1?\")\n\n def deny_all(request, invocation):\n return PermissionRequestResult()\n\n session2 = await ctx.client.resume_session(session_id, on_permission_request=deny_all)\n\n denied_events = []\n done_event = asyncio.Event()\n\n def on_event(event):\n match event.data:\n case ToolExecutionCompleteData(success=False) as data:\n error = data.error\n msg = (\n error\n if isinstance(error, str)\n else (getattr(error, \"message\", None) if error is not None else None)\n )\n if msg and \"Permission denied\" in msg:\n denied_events.append(event)\n case SessionIdleData():\n done_event.set()\n\n session2.on(on_event)\n\n await session2.send(\"Run 'node --version'\")\n await asyncio.wait_for(done_event.wait(), timeout=60)\n\n assert len(denied_events) > 0\n\n await session2.disconnect()\n\n async def test_should_work_with_approve_all_permission_handler(self, ctx: E2ETestContext):\n \"\"\"Test that sessions work with approve-all permission handler\"\"\"\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n message = await session.send_and_wait(\"What is 2+2?\")\n\n assert message is not None\n assert \"4\" in message.data.content\n\n await session.disconnect()\n\n async def test_should_handle_async_permission_handler(self, ctx: E2ETestContext):\n \"\"\"Test async permission handler\"\"\"\n permission_requests = []\n\n async def on_permission_request(\n request: PermissionRequest, invocation: dict\n ) -> PermissionRequestResult:\n permission_requests.append(request)\n # Simulate async permission check (e.g., user prompt)\n await asyncio.sleep(0.01)\n return PermissionRequestResult(kind=\"approve-once\")\n\n session = await ctx.client.create_session(on_permission_request=on_permission_request)\n\n await session.send_and_wait(\"Run 'echo test' and tell me what happens\")\n\n assert len(permission_requests) > 0\n\n await session.disconnect()\n\n async def test_should_resume_session_with_permission_handler(self, ctx: E2ETestContext):\n \"\"\"Test resuming session with permission handler\"\"\"\n permission_requests = []\n\n # Create initial session\n session1 = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n session_id = session1.session_id\n await session1.send_and_wait(\"What is 1+1?\")\n\n # Resume with permission handler\n def on_permission_request(\n request: PermissionRequest, invocation: dict\n ) -> PermissionRequestResult:\n permission_requests.append(request)\n return PermissionRequestResult(kind=\"approve-once\")\n\n session2 = await ctx.client.resume_session(\n session_id, on_permission_request=on_permission_request\n )\n\n await session2.send_and_wait(\"Run 'echo resumed' for me\")\n\n # Should have permission requests from resumed session\n assert len(permission_requests) > 0\n\n await session2.disconnect()\n\n async def test_should_handle_permission_handler_errors_gracefully(self, ctx: E2ETestContext):\n \"\"\"Test that permission handler errors are handled gracefully\"\"\"\n\n def on_permission_request(\n request: PermissionRequest, invocation: dict\n ) -> PermissionRequestResult:\n raise RuntimeError(\"Handler error\")\n\n session = await ctx.client.create_session(on_permission_request=on_permission_request)\n\n message = await session.send_and_wait(\"Run 'echo test'. If you can't, say 'failed'.\")\n\n # Should handle the error and deny permission\n assert message is not None\n content_lower = message.data.content.lower()\n assert any(word in content_lower for word in [\"fail\", \"cannot\", \"unable\", \"permission\"])\n\n await session.disconnect()\n\n async def test_should_receive_toolcallid_in_permission_requests(self, ctx: E2ETestContext):\n \"\"\"Test that toolCallId is included in permission requests\"\"\"\n received_tool_call_id = False\n\n def on_permission_request(\n request: PermissionRequest, invocation: dict\n ) -> PermissionRequestResult:\n nonlocal received_tool_call_id\n if request.tool_call_id:\n received_tool_call_id = True\n assert isinstance(request.tool_call_id, str)\n assert len(request.tool_call_id) > 0\n return PermissionRequestResult(kind=\"approve-once\")\n\n session = await ctx.client.create_session(on_permission_request=on_permission_request)\n\n await session.send_and_wait(\"Run 'echo test'\")\n\n assert received_tool_call_id\n\n await session.disconnect()\n" }, { "path": "python/e2e/test_rpc_e2e.py", "content": "\"\"\"E2E RPC Tests\"\"\"\n\nimport pytest\n\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\nfrom copilot.generated.rpc import PingRequest\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import CLI_PATH, E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nclass TestRpc:\n @pytest.mark.asyncio\n async def test_should_call_rpc_ping_with_typed_params(self):\n \"\"\"Test calling rpc.ping with typed params and result\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n\n result = await client.rpc.ping(PingRequest(message=\"typed rpc test\"))\n assert result.message == \"pong: typed rpc test\"\n assert isinstance(result.timestamp, (int, float))\n\n await client.stop()\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_should_call_rpc_models_list(self):\n \"\"\"Test calling rpc.models.list with typed result\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n\n auth_status = await client.get_auth_status()\n if not auth_status.isAuthenticated:\n await client.stop()\n return\n\n result = await client.rpc.models.list()\n assert result.models is not None\n assert isinstance(result.models, list)\n\n await client.stop()\n finally:\n await client.force_stop()\n\n # account.getQuota is defined in schema but not yet implemented in CLI\n @pytest.mark.skip(reason=\"account.getQuota not yet implemented in CLI\")\n @pytest.mark.asyncio\n async def test_should_call_rpc_account_get_quota(self):\n \"\"\"Test calling rpc.account.getQuota when authenticated\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n\n auth_status = await client.get_auth_status()\n if not auth_status.isAuthenticated:\n await client.stop()\n return\n\n result = await client.rpc.account.get_quota()\n assert result.quota_snapshots is not None\n assert isinstance(result.quota_snapshots, dict)\n\n await client.stop()\n finally:\n await client.force_stop()\n\n\nclass TestSessionRpc:\n # session.model.getCurrent is defined in schema but not yet implemented in CLI\n @pytest.mark.skip(reason=\"session.model.getCurrent not yet implemented in CLI\")\n async def test_should_call_session_rpc_model_get_current(self, ctx: E2ETestContext):\n \"\"\"Test calling session.rpc.model.getCurrent\"\"\"\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all, model=\"claude-sonnet-4.5\"\n )\n\n result = await session.rpc.model.get_current()\n assert result.model_id is not None\n assert isinstance(result.model_id, str)\n\n # session.model.switchTo is defined in schema but not yet implemented in CLI\n @pytest.mark.skip(reason=\"session.model.switchTo not yet implemented in CLI\")\n async def test_should_call_session_rpc_model_switch_to(self, ctx: E2ETestContext):\n \"\"\"Test calling session.rpc.model.switchTo\"\"\"\n from copilot.generated.rpc import ModelSwitchToRequest\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all, model=\"claude-sonnet-4.5\"\n )\n\n # Get initial model\n before = await session.rpc.model.get_current()\n assert before.model_id is not None\n\n # Switch to a different model with reasoning effort\n result = await session.rpc.model.switch_to(\n ModelSwitchToRequest(model_id=\"gpt-4.1\", reasoning_effort=\"high\")\n )\n assert result.model_id == \"gpt-4.1\"\n\n # Verify the switch persisted\n after = await session.rpc.model.get_current()\n assert after.model_id == \"gpt-4.1\"\n\n @pytest.mark.asyncio\n async def test_get_and_set_session_mode(self):\n \"\"\"Test getting and setting session mode\"\"\"\n from copilot.generated.rpc import ModeSetRequest, SessionMode\n\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n # Get initial mode (default should be interactive)\n initial = await session.rpc.mode.get()\n assert initial == SessionMode.INTERACTIVE\n\n # Switch to plan mode\n await session.rpc.mode.set(ModeSetRequest(mode=SessionMode.PLAN))\n\n # Verify mode persisted\n after_plan = await session.rpc.mode.get()\n assert after_plan == SessionMode.PLAN\n\n # Switch back to interactive\n await session.rpc.mode.set(ModeSetRequest(mode=SessionMode.INTERACTIVE))\n\n await session.disconnect()\n await client.stop()\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_read_update_and_delete_plan(self):\n \"\"\"Test reading, updating, and deleting plan\"\"\"\n from copilot.generated.rpc import PlanUpdateRequest\n\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n # Initially plan should not exist\n initial = await session.rpc.plan.read()\n assert initial.exists is False\n assert initial.content is None\n\n # Create/update plan\n plan_content = \"# Test Plan\\n\\n- Step 1\\n- Step 2\"\n await session.rpc.plan.update(PlanUpdateRequest(content=plan_content))\n\n # Verify plan exists and has correct content\n after_update = await session.rpc.plan.read()\n assert after_update.exists is True\n assert after_update.content == plan_content\n\n # Delete plan\n await session.rpc.plan.delete()\n\n # Verify plan is deleted\n after_delete = await session.rpc.plan.read()\n assert after_delete.exists is False\n assert after_delete.content is None\n\n await session.disconnect()\n await client.stop()\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_create_list_and_read_workspace_files(self):\n \"\"\"Test creating, listing, and reading workspace files\"\"\"\n from copilot.generated.rpc import (\n WorkspacesCreateFileRequest,\n WorkspacesReadFileRequest,\n )\n\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, use_stdio=True))\n\n try:\n await client.start()\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n # Initially no files\n initial_files = await session.rpc.workspaces.list_files()\n assert initial_files.files == []\n\n # Create a file\n file_content = \"Hello, workspace!\"\n await session.rpc.workspaces.create_file(\n WorkspacesCreateFileRequest(content=file_content, path=\"test.txt\")\n )\n\n # List files\n after_create = await session.rpc.workspaces.list_files()\n assert \"test.txt\" in after_create.files\n\n # Read file\n read_result = await session.rpc.workspaces.read_file(\n WorkspacesReadFileRequest(path=\"test.txt\")\n )\n assert read_result.content == file_content\n\n # Create nested file\n await session.rpc.workspaces.create_file(\n WorkspacesCreateFileRequest(content=\"Nested content\", path=\"subdir/nested.txt\")\n )\n\n after_nested = await session.rpc.workspaces.list_files()\n assert \"test.txt\" in after_nested.files\n assert any(\"nested.txt\" in f for f in after_nested.files)\n\n await session.disconnect()\n await client.stop()\n finally:\n await client.force_stop()\n" }, { "path": "python/e2e/test_rpc_mcp_and_skills_e2e.py", "content": "\"\"\"\nE2E coverage for session-scoped MCP, skills, plugins, and extensions RPCs.\n\nMirrors ``dotnet/test/RpcMcpAndSkillsTests.cs`` (snapshot category\n``rpc_mcp_and_skills``).\n\"\"\"\n\nfrom __future__ import annotations\n\nimport os\nimport uuid\nfrom pathlib import Path\n\nimport pytest\n\nfrom copilot.generated.rpc import (\n ExtensionsDisableRequest,\n ExtensionsEnableRequest,\n MCPDisableRequest,\n MCPEnableRequest,\n SkillsDisableRequest,\n SkillsEnableRequest,\n)\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\ndef _create_skill(skills_dir: Path, skill_name: str, description: str) -> None:\n skill_subdir = skills_dir / skill_name\n skill_subdir.mkdir(parents=True, exist_ok=True)\n skill_md = (\n f\"---\\n\"\n f\"name: {skill_name}\\n\"\n f\"description: {description}\\n\"\n f\"---\\n\\n\"\n f\"# {skill_name}\\n\\n\"\n f\"This skill is used by RPC E2E tests.\\n\"\n )\n (skill_subdir / \"SKILL.md\").write_text(skill_md, encoding=\"utf-8\", newline=\"\\n\")\n\n\ndef _create_skill_directory(work_dir: str, skill_name: str, description: str) -> str:\n skills_dir = Path(work_dir) / \"session-rpc-skills\" / uuid.uuid4().hex\n skills_dir.mkdir(parents=True, exist_ok=True)\n _create_skill(skills_dir, skill_name, description)\n return str(skills_dir)\n\n\ndef _assert_skill(skills, skill_name: str, *, enabled: bool):\n matching = [s for s in skills if s.name == skill_name]\n assert len(matching) == 1, f\"Expected exactly one skill named {skill_name!r}\"\n skill = matching[0]\n assert skill.enabled is enabled\n assert skill.path is not None\n assert skill.path.endswith(os.path.join(skill_name, \"SKILL.md\"))\n return skill\n\n\nasync def _assert_failure(awaitable, expected: str) -> None:\n with pytest.raises(Exception) as excinfo:\n _ = await awaitable\n assert expected.lower() in str(excinfo.value).lower()\n\n\nclass TestRpcMcpAndSkills:\n async def test_should_list_and_toggle_session_skills(self, ctx: E2ETestContext):\n skill_name = f\"session-rpc-skill-{uuid.uuid4().hex}\"\n skills_dir = _create_skill_directory(\n ctx.work_dir, skill_name, \"Session skill controlled by RPC.\"\n )\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n skill_directories=[skills_dir],\n disabled_skills=[skill_name],\n )\n try:\n disabled = await session.rpc.skills.list()\n _assert_skill(disabled.skills, skill_name, enabled=False)\n\n await session.rpc.skills.enable(SkillsEnableRequest(name=skill_name))\n enabled = await session.rpc.skills.list()\n _assert_skill(enabled.skills, skill_name, enabled=True)\n\n await session.rpc.skills.disable(SkillsDisableRequest(name=skill_name))\n disabled_again = await session.rpc.skills.list()\n _assert_skill(disabled_again.skills, skill_name, enabled=False)\n finally:\n await session.disconnect()\n\n async def test_should_reload_session_skills(self, ctx: E2ETestContext):\n skills_dir = Path(ctx.work_dir) / \"reloadable-rpc-skills\" / uuid.uuid4().hex\n skills_dir.mkdir(parents=True, exist_ok=True)\n skill_name = f\"reload-rpc-skill-{uuid.uuid4().hex}\"\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n skill_directories=[str(skills_dir)],\n )\n try:\n before = await session.rpc.skills.list()\n assert all(s.name != skill_name for s in before.skills)\n\n _create_skill(skills_dir, skill_name, \"Skill added after session creation.\")\n await session.rpc.skills.reload()\n\n after = await session.rpc.skills.list()\n reloaded = _assert_skill(after.skills, skill_name, enabled=True)\n assert reloaded.description == \"Skill added after session creation.\"\n finally:\n await session.disconnect()\n\n async def test_should_list_mcp_servers_with_configured_server(self, ctx: E2ETestContext):\n server_name = \"rpc-list-mcp-server\"\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n mcp_servers={\n server_name: {\n \"command\": \"echo\",\n \"args\": [\"rpc-list-mcp-server\"],\n \"tools\": [\"*\"],\n }\n },\n )\n try:\n result = await session.rpc.mcp.list()\n matching = [s for s in result.servers if s.name == server_name]\n assert len(matching) == 1\n assert matching[0].status is not None\n finally:\n await session.disconnect()\n\n async def test_should_list_plugins(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n result = await session.rpc.plugins.list()\n assert result.plugins is not None\n assert all((p.name or \"\").strip() for p in result.plugins)\n finally:\n await session.disconnect()\n\n async def test_should_list_extensions(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n result = await session.rpc.extensions.list()\n assert result.extensions is not None\n for extension in result.extensions:\n assert (extension.id or \"\").strip()\n assert (extension.name or \"\").strip()\n finally:\n await session.disconnect()\n\n async def test_should_report_error_when_mcp_host_is_not_initialized(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n await _assert_failure(\n session.rpc.mcp.enable(MCPEnableRequest(server_name=\"missing-server\")),\n \"No MCP host initialized\",\n )\n await _assert_failure(\n session.rpc.mcp.disable(MCPDisableRequest(server_name=\"missing-server\")),\n \"No MCP host initialized\",\n )\n await _assert_failure(\n session.rpc.mcp.reload(),\n \"MCP config reload not available\",\n )\n finally:\n await session.disconnect()\n\n async def test_should_report_error_when_extensions_are_not_available(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n await _assert_failure(\n session.rpc.extensions.enable(ExtensionsEnableRequest(id=\"missing-extension\")),\n \"Extensions not available\",\n )\n await _assert_failure(\n session.rpc.extensions.disable(ExtensionsDisableRequest(id=\"missing-extension\")),\n \"Extensions not available\",\n )\n await _assert_failure(\n session.rpc.extensions.reload(),\n \"Extensions not available\",\n )\n finally:\n await session.disconnect()\n" }, { "path": "python/e2e/test_rpc_mcp_config_e2e.py", "content": "\"\"\"\nE2E coverage for ``mcp.config.*`` server-scoped RPCs.\n\nMirrors ``dotnet/test/RpcMcpConfigTests.cs`` (snapshot category\n``rpc_mcp_config``).\n\"\"\"\n\nfrom __future__ import annotations\n\nimport uuid\n\nimport pytest\n\nfrom copilot.generated.rpc import (\n MCPConfigAddRequest,\n MCPConfigDisableRequest,\n MCPConfigEnableRequest,\n MCPConfigRemoveRequest,\n MCPConfigUpdateRequest,\n MCPServerConfig,\n MCPServerConfigHTTPOauthGrantType,\n MCPServerConfigType,\n)\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\ndef _server_config(servers: dict, name: str) -> MCPServerConfig:\n assert name in servers, f\"Expected MCP server '{name}' to be present.\"\n return servers[name]\n\n\nclass TestRpcMcpConfig:\n async def test_should_call_server_mcp_config_rpcs(self, ctx: E2ETestContext):\n await ctx.client.start()\n\n server_name = f\"sdk-test-{uuid.uuid4().hex}\"\n config = MCPServerConfig(command=\"node\", args=[])\n updated_config = MCPServerConfig(command=\"node\", args=[\"--version\"])\n\n initial = await ctx.client.rpc.mcp.config.list()\n assert server_name not in initial.servers\n\n try:\n await ctx.client.rpc.mcp.config.add(\n MCPConfigAddRequest(name=server_name, config=config)\n )\n after_add = await ctx.client.rpc.mcp.config.list()\n assert server_name in after_add.servers\n\n await ctx.client.rpc.mcp.config.update(\n MCPConfigUpdateRequest(name=server_name, config=updated_config)\n )\n after_update = await ctx.client.rpc.mcp.config.list()\n updated = _server_config(after_update.servers, server_name)\n assert updated.command == \"node\"\n assert updated.args is not None and updated.args[0] == \"--version\"\n\n await ctx.client.rpc.mcp.config.disable(MCPConfigDisableRequest(names=[server_name]))\n await ctx.client.rpc.mcp.config.enable(MCPConfigEnableRequest(names=[server_name]))\n finally:\n await ctx.client.rpc.mcp.config.remove(MCPConfigRemoveRequest(name=server_name))\n\n after_remove = await ctx.client.rpc.mcp.config.list()\n assert server_name not in after_remove.servers\n\n async def test_should_round_trip_http_mcp_oauth_config_rpc(self, ctx: E2ETestContext):\n await ctx.client.start()\n\n server_name = f\"sdk-http-oauth-{uuid.uuid4().hex}\"\n config = MCPServerConfig(\n type=MCPServerConfigType.HTTP,\n url=\"https://example.com/mcp\",\n headers={\"Authorization\": \"Bearer token\"},\n oauth_client_id=\"client-id\",\n oauth_public_client=False,\n oauth_grant_type=MCPServerConfigHTTPOauthGrantType.CLIENT_CREDENTIALS,\n tools=[\"*\"],\n timeout=3000,\n )\n updated_config = MCPServerConfig(\n type=MCPServerConfigType.HTTP,\n url=\"https://example.com/updated-mcp\",\n oauth_client_id=\"updated-client-id\",\n oauth_public_client=True,\n oauth_grant_type=MCPServerConfigHTTPOauthGrantType.AUTHORIZATION_CODE,\n tools=[\"updated-tool\"],\n timeout=4000,\n )\n\n try:\n await ctx.client.rpc.mcp.config.add(\n MCPConfigAddRequest(name=server_name, config=config)\n )\n after_add = await ctx.client.rpc.mcp.config.list()\n added = _server_config(after_add.servers, server_name)\n assert added.type == MCPServerConfigType.HTTP\n assert added.url == \"https://example.com/mcp\"\n assert added.headers is not None\n assert added.headers[\"Authorization\"] == \"Bearer token\"\n assert added.oauth_client_id == \"client-id\"\n assert added.oauth_public_client is False\n assert added.oauth_grant_type == MCPServerConfigHTTPOauthGrantType.CLIENT_CREDENTIALS\n\n await ctx.client.rpc.mcp.config.update(\n MCPConfigUpdateRequest(name=server_name, config=updated_config)\n )\n after_update = await ctx.client.rpc.mcp.config.list()\n updated = _server_config(after_update.servers, server_name)\n assert updated.url == \"https://example.com/updated-mcp\"\n assert updated.oauth_client_id == \"updated-client-id\"\n assert updated.oauth_public_client is True\n assert updated.oauth_grant_type == MCPServerConfigHTTPOauthGrantType.AUTHORIZATION_CODE\n assert updated.tools is not None and updated.tools[0] == \"updated-tool\"\n assert updated.timeout == 4000\n finally:\n await ctx.client.rpc.mcp.config.remove(MCPConfigRemoveRequest(name=server_name))\n\n after_remove = await ctx.client.rpc.mcp.config.list()\n assert server_name not in after_remove.servers\n" }, { "path": "python/e2e/test_rpc_server_e2e.py", "content": "\"\"\"\nE2E coverage for top-level (server-scoped) RPC methods.\n\nMirrors ``dotnet/test/RpcServerTests.cs`` (snapshot category ``rpc_server``).\n\"\"\"\n\nfrom __future__ import annotations\n\nimport os\nimport uuid\nfrom pathlib import Path\n\nimport pytest\n\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\nfrom copilot.generated.rpc import (\n AccountGetQuotaRequest,\n MCPDiscoverRequest,\n PingRequest,\n SkillsConfigSetDisabledSkillsRequest,\n SkillsDiscoverRequest,\n ToolsListRequest,\n)\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\ndef _create_skill_directory(work_dir: str, skill_name: str, description: str) -> str:\n skills_dir = Path(work_dir) / \"server-rpc-skills\" / uuid.uuid4().hex\n skill_subdir = skills_dir / skill_name\n skill_subdir.mkdir(parents=True, exist_ok=True)\n skill_md = (\n f\"---\\n\"\n f\"name: {skill_name}\\n\"\n f\"description: {description}\\n\"\n f\"---\\n\\n\"\n f\"# {skill_name}\\n\\n\"\n f\"This skill is used by RPC E2E tests.\\n\"\n )\n (skill_subdir / \"SKILL.md\").write_text(skill_md, encoding=\"utf-8\", newline=\"\\n\")\n return str(skills_dir)\n\n\n@pytest.fixture(scope=\"module\")\nasync def authed_ctx(ctx: E2ETestContext):\n \"\"\"Configure proxy to redirect GitHub user lookups so per-token auth works.\"\"\"\n ctx.client._config.env[\"COPILOT_DEBUG_GITHUB_API_URL\"] = ctx.proxy_url\n return ctx\n\n\ndef _make_authed_client(ctx: E2ETestContext, token: str) -> CopilotClient:\n env = ctx.get_env()\n env[\"COPILOT_DEBUG_GITHUB_API_URL\"] = ctx.proxy_url\n return CopilotClient(\n SubprocessConfig(\n cli_path=ctx.cli_path,\n cwd=ctx.work_dir,\n env=env,\n github_token=token,\n )\n )\n\n\nasync def _configure_user(\n ctx: E2ETestContext,\n token: str,\n quota_snapshots: dict | None = None,\n):\n payload: dict = {\n \"login\": \"rpc-user\",\n \"copilot_plan\": \"individual_pro\",\n \"endpoints\": {\n \"api\": ctx.proxy_url,\n \"telemetry\": \"https://localhost:1/telemetry\",\n },\n \"analytics_tracking_id\": \"rpc-user-tracking-id\",\n }\n if quota_snapshots is not None:\n payload[\"quota_snapshots\"] = quota_snapshots\n await ctx.set_copilot_user_by_token(token, payload)\n\n\nclass TestRpcServer:\n async def test_should_call_rpc_ping_with_typed_params_and_result(self, ctx: E2ETestContext):\n await ctx.client.start()\n result = await ctx.client.rpc.ping(PingRequest(message=\"typed rpc test\"))\n assert result.message == \"pong: typed rpc test\"\n assert result.timestamp >= 0\n\n async def test_should_call_rpc_models_list_with_typed_result(self, authed_ctx: E2ETestContext):\n token = \"rpc-models-token\"\n await _configure_user(authed_ctx, token)\n client = _make_authed_client(authed_ctx, token)\n try:\n await client.start()\n result = await client.rpc.models.list()\n assert result.models is not None\n assert any(model.id == \"claude-sonnet-4.5\" for model in result.models)\n assert all((model.name or \"\").strip() for model in result.models)\n finally:\n try:\n await client.stop()\n except ExceptionGroup:\n # Intentional: shutting down the per-test client can race the\n # CLI's own teardown and surface as an aggregated cancellation\n # error from anyio. We don't want it to fail the test.\n pass\n\n async def test_should_call_rpc_account_get_quota_when_authenticated(\n self, authed_ctx: E2ETestContext\n ):\n token = \"rpc-quota-token\"\n await _configure_user(\n authed_ctx,\n token,\n quota_snapshots={\n \"chat\": {\n \"entitlement\": 100,\n \"overage_count\": 2,\n \"overage_permitted\": True,\n \"percent_remaining\": 75,\n \"timestamp_utc\": \"2026-04-30T00:00:00Z\",\n }\n },\n )\n client = _make_authed_client(authed_ctx, token)\n try:\n await client.start()\n result = await client.rpc.account.get_quota(AccountGetQuotaRequest(git_hub_token=token))\n assert \"chat\" in result.quota_snapshots\n chat_quota = result.quota_snapshots[\"chat\"]\n assert chat_quota.entitlement_requests == 100\n assert chat_quota.used_requests == 25\n assert chat_quota.remaining_percentage == 75\n assert chat_quota.overage == 2\n assert chat_quota.usage_allowed_with_exhausted_quota is True\n assert chat_quota.overage_allowed_with_exhausted_quota is True\n assert chat_quota.reset_date == \"2026-04-30T00:00:00Z\"\n finally:\n try:\n await client.stop()\n except ExceptionGroup:\n # Intentional: shutting down the per-test client can race the\n # CLI's own teardown and surface as an aggregated cancellation\n # error from anyio. We don't want it to fail the test.\n pass\n\n async def test_should_call_rpc_tools_list_with_typed_result(self, ctx: E2ETestContext):\n await ctx.client.start()\n result = await ctx.client.rpc.tools.list(ToolsListRequest())\n assert result.tools is not None\n assert len(result.tools) > 0\n assert all((tool.name or \"\").strip() for tool in result.tools)\n\n async def test_should_discover_server_mcp_and_skills(self, ctx: E2ETestContext):\n await ctx.client.start()\n\n skill_name = f\"server-rpc-skill-{uuid.uuid4().hex}\"\n skill_directory = _create_skill_directory(\n ctx.work_dir,\n skill_name,\n \"Skill discovered by server-scoped RPC tests.\",\n )\n\n mcp = await ctx.client.rpc.mcp.discover(MCPDiscoverRequest(working_directory=ctx.work_dir))\n assert mcp.servers is not None\n\n skills = await ctx.client.rpc.skills.discover(\n SkillsDiscoverRequest(skill_directories=[skill_directory])\n )\n matching = [s for s in skills.skills if s.name == skill_name]\n assert len(matching) == 1\n discovered = matching[0]\n assert discovered.description == \"Skill discovered by server-scoped RPC tests.\"\n assert discovered.enabled is True\n assert discovered.path.endswith(os.path.join(skill_name, \"SKILL.md\"))\n\n try:\n await ctx.client.rpc.skills.config.set_disabled_skills(\n SkillsConfigSetDisabledSkillsRequest(disabled_skills=[skill_name])\n )\n disabled = await ctx.client.rpc.skills.discover(\n SkillsDiscoverRequest(skill_directories=[skill_directory])\n )\n disabled_match = [s for s in disabled.skills if s.name == skill_name]\n assert len(disabled_match) == 1\n assert disabled_match[0].enabled is False\n finally:\n await ctx.client.rpc.skills.config.set_disabled_skills(\n SkillsConfigSetDisabledSkillsRequest(disabled_skills=[])\n )\n" }, { "path": "python/e2e/test_rpc_session_state_e2e.py", "content": "\"\"\"\nE2E coverage for session-scoped state RPCs.\n\nMirrors ``dotnet/test/RpcSessionStateTests.cs`` (snapshot category\n``rpc_session_state``).\n\"\"\"\n\nfrom __future__ import annotations\n\nimport pytest\n\nfrom copilot.generated.rpc import (\n HistoryTruncateRequest,\n MCPOauthLoginRequest,\n ModelSwitchToRequest,\n ModeSetRequest,\n NameSetRequest,\n PermissionsSetApproveAllRequest,\n PlanUpdateRequest,\n SessionMode,\n SessionsForkRequest,\n WorkspacesCreateFileRequest,\n WorkspacesReadFileRequest,\n)\nfrom copilot.generated.session_events import AssistantMessageData, UserMessageData\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\ndef _conversation_messages(events) -> list[tuple[str, str]]:\n out: list[tuple[str, str]] = []\n for evt in events:\n match evt.data:\n case UserMessageData() as data:\n out.append((\"user\", data.content or \"\"))\n case AssistantMessageData() as data:\n out.append((\"assistant\", data.content or \"\"))\n return out\n\n\nasync def _assert_implemented_failure(awaitable, method: str) -> None:\n with pytest.raises(Exception) as excinfo:\n _ = await awaitable\n assert f\"Unhandled method {method}\".lower() not in str(excinfo.value).lower()\n\n\nclass TestRpcSessionState:\n async def test_should_call_session_rpc_model_get_current(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model=\"claude-sonnet-4.5\",\n )\n try:\n result = await session.rpc.model.get_current()\n assert result.model_id\n finally:\n await session.disconnect()\n\n async def test_should_call_session_rpc_model_switch_to(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model=\"claude-sonnet-4.5\",\n )\n try:\n before = await session.rpc.model.get_current()\n assert before.model_id\n\n result = await session.rpc.model.switch_to(\n ModelSwitchToRequest(model_id=\"gpt-4.1\", reasoning_effort=\"high\")\n )\n after = await session.rpc.model.get_current()\n\n assert result.model_id == \"gpt-4.1\"\n # SwitchToAsync does not mutate session state — it only resolves the override.\n assert after.model_id == before.model_id\n finally:\n await session.disconnect()\n\n async def test_should_get_and_set_session_mode(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n initial = await session.rpc.mode.get()\n assert initial == SessionMode.INTERACTIVE\n\n await session.rpc.mode.set(ModeSetRequest(mode=SessionMode.PLAN))\n assert await session.rpc.mode.get() == SessionMode.PLAN\n\n await session.rpc.mode.set(ModeSetRequest(mode=SessionMode.INTERACTIVE))\n assert await session.rpc.mode.get() == SessionMode.INTERACTIVE\n finally:\n await session.disconnect()\n\n async def test_should_read_update_and_delete_plan(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n initial = await session.rpc.plan.read()\n assert initial.exists is False\n assert initial.content is None\n\n plan_content = \"# Test Plan\\n\\n- Step 1\\n- Step 2\"\n await session.rpc.plan.update(PlanUpdateRequest(content=plan_content))\n\n after_update = await session.rpc.plan.read()\n assert after_update.exists is True\n assert after_update.content == plan_content\n\n await session.rpc.plan.delete()\n\n after_delete = await session.rpc.plan.read()\n assert after_delete.exists is False\n assert after_delete.content is None\n finally:\n await session.disconnect()\n\n async def test_should_call_workspace_file_rpc_methods(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n initial = await session.rpc.workspaces.list_files()\n assert initial.files is not None\n\n await session.rpc.workspaces.create_file(\n WorkspacesCreateFileRequest(path=\"test.txt\", content=\"Hello, workspace!\")\n )\n\n after_create = await session.rpc.workspaces.list_files()\n assert \"test.txt\" in after_create.files\n\n file = await session.rpc.workspaces.read_file(\n WorkspacesReadFileRequest(path=\"test.txt\")\n )\n assert file.content == \"Hello, workspace!\"\n\n workspace = await session.rpc.workspaces.get_workspace()\n assert workspace.workspace is not None\n assert workspace.workspace.id is not None\n finally:\n await session.disconnect()\n\n async def test_should_get_and_set_session_metadata(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n await session.rpc.name.set(NameSetRequest(name=\"SDK test session\"))\n name = await session.rpc.name.get()\n assert name.name == \"SDK test session\"\n\n sources = await session.rpc.instructions.get_sources()\n assert sources.sources is not None\n finally:\n await session.disconnect()\n\n async def test_should_fork_session_with_persisted_messages(self, ctx: E2ETestContext):\n source_prompt = \"Say FORK_SOURCE_ALPHA exactly.\"\n fork_prompt = \"Now say FORK_CHILD_BETA exactly.\"\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n initial_answer = await session.send_and_wait(source_prompt, timeout=60.0)\n assert initial_answer is not None\n assert \"FORK_SOURCE_ALPHA\" in (initial_answer.data.content or \"\")\n\n source_messages = await session.get_messages()\n source_conversation = _conversation_messages(source_messages)\n assert any(\n role == \"user\" and content == source_prompt for role, content in source_conversation\n )\n assert any(\n role == \"assistant\" and \"FORK_SOURCE_ALPHA\" in content\n for role, content in source_conversation\n )\n\n fork = await ctx.client.rpc.sessions.fork(\n SessionsForkRequest(session_id=session.session_id)\n )\n assert (fork.session_id or \"\").strip()\n assert fork.session_id != session.session_id\n\n forked_session = await ctx.client.resume_session(\n fork.session_id,\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n forked_messages = await forked_session.get_messages()\n forked_conversation = _conversation_messages(forked_messages)\n assert forked_conversation[: len(source_conversation)] == source_conversation\n\n fork_answer = await forked_session.send_and_wait(fork_prompt, timeout=60.0)\n assert fork_answer is not None\n assert \"FORK_CHILD_BETA\" in (fork_answer.data.content or \"\")\n\n source_after_fork = _conversation_messages(await session.get_messages())\n assert all(content != fork_prompt for _, content in source_after_fork)\n\n fork_after_prompt = _conversation_messages(await forked_session.get_messages())\n assert any(\n role == \"user\" and content == fork_prompt for role, content in fork_after_prompt\n )\n assert any(\n role == \"assistant\" and \"FORK_CHILD_BETA\" in content\n for role, content in fork_after_prompt\n )\n finally:\n await forked_session.disconnect()\n finally:\n await session.disconnect()\n\n async def test_should_report_error_when_forking_session_without_persisted_events(\n self, ctx: E2ETestContext\n ):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n with pytest.raises(Exception) as excinfo:\n await ctx.client.rpc.sessions.fork(\n SessionsForkRequest(session_id=session.session_id)\n )\n text = str(excinfo.value).lower()\n assert \"not found or has no persisted events\" in text\n assert \"unhandled method sessions.fork\" not in text\n finally:\n await session.disconnect()\n\n async def test_should_call_session_usage_and_permission_rpcs(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n metrics = await session.rpc.usage.get_metrics()\n assert metrics.session_start_time > 0\n if metrics.total_nano_aiu is not None:\n assert metrics.total_nano_aiu >= 0\n if metrics.token_details is not None:\n for detail in metrics.token_details.values():\n assert detail.token_count >= 0\n for model_metric in metrics.model_metrics.values():\n if model_metric.total_nano_aiu is not None:\n assert model_metric.total_nano_aiu >= 0\n if model_metric.token_details is not None:\n for detail in model_metric.token_details.values():\n assert detail.token_count >= 0\n\n try:\n approve_all = await session.rpc.permissions.set_approve_all(\n PermissionsSetApproveAllRequest(enabled=True)\n )\n assert approve_all.success\n\n reset = await session.rpc.permissions.reset_session_approvals()\n assert reset.success\n finally:\n await session.rpc.permissions.set_approve_all(\n PermissionsSetApproveAllRequest(enabled=False)\n )\n finally:\n await session.disconnect()\n\n async def test_should_report_implemented_errors_for_unsupported_session_rpc_paths(\n self, ctx: E2ETestContext\n ):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n await _assert_implemented_failure(\n session.rpc.history.truncate(HistoryTruncateRequest(event_id=\"missing-event\")),\n \"session.history.truncate\",\n )\n await _assert_implemented_failure(\n session.rpc.mcp.oauth.login(MCPOauthLoginRequest(server_name=\"missing-server\")),\n \"session.mcp.oauth.login\",\n )\n finally:\n await session.disconnect()\n\n async def test_should_compact_session_history_after_messages(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n await session.send_and_wait(\"What is 2+2?\", timeout=60.0)\n result = await session.rpc.history.compact()\n assert result is not None\n finally:\n await session.disconnect()\n" }, { "path": "python/e2e/test_rpc_shell_and_fleet_e2e.py", "content": "\"\"\"\nE2E coverage for ``session.shell.*`` and ``session.fleet.*`` RPCs.\n\nMirrors ``dotnet/test/RpcShellAndFleetTests.cs`` (snapshot category\n``rpc_shell_and_fleet``).\n\"\"\"\n\nfrom __future__ import annotations\n\nimport asyncio\nimport sys\nimport uuid\nfrom pathlib import Path\n\nimport pytest\n\nfrom copilot.generated.rpc import FleetStartRequest, ShellExecRequest, ShellKillRequest\nfrom copilot.generated.session_events import (\n AssistantMessageData,\n SessionErrorData,\n ToolExecutionCompleteData,\n ToolExecutionStartData,\n UserMessageData,\n)\nfrom copilot.session import PermissionHandler\nfrom copilot.tools import Tool, ToolInvocation, ToolResult\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\ndef _write_file_command(marker_path: Path, marker: str) -> str:\n if sys.platform == \"win32\":\n return (\n f\"powershell -NoLogo -NoProfile -Command \"\n f\"\\\"Set-Content -LiteralPath '{marker_path}' -Value '{marker}'\\\"\"\n )\n return f\"sh -c \\\"printf '%s' '{marker}' > '{marker_path}'\\\"\"\n\n\nasync def _wait_for_file_text(path: Path, expected: str, *, timeout: float = 30.0) -> None:\n deadline = asyncio.get_event_loop().time() + timeout\n while asyncio.get_event_loop().time() < deadline:\n if path.exists():\n text = path.read_text(encoding=\"utf-8\")\n if expected in text:\n return\n await asyncio.sleep(0.1)\n raise TimeoutError(f\"Timed out waiting for shell command to write '{expected}' to '{path}'.\")\n\n\nclass TestRpcShellAndFleet:\n async def test_should_execute_shell_command(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n marker_path = Path(ctx.work_dir) / f\"shell-rpc-{uuid.uuid4().hex}.txt\"\n marker = \"copilot-sdk-shell-rpc\"\n\n result = await session.rpc.shell.exec(\n ShellExecRequest(command=_write_file_command(marker_path, marker), cwd=ctx.work_dir)\n )\n assert (result.process_id or \"\").strip()\n await _wait_for_file_text(marker_path, marker)\n\n await session.disconnect()\n\n async def test_should_kill_shell_process(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n if sys.platform == \"win32\":\n command = 'powershell -NoLogo -NoProfile -Command \"Start-Sleep -Seconds 30\"'\n else:\n command = \"sleep 30\"\n\n exec_result = await session.rpc.shell.exec(ShellExecRequest(command=command))\n assert (exec_result.process_id or \"\").strip()\n\n kill_result = await session.rpc.shell.kill(\n ShellKillRequest(process_id=exec_result.process_id)\n )\n assert kill_result.killed\n\n await session.disconnect()\n\n async def test_should_start_fleet_and_complete_custom_tool_task(self, ctx: E2ETestContext):\n marker_path = Path(ctx.work_dir) / f\"fleet-rpc-{uuid.uuid4().hex}.txt\"\n marker = \"copilot-sdk-fleet-rpc\"\n tool_name = \"record_fleet_completion\"\n\n def record_fleet_completion(invocation: ToolInvocation) -> ToolResult:\n args = invocation.arguments or {}\n content = str(args.get(\"content\", \"\"))\n marker_path.write_text(content, encoding=\"utf-8\")\n return ToolResult(text_result_for_llm=content)\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n tools=[\n Tool(\n name=tool_name,\n description=\"Records completion of the fleet validation task.\",\n parameters={\n \"type\": \"object\",\n \"properties\": {\"content\": {\"type\": \"string\", \"description\": \"Marker\"}},\n \"required\": [\"content\"],\n },\n handler=record_fleet_completion,\n )\n ],\n )\n\n prompt = (\n f\"Use the {tool_name} tool with content '{marker}', \"\n \"then report that the fleet task is complete.\"\n )\n result = await session.rpc.fleet.start(FleetStartRequest(prompt=prompt))\n assert result.started\n await _wait_for_file_text(marker_path, marker)\n\n async def _wait_for_messages(timeout: float = 120.0):\n deadline = asyncio.get_event_loop().time() + timeout\n while asyncio.get_event_loop().time() < deadline:\n messages = await session.get_messages()\n if any(\n isinstance(m.data, AssistantMessageData)\n and \"fleet task\" in (m.data.content or \"\").lower()\n for m in messages\n ):\n return messages\n if any(isinstance(m.data, SessionErrorData) for m in messages):\n raise RuntimeError(\"Session error while waiting for fleet completion\")\n await asyncio.sleep(0.25)\n raise TimeoutError(\"Timed out waiting for fleet-mode assistant reply.\")\n\n messages = await _wait_for_messages()\n assert any(\n isinstance(m.data, UserMessageData) and prompt in (m.data.content or \"\")\n for m in messages\n )\n assert any(\n isinstance(m.data, ToolExecutionStartData) and m.data.tool_name == tool_name\n for m in messages\n )\n assert any(\n isinstance(m.data, ToolExecutionCompleteData)\n and m.data.success\n and (\n getattr(m.data, \"result\", None) is not None\n and marker in (m.data.result.content or \"\")\n )\n for m in messages\n )\n assert any(\n isinstance(m.data, AssistantMessageData)\n and \"fleet task\" in (m.data.content or \"\").lower()\n for m in messages\n )\n\n await session.disconnect()\n" }, { "path": "python/e2e/test_rpc_tasks_and_handlers_e2e.py", "content": "\"\"\"\nE2E coverage for ``session.tasks.*`` and pending-handler RPCs.\n\nMirrors ``dotnet/test/RpcTasksAndHandlersTests.cs`` (snapshot category\n``rpc_tasks_and_handlers``).\n\"\"\"\n\nfrom __future__ import annotations\n\nimport pytest\n\nfrom copilot.generated.rpc import (\n CommandsHandlePendingCommandRequest,\n HandlePendingToolCallRequest,\n PermissionDecision,\n PermissionDecisionKind,\n PermissionDecisionRequest,\n TasksCancelRequest,\n TasksPromoteToBackgroundRequest,\n TasksRemoveRequest,\n TasksStartAgentRequest,\n UIElicitationResponse,\n UIElicitationResponseAction,\n UIHandlePendingElicitationRequest,\n)\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nasync def _assert_implemented_failure(awaitable, method: str) -> None:\n with pytest.raises(Exception) as excinfo:\n _ = await awaitable\n assert f\"Unhandled method {method}\".lower() not in str(excinfo.value).lower()\n\n\nclass TestRpcTasksAndHandlers:\n async def test_should_list_task_state_and_return_false_for_missing_task_operations(\n self, ctx: E2ETestContext\n ):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n tasks = await session.rpc.tasks.list()\n assert tasks.tasks is not None\n assert len(tasks.tasks) == 0\n\n promote = await session.rpc.tasks.promote_to_background(\n TasksPromoteToBackgroundRequest(id=\"missing-task\")\n )\n assert promote.promoted is False\n\n cancel = await session.rpc.tasks.cancel(TasksCancelRequest(id=\"missing-task\"))\n assert cancel.cancelled is False\n\n remove = await session.rpc.tasks.remove(TasksRemoveRequest(id=\"missing-task\"))\n assert remove.removed is False\n finally:\n await session.disconnect()\n\n async def test_should_report_implemented_error_for_missing_task_agent_type(\n self, ctx: E2ETestContext\n ):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n await _assert_implemented_failure(\n session.rpc.tasks.start_agent(\n TasksStartAgentRequest(\n agent_type=\"missing-agent-type\",\n prompt=\"Say hi\",\n name=\"sdk-test-task\",\n )\n ),\n \"session.tasks.startAgent\",\n )\n finally:\n await session.disconnect()\n\n async def test_should_return_expected_results_for_missing_pending_handler_request_ids(\n self, ctx: E2ETestContext\n ):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n tool = await session.rpc.tools.handle_pending_tool_call(\n HandlePendingToolCallRequest(\n request_id=\"missing-tool-request\",\n result=\"tool result\",\n )\n )\n assert tool.success is False\n\n command = await session.rpc.commands.handle_pending_command(\n CommandsHandlePendingCommandRequest(\n request_id=\"missing-command-request\",\n error=\"command error\",\n )\n )\n assert command.success is True\n\n elicitation = await session.rpc.ui.handle_pending_elicitation(\n UIHandlePendingElicitationRequest(\n request_id=\"missing-elicitation-request\",\n result=UIElicitationResponse(action=UIElicitationResponseAction.CANCEL),\n )\n )\n assert elicitation.success is False\n\n permission = await session.rpc.permissions.handle_pending_permission_request(\n PermissionDecisionRequest(\n request_id=\"missing-permission-request\",\n result=PermissionDecision(\n kind=PermissionDecisionKind.REJECT,\n feedback=\"not approved\",\n ),\n )\n )\n assert permission.success is False\n\n permanent = await session.rpc.permissions.handle_pending_permission_request(\n PermissionDecisionRequest(\n request_id=\"missing-permanent-permission-request\",\n result=PermissionDecision(\n kind=PermissionDecisionKind.APPROVE_PERMANENTLY,\n domain=\"example.com\",\n ),\n )\n )\n assert permanent.success is False\n finally:\n await session.disconnect()\n" }, { "path": "python/e2e/test_session_config_e2e.py", "content": "\"\"\"E2E tests for session configuration including model capabilities overrides.\"\"\"\n\nimport base64\nimport os\nimport uuid\n\nimport pytest\n\nfrom copilot import ModelCapabilitiesOverride, ModelSupportsOverride\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\nPROVIDER_HEADER_NAME = \"x-copilot-sdk-provider-header\"\nCLIENT_NAME = \"python-public-surface-client\"\n\n\ndef has_image_url_content(exchanges: list[dict]) -> bool:\n \"\"\"Check if any exchange contains an image_url content part in user messages.\"\"\"\n for ex in exchanges:\n for msg in ex.get(\"request\", {}).get(\"messages\", []):\n if msg.get(\"role\") == \"user\" and isinstance(msg.get(\"content\"), list):\n if any(p.get(\"type\") == \"image_url\" for p in msg[\"content\"]):\n return True\n return False\n\n\ndef _make_proxy_provider(proxy_url: str, header_value: str) -> dict:\n return {\n \"type\": \"openai\",\n \"base_url\": proxy_url,\n \"api_key\": \"test-provider-key\",\n \"headers\": {PROVIDER_HEADER_NAME: header_value},\n }\n\n\ndef _normalize_headers(headers) -> dict[str, str]:\n if isinstance(headers, list):\n flat: dict[str, str] = {}\n for entry in headers:\n if isinstance(entry, dict):\n key = entry.get(\"name\") or entry.get(\"key\")\n value = entry.get(\"value\")\n if key is not None:\n flat[str(key).lower()] = str(value)\n return flat\n if isinstance(headers, dict):\n flat = {}\n for key, value in headers.items():\n if isinstance(value, list):\n flat[str(key).lower()] = \", \".join(str(v) for v in value)\n else:\n flat[str(key).lower()] = str(value)\n return flat\n return {}\n\n\ndef _assert_header_contains(headers, name: str, expected: str) -> None:\n flat = _normalize_headers(headers)\n actual = flat.get(name.lower(), \"\")\n assert expected in actual, (\n f\"Expected header {name!r} to contain {expected!r}; got {actual!r}. All headers: {flat!r}\"\n )\n\n\ndef _get_system_message(exchange: dict) -> str:\n for msg in exchange.get(\"request\", {}).get(\"messages\", []):\n if msg.get(\"role\") == \"system\":\n value = msg.get(\"content\")\n if isinstance(value, str):\n return value\n return \"\"\n\n\ndef _get_tool_names(exchange: dict) -> list[str]:\n tools = exchange.get(\"request\", {}).get(\"tools\") or []\n names: list[str] = []\n for tool in tools:\n function = tool.get(\"function\") if isinstance(tool, dict) else None\n if isinstance(function, dict):\n name = function.get(\"name\")\n if isinstance(name, str):\n names.append(name)\n return names\n\n\nPNG_1X1 = base64.b64decode(\n \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\"\n)\nVIEW_IMAGE_PROMPT = \"Use the view tool to look at the file test.png and describe what you see\"\n\n\nclass TestSessionConfig:\n \"\"\"Tests for session configuration including model capabilities overrides.\"\"\"\n\n async def test_vision_disabled_then_enabled_via_setmodel(self, ctx: E2ETestContext):\n png_path = os.path.join(ctx.work_dir, \"test.png\")\n with open(png_path, \"wb\") as f:\n f.write(PNG_1X1)\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model_capabilities=ModelCapabilitiesOverride(\n supports=ModelSupportsOverride(vision=False)\n ),\n )\n\n # Turn 1: vision off — no image_url expected\n await session.send_and_wait(VIEW_IMAGE_PROMPT)\n traffic_after_t1 = await ctx.get_exchanges()\n assert not has_image_url_content(traffic_after_t1)\n\n # Switch vision on\n await session.set_model(\n \"claude-sonnet-4.5\",\n model_capabilities=ModelCapabilitiesOverride(\n supports=ModelSupportsOverride(vision=True)\n ),\n )\n\n # Turn 2: vision on — image_url expected in new exchanges\n await session.send_and_wait(VIEW_IMAGE_PROMPT)\n traffic_after_t2 = await ctx.get_exchanges()\n new_exchanges = traffic_after_t2[len(traffic_after_t1) :]\n assert has_image_url_content(new_exchanges)\n\n await session.disconnect()\n\n async def test_vision_enabled_then_disabled_via_setmodel(self, ctx: E2ETestContext):\n png_path = os.path.join(ctx.work_dir, \"test.png\")\n with open(png_path, \"wb\") as f:\n f.write(PNG_1X1)\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model_capabilities=ModelCapabilitiesOverride(\n supports=ModelSupportsOverride(vision=True)\n ),\n )\n\n # Turn 1: vision on — image_url expected\n await session.send_and_wait(VIEW_IMAGE_PROMPT)\n traffic_after_t1 = await ctx.get_exchanges()\n assert has_image_url_content(traffic_after_t1)\n\n # Switch vision off\n await session.set_model(\n \"claude-sonnet-4.5\",\n model_capabilities=ModelCapabilitiesOverride(\n supports=ModelSupportsOverride(vision=False)\n ),\n )\n\n # Turn 2: vision off — no image_url expected in new exchanges\n await session.send_and_wait(VIEW_IMAGE_PROMPT)\n traffic_after_t2 = await ctx.get_exchanges()\n new_exchanges = traffic_after_t2[len(traffic_after_t1) :]\n assert not has_image_url_content(new_exchanges)\n\n await session.disconnect()\n\n async def test_should_use_custom_sessionid(self, ctx: E2ETestContext):\n from copilot.generated.session_events import SessionStartData\n\n requested_session_id = str(uuid.uuid4())\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n session_id=requested_session_id,\n )\n assert session.session_id == requested_session_id\n\n messages = await session.get_messages()\n assert messages\n start_event = messages[0]\n assert isinstance(start_event.data, SessionStartData)\n assert start_event.data.session_id == requested_session_id\n\n await session.disconnect()\n\n async def test_should_forward_clientname_in_useragent(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n client_name=CLIENT_NAME,\n )\n\n await session.send_and_wait(\"What is 1+1?\")\n\n exchanges = await ctx.get_exchanges()\n assert exchanges\n _assert_header_contains(exchanges[-1].get(\"requestHeaders\"), \"user-agent\", CLIENT_NAME)\n\n await session.disconnect()\n\n async def test_should_forward_custom_provider_headers_on_create(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n model=\"claude-sonnet-4.5\",\n provider=_make_proxy_provider(ctx.proxy_url, \"create-provider-header\"),\n )\n\n message = await session.send_and_wait(\"What is 1+1?\")\n assert \"2\" in (message.data.content or \"\")\n\n exchanges = await ctx.get_exchanges()\n assert exchanges\n headers = exchanges[-1].get(\"requestHeaders\")\n _assert_header_contains(headers, \"authorization\", \"Bearer test-provider-key\")\n _assert_header_contains(headers, PROVIDER_HEADER_NAME, \"create-provider-header\")\n\n await session.disconnect()\n\n async def test_should_forward_custom_provider_headers_on_resume(self, ctx: E2ETestContext):\n session1 = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n session_id = session1.session_id\n\n session2 = await ctx.client.resume_session(\n session_id,\n on_permission_request=PermissionHandler.approve_all,\n model=\"claude-sonnet-4.5\",\n provider=_make_proxy_provider(ctx.proxy_url, \"resume-provider-header\"),\n )\n\n message = await session2.send_and_wait(\"What is 2+2?\")\n assert \"4\" in (message.data.content or \"\")\n\n exchanges = await ctx.get_exchanges()\n assert exchanges\n headers = exchanges[-1].get(\"requestHeaders\")\n _assert_header_contains(headers, \"authorization\", \"Bearer test-provider-key\")\n _assert_header_contains(headers, PROVIDER_HEADER_NAME, \"resume-provider-header\")\n\n await session2.disconnect()\n await session1.disconnect()\n\n async def test_should_use_workingdirectory_for_tool_execution(self, ctx: E2ETestContext):\n sub_dir = os.path.join(ctx.work_dir, \"subproject\")\n os.makedirs(sub_dir, exist_ok=True)\n with open(os.path.join(sub_dir, \"marker.txt\"), \"w\", encoding=\"utf-8\") as f:\n f.write(\"I am in the subdirectory\")\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n working_directory=sub_dir,\n )\n\n message = await session.send_and_wait(\"Read the file marker.txt and tell me what it says\")\n assert \"subdirectory\" in (message.data.content or \"\")\n\n await session.disconnect()\n\n async def test_should_apply_workingdirectory_on_session_resume(self, ctx: E2ETestContext):\n sub_dir = os.path.join(ctx.work_dir, \"resume-subproject\")\n os.makedirs(sub_dir, exist_ok=True)\n with open(os.path.join(sub_dir, \"resume-marker.txt\"), \"w\", encoding=\"utf-8\") as f:\n f.write(\"I am in the resume working directory\")\n\n session1 = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n session_id = session1.session_id\n\n session2 = await ctx.client.resume_session(\n session_id,\n on_permission_request=PermissionHandler.approve_all,\n working_directory=sub_dir,\n )\n\n message = await session2.send_and_wait(\n \"Read the file resume-marker.txt and tell me what it says\"\n )\n assert \"resume working directory\" in (message.data.content or \"\")\n\n await session2.disconnect()\n await session1.disconnect()\n\n async def test_should_apply_systemmessage_on_session_resume(self, ctx: E2ETestContext):\n session1 = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n session_id = session1.session_id\n\n resume_instruction = \"End the response with RESUME_SYSTEM_MESSAGE_SENTINEL.\"\n session2 = await ctx.client.resume_session(\n session_id,\n on_permission_request=PermissionHandler.approve_all,\n system_message={\"mode\": \"append\", \"content\": resume_instruction},\n )\n\n message = await session2.send_and_wait(\"What is 1+1?\")\n assert \"RESUME_SYSTEM_MESSAGE_SENTINEL\" in (message.data.content or \"\")\n\n exchanges = await ctx.get_exchanges()\n assert exchanges\n assert resume_instruction in _get_system_message(exchanges[-1])\n\n await session2.disconnect()\n await session1.disconnect()\n\n async def test_should_apply_availabletools_on_session_resume(self, ctx: E2ETestContext):\n session1 = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n session_id = session1.session_id\n\n session2 = await ctx.client.resume_session(\n session_id,\n on_permission_request=PermissionHandler.approve_all,\n available_tools=[\"view\"],\n )\n\n await session2.send_and_wait(\"What is 1+1?\")\n\n exchanges = await ctx.get_exchanges()\n assert exchanges\n assert _get_tool_names(exchanges[-1]) == [\"view\"]\n\n await session2.disconnect()\n await session1.disconnect()\n" }, { "path": "python/e2e/test_session_e2e.py", "content": "\"\"\"E2E Session Tests\"\"\"\n\nimport base64\nimport os\n\nimport pytest\n\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\nfrom copilot.generated.session_events import SessionModelChangeData\nfrom copilot.session import PermissionHandler\nfrom copilot.tools import Tool, ToolResult\n\nfrom .testharness import E2ETestContext, get_final_assistant_message, get_next_event_of_type\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nclass TestSessions:\n async def test_should_create_and_disconnect_sessions(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all, model=\"claude-sonnet-4.5\"\n )\n assert session.session_id\n\n messages = await session.get_messages()\n assert len(messages) > 0\n assert messages[0].type.value == \"session.start\"\n assert messages[0].data.session_id == session.session_id\n assert messages[0].data.selected_model == \"claude-sonnet-4.5\"\n\n await session.disconnect()\n\n with pytest.raises(Exception, match=\"Session not found\"):\n await session.get_messages()\n\n async def test_should_have_stateful_conversation(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n assistant_message = await session.send_and_wait(\"What is 1+1?\")\n assert assistant_message is not None\n assert \"2\" in assistant_message.data.content\n\n second_message = await session.send_and_wait(\"Now if you double that, what do you get?\")\n assert second_message is not None\n assert \"4\" in second_message.data.content\n\n async def test_should_create_a_session_with_appended_systemMessage_config(\n self, ctx: E2ETestContext\n ):\n system_message_suffix = \"End each response with the phrase 'Have a nice day!'\"\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n system_message={\"mode\": \"append\", \"content\": system_message_suffix},\n )\n\n await session.send(\"What is your full name?\")\n assistant_message = await get_final_assistant_message(session)\n assert \"GitHub\" in assistant_message.data.content\n assert \"Have a nice day!\" in assistant_message.data.content\n\n # Also validate the underlying traffic\n traffic = await ctx.get_exchanges()\n system_message = _get_system_message(traffic[0])\n assert \"GitHub\" in system_message\n assert system_message_suffix in system_message\n\n async def test_should_create_a_session_with_replaced_systemMessage_config(\n self, ctx: E2ETestContext\n ):\n test_system_message = \"You are an assistant called Testy McTestface. Reply succinctly.\"\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n system_message={\"mode\": \"replace\", \"content\": test_system_message},\n )\n\n await session.send(\"What is your full name?\")\n assistant_message = await get_final_assistant_message(session)\n assert \"GitHub\" not in assistant_message.data.content\n assert \"Testy\" in assistant_message.data.content\n\n # Also validate the underlying traffic\n traffic = await ctx.get_exchanges()\n system_message = _get_system_message(traffic[0])\n assert system_message == test_system_message # Exact match\n\n async def test_should_create_a_session_with_customized_systemMessage_config(\n self, ctx: E2ETestContext\n ):\n custom_tone = \"Respond in a warm, professional tone. Be thorough in explanations.\"\n appended_content = \"Always mention quarterly earnings.\"\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n system_message={\n \"mode\": \"customize\",\n \"sections\": {\n \"tone\": {\"action\": \"replace\", \"content\": custom_tone},\n \"code_change_rules\": {\"action\": \"remove\"},\n },\n \"content\": appended_content,\n },\n )\n\n assistant_message = await session.send_and_wait(\"Who are you?\")\n assert assistant_message is not None\n\n # Validate the system message sent to the model\n traffic = await ctx.get_exchanges()\n system_message = _get_system_message(traffic[0])\n assert custom_tone in system_message\n assert appended_content in system_message\n assert \"\" not in system_message\n\n async def test_should_create_a_session_with_availableTools(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n available_tools=[\"view\", \"edit\"],\n )\n\n await session.send(\"What is 1+1?\")\n await get_final_assistant_message(session)\n\n # It only tells the model about the specified tools and no others\n traffic = await ctx.get_exchanges()\n tools = traffic[0][\"request\"][\"tools\"]\n tool_names = [t[\"function\"][\"name\"] for t in tools]\n assert len(tool_names) == 2\n assert \"view\" in tool_names\n assert \"edit\" in tool_names\n\n async def test_should_create_a_session_with_excludedTools(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all, excluded_tools=[\"view\"]\n )\n\n await session.send(\"What is 1+1?\")\n await get_final_assistant_message(session)\n\n # It has other tools, but not the one we excluded\n traffic = await ctx.get_exchanges()\n tools = traffic[0][\"request\"][\"tools\"]\n tool_names = [t[\"function\"][\"name\"] for t in tools]\n assert \"edit\" in tool_names\n assert \"grep\" in tool_names\n assert \"view\" not in tool_names\n\n async def test_should_create_a_session_with_defaultAgent_excludedTools(\n self, ctx: E2ETestContext\n ):\n secret_tool = Tool(\n name=\"secret_tool\",\n description=\"A secret tool hidden from the default agent\",\n handler=lambda args: \"SECRET\",\n parameters={\n \"type\": \"object\",\n \"properties\": {\"input\": {\"type\": \"string\"}},\n },\n )\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n tools=[secret_tool],\n default_agent={\"excluded_tools\": [\"secret_tool\"]},\n )\n\n await session.send(\"What is 1+1?\")\n await get_final_assistant_message(session)\n\n # The real assertion: verify the runtime excluded the tool from the CAPI request\n traffic = await ctx.get_exchanges()\n tools = traffic[0][\"request\"][\"tools\"]\n tool_names = [t[\"function\"][\"name\"] for t in tools]\n assert \"secret_tool\" not in tool_names\n\n # TODO: This test shows there's a race condition inside client.ts. If createSession\n # is called concurrently and autoStart is on, it may start multiple child processes.\n # This needs to be fixed. Right now it manifests as being unable to delete the temp\n # directories during afterAll even though we stopped all the clients.\n @pytest.mark.skip(reason=\"Known race condition - see TypeScript test\")\n async def test_should_handle_multiple_concurrent_sessions(self, ctx: E2ETestContext):\n import asyncio\n\n s1, s2, s3 = await asyncio.gather(\n ctx.client.create_session(on_permission_request=PermissionHandler.approve_all),\n ctx.client.create_session(on_permission_request=PermissionHandler.approve_all),\n ctx.client.create_session(on_permission_request=PermissionHandler.approve_all),\n )\n\n # All sessions should have unique IDs\n session_ids = {s1.session_id, s2.session_id, s3.session_id}\n assert len(session_ids) == 3\n\n # All are connected\n for s in [s1, s2, s3]:\n messages = await s.get_messages()\n assert len(messages) > 0\n assert messages[0].type.value == \"session.start\"\n assert messages[0].data.session_id == s.session_id\n\n # All can be disconnected\n await asyncio.gather(s1.disconnect(), s2.disconnect(), s3.disconnect())\n for s in [s1, s2, s3]:\n with pytest.raises(Exception, match=\"Session not found\"):\n await s.get_messages()\n\n async def test_should_resume_a_session_using_the_same_client(self, ctx: E2ETestContext):\n # Create initial session\n session1 = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n session_id = session1.session_id\n answer = await session1.send_and_wait(\"What is 1+1?\")\n assert answer is not None\n assert \"2\" in answer.data.content\n\n # Resume using the same client\n session2 = await ctx.client.resume_session(\n session_id, on_permission_request=PermissionHandler.approve_all\n )\n assert session2.session_id == session_id\n answer2 = await get_final_assistant_message(session2, already_idle=True)\n assert \"2\" in answer2.data.content\n\n # Can continue the conversation statefully\n answer3 = await session2.send_and_wait(\"Now if you double that, what do you get?\")\n assert answer3 is not None\n assert \"4\" in answer3.data.content\n\n async def test_should_resume_a_session_using_a_new_client(self, ctx: E2ETestContext):\n # Create initial session\n session1 = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n session_id = session1.session_id\n answer = await session1.send_and_wait(\"What is 1+1?\")\n assert answer is not None\n assert \"2\" in answer.data.content\n\n # Resume using a new client\n github_token = (\n \"fake-token-for-e2e-tests\" if os.environ.get(\"GITHUB_ACTIONS\") == \"true\" else None\n )\n new_client = CopilotClient(\n SubprocessConfig(\n cli_path=ctx.cli_path,\n cwd=ctx.work_dir,\n env=ctx.get_env(),\n github_token=github_token,\n )\n )\n\n try:\n session2 = await new_client.resume_session(\n session_id, on_permission_request=PermissionHandler.approve_all\n )\n assert session2.session_id == session_id\n\n messages = await session2.get_messages()\n message_types = [m.type.value for m in messages]\n assert \"user.message\" in message_types\n assert \"session.resume\" in message_types\n\n # Can continue the conversation statefully\n answer2 = await session2.send_and_wait(\"Now if you double that, what do you get?\")\n assert answer2 is not None\n assert \"4\" in answer2.data.content\n finally:\n await new_client.force_stop()\n\n async def test_should_throw_error_resuming_nonexistent_session(self, ctx: E2ETestContext):\n with pytest.raises(Exception):\n await ctx.client.resume_session(\n \"non-existent-session-id\", on_permission_request=PermissionHandler.approve_all\n )\n\n async def test_should_list_sessions(self, ctx: E2ETestContext):\n import asyncio\n\n # Create a couple of sessions and send messages to persist them\n session1 = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n await session1.send_and_wait(\"Say hello\")\n session2 = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n await session2.send_and_wait(\"Say goodbye\")\n\n # Small delay to ensure session files are written to disk\n await asyncio.sleep(0.2)\n\n # List sessions and verify they're included\n sessions = await ctx.client.list_sessions()\n assert isinstance(sessions, list)\n\n session_ids = [s.sessionId for s in sessions]\n assert session1.session_id in session_ids\n assert session2.session_id in session_ids\n\n # Verify session metadata structure\n for session_data in sessions:\n assert hasattr(session_data, \"sessionId\")\n assert hasattr(session_data, \"startTime\")\n assert hasattr(session_data, \"modifiedTime\")\n assert hasattr(session_data, \"isRemote\")\n # summary is optional\n assert isinstance(session_data.sessionId, str)\n assert isinstance(session_data.startTime, str)\n assert isinstance(session_data.modifiedTime, str)\n assert isinstance(session_data.isRemote, bool)\n\n # Verify context field is present\n for session_data in sessions:\n assert hasattr(session_data, \"context\")\n if session_data.context is not None:\n assert hasattr(session_data.context, \"cwd\")\n assert isinstance(session_data.context.cwd, str)\n\n async def test_should_delete_session(self, ctx: E2ETestContext):\n import asyncio\n\n # Create a session and send a message to persist it\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n await session.send_and_wait(\"Hello\")\n session_id = session.session_id\n\n # Small delay to ensure session file is written to disk\n await asyncio.sleep(0.2)\n\n # Verify session exists in the list\n sessions = await ctx.client.list_sessions()\n session_ids = [s.sessionId for s in sessions]\n assert session_id in session_ids\n\n # Delete the session\n await ctx.client.delete_session(session_id)\n\n # Verify session no longer exists in the list\n sessions_after = await ctx.client.list_sessions()\n session_ids_after = [s.sessionId for s in sessions_after]\n assert session_id not in session_ids_after\n\n # Verify we cannot resume the deleted session\n with pytest.raises(Exception):\n await ctx.client.resume_session(\n session_id, on_permission_request=PermissionHandler.approve_all\n )\n\n async def test_should_get_session_metadata(self, ctx: E2ETestContext):\n import asyncio\n\n # Create a session and send a message to persist it\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n await session.send_and_wait(\"Say hello\")\n\n # Small delay to ensure session file is written to disk\n await asyncio.sleep(0.2)\n\n # Get metadata for the session we just created\n metadata = await ctx.client.get_session_metadata(session.session_id)\n assert metadata is not None\n assert metadata.sessionId == session.session_id\n assert isinstance(metadata.startTime, str)\n assert isinstance(metadata.modifiedTime, str)\n assert isinstance(metadata.isRemote, bool)\n\n # Verify context field is present\n if metadata.context is not None:\n assert hasattr(metadata.context, \"cwd\")\n assert isinstance(metadata.context.cwd, str)\n\n # Verify non-existent session returns None\n not_found = await ctx.client.get_session_metadata(\"non-existent-session-id\")\n assert not_found is None\n\n async def test_should_get_last_session_id(self, ctx: E2ETestContext):\n import asyncio\n\n # Create a session and send a message to persist it\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n await session.send_and_wait(\"Say hello\")\n\n # Small delay to ensure session data is flushed to disk\n await asyncio.sleep(0.5)\n\n last_session_id = await ctx.client.get_last_session_id()\n assert last_session_id == session.session_id\n\n await session.disconnect()\n\n async def test_should_create_session_with_custom_tool(self, ctx: E2ETestContext):\n # This test uses the low-level Tool() API to show that Pydantic is optional\n def get_secret_number_handler(invocation):\n key = invocation.arguments.get(\"key\", \"\") if invocation.arguments else \"\"\n return ToolResult(\n text_result_for_llm=\"54321\" if key == \"ALPHA\" else \"unknown\",\n result_type=\"success\",\n )\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n tools=[\n Tool(\n name=\"get_secret_number\",\n description=\"Gets the secret number\",\n handler=get_secret_number_handler,\n parameters={\n \"type\": \"object\",\n \"properties\": {\"key\": {\"type\": \"string\", \"description\": \"Key\"}},\n \"required\": [\"key\"],\n },\n )\n ],\n )\n\n answer = await session.send_and_wait(\"What is the secret number for key ALPHA?\")\n assert answer is not None\n assert \"54321\" in answer.data.content\n\n async def test_should_create_session_with_custom_provider(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n provider={\n \"type\": \"openai\",\n \"base_url\": \"https://api.openai.com/v1\",\n \"api_key\": \"fake-key\",\n },\n )\n assert session.session_id\n\n async def test_should_create_session_with_azure_provider(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n provider={\n \"type\": \"azure\",\n \"base_url\": \"https://my-resource.openai.azure.com\",\n \"api_key\": \"fake-key\",\n \"azure\": {\n \"api_version\": \"2024-02-15-preview\",\n },\n },\n )\n assert session.session_id\n\n async def test_should_resume_session_with_custom_provider(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n session_id = session.session_id\n\n # Resume the session with a provider\n session2 = await ctx.client.resume_session(\n session_id,\n on_permission_request=PermissionHandler.approve_all,\n provider={\n \"type\": \"openai\",\n \"base_url\": \"https://api.openai.com/v1\",\n \"api_key\": \"fake-key\",\n },\n )\n\n assert session2.session_id == session_id\n\n async def test_should_abort_a_session(self, ctx: E2ETestContext):\n import asyncio\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n # Set up event listeners BEFORE sending to avoid race conditions\n wait_for_tool_start = asyncio.create_task(\n get_next_event_of_type(session, \"tool.execution_start\", timeout=60.0)\n )\n wait_for_session_idle = asyncio.create_task(\n get_next_event_of_type(session, \"session.idle\", timeout=30.0)\n )\n\n # Send a message that will trigger a long-running shell command\n await session.send(\n \"run the shell command 'sleep 100' (note this works on both bash and PowerShell)\"\n )\n\n # Wait for the tool to start executing\n _ = await wait_for_tool_start\n\n # Abort the session while the tool is running\n await session.abort()\n\n # Wait for session to become idle after abort\n _ = await wait_for_session_idle\n\n # The session should still be alive and usable after abort\n messages = await session.get_messages()\n assert len(messages) > 0\n\n # Verify an abort event exists in messages\n abort_events = [m for m in messages if m.type.value == \"abort\"]\n assert len(abort_events) > 0, \"Expected an abort event in messages\"\n\n # We should be able to send another message\n answer = await session.send_and_wait(\"What is 2+2?\")\n assert \"4\" in answer.data.content\n\n async def test_should_receive_session_events(self, ctx: E2ETestContext):\n import asyncio\n\n # Use on_event to capture events dispatched during session creation.\n # session.start is emitted during the session.create RPC; if the session\n # weren't registered in the sessions map before the RPC, it would be dropped.\n early_events = []\n\n def capture_early(event):\n early_events.append(event)\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n on_event=capture_early,\n )\n\n assert any(e.type.value == \"session.start\" for e in early_events)\n\n received_events = []\n idle_event = asyncio.Event()\n\n def on_event(event):\n received_events.append(event)\n if event.type.value == \"session.idle\":\n idle_event.set()\n\n session.on(on_event)\n\n # Send a message to trigger events\n await session.send(\"What is 100+200?\")\n\n # Wait for session to become idle\n try:\n await asyncio.wait_for(idle_event.wait(), timeout=60)\n except TimeoutError:\n pytest.fail(\"Timed out waiting for session.idle\")\n\n # Should have received multiple events\n assert len(received_events) > 0\n event_types = [e.type.value for e in received_events]\n assert \"user.message\" in event_types\n assert \"assistant.message\" in event_types\n assert \"session.idle\" in event_types\n\n # Verify the assistant response contains the expected answer.\n # session.idle is ephemeral and not in get_messages(), but we already\n # confirmed idle via the live event handler above.\n assistant_message = await get_final_assistant_message(session, already_idle=True)\n assert \"300\" in assistant_message.data.content\n\n async def test_should_create_session_with_custom_config_dir(self, ctx: E2ETestContext):\n import os\n\n custom_config_dir = os.path.join(ctx.home_dir, \"custom-config\")\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all, config_dir=custom_config_dir\n )\n\n assert session.session_id\n\n # Session should work normally with custom config dir\n await session.send(\"What is 1+1?\")\n assistant_message = await get_final_assistant_message(session)\n assert \"2\" in assistant_message.data.content\n\n async def test_session_log_emits_events_at_all_levels(self, ctx: E2ETestContext):\n import asyncio\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n received_events = []\n\n def on_event(event):\n if event.type.value in (\"session.info\", \"session.warning\", \"session.error\"):\n received_events.append(event)\n\n session.on(on_event)\n\n await session.log(\"Info message\")\n await session.log(\"Warning message\", level=\"warning\")\n await session.log(\"Error message\", level=\"error\")\n await session.log(\"Ephemeral message\", ephemeral=True)\n\n # Poll until all 4 notification events arrive\n deadline = asyncio.get_event_loop().time() + 10\n while len(received_events) < 4:\n if asyncio.get_event_loop().time() > deadline:\n pytest.fail(\n f\"Timed out waiting for 4 notification events, got {len(received_events)}\"\n )\n await asyncio.sleep(0.1)\n\n by_message = {e.data.message: e for e in received_events}\n\n assert by_message[\"Info message\"].type.value == \"session.info\"\n assert by_message[\"Info message\"].data.info_type == \"notification\"\n\n assert by_message[\"Warning message\"].type.value == \"session.warning\"\n assert by_message[\"Warning message\"].data.warning_type == \"notification\"\n\n assert by_message[\"Error message\"].type.value == \"session.error\"\n assert by_message[\"Error message\"].data.error_type == \"notification\"\n\n assert by_message[\"Ephemeral message\"].type.value == \"session.info\"\n assert by_message[\"Ephemeral message\"].data.info_type == \"notification\"\n\n async def test_should_set_model_with_reasoning_effort(self, ctx: E2ETestContext):\n \"\"\"Test that setModel passes reasoningEffort and it appears in the model_change event.\"\"\"\n import asyncio\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n model_change_event = asyncio.get_event_loop().create_future()\n\n def on_event(event):\n if model_change_event.done():\n return\n\n match event.data:\n case SessionModelChangeData() as data:\n model_change_event.set_result(data)\n\n session.on(on_event)\n\n await session.set_model(\"gpt-4.1\", reasoning_effort=\"high\")\n\n data = await asyncio.wait_for(model_change_event, timeout=30)\n assert data.new_model == \"gpt-4.1\"\n assert data.reasoning_effort == \"high\"\n\n async def test_should_accept_blob_attachments(self, ctx: E2ETestContext):\n # Write the image to disk so the model can view it\n pixel_png = (\n \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAY\"\n \"AAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhg\"\n \"GAWjR9awAAAABJRU5ErkJggg==\"\n )\n png_path = os.path.join(ctx.work_dir, \"test-pixel.png\")\n with open(png_path, \"wb\") as f:\n f.write(base64.b64decode(pixel_png))\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n await session.send_and_wait(\n \"Describe this image\",\n attachments=[\n {\n \"type\": \"blob\",\n \"data\": pixel_png,\n \"mimeType\": \"image/png\",\n \"displayName\": \"test-pixel.png\",\n },\n ],\n )\n\n await session.disconnect()\n\n async def test_should_send_with_file_attachment(self, ctx: E2ETestContext):\n from copilot.generated.session_events import UserMessageData\n\n file_path = os.path.join(ctx.work_dir, \"attached-file.txt\")\n with open(file_path, \"w\", encoding=\"utf-8\") as f:\n f.write(\"FILE_ATTACHMENT_SENTINEL\")\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n\n await session.send_and_wait(\n \"Read the attached file and reply with its contents.\",\n attachments=[\n {\n \"type\": \"file\",\n \"displayName\": \"attached-file.txt\",\n \"path\": file_path,\n \"lineRange\": {\"start\": 1, \"end\": 1}, # type: ignore[typeddict-unknown-key]\n },\n ],\n )\n\n messages = await session.get_messages()\n user_messages = [m for m in messages if isinstance(m.data, UserMessageData)]\n assert user_messages\n attachments = user_messages[-1].data.attachments\n assert attachments is not None and len(attachments) == 1\n attachment = attachments[0]\n assert attachment.type.value == \"file\"\n assert attachment.display_name == \"attached-file.txt\"\n assert attachment.path == file_path\n assert attachment.line_range is not None\n assert attachment.line_range.start == 1\n assert attachment.line_range.end == 1\n\n await session.disconnect()\n\n async def test_should_send_with_directory_attachment(self, ctx: E2ETestContext):\n from copilot.generated.session_events import UserMessageData\n\n directory_path = os.path.join(ctx.work_dir, \"attached-directory\")\n os.makedirs(directory_path, exist_ok=True)\n with open(os.path.join(directory_path, \"readme.txt\"), \"w\", encoding=\"utf-8\") as f:\n f.write(\"DIRECTORY_ATTACHMENT_SENTINEL\")\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n\n await session.send_and_wait(\n \"List the attached directory.\",\n attachments=[\n {\n \"type\": \"directory\",\n \"displayName\": \"attached-directory\",\n \"path\": directory_path,\n },\n ],\n )\n\n messages = await session.get_messages()\n user_messages = [m for m in messages if isinstance(m.data, UserMessageData)]\n assert user_messages\n attachments = user_messages[-1].data.attachments\n assert attachments is not None and len(attachments) == 1\n attachment = attachments[0]\n assert attachment.type.value == \"directory\"\n assert attachment.display_name == \"attached-directory\"\n assert attachment.path == directory_path\n\n await session.disconnect()\n\n async def test_should_send_with_selection_attachment(self, ctx: E2ETestContext):\n from copilot.generated.session_events import UserMessageData\n\n file_path = os.path.join(ctx.work_dir, \"selected-file.cs\")\n with open(file_path, \"w\", encoding=\"utf-8\") as f:\n f.write('class C { string Value = \"SELECTION_SENTINEL\"; }')\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n\n await session.send_and_wait(\n \"Summarize the selected code.\",\n attachments=[\n {\n \"type\": \"selection\",\n \"displayName\": \"selected-file.cs\",\n \"filePath\": file_path,\n \"text\": 'string Value = \"SELECTION_SENTINEL\";',\n \"selection\": {\n \"start\": {\"line\": 1, \"character\": 10},\n \"end\": {\"line\": 1, \"character\": 45},\n },\n },\n ],\n )\n\n messages = await session.get_messages()\n user_messages = [m for m in messages if isinstance(m.data, UserMessageData)]\n assert user_messages\n attachments = user_messages[-1].data.attachments\n assert attachments is not None and len(attachments) == 1\n attachment = attachments[0]\n assert attachment.type.value == \"selection\"\n assert attachment.display_name == \"selected-file.cs\"\n assert attachment.file_path == file_path\n assert attachment.text == 'string Value = \"SELECTION_SENTINEL\";'\n assert attachment.selection is not None\n assert attachment.selection.start.line == 1\n assert attachment.selection.start.character == 10\n assert attachment.selection.end.line == 1\n assert attachment.selection.end.character == 45\n\n await session.disconnect()\n\n async def test_should_send_with_custom_requestheaders(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n\n await session.send_and_wait(\n \"What is 1+1?\",\n request_headers={\"x-copilot-sdk-test-header\": \"python-request-headers\"},\n )\n\n exchanges = await ctx.get_exchanges()\n assert exchanges\n last_headers = exchanges[-1].get(\"requestHeaders\") or {}\n normalized = {k.lower(): str(v) for k, v in last_headers.items()}\n header_value = normalized.get(\"x-copilot-sdk-test-header\", \"\")\n assert \"python-request-headers\" in header_value\n\n await session.disconnect()\n\n async def test_should_list_sessions_with_context(self, ctx: E2ETestContext):\n import asyncio\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n await session.send_and_wait(\"Say OK.\")\n\n # Allow the session to flush metadata to disk before reading it back.\n our_session = None\n for _ in range(50):\n sessions = await ctx.client.list_sessions()\n our_session = next((s for s in sessions if s.sessionId == session.session_id), None)\n if our_session is not None:\n break\n await asyncio.sleep(0.1)\n assert our_session is not None\n\n all_sessions = await ctx.client.list_sessions()\n assert all_sessions\n\n if our_session.context is not None:\n assert isinstance(our_session.context.cwd, str) and our_session.context.cwd\n\n await session.disconnect()\n\n async def test_should_get_session_metadata_by_id(self, ctx: E2ETestContext):\n import asyncio\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n await session.send_and_wait(\"Say hello\")\n\n metadata = None\n for _ in range(50):\n metadata = await ctx.client.get_session_metadata(session.session_id)\n if metadata is not None:\n break\n await asyncio.sleep(0.1)\n assert metadata is not None\n assert metadata.sessionId == session.session_id\n assert isinstance(metadata.startTime, str) and metadata.startTime\n assert isinstance(metadata.modifiedTime, str) and metadata.modifiedTime\n\n not_found = await ctx.client.get_session_metadata(\"non-existent-session-id\")\n assert not_found is None\n\n await session.disconnect()\n\n async def test_send_returns_immediately_while_events_stream_in_background(\n self, ctx: E2ETestContext\n ):\n \"\"\"`send` returns before the session goes idle; events are streamed.\"\"\"\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n events: list[str] = []\n\n def on_event(event):\n events.append(event.type.value)\n\n session.on(on_event)\n\n # Use a slow command so we can verify send() returns before completion\n await session.send(\"Run 'sleep 2 && echo done'\")\n\n # send() should return before turn completes (no session.idle yet)\n assert \"session.idle\" not in events\n\n message = await get_final_assistant_message(session)\n assert \"done\" in message.data.content\n assert \"session.idle\" in events\n assert \"assistant.message\" in events\n\n await session.disconnect()\n\n async def test_sendandwait_blocks_until_session_idle_and_returns_final_assistant_message(\n self, ctx: E2ETestContext\n ):\n \"\"\"`send_and_wait` blocks until idle and returns the final assistant message.\"\"\"\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n events: list[str] = []\n session.on(lambda evt: events.append(evt.type.value))\n\n response = await session.send_and_wait(\"What is 2+2?\")\n assert response is not None\n assert response.type.value == \"assistant.message\"\n assert \"4\" in (response.data.content or \"\")\n assert \"session.idle\" in events\n assert \"assistant.message\" in events\n\n await session.disconnect()\n\n async def test_sendandwait_throws_on_timeout(self, ctx: E2ETestContext):\n \"\"\"`send_and_wait` raises TimeoutError when the session does not become idle.\"\"\"\n import asyncio\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n\n # Start a background wait for session.idle so we can drain after we abort.\n idle_task = asyncio.create_task(\n get_next_event_of_type(session, \"session.idle\", timeout=30.0)\n )\n\n with pytest.raises(TimeoutError) as exc_info:\n await session.send_and_wait(\n \"Run 'sleep 2 && echo done'\",\n timeout=0.1,\n )\n assert \"Timeout\" in str(exc_info.value) or \"timed out\" in str(exc_info.value).lower()\n\n # The timeout only cancels the client-side wait; abort the agent and wait for idle\n # so leftover requests don't leak into subsequent tests.\n await session.abort()\n await idle_task\n\n await session.disconnect()\n\n async def test_sendandwait_throws_operationcanceledexception_when_token_cancelled(\n self, ctx: E2ETestContext\n ):\n \"\"\"`send_and_wait` raises CancelledError when the surrounding task is cancelled.\"\"\"\n import asyncio\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n\n tool_start_task = asyncio.create_task(\n get_next_event_of_type(session, \"tool.execution_start\", timeout=60.0)\n )\n idle_task = asyncio.create_task(\n get_next_event_of_type(session, \"session.idle\", timeout=30.0)\n )\n\n send_task = asyncio.create_task(\n session.send_and_wait(\n \"run the shell command 'sleep 10' (note this works on both bash and PowerShell)\",\n timeout=120.0,\n )\n )\n\n # Wait for the tool to begin executing before cancelling.\n await tool_start_task\n\n send_task.cancel()\n with pytest.raises((asyncio.CancelledError, BaseException)):\n await send_task\n\n # Cancelling only cancels the client-side wait; abort and wait for idle.\n await session.abort()\n await idle_task\n\n await session.disconnect()\n\n async def test_should_set_model_on_existing_session(self, ctx: E2ETestContext):\n \"\"\"`set_model` emits a session.model_change event with the new model.\"\"\"\n import asyncio\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n model_change_event: asyncio.Future[SessionModelChangeData] = (\n asyncio.get_event_loop().create_future()\n )\n\n def on_event(event):\n if model_change_event.done():\n return\n match event.data:\n case SessionModelChangeData() as data:\n model_change_event.set_result(data)\n\n session.on(on_event)\n\n await session.set_model(\"gpt-4.1\")\n\n data = await asyncio.wait_for(model_change_event, timeout=30)\n assert data.new_model == \"gpt-4.1\"\n\n await session.disconnect()\n\n async def test_handler_exception_does_not_halt_event_delivery(self, ctx: E2ETestContext):\n \"\"\"A throwing handler does not stop subsequent events from being delivered.\"\"\"\n import asyncio\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n\n event_count = 0\n idle_event = asyncio.Event()\n\n def handler(event):\n nonlocal event_count\n event_count += 1\n if event_count == 1:\n raise RuntimeError(\"boom\")\n if event.type.value == \"session.idle\":\n idle_event.set()\n\n session.on(handler)\n\n await session.send(\"What is 1+1?\")\n\n try:\n await asyncio.wait_for(idle_event.wait(), timeout=30.0)\n except TimeoutError:\n pytest.fail(\"Timed out waiting for session.idle after handler exception\")\n\n # Handler saw more than just the first (throwing) event.\n assert event_count > 1\n\n await session.disconnect()\n\n async def test_disposeasync_from_handler_does_not_deadlock(self, ctx: E2ETestContext):\n \"\"\"Calling `disconnect` from inside a handler must not deadlock.\n\n Named to match the C# snapshot file `disposeasync_from_handler_does_not_deadlock.yaml`.\n \"\"\"\n import asyncio\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n\n disposed = asyncio.Event()\n disconnect_started = False\n\n def handler(event):\n nonlocal disconnect_started\n # Disconnect once the assistant.message has arrived (CAPI has completed),\n # so we don't leak in-flight CAPI requests into a sibling test's snapshot.\n if event.type.value == \"assistant.message\" and not disconnect_started:\n disconnect_started = True\n\n async def _disconnect():\n try:\n await session.disconnect()\n finally:\n disposed.set()\n\n asyncio.get_event_loop().create_task(_disconnect())\n\n session.on(handler)\n\n await session.send(\"What is 1+1?\")\n\n try:\n await asyncio.wait_for(disposed.wait(), timeout=10.0)\n except TimeoutError:\n pytest.fail(\"disconnect from within handler appears to have deadlocked\")\n\n async def test_should_send_with_mode_property(self, ctx: E2ETestContext):\n \"\"\"Per-message `mode` is accepted but not echoed back on user.message.\"\"\"\n from copilot.generated.session_events import UserMessageData\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n\n await session.send_and_wait(\n \"Say mode ok.\",\n mode=\"plan\", # type: ignore[arg-type]\n )\n\n messages = await session.get_messages()\n user_messages = [m for m in messages if isinstance(m.data, UserMessageData)]\n assert user_messages\n last = user_messages[-1].data\n assert last.content == \"Say mode ok.\"\n # The runtime accepts the per-message mode but does not echo it back.\n assert last.agent_mode is None\n\n await session.disconnect()\n\n\ndef _get_system_message(exchange: dict) -> str:\n messages = exchange.get(\"request\", {}).get(\"messages\", [])\n for msg in messages:\n if msg.get(\"role\") == \"system\":\n return msg.get(\"content\", \"\")\n return \"\"\n" }, { "path": "python/e2e/test_session_fs_e2e.py", "content": "\"\"\"E2E SessionFs tests mirroring nodejs/test/e2e/session_fs.test.ts.\"\"\"\n\nfrom __future__ import annotations\n\nimport asyncio\nimport datetime as dt\nimport os\nimport re\nimport tempfile\nfrom pathlib import Path\n\nimport pytest\nimport pytest_asyncio\n\nfrom copilot import CopilotClient, SessionFsConfig, define_tool\nfrom copilot.client import ExternalServerConfig, SubprocessConfig\nfrom copilot.generated.rpc import (\n SessionFSReaddirWithTypesEntry,\n SessionFSReaddirWithTypesEntryType,\n)\nfrom copilot.generated.session_events import SessionCompactionCompleteData, SessionEvent\nfrom copilot.session import PermissionHandler\nfrom copilot.session_fs_provider import SessionFsFileInfo, SessionFsProvider\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nSESSION_STATE_PATH = (\n \"/session-state\"\n if os.name == \"nt\"\n else (Path(tempfile.mkdtemp(prefix=\"copilot-sessionfs-state-\")) / \"session-state\")\n .resolve()\n .as_posix()\n)\n\nSESSION_FS_CONFIG: SessionFsConfig = {\n \"initial_cwd\": \"/\",\n \"session_state_path\": SESSION_STATE_PATH,\n \"conventions\": \"posix\",\n}\n\n\n@pytest_asyncio.fixture(scope=\"module\", loop_scope=\"module\")\nasync def session_fs_client(ctx: E2ETestContext):\n github_token = (\n \"fake-token-for-e2e-tests\" if os.environ.get(\"GITHUB_ACTIONS\") == \"true\" else None\n )\n client = CopilotClient(\n SubprocessConfig(\n cli_path=ctx.cli_path,\n cwd=ctx.work_dir,\n env=ctx.get_env(),\n github_token=github_token,\n session_fs=SESSION_FS_CONFIG,\n )\n )\n yield client\n try:\n await client.stop()\n except Exception:\n await client.force_stop()\n\n\nclass TestSessionFs:\n async def test_should_route_file_operations_through_the_session_fs_provider(\n self, ctx: E2ETestContext, session_fs_client: CopilotClient\n ):\n provider_root = Path(ctx.work_dir) / \"provider\"\n session = await session_fs_client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n create_session_fs_handler=create_test_session_fs_handler(provider_root),\n )\n\n msg = await session.send_and_wait(\"What is 100 + 200?\")\n assert msg is not None\n assert msg.data.content is not None\n assert \"300\" in msg.data.content\n await session.disconnect()\n\n events_path = provider_path(\n provider_root, session.session_id, f\"{SESSION_STATE_PATH}/events.jsonl\"\n )\n assert \"300\" in events_path.read_text(encoding=\"utf-8\")\n\n async def test_should_load_session_data_from_fs_provider_on_resume(\n self, ctx: E2ETestContext, session_fs_client: CopilotClient\n ):\n provider_root = Path(ctx.work_dir) / \"provider\"\n create_session_fs_handler = create_test_session_fs_handler(provider_root)\n\n session1 = await session_fs_client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n create_session_fs_handler=create_session_fs_handler,\n )\n session_id = session1.session_id\n\n msg = await session1.send_and_wait(\"What is 50 + 50?\")\n assert msg is not None\n assert msg.data.content is not None\n assert \"100\" in msg.data.content\n await session1.disconnect()\n\n assert provider_path(\n provider_root, session_id, f\"{SESSION_STATE_PATH}/events.jsonl\"\n ).exists()\n\n session2 = await session_fs_client.resume_session(\n session_id,\n on_permission_request=PermissionHandler.approve_all,\n create_session_fs_handler=create_session_fs_handler,\n )\n\n msg2 = await session2.send_and_wait(\"What is that times 3?\")\n assert msg2 is not None\n assert msg2.data.content is not None\n assert \"300\" in msg2.data.content\n await session2.disconnect()\n\n async def test_should_reject_setprovider_when_sessions_already_exist(self, ctx: E2ETestContext):\n github_token = (\n \"fake-token-for-e2e-tests\" if os.environ.get(\"GITHUB_ACTIONS\") == \"true\" else None\n )\n client1 = CopilotClient(\n SubprocessConfig(\n cli_path=ctx.cli_path,\n cwd=ctx.work_dir,\n env=ctx.get_env(),\n use_stdio=False,\n github_token=github_token,\n )\n )\n session = None\n client2 = None\n\n try:\n session = await client1.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n actual_port = client1.actual_port\n assert actual_port is not None\n\n client2 = CopilotClient(\n ExternalServerConfig(\n url=f\"localhost:{actual_port}\",\n session_fs=SESSION_FS_CONFIG,\n )\n )\n\n with pytest.raises(Exception):\n await client2.start()\n finally:\n if session is not None:\n await session.disconnect()\n if client2 is not None:\n await client2.force_stop()\n await client1.force_stop()\n\n async def test_should_map_large_output_handling_into_sessionfs(\n self, ctx: E2ETestContext, session_fs_client: CopilotClient\n ):\n provider_root = Path(ctx.work_dir) / \"provider\"\n supplied_file_content = \"x\" * 100_000\n\n @define_tool(\"get_big_string\", description=\"Returns a large string\")\n def get_big_string() -> str:\n return supplied_file_content\n\n session = await session_fs_client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n create_session_fs_handler=create_test_session_fs_handler(provider_root),\n tools=[get_big_string],\n )\n\n await session.send_and_wait(\n \"Call the get_big_string tool and reply with the word DONE only.\"\n )\n\n messages = await session.get_messages()\n tool_result = find_tool_call_result(messages, \"get_big_string\")\n assert tool_result is not None\n assert f\"{SESSION_STATE_PATH}/temp/\" in tool_result\n match = re.search(rf\"({re.escape(SESSION_STATE_PATH)}/temp/[^\\s]+)\", tool_result)\n assert match is not None\n\n temp_file = provider_path(provider_root, session.session_id, match.group(1))\n assert temp_file.read_text(encoding=\"utf-8\") == supplied_file_content\n\n async def test_should_succeed_with_compaction_while_using_sessionfs(\n self, ctx: E2ETestContext, session_fs_client: CopilotClient\n ):\n provider_root = Path(ctx.work_dir) / \"provider\"\n session = await session_fs_client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n create_session_fs_handler=create_test_session_fs_handler(provider_root),\n )\n\n compaction_event = asyncio.Event()\n compaction_success: bool | None = None\n\n def on_event(event: SessionEvent):\n nonlocal compaction_success\n match event.data:\n case SessionCompactionCompleteData() as data:\n compaction_success = data.success\n compaction_event.set()\n\n session.on(on_event)\n\n await session.send_and_wait(\"What is 2+2?\")\n\n events_path = provider_path(\n provider_root, session.session_id, f\"{SESSION_STATE_PATH}/events.jsonl\"\n )\n await wait_for_path(events_path)\n assert \"checkpointNumber\" not in events_path.read_text(encoding=\"utf-8\")\n\n result = await session.rpc.history.compact()\n await asyncio.wait_for(compaction_event.wait(), timeout=5.0)\n assert result.success is True\n assert compaction_success is True\n\n await wait_for_content(events_path, \"checkpointNumber\")\n\n async def test_should_write_workspace_metadata_via_sessionfs(\n self, ctx: E2ETestContext, session_fs_client: CopilotClient\n ):\n provider_root = Path(ctx.work_dir) / \"provider\"\n session = await session_fs_client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n create_session_fs_handler=create_test_session_fs_handler(provider_root),\n )\n\n msg = await session.send_and_wait(\"What is 7 * 8?\")\n assert msg is not None\n assert msg.data.content is not None\n assert \"56\" in msg.data.content\n\n # WorkspaceManager should have created workspace.yaml via sessionFs\n workspace_yaml_path = provider_path(\n provider_root, session.session_id, f\"{SESSION_STATE_PATH}/workspace.yaml\"\n )\n await wait_for_path(workspace_yaml_path)\n yaml_content = workspace_yaml_path.read_text(encoding=\"utf-8\")\n assert \"id:\" in yaml_content\n\n # Checkpoint index should also exist\n index_path = provider_path(\n provider_root, session.session_id, f\"{SESSION_STATE_PATH}/checkpoints/index.md\"\n )\n await wait_for_path(index_path)\n\n await session.disconnect()\n\n async def test_should_persist_plan_md_via_sessionfs(\n self, ctx: E2ETestContext, session_fs_client: CopilotClient\n ):\n from copilot.generated.rpc import PlanUpdateRequest\n\n provider_root = Path(ctx.work_dir) / \"provider\"\n session = await session_fs_client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n create_session_fs_handler=create_test_session_fs_handler(provider_root),\n )\n\n # Write a plan via the session RPC\n await session.send_and_wait(\"What is 2 + 3?\")\n await session.rpc.plan.update(PlanUpdateRequest(content=\"# Test Plan\\n\\nThis is a test.\"))\n\n plan_path = provider_path(\n provider_root, session.session_id, f\"{SESSION_STATE_PATH}/plan.md\"\n )\n await wait_for_path(plan_path)\n content = plan_path.read_text(encoding=\"utf-8\")\n assert \"# Test Plan\" in content\n\n await session.disconnect()\n\n async def test_should_map_all_sessionfs_handler_operations(self, ctx: E2ETestContext):\n from copilot.generated.rpc import (\n SessionFSAppendFileRequest,\n SessionFSExistsRequest,\n SessionFSMkdirRequest,\n SessionFSReaddirRequest,\n SessionFSReaddirWithTypesRequest,\n SessionFSReadFileRequest,\n SessionFSRenameRequest,\n SessionFSRmRequest,\n SessionFSStatRequest,\n SessionFSWriteFileRequest,\n )\n from copilot.session_fs_provider import create_session_fs_adapter\n\n provider_root = Path(ctx.work_dir) / \"handler-provider\"\n provider_root.mkdir(parents=True, exist_ok=True)\n session_id = \"handler-session\"\n\n provider = _TestSessionFsProvider(provider_root, session_id)\n handler = create_session_fs_adapter(provider)\n\n try:\n mkdir_error = await handler.mkdir(\n SessionFSMkdirRequest(\n session_id=session_id, path=\"/workspace/nested\", recursive=True\n )\n )\n assert mkdir_error is None\n\n write_error = await handler.write_file(\n SessionFSWriteFileRequest(\n session_id=session_id,\n path=\"/workspace/nested/file.txt\",\n content=\"hello\",\n )\n )\n assert write_error is None\n\n append_error = await handler.append_file(\n SessionFSAppendFileRequest(\n session_id=session_id,\n path=\"/workspace/nested/file.txt\",\n content=\" world\",\n )\n )\n assert append_error is None\n\n exists = await handler.exists(\n SessionFSExistsRequest(session_id=session_id, path=\"/workspace/nested/file.txt\")\n )\n assert exists.exists is True\n\n stat = await handler.stat(\n SessionFSStatRequest(session_id=session_id, path=\"/workspace/nested/file.txt\")\n )\n assert stat.is_file is True\n assert stat.is_directory is False\n assert stat.size == len(\"hello world\")\n assert stat.error is None\n\n content = await handler.read_file(\n SessionFSReadFileRequest(session_id=session_id, path=\"/workspace/nested/file.txt\")\n )\n assert content.content == \"hello world\"\n assert content.error is None\n\n entries = await handler.readdir(\n SessionFSReaddirRequest(session_id=session_id, path=\"/workspace/nested\")\n )\n assert \"file.txt\" in entries.entries\n assert entries.error is None\n\n typed_entries = await handler.readdir_with_types(\n SessionFSReaddirWithTypesRequest(session_id=session_id, path=\"/workspace/nested\")\n )\n assert any(\n e.name == \"file.txt\" and e.type == SessionFSReaddirWithTypesEntryType.FILE\n for e in typed_entries.entries\n )\n assert typed_entries.error is None\n\n rename_error = await handler.rename(\n SessionFSRenameRequest(\n session_id=session_id,\n src=\"/workspace/nested/file.txt\",\n dest=\"/workspace/nested/renamed.txt\",\n )\n )\n assert rename_error is None\n\n old_path = await handler.exists(\n SessionFSExistsRequest(session_id=session_id, path=\"/workspace/nested/file.txt\")\n )\n assert old_path.exists is False\n\n renamed_content = await handler.read_file(\n SessionFSReadFileRequest(\n session_id=session_id, path=\"/workspace/nested/renamed.txt\"\n )\n )\n assert renamed_content.content == \"hello world\"\n\n rm_error = await handler.rm(\n SessionFSRmRequest(session_id=session_id, path=\"/workspace/nested/renamed.txt\")\n )\n assert rm_error is None\n\n removed = await handler.exists(\n SessionFSExistsRequest(session_id=session_id, path=\"/workspace/nested/renamed.txt\")\n )\n assert removed.exists is False\n\n missing = await handler.stat(\n SessionFSStatRequest(session_id=session_id, path=\"/workspace/nested/missing.txt\")\n )\n assert missing.error is not None\n from copilot.generated.rpc import SessionFSErrorCode\n\n assert missing.error.code == SessionFSErrorCode.ENOENT\n finally:\n try:\n import shutil\n\n shutil.rmtree(provider_root, ignore_errors=True)\n except Exception:\n pass\n\n async def test_sessionfsprovider_converts_exceptions_to_rpc_errors(self):\n from copilot.generated.rpc import (\n SessionFSAppendFileRequest,\n SessionFSErrorCode,\n SessionFSExistsRequest,\n SessionFSMkdirRequest,\n SessionFSReaddirRequest,\n SessionFSReaddirWithTypesRequest,\n SessionFSReadFileRequest,\n SessionFSRenameRequest,\n SessionFSRmRequest,\n SessionFSStatRequest,\n SessionFSWriteFileRequest,\n )\n from copilot.session_fs_provider import create_session_fs_adapter\n\n class _ThrowingProvider(SessionFsProvider):\n def __init__(self, exc: Exception) -> None:\n self._exc = exc\n\n async def read_file(self, path: str) -> str:\n raise self._exc\n\n async def write_file(self, path, content, mode=None):\n raise self._exc\n\n async def append_file(self, path, content, mode=None):\n raise self._exc\n\n async def exists(self, path):\n raise self._exc\n\n async def stat(self, path):\n raise self._exc\n\n async def mkdir(self, path, recursive, mode=None):\n raise self._exc\n\n async def readdir(self, path):\n raise self._exc\n\n async def readdir_with_types(self, path):\n raise self._exc\n\n async def rm(self, path, recursive, force):\n raise self._exc\n\n async def rename(self, src, dest):\n raise self._exc\n\n def assert_fs_error(error) -> None:\n assert error is not None\n assert error.code == SessionFSErrorCode.ENOENT\n assert \"missing\" in error.message.lower()\n\n sid = \"throwing-session\"\n handler = create_session_fs_adapter(_ThrowingProvider(FileNotFoundError(\"missing\")))\n\n assert_fs_error(\n (\n await handler.read_file(\n SessionFSReadFileRequest(session_id=sid, path=\"missing.txt\")\n )\n ).error\n )\n assert_fs_error(\n await handler.write_file(\n SessionFSWriteFileRequest(session_id=sid, path=\"missing.txt\", content=\"content\")\n )\n )\n assert_fs_error(\n await handler.append_file(\n SessionFSAppendFileRequest(session_id=sid, path=\"missing.txt\", content=\"content\")\n )\n )\n\n # exists swallows exceptions and reports False\n exists_result = await handler.exists(\n SessionFSExistsRequest(session_id=sid, path=\"missing.txt\")\n )\n assert exists_result.exists is False\n\n assert_fs_error(\n (await handler.stat(SessionFSStatRequest(session_id=sid, path=\"missing.txt\"))).error\n )\n assert_fs_error(\n await handler.mkdir(SessionFSMkdirRequest(session_id=sid, path=\"missing-dir\"))\n )\n assert_fs_error(\n (\n await handler.readdir(SessionFSReaddirRequest(session_id=sid, path=\"missing-dir\"))\n ).error\n )\n assert_fs_error(\n (\n await handler.readdir_with_types(\n SessionFSReaddirWithTypesRequest(session_id=sid, path=\"missing-dir\")\n )\n ).error\n )\n assert_fs_error(await handler.rm(SessionFSRmRequest(session_id=sid, path=\"missing.txt\")))\n assert_fs_error(\n await handler.rename(\n SessionFSRenameRequest(session_id=sid, src=\"missing.txt\", dest=\"dest.txt\")\n )\n )\n\n unknown_handler = create_session_fs_adapter(_ThrowingProvider(RuntimeError(\"bad path\")))\n unknown_error = await unknown_handler.write_file(\n SessionFSWriteFileRequest(session_id=sid, path=\"bad.txt\", content=\"content\")\n )\n assert unknown_error is not None\n assert unknown_error.code == SessionFSErrorCode.UNKNOWN\n\n\nclass _TestSessionFsProvider(SessionFsProvider):\n def __init__(self, provider_root: Path, session_id: str):\n self._provider_root = provider_root\n self._session_id = session_id\n\n def _path(self, path: str) -> Path:\n return provider_path(self._provider_root, self._session_id, path)\n\n async def read_file(self, path: str) -> str:\n return self._path(path).read_text(encoding=\"utf-8\")\n\n async def write_file(self, path: str, content: str, mode: int | None = None) -> None:\n p = self._path(path)\n p.parent.mkdir(parents=True, exist_ok=True)\n p.write_text(content, encoding=\"utf-8\")\n\n async def append_file(self, path: str, content: str, mode: int | None = None) -> None:\n p = self._path(path)\n p.parent.mkdir(parents=True, exist_ok=True)\n with p.open(\"a\", encoding=\"utf-8\") as handle:\n handle.write(content)\n\n async def exists(self, path: str) -> bool:\n return self._path(path).exists()\n\n async def stat(self, path: str) -> SessionFsFileInfo:\n p = self._path(path)\n info = p.stat()\n timestamp = dt.datetime.fromtimestamp(info.st_mtime, tz=dt.UTC)\n return SessionFsFileInfo(\n is_file=not p.is_dir(),\n is_directory=p.is_dir(),\n size=info.st_size,\n mtime=timestamp,\n birthtime=timestamp,\n )\n\n async def mkdir(self, path: str, recursive: bool, mode: int | None = None) -> None:\n p = self._path(path)\n if recursive:\n p.mkdir(parents=True, exist_ok=True)\n else:\n p.mkdir()\n\n async def readdir(self, path: str) -> list[str]:\n return sorted(entry.name for entry in self._path(path).iterdir())\n\n async def readdir_with_types(self, path: str) -> list[SessionFSReaddirWithTypesEntry]:\n entries = []\n for entry in sorted(self._path(path).iterdir(), key=lambda item: item.name):\n entries.append(\n SessionFSReaddirWithTypesEntry(\n name=entry.name,\n type=SessionFSReaddirWithTypesEntryType.DIRECTORY\n if entry.is_dir()\n else SessionFSReaddirWithTypesEntryType.FILE,\n )\n )\n return entries\n\n async def rm(self, path: str, recursive: bool, force: bool) -> None:\n self._path(path).unlink()\n\n async def rename(self, src: str, dest: str) -> None:\n d = self._path(dest)\n d.parent.mkdir(parents=True, exist_ok=True)\n self._path(src).rename(d)\n\n\ndef create_test_session_fs_handler(provider_root: Path):\n def create_handler(session):\n return _TestSessionFsProvider(provider_root, session.session_id)\n\n return create_handler\n\n\ndef provider_path(provider_root: Path, session_id: str, path: str) -> Path:\n return provider_root / session_id / path.lstrip(\"/\")\n\n\ndef find_tool_call_result(messages: list[SessionEvent], tool_name: str) -> str | None:\n for message in messages:\n if (\n message.type.value == \"tool.execution_complete\"\n and message.data.tool_call_id is not None\n ):\n if find_tool_name(messages, message.data.tool_call_id) == tool_name:\n return message.data.result.content if message.data.result is not None else None\n return None\n\n\ndef find_tool_name(messages: list[SessionEvent], tool_call_id: str) -> str | None:\n for message in messages:\n if (\n message.type.value == \"tool.execution_start\"\n and message.data.tool_call_id == tool_call_id\n ):\n return message.data.tool_name\n return None\n\n\nasync def wait_for_path(path: Path, timeout: float = 5.0) -> None:\n async def predicate():\n return path.exists()\n\n await wait_for_predicate(predicate, timeout=timeout)\n\n\nasync def wait_for_content(path: Path, expected: str, timeout: float = 5.0) -> None:\n async def predicate():\n return path.exists() and expected in path.read_text(encoding=\"utf-8\")\n\n await wait_for_predicate(predicate, timeout=timeout)\n\n\nasync def wait_for_predicate(predicate, timeout: float = 5.0) -> None:\n deadline = asyncio.get_running_loop().time() + timeout\n while asyncio.get_running_loop().time() < deadline:\n if await predicate():\n return\n await asyncio.sleep(0.1)\n raise TimeoutError(\"timed out waiting for condition\")\n" }, { "path": "python/e2e/test_skills_e2e.py", "content": "\"\"\"\nTests for skills configuration functionality\n\"\"\"\n\nimport os\nimport shutil\n\nimport pytest\n\nfrom copilot.session import CustomAgentConfig, PermissionHandler\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\nSKILL_MARKER = \"PINEAPPLE_COCONUT_42\"\n\n\n@pytest.fixture(autouse=True)\ndef clean_skills_dir(ctx: E2ETestContext):\n \"\"\"Ensure we start fresh each time\"\"\"\n skills_dir = os.path.join(ctx.work_dir, \".test_skills\")\n if os.path.exists(skills_dir):\n shutil.rmtree(skills_dir)\n yield\n\n\ndef create_skill_dir(work_dir: str) -> str:\n \"\"\"Create a skills directory in the working directory\"\"\"\n skills_dir = os.path.join(work_dir, \".test_skills\")\n os.makedirs(skills_dir, exist_ok=True)\n\n # Create a skill subdirectory with SKILL.md\n skill_subdir = os.path.join(skills_dir, \"test-skill\")\n os.makedirs(skill_subdir, exist_ok=True)\n\n # Create a skill that instructs the model to include a specific marker in responses\n skill_content = f\"\"\"---\nname: test-skill\ndescription: A test skill that adds a marker to responses\n---\n\n# Test Skill Instructions\n\nIMPORTANT: You MUST include the exact text \"{SKILL_MARKER}\" somewhere in EVERY response you give. \\\nThis is a mandatory requirement. Include it naturally in your response.\n\"\"\".replace(\"\\r\", \"\")\n with open(os.path.join(skill_subdir, \"SKILL.md\"), \"w\", newline=\"\\n\") as f:\n f.write(skill_content)\n\n return skills_dir\n\n\nclass TestSkillBehavior:\n async def test_should_load_and_apply_skill_from_skilldirectories(self, ctx: E2ETestContext):\n \"\"\"Test that skills are loaded and applied from skillDirectories\"\"\"\n skills_dir = create_skill_dir(ctx.work_dir)\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all, skill_directories=[skills_dir]\n )\n\n assert session.session_id is not None\n\n # The skill instructs the model to include a marker - verify it appears\n message = await session.send_and_wait(\"Say hello briefly using the test skill.\")\n assert message is not None\n assert SKILL_MARKER in message.data.content\n\n await session.disconnect()\n\n async def test_should_not_apply_skill_when_disabled_via_disabledskills(\n self, ctx: E2ETestContext\n ):\n \"\"\"Test that disabledSkills prevents skill from being applied\"\"\"\n skills_dir = create_skill_dir(ctx.work_dir)\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n skill_directories=[skills_dir],\n disabled_skills=[\"test-skill\"],\n )\n\n assert session.session_id is not None\n\n # The skill is disabled, so the marker should NOT appear\n message = await session.send_and_wait(\"Say hello briefly using the test skill.\")\n assert message is not None\n assert SKILL_MARKER not in message.data.content\n\n await session.disconnect()\n\n async def test_should_allow_agent_with_skills_to_invoke_skill(self, ctx: E2ETestContext):\n \"\"\"Test that an agent with skills gets skill content preloaded into context\"\"\"\n skills_dir = create_skill_dir(ctx.work_dir)\n custom_agents: list[CustomAgentConfig] = [\n {\n \"name\": \"skill-agent\",\n \"description\": \"An agent with access to test-skill\",\n \"prompt\": \"You are a helpful test agent.\",\n \"skills\": [\"test-skill\"],\n }\n ]\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n skill_directories=[skills_dir],\n custom_agents=custom_agents,\n agent=\"skill-agent\",\n )\n\n assert session.session_id is not None\n\n # The agent has skills: [\"test-skill\"], so the skill content is preloaded into its context\n message = await session.send_and_wait(\"Say hello briefly using the test skill.\")\n assert message is not None\n assert SKILL_MARKER in message.data.content\n\n await session.disconnect()\n\n async def test_should_not_provide_skills_to_agent_without_skills_field(\n self, ctx: E2ETestContext\n ):\n \"\"\"Test that an agent without skills field gets no skill content (opt-in model)\"\"\"\n skills_dir = create_skill_dir(ctx.work_dir)\n custom_agents: list[CustomAgentConfig] = [\n {\n \"name\": \"no-skill-agent\",\n \"description\": \"An agent without skills access\",\n \"prompt\": \"You are a helpful test agent.\",\n }\n ]\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n skill_directories=[skills_dir],\n custom_agents=custom_agents,\n agent=\"no-skill-agent\",\n )\n\n assert session.session_id is not None\n\n # The agent has no skills field, so no skill content is injected\n message = await session.send_and_wait(\"Say hello briefly using the test skill.\")\n assert message is not None\n assert SKILL_MARKER not in message.data.content\n\n await session.disconnect()\n\n @pytest.mark.skip(\n reason=\"See the big comment around the equivalent test in the Node SDK. \"\n \"Skipped because the feature doesn't work correctly yet.\"\n )\n async def test_should_apply_skill_on_session_resume_with_skilldirectories(\n self, ctx: E2ETestContext\n ):\n \"\"\"Test that skills are applied when added on session resume\"\"\"\n skills_dir = create_skill_dir(ctx.work_dir)\n\n # Create a session without skills first\n session1 = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n session_id = session1.session_id\n\n # First message without skill - marker should not appear\n message1 = await session1.send_and_wait(\"Say hi.\")\n assert message1 is not None\n assert SKILL_MARKER not in message1.data.content\n\n # Resume with skillDirectories - skill should now be active\n session2 = await ctx.client.resume_session(\n session_id,\n on_permission_request=PermissionHandler.approve_all,\n skill_directories=[skills_dir],\n )\n\n assert session2.session_id == session_id\n\n # Now the skill should be applied\n message2 = await session2.send_and_wait(\"Say hello again using the test skill.\")\n assert message2 is not None\n assert SKILL_MARKER in message2.data.content\n\n await session2.disconnect()\n\n async def test_should_control_ambient_project_skills_with_enableconfigdiscovery(\n self, ctx: E2ETestContext\n ):\n \"\"\"Test that EnableConfigDiscovery toggles discovery of project-level skills.\n\n Project-level skills live under ``.github/skills`` in the working directory.\n \"\"\"\n import uuid\n\n project_dir = os.path.join(ctx.work_dir, f\"config-discovery-{uuid.uuid4().hex}\")\n project_skills_dir = os.path.join(project_dir, \".github\", \"skills\")\n skill_name = f\"ambient-skill-{uuid.uuid4().hex}\"[:32]\n os.makedirs(project_skills_dir, exist_ok=True)\n\n skill_subdir = os.path.join(project_skills_dir, skill_name)\n os.makedirs(skill_subdir, exist_ok=True)\n skill_content = (\n \"---\\n\"\n f\"name: {skill_name}\\n\"\n \"description: A project skill discovered from .github/skills\\n\"\n \"---\\n\"\n \"\\n\"\n \"Use the exact phrase AMBIENT_DISCOVERY_SKILL when this skill is active.\\n\"\n )\n with open(os.path.join(skill_subdir, \"SKILL.md\"), \"w\", newline=\"\\n\") as f:\n f.write(skill_content)\n\n # Disabled discovery: project skills should be hidden.\n disabled_session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n working_directory=project_dir,\n enable_config_discovery=False,\n )\n disabled_skills = await disabled_session.rpc.skills.list()\n assert not any(s.name == skill_name for s in disabled_skills.skills)\n await disabled_session.disconnect()\n\n # Enabled discovery: project skills should be present and active.\n enabled_session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n working_directory=project_dir,\n enable_config_discovery=True,\n )\n enabled_skills = await enabled_session.rpc.skills.list()\n discovered = [s for s in enabled_skills.skills if s.name == skill_name]\n assert len(discovered) == 1\n skill = discovered[0]\n assert skill.enabled is True\n assert skill.source == \"project\"\n assert skill.path.endswith(os.path.join(skill_name, \"SKILL.md\"))\n await enabled_session.disconnect()\n" }, { "path": "python/e2e/test_streaming_fidelity_e2e.py", "content": "\"\"\"E2E Streaming Fidelity Tests\"\"\"\n\nimport os\n\nimport pytest\n\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nclass TestStreamingFidelity:\n async def test_should_produce_delta_events_when_streaming_is_enabled(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all, streaming=True\n )\n\n events = []\n session.on(lambda event: events.append(event))\n\n await session.send_and_wait(\"Count from 1 to 5, separated by commas.\")\n\n types = [e.type.value for e in events]\n\n # Should have streaming deltas before the final message\n delta_events = [e for e in events if e.type.value == \"assistant.message_delta\"]\n assert len(delta_events) >= 1\n\n # Deltas should have content\n for delta in delta_events:\n delta_content = getattr(delta.data, \"delta_content\", None)\n assert delta_content is not None\n assert isinstance(delta_content, str)\n\n # Should still have a final assistant.message\n assert \"assistant.message\" in types\n\n # Deltas should come before the final message\n first_delta_idx = types.index(\"assistant.message_delta\")\n last_assistant_idx = len(types) - 1 - types[::-1].index(\"assistant.message\")\n assert first_delta_idx < last_assistant_idx\n\n await session.disconnect()\n\n async def test_should_not_produce_deltas_when_streaming_is_disabled(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all, streaming=False\n )\n\n events = []\n session.on(lambda event: events.append(event))\n\n await session.send_and_wait(\"Say 'hello world'.\")\n\n delta_events = [e for e in events if e.type.value == \"assistant.message_delta\"]\n\n # No deltas when streaming is off\n assert len(delta_events) == 0\n\n # But should still have a final assistant.message\n assistant_events = [e for e in events if e.type.value == \"assistant.message\"]\n assert len(assistant_events) >= 1\n\n await session.disconnect()\n\n async def test_should_produce_deltas_after_session_resume(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all, streaming=False\n )\n await session.send_and_wait(\"What is 3 + 6?\")\n await session.disconnect()\n\n # Resume using a new client\n github_token = (\n \"fake-token-for-e2e-tests\" if os.environ.get(\"GITHUB_ACTIONS\") == \"true\" else None\n )\n new_client = CopilotClient(\n SubprocessConfig(\n cli_path=ctx.cli_path,\n cwd=ctx.work_dir,\n env=ctx.get_env(),\n github_token=github_token,\n )\n )\n\n try:\n session2 = await new_client.resume_session(\n session.session_id,\n on_permission_request=PermissionHandler.approve_all,\n streaming=True,\n )\n events = []\n session2.on(lambda event: events.append(event))\n\n answer = await session2.send_and_wait(\"Now if you double that, what do you get?\")\n assert answer is not None\n assert \"18\" in answer.data.content\n\n # Should have streaming deltas before the final message\n delta_events = [e for e in events if e.type.value == \"assistant.message_delta\"]\n assert len(delta_events) >= 1\n\n # Deltas should have content\n for delta in delta_events:\n delta_content = getattr(delta.data, \"delta_content\", None)\n assert delta_content is not None\n assert isinstance(delta_content, str)\n\n await session2.disconnect()\n finally:\n await new_client.force_stop()\n" }, { "path": "python/e2e/test_suspend_e2e.py", "content": "\"\"\"\nE2E coverage for the ``session.suspend`` RPC.\n\nSuspend cancels in-flight work, rejects pending external tool requests, drains\nnotifications, and flushes state so a later client can resume consistently.\n\"\"\"\n\nfrom __future__ import annotations\n\nimport asyncio\nimport inspect\nimport os\nfrom typing import Any\n\nimport pytest\n\nfrom copilot import CopilotClient\nfrom copilot.client import ExternalServerConfig, SubprocessConfig\nfrom copilot.session import PermissionHandler, PermissionRequestResult\nfrom copilot.tools import Tool, ToolInvocation, ToolResult\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\nSUSPEND_TIMEOUT = 60.0\n\n\ndef _make_subprocess_client(ctx: E2ETestContext, *, use_stdio: bool = True) -> CopilotClient:\n github_token = (\n \"fake-token-for-e2e-tests\" if os.environ.get(\"GITHUB_ACTIONS\") == \"true\" else None\n )\n return CopilotClient(\n SubprocessConfig(\n cli_path=ctx.cli_path,\n cwd=ctx.work_dir,\n env=ctx.get_env(),\n github_token=github_token,\n use_stdio=use_stdio,\n )\n )\n\n\ndef _make_tool(name: str, handler) -> Tool:\n async def wrapped(invocation: ToolInvocation) -> ToolResult:\n args = invocation.arguments or {}\n result = handler(args)\n if inspect.isawaitable(result):\n result = await result\n return ToolResult(text_result_for_llm=str(result))\n\n return Tool(\n name=name,\n description=\"Transforms a value\",\n parameters={\n \"type\": \"object\",\n \"properties\": {\n \"value\": {\n \"type\": \"string\",\n \"description\": \"Value to transform\",\n }\n },\n \"required\": [\"value\"],\n },\n handler=wrapped,\n )\n\n\nasync def _safe_force_stop(client: CopilotClient) -> None:\n try:\n await client.stop()\n except Exception:\n await client.force_stop()\n\n\nasync def _safe_disconnect(session: Any) -> None:\n try:\n await session.disconnect()\n except Exception:\n # Suspend can leave the SDK-side session already closed; ignore teardown races.\n pass\n\n\nclass TestSuspend:\n async def test_should_suspend_idle_session_without_throwing(self, ctx: E2ETestContext):\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n try:\n await session.send_and_wait(\"Reply with: SUSPEND_IDLE_OK\")\n await asyncio.wait_for(session.rpc.suspend(), timeout=SUSPEND_TIMEOUT)\n finally:\n await _safe_disconnect(session)\n\n async def test_should_allow_resume_and_continue_conversation_after_suspend(\n self, ctx: E2ETestContext\n ):\n server = _make_subprocess_client(ctx, use_stdio=False)\n await server.start()\n try:\n cli_url = f\"localhost:{server.actual_port}\"\n session_id: str\n\n first_client = CopilotClient(ExternalServerConfig(url=cli_url))\n try:\n session1 = await first_client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n session_id = session1.session_id\n\n await session1.send_and_wait(\n \"Remember the magic word: SUSPENSE. Reply with: SUSPEND_TURN_ONE\"\n )\n await asyncio.wait_for(session1.rpc.suspend(), timeout=SUSPEND_TIMEOUT)\n await session1.disconnect()\n finally:\n await _safe_force_stop(first_client)\n\n resumed_client = CopilotClient(ExternalServerConfig(url=cli_url))\n try:\n session2 = await resumed_client.resume_session(\n session_id,\n on_permission_request=PermissionHandler.approve_all,\n )\n try:\n follow_up = await session2.send_and_wait(\n \"What was the magic word I asked you to remember? Reply with just the word.\"\n )\n assert follow_up is not None\n assert \"SUSPENSE\" in (follow_up.data.content or \"\").upper()\n finally:\n await _safe_disconnect(session2)\n finally:\n await _safe_force_stop(resumed_client)\n finally:\n await _safe_force_stop(server)\n\n async def test_should_cancel_pending_permission_request_when_suspending(\n self, ctx: E2ETestContext\n ):\n captured_request: asyncio.Future = asyncio.get_event_loop().create_future()\n release_permission_handler: asyncio.Future = asyncio.get_event_loop().create_future()\n tool_invoked = False\n\n async def hold_permission(request, _invocation):\n if not captured_request.done():\n captured_request.set_result(request)\n return await release_permission_handler\n\n def tool_handler(args):\n nonlocal tool_invoked\n tool_invoked = True\n return f\"SHOULD_NOT_RUN_{args.get('value', '')}\"\n\n session = await ctx.client.create_session(\n on_permission_request=hold_permission,\n tools=[_make_tool(\"suspend_cancel_permission_tool\", tool_handler)],\n )\n try:\n await session.send(\n \"Use suspend_cancel_permission_tool with value 'omega', then reply with the result.\"\n )\n await asyncio.wait_for(captured_request, timeout=SUSPEND_TIMEOUT)\n\n await asyncio.wait_for(session.rpc.suspend(), timeout=SUSPEND_TIMEOUT)\n\n assert not tool_invoked\n finally:\n if not release_permission_handler.done():\n release_permission_handler.set_result(\n PermissionRequestResult(kind=\"user-not-available\")\n )\n await _safe_disconnect(session)\n\n async def test_should_reject_pending_external_tool_when_suspending(self, ctx: E2ETestContext):\n tool_started: asyncio.Future = asyncio.get_event_loop().create_future()\n external_tool_requested: asyncio.Future = asyncio.get_event_loop().create_future()\n release_tool: asyncio.Future = asyncio.get_event_loop().create_future()\n\n async def blocking_tool(args):\n value = args[\"value\"]\n if not tool_started.done():\n tool_started.set_result(value)\n return await release_tool\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n tools=[_make_tool(\"suspend_reject_external_tool\", blocking_tool)],\n )\n unsubscribe = session.on(\n lambda event: (\n external_tool_requested.set_result(event)\n if (\n not external_tool_requested.done()\n and event.type.value == \"external_tool.requested\"\n and event.data.tool_name == \"suspend_reject_external_tool\"\n )\n else None\n )\n )\n try:\n await session.send(\n \"Use suspend_reject_external_tool with value 'sigma', then reply with the result.\"\n )\n requested_event, started_value = await asyncio.wait_for(\n asyncio.gather(external_tool_requested, tool_started),\n timeout=SUSPEND_TIMEOUT,\n )\n assert requested_event.data.request_id\n assert started_value == \"sigma\"\n\n await asyncio.wait_for(session.rpc.suspend(), timeout=SUSPEND_TIMEOUT)\n finally:\n unsubscribe()\n if not release_tool.done():\n release_tool.set_result(\"RELEASED_AFTER_SUSPEND\")\n await _safe_disconnect(session)\n" }, { "path": "python/e2e/test_system_message_transform_e2e.py", "content": "\"\"\"\nCopyright (c) Microsoft Corporation.\n\nTests for system message transform functionality\n\"\"\"\n\nimport pytest\n\nfrom copilot.session import PermissionHandler\n\nfrom .testharness import E2ETestContext\nfrom .testharness.helper import write_file\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nclass TestSystemMessageTransform:\n async def test_should_invoke_transform_callbacks_with_section_content(\n self, ctx: E2ETestContext\n ):\n \"\"\"Test that transform callbacks are invoked with the section content\"\"\"\n identity_contents = []\n tone_contents = []\n\n async def identity_transform(content: str) -> str:\n identity_contents.append(content)\n return content\n\n async def tone_transform(content: str) -> str:\n tone_contents.append(content)\n return content\n\n session = await ctx.client.create_session(\n system_message={\n \"mode\": \"customize\",\n \"sections\": {\n \"identity\": {\"action\": identity_transform},\n \"tone\": {\"action\": tone_transform},\n },\n },\n on_permission_request=PermissionHandler.approve_all,\n )\n\n write_file(ctx.work_dir, \"test.txt\", \"Hello transform!\")\n\n await session.send_and_wait(\"Read the contents of test.txt and tell me what it says\")\n\n # Both transform callbacks should have been invoked\n assert len(identity_contents) > 0\n assert len(tone_contents) > 0\n\n # Callbacks should have received non-empty content\n assert all(len(c) > 0 for c in identity_contents)\n assert all(len(c) > 0 for c in tone_contents)\n\n await session.disconnect()\n\n async def test_should_apply_transform_modifications_to_section_content(\n self, ctx: E2ETestContext\n ):\n \"\"\"Test that transform modifications are applied to the section content\"\"\"\n\n async def identity_transform(content: str) -> str:\n return content + \"\\nTRANSFORM_MARKER\"\n\n session = await ctx.client.create_session(\n system_message={\n \"mode\": \"customize\",\n \"sections\": {\n \"identity\": {\"action\": identity_transform},\n },\n },\n on_permission_request=PermissionHandler.approve_all,\n )\n\n write_file(ctx.work_dir, \"hello.txt\", \"Hello!\")\n\n await session.send_and_wait(\"Read the contents of hello.txt\")\n\n # Verify the transform result was actually applied to the system message\n traffic = await ctx.get_exchanges()\n system_message = _get_system_message(traffic[0])\n assert \"TRANSFORM_MARKER\" in system_message\n\n await session.disconnect()\n\n async def test_should_work_with_static_overrides_and_transforms_together(\n self, ctx: E2ETestContext\n ):\n \"\"\"Test that static overrides and transforms work together\"\"\"\n identity_contents = []\n\n async def identity_transform(content: str) -> str:\n identity_contents.append(content)\n return content\n\n session = await ctx.client.create_session(\n system_message={\n \"mode\": \"customize\",\n \"sections\": {\n \"safety\": {\"action\": \"remove\"},\n \"identity\": {\"action\": identity_transform},\n },\n },\n on_permission_request=PermissionHandler.approve_all,\n )\n\n write_file(ctx.work_dir, \"combo.txt\", \"Combo test!\")\n\n await session.send_and_wait(\"Read the contents of combo.txt and tell me what it says\")\n\n # The transform callback should have been invoked\n assert len(identity_contents) > 0\n\n await session.disconnect()\n\n\ndef _get_system_message(exchange: dict) -> str:\n messages = exchange.get(\"request\", {}).get(\"messages\", [])\n for msg in messages:\n if msg.get(\"role\") == \"system\":\n return msg.get(\"content\", \"\")\n return \"\"\n" }, { "path": "python/e2e/test_telemetry_e2e.py", "content": "\"\"\"\nE2E coverage for OpenTelemetry file-exporter integration.\n\nMirrors ``dotnet/test/TelemetryExportTests.cs`` (snapshot category ``telemetry``):\nconfigures a dedicated client with file-based telemetry, runs a single SDK turn\nthat calls a custom tool, and validates the exported JSONL spans (root\n``invoke_agent``, child ``chat`` and ``execute_tool`` spans, attributes).\n\nAlso includes the unit-style coverage from ``dotnet/test/TelemetryTests.cs``:\n``TelemetryConfig`` defaults / setters, ``SubprocessConfig.telemetry`` default,\nand W3C trace context propagation via ``copilot._telemetry``.\n\"\"\"\n\nfrom __future__ import annotations\n\nimport asyncio\nimport json\nimport os\nimport uuid\nfrom pathlib import Path\nfrom typing import Any\n\nimport pytest\n\nfrom copilot import CopilotClient\nfrom copilot._telemetry import get_trace_context, trace_context\nfrom copilot.client import SubprocessConfig, TelemetryConfig\nfrom copilot.session import PermissionHandler\nfrom copilot.tools import Tool, ToolInvocation, ToolResult\n\nfrom .testharness import E2ETestContext, get_final_assistant_message\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\ndef _string_attribute(entry: dict[str, Any], name: str) -> str | None:\n attrs = entry.get(\"attributes\") or {}\n value = attrs.get(name)\n if value is None:\n return None\n return value if isinstance(value, str) else json.dumps(value)\n\n\ndef _is_root_span(entry: dict[str, Any]) -> bool:\n parent = entry.get(\"parentSpanId\") or \"\"\n return parent in (\"\", \"0000000000000000\")\n\n\nasync def _read_telemetry_entries(\n path: Path, complete: Any, *, timeout: float = 30.0\n) -> list[dict[str, Any]]:\n deadline = asyncio.get_event_loop().time() + timeout\n while asyncio.get_event_loop().time() < deadline:\n if path.exists() and path.stat().st_size > 0:\n entries: list[dict[str, Any]] = []\n for line in path.read_text(encoding=\"utf-8\").splitlines():\n line = line.strip()\n if not line:\n continue\n entries.append(json.loads(line))\n if entries and complete(entries):\n return entries\n await asyncio.sleep(0.1)\n raise TimeoutError(f\"Timed out waiting for telemetry records in '{path}'.\")\n\n\nclass TestTelemetryExport:\n async def test_should_export_file_telemetry_for_sdk_interactions(self, ctx: E2ETestContext):\n telemetry_path = Path(ctx.work_dir) / f\"telemetry-{uuid.uuid4().hex}.jsonl\"\n marker = \"copilot-sdk-telemetry-e2e\"\n source_name = \"python-sdk-telemetry-e2e\"\n tool_name = \"echo_telemetry_marker\"\n prompt = (\n f\"Use the {tool_name} tool with value '{marker}', then respond with TELEMETRY_E2E_DONE.\"\n )\n\n def echo(invocation: ToolInvocation) -> ToolResult:\n args = invocation.arguments or {}\n return ToolResult(text_result_for_llm=str(args.get(\"value\", \"\")))\n\n github_token = (\n \"fake-token-for-e2e-tests\" if os.environ.get(\"GITHUB_ACTIONS\") == \"true\" else None\n )\n client = CopilotClient(\n SubprocessConfig(\n cli_path=ctx.cli_path,\n cwd=ctx.work_dir,\n env=ctx.get_env(),\n github_token=github_token,\n telemetry=TelemetryConfig(\n file_path=str(telemetry_path),\n exporter_type=\"file\",\n source_name=source_name,\n capture_content=True,\n ),\n )\n )\n\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n tools=[\n Tool(\n name=tool_name,\n description=\"Echoes a marker string for telemetry validation.\",\n parameters={\n \"type\": \"object\",\n \"properties\": {\"value\": {\"type\": \"string\", \"description\": \"Marker\"}},\n \"required\": [\"value\"],\n },\n handler=echo,\n )\n ],\n )\n session_id = session.session_id\n\n await session.send(prompt)\n answer = await get_final_assistant_message(session, timeout=60.0)\n assert \"TELEMETRY_E2E_DONE\" in (answer.data.content or \"\")\n\n await session.disconnect()\n finally:\n await client.stop()\n\n entries = await _read_telemetry_entries(\n telemetry_path,\n lambda items: any(\n item.get(\"type\") == \"span\"\n and _string_attribute(item, \"gen_ai.operation.name\") == \"invoke_agent\"\n for item in items\n ),\n )\n spans = [item for item in entries if item.get(\"type\") == \"span\"]\n assert spans\n\n for span in spans:\n scope = span.get(\"instrumentationScope\") or {}\n assert scope.get(\"name\") == source_name\n\n trace_ids = {s.get(\"traceId\") for s in spans if s.get(\"traceId\")}\n assert len(trace_ids) == 1\n\n for span in spans:\n status = (span.get(\"status\") or {}).get(\"code\", 0)\n assert status != 2, f\"span in error state: {span}\"\n\n invoke_agent = next(\n s for s in spans if _string_attribute(s, \"gen_ai.operation.name\") == \"invoke_agent\"\n )\n assert _string_attribute(invoke_agent, \"gen_ai.conversation.id\") == session_id\n assert _is_root_span(invoke_agent)\n invoke_agent_span_id = invoke_agent.get(\"spanId\")\n assert invoke_agent_span_id\n\n chat_spans = [s for s in spans if _string_attribute(s, \"gen_ai.operation.name\") == \"chat\"]\n assert chat_spans\n for chat in chat_spans:\n assert chat.get(\"parentSpanId\") == invoke_agent_span_id\n assert any(\n prompt in (_string_attribute(c, \"gen_ai.input.messages\") or \"\") for c in chat_spans\n )\n assert any(\n \"TELEMETRY_E2E_DONE\" in (_string_attribute(c, \"gen_ai.output.messages\") or \"\")\n for c in chat_spans\n )\n\n tool_span = next(\n s for s in spans if _string_attribute(s, \"gen_ai.operation.name\") == \"execute_tool\"\n )\n assert tool_span.get(\"parentSpanId\") == invoke_agent_span_id\n assert _string_attribute(tool_span, \"gen_ai.tool.name\") == tool_name\n assert (_string_attribute(tool_span, \"gen_ai.tool.call.id\") or \"\").strip()\n assert (\n _string_attribute(tool_span, \"gen_ai.tool.call.arguments\") == f'{{\"value\":\"{marker}\"}}'\n )\n assert _string_attribute(tool_span, \"gen_ai.tool.call.result\") == marker\n\n\n# ---------------------------------------------------------------------------\n# Unit-style tests mirroring dotnet/test/TelemetryTests.cs\n# ---------------------------------------------------------------------------\n\n\nclass TestTelemetryConfig:\n \"\"\"Mirrors TelemetryConfig_DefaultValues_AreNull / TelemetryConfig_CanSetAllProperties.\"\"\"\n\n async def test_default_values_are_unset(self):\n # Python's TelemetryConfig is a TypedDict with total=False, so an empty\n # constructor leaves every field unset (equivalent to C#'s null defaults).\n cfg: TelemetryConfig = TelemetryConfig()\n assert cfg.get(\"otlp_endpoint\") is None\n assert cfg.get(\"file_path\") is None\n assert cfg.get(\"exporter_type\") is None\n assert cfg.get(\"source_name\") is None\n assert cfg.get(\"capture_content\") is None\n\n async def test_can_set_all_properties(self):\n cfg: TelemetryConfig = TelemetryConfig(\n otlp_endpoint=\"http://localhost:4318\",\n file_path=\"/tmp/traces.json\",\n exporter_type=\"otlp-http\",\n source_name=\"my-app\",\n capture_content=True,\n )\n assert cfg[\"otlp_endpoint\"] == \"http://localhost:4318\"\n assert cfg[\"file_path\"] == \"/tmp/traces.json\"\n assert cfg[\"exporter_type\"] == \"otlp-http\"\n assert cfg[\"source_name\"] == \"my-app\"\n assert cfg[\"capture_content\"] is True\n\n\nclass TestSubprocessConfigTelemetry:\n \"\"\"Mirrors CopilotClientOptions_Telemetry_DefaultsToNull.\"\"\"\n\n async def test_telemetry_defaults_to_none(self):\n config = SubprocessConfig()\n assert config.telemetry is None\n\n # NOTE: CopilotClientOptions_Clone_CopiesTelemetry from the C# baseline has\n # no Python equivalent: SubprocessConfig is a plain dataclass with no\n # Clone() method, so there is nothing meaningful to test.\n\n\nclass TestTelemetryHelpers:\n \"\"\"Mirrors TelemetryHelpers_Restores_W3C_Trace_Context.\"\"\"\n\n async def test_restores_w3c_trace_context(self):\n # The helpers are a no-op if the OpenTelemetry API is not installed;\n # skip the test in that case to keep CI portable.\n opentelemetry = pytest.importorskip(\"opentelemetry\")\n from opentelemetry import propagate, trace\n from opentelemetry.sdk.trace import TracerProvider\n from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator\n\n # Configure a real tracer provider + W3C propagator so the helpers\n # actually have something to inject/extract.\n previous_provider = trace.get_tracer_provider()\n previous_propagator = propagate.get_global_textmap()\n trace.set_tracer_provider(TracerProvider())\n propagate.set_global_textmap(TraceContextTextMapPropagator())\n try:\n tracer = trace.get_tracer(\"copilot-sdk-test\")\n with tracer.start_as_current_span(\"parent\") as parent:\n ctx = get_trace_context()\n assert ctx.get(\"traceparent\"), \"expected non-empty traceparent under active span\"\n expected_trace_id = format(parent.get_span_context().trace_id, \"032x\")\n assert expected_trace_id in ctx[\"traceparent\"]\n\n # Now outside any active span, restore the captured headers and\n # verify the propagated trace id round-trips.\n captured_traceparent = ctx[\"traceparent\"]\n captured_tracestate = ctx.get(\"tracestate\")\n with trace_context(captured_traceparent, captured_tracestate):\n restored = get_trace_context()\n assert restored.get(\"traceparent\")\n assert expected_trace_id in restored[\"traceparent\"]\n\n # Invalid traceparents should not raise; they simply produce no\n # propagated context (matching the C# helper's null return).\n with trace_context(\"not-a-traceparent\", None):\n bad = get_trace_context()\n assert \"traceparent\" not in bad\n finally:\n propagate.set_global_textmap(previous_propagator)\n trace.set_tracer_provider(previous_provider)\n _ = opentelemetry # keep importorskip reference\n" }, { "path": "python/e2e/test_tool_results_e2e.py", "content": "\"\"\"E2E Tool Results Tests\"\"\"\n\nimport pytest\nfrom pydantic import BaseModel, Field\n\nfrom copilot import define_tool\nfrom copilot.session import PermissionHandler\nfrom copilot.tools import ToolInvocation, ToolResult\n\nfrom .testharness import E2ETestContext, get_final_assistant_message\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nclass TestToolResults:\n async def test_should_handle_structured_toolresultobject_from_custom_tool(\n self, ctx: E2ETestContext\n ):\n class WeatherParams(BaseModel):\n city: str = Field(description=\"City name\")\n\n @define_tool(\"get_weather\", description=\"Gets weather for a city\")\n def get_weather(params: WeatherParams, invocation: ToolInvocation) -> ToolResult:\n return ToolResult(\n text_result_for_llm=f\"The weather in {params.city} is sunny and 72°F\",\n result_type=\"success\",\n )\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all, tools=[get_weather]\n )\n\n try:\n await session.send(\"What's the weather in Paris?\")\n assistant_message = await get_final_assistant_message(session)\n assert (\n \"sunny\" in assistant_message.data.content.lower()\n or \"72\" in assistant_message.data.content\n )\n finally:\n await session.disconnect()\n\n async def test_should_handle_tool_result_with_failure_resulttype(self, ctx: E2ETestContext):\n @define_tool(\"check_status\", description=\"Checks the status of a service\")\n def check_status(invocation: ToolInvocation) -> ToolResult:\n return ToolResult(\n text_result_for_llm=\"Service unavailable\",\n result_type=\"failure\",\n error=\"API timeout\",\n )\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all, tools=[check_status]\n )\n\n try:\n answer = await session.send_and_wait(\n \"Check the status of the service using check_status.\"\n \" If it fails, say 'service is down'.\"\n )\n assert answer is not None\n assert \"service is down\" in answer.data.content.lower()\n finally:\n await session.disconnect()\n\n async def test_should_preserve_tooltelemetry_and_not_stringify_structured_results_for_llm(\n self, ctx: E2ETestContext\n ):\n class AnalyzeParams(BaseModel):\n file: str = Field(description=\"File to analyze\")\n\n @define_tool(\"analyze_code\", description=\"Analyzes code for issues\")\n def analyze_code(params: AnalyzeParams, invocation: ToolInvocation) -> ToolResult:\n return ToolResult(\n text_result_for_llm=f\"Analysis of {params.file}: no issues found\",\n result_type=\"success\",\n tool_telemetry={\n \"metrics\": {\"analysisTimeMs\": 150},\n \"properties\": {\"analyzer\": \"eslint\"},\n },\n )\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all, tools=[analyze_code]\n )\n\n try:\n await session.send(\"Analyze the file main.ts for issues.\")\n assistant_message = await get_final_assistant_message(session)\n assert \"no issues\" in assistant_message.data.content.lower()\n\n # Verify the LLM received just textResultForLlm, not stringified JSON\n traffic = await ctx.get_exchanges()\n last_conversation = traffic[-1]\n tool_results = [\n m for m in last_conversation[\"request\"][\"messages\"] if m[\"role\"] == \"tool\"\n ]\n assert len(tool_results) == 1\n assert \"toolTelemetry\" not in tool_results[0][\"content\"]\n assert \"resultType\" not in tool_results[0][\"content\"]\n finally:\n await session.disconnect()\n" }, { "path": "python/e2e/test_tools_e2e.py", "content": "\"\"\"E2E Tools Tests\"\"\"\n\nimport os\n\nimport pytest\nfrom pydantic import BaseModel, Field\n\nfrom copilot import define_tool\nfrom copilot.session import PermissionHandler, PermissionRequestResult\nfrom copilot.tools import ToolInvocation\n\nfrom .testharness import E2ETestContext, get_final_assistant_message\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nclass TestTools:\n async def test_invokes_built_in_tools(self, ctx: E2ETestContext):\n readme_path = os.path.join(ctx.work_dir, \"README.md\")\n with open(readme_path, \"w\") as f:\n f.write(\"# ELIZA, the only chatbot you'll ever need\")\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n await session.send(\"What's the first line of README.md in this directory?\")\n assistant_message = await get_final_assistant_message(session)\n assert \"ELIZA\" in assistant_message.data.content\n\n async def test_invokes_custom_tool(self, ctx: E2ETestContext):\n class EncryptParams(BaseModel):\n input: str = Field(description=\"String to encrypt\")\n\n @define_tool(\"encrypt_string\", description=\"Encrypts a string\")\n def encrypt_string(params: EncryptParams, invocation: ToolInvocation) -> str:\n return params.input.upper()\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all, tools=[encrypt_string]\n )\n\n await session.send(\"Use encrypt_string to encrypt this string: Hello\")\n assistant_message = await get_final_assistant_message(session)\n assert \"HELLO\" in assistant_message.data.content\n\n async def test_handles_tool_calling_errors(self, ctx: E2ETestContext):\n @define_tool(\"get_user_location\", description=\"Gets the user's location\")\n def get_user_location() -> str:\n raise Exception(\"Melbourne\")\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all, tools=[get_user_location]\n )\n\n await session.send(\"What is my location? If you can't find out, just say 'unknown'.\")\n answer = await get_final_assistant_message(session)\n\n # Check the underlying traffic\n traffic = await ctx.get_exchanges()\n last_conversation = traffic[-1]\n\n tool_calls = []\n for msg in last_conversation[\"request\"][\"messages\"]:\n if msg.get(\"role\") == \"assistant\" and \"tool_calls\" in msg:\n tool_calls.extend(msg[\"tool_calls\"])\n\n assert len(tool_calls) == 1\n tool_call = tool_calls[0]\n assert tool_call[\"type\"] == \"function\"\n assert tool_call[\"function\"][\"name\"] == \"get_user_location\"\n\n tool_results = [\n msg for msg in last_conversation[\"request\"][\"messages\"] if msg.get(\"role\") == \"tool\"\n ]\n assert len(tool_results) == 1\n tool_result = tool_results[0]\n assert tool_result[\"tool_call_id\"] == tool_call[\"id\"]\n\n # The error message \"Melbourne\" should NOT be exposed to the LLM\n assert \"Melbourne\" not in tool_result[\"content\"]\n\n # The assistant should not see the exception information\n assert \"Melbourne\" not in (answer.data.content or \"\")\n assert \"unknown\" in (answer.data.content or \"\").lower()\n\n async def test_can_receive_and_return_complex_types(self, ctx: E2ETestContext):\n class DbQuery(BaseModel):\n table: str\n ids: list[int]\n sortAscending: bool\n\n class DbQueryParams(BaseModel):\n query: DbQuery\n\n class City(BaseModel):\n countryId: int\n cityName: str\n population: int\n\n expected_session_id = None\n\n @define_tool(\"db_query\", description=\"Performs a database query\")\n def db_query(params: DbQueryParams, invocation: ToolInvocation) -> list[City]:\n assert params.query.table == \"cities\"\n assert params.query.ids == [12, 19]\n assert params.query.sortAscending is True\n assert invocation.session_id == expected_session_id\n\n return [\n City(countryId=19, cityName=\"Passos\", population=135460),\n City(countryId=12, cityName=\"San Lorenzo\", population=204356),\n ]\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all, tools=[db_query]\n )\n expected_session_id = session.session_id\n\n await session.send(\n \"Perform a DB query for the 'cities' table using IDs 12 and 19, \"\n \"sorting ascending. Reply only with lines of the form: [cityname] [population]\"\n )\n\n assistant_message = await get_final_assistant_message(session)\n response_content = assistant_message.data.content or \"\"\n\n assert response_content != \"\"\n assert \"Passos\" in response_content\n assert \"San Lorenzo\" in response_content\n assert \"135460\" in response_content.replace(\",\", \"\")\n assert \"204356\" in response_content.replace(\",\", \"\")\n\n async def test_skippermission_sent_in_tool_definition(self, ctx: E2ETestContext):\n class LookupParams(BaseModel):\n id: str = Field(description=\"ID to look up\")\n\n @define_tool(\n \"safe_lookup\",\n description=\"A safe lookup that skips permission\",\n skip_permission=True,\n )\n def safe_lookup(params: LookupParams, invocation: ToolInvocation) -> str:\n return f\"RESULT: {params.id}\"\n\n did_run_permission_request = False\n\n def tracking_handler(request, invocation):\n nonlocal did_run_permission_request\n did_run_permission_request = True\n return PermissionRequestResult(kind=\"no-result\")\n\n session = await ctx.client.create_session(\n on_permission_request=tracking_handler, tools=[safe_lookup]\n )\n\n await session.send(\"Use safe_lookup to look up 'test123'\")\n assistant_message = await get_final_assistant_message(session)\n assert \"RESULT: test123\" in assistant_message.data.content\n assert not did_run_permission_request\n\n async def test_overrides_built_in_tool_with_custom_tool(self, ctx: E2ETestContext):\n class GrepParams(BaseModel):\n query: str = Field(description=\"Search query\")\n\n @define_tool(\n \"grep\",\n description=\"A custom grep implementation that overrides the built-in\",\n overrides_built_in_tool=True,\n )\n def custom_grep(params: GrepParams, invocation: ToolInvocation) -> str:\n return f\"CUSTOM_GREP_RESULT: {params.query}\"\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all, tools=[custom_grep]\n )\n\n await session.send(\"Use grep to search for the word 'hello'\")\n assistant_message = await get_final_assistant_message(session)\n assert \"CUSTOM_GREP_RESULT\" in assistant_message.data.content\n\n async def test_invokes_custom_tool_with_permission_handler(self, ctx: E2ETestContext):\n class EncryptParams(BaseModel):\n input: str = Field(description=\"String to encrypt\")\n\n @define_tool(\"encrypt_string\", description=\"Encrypts a string\")\n def encrypt_string(params: EncryptParams, invocation: ToolInvocation) -> str:\n return params.input.upper()\n\n permission_requests = []\n\n def on_permission_request(request, invocation):\n permission_requests.append(request)\n return PermissionRequestResult(kind=\"approve-once\")\n\n session = await ctx.client.create_session(\n on_permission_request=on_permission_request, tools=[encrypt_string]\n )\n\n await session.send(\"Use encrypt_string to encrypt this string: Hello\")\n assistant_message = await get_final_assistant_message(session)\n assert \"HELLO\" in assistant_message.data.content\n\n # Should have received a custom-tool permission request\n custom_tool_requests = [r for r in permission_requests if r.kind.value == \"custom-tool\"]\n assert len(custom_tool_requests) > 0\n assert custom_tool_requests[0].tool_name == \"encrypt_string\"\n\n async def test_denies_custom_tool_when_permission_denied(self, ctx: E2ETestContext):\n tool_handler_called = False\n\n class EncryptParams(BaseModel):\n input: str = Field(description=\"String to encrypt\")\n\n @define_tool(\"encrypt_string\", description=\"Encrypts a string\")\n def encrypt_string(params: EncryptParams, invocation: ToolInvocation) -> str:\n nonlocal tool_handler_called\n tool_handler_called = True\n return params.input.upper()\n\n def on_permission_request(request, invocation):\n return PermissionRequestResult(kind=\"reject\")\n\n session = await ctx.client.create_session(\n on_permission_request=on_permission_request, tools=[encrypt_string]\n )\n\n await session.send(\"Use encrypt_string to encrypt this string: Hello\")\n await get_final_assistant_message(session)\n\n # The tool handler should NOT have been called since permission was denied\n assert not tool_handler_called\n" }, { "path": "python/e2e/test_ui_elicitation_e2e.py", "content": "\"\"\"E2E UI Elicitation Tests (single-client)\n\nMirrors nodejs/test/e2e/ui_elicitation.test.ts — single-client scenarios.\n\nUses the shared ``ctx`` fixture from conftest.py.\n\"\"\"\n\nimport pytest\n\nfrom copilot.session import (\n ElicitationContext,\n ElicitationParams,\n ElicitationResult,\n PermissionHandler,\n)\n\nfrom .testharness import E2ETestContext\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\nclass TestUiElicitation:\n async def test_elicitation_methods_throw_in_headless_mode(self, ctx: E2ETestContext):\n \"\"\"Elicitation methods throw when running in headless mode.\"\"\"\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n\n # The SDK spawns the CLI headless — no TUI means no elicitation support.\n ui_caps = session.capabilities.get(\"ui\", {})\n assert not ui_caps.get(\"elicitation\")\n\n with pytest.raises(RuntimeError, match=\"not supported\"):\n await session.ui.confirm(\"test\")\n\n with pytest.raises(RuntimeError, match=\"not supported\"):\n await session.ui.select(\"test\", [\"a\", \"b\"])\n\n with pytest.raises(RuntimeError, match=\"not supported\"):\n await session.ui.input(\"test\")\n\n with pytest.raises(RuntimeError, match=\"not supported\"):\n await session.ui.elicitation(\n {\n \"message\": \"Enter name\",\n \"requestedSchema\": {\n \"type\": \"object\",\n \"properties\": {\"name\": {\"type\": \"string\"}},\n \"required\": [\"name\"],\n },\n }\n )\n\n await session.disconnect()\n\n async def test_session_with_elicitation_handler_reports_capability(self, ctx: E2ETestContext):\n \"\"\"Session created with onElicitationContext reports elicitation capability.\"\"\"\n\n async def handler(\n context: ElicitationContext,\n ) -> ElicitationResult:\n return {\"action\": \"accept\", \"content\": {}}\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n on_elicitation_request=handler,\n )\n\n assert session.capabilities.get(\"ui\", {}).get(\"elicitation\") is True\n\n await session.disconnect()\n\n async def test_session_without_elicitation_handler_reports_no_capability(\n self, ctx: E2ETestContext\n ):\n \"\"\"Session created without onElicitationContext reports no elicitation capability.\"\"\"\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n\n assert session.capabilities.get(\"ui\", {}).get(\"elicitation\") in (False, None)\n\n await session.disconnect()\n\n async def test_sends_request_elicitation_when_handler_provided(self, ctx: E2ETestContext):\n \"\"\"Session is created successfully with requestElicitation=true when handler is provided.\"\"\"\n\n async def handler(_: ElicitationContext) -> ElicitationResult:\n return {\"action\": \"accept\", \"content\": {}}\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n on_elicitation_request=handler,\n )\n\n assert session.session_id is not None\n await session.disconnect()\n\n async def test_session_without_elicitation_handler_creates_successfully(\n self, ctx: E2ETestContext\n ):\n \"\"\"Session without an elicitation handler still creates successfully.\"\"\"\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n\n assert session.session_id is not None\n await session.disconnect()\n\n async def test_confirm_returns_true_when_handler_accepts(self, ctx: E2ETestContext):\n async def handler(context: ElicitationContext) -> ElicitationResult:\n assert context[\"message\"] == \"Confirm?\"\n schema = context.get(\"requestedSchema\") or {}\n assert \"confirmed\" in (schema.get(\"properties\") or {})\n return {\"action\": \"accept\", \"content\": {\"confirmed\": True}}\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n on_elicitation_request=handler,\n )\n\n assert session.capabilities.get(\"ui\", {}).get(\"elicitation\") is True\n assert (await session.ui.confirm(\"Confirm?\")) is True\n\n await session.disconnect()\n\n async def test_confirm_returns_false_when_handler_declines(self, ctx: E2ETestContext):\n async def handler(_: ElicitationContext) -> ElicitationResult:\n return {\"action\": \"decline\"}\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n on_elicitation_request=handler,\n )\n\n assert (await session.ui.confirm(\"Confirm?\")) is False\n\n await session.disconnect()\n\n async def test_select_returns_selected_option(self, ctx: E2ETestContext):\n async def handler(context: ElicitationContext) -> ElicitationResult:\n assert context[\"message\"] == \"Choose\"\n schema = context.get(\"requestedSchema\") or {}\n assert \"selection\" in (schema.get(\"properties\") or {})\n return {\"action\": \"accept\", \"content\": {\"selection\": \"beta\"}}\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n on_elicitation_request=handler,\n )\n\n assert (await session.ui.select(\"Choose\", [\"alpha\", \"beta\"])) == \"beta\"\n\n await session.disconnect()\n\n async def test_input_returns_freeform_value(self, ctx: E2ETestContext):\n async def handler(context: ElicitationContext) -> ElicitationResult:\n assert context[\"message\"] == \"Enter value\"\n schema = context.get(\"requestedSchema\") or {}\n assert \"value\" in (schema.get(\"properties\") or {})\n return {\"action\": \"accept\", \"content\": {\"value\": \"typed value\"}}\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n on_elicitation_request=handler,\n )\n\n result = await session.ui.input(\n \"Enter value\",\n {\n \"title\": \"Value\",\n \"description\": \"A value to test\",\n \"minLength\": 1,\n \"maxLength\": 20,\n \"default\": \"default\",\n },\n )\n assert result == \"typed value\"\n\n await session.disconnect()\n\n async def test_elicitation_returns_all_action_shapes(self, ctx: E2ETestContext):\n responses: list[ElicitationResult] = [\n {\"action\": \"accept\", \"content\": {\"name\": \"Mona\"}},\n {\"action\": \"decline\"},\n {\"action\": \"cancel\"},\n ]\n\n async def handler(context: ElicitationContext) -> ElicitationResult:\n assert context[\"message\"] == \"Name?\"\n return responses.pop(0)\n\n session = await ctx.client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n on_elicitation_request=handler,\n )\n\n params: ElicitationParams = {\n \"message\": \"Name?\",\n \"requestedSchema\": {\n \"type\": \"object\",\n \"properties\": {\"name\": {\"type\": \"string\"}},\n \"required\": [\"name\"],\n },\n }\n\n accept = await session.ui.elicitation(params)\n decline = await session.ui.elicitation(params)\n cancel = await session.ui.elicitation(params)\n\n assert accept[\"action\"] == \"accept\"\n assert (accept.get(\"content\") or {}).get(\"name\") == \"Mona\"\n assert decline[\"action\"] == \"decline\"\n assert cancel[\"action\"] == \"cancel\"\n\n await session.disconnect()\n" }, { "path": "python/e2e/test_ui_elicitation_multi_client_e2e.py", "content": "\"\"\"E2E UI Elicitation Tests (multi-client)\n\nMirrors nodejs/test/e2e/ui_elicitation.test.ts — multi-client scenarios.\n\nTests:\n - capabilities.changed fires when second client joins with elicitation handler\n - capabilities.changed fires when elicitation provider disconnects\n\"\"\"\n\nimport asyncio\nimport contextlib\nimport os\nimport shutil\nimport tempfile\n\nimport pytest\nimport pytest_asyncio\n\nfrom copilot import CopilotClient\nfrom copilot.client import ExternalServerConfig, SubprocessConfig\nfrom copilot.generated.session_events import CapabilitiesChangedData\nfrom copilot.session import (\n ElicitationContext,\n ElicitationResult,\n PermissionHandler,\n)\n\nfrom .testharness.context import SNAPSHOTS_DIR, get_cli_path_for_tests\nfrom .testharness.proxy import CapiProxy\n\npytestmark = pytest.mark.asyncio(loop_scope=\"module\")\n\n\n# ---------------------------------------------------------------------------\n# Multi-client context (TCP mode) — same pattern as test_multi_client.py\n# ---------------------------------------------------------------------------\n\n\nclass ElicitationMultiClientContext:\n \"\"\"Test context managing multiple clients on one CLI server.\"\"\"\n\n def __init__(self):\n self.cli_path: str = \"\"\n self.home_dir: str = \"\"\n self.work_dir: str = \"\"\n self.proxy_url: str = \"\"\n self._proxy: CapiProxy | None = None\n self._client1: CopilotClient | None = None\n self._client2: CopilotClient | None = None\n self._actual_port: int | None = None\n\n async def setup(self):\n self.cli_path = get_cli_path_for_tests()\n self.home_dir = os.path.realpath(tempfile.mkdtemp(prefix=\"copilot-elicit-config-\"))\n self.work_dir = os.path.realpath(tempfile.mkdtemp(prefix=\"copilot-elicit-work-\"))\n\n self._proxy = CapiProxy()\n self.proxy_url = await self._proxy.start()\n\n github_token = (\n \"fake-token-for-e2e-tests\" if os.environ.get(\"GITHUB_ACTIONS\") == \"true\" else None\n )\n\n # Client 1 uses TCP mode so additional clients can connect\n self._client1 = CopilotClient(\n SubprocessConfig(\n cli_path=self.cli_path,\n cwd=self.work_dir,\n env=self._get_env(),\n use_stdio=False,\n github_token=github_token,\n )\n )\n\n # Trigger connection to obtain the TCP port\n init_session = await self._client1.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n await init_session.disconnect()\n\n self._actual_port = self._client1.actual_port\n assert self._actual_port is not None\n\n self._client2 = CopilotClient(ExternalServerConfig(url=f\"localhost:{self._actual_port}\"))\n\n async def teardown(self, test_failed: bool = False):\n for c in (self._client2, self._client1):\n if c:\n try:\n await c.stop()\n except Exception:\n pass # Best-effort cleanup during teardown\n self._client1 = self._client2 = None\n\n if self._proxy:\n await self._proxy.stop(skip_writing_cache=test_failed)\n self._proxy = None\n\n for d in (self.home_dir, self.work_dir):\n if d and os.path.exists(d):\n shutil.rmtree(d, ignore_errors=True)\n\n async def configure_for_test(self, test_file: str, test_name: str):\n import re\n\n sanitized_name = re.sub(r\"[^a-zA-Z0-9]\", \"_\", test_name).lower()\n snapshot_path = SNAPSHOTS_DIR / test_file / f\"{sanitized_name}.yaml\"\n if self._proxy:\n await self._proxy.configure(str(snapshot_path.resolve()), self.work_dir)\n from pathlib import Path\n\n for d in (self.home_dir, self.work_dir):\n for item in Path(d).iterdir():\n if item.is_dir():\n shutil.rmtree(item, ignore_errors=True)\n else:\n with contextlib.suppress(OSError):\n item.unlink(missing_ok=True)\n\n def _get_env(self) -> dict:\n env = os.environ.copy()\n env.update(\n {\n \"COPILOT_API_URL\": self.proxy_url,\n \"COPILOT_HOME\": self.home_dir,\n \"XDG_CONFIG_HOME\": self.home_dir,\n \"XDG_STATE_HOME\": self.home_dir,\n }\n )\n return env\n\n def make_external_client(self) -> CopilotClient:\n \"\"\"Create a new external client connected to the same CLI server.\"\"\"\n assert self._actual_port is not None\n return CopilotClient(ExternalServerConfig(url=f\"localhost:{self._actual_port}\"))\n\n @property\n def client1(self) -> CopilotClient:\n assert self._client1 is not None\n return self._client1\n\n @property\n def client2(self) -> CopilotClient:\n assert self._client2 is not None\n return self._client2\n\n\n# ---------------------------------------------------------------------------\n# Fixtures\n# ---------------------------------------------------------------------------\n\n\n@pytest.hookimpl(tryfirst=True, hookwrapper=True)\ndef pytest_runtest_makereport(item, call):\n outcome = yield\n rep = outcome.get_result()\n if rep.when == \"call\" and rep.failed:\n item.session.stash.setdefault(\"any_test_failed\", False)\n item.session.stash[\"any_test_failed\"] = True\n\n\n@pytest_asyncio.fixture(scope=\"module\", loop_scope=\"module\")\nasync def mctx(request):\n context = ElicitationMultiClientContext()\n await context.setup()\n yield context\n any_failed = request.session.stash.get(\"any_test_failed\", False)\n await context.teardown(test_failed=any_failed)\n\n\n@pytest_asyncio.fixture(autouse=True, loop_scope=\"module\")\nasync def configure_elicit_multi_test(request, mctx):\n test_name = request.node.name\n if test_name.startswith(\"test_\"):\n test_name = test_name[5:]\n await mctx.configure_for_test(\"multi_client\", test_name)\n yield\n\n\n# ---------------------------------------------------------------------------\n# Tests\n# ---------------------------------------------------------------------------\n\n\nclass TestUiElicitationMultiClient:\n async def test_client_receives_commands_changed_when_another_client_joins_with_commands(\n self, mctx: ElicitationMultiClientContext\n ):\n \"\"\"Client 1 receives `commands.changed` when client 2 joins with commands.\"\"\"\n from copilot.generated.session_events import CommandsChangedData\n from copilot.session import CommandDefinition\n\n session1 = await mctx.client1.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n\n commands_changed = asyncio.Event()\n captured: list = []\n\n def on_event(event):\n match event.data:\n case CommandsChangedData() as data:\n captured.append(data)\n commands_changed.set()\n\n session1.on(on_event)\n\n async def deploy_handler(_ctx):\n return None\n\n session2 = await mctx.client2.resume_session(\n session1.session_id,\n on_permission_request=PermissionHandler.approve_all,\n commands=[\n CommandDefinition(\n name=\"deploy\",\n description=\"Deploy the app\",\n handler=deploy_handler,\n ),\n ],\n )\n\n try:\n await asyncio.wait_for(commands_changed.wait(), timeout=15.0)\n assert captured\n commands = captured[-1].commands or []\n assert any(c.name == \"deploy\" and c.description == \"Deploy the app\" for c in commands)\n finally:\n await session2.disconnect()\n\n async def test_capabilities_changed_when_second_client_joins_with_elicitation(\n self, mctx: ElicitationMultiClientContext\n ):\n \"\"\"capabilities.changed fires when second client joins with elicitation handler.\"\"\"\n # Client 1 creates session without elicitation\n session1 = await mctx.client1.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n assert session1.capabilities.get(\"ui\", {}).get(\"elicitation\") in (False, None)\n\n # Listen for capabilities.changed event\n cap_changed = asyncio.Event()\n cap_event_data: dict = {}\n\n def on_event(event):\n match event.data:\n case CapabilitiesChangedData() as data:\n ui = data.ui\n if ui:\n cap_event_data[\"elicitation\"] = ui.elicitation\n cap_changed.set()\n\n unsubscribe = session1.on(on_event)\n\n # Client 2 joins WITH elicitation handler — triggers capabilities.changed\n async def handler(\n context: ElicitationContext,\n ) -> ElicitationResult:\n return {\"action\": \"accept\", \"content\": {}}\n\n session2 = await mctx.client2.resume_session(\n session1.session_id,\n on_permission_request=PermissionHandler.approve_all,\n on_elicitation_request=handler,\n )\n\n await asyncio.wait_for(cap_changed.wait(), timeout=15.0)\n unsubscribe()\n\n # The event should report elicitation as True\n assert cap_event_data.get(\"elicitation\") is True\n\n # Client 1's capabilities should have been auto-updated\n assert session1.capabilities.get(\"ui\", {}).get(\"elicitation\") is True\n\n await session2.disconnect()\n\n async def test_capabilities_changed_when_elicitation_provider_disconnects(\n self, mctx: ElicitationMultiClientContext\n ):\n \"\"\"capabilities.changed fires when elicitation provider disconnects.\"\"\"\n # Client 1 creates session without elicitation\n session1 = await mctx.client1.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n assert session1.capabilities.get(\"ui\", {}).get(\"elicitation\") in (False, None)\n\n # Wait for elicitation to become available\n cap_enabled = asyncio.Event()\n\n def on_enabled(event):\n match event.data:\n case CapabilitiesChangedData() as data:\n ui = data.ui\n if ui and ui.elicitation is True:\n cap_enabled.set()\n\n unsub_enabled = session1.on(on_enabled)\n\n # Use a dedicated client so we can stop it independently\n client3 = mctx.make_external_client()\n\n async def handler(\n context: ElicitationContext,\n ) -> ElicitationResult:\n return {\"action\": \"accept\", \"content\": {}}\n\n # Client 3 joins WITH elicitation handler\n await client3.resume_session(\n session1.session_id,\n on_permission_request=PermissionHandler.approve_all,\n on_elicitation_request=handler,\n )\n\n await asyncio.wait_for(cap_enabled.wait(), timeout=15.0)\n unsub_enabled()\n assert session1.capabilities.get(\"ui\", {}).get(\"elicitation\") is True\n\n # Now listen for the capability being removed\n cap_disabled = asyncio.Event()\n\n def on_disabled(event):\n match event.data:\n case CapabilitiesChangedData() as data:\n ui = data.ui\n if ui and ui.elicitation is False:\n cap_disabled.set()\n\n unsub_disabled = session1.on(on_disabled)\n\n # Force-stop client 3 — destroys the socket, triggering server-side cleanup\n await client3.force_stop()\n\n await asyncio.wait_for(cap_disabled.wait(), timeout=15.0)\n unsub_disabled()\n assert session1.capabilities.get(\"ui\", {}).get(\"elicitation\") is False\n" }, { "path": "python/e2e/testharness/__init__.py", "content": "\"\"\"Test harness for E2E tests.\"\"\"\n\nfrom .context import CLI_PATH, E2ETestContext\nfrom .helper import get_final_assistant_message, get_next_event_of_type\nfrom .proxy import CapiProxy\n\n__all__ = [\n \"CLI_PATH\",\n \"E2ETestContext\",\n \"CapiProxy\",\n \"get_final_assistant_message\",\n \"get_next_event_of_type\",\n]\n" }, { "path": "python/e2e/testharness/context.py", "content": "\"\"\"\nTest context for E2E tests.\n\nProvides isolated directories and a replaying proxy for testing the SDK.\n\"\"\"\n\nimport contextlib\nimport os\nimport re\nimport shutil\nimport tempfile\nfrom pathlib import Path\nfrom typing import Any\n\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\nfrom .proxy import CapiProxy\n\n\ndef get_cli_path_for_tests() -> str:\n \"\"\"Get CLI path for E2E tests.\n\n Uses COPILOT_CLI_PATH env var if set, otherwise node_modules CLI.\n \"\"\"\n env_path = os.environ.get(\"COPILOT_CLI_PATH\")\n if env_path and Path(env_path).exists():\n return str(Path(env_path).resolve())\n\n # Look for CLI in sibling nodejs directory's node_modules\n base_path = Path(__file__).parents[3]\n full_path = base_path / \"nodejs\" / \"node_modules\" / \"@github\" / \"copilot\" / \"index.js\"\n if full_path.exists():\n return str(full_path.resolve())\n\n raise RuntimeError(\"CLI not found for tests. Run 'npm install' in the nodejs directory.\")\n\n\nCLI_PATH = get_cli_path_for_tests()\nSNAPSHOTS_DIR = Path(__file__).parents[3] / \"test\" / \"snapshots\"\n\n\nclass E2ETestContext:\n \"\"\"Holds shared resources for E2E tests.\"\"\"\n\n def __init__(self):\n self.cli_path: str = \"\"\n self.home_dir: str = \"\"\n self.work_dir: str = \"\"\n self.proxy_url: str = \"\"\n self._proxy: CapiProxy | None = None\n self._client: CopilotClient | None = None\n\n async def setup(self):\n \"\"\"Set up the test context with a shared client.\"\"\"\n self.cli_path = get_cli_path_for_tests()\n\n self.home_dir = os.path.realpath(tempfile.mkdtemp(prefix=\"copilot-test-config-\"))\n self.work_dir = os.path.realpath(tempfile.mkdtemp(prefix=\"copilot-test-work-\"))\n\n self._proxy = CapiProxy()\n self.proxy_url = await self._proxy.start()\n\n # Create the shared client (like Node.js/Go do)\n # Use fake token in CI to allow cached responses without real auth\n github_token = (\n \"fake-token-for-e2e-tests\" if os.environ.get(\"GITHUB_ACTIONS\") == \"true\" else None\n )\n self._client = CopilotClient(\n SubprocessConfig(\n cli_path=self.cli_path,\n cwd=self.work_dir,\n env=self.get_env(),\n github_token=github_token,\n )\n )\n\n async def teardown(self, test_failed: bool = False):\n \"\"\"Clean up the test context.\n\n Args:\n test_failed: If True, skip writing snapshots to avoid corruption.\n \"\"\"\n if self._client:\n try:\n await self._client.stop()\n except ExceptionGroup:\n pass # stop() completes all cleanup before raising; safe to ignore in teardown\n self._client = None\n\n if self._proxy:\n await self._proxy.stop(skip_writing_cache=test_failed)\n self._proxy = None\n\n if self.home_dir and os.path.exists(self.home_dir):\n shutil.rmtree(self.home_dir, ignore_errors=True)\n\n if self.work_dir and os.path.exists(self.work_dir):\n shutil.rmtree(self.work_dir, ignore_errors=True)\n\n async def configure_for_test(self, test_file: str, test_name: str):\n \"\"\"\n Configure the proxy for a specific test.\n\n Args:\n test_file: The test file name (e.g., \"session\" from \"test_session.py\")\n test_name: The test name (e.g., \"should_have_stateful_conversation\")\n \"\"\"\n sanitized_name = re.sub(r\"[^a-zA-Z0-9]\", \"_\", test_name).lower()\n snapshot_path = SNAPSHOTS_DIR / test_file / f\"{sanitized_name}.yaml\"\n abs_snapshot_path = str(snapshot_path.resolve())\n\n if self._proxy:\n await self._proxy.configure(abs_snapshot_path, self.work_dir)\n\n # Clear temp directories between tests (but leave them in place)\n # Use ignore_errors=True / suppress(OSError) to handle race conditions\n # where files (e.g., SQLite session-store.db on Windows) may still be\n # held open by a background process during cleanup.\n for base_dir in (self.home_dir, self.work_dir):\n for item in Path(base_dir).iterdir():\n if item.is_dir():\n shutil.rmtree(item, ignore_errors=True)\n else:\n with contextlib.suppress(OSError):\n item.unlink(missing_ok=True)\n\n def get_env(self) -> dict:\n \"\"\"Return environment variables configured for isolated testing.\"\"\"\n env = os.environ.copy()\n\n env.update(\n {\n \"COPILOT_API_URL\": self.proxy_url,\n \"COPILOT_HOME\": self.home_dir,\n \"XDG_CONFIG_HOME\": self.home_dir,\n \"XDG_STATE_HOME\": self.home_dir,\n }\n )\n return env\n\n @property\n def client(self) -> CopilotClient:\n \"\"\"Return the shared CopilotClient instance.\"\"\"\n if not self._client:\n raise RuntimeError(\"Context not set up. Call setup() first.\")\n return self._client\n\n async def set_copilot_user_by_token(self, token: str, response: dict[str, Any]) -> None:\n \"\"\"Register a per-token response for the /copilot_internal/user endpoint.\"\"\"\n if not self._proxy:\n raise RuntimeError(\"Proxy not started\")\n await self._proxy.set_copilot_user_by_token(token, response)\n\n async def get_exchanges(self):\n \"\"\"Retrieve the captured HTTP exchanges from the proxy.\"\"\"\n if not self._proxy:\n raise RuntimeError(\"Proxy not started\")\n return await self._proxy.get_exchanges()\n" }, { "path": "python/e2e/testharness/helper.py", "content": "\"\"\"\nTest helper functions for E2E tests.\n\"\"\"\n\nimport asyncio\nimport os\n\nfrom copilot import CopilotSession\nfrom copilot.generated.session_events import (\n AssistantMessageData,\n SessionErrorData,\n SessionIdleData,\n)\n\n\nasync def get_final_assistant_message(\n session: CopilotSession, timeout: float = 10.0, already_idle: bool = False\n):\n \"\"\"\n Wait for and return the final assistant message from a session turn.\n\n Args:\n session: The session to wait on\n timeout: Maximum time to wait in seconds\n\n Returns:\n The final assistant message event\n\n Raises:\n TimeoutError: If no message arrives within timeout\n RuntimeError: If a session error occurs\n \"\"\"\n result_future: asyncio.Future = asyncio.get_event_loop().create_future()\n\n final_assistant_message = None\n\n def on_event(event):\n nonlocal final_assistant_message\n if result_future.done():\n return\n\n match event.data:\n case AssistantMessageData():\n final_assistant_message = event\n case SessionIdleData():\n if final_assistant_message is not None:\n result_future.set_result(final_assistant_message)\n case SessionErrorData() as data:\n msg = data.message if data.message else \"session error\"\n result_future.set_exception(RuntimeError(msg))\n\n # Subscribe to future events\n unsubscribe = session.on(on_event)\n\n try:\n # Also check existing messages in case the response already arrived\n existing = await _get_existing_final_response(session, already_idle)\n if existing is not None:\n return existing\n\n return await asyncio.wait_for(result_future, timeout=timeout)\n finally:\n unsubscribe()\n\n\nasync def _get_existing_final_response(session: CopilotSession, already_idle: bool = False):\n \"\"\"Check existing messages for a final response.\"\"\"\n messages = await session.get_messages()\n\n # Find last user message\n final_user_message_index = -1\n for i in range(len(messages) - 1, -1, -1):\n if messages[i].type.value == \"user.message\":\n final_user_message_index = i\n break\n\n if final_user_message_index < 0:\n current_turn_messages = messages\n else:\n current_turn_messages = messages[final_user_message_index:]\n\n # Check for errors\n for msg in current_turn_messages:\n match msg.data:\n case SessionErrorData() as data:\n err_msg = data.message if data.message else \"session error\"\n raise RuntimeError(err_msg)\n\n # Find session.idle and get last assistant message before it\n if already_idle:\n session_idle_index = len(current_turn_messages)\n else:\n session_idle_index = -1\n for i, msg in enumerate(current_turn_messages):\n if msg.type.value == \"session.idle\":\n session_idle_index = i\n break\n\n if session_idle_index != -1:\n # Find last assistant.message before session.idle\n for i in range(session_idle_index - 1, -1, -1):\n if current_turn_messages[i].type.value == \"assistant.message\":\n return current_turn_messages[i]\n\n return None\n\n\ndef write_file(work_dir: str, filename: str, content: str) -> str:\n \"\"\"\n Write content to a file in the work directory.\n\n Args:\n work_dir: The working directory\n filename: The name of the file\n content: The content to write\n\n Returns:\n The full path to the created file\n \"\"\"\n filepath = os.path.join(work_dir, filename)\n with open(filepath, \"w\") as f:\n f.write(content)\n return filepath\n\n\ndef read_file(work_dir: str, filename: str) -> str:\n \"\"\"\n Read content from a file in the work directory.\n\n Args:\n work_dir: The working directory\n filename: The name of the file\n\n Returns:\n The content of the file\n \"\"\"\n filepath = os.path.join(work_dir, filename)\n with open(filepath) as f:\n return f.read()\n\n\nasync def get_next_event_of_type(session: CopilotSession, event_type: str, timeout: float = 30.0):\n \"\"\"\n Wait for and return the next event of a specific type from a session.\n\n Args:\n session: The session to wait on\n event_type: The event type to wait for (e.g., \"tool.execution_start\", \"session.idle\")\n timeout: Maximum time to wait in seconds\n\n Returns:\n The matching event\n\n Raises:\n TimeoutError: If no matching event arrives within timeout\n RuntimeError: If a session error occurs\n \"\"\"\n result_future: asyncio.Future = asyncio.get_event_loop().create_future()\n\n def on_event(event):\n if result_future.done():\n return\n\n if event.type.value == event_type:\n result_future.set_result(event)\n else:\n match event.data:\n case SessionErrorData() as data:\n msg = data.message if data.message else \"session error\"\n result_future.set_exception(RuntimeError(msg))\n\n unsubscribe = session.on(on_event)\n\n try:\n return await asyncio.wait_for(result_future, timeout=timeout)\n finally:\n unsubscribe()\n" }, { "path": "python/e2e/testharness/proxy.py", "content": "\"\"\"\nReplaying CAPI proxy for E2E tests.\n\nThis manages a child process that acts as a replaying proxy to AI endpoints.\nIt spawns the shared test harness server from test/harness/server.ts.\n\"\"\"\n\nimport os\nimport platform\nimport re\nimport subprocess\nfrom typing import Any\n\nimport httpx\n\n\nclass CapiProxy:\n \"\"\"Manages a replaying proxy server for E2E tests.\"\"\"\n\n def __init__(self):\n self._process: subprocess.Popen | None = None\n self._proxy_url: str | None = None\n\n async def start(self) -> str:\n \"\"\"Launch the proxy server and return its URL.\"\"\"\n if self._proxy_url:\n return self._proxy_url\n\n # The harness server is in the shared test directory\n server_path = os.path.join(\n os.path.dirname(__file__), \"..\", \"..\", \"..\", \"test\", \"harness\", \"server.ts\"\n )\n server_path = os.path.abspath(server_path)\n\n # On Windows, use shell=True to find npx\n use_shell = platform.system() == \"Windows\"\n\n self._process = subprocess.Popen(\n [\"npx\", \"tsx\", server_path],\n stdout=subprocess.PIPE,\n stderr=None, # Inherit stderr to parent for debugging\n text=True,\n cwd=os.path.dirname(server_path),\n shell=use_shell,\n )\n\n # Read the first line to get the listening URL\n line = self._process.stdout.readline()\n if not line:\n self._process.kill()\n raise RuntimeError(\"Failed to read proxy URL\")\n\n # Parse \"Listening: http://...\" from output\n match = re.search(r\"Listening: (http://[^\\s]+)\", line.strip())\n if not match:\n self._process.kill()\n raise RuntimeError(f\"Unexpected proxy output: {line}\")\n\n self._proxy_url = match.group(1)\n return self._proxy_url\n\n async def stop(self, skip_writing_cache: bool = False):\n \"\"\"Gracefully shut down the proxy server.\n\n Args:\n skip_writing_cache: If True, the proxy won't write captured exchanges to disk.\n \"\"\"\n if not self._process:\n return\n\n # Send stop request to the server\n if self._proxy_url:\n try:\n stop_url = f\"{self._proxy_url}/stop\"\n if skip_writing_cache:\n stop_url += \"?skipWritingCache=true\"\n async with httpx.AsyncClient() as client:\n await client.post(stop_url)\n except Exception:\n pass # Best effort\n\n # Wait for process to exit\n self._process.wait()\n self._process = None\n self._proxy_url = None\n\n async def configure(self, file_path: str, work_dir: str):\n \"\"\"Send configuration to the proxy.\"\"\"\n if not self._proxy_url:\n raise RuntimeError(\"Proxy not started\")\n\n async with httpx.AsyncClient() as client:\n resp = await client.post(\n f\"{self._proxy_url}/config\",\n json={\"filePath\": file_path, \"workDir\": work_dir},\n )\n if resp.status_code != 200:\n raise RuntimeError(f\"Proxy config failed with status {resp.status_code}\")\n\n async def get_exchanges(self) -> list[dict[str, Any]]:\n \"\"\"Retrieve the captured HTTP exchanges from the proxy.\"\"\"\n if not self._proxy_url:\n raise RuntimeError(\"Proxy not started\")\n\n async with httpx.AsyncClient() as client:\n resp = await client.get(f\"{self._proxy_url}/exchanges\")\n return resp.json()\n\n async def set_copilot_user_by_token(self, token: str, response: dict[str, Any]) -> None:\n \"\"\"Register a per-token response for /copilot_internal/user.\"\"\"\n if not self._proxy_url:\n raise RuntimeError(\"Proxy not started\")\n\n async with httpx.AsyncClient() as client:\n resp = await client.post(\n f\"{self._proxy_url}/copilot-user-config\",\n json={\"token\": token, \"response\": response},\n )\n assert resp.status_code == 200\n\n @property\n def url(self) -> str | None:\n \"\"\"Return the proxy URL, or None if not started.\"\"\"\n return self._proxy_url\n" }, { "path": "python/pyproject.toml", "content": "[build-system]\nrequires = [\"setuptools>=45\", \"wheel\", \"setuptools_scm[toml]>=6.2\"]\nbuild-backend = \"setuptools.build_meta\"\n\n[project]\nname = \"github-copilot-sdk\"\nversion = \"0.1.0\"\ndescription = \"Python SDK for GitHub Copilot CLI\"\nreadme = \"README.md\"\nrequires-python = \">=3.11\"\nlicense = \"MIT\"\n# license-files is set by scripts/build-wheels.mjs for bundled CLI wheels\nauthors = [\n {name = \"GitHub\", email = \"opensource@github.com\"}\n]\nclassifiers = [\n \"Development Status :: 3 - Alpha\",\n \"Intended Audience :: Developers\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.11\",\n \"Programming Language :: Python :: 3.12\",\n \"Programming Language :: Python :: 3.13\",\n \"Programming Language :: Python :: 3.14\",\n]\ndependencies = [\n \"python-dateutil>=2.9.0.post0\",\n \"pydantic>=2.0\",\n]\n\n[project.urls]\nHomepage = \"https://github.com/github/copilot-sdk\"\nRepository = \"https://github.com/github/copilot-sdk\"\n\n[project.optional-dependencies]\ndev = [\n \"ruff>=0.1.0\",\n \"ty>=0.0.2,<0.0.25\",\n \"pytest>=7.0.0\",\n \"pytest-asyncio>=0.21.0\",\n \"pytest-timeout>=2.0.0\",\n \"httpx>=0.24.0\",\n \"opentelemetry-sdk>=1.0.0\",\n]\ntelemetry = [\n \"opentelemetry-api>=1.0.0\",\n]\n\n# Use find with a glob so that the copilot.bin subpackage (created dynamically\n# by scripts/build-wheels.mjs during publishing) is included in platform wheels.\n[tool.setuptools.packages.find]\nwhere = [\".\"]\ninclude = [\"copilot*\"]\n\n[tool.ruff]\nline-length = 100\ntarget-version = \"py311\"\nexclude = [\n \"generated\",\n \"copilot/generated\",\n]\n\n[tool.ruff.lint]\nselect = [\n \"E\", # pycodestyle errors\n \"W\", # pycodestyle warnings\n \"F\", # pyflakes\n \"I\", # isort\n \"UP\", # pyupgrade\n]\n\n[tool.ruff.format]\ndocstring-code-format = true\nquote-style = \"double\"\nindent-style = \"space\"\n\n[tool.ty.rules]\ninvalid-argument-type = \"warn\"\n\n[tool.ty.src]\nexclude = [\n \"generated\",\n \"copilot/generated\",\n \"copilot/test_*.py\",\n]\n\n[tool.pytest.ini_options]\ntestpaths = [\".\"]\npython_files = \"test_*.py\"\npython_classes = \"Test*\"\npython_functions = \"test_*\"\nasyncio_mode = \"auto\"\n" }, { "path": "python/samples/chat.py", "content": "import asyncio\n\nfrom copilot import CopilotClient\nfrom copilot.generated.session_events import (\n AssistantMessageData,\n AssistantReasoningData,\n ToolExecutionStartData,\n)\nfrom copilot.session import PermissionHandler\n\nBLUE = \"\\033[34m\"\nRESET = \"\\033[0m\"\n\n\nasync def main():\n client = CopilotClient()\n await client.start()\n session = await client.create_session(on_permission_request=PermissionHandler.approve_all)\n\n def on_event(event):\n output = None\n match event.data:\n case AssistantReasoningData() as data:\n output = f\"[reasoning: {data.content}]\"\n case ToolExecutionStartData() as data:\n output = f\"[tool: {data.tool_name}]\"\n if output:\n print(f\"{BLUE}{output}{RESET}\")\n\n session.on(on_event)\n\n print(\"Chat with Copilot (Ctrl+C to exit)\\n\")\n\n while True:\n user_input = input(\"You: \").strip()\n if not user_input:\n continue\n print()\n\n reply = await session.send_and_wait(user_input)\n assistant_output = None\n if reply:\n match reply.data:\n case AssistantMessageData() as data:\n assistant_output = data.content\n print(f\"\\nAssistant: {assistant_output}\\n\")\n\n\nif __name__ == \"__main__\":\n try:\n asyncio.run(main())\n except KeyboardInterrupt:\n print(\"\\nBye!\")\n" }, { "path": "python/scripts/build-wheels.mjs", "content": "#!/usr/bin/env node\n/**\n * Build platform-specific Python wheels with bundled Copilot CLI binaries.\n *\n * Downloads the Copilot CLI binary for each platform from the npm registry\n * and builds a wheel that includes it.\n *\n * Usage:\n * node scripts/build-wheels.mjs [--platform PLATFORM] [--output-dir DIR]\n *\n * --platform: Build for specific platform only (linux-x64, linux-arm64, darwin-x64,\n * darwin-arm64, win32-x64, win32-arm64). If not specified, builds all.\n * --output-dir: Directory for output wheels (default: dist/)\n */\n\nimport { execSync } from \"node:child_process\";\nimport {\n createWriteStream,\n existsSync,\n mkdirSync,\n readFileSync,\n writeFileSync,\n chmodSync,\n rmSync,\n cpSync,\n readdirSync,\n statSync,\n} from \"node:fs\";\nimport { dirname, join } from \"node:path\";\nimport { pipeline } from \"node:stream/promises\";\nimport { fileURLToPath } from \"node:url\";\n\nconst __filename = fileURLToPath(import.meta.url);\nconst __dirname = dirname(__filename);\nconst pythonDir = dirname(__dirname);\nconst repoRoot = dirname(pythonDir);\n\n// Platform mappings: npm package suffix -> [wheel platform tag, binary name]\n// Based on Node 24.11 binaries being included in the wheels\nconst PLATFORMS = {\n \"linux-x64\": [\"manylinux_2_28_x86_64\", \"copilot\"],\n \"linux-arm64\": [\"manylinux_2_28_aarch64\", \"copilot\"],\n \"darwin-x64\": [\"macosx_10_9_x86_64\", \"copilot\"],\n \"darwin-arm64\": [\"macosx_11_0_arm64\", \"copilot\"],\n \"win32-x64\": [\"win_amd64\", \"copilot.exe\"],\n \"win32-arm64\": [\"win_arm64\", \"copilot.exe\"],\n};\n\nfunction getCliVersion() {\n const packageLockPath = join(repoRoot, \"nodejs\", \"package-lock.json\");\n if (!existsSync(packageLockPath)) {\n throw new Error(\n `package-lock.json not found at ${packageLockPath}. Run 'npm install' in nodejs/ first.`\n );\n }\n\n const packageLock = JSON.parse(readFileSync(packageLockPath, \"utf-8\"));\n const version = packageLock.packages?.[\"node_modules/@github/copilot\"]?.version;\n\n if (!version) {\n throw new Error(\"Could not find @github/copilot version in package-lock.json\");\n }\n\n return version;\n}\n\nfunction getPkgVersion() {\n const pyprojectPath = join(pythonDir, \"pyproject.toml\");\n const content = readFileSync(pyprojectPath, \"utf-8\");\n const match = content.match(/version\\s*=\\s*\"([^\"]+)\"/);\n if (!match) {\n throw new Error(\"Could not find version in pyproject.toml\");\n }\n return match[1];\n}\n\nasync function downloadCliBinary(platform, cliVersion, cacheDir) {\n const [, binaryName] = PLATFORMS[platform];\n const cachedBinary = join(cacheDir, binaryName);\n\n // Check cache\n if (existsSync(cachedBinary)) {\n console.log(` Using cached ${binaryName}`);\n return cachedBinary;\n }\n\n const tarballUrl = `https://registry.npmjs.org/@github/copilot-${platform}/-/copilot-${platform}-${cliVersion}.tgz`;\n console.log(` Downloading from ${tarballUrl}...`);\n\n // Download tarball\n const response = await fetch(tarballUrl);\n if (!response.ok) {\n throw new Error(`Failed to download: ${response.status} ${response.statusText}`);\n }\n\n // Extract to cache dir\n mkdirSync(cacheDir, { recursive: true });\n\n const tarballPath = join(cacheDir, `copilot-${platform}-${cliVersion}.tgz`);\n const fileStream = createWriteStream(tarballPath);\n\n await pipeline(response.body, fileStream);\n\n // Extract binary from tarball using system tar\n // On Windows, use the system32 tar to avoid Git Bash tar issues\n const tarCmd = process.platform === \"win32\"\n ? `\"${process.env.SystemRoot}\\\\System32\\\\tar.exe\"`\n : \"tar\";\n \n try {\n execSync(`${tarCmd} -xzf \"${tarballPath}\" -C \"${cacheDir}\" --strip-components=1 \"package/${binaryName}\"`, {\n stdio: \"inherit\",\n });\n } catch (e) {\n // Clean up on failure\n if (existsSync(tarballPath)) {\n rmSync(tarballPath);\n }\n throw new Error(`Failed to extract binary: ${e.message}`);\n }\n\n // Clean up tarball\n rmSync(tarballPath);\n\n // Verify binary exists\n if (!existsSync(cachedBinary)) {\n throw new Error(`Binary not found after extraction: ${cachedBinary}`);\n }\n\n // Make executable on Unix\n if (!binaryName.endsWith(\".exe\")) {\n chmodSync(cachedBinary, 0o755);\n }\n\n const size = statSync(cachedBinary).size / 1024 / 1024;\n console.log(` Downloaded ${binaryName} (${size.toFixed(1)} MB)`);\n\n return cachedBinary;\n}\n\nfunction getCliLicensePath() {\n // Use license from node_modules (requires npm ci in nodejs/ first)\n const licensePath = join(repoRoot, \"nodejs\", \"node_modules\", \"@github\", \"copilot\", \"LICENSE.md\");\n if (!existsSync(licensePath)) {\n throw new Error(\n `CLI LICENSE.md not found at ${licensePath}. Run 'npm ci' in nodejs/ first.`\n );\n }\n return licensePath;\n}\n\nasync function buildWheel(platform, pkgVersion, cliVersion, outputDir, licensePath) {\n const [wheelTag, binaryName] = PLATFORMS[platform];\n console.log(`\\nBuilding wheel for ${platform}...`);\n\n // Cache directory includes version\n const cacheDir = join(pythonDir, \".cli-cache\", cliVersion, platform);\n\n // Download/get cached binary\n const binaryPath = await downloadCliBinary(platform, cliVersion, cacheDir);\n\n // Create temp build directory\n const buildDir = join(pythonDir, \".build-temp\", platform);\n if (existsSync(buildDir)) {\n rmSync(buildDir, { recursive: true });\n }\n mkdirSync(buildDir, { recursive: true });\n\n // Copy package source\n const pkgDir = join(buildDir, \"copilot\");\n cpSync(join(pythonDir, \"copilot\"), pkgDir, { recursive: true });\n\n // Create bin directory and copy binary\n const binDir = join(pkgDir, \"bin\");\n mkdirSync(binDir, { recursive: true });\n cpSync(binaryPath, join(binDir, binaryName));\n\n // Create VERSION file\n writeFileSync(join(binDir, \"VERSION\"), cliVersion);\n\n // Create __init__.py\n writeFileSync(join(binDir, \"__init__.py\"), '\"\"\"Bundled Copilot CLI binary.\"\"\"\\n');\n\n // Copy and modify pyproject.toml for bundled CLI wheel\n let pyprojectContent = readFileSync(join(pythonDir, \"pyproject.toml\"), \"utf-8\");\n\n // Update SPDX expression and add license-files for both SDK and bundled CLI licenses\n pyprojectContent = pyprojectContent.replace(\n 'license = \"MIT\"',\n 'license = \"MIT AND LicenseRef-Copilot-CLI\"\\nlicense-files = [\"LICENSE\", \"CLI-LICENSE.md\"]'\n );\n\n // Add package-data configuration\n const packageDataConfig = `\n[tool.setuptools.package-data]\n\"copilot.bin\" = [\"*\"]\n`;\n pyprojectContent = pyprojectContent.replace(\"\\n[tool.ruff]\", `${packageDataConfig}\\n[tool.ruff]`);\n writeFileSync(join(buildDir, \"pyproject.toml\"), pyprojectContent);\n\n // Copy README\n if (existsSync(join(pythonDir, \"README.md\"))) {\n cpSync(join(pythonDir, \"README.md\"), join(buildDir, \"README.md\"));\n }\n\n // Copy SDK LICENSE\n cpSync(join(repoRoot, \"LICENSE\"), join(buildDir, \"LICENSE\"));\n\n // Copy CLI LICENSE\n cpSync(licensePath, join(buildDir, \"CLI-LICENSE.md\"));\n\n // Build wheel using uv (faster and doesn't require build package to be installed)\n const distDir = join(buildDir, \"dist\");\n execSync(\"uv build --wheel\", {\n cwd: buildDir,\n stdio: \"inherit\",\n });\n\n // Find built wheel\n const wheels = readdirSync(distDir).filter((f) => f.endsWith(\".whl\"));\n if (wheels.length === 0) {\n throw new Error(\"No wheel found after build\");\n }\n\n const srcWheel = join(distDir, wheels[0]);\n const newName = wheels[0].replace(\"-py3-none-any.whl\", `-py3-none-${wheelTag}.whl`);\n const destWheel = join(outputDir, newName);\n\n // Repack wheel with correct platform tag\n await repackWheelWithPlatform(srcWheel, destWheel, wheelTag);\n\n // Clean up build dir\n rmSync(buildDir, { recursive: true });\n\n const size = statSync(destWheel).size / 1024 / 1024;\n console.log(` Built ${newName} (${size.toFixed(1)} MB)`);\n\n return destWheel;\n}\n\nasync function repackWheelWithPlatform(srcWheel, destWheel, platformTag) {\n // Write Python script to temp file to avoid shell escaping issues\n const script = `\nimport sys\nimport zipfile\nimport tempfile\nfrom pathlib import Path\n\nsrc_wheel = Path(sys.argv[1])\ndest_wheel = Path(sys.argv[2])\nplatform_tag = sys.argv[3]\n\nwith tempfile.TemporaryDirectory() as tmpdir:\n tmpdir = Path(tmpdir)\n \n # Extract wheel\n with zipfile.ZipFile(src_wheel, 'r') as zf:\n zf.extractall(tmpdir)\n \n # Restore executable bit on the CLI binary (setuptools strips it)\n for bin_path in (tmpdir / 'copilot' / 'bin').iterdir():\n if bin_path.name in ('copilot', 'copilot.exe'):\n bin_path.chmod(0o755)\n \n # Find and update WHEEL file\n wheel_info_dirs = list(tmpdir.glob('*.dist-info'))\n if not wheel_info_dirs:\n raise RuntimeError('No .dist-info directory found in wheel')\n \n wheel_info_dir = wheel_info_dirs[0]\n wheel_file = wheel_info_dir / 'WHEEL'\n \n with open(wheel_file) as f:\n wheel_content = f.read()\n \n wheel_content = wheel_content.replace('Tag: py3-none-any', f'Tag: py3-none-{platform_tag}')\n \n with open(wheel_file, 'w') as f:\n f.write(wheel_content)\n \n # Regenerate RECORD file\n record_file = wheel_info_dir / 'RECORD'\n records = []\n for path in tmpdir.rglob('*'):\n if path.is_file() and path.name != 'RECORD':\n rel_path = path.relative_to(tmpdir)\n records.append(f'{rel_path},,')\n records.append(f'{wheel_info_dir.name}/RECORD,,')\n \n with open(record_file, 'w') as f:\n f.write('\\\\n'.join(records))\n \n # Create new wheel\n dest_wheel.parent.mkdir(parents=True, exist_ok=True)\n if dest_wheel.exists():\n dest_wheel.unlink()\n \n with zipfile.ZipFile(dest_wheel, 'w', zipfile.ZIP_DEFLATED) as zf:\n for path in tmpdir.rglob('*'):\n if path.is_file():\n zf.write(path, path.relative_to(tmpdir))\n`;\n\n // Write script to temp file\n const scriptPath = join(pythonDir, \".build-temp\", \"repack_wheel.py\");\n mkdirSync(dirname(scriptPath), { recursive: true });\n writeFileSync(scriptPath, script);\n\n try {\n execSync(`python \"${scriptPath}\" \"${srcWheel}\" \"${destWheel}\" \"${platformTag}\"`, {\n stdio: \"inherit\",\n });\n } finally {\n // Clean up script\n rmSync(scriptPath);\n }\n}\n\nasync function main() {\n const args = process.argv.slice(2);\n let platform = null;\n let outputDir = join(pythonDir, \"dist\");\n\n // Parse args\n for (let i = 0; i < args.length; i++) {\n if (args[i] === \"--platform\" && args[i + 1]) {\n platform = args[++i];\n if (!PLATFORMS[platform]) {\n console.error(`Invalid platform: ${platform}`);\n console.error(`Valid platforms: ${Object.keys(PLATFORMS).join(\", \")}`);\n process.exit(1);\n }\n } else if (args[i] === \"--output-dir\" && args[i + 1]) {\n outputDir = args[++i];\n }\n }\n\n const cliVersion = getCliVersion();\n const pkgVersion = getPkgVersion();\n\n console.log(`CLI version: ${cliVersion}`);\n console.log(`Package version: ${pkgVersion}`);\n\n mkdirSync(outputDir, { recursive: true });\n\n // Get CLI license from node_modules\n const licensePath = getCliLicensePath();\n\n const platforms = platform ? [platform] : Object.keys(PLATFORMS);\n const wheels = [];\n\n for (const p of platforms) {\n try {\n const wheel = await buildWheel(p, pkgVersion, cliVersion, outputDir, licensePath);\n wheels.push(wheel);\n } catch (e) {\n console.error(`Error building wheel for ${p}:`, e.message);\n if (platform) {\n process.exit(1);\n }\n }\n }\n\n console.log(`\\nBuilt ${wheels.length} wheel(s):`);\n for (const wheel of wheels) {\n console.log(` ${wheel}`);\n }\n}\n\nmain().catch((e) => {\n console.error(e);\n process.exit(1);\n});\n" }, { "path": "python/test_client.py", "content": "\"\"\"\nCopilotClient Unit Tests\n\nThis file is for unit tests. Where relevant, prefer to add e2e tests in e2e/*.py instead.\n\"\"\"\n\nfrom unittest.mock import AsyncMock, patch\n\nimport pytest\n\nfrom copilot import CopilotClient, define_tool\nfrom copilot.client import (\n ExternalServerConfig,\n ModelCapabilities,\n ModelInfo,\n ModelLimits,\n ModelSupports,\n SubprocessConfig,\n)\nfrom copilot.session import PermissionHandler, PermissionRequestResult\nfrom e2e.testharness import CLI_PATH\n\n\nclass TestPermissionHandlerRequired:\n @pytest.mark.asyncio\n async def test_create_session_raises_without_permission_handler(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n try:\n with pytest.raises(TypeError, match=\"on_permission_request\"):\n await client.create_session() # type: ignore[call-arg]\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_create_session_raises_with_none_permission_handler(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n try:\n with pytest.raises(ValueError, match=\"on_permission_request handler is required\"):\n await client.create_session(on_permission_request=None) # type: ignore[arg-type]\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_v2_permission_adapter_rejects_no_result(self):\n client = CopilotClient(SubprocessConfig(CLI_PATH))\n await client.start()\n try:\n session = await client.create_session(\n on_permission_request=lambda request, invocation: PermissionRequestResult(\n kind=\"no-result\"\n )\n )\n with pytest.raises(ValueError, match=\"protocol v2 server\"):\n await client._handle_permission_request_v2(\n {\n \"sessionId\": session.session_id,\n \"permissionRequest\": {\"kind\": \"write\"},\n }\n )\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_resume_session_raises_without_permission_handler(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n with pytest.raises(ValueError, match=\"on_permission_request.*is required\"):\n await client.resume_session(session.session_id, on_permission_request=None)\n finally:\n await client.force_stop()\n\n\nclass TestURLParsing:\n def test_parse_port_only_url(self):\n client = CopilotClient(ExternalServerConfig(url=\"8080\"))\n assert client._actual_port == 8080\n assert client._actual_host == \"localhost\"\n assert client._is_external_server\n\n def test_parse_host_port_url(self):\n client = CopilotClient(ExternalServerConfig(url=\"127.0.0.1:9000\"))\n assert client._actual_port == 9000\n assert client._actual_host == \"127.0.0.1\"\n assert client._is_external_server\n\n def test_parse_http_url(self):\n client = CopilotClient(ExternalServerConfig(url=\"http://localhost:7000\"))\n assert client._actual_port == 7000\n assert client._actual_host == \"localhost\"\n assert client._is_external_server\n\n def test_parse_https_url(self):\n client = CopilotClient(ExternalServerConfig(url=\"https://example.com:443\"))\n assert client._actual_port == 443\n assert client._actual_host == \"example.com\"\n assert client._is_external_server\n\n def test_invalid_url_format(self):\n with pytest.raises(ValueError, match=\"Invalid cli_url format\"):\n CopilotClient(ExternalServerConfig(url=\"invalid-url\"))\n\n def test_invalid_port_too_high(self):\n with pytest.raises(ValueError, match=\"Invalid port in cli_url\"):\n CopilotClient(ExternalServerConfig(url=\"localhost:99999\"))\n\n def test_invalid_port_zero(self):\n with pytest.raises(ValueError, match=\"Invalid port in cli_url\"):\n CopilotClient(ExternalServerConfig(url=\"localhost:0\"))\n\n def test_invalid_port_negative(self):\n with pytest.raises(ValueError, match=\"Invalid port in cli_url\"):\n CopilotClient(ExternalServerConfig(url=\"localhost:-1\"))\n\n def test_is_external_server_true(self):\n client = CopilotClient(ExternalServerConfig(url=\"localhost:8080\"))\n assert client._is_external_server\n\n\nclass TestSessionFsConfig:\n def test_missing_initial_cwd(self):\n with pytest.raises(ValueError, match=\"session_fs.initial_cwd is required\"):\n CopilotClient(\n SubprocessConfig(\n cli_path=CLI_PATH,\n log_level=\"error\",\n session_fs={\n \"initial_cwd\": \"\",\n \"session_state_path\": \"/session-state\",\n \"conventions\": \"posix\",\n },\n )\n )\n\n def test_missing_session_state_path(self):\n with pytest.raises(ValueError, match=\"session_fs.session_state_path is required\"):\n CopilotClient(\n SubprocessConfig(\n cli_path=CLI_PATH,\n log_level=\"error\",\n session_fs={\n \"initial_cwd\": \"/\",\n \"session_state_path\": \"\",\n \"conventions\": \"posix\",\n },\n )\n )\n\n\nclass TestAuthOptions:\n def test_accepts_github_token(self):\n client = CopilotClient(\n SubprocessConfig(\n cli_path=CLI_PATH,\n github_token=\"gho_test_token\",\n log_level=\"error\",\n )\n )\n assert isinstance(client._config, SubprocessConfig)\n assert client._config.github_token == \"gho_test_token\"\n\n def test_default_use_logged_in_user_true_without_token(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, log_level=\"error\"))\n assert isinstance(client._config, SubprocessConfig)\n assert client._config.use_logged_in_user is True\n\n def test_default_use_logged_in_user_false_with_token(self):\n client = CopilotClient(\n SubprocessConfig(\n cli_path=CLI_PATH,\n github_token=\"gho_test_token\",\n log_level=\"error\",\n )\n )\n assert isinstance(client._config, SubprocessConfig)\n assert client._config.use_logged_in_user is False\n\n def test_explicit_use_logged_in_user_true_with_token(self):\n client = CopilotClient(\n SubprocessConfig(\n cli_path=CLI_PATH,\n github_token=\"gho_test_token\",\n use_logged_in_user=True,\n log_level=\"error\",\n )\n )\n assert isinstance(client._config, SubprocessConfig)\n assert client._config.use_logged_in_user is True\n\n def test_explicit_use_logged_in_user_false_without_token(self):\n client = CopilotClient(\n SubprocessConfig(\n cli_path=CLI_PATH,\n use_logged_in_user=False,\n log_level=\"error\",\n )\n )\n assert isinstance(client._config, SubprocessConfig)\n assert client._config.use_logged_in_user is False\n\n\nclass TestSessionIdleTimeoutSeconds:\n def test_accepts_session_idle_timeout_seconds(self):\n client = CopilotClient(\n SubprocessConfig(\n cli_path=CLI_PATH,\n session_idle_timeout_seconds=600,\n log_level=\"error\",\n )\n )\n assert isinstance(client._config, SubprocessConfig)\n assert client._config.session_idle_timeout_seconds == 600\n\n def test_default_session_idle_timeout_seconds_is_none(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH, log_level=\"error\"))\n assert isinstance(client._config, SubprocessConfig)\n assert client._config.session_idle_timeout_seconds is None\n\n\nclass TestOverridesBuiltInTool:\n @pytest.mark.asyncio\n async def test_overrides_built_in_tool_sent_in_tool_definition(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n captured = {}\n original_request = client._client.request\n\n async def mock_request(method, params):\n captured[method] = params\n return await original_request(method, params)\n\n client._client.request = mock_request\n\n @define_tool(description=\"Custom grep\", overrides_built_in_tool=True)\n def grep(params) -> str:\n return \"ok\"\n\n await client.create_session(\n on_permission_request=PermissionHandler.approve_all, tools=[grep]\n )\n tool_defs = captured[\"session.create\"][\"tools\"]\n assert len(tool_defs) == 1\n assert tool_defs[0][\"name\"] == \"grep\"\n assert tool_defs[0][\"overridesBuiltInTool\"] is True\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_resume_session_sends_overrides_built_in_tool(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n captured = {}\n\n async def mock_request(method, params):\n captured[method] = params\n # Return a fake response instead of calling the real CLI,\n # which would fail without auth credentials.\n return {\"sessionId\": params[\"sessionId\"]}\n\n client._client.request = mock_request\n\n @define_tool(description=\"Custom grep\", overrides_built_in_tool=True)\n def grep(params) -> str:\n return \"ok\"\n\n await client.resume_session(\n session.session_id,\n on_permission_request=PermissionHandler.approve_all,\n tools=[grep],\n )\n tool_defs = captured[\"session.resume\"][\"tools\"]\n assert len(tool_defs) == 1\n assert tool_defs[0][\"overridesBuiltInTool\"] is True\n finally:\n await client.force_stop()\n\n\nclass TestOnListModels:\n @pytest.mark.asyncio\n async def test_list_models_with_custom_handler(self):\n \"\"\"Test that on_list_models handler is called instead of RPC\"\"\"\n custom_models = [\n ModelInfo(\n id=\"my-custom-model\",\n name=\"My Custom Model\",\n capabilities=ModelCapabilities(\n supports=ModelSupports(vision=False, reasoning_effort=False),\n limits=ModelLimits(max_context_window_tokens=128000),\n ),\n )\n ]\n\n handler_calls = []\n\n def handler():\n handler_calls.append(1)\n return custom_models\n\n client = CopilotClient(\n SubprocessConfig(cli_path=CLI_PATH),\n on_list_models=handler,\n )\n await client.start()\n try:\n models = await client.list_models()\n assert len(handler_calls) == 1\n assert models == custom_models\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_list_models_handler_caches_results(self):\n \"\"\"Test that on_list_models results are cached\"\"\"\n custom_models = [\n ModelInfo(\n id=\"cached-model\",\n name=\"Cached Model\",\n capabilities=ModelCapabilities(\n supports=ModelSupports(vision=False, reasoning_effort=False),\n limits=ModelLimits(max_context_window_tokens=128000),\n ),\n )\n ]\n\n handler_calls = []\n\n def handler():\n handler_calls.append(1)\n return custom_models\n\n client = CopilotClient(\n SubprocessConfig(cli_path=CLI_PATH),\n on_list_models=handler,\n )\n await client.start()\n try:\n await client.list_models()\n await client.list_models()\n assert len(handler_calls) == 1 # Only called once due to caching\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_list_models_async_handler(self):\n \"\"\"Test that async on_list_models handler works\"\"\"\n custom_models = [\n ModelInfo(\n id=\"async-model\",\n name=\"Async Model\",\n capabilities=ModelCapabilities(\n supports=ModelSupports(vision=False, reasoning_effort=False),\n limits=ModelLimits(max_context_window_tokens=128000),\n ),\n )\n ]\n\n async def handler():\n return custom_models\n\n client = CopilotClient(\n SubprocessConfig(cli_path=CLI_PATH),\n on_list_models=handler,\n )\n await client.start()\n try:\n models = await client.list_models()\n assert models == custom_models\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_list_models_handler_without_start(self):\n \"\"\"Test that on_list_models works without starting the CLI connection\"\"\"\n custom_models = [\n ModelInfo(\n id=\"no-start-model\",\n name=\"No Start Model\",\n capabilities=ModelCapabilities(\n supports=ModelSupports(vision=False, reasoning_effort=False),\n limits=ModelLimits(max_context_window_tokens=128000),\n ),\n )\n ]\n\n handler_calls = []\n\n def handler():\n handler_calls.append(1)\n return custom_models\n\n client = CopilotClient(\n SubprocessConfig(cli_path=CLI_PATH),\n on_list_models=handler,\n )\n models = await client.list_models()\n assert len(handler_calls) == 1\n assert models == custom_models\n\n\nclass TestSessionConfigForwarding:\n @pytest.mark.asyncio\n async def test_create_session_forwards_client_name(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n captured = {}\n original_request = client._client.request\n\n async def mock_request(method, params):\n captured[method] = params\n return await original_request(method, params)\n\n client._client.request = mock_request\n await client.create_session(\n on_permission_request=PermissionHandler.approve_all, client_name=\"my-app\"\n )\n assert captured[\"session.create\"][\"clientName\"] == \"my-app\"\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_resume_session_forwards_client_name(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n captured = {}\n original_request = client._client.request\n\n async def mock_request(method, params):\n captured[method] = params\n if method == \"session.resume\":\n # Return a fake response to avoid needing real auth\n return {\"sessionId\": session.session_id}\n return await original_request(method, params)\n\n client._client.request = mock_request\n await client.resume_session(\n session.session_id,\n on_permission_request=PermissionHandler.approve_all,\n client_name=\"my-app\",\n )\n assert captured[\"session.resume\"][\"clientName\"] == \"my-app\"\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_create_session_forwards_provider_headers(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n captured = {}\n original_request = client._client.request\n\n async def mock_request(method, params):\n captured[method] = params\n if method == \"session.create\":\n return {\"sessionId\": params[\"sessionId\"]}\n return await original_request(method, params)\n\n client._client.request = mock_request\n await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n provider={\n \"base_url\": \"https://example.com/provider\",\n \"headers\": {\"Authorization\": \"Bearer provider-token\"},\n },\n )\n\n provider = captured[\"session.create\"][\"provider\"]\n assert provider[\"baseUrl\"] == \"https://example.com/provider\"\n assert provider[\"headers\"] == {\"Authorization\": \"Bearer provider-token\"}\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_resume_session_forwards_provider_headers(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n captured = {}\n original_request = client._client.request\n\n async def mock_request(method, params):\n captured[method] = params\n if method == \"session.resume\":\n return {\"sessionId\": session.session_id}\n return await original_request(method, params)\n\n client._client.request = mock_request\n await client.resume_session(\n session.session_id,\n on_permission_request=PermissionHandler.approve_all,\n provider={\n \"base_url\": \"https://example.com/provider\",\n \"headers\": {\"Authorization\": \"Bearer resume-token\"},\n },\n )\n\n provider = captured[\"session.resume\"][\"provider\"]\n assert provider[\"baseUrl\"] == \"https://example.com/provider\"\n assert provider[\"headers\"] == {\"Authorization\": \"Bearer resume-token\"}\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_session_send_forwards_request_headers(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n captured = {}\n original_request = client._client.request\n\n async def mock_request(method, params):\n captured[method] = params\n if method == \"session.send\":\n return {\"messageId\": \"msg-1\"}\n return await original_request(method, params)\n\n client._client.request = mock_request\n await session.send(\n \"hello\",\n request_headers={\"Authorization\": \"Bearer turn-token\"},\n )\n\n assert captured[\"session.send\"][\"prompt\"] == \"hello\"\n assert captured[\"session.send\"][\"requestHeaders\"] == {\n \"Authorization\": \"Bearer turn-token\"\n }\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_create_session_forwards_agent(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n captured = {}\n original_request = client._client.request\n\n async def mock_request(method, params):\n captured[method] = params\n return await original_request(method, params)\n\n client._client.request = mock_request\n await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n agent=\"test-agent\",\n custom_agents=[{\"name\": \"test-agent\", \"prompt\": \"You are a test agent.\"}],\n )\n assert captured[\"session.create\"][\"agent\"] == \"test-agent\"\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_resume_session_forwards_agent(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n captured = {}\n original_request = client._client.request\n\n async def mock_request(method, params):\n captured[method] = params\n if method == \"session.resume\":\n return {\"sessionId\": session.session_id}\n return await original_request(method, params)\n\n client._client.request = mock_request\n await client.resume_session(\n session.session_id,\n on_permission_request=PermissionHandler.approve_all,\n agent=\"test-agent\",\n custom_agents=[{\"name\": \"test-agent\", \"prompt\": \"You are a test agent.\"}],\n )\n assert captured[\"session.resume\"][\"agent\"] == \"test-agent\"\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_create_session_defaults_include_sub_agent_streaming_events_to_true(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n captured = {}\n original_request = client._client.request\n\n async def mock_request(method, params):\n captured[method] = params\n return await original_request(method, params)\n\n client._client.request = mock_request\n await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n assert captured[\"session.create\"][\"includeSubAgentStreamingEvents\"] is True\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_create_session_preserves_explicit_false_include_sub_agent_streaming_events(\n self,\n ):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n captured = {}\n original_request = client._client.request\n\n async def mock_request(method, params):\n captured[method] = params\n return await original_request(method, params)\n\n client._client.request = mock_request\n await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n include_sub_agent_streaming_events=False,\n )\n assert captured[\"session.create\"][\"includeSubAgentStreamingEvents\"] is False\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_resume_session_defaults_include_sub_agent_streaming_events_to_true(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n captured = {}\n original_request = client._client.request\n\n async def mock_request(method, params):\n captured[method] = params\n if method == \"session.resume\":\n return {\"sessionId\": session.session_id}\n return await original_request(method, params)\n\n client._client.request = mock_request\n await client.resume_session(\n session.session_id,\n on_permission_request=PermissionHandler.approve_all,\n )\n assert captured[\"session.resume\"][\"includeSubAgentStreamingEvents\"] is True\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_resume_session_preserves_explicit_false_include_sub_agent_streaming_events(\n self,\n ):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n captured = {}\n original_request = client._client.request\n\n async def mock_request(method, params):\n captured[method] = params\n if method == \"session.resume\":\n return {\"sessionId\": session.session_id}\n return await original_request(method, params)\n\n client._client.request = mock_request\n await client.resume_session(\n session.session_id,\n on_permission_request=PermissionHandler.approve_all,\n include_sub_agent_streaming_events=False,\n )\n assert captured[\"session.resume\"][\"includeSubAgentStreamingEvents\"] is False\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_resume_session_forwards_continue_pending_work(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n captured: dict = {}\n original_request = client._client.request\n\n async def mock_request(method, params):\n captured[method] = params\n if method == \"session.resume\":\n return {\"sessionId\": session.session_id}\n return await original_request(method, params)\n\n client._client.request = mock_request\n await client.resume_session(\n session.session_id,\n on_permission_request=PermissionHandler.approve_all,\n continue_pending_work=True,\n )\n assert captured[\"session.resume\"][\"continuePendingWork\"] is True\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_resume_session_omits_continue_pending_work_by_default(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n captured: dict = {}\n original_request = client._client.request\n\n async def mock_request(method, params):\n captured[method] = params\n if method == \"session.resume\":\n return {\"sessionId\": session.session_id}\n return await original_request(method, params)\n\n client._client.request = mock_request\n await client.resume_session(\n session.session_id,\n on_permission_request=PermissionHandler.approve_all,\n )\n assert \"continuePendingWork\" not in captured[\"session.resume\"]\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_set_model_sends_correct_rpc(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n captured = {}\n original_request = client._client.request\n\n async def mock_request(method, params):\n captured[method] = params\n if method == \"session.model.switchTo\":\n return {}\n return await original_request(method, params)\n\n client._client.request = mock_request\n await session.set_model(\"gpt-4.1\")\n assert captured[\"session.model.switchTo\"][\"sessionId\"] == session.session_id\n assert captured[\"session.model.switchTo\"][\"modelId\"] == \"gpt-4.1\"\n finally:\n await client.force_stop()\n\n\nclass TestCopilotClientContextManager:\n @pytest.mark.asyncio\n async def test_aenter_calls_start_and_returns_self(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n with patch.object(client, \"start\", new_callable=AsyncMock) as mock_start:\n result = await client.__aenter__()\n mock_start.assert_awaited_once()\n assert result is client\n\n @pytest.mark.asyncio\n async def test_aexit_calls_stop(self):\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n with patch.object(client, \"stop\", new_callable=AsyncMock) as mock_stop:\n await client.__aexit__(None, None, None)\n mock_stop.assert_awaited_once()\n\n\nclass TestCopilotSessionContextManager:\n @pytest.mark.asyncio\n async def test_aenter_returns_self(self):\n from copilot.session import CopilotSession\n\n session = CopilotSession.__new__(CopilotSession)\n result = await session.__aenter__()\n assert result is session\n\n @pytest.mark.asyncio\n async def test_aexit_calls_disconnect(self):\n from copilot.session import CopilotSession\n\n session = CopilotSession.__new__(CopilotSession)\n with patch.object(session, \"disconnect\", new_callable=AsyncMock) as mock_disconnect:\n await session.__aexit__(None, None, None)\n mock_disconnect.assert_awaited_once()\n" }, { "path": "python/test_commands_and_elicitation.py", "content": "\"\"\"\nUnit tests for Commands, UI Elicitation (client→server), and\nonElicitationContext (server→client callback) features.\n\nMirrors the Node.js client.test.ts tests for these features.\n\"\"\"\n\nimport asyncio\nfrom collections.abc import Callable\n\nimport pytest\n\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\nfrom copilot.session import (\n CommandContext,\n CommandDefinition,\n ElicitationContext,\n ElicitationResult,\n PermissionHandler,\n)\nfrom e2e.testharness import CLI_PATH\n\n\nasync def _wait_for(predicate: Callable[[], bool], timeout: float = 2.0) -> None:\n \"\"\"Poll predicate until True or timeout. Replaces brittle ``asyncio.sleep`` waits.\n\n Used in unit tests where we dispatch an event and need to wait for the consumer\n coroutine to invoke a handler and (sometimes) for the handler to issue an RPC\n that our mock captures. Polling at 5ms means fast machines exit quickly while\n slow machines still get up to ``timeout`` seconds before the test fails.\n \"\"\"\n deadline = asyncio.get_event_loop().time() + timeout\n while not predicate():\n if asyncio.get_event_loop().time() >= deadline:\n raise AssertionError(f\"Condition not met within {timeout}s\")\n await asyncio.sleep(0.005)\n\n\n# ============================================================================\n# Commands\n# ============================================================================\n\n\nclass TestCommands:\n @pytest.mark.asyncio\n async def test_forwards_commands_in_session_create_rpc(self):\n \"\"\"Verifies that commands (name + description) are serialized in session.create payload.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n captured: dict = {}\n original_request = client._client.request\n\n async def mock_request(method, params):\n captured[method] = params\n return await original_request(method, params)\n\n client._client.request = mock_request\n\n await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n commands=[\n CommandDefinition(\n name=\"deploy\",\n description=\"Deploy the app\",\n handler=lambda ctx: None,\n ),\n CommandDefinition(\n name=\"rollback\",\n handler=lambda ctx: None,\n ),\n ],\n )\n\n payload = captured[\"session.create\"]\n assert payload[\"commands\"] == [\n {\"name\": \"deploy\", \"description\": \"Deploy the app\"},\n {\"name\": \"rollback\", \"description\": None},\n ]\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_forwards_commands_in_session_resume_rpc(self):\n \"\"\"Verifies that commands are serialized in session.resume payload.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n\n captured: dict = {}\n\n async def mock_request(method, params):\n captured[method] = params\n if method == \"session.resume\":\n return {\"sessionId\": params[\"sessionId\"]}\n raise RuntimeError(f\"Unexpected method: {method}\")\n\n client._client.request = mock_request\n\n await client.resume_session(\n session.session_id,\n on_permission_request=PermissionHandler.approve_all,\n commands=[\n CommandDefinition(\n name=\"deploy\",\n description=\"Deploy\",\n handler=lambda ctx: None,\n ),\n ],\n )\n\n payload = captured[\"session.resume\"]\n assert payload[\"commands\"] == [{\"name\": \"deploy\", \"description\": \"Deploy\"}]\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_routes_command_execute_event_to_correct_handler(self):\n \"\"\"Verifies the command dispatch works for command.execute events.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n handler_calls: list[CommandContext] = []\n\n async def deploy_handler(ctx: CommandContext) -> None:\n handler_calls.append(ctx)\n\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n commands=[\n CommandDefinition(name=\"deploy\", handler=deploy_handler),\n ],\n )\n\n # Mock the RPC so handlePendingCommand doesn't fail\n rpc_calls: list[tuple] = []\n original_request = client._client.request\n\n async def mock_request(method, params):\n if method == \"session.commands.handlePendingCommand\":\n rpc_calls.append((method, params))\n return {\"success\": True}\n return await original_request(method, params)\n\n client._client.request = mock_request\n\n # Simulate a command.execute broadcast event\n from copilot.generated.session_events import (\n CommandExecuteData,\n SessionEvent,\n SessionEventType,\n )\n\n event = SessionEvent(\n data=CommandExecuteData(\n request_id=\"req-1\",\n command=\"/deploy production\",\n command_name=\"deploy\",\n args=\"production\",\n ),\n id=\"evt-1\",\n timestamp=\"2025-01-01T00:00:00Z\",\n type=SessionEventType.COMMAND_EXECUTE,\n ephemeral=True,\n parent_id=None,\n )\n session._dispatch_event(event)\n\n # Wait for the consumer coroutine to invoke the handler and the handler\n # to issue the handlePendingCommand RPC that our mock captures.\n await _wait_for(lambda: len(handler_calls) >= 1 and len(rpc_calls) >= 1)\n\n assert len(handler_calls) == 1\n assert handler_calls[0].session_id == session.session_id\n assert handler_calls[0].command == \"/deploy production\"\n assert handler_calls[0].command_name == \"deploy\"\n assert handler_calls[0].args == \"production\"\n\n # Verify handlePendingCommand was called\n assert len(rpc_calls) >= 1\n assert rpc_calls[0][1][\"requestId\"] == \"req-1\"\n # No error key means success\n assert \"error\" not in rpc_calls[0][1] or rpc_calls[0][1].get(\"error\") is None\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_sends_error_when_command_handler_throws(self):\n \"\"\"Verifies error is sent via RPC when a command handler raises.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n\n def fail_handler(ctx: CommandContext) -> None:\n raise RuntimeError(\"deploy failed\")\n\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n commands=[\n CommandDefinition(name=\"fail\", handler=fail_handler),\n ],\n )\n\n rpc_calls: list[tuple] = []\n original_request = client._client.request\n\n async def mock_request(method, params):\n if method == \"session.commands.handlePendingCommand\":\n rpc_calls.append((method, params))\n return {\"success\": True}\n return await original_request(method, params)\n\n client._client.request = mock_request\n\n from copilot.generated.session_events import (\n CommandExecuteData,\n SessionEvent,\n SessionEventType,\n )\n\n event = SessionEvent(\n data=CommandExecuteData(\n request_id=\"req-2\",\n command=\"/fail\",\n command_name=\"fail\",\n args=\"\",\n ),\n id=\"evt-2\",\n timestamp=\"2025-01-01T00:00:00Z\",\n type=SessionEventType.COMMAND_EXECUTE,\n ephemeral=True,\n parent_id=None,\n )\n session._dispatch_event(event)\n\n await _wait_for(lambda: len(rpc_calls) >= 1)\n\n assert len(rpc_calls) >= 1\n assert rpc_calls[0][1][\"requestId\"] == \"req-2\"\n assert \"deploy failed\" in rpc_calls[0][1][\"error\"]\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_sends_error_for_unknown_command(self):\n \"\"\"Verifies error is sent via RPC for an unrecognized command.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n commands=[\n CommandDefinition(name=\"deploy\", handler=lambda ctx: None),\n ],\n )\n\n rpc_calls: list[tuple] = []\n original_request = client._client.request\n\n async def mock_request(method, params):\n if method == \"session.commands.handlePendingCommand\":\n rpc_calls.append((method, params))\n return {\"success\": True}\n return await original_request(method, params)\n\n client._client.request = mock_request\n\n from copilot.generated.session_events import (\n CommandExecuteData,\n SessionEvent,\n SessionEventType,\n )\n\n event = SessionEvent(\n data=CommandExecuteData(\n request_id=\"req-3\",\n command=\"/unknown\",\n command_name=\"unknown\",\n args=\"\",\n ),\n id=\"evt-3\",\n timestamp=\"2025-01-01T00:00:00Z\",\n type=SessionEventType.COMMAND_EXECUTE,\n ephemeral=True,\n parent_id=None,\n )\n session._dispatch_event(event)\n\n await _wait_for(lambda: len(rpc_calls) >= 1)\n\n assert len(rpc_calls) >= 1\n assert rpc_calls[0][1][\"requestId\"] == \"req-3\"\n assert \"Unknown command\" in rpc_calls[0][1][\"error\"]\n finally:\n await client.force_stop()\n\n\n# ============================================================================\n# UI Elicitation (client → server)\n# ============================================================================\n\n\nclass TestUiElicitation:\n @pytest.mark.asyncio\n async def test_reads_capabilities_from_session_create_response(self):\n \"\"\"Verifies capabilities are parsed from session.create response.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n original_request = client._client.request\n\n async def mock_request(method, params):\n if method == \"session.create\":\n result = await original_request(method, params)\n return {**result, \"capabilities\": {\"ui\": {\"elicitation\": True}}}\n return await original_request(method, params)\n\n client._client.request = mock_request\n\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n assert session.capabilities == {\"ui\": {\"elicitation\": True}}\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_defaults_capabilities_when_not_injected(self):\n \"\"\"Verifies capabilities default to empty when server returns none.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n # CLI returns actual capabilities; in headless mode, elicitation is\n # either False or absent. Just verify we don't crash.\n ui_caps = session.capabilities.get(\"ui\", {})\n assert ui_caps.get(\"elicitation\") in (False, None, True)\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_elicitation_throws_when_capability_is_missing(self):\n \"\"\"Verifies that UI methods throw when elicitation is not supported.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n # Force capabilities to not support elicitation\n session._set_capabilities({})\n\n with pytest.raises(RuntimeError, match=\"not supported\"):\n await session.ui.elicitation(\n {\n \"message\": \"Enter name\",\n \"requestedSchema\": {\n \"type\": \"object\",\n \"properties\": {\"name\": {\"type\": \"string\", \"minLength\": 1}},\n \"required\": [\"name\"],\n },\n }\n )\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_confirm_throws_when_capability_is_missing(self):\n \"\"\"Verifies confirm throws when elicitation is not supported.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n session._set_capabilities({})\n\n with pytest.raises(RuntimeError, match=\"not supported\"):\n await session.ui.confirm(\"Deploy?\")\n finally:\n await client.force_stop()\n\n\n# ============================================================================\n# onElicitationContext (server → client callback)\n# ============================================================================\n\n\nclass TestOnElicitationContext:\n @pytest.mark.asyncio\n async def test_sends_request_elicitation_flag_when_handler_provided(self):\n \"\"\"Verifies requestElicitation=true is sent when onElicitationContext is provided.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n captured: dict = {}\n original_request = client._client.request\n\n async def mock_request(method, params):\n captured[method] = params\n return await original_request(method, params)\n\n client._client.request = mock_request\n\n async def elicitation_handler(\n context: ElicitationContext,\n ) -> ElicitationResult:\n return {\"action\": \"accept\", \"content\": {}}\n\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n on_elicitation_request=elicitation_handler,\n )\n assert session is not None\n\n payload = captured[\"session.create\"]\n assert payload[\"requestElicitation\"] is True\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_does_not_send_request_elicitation_when_no_handler(self):\n \"\"\"Verifies requestElicitation=false when no handler is provided.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n captured: dict = {}\n original_request = client._client.request\n\n async def mock_request(method, params):\n captured[method] = params\n return await original_request(method, params)\n\n client._client.request = mock_request\n\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n )\n assert session is not None\n\n payload = captured[\"session.create\"]\n assert payload[\"requestElicitation\"] is False\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_sends_cancel_when_elicitation_handler_throws(self):\n \"\"\"Verifies auto-cancel when the elicitation handler raises.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n\n async def bad_handler(\n context: ElicitationContext,\n ) -> ElicitationResult:\n raise RuntimeError(\"handler exploded\")\n\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n on_elicitation_request=bad_handler,\n )\n\n rpc_calls: list[tuple] = []\n original_request = client._client.request\n\n async def mock_request(method, params):\n if method == \"session.ui.handlePendingElicitation\":\n rpc_calls.append((method, params))\n return {\"success\": True}\n return await original_request(method, params)\n\n client._client.request = mock_request\n\n # Call _handle_elicitation_request directly (as Node.js test does)\n await session._handle_elicitation_request(\n {\"session_id\": session.session_id, \"message\": \"Pick a color\"}, \"req-123\"\n )\n\n assert len(rpc_calls) >= 1\n cancel_call = next(\n (call for call in rpc_calls if call[1].get(\"result\", {}).get(\"action\") == \"cancel\"),\n None,\n )\n assert cancel_call is not None\n assert cancel_call[1][\"requestId\"] == \"req-123\"\n assert cancel_call[1][\"result\"][\"action\"] == \"cancel\"\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_dispatches_elicitation_requested_event_to_handler(self):\n \"\"\"Verifies that an elicitation.requested event dispatches to the handler.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n handler_calls: list = []\n\n async def elicitation_handler(\n context: ElicitationContext,\n ) -> ElicitationResult:\n handler_calls.append(context)\n return {\"action\": \"accept\", \"content\": {\"color\": \"blue\"}}\n\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n on_elicitation_request=elicitation_handler,\n )\n\n rpc_calls: list[tuple] = []\n original_request = client._client.request\n\n async def mock_request(method, params):\n if method == \"session.ui.handlePendingElicitation\":\n rpc_calls.append((method, params))\n return {\"success\": True}\n return await original_request(method, params)\n\n client._client.request = mock_request\n\n from copilot.generated.session_events import (\n ElicitationRequestedData,\n SessionEvent,\n SessionEventType,\n )\n\n event = SessionEvent(\n data=ElicitationRequestedData(\n request_id=\"req-elicit-1\",\n message=\"Pick a color\",\n ),\n id=\"evt-elicit-1\",\n timestamp=\"2025-01-01T00:00:00Z\",\n type=SessionEventType.ELICITATION_REQUESTED,\n ephemeral=True,\n parent_id=None,\n )\n session._dispatch_event(event)\n\n await _wait_for(lambda: len(handler_calls) >= 1 and len(rpc_calls) >= 1)\n\n assert len(handler_calls) == 1\n assert handler_calls[0][\"message\"] == \"Pick a color\"\n\n assert len(rpc_calls) >= 1\n assert rpc_calls[0][1][\"requestId\"] == \"req-elicit-1\"\n assert rpc_calls[0][1][\"result\"][\"action\"] == \"accept\"\n finally:\n await client.force_stop()\n\n @pytest.mark.asyncio\n async def test_elicitation_handler_receives_full_schema(self):\n \"\"\"Verifies that requestedSchema passes type, properties, and required to handler.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n handler_calls: list = []\n\n async def elicitation_handler(\n context: ElicitationContext,\n ) -> ElicitationResult:\n handler_calls.append(context)\n return {\"action\": \"cancel\"}\n\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all,\n on_elicitation_request=elicitation_handler,\n )\n\n original_request = client._client.request\n\n async def mock_request(method, params):\n if method == \"session.ui.handlePendingElicitation\":\n return {\"success\": True}\n return await original_request(method, params)\n\n client._client.request = mock_request\n\n from copilot.generated.session_events import (\n ElicitationRequestedData,\n ElicitationRequestedSchema,\n SessionEvent,\n SessionEventType,\n )\n\n event = SessionEvent(\n data=ElicitationRequestedData(\n request_id=\"req-schema-1\",\n message=\"Fill in your details\",\n requested_schema=ElicitationRequestedSchema(\n type=\"object\",\n properties={\n \"name\": {\"type\": \"string\"},\n \"age\": {\"type\": \"number\"},\n },\n required=[\"name\", \"age\"],\n ),\n ),\n id=\"evt-schema-1\",\n timestamp=\"2025-01-01T00:00:00Z\",\n type=SessionEventType.ELICITATION_REQUESTED,\n ephemeral=True,\n parent_id=None,\n )\n session._dispatch_event(event)\n\n await _wait_for(lambda: len(handler_calls) >= 1)\n\n assert len(handler_calls) == 1\n schema = handler_calls[0].get(\"requestedSchema\")\n assert schema is not None, \"Expected requestedSchema in handler call\"\n assert schema[\"type\"] == \"object\"\n assert \"name\" in schema[\"properties\"]\n assert \"age\" in schema[\"properties\"]\n assert schema[\"required\"] == [\"name\", \"age\"]\n finally:\n await client.force_stop()\n\n\n# ============================================================================\n# Capabilities changed event\n# ============================================================================\n\n\nclass TestCapabilitiesChanged:\n @pytest.mark.asyncio\n async def test_capabilities_changed_event_updates_session(self):\n \"\"\"Verifies that a capabilities.changed event updates session capabilities.\"\"\"\n client = CopilotClient(SubprocessConfig(cli_path=CLI_PATH))\n await client.start()\n\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all\n )\n session._set_capabilities({})\n\n from copilot.generated.session_events import (\n CapabilitiesChangedData,\n CapabilitiesChangedUI,\n SessionEvent,\n SessionEventType,\n )\n\n event = SessionEvent(\n data=CapabilitiesChangedData(ui=CapabilitiesChangedUI(elicitation=True)),\n id=\"evt-cap-1\",\n timestamp=\"2025-01-01T00:00:00Z\",\n type=SessionEventType.CAPABILITIES_CHANGED,\n ephemeral=True,\n parent_id=None,\n )\n session._dispatch_event(event)\n\n assert session.capabilities.get(\"ui\", {}).get(\"elicitation\") is True\n finally:\n await client.force_stop()\n" }, { "path": "python/test_event_forward_compatibility.py", "content": "\"\"\"\nTest that unknown event types are handled gracefully for forward compatibility.\n\nThis test verifies that:\n1. The session.usage_info event type is recognized\n2. Unknown future event types map to UNKNOWN enum value\n3. Real parsing errors (malformed data) are NOT suppressed and surface for visibility\n\"\"\"\n\nfrom datetime import datetime\nfrom uuid import uuid4\n\nimport pytest\n\nfrom copilot.generated.session_events import (\n Data,\n ElicitationCompletedAction,\n ElicitationRequestedMode,\n ElicitationRequestedSchema,\n PermissionRequest,\n PermissionRequestMemoryAction,\n SessionEventType,\n SessionTaskCompleteData,\n UserMessageAgentMode,\n UserMessageAttachmentGithubReferenceType,\n session_event_from_dict,\n session_event_to_dict,\n)\n\n\nclass TestEventForwardCompatibility:\n \"\"\"Test forward compatibility for unknown event types.\"\"\"\n\n def test_session_usage_info_is_recognized(self):\n \"\"\"The session.usage_info event type should be in the enum.\"\"\"\n assert SessionEventType.SESSION_USAGE_INFO.value == \"session.usage_info\"\n\n def test_unknown_event_type_maps_to_unknown(self):\n \"\"\"Unknown event types should map to UNKNOWN enum value for forward compatibility.\"\"\"\n unknown_event = {\n \"id\": str(uuid4()),\n \"timestamp\": datetime.now().isoformat(),\n \"parentId\": None,\n \"type\": \"session.future_feature_from_server\",\n \"data\": {},\n }\n\n event = session_event_from_dict(unknown_event)\n assert event.type == SessionEventType.UNKNOWN, f\"Expected UNKNOWN, got {event.type}\"\n\n def test_known_event_preserves_top_level_agent_id(self):\n \"\"\"Known events should preserve the top-level sub-agent envelope ID.\"\"\"\n known_event = {\n \"id\": str(uuid4()),\n \"timestamp\": datetime.now().isoformat(),\n \"parentId\": None,\n \"agentId\": \"agent-1\",\n \"type\": \"user.message\",\n \"data\": {\"content\": \"Hello\"},\n }\n\n event = session_event_from_dict(known_event)\n assert event.agent_id == \"agent-1\"\n assert session_event_to_dict(event)[\"agentId\"] == \"agent-1\"\n\n def test_unknown_event_preserves_top_level_agent_id(self):\n \"\"\"Unknown events should preserve the top-level sub-agent envelope ID.\"\"\"\n unknown_event = {\n \"id\": str(uuid4()),\n \"timestamp\": datetime.now().isoformat(),\n \"parentId\": None,\n \"agentId\": \"future-agent\",\n \"type\": \"session.future_feature_from_server\",\n \"data\": {\"key\": \"value\"},\n }\n\n event = session_event_from_dict(unknown_event)\n assert event.type == SessionEventType.UNKNOWN\n assert event.agent_id == \"future-agent\"\n serialized = session_event_to_dict(event)\n assert serialized[\"agentId\"] == \"future-agent\"\n assert serialized[\"type\"] == \"session.future_feature_from_server\"\n\n def test_malformed_uuid_raises_error(self):\n \"\"\"Malformed UUIDs should raise ValueError for visibility, not be suppressed.\"\"\"\n malformed_event = {\n \"id\": \"not-a-valid-uuid\",\n \"timestamp\": datetime.now().isoformat(),\n \"parentId\": None,\n \"type\": \"session.start\",\n \"data\": {},\n }\n\n # This should raise an error and NOT be silently suppressed\n with pytest.raises(ValueError):\n session_event_from_dict(malformed_event)\n\n def test_malformed_timestamp_raises_error(self):\n \"\"\"Malformed timestamps should raise an error for visibility.\"\"\"\n malformed_event = {\n \"id\": str(uuid4()),\n \"timestamp\": \"not-a-valid-timestamp\",\n \"parentId\": None,\n \"type\": \"session.start\",\n \"data\": {},\n }\n\n # This should raise an error and NOT be silently suppressed\n with pytest.raises((ValueError, TypeError)):\n session_event_from_dict(malformed_event)\n\n def test_explicit_generated_symbols_remain_available(self):\n \"\"\"Explicit generated helper symbols should remain importable.\"\"\"\n assert ElicitationCompletedAction.ACCEPT.value == \"accept\"\n assert UserMessageAgentMode.INTERACTIVE.value == \"interactive\"\n assert ElicitationRequestedMode.FORM.value == \"form\"\n assert UserMessageAttachmentGithubReferenceType.PR.value == \"pr\"\n\n schema = ElicitationRequestedSchema(\n properties={\"answer\": {\"type\": \"string\"}}, type=\"object\"\n )\n assert schema.to_dict()[\"type\"] == \"object\"\n\n def test_data_shim_preserves_raw_mapping_values(self):\n \"\"\"Compatibility Data should keep arbitrary nested mappings as plain dicts.\"\"\"\n parsed = Data.from_dict(\n {\n \"arguments\": {\"toolCallId\": \"call-1\"},\n \"input\": {\"step_name\": \"build\"},\n }\n )\n assert parsed.arguments == {\"toolCallId\": \"call-1\"}\n assert isinstance(parsed.arguments, dict)\n assert parsed.input == {\"step_name\": \"build\"}\n assert isinstance(parsed.input, dict)\n\n constructed = Data(arguments={\"tool_call_id\": \"call-1\"})\n assert constructed.to_dict() == {\"arguments\": {\"tool_call_id\": \"call-1\"}}\n\n def test_schema_defaults_are_applied_for_missing_optional_fields(self):\n \"\"\"Generated event models should honor primitive schema defaults during parsing.\"\"\"\n request = PermissionRequest.from_dict({\"kind\": \"memory\", \"fact\": \"remember this\"})\n assert request.action == PermissionRequestMemoryAction.STORE\n\n task_complete = SessionTaskCompleteData.from_dict({\"success\": True})\n assert task_complete.summary == \"\"\n" }, { "path": "python/test_jsonrpc.py", "content": "\"\"\"\nJsonRpcClient Unit Tests\n\nTests for the JSON-RPC client implementation, focusing on proper handling\nof large payloads and short reads from pipes.\n\"\"\"\n\nimport io\nimport json\nimport os\nimport threading\nimport time\n\nimport pytest\n\nfrom copilot._jsonrpc import JsonRpcClient\n\n\nclass MockProcess:\n \"\"\"Mock subprocess.Popen for testing JSON-RPC client\"\"\"\n\n def __init__(self):\n self.stdin = io.BytesIO()\n self.stdout = None # Will be set per test\n self.returncode = None\n\n def poll(self):\n return self.returncode\n\n\nclass ShortReadStream:\n \"\"\"\n Mock stream that simulates short reads from a pipe.\n\n This simulates the behavior of Unix pipes when reading data larger than\n the pipe buffer (typically 64KB). The read() method will return fewer\n bytes than requested, requiring multiple read calls.\n \"\"\"\n\n def __init__(self, data: bytes, chunk_size: int = 32768):\n \"\"\"\n Args:\n data: Complete data to be read\n chunk_size: Maximum bytes to return per read() call (simulates pipe buffer)\n \"\"\"\n self.data = data\n self.chunk_size = chunk_size\n self.pos = 0\n\n def readline(self):\n \"\"\"Read until newline\"\"\"\n end = self.data.find(b\"\\n\", self.pos) + 1\n if end == 0: # Not found\n result = self.data[self.pos :]\n self.pos = len(self.data)\n else:\n result = self.data[self.pos : end]\n self.pos = end\n return result\n\n def read(self, n: int) -> bytes:\n \"\"\"\n Read at most n bytes, but may return fewer (short read).\n\n This simulates the behavior of pipes when data exceeds buffer size.\n \"\"\"\n # Calculate how much we can return (limited by chunk_size)\n available = len(self.data) - self.pos\n to_read = min(n, available, self.chunk_size)\n\n result = self.data[self.pos : self.pos + to_read]\n self.pos += to_read\n return result\n\n\nclass TestReadExact:\n \"\"\"Tests for the _read_exact() method that handles short reads\"\"\"\n\n def test_read_exact_single_chunk(self):\n \"\"\"Test reading data that fits in a single chunk\"\"\"\n content = b\"Hello, World!\"\n mock_stream = ShortReadStream(content, chunk_size=1024)\n\n process = MockProcess()\n process.stdout = mock_stream\n\n client = JsonRpcClient(process)\n result = client._read_exact(len(content))\n\n assert result == content\n\n def test_read_exact_multiple_chunks(self):\n \"\"\"Test reading data that requires multiple chunks (short reads)\"\"\"\n # Create 100KB of data\n content = b\"x\" * 100000\n # Simulate 32KB chunks (typical pipe behavior)\n mock_stream = ShortReadStream(content, chunk_size=32768)\n\n process = MockProcess()\n process.stdout = mock_stream\n\n client = JsonRpcClient(process)\n result = client._read_exact(len(content))\n\n assert result == content\n assert len(result) == 100000\n\n def test_read_exact_at_64kb_boundary(self):\n \"\"\"Test reading exactly 64KB (common pipe buffer size)\"\"\"\n content = b\"y\" * 65536 # Exactly 64KB\n mock_stream = ShortReadStream(content, chunk_size=65536)\n\n process = MockProcess()\n process.stdout = mock_stream\n\n client = JsonRpcClient(process)\n result = client._read_exact(len(content))\n\n assert result == content\n assert len(result) == 65536\n\n def test_read_exact_exceeds_64kb(self):\n \"\"\"Test reading data that exceeds 64KB (triggers the bug without fix)\"\"\"\n # 80KB - larger than typical pipe buffer\n content = b\"z\" * 81920\n # Simulate reading with 64KB limit (macOS pipe buffer)\n mock_stream = ShortReadStream(content, chunk_size=65536)\n\n process = MockProcess()\n process.stdout = mock_stream\n\n client = JsonRpcClient(process)\n result = client._read_exact(len(content))\n\n assert result == content\n assert len(result) == 81920\n\n def test_read_exact_empty_stream_raises_eof(self):\n \"\"\"Test that reading from closed stream raises EOFError\"\"\"\n mock_stream = ShortReadStream(b\"\", chunk_size=1024)\n\n process = MockProcess()\n process.stdout = mock_stream\n\n client = JsonRpcClient(process)\n\n with pytest.raises(EOFError, match=\"Unexpected end of stream\"):\n client._read_exact(10)\n\n def test_read_exact_partial_data_raises_eof(self):\n \"\"\"Test that stream ending mid-message raises EOFError\"\"\"\n # Only 50 bytes available, but we request 100\n content = b\"a\" * 50\n mock_stream = ShortReadStream(content, chunk_size=1024)\n\n process = MockProcess()\n process.stdout = mock_stream\n\n client = JsonRpcClient(process)\n\n with pytest.raises(EOFError, match=\"Unexpected end of stream\"):\n client._read_exact(100)\n\n\nclass TestReadMessageWithLargePayloads:\n \"\"\"Tests for _read_message() with large JSON-RPC messages\"\"\"\n\n def create_jsonrpc_message(self, content_dict: dict) -> bytes:\n \"\"\"Create a complete JSON-RPC message with Content-Length header\"\"\"\n content = json.dumps(content_dict, separators=(\",\", \":\"))\n content_bytes = content.encode(\"utf-8\")\n header = f\"Content-Length: {len(content_bytes)}\\r\\n\\r\\n\"\n return header.encode(\"utf-8\") + content_bytes\n\n def test_read_message_small_payload(self):\n \"\"\"Test reading a small JSON-RPC message\"\"\"\n message = {\"jsonrpc\": \"2.0\", \"id\": \"1\", \"result\": {\"status\": \"ok\"}}\n full_data = self.create_jsonrpc_message(message)\n\n mock_stream = ShortReadStream(full_data, chunk_size=1024)\n process = MockProcess()\n process.stdout = mock_stream\n\n client = JsonRpcClient(process)\n result = client._read_message()\n\n assert result == message\n\n def test_read_message_large_payload_70kb(self):\n \"\"\"Test reading a 70KB JSON-RPC message (exceeds typical pipe buffer)\"\"\"\n # Simulate a large response with context echo (common pattern)\n large_content = \"x\" * 70000 # 70KB of data\n message = {\n \"jsonrpc\": \"2.0\",\n \"id\": \"1\",\n \"result\": {\"content\": large_content, \"status\": \"complete\"},\n }\n\n full_data = self.create_jsonrpc_message(message)\n # Simulate 64KB pipe buffer limit\n mock_stream = ShortReadStream(full_data, chunk_size=65536)\n\n process = MockProcess()\n process.stdout = mock_stream\n\n client = JsonRpcClient(process)\n result = client._read_message()\n\n assert result == message\n assert len(result[\"result\"][\"content\"]) == 70000\n\n def test_read_message_large_payload_100kb(self):\n \"\"\"Test reading a 100KB JSON-RPC message\"\"\"\n large_content = \"y\" * 100000 # 100KB\n message = {\n \"jsonrpc\": \"2.0\",\n \"id\": \"2\",\n \"result\": {\"data\": large_content, \"metadata\": {\"size\": 100000}},\n }\n\n full_data = self.create_jsonrpc_message(message)\n # Simulate short reads with 32KB chunks\n mock_stream = ShortReadStream(full_data, chunk_size=32768)\n\n process = MockProcess()\n process.stdout = mock_stream\n\n client = JsonRpcClient(process)\n result = client._read_message()\n\n assert result == message\n assert len(result[\"result\"][\"data\"]) == 100000\n\n def test_read_message_exactly_64kb_content(self):\n \"\"\"Test reading message with exactly 64KB of content\"\"\"\n content_64kb = \"z\" * 65536 # Exactly 64KB\n message = {\"jsonrpc\": \"2.0\", \"id\": \"3\", \"result\": {\"content\": content_64kb}}\n\n full_data = self.create_jsonrpc_message(message)\n mock_stream = ShortReadStream(full_data, chunk_size=65536)\n\n process = MockProcess()\n process.stdout = mock_stream\n\n client = JsonRpcClient(process)\n result = client._read_message()\n\n assert result == message\n assert len(result[\"result\"][\"content\"]) == 65536\n\n def test_read_message_multiple_messages_in_sequence(self):\n \"\"\"Test reading multiple large messages in sequence\"\"\"\n message1 = {\"jsonrpc\": \"2.0\", \"id\": \"1\", \"result\": {\"data\": \"a\" * 50000}}\n message2 = {\"jsonrpc\": \"2.0\", \"id\": \"2\", \"result\": {\"data\": \"b\" * 80000}}\n\n data1 = self.create_jsonrpc_message(message1)\n data2 = self.create_jsonrpc_message(message2)\n full_data = data1 + data2\n\n mock_stream = ShortReadStream(full_data, chunk_size=32768)\n process = MockProcess()\n process.stdout = mock_stream\n\n client = JsonRpcClient(process)\n\n result1 = client._read_message()\n assert result1 == message1\n\n result2 = client._read_message()\n assert result2 == message2\n\n\nclass ClosingStream:\n \"\"\"Stream that immediately returns empty bytes (simulates process death / EOF).\"\"\"\n\n def readline(self):\n return b\"\"\n\n def read(self, n: int) -> bytes:\n return b\"\"\n\n\nclass TestOnClose:\n \"\"\"Tests for the on_close callback when the read loop exits unexpectedly.\"\"\"\n\n def test_on_close_called_on_unexpected_exit(self):\n \"\"\"on_close fires when the stream closes while client is still running.\"\"\"\n import asyncio\n\n process = MockProcess()\n process.stdout = ClosingStream()\n\n client = JsonRpcClient(process)\n\n called = threading.Event()\n client.on_close = lambda: called.set()\n\n loop = asyncio.new_event_loop()\n try:\n client.start(loop=loop)\n assert called.wait(timeout=2), \"on_close was not called within 2 seconds\"\n finally:\n loop.close()\n\n def test_on_close_not_called_on_intentional_stop(self):\n \"\"\"on_close should not fire when stop() is called intentionally.\"\"\"\n import asyncio\n\n r_fd, w_fd = os.pipe()\n process = MockProcess()\n process.stdout = os.fdopen(r_fd, \"rb\")\n\n client = JsonRpcClient(process)\n\n called = threading.Event()\n client.on_close = lambda: called.set()\n\n loop = asyncio.new_event_loop()\n try:\n client.start(loop=loop)\n\n # Intentional stop sets _running = False before the thread sees EOF\n loop.run_until_complete(client.stop())\n os.close(w_fd)\n\n time.sleep(0.5)\n assert not called.is_set(), \"on_close should not be called on intentional stop\"\n finally:\n loop.close()\n" }, { "path": "python/test_rpc_timeout.py", "content": "\"\"\"Tests for timeout parameter on generated RPC methods.\"\"\"\n\nfrom unittest.mock import AsyncMock\n\nimport pytest\n\nfrom copilot.generated.rpc import (\n FleetApi,\n FleetStartRequest,\n ModeApi,\n ModeSetRequest,\n PlanApi,\n ServerModelsApi,\n ServerToolsApi,\n SessionMode,\n ToolsListRequest,\n)\n\n\nclass TestRpcTimeout:\n \"\"\"Tests for timeout forwarding across all four codegen branches:\n - session-scoped with params\n - session-scoped without params\n - server-scoped with params\n - server-scoped without params\n \"\"\"\n\n # ── session-scoped, with params ──────────────────────────────────\n\n @pytest.mark.asyncio\n async def test_default_timeout_not_forwarded(self):\n client = AsyncMock()\n client.request = AsyncMock(return_value={\"started\": True})\n api = FleetApi(client, \"sess-1\")\n\n await api.start(FleetStartRequest(prompt=\"go\"))\n\n client.request.assert_called_once()\n _, kwargs = client.request.call_args\n assert \"timeout\" not in kwargs\n\n @pytest.mark.asyncio\n async def test_custom_timeout_forwarded(self):\n client = AsyncMock()\n client.request = AsyncMock(return_value={\"started\": True})\n api = FleetApi(client, \"sess-1\")\n\n await api.start(FleetStartRequest(prompt=\"go\"), timeout=600.0)\n\n _, kwargs = client.request.call_args\n assert kwargs[\"timeout\"] == 600.0\n\n @pytest.mark.asyncio\n async def test_timeout_on_session_params_method(self):\n client = AsyncMock()\n client.request = AsyncMock(return_value={\"mode\": \"plan\"})\n api = ModeApi(client, \"sess-1\")\n\n await api.set(ModeSetRequest(mode=SessionMode.PLAN), timeout=120.0)\n\n _, kwargs = client.request.call_args\n assert kwargs[\"timeout\"] == 120.0\n\n # ── session-scoped, no params ────────────────────────────────────\n\n @pytest.mark.asyncio\n async def test_timeout_on_session_no_params_method(self):\n client = AsyncMock()\n client.request = AsyncMock(return_value={\"exists\": True})\n api = PlanApi(client, \"sess-1\")\n\n await api.read(timeout=90.0)\n\n _, kwargs = client.request.call_args\n assert kwargs[\"timeout\"] == 90.0\n\n @pytest.mark.asyncio\n async def test_default_timeout_on_session_no_params_method(self):\n client = AsyncMock()\n client.request = AsyncMock(return_value={\"exists\": True})\n api = PlanApi(client, \"sess-1\")\n\n await api.read()\n\n _, kwargs = client.request.call_args\n assert \"timeout\" not in kwargs\n\n # ── server-scoped, with params ─────────────────────────────────────\n\n @pytest.mark.asyncio\n async def test_timeout_on_server_params_method(self):\n client = AsyncMock()\n client.request = AsyncMock(return_value={\"tools\": []})\n api = ServerToolsApi(client)\n\n await api.list(ToolsListRequest(), timeout=60.0)\n\n _, kwargs = client.request.call_args\n assert kwargs[\"timeout\"] == 60.0\n\n @pytest.mark.asyncio\n async def test_default_timeout_on_server_params_method(self):\n client = AsyncMock()\n client.request = AsyncMock(return_value={\"tools\": []})\n api = ServerToolsApi(client)\n\n await api.list(ToolsListRequest())\n\n _, kwargs = client.request.call_args\n assert \"timeout\" not in kwargs\n\n # ── server-scoped, no params ─────────────────────────────────────\n\n @pytest.mark.asyncio\n async def test_timeout_on_server_no_params_method(self):\n client = AsyncMock()\n client.request = AsyncMock(return_value={\"models\": []})\n api = ServerModelsApi(client)\n\n await api.list(timeout=45.0)\n\n _, kwargs = client.request.call_args\n assert kwargs[\"timeout\"] == 45.0\n\n @pytest.mark.asyncio\n async def test_default_timeout_on_server_no_params_method(self):\n client = AsyncMock()\n client.request = AsyncMock(return_value={\"models\": []})\n api = ServerModelsApi(client)\n\n await api.list()\n\n _, kwargs = client.request.call_args\n assert \"timeout\" not in kwargs\n" }, { "path": "python/test_telemetry.py", "content": "\"\"\"Tests for OpenTelemetry telemetry helpers.\"\"\"\n\nfrom __future__ import annotations\n\nfrom unittest.mock import patch\n\nfrom copilot._telemetry import get_trace_context, trace_context\nfrom copilot.client import SubprocessConfig, TelemetryConfig\n\n\nclass TestGetTraceContext:\n def test_returns_empty_dict_when_otel_not_installed(self):\n \"\"\"get_trace_context() returns {} when opentelemetry is not importable.\"\"\"\n real_import = __import__\n\n def _block_otel(name: str, *args, **kwargs):\n if name.startswith(\"opentelemetry\"):\n raise ImportError(\"mocked\")\n return real_import(name, *args, **kwargs)\n\n with patch(\"builtins.__import__\", side_effect=_block_otel):\n result = get_trace_context()\n\n assert result == {}\n\n def test_returns_dict_type(self):\n \"\"\"get_trace_context() always returns a dict.\"\"\"\n result = get_trace_context()\n assert isinstance(result, dict)\n\n\nclass TestTraceContext:\n def test_yields_without_error_when_no_traceparent(self):\n \"\"\"trace_context() with no traceparent should yield without error.\"\"\"\n with trace_context(None, None):\n pass # should not raise\n\n def test_yields_without_error_when_otel_not_installed(self):\n \"\"\"trace_context() should gracefully yield even if opentelemetry is missing.\"\"\"\n real_import = __import__\n\n def _block_otel(name: str, *args, **kwargs):\n if name.startswith(\"opentelemetry\"):\n raise ImportError(\"mocked\")\n return real_import(name, *args, **kwargs)\n\n with patch(\"builtins.__import__\", side_effect=_block_otel):\n with trace_context(\"00-abc-def-01\", None):\n pass # should not raise\n\n def test_yields_without_error_with_traceparent(self):\n \"\"\"trace_context() with a traceparent value should yield without error.\"\"\"\n tp = \"00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01\"\n with trace_context(tp, None):\n pass # should not raise\n\n def test_yields_without_error_with_tracestate(self):\n \"\"\"trace_context() with both traceparent and tracestate should yield without error.\"\"\"\n tp = \"00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01\"\n with trace_context(tp, \"congo=t61rcWkgMzE\"):\n pass # should not raise\n\n\nclass TestTelemetryConfig:\n def test_telemetry_config_type(self):\n \"\"\"TelemetryConfig can be constructed as a TypedDict.\"\"\"\n config: TelemetryConfig = {\n \"otlp_endpoint\": \"http://localhost:4318\",\n \"exporter_type\": \"otlp-http\",\n \"source_name\": \"my-app\",\n \"capture_content\": True,\n }\n assert config[\"otlp_endpoint\"] == \"http://localhost:4318\"\n assert config[\"capture_content\"] is True\n\n def test_telemetry_config_in_subprocess_config(self):\n \"\"\"TelemetryConfig can be used in SubprocessConfig.\"\"\"\n config = SubprocessConfig(\n telemetry={\n \"otlp_endpoint\": \"http://localhost:4318\",\n \"exporter_type\": \"otlp-http\",\n }\n )\n assert config.telemetry is not None\n assert config.telemetry[\"otlp_endpoint\"] == \"http://localhost:4318\"\n\n def test_telemetry_env_var_mapping(self):\n \"\"\"TelemetryConfig fields map to expected environment variable names.\"\"\"\n config: TelemetryConfig = {\n \"otlp_endpoint\": \"http://localhost:4318\",\n \"file_path\": \"/tmp/traces.jsonl\",\n \"exporter_type\": \"file\",\n \"source_name\": \"test-app\",\n \"capture_content\": True,\n }\n\n env: dict[str, str] = {}\n env[\"COPILOT_OTEL_ENABLED\"] = \"true\"\n if \"otlp_endpoint\" in config:\n env[\"OTEL_EXPORTER_OTLP_ENDPOINT\"] = config[\"otlp_endpoint\"]\n if \"file_path\" in config:\n env[\"COPILOT_OTEL_FILE_EXPORTER_PATH\"] = config[\"file_path\"]\n if \"exporter_type\" in config:\n env[\"COPILOT_OTEL_EXPORTER_TYPE\"] = config[\"exporter_type\"]\n if \"source_name\" in config:\n env[\"COPILOT_OTEL_SOURCE_NAME\"] = config[\"source_name\"]\n if \"capture_content\" in config:\n env[\"OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT\"] = str(\n config[\"capture_content\"]\n ).lower()\n\n assert env[\"COPILOT_OTEL_ENABLED\"] == \"true\"\n assert env[\"OTEL_EXPORTER_OTLP_ENDPOINT\"] == \"http://localhost:4318\"\n assert env[\"COPILOT_OTEL_FILE_EXPORTER_PATH\"] == \"/tmp/traces.jsonl\"\n assert env[\"COPILOT_OTEL_EXPORTER_TYPE\"] == \"file\"\n assert env[\"COPILOT_OTEL_SOURCE_NAME\"] == \"test-app\"\n assert env[\"OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT\"] == \"true\"\n\n def test_capture_content_false_maps_to_lowercase(self):\n \"\"\"capture_content=False should map to 'false' string.\"\"\"\n config: TelemetryConfig = {\"capture_content\": False}\n value = str(config[\"capture_content\"]).lower()\n assert value == \"false\"\n\n def test_empty_telemetry_config(self):\n \"\"\"An empty TelemetryConfig is valid since total=False.\"\"\"\n config: TelemetryConfig = {}\n assert len(config) == 0\n" }, { "path": "python/test_tools.py", "content": "\"\"\"Unit tests for define_tool\"\"\"\n\nimport json\n\nimport pytest\nfrom pydantic import BaseModel, Field\n\nfrom copilot import define_tool\nfrom copilot.tools import (\n ToolInvocation,\n ToolResult,\n _normalize_result,\n convert_mcp_call_tool_result,\n)\n\n\nclass TestDefineTool:\n def test_creates_tool_with_correct_name_and_description(self):\n class Params(BaseModel):\n query: str\n\n @define_tool(\"search\", description=\"Search for something\")\n def search(params: Params, invocation: ToolInvocation) -> str:\n return \"result\"\n\n assert search.name == \"search\"\n assert search.description == \"Search for something\"\n assert search.handler is not None\n assert search.parameters is not None\n\n def test_infers_name_from_function(self):\n class Params(BaseModel):\n query: str\n\n @define_tool(description=\"Search for something\")\n def my_search_tool(params: Params) -> str:\n return \"result\"\n\n assert my_search_tool.name == \"my_search_tool\"\n\n def test_generates_schema_from_pydantic_model(self):\n class Params(BaseModel):\n city: str = Field(description=\"City name\")\n unit: str = Field(description=\"Temperature unit\")\n\n @define_tool(\"get_weather\", description=\"Get weather\")\n def get_weather(params: Params, invocation: ToolInvocation) -> str:\n return \"sunny\"\n\n schema = get_weather.parameters\n assert schema is not None\n assert schema[\"type\"] == \"object\"\n assert \"city\" in schema[\"properties\"]\n assert \"unit\" in schema[\"properties\"]\n assert schema[\"properties\"][\"city\"][\"description\"] == \"City name\"\n\n async def test_handler_receives_typed_arguments(self):\n class Params(BaseModel):\n name: str\n count: int\n\n received_params = None\n\n @define_tool(\"test\", description=\"Test tool\")\n def test_tool(params: Params, invocation: ToolInvocation) -> str:\n nonlocal received_params\n received_params = params\n return \"ok\"\n\n invocation = ToolInvocation(\n session_id=\"session-1\",\n tool_call_id=\"call-1\",\n tool_name=\"test\",\n arguments={\"name\": \"Alice\", \"count\": 42},\n )\n\n await test_tool.handler(invocation)\n\n assert received_params is not None\n assert received_params.name == \"Alice\"\n assert received_params.count == 42\n\n async def test_handler_receives_invocation(self):\n class Params(BaseModel):\n pass\n\n received_inv = None\n\n @define_tool(\"test\", description=\"Test tool\")\n def test_tool(params: Params, invocation: ToolInvocation) -> str:\n nonlocal received_inv\n received_inv = invocation\n return \"ok\"\n\n invocation = ToolInvocation(\n session_id=\"session-123\",\n tool_call_id=\"call-456\",\n tool_name=\"test\",\n arguments={},\n )\n\n await test_tool.handler(invocation)\n\n assert received_inv.session_id == \"session-123\"\n assert received_inv.tool_call_id == \"call-456\"\n\n async def test_zero_param_handler(self):\n \"\"\"Handler with no parameters: def handler() -> str\"\"\"\n called = False\n\n @define_tool(\"test\", description=\"Test tool\")\n def test_tool() -> str:\n nonlocal called\n called = True\n return \"ok\"\n\n invocation = ToolInvocation(\n session_id=\"s1\",\n tool_call_id=\"c1\",\n tool_name=\"test\",\n arguments={},\n )\n\n result = await test_tool.handler(invocation)\n\n assert called\n assert result.text_result_for_llm == \"ok\"\n\n async def test_invocation_only_handler(self):\n \"\"\"Handler with only invocation: def handler(invocation) -> str\"\"\"\n received_inv = None\n\n @define_tool(\"test\", description=\"Test tool\")\n def test_tool(invocation: ToolInvocation) -> str:\n nonlocal received_inv\n received_inv = invocation\n return \"ok\"\n\n invocation = ToolInvocation(\n session_id=\"s1\",\n tool_call_id=\"c1\",\n tool_name=\"test\",\n arguments={},\n )\n\n await test_tool.handler(invocation)\n\n assert received_inv is not None\n assert received_inv.session_id == \"s1\"\n\n async def test_params_only_handler(self):\n \"\"\"Handler with only params: def handler(params) -> str\"\"\"\n\n class Params(BaseModel):\n value: str\n\n received_params = None\n\n @define_tool(\"test\", description=\"Test tool\")\n def test_tool(params: Params) -> str:\n nonlocal received_params\n received_params = params\n return \"ok\"\n\n invocation = ToolInvocation(\n session_id=\"s1\",\n tool_call_id=\"c1\",\n tool_name=\"test\",\n arguments={\"value\": \"hello\"},\n )\n\n await test_tool.handler(invocation)\n\n assert received_params is not None\n assert received_params.value == \"hello\"\n\n async def test_handler_error_is_hidden_from_llm(self):\n class Params(BaseModel):\n pass\n\n @define_tool(\"failing\", description=\"A failing tool\")\n def failing_tool(params: Params, invocation: ToolInvocation) -> str:\n raise ValueError(\"secret error message\")\n\n invocation = ToolInvocation(\n session_id=\"s1\",\n tool_call_id=\"c1\",\n tool_name=\"failing\",\n arguments={},\n )\n\n result = await failing_tool.handler(invocation)\n\n assert result.result_type == \"failure\"\n assert \"secret error message\" not in result.text_result_for_llm\n assert \"error\" in result.text_result_for_llm.lower()\n # But the actual error is stored internally\n assert result.error == \"secret error message\"\n\n async def test_function_style_api(self):\n class Params(BaseModel):\n value: str\n\n tool = define_tool(\n \"my_tool\",\n description=\"My tool\",\n handler=lambda params, inv: params.value.upper(),\n params_type=Params,\n )\n\n assert tool.name == \"my_tool\"\n assert tool.description == \"My tool\"\n\n result = await tool.handler(\n ToolInvocation(\n session_id=\"s\",\n tool_call_id=\"c\",\n tool_name=\"my_tool\",\n arguments={\"value\": \"hello\"},\n )\n )\n assert result.text_result_for_llm == \"HELLO\"\n\n def test_function_style_requires_name(self):\n class Params(BaseModel):\n value: str\n\n with pytest.raises(ValueError, match=\"name is required\"):\n define_tool(\n description=\"My tool\",\n handler=lambda params, inv: params.value.upper(),\n params_type=Params,\n )\n\n\nclass TestNormalizeResult:\n def test_none_returns_empty_success(self):\n result = _normalize_result(None)\n assert result.text_result_for_llm == \"\"\n assert result.result_type == \"success\"\n\n def test_string_passes_through(self):\n result = _normalize_result(\"hello world\")\n assert result.text_result_for_llm == \"hello world\"\n assert result.result_type == \"success\"\n\n def test_tool_result_passes_through(self):\n input_result = ToolResult(\n text_result_for_llm=\"custom\",\n result_type=\"failure\",\n error=\"some error\",\n )\n result = _normalize_result(input_result)\n assert result.text_result_for_llm == \"custom\"\n assert result.result_type == \"failure\"\n\n def test_dict_is_json_serialized(self):\n result = _normalize_result({\"key\": \"value\", \"num\": 42})\n parsed = json.loads(result.text_result_for_llm)\n assert parsed == {\"key\": \"value\", \"num\": 42}\n assert result.result_type == \"success\"\n\n def test_list_is_json_serialized(self):\n result = _normalize_result([\"a\", \"b\", \"c\"])\n assert result.text_result_for_llm == '[\"a\", \"b\", \"c\"]'\n assert result.result_type == \"success\"\n\n def test_pydantic_model_is_serialized(self):\n class Response(BaseModel):\n status: str\n count: int\n\n result = _normalize_result(Response(status=\"ok\", count=5))\n parsed = json.loads(result.text_result_for_llm)\n assert parsed == {\"status\": \"ok\", \"count\": 5}\n\n def test_list_of_pydantic_models_is_serialized(self):\n class Item(BaseModel):\n name: str\n value: int\n\n items = [Item(name=\"a\", value=1), Item(name=\"b\", value=2)]\n result = _normalize_result(items)\n parsed = json.loads(result.text_result_for_llm)\n assert parsed == [{\"name\": \"a\", \"value\": 1}, {\"name\": \"b\", \"value\": 2}]\n assert result.result_type == \"success\"\n\n def test_raises_for_unserializable_value(self):\n # Functions cannot be JSON serialized\n with pytest.raises(TypeError, match=\"Failed to serialize\"):\n _normalize_result(lambda x: x)\n\n\nclass TestConvertMcpCallToolResult:\n def test_text_only_call_tool_result(self):\n result = convert_mcp_call_tool_result(\n {\n \"content\": [{\"type\": \"text\", \"text\": \"hello\"}],\n }\n )\n assert result.text_result_for_llm == \"hello\"\n assert result.result_type == \"success\"\n\n def test_multiple_text_blocks(self):\n result = convert_mcp_call_tool_result(\n {\n \"content\": [\n {\"type\": \"text\", \"text\": \"line 1\"},\n {\"type\": \"text\", \"text\": \"line 2\"},\n ],\n }\n )\n assert result.text_result_for_llm == \"line 1\\nline 2\"\n\n def test_is_error_maps_to_failure(self):\n result = convert_mcp_call_tool_result(\n {\n \"content\": [{\"type\": \"text\", \"text\": \"oops\"}],\n \"isError\": True,\n }\n )\n assert result.result_type == \"failure\"\n\n def test_is_error_false_maps_to_success(self):\n result = convert_mcp_call_tool_result(\n {\n \"content\": [{\"type\": \"text\", \"text\": \"ok\"}],\n \"isError\": False,\n }\n )\n assert result.result_type == \"success\"\n\n def test_image_content_to_binary(self):\n result = convert_mcp_call_tool_result(\n {\n \"content\": [{\"type\": \"image\", \"data\": \"base64data\", \"mimeType\": \"image/png\"}],\n }\n )\n assert result.binary_results_for_llm is not None\n assert len(result.binary_results_for_llm) == 1\n assert result.binary_results_for_llm[0].data == \"base64data\"\n assert result.binary_results_for_llm[0].mime_type == \"image/png\"\n assert result.binary_results_for_llm[0].type == \"image\"\n\n def test_resource_text_to_text_result(self):\n result = convert_mcp_call_tool_result(\n {\n \"content\": [\n {\n \"type\": \"resource\",\n \"resource\": {\"uri\": \"file:///data.txt\", \"text\": \"file contents\"},\n },\n ],\n }\n )\n assert result.text_result_for_llm == \"file contents\"\n\n def test_resource_blob_to_binary(self):\n result = convert_mcp_call_tool_result(\n {\n \"content\": [\n {\n \"type\": \"resource\",\n \"resource\": {\n \"uri\": \"file:///img.png\",\n \"blob\": \"blobdata\",\n \"mimeType\": \"image/png\",\n },\n },\n ],\n }\n )\n assert result.binary_results_for_llm is not None\n assert len(result.binary_results_for_llm) == 1\n assert result.binary_results_for_llm[0].data == \"blobdata\"\n assert result.binary_results_for_llm[0].description == \"file:///img.png\"\n\n def test_empty_content_array(self):\n result = convert_mcp_call_tool_result({\"content\": []})\n assert result.text_result_for_llm == \"\"\n assert result.result_type == \"success\"\n\n def test_call_tool_result_dict_is_json_serialized_by_normalize(self):\n \"\"\"_normalize_result does NOT auto-detect MCP results; it JSON-serializes them.\"\"\"\n result = _normalize_result({\"content\": [{\"type\": \"text\", \"text\": \"hello\"}]})\n parsed = json.loads(result.text_result_for_llm)\n assert parsed == {\"content\": [{\"type\": \"text\", \"text\": \"hello\"}]}\n" }, { "path": "scripts/codegen/.gitignore", "content": "node_modules/\n" }, { "path": "scripts/codegen/csharp.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\n/**\n * C# code generator for session-events and RPC types.\n */\n\nimport { execFile } from \"child_process\";\nimport fs from \"fs/promises\";\nimport path from \"path\";\nimport { promisify } from \"util\";\nimport type { JSONSchema7 } from \"json-schema\";\nimport {\n cloneSchemaForCodegen,\n fixNullableRequiredRefsInApiSchema,\n getApiSchemaPath,\n getRpcSchemaTypeName,\n getSessionEventsSchemaPath,\n writeGeneratedFile,\n collectDefinitionCollections,\n postProcessSchema,\n resolveRef,\n resolveObjectSchema,\n resolveSchema,\n refTypeName,\n isRpcMethod,\n isNodeFullyExperimental,\n isNodeFullyDeprecated,\n isSchemaDeprecated,\n isObjectSchema,\n isVoidSchema,\n getNullableInner,\n getSessionEventVariantSchemas,\n getSharedSessionEventEnvelopeProperties,\n REPO_ROOT,\n type ApiSchema,\n type DefinitionCollections,\n type RpcMethod,\n type SessionEventEnvelopeProperty,\n} from \"./utils.js\";\n\nconst execFileAsync = promisify(execFile);\n\n// ── C# type rename overrides ────────────────────────────────────────────────\n// Map generated class names to shorter public-facing names.\n// Applied to base classes AND their derived variants (e.g., FooBar → Bar, FooBazShell → BarShell).\nconst TYPE_RENAMES: Record = {\n PermissionRequestedDataPermissionRequest: \"PermissionRequest\",\n};\n\n/** Apply rename to a generated class name, checking both exact match and prefix replacement for derived types. */\nfunction applyTypeRename(className: string): string {\n if (TYPE_RENAMES[className]) return TYPE_RENAMES[className];\n for (const [from, to] of Object.entries(TYPE_RENAMES)) {\n if (className.startsWith(from)) {\n return to + className.slice(from.length);\n }\n }\n return className;\n}\n\n// ── C# utilities ────────────────────────────────────────────────────────────\n\nfunction escapeXml(text: string): string {\n return text.replace(/&/g, \"&\").replace(//g, \">\");\n}\n\n/** Ensures text ends with sentence-ending punctuation. */\nfunction ensureTrailingPunctuation(text: string): string {\n const trimmed = text.trimEnd();\n if (/[.!?]$/.test(trimmed)) return trimmed;\n return `${trimmed}.`;\n}\n\nfunction xmlDocComment(description: string | undefined, indent: string): string[] {\n if (!description) return [];\n const escaped = ensureTrailingPunctuation(escapeXml(description.trim()));\n const lines = escaped.split(/\\r?\\n/);\n if (lines.length === 1) {\n return [`${indent}/// ${lines[0]}`];\n }\n return [\n `${indent}/// `,\n ...lines.map((l) => `${indent}/// ${l}`),\n `${indent}/// `,\n ];\n}\n\n/** Like xmlDocComment but skips XML escaping — use only for codegen-controlled strings that already contain valid XML tags. */\nfunction rawXmlDocSummary(text: string, indent: string): string[] {\n const line = ensureTrailingPunctuation(text.trim());\n return [`${indent}/// ${line}`];\n}\n\n/** Emits a summary (from description or fallback) and, when a real description exists, a remarks line with the fallback. */\nfunction xmlDocCommentWithFallback(description: string | undefined, fallback: string, indent: string): string[] {\n if (description) {\n return [\n ...xmlDocComment(description, indent),\n `${indent}/// ${ensureTrailingPunctuation(fallback)}`,\n ];\n }\n return rawXmlDocSummary(fallback, indent);\n}\n\n/** Emits a summary from the schema description, or a fallback naming the property by its JSON key. */\nfunction xmlDocPropertyComment(description: string | undefined, jsonPropName: string, indent: string): string[] {\n if (description) return xmlDocComment(description, indent);\n return rawXmlDocSummary(`Gets or sets the ${escapeXml(jsonPropName)} value.`, indent);\n}\n\n/** Emits a summary from the schema description, or a generic fallback. */\nfunction xmlDocEnumComment(description: string | undefined, indent: string): string[] {\n if (description) return xmlDocComment(description, indent);\n return rawXmlDocSummary(`Defines the allowed values.`, indent);\n}\n\nfunction toPascalCase(name: string): string {\n if (name.includes(\"_\") || name.includes(\"-\")) {\n return name.split(/[-_]/).map((p) => p.charAt(0).toUpperCase() + p.slice(1)).join(\"\");\n }\n return name.charAt(0).toUpperCase() + name.slice(1);\n}\n\nfunction typeToClassName(typeName: string): string {\n return typeName.split(/[._]/).map((p) => p.charAt(0).toUpperCase() + p.slice(1)).join(\"\");\n}\n\nfunction toPascalCaseEnumMember(value: string): string {\n return value.split(/[-_.]/).map((p) => p.charAt(0).toUpperCase() + p.slice(1)).join(\"\");\n}\n\nasync function formatCSharpFile(filePath: string): Promise {\n try {\n const projectFile = path.join(REPO_ROOT, \"dotnet/src/GitHub.Copilot.SDK.csproj\");\n await execFileAsync(\"dotnet\", [\"format\", projectFile, \"--include\", filePath]);\n console.log(` ✓ Formatted with dotnet format`);\n } catch {\n // dotnet format not available, skip\n }\n}\n\nfunction collectRpcMethods(node: Record): RpcMethod[] {\n const results: RpcMethod[] = [];\n for (const value of Object.values(node)) {\n if (isRpcMethod(value)) {\n results.push(value);\n } else if (typeof value === \"object\" && value !== null) {\n results.push(...collectRpcMethods(value as Record));\n }\n }\n return results;\n}\n\nfunction schemaTypeToCSharp(schema: JSONSchema7, required: boolean, knownTypes: Map): string {\n const nullableInner = getNullableInner(schema);\n if (nullableInner) {\n // Pass required=true to get the base type, then add \"?\" for nullable\n return schemaTypeToCSharp(nullableInner, true, knownTypes) + \"?\";\n }\n if (schema.$ref) {\n const refName = schema.$ref.split(\"/\").pop()!;\n return knownTypes.get(refName) || refName;\n }\n // Titled union schemas (anyOf with a title) — use the title if it's a known generated type\n if (schema.title && schema.anyOf && knownTypes.has(schema.title)) {\n return required ? schema.title : `${schema.title}?`;\n }\n const type = schema.type;\n const format = schema.format;\n // Handle type: [\"string\", \"null\"] patterns (nullable string)\n if (Array.isArray(type)) {\n const nonNullTypes = type.filter((t) => t !== \"null\");\n if (nonNullTypes.length === 1 && nonNullTypes[0] === \"string\") {\n if (format === \"uuid\") return \"Guid?\";\n if (format === \"date-time\") return \"DateTimeOffset?\";\n return \"string?\";\n }\n if (nonNullTypes.length === 1 && (nonNullTypes[0] === \"number\" || nonNullTypes[0] === \"integer\")) {\n if (format === \"duration\") {\n return \"TimeSpan?\";\n }\n return nonNullTypes[0] === \"integer\" ? \"long?\" : \"double?\";\n }\n }\n if (type === \"string\") {\n if (format === \"uuid\") return required ? \"Guid\" : \"Guid?\";\n if (format === \"date-time\") return required ? \"DateTimeOffset\" : \"DateTimeOffset?\";\n return required ? \"string\" : \"string?\";\n }\n if (type === \"number\" || type === \"integer\") {\n if (format === \"duration\") {\n return required ? \"TimeSpan\" : \"TimeSpan?\";\n }\n if (type === \"integer\") return required ? \"long\" : \"long?\";\n return required ? \"double\" : \"double?\";\n }\n if (type === \"boolean\") return required ? \"bool\" : \"bool?\";\n if (type === \"array\") {\n const items = schema.items as JSONSchema7 | undefined;\n const itemType = items ? schemaTypeToCSharp(items, true, knownTypes) : \"object\";\n return required ? `${itemType}[]` : `${itemType}[]?`;\n }\n if (type === \"object\") {\n if (schema.additionalProperties && typeof schema.additionalProperties === \"object\") {\n const valueType = schemaTypeToCSharp(schema.additionalProperties as JSONSchema7, true, knownTypes);\n return required ? `IDictionary` : `IDictionary?`;\n }\n return required ? \"object\" : \"object?\";\n }\n return required ? \"object\" : \"object?\";\n}\n\n/** Tracks whether any TimeSpan property was emitted so the converter can be generated. */\n\n\n/**\n * Emit C# data-annotation attributes for a JSON Schema property.\n * Returns an array of attribute lines (without trailing newlines).\n */\nfunction emitDataAnnotations(schema: JSONSchema7, indent: string): string[] {\n const attrs: string[] = [];\n const format = schema.format;\n\n // [Url] + [StringSyntax(StringSyntaxAttribute.Uri)] for format: \"uri\"\n if (format === \"uri\") {\n attrs.push(`${indent}[Url]`);\n attrs.push(`${indent}[StringSyntax(StringSyntaxAttribute.Uri)]`);\n }\n\n // [StringSyntax(StringSyntaxAttribute.Regex)] for format: \"regex\"\n if (format === \"regex\") {\n attrs.push(`${indent}[StringSyntax(StringSyntaxAttribute.Regex)]`);\n }\n\n // [Base64String] for base64-encoded string properties\n if (format === \"byte\" || (schema as Record).contentEncoding === \"base64\") {\n attrs.push(`${indent}[Base64String]`);\n }\n\n // [Range] for minimum/maximum\n const hasMin = typeof schema.minimum === \"number\";\n const hasMax = typeof schema.maximum === \"number\";\n if (hasMin || hasMax) {\n const namedArgs: string[] = [];\n if (schema.exclusiveMinimum === true) namedArgs.push(\"MinimumIsExclusive = true\");\n if (schema.exclusiveMaximum === true) namedArgs.push(\"MaximumIsExclusive = true\");\n const namedSuffix = namedArgs.length > 0 ? `, ${namedArgs.join(\", \")}` : \"\";\n if (schema.type === \"integer\") {\n // Use Range(double, double) for AOT/trimming compatibility.\n // The Range(Type, string, string) overload uses TypeConverter which triggers IL2026.\n const min = hasMin ? String(schema.minimum) : \"long.MinValue\";\n const max = hasMax ? String(schema.maximum) : \"long.MaxValue\";\n attrs.push(`${indent}[Range((double)${min}, (double)${max}${namedSuffix})]`);\n } else {\n const min = hasMin ? String(schema.minimum) : \"double.MinValue\";\n const max = hasMax ? String(schema.maximum) : \"double.MaxValue\";\n attrs.push(`${indent}[Range(${min}, ${max}${namedSuffix})]`);\n }\n }\n\n // [RegularExpression] for pattern\n if (typeof schema.pattern === \"string\") {\n const escaped = schema.pattern.replace(/\\\\/g, \"\\\\\\\\\").replace(/\"/g, '\\\\\"');\n attrs.push(`${indent}[RegularExpression(\"${escaped}\")]`);\n }\n\n // [MinLength] / [MaxLength] for string constraints\n if (typeof schema.minLength === \"number\" || typeof schema.maxLength === \"number\") {\n attrs.push(\n `${indent}[UnconditionalSuppressMessage(\"Trimming\", \"IL2026\", Justification = \"Safe for generated string properties: JSON Schema minLength/maxLength map to string length validation, not reflection over trimmed Count members\")]`\n );\n }\n if (typeof schema.minLength === \"number\") {\n attrs.push(`${indent}[MinLength(${schema.minLength})]`);\n }\n if (typeof schema.maxLength === \"number\") {\n attrs.push(`${indent}[MaxLength(${schema.maxLength})]`);\n }\n\n return attrs;\n}\n\n/**\n * Returns true when a TimeSpan-typed property needs a [JsonConverter] attribute.\n *\n * NOTE: The runtime schema uses `format: \"duration\"` on numeric (integer/number) fields\n * to mean \"a duration value expressed in milliseconds\". This differs from the JSON Schema\n * spec, where `format: \"duration\"` denotes an ISO 8601 duration string (e.g. \"PT1H30M\").\n * The generator and runtime agree on this convention, so we map these to TimeSpan with a\n * milliseconds-based JSON converter rather than expecting ISO 8601 strings.\n */\nfunction isDurationProperty(schema: JSONSchema7): boolean {\n if (schema.format === \"duration\") {\n const t = schema.type;\n if (t === \"number\" || t === \"integer\") return true;\n if (Array.isArray(t)) {\n const nonNull = (t as string[]).filter((x) => x !== \"null\");\n if (nonNull.length === 1 && (nonNull[0] === \"number\" || nonNull[0] === \"integer\")) return true;\n }\n }\n return false;\n}\n\n\nconst COPYRIGHT = `/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/`;\n\n// ══════════════════════════════════════════════════════════════════════════════\n// SESSION EVENTS\n// ══════════════════════════════════════════════════════════════════════════════\n\ninterface EventVariant {\n typeName: string;\n className: string;\n dataClassName: string;\n dataSchema: JSONSchema7;\n dataDescription?: string;\n}\n\nlet generatedEnums = new Map();\n\n/** Schema definitions available during session event generation (for $ref resolution). */\nlet sessionDefinitions: DefinitionCollections = { definitions: {}, $defs: {} };\n\nfunction getOrCreateEnum(parentClassName: string, propName: string, values: string[], enumOutput: string[], description?: string, explicitName?: string, deprecated?: boolean): string {\n const enumName = explicitName ?? `${parentClassName}${propName}`;\n const existing = generatedEnums.get(enumName);\n if (existing) return existing.enumName;\n generatedEnums.set(enumName, { enumName, values });\n\n const lines: string[] = [];\n lines.push(...xmlDocEnumComment(description, \"\"));\n if (deprecated) lines.push(`[Obsolete(\"This member is deprecated and will be removed in a future version.\")]`);\n lines.push(`[JsonConverter(typeof(JsonStringEnumConverter<${enumName}>))]`, `public enum ${enumName}`, `{`);\n for (const value of values) {\n lines.push(` /// The ${escapeXml(value)} variant.`);\n lines.push(` [JsonStringEnumMemberName(\"${value}\")]`, ` ${toPascalCaseEnumMember(value)},`);\n }\n lines.push(`}`, \"\");\n enumOutput.push(lines.join(\"\\n\"));\n return enumName;\n}\n\nfunction extractEventVariants(schema: JSONSchema7): EventVariant[] {\n const definitionCollections = collectDefinitionCollections(schema as Record);\n return getSessionEventVariantSchemas(schema, definitionCollections)\n .map((variant) => {\n const typeSchema = variant.properties!.type as JSONSchema7;\n const typeName = typeSchema?.const as string;\n if (!typeName) throw new Error(\"Variant must have type.const\");\n const baseName = typeToClassName(typeName);\n const dataSchema =\n resolveObjectSchema(variant.properties!.data as JSONSchema7, definitionCollections) ??\n resolveSchema(variant.properties!.data as JSONSchema7, definitionCollections) ??\n (variant.properties!.data as JSONSchema7);\n return {\n typeName,\n className: `${baseName}Event`,\n dataClassName: `${baseName}Data`,\n dataSchema,\n dataDescription: dataSchema?.description,\n };\n });\n}\n\n/**\n * Find a discriminator property shared by all variants in an anyOf.\n */\nfunction findDiscriminator(variants: JSONSchema7[]): { property: string; mapping: Map } | null {\n if (variants.length === 0) return null;\n const firstVariant = variants[0];\n if (!firstVariant.properties) return null;\n\n for (const [propName, propSchema] of Object.entries(firstVariant.properties).sort(([a], [b]) => a.localeCompare(b))) {\n if (typeof propSchema !== \"object\") continue;\n const schema = propSchema as JSONSchema7;\n if (schema.const === undefined) continue;\n\n const mapping = new Map();\n let isValidDiscriminator = true;\n\n for (const variant of variants) {\n if (!variant.properties) { isValidDiscriminator = false; break; }\n const variantProp = variant.properties[propName];\n if (typeof variantProp !== \"object\") { isValidDiscriminator = false; break; }\n const variantSchema = variantProp as JSONSchema7;\n if (variantSchema.const === undefined) { isValidDiscriminator = false; break; }\n mapping.set(String(variantSchema.const), variant);\n }\n\n if (isValidDiscriminator && mapping.size === variants.length) {\n return { property: propName, mapping };\n }\n }\n return null;\n}\n\n/** Callback that resolves the C# type for a property schema within a polymorphic class. */\ntype PropertyTypeResolver = (\n propSchema: JSONSchema7,\n parentClassName: string,\n propName: string,\n isRequired: boolean,\n knownTypes: Map,\n nestedClasses: Map,\n enumOutput: string[]\n) => string;\n\n/**\n * Generate a polymorphic base class and derived classes for a discriminated union.\n */\nfunction generatePolymorphicClasses(\n baseClassName: string,\n discriminatorProperty: string,\n variants: JSONSchema7[],\n knownTypes: Map,\n nestedClasses: Map,\n enumOutput: string[],\n description?: string,\n propertyResolver?: PropertyTypeResolver\n): string {\n const resolver = propertyResolver ?? resolveSessionPropertyType;\n const lines: string[] = [];\n const discriminatorInfo = findDiscriminator(variants)!;\n const renamedBase = applyTypeRename(baseClassName);\n\n lines.push(...xmlDocCommentWithFallback(description, `Polymorphic base type discriminated by ${escapeXml(discriminatorProperty)}.`, \"\"));\n lines.push(`[JsonPolymorphic(`);\n lines.push(` TypeDiscriminatorPropertyName = \"${discriminatorProperty}\",`);\n lines.push(` UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FallBackToBaseType)]`);\n\n for (const [constValue] of discriminatorInfo.mapping) {\n const derivedClassName = applyTypeRename(`${baseClassName}${toPascalCase(constValue)}`);\n lines.push(`[JsonDerivedType(typeof(${derivedClassName}), \"${constValue}\")]`);\n }\n\n lines.push(`public partial class ${renamedBase}`);\n lines.push(`{`);\n lines.push(` /// The type discriminator.`);\n lines.push(` [JsonPropertyName(\"${discriminatorProperty}\")]`);\n lines.push(` public virtual string ${toPascalCase(discriminatorProperty)} { get; set; } = string.Empty;`);\n lines.push(`}`);\n lines.push(\"\");\n\n for (const [constValue, variant] of discriminatorInfo.mapping) {\n const derivedClassName = applyTypeRename(`${baseClassName}${toPascalCase(constValue)}`);\n const derivedCode = generateDerivedClass(derivedClassName, renamedBase, discriminatorProperty, constValue, variant, knownTypes, nestedClasses, enumOutput, resolver);\n nestedClasses.set(derivedClassName, derivedCode);\n }\n\n return lines.join(\"\\n\");\n}\n\n/**\n * Generate a derived class for a discriminated union variant.\n */\nfunction generateDerivedClass(\n className: string,\n baseClassName: string,\n discriminatorProperty: string,\n discriminatorValue: string,\n schema: JSONSchema7,\n knownTypes: Map,\n nestedClasses: Map,\n enumOutput: string[],\n propertyResolver: PropertyTypeResolver\n): string {\n const lines: string[] = [];\n const required = new Set(schema.required || []);\n\n lines.push(...xmlDocCommentWithFallback(schema.description, `The ${escapeXml(discriminatorValue)} variant of .`, \"\"));\n if (isSchemaDeprecated(schema)) lines.push(`[Obsolete(\"This member is deprecated and will be removed in a future version.\")]`);\n lines.push(`public partial class ${className} : ${baseClassName}`);\n lines.push(`{`);\n lines.push(` /// `);\n lines.push(` [JsonIgnore]`);\n lines.push(` public override string ${toPascalCase(discriminatorProperty)} => \"${discriminatorValue}\";`);\n lines.push(\"\");\n\n if (schema.properties) {\n for (const [propName, propSchema] of Object.entries(schema.properties).sort(([a], [b]) => a.localeCompare(b))) {\n if (typeof propSchema !== \"object\") continue;\n if (propName === discriminatorProperty) continue;\n\n const isReq = required.has(propName);\n const csharpName = toPascalCase(propName);\n const csharpType = propertyResolver(propSchema as JSONSchema7, className, csharpName, isReq, knownTypes, nestedClasses, enumOutput);\n\n lines.push(...xmlDocPropertyComment((propSchema as JSONSchema7).description, propName, \" \"));\n lines.push(...emitDataAnnotations(propSchema as JSONSchema7, \" \"));\n if (isSchemaDeprecated(propSchema as JSONSchema7)) lines.push(` [Obsolete(\"This member is deprecated and will be removed in a future version.\")]`);\n if (isDurationProperty(propSchema as JSONSchema7)) lines.push(` [JsonConverter(typeof(MillisecondsTimeSpanConverter))]`);\n if (!isReq) lines.push(` [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]`);\n lines.push(` [JsonPropertyName(\"${propName}\")]`);\n const reqMod = isReq && !csharpType.endsWith(\"?\") ? \"required \" : \"\";\n lines.push(` public ${reqMod}${csharpType} ${csharpName} { get; set; }`, \"\");\n }\n }\n\n if (lines[lines.length - 1] === \"\") lines.pop();\n lines.push(`}`);\n return lines.join(\"\\n\");\n}\n\nfunction generateNestedClass(\n className: string,\n schema: JSONSchema7,\n knownTypes: Map,\n nestedClasses: Map,\n enumOutput: string[]\n): string {\n const required = new Set(schema.required || []);\n const lines: string[] = [];\n lines.push(...xmlDocCommentWithFallback(schema.description, `Nested data type for ${className}.`, \"\"));\n if (isSchemaDeprecated(schema)) lines.push(`[Obsolete(\"This member is deprecated and will be removed in a future version.\")]`);\n lines.push(`public partial class ${className}`, `{`);\n\n for (const [propName, propSchema] of Object.entries(schema.properties || {}).sort(([a], [b]) => a.localeCompare(b))) {\n if (typeof propSchema !== \"object\") continue;\n const prop = propSchema as JSONSchema7;\n const isReq = required.has(propName);\n const csharpName = toPascalCase(propName);\n const csharpType = resolveSessionPropertyType(prop, className, csharpName, isReq, knownTypes, nestedClasses, enumOutput);\n\n lines.push(...xmlDocPropertyComment(prop.description, propName, \" \"));\n lines.push(...emitDataAnnotations(prop, \" \"));\n if (isSchemaDeprecated(prop)) lines.push(` [Obsolete(\"This member is deprecated and will be removed in a future version.\")]`);\n if (isDurationProperty(prop)) lines.push(` [JsonConverter(typeof(MillisecondsTimeSpanConverter))]`);\n if (!isReq) lines.push(` [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]`);\n lines.push(` [JsonPropertyName(\"${propName}\")]`);\n const reqMod = isReq && !csharpType.endsWith(\"?\") ? \"required \" : \"\";\n lines.push(` public ${reqMod}${csharpType} ${csharpName} { get; set; }`, \"\");\n }\n if (lines[lines.length - 1] === \"\") lines.pop();\n lines.push(`}`);\n return lines.join(\"\\n\");\n}\n\nfunction resolveSessionPropertyType(\n propSchema: JSONSchema7,\n parentClassName: string,\n propName: string,\n isRequired: boolean,\n knownTypes: Map,\n nestedClasses: Map,\n enumOutput: string[]\n): string {\n // Handle $ref by resolving against schema definitions\n if (propSchema.$ref) {\n const className = typeToClassName(refTypeName(propSchema.$ref, sessionDefinitions));\n const refSchema = resolveRef(propSchema.$ref, sessionDefinitions);\n if (!refSchema) {\n return isRequired ? className : `${className}?`;\n }\n\n if (refSchema.enum && Array.isArray(refSchema.enum)) {\n const enumName = getOrCreateEnum(className, \"\", refSchema.enum as string[], enumOutput, refSchema.description, undefined, isSchemaDeprecated(refSchema));\n return isRequired ? enumName : `${enumName}?`;\n }\n\n if (refSchema.type === \"object\" && refSchema.properties) {\n if (!nestedClasses.has(className)) {\n nestedClasses.set(className, generateNestedClass(className, refSchema, knownTypes, nestedClasses, enumOutput));\n }\n return isRequired ? className : `${className}?`;\n }\n\n return resolveSessionPropertyType(refSchema, parentClassName, propName, isRequired, knownTypes, nestedClasses, enumOutput);\n }\n if (propSchema.anyOf) {\n const simpleNullable = getNullableInner(propSchema);\n if (simpleNullable) {\n return resolveSessionPropertyType(simpleNullable, parentClassName, propName, false, knownTypes, nestedClasses, enumOutput);\n }\n // Discriminated union: anyOf with multiple object variants sharing a const discriminator\n const nonNull = propSchema.anyOf.filter((s) => typeof s === \"object\" && s !== null && (s as JSONSchema7).type !== \"null\");\n if (nonNull.length > 1) {\n // Resolve $ref variants to their actual schemas\n const variants = (nonNull as JSONSchema7[]).map((v) => {\n if (v.$ref) {\n const resolved = resolveRef(v.$ref, sessionDefinitions);\n return resolved ?? v;\n }\n return v;\n });\n const discriminatorInfo = findDiscriminator(variants);\n if (discriminatorInfo) {\n const hasNull = propSchema.anyOf.length > nonNull.length;\n const baseClassName = (propSchema.title as string) ?? `${parentClassName}${propName}`;\n const renamedBase = applyTypeRename(baseClassName);\n const polymorphicCode = generatePolymorphicClasses(baseClassName, discriminatorInfo.property, variants, knownTypes, nestedClasses, enumOutput, propSchema.description);\n nestedClasses.set(renamedBase, polymorphicCode);\n return isRequired && !hasNull ? renamedBase : `${renamedBase}?`;\n }\n }\n return !isRequired ? \"object?\" : \"object\";\n }\n if (propSchema.enum && Array.isArray(propSchema.enum)) {\n const enumName = getOrCreateEnum(parentClassName, propName, propSchema.enum as string[], enumOutput, propSchema.description, propSchema.title as string | undefined, isSchemaDeprecated(propSchema));\n return isRequired ? enumName : `${enumName}?`;\n }\n if (propSchema.type === \"object\" && propSchema.properties) {\n const nestedClassName = (propSchema.title as string) ?? `${parentClassName}${propName}`;\n nestedClasses.set(nestedClassName, generateNestedClass(nestedClassName, propSchema, knownTypes, nestedClasses, enumOutput));\n return isRequired ? nestedClassName : `${nestedClassName}?`;\n }\n if (propSchema.type === \"array\" && propSchema.items) {\n const items = propSchema.items as JSONSchema7;\n const itemType = resolveSessionPropertyType(\n items,\n parentClassName,\n `${propName}Item`,\n true,\n knownTypes,\n nestedClasses,\n enumOutput\n );\n return isRequired ? `${itemType}[]` : `${itemType}[]?`;\n }\n if (propSchema.type === \"object\" && propSchema.additionalProperties && typeof propSchema.additionalProperties === \"object\") {\n const valueSchema = propSchema.additionalProperties as JSONSchema7;\n const valueType = resolveSessionPropertyType(\n valueSchema,\n parentClassName,\n `${propName}Value`,\n true,\n knownTypes,\n nestedClasses,\n enumOutput\n );\n return isRequired ? `IDictionary` : `IDictionary?`;\n }\n return schemaTypeToCSharp(propSchema, isRequired, knownTypes);\n}\n\nfunction generateDataClass(variant: EventVariant, knownTypes: Map, nestedClasses: Map, enumOutput: string[]): string {\n if (!variant.dataSchema?.properties) return `public partial class ${variant.dataClassName} { }`;\n\n const required = new Set(variant.dataSchema.required || []);\n const lines: string[] = [];\n if (variant.dataDescription) {\n lines.push(...xmlDocComment(variant.dataDescription, \"\"));\n } else {\n lines.push(...rawXmlDocSummary(`Event payload for .`, \"\"));\n }\n if (isSchemaDeprecated(variant.dataSchema)) {\n lines.push(`[Obsolete(\"This member is deprecated and will be removed in a future version.\")]`);\n }\n lines.push(`public partial class ${variant.dataClassName}`, `{`);\n\n for (const [propName, propSchema] of Object.entries(variant.dataSchema.properties).sort(([a], [b]) => a.localeCompare(b))) {\n if (typeof propSchema !== \"object\") continue;\n const isReq = required.has(propName);\n const csharpName = toPascalCase(propName);\n const csharpType = resolveSessionPropertyType(propSchema as JSONSchema7, variant.dataClassName, csharpName, isReq, knownTypes, nestedClasses, enumOutput);\n\n lines.push(...xmlDocPropertyComment((propSchema as JSONSchema7).description, propName, \" \"));\n lines.push(...emitDataAnnotations(propSchema as JSONSchema7, \" \"));\n if (isSchemaDeprecated(propSchema as JSONSchema7)) lines.push(` [Obsolete(\"This member is deprecated and will be removed in a future version.\")]`);\n if (isDurationProperty(propSchema as JSONSchema7)) lines.push(` [JsonConverter(typeof(MillisecondsTimeSpanConverter))]`);\n if (!isReq) lines.push(` [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]`);\n lines.push(` [JsonPropertyName(\"${propName}\")]`);\n const reqMod = isReq && !csharpType.endsWith(\"?\") ? \"required \" : \"\";\n lines.push(` public ${reqMod}${csharpType} ${csharpName} { get; set; }`, \"\");\n }\n if (lines[lines.length - 1] === \"\") lines.pop();\n lines.push(`}`);\n return lines.join(\"\\n\");\n}\n\nfunction emitSessionEventEnvelopeProperty(\n property: SessionEventEnvelopeProperty,\n knownTypes: Map,\n nestedClasses: Map,\n enumOutput: string[]\n): string[] {\n const csharpName = toPascalCase(property.name);\n const csharpType = resolveSessionPropertyType(\n property.schema,\n \"SessionEvent\",\n csharpName,\n property.required,\n knownTypes,\n nestedClasses,\n enumOutput\n );\n const lines: string[] = [];\n\n lines.push(...xmlDocPropertyComment(property.schema.description, property.name, \" \"));\n lines.push(...emitDataAnnotations(property.schema, \" \"));\n if (isSchemaDeprecated(property.schema)) lines.push(` [Obsolete(\"This member is deprecated and will be removed in a future version.\")]`);\n if (isDurationProperty(property.schema)) lines.push(` [JsonConverter(typeof(MillisecondsTimeSpanConverter))]`);\n if (!property.required) lines.push(` [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]`);\n lines.push(` [JsonPropertyName(\"${property.name}\")]`);\n lines.push(` public ${csharpType} ${csharpName} { get; set; }`, \"\");\n\n return lines;\n}\n\nfunction generateSessionEventsCode(schema: JSONSchema7): string {\n generatedEnums.clear();\n sessionDefinitions = collectDefinitionCollections(schema as Record);\n const variants = extractEventVariants(schema);\n const knownTypes = new Map();\n const nestedClasses = new Map();\n const enumOutput: string[] = [];\n const envelopeProperties = getSharedSessionEventEnvelopeProperties(schema, sessionDefinitions);\n\n const lines: string[] = [];\n lines.push(`${COPYRIGHT}\n\n// AUTO-GENERATED FILE - DO NOT EDIT\n// Generated from: session-events.schema.json\n\n#pragma warning disable CS0612 // Type or member is obsolete\n#pragma warning disable CS0618 // Type or member is obsolete (with message)\n\nusing System.ComponentModel.DataAnnotations;\nusing System.Diagnostics;\nusing System.Diagnostics.CodeAnalysis;\nusing System.Text.Json;\nusing System.Text.Json.Serialization;\n\nnamespace GitHub.Copilot.SDK;\n`);\n\n // Base class with XML doc\n lines.push(`/// `);\n lines.push(`/// Provides the base class from which all session events derive.`);\n lines.push(`/// `);\n lines.push(`[DebuggerDisplay(\"{DebuggerDisplay,nq}\")]`);\n lines.push(`[JsonPolymorphic(`, ` TypeDiscriminatorPropertyName = \"type\",`, ` IgnoreUnrecognizedTypeDiscriminators = true)]`);\n for (const variant of [...variants].sort((a, b) => a.typeName.localeCompare(b.typeName))) {\n lines.push(`[JsonDerivedType(typeof(${variant.className}), \"${variant.typeName}\")]`);\n }\n lines.push(`public partial class SessionEvent`, `{`);\n for (const property of envelopeProperties) {\n lines.push(...emitSessionEventEnvelopeProperty(property, knownTypes, nestedClasses, enumOutput));\n }\n lines.push(` /// `, ` /// The event type discriminator.`, ` /// `);\n lines.push(` [JsonIgnore]`, ` public virtual string Type => \"unknown\";`, \"\");\n lines.push(` /// Deserializes a JSON string into a .`);\n lines.push(` public static SessionEvent FromJson(string json) =>`, ` JsonSerializer.Deserialize(json, SessionEventsJsonContext.Default.SessionEvent)!;`, \"\");\n lines.push(` /// Serializes this event to a JSON string.`);\n lines.push(` public string ToJson() =>`, ` JsonSerializer.Serialize(this, SessionEventsJsonContext.Default.SessionEvent);`, \"\");\n lines.push(` [DebuggerBrowsable(DebuggerBrowsableState.Never)]`, ` private string DebuggerDisplay => ToJson();`);\n lines.push(`}`, \"\");\n\n // Event classes with XML docs\n for (const variant of variants) {\n const remarksLine = `/// Represents the ${escapeXml(variant.typeName)} event.`;\n if (variant.dataDescription) {\n lines.push(...xmlDocComment(variant.dataDescription, \"\"));\n lines.push(remarksLine);\n } else {\n lines.push(`/// Represents the ${escapeXml(variant.typeName)} event.`);\n }\n lines.push(`public partial class ${variant.className} : SessionEvent`, `{`);\n lines.push(` /// `);\n lines.push(` [JsonIgnore]`, ` public override string Type => \"${variant.typeName}\";`, \"\");\n lines.push(` /// The ${escapeXml(variant.typeName)} event payload.`);\n lines.push(` [JsonPropertyName(\"data\")]`, ` public required ${variant.dataClassName} Data { get; set; }`, `}`, \"\");\n }\n\n // Data classes\n for (const variant of variants) {\n lines.push(generateDataClass(variant, knownTypes, nestedClasses, enumOutput), \"\");\n }\n\n // Nested classes\n for (const [, code] of nestedClasses) lines.push(code, \"\");\n\n // Enums\n for (const code of enumOutput) lines.push(code);\n\n // JsonSerializerContext\n const types = [\"SessionEvent\", ...variants.flatMap((v) => [v.className, v.dataClassName]), ...nestedClasses.keys()].sort();\n lines.push(`[JsonSourceGenerationOptions(`, ` JsonSerializerDefaults.Web,`, ` AllowOutOfOrderMetadataProperties = true,`, ` NumberHandling = JsonNumberHandling.AllowReadingFromString,`, ` DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)]`);\n for (const t of types) lines.push(`[JsonSerializable(typeof(${t}))]`);\n lines.push(`[JsonSerializable(typeof(JsonElement))]`);\n lines.push(`internal partial class SessionEventsJsonContext : JsonSerializerContext;`);\n\n return lines.join(\"\\n\");\n}\n\nexport async function generateSessionEvents(schemaPath?: string): Promise {\n console.log(\"C#: generating session-events...\");\n const resolvedPath = schemaPath ?? (await getSessionEventsSchemaPath());\n const schema = cloneSchemaForCodegen(JSON.parse(await fs.readFile(resolvedPath, \"utf-8\")) as JSONSchema7);\n const processed = postProcessSchema(schema);\n const code = generateSessionEventsCode(processed);\n const outPath = await writeGeneratedFile(\"dotnet/src/Generated/SessionEvents.cs\", code);\n console.log(` ✓ ${outPath}`);\n await formatCSharpFile(outPath);\n}\n\n// ══════════════════════════════════════════════════════════════════════════════\n// RPC TYPES\n// ══════════════════════════════════════════════════════════════════════════════\n\nlet emittedRpcClassSchemas = new Map();\nlet emittedRpcEnumResultTypes = new Set();\nlet experimentalRpcTypes = new Set();\nlet rpcKnownTypes = new Map();\nlet rpcEnumOutput: string[] = [];\n\n/** Schema definitions available during RPC generation (for $ref resolution). */\nlet rpcDefinitions: DefinitionCollections = { definitions: {}, $defs: {} };\n\nfunction singularPascal(s: string): string {\n const p = toPascalCase(s);\n if (p.endsWith(\"ies\")) return `${p.slice(0, -3)}y`;\n if (/(xes|zes|ches|shes|sses)$/i.test(p)) return p.slice(0, -2);\n if (p.endsWith(\"s\") && !/(ss|us|is)$/i.test(p)) return p.slice(0, -1);\n return p;\n}\n\nfunction getMethodResultSchema(method: RpcMethod): JSONSchema7 | undefined {\n return resolveSchema(method.result, rpcDefinitions) ?? method.result ?? undefined;\n}\n\nfunction resultTypeName(method: RpcMethod): string {\n return getRpcSchemaTypeName(getMethodResultSchema(method), `${typeToClassName(method.rpcMethod)}Result`);\n}\n\n/** Returns the C# type for a method's result, accounting for nullable anyOf wrappers. */\nfunction resolvedResultTypeName(method: RpcMethod): string {\n const schema = getMethodResultSchema(method);\n if (!schema) return resultTypeName(method);\n const inner = getNullableInner(schema);\n if (inner) {\n // Nullable wrapper: resolve the inner $ref type name with \"?\" suffix\n const innerName = inner.$ref\n ? typeToClassName(refTypeName(inner.$ref, rpcDefinitions))\n : getRpcSchemaTypeName(inner, resultTypeName(method));\n return `${innerName}?`;\n }\n return resultTypeName(method);\n}\n\n/** Returns the ValueTask or ValueTask string for an incoming-handler's result type. */\nfunction handlerTaskType(method: RpcMethod): string {\n const schema = getMethodResultSchema(method);\n return !isVoidSchema(schema) ? `ValueTask<${resolvedResultTypeName(method)}>` : \"ValueTask\";\n}\n\n/** Returns the Task or Task string for an outgoing-call wrapper's result type. */\nfunction resultTaskType(method: RpcMethod): string {\n const schema = getMethodResultSchema(method);\n return !isVoidSchema(schema) ? `Task<${resolvedResultTypeName(method)}>` : \"Task\";\n}\n\nfunction paramsTypeName(method: RpcMethod): string {\n return getRpcSchemaTypeName(resolveMethodParamsSchema(method), `${typeToClassName(method.rpcMethod)}Request`);\n}\n\nfunction resolveMethodParamsSchema(method: RpcMethod): JSONSchema7 | undefined {\n return (\n resolveObjectSchema(method.params, rpcDefinitions) ??\n resolveSchema(method.params, rpcDefinitions) ??\n method.params ??\n undefined\n );\n}\n\nfunction stableStringify(value: unknown): string {\n if (Array.isArray(value)) {\n return `[${value.map((item) => stableStringify(item)).join(\",\")}]`;\n }\n if (value && typeof value === \"object\") {\n const entries = Object.entries(value as Record).sort(([a], [b]) => a.localeCompare(b));\n return `{${entries.map(([key, entryValue]) => `${JSON.stringify(key)}:${stableStringify(entryValue)}`).join(\",\")}}`;\n }\n return JSON.stringify(value);\n}\n\nfunction resolveRpcType(schema: JSONSchema7, isRequired: boolean, parentClassName: string, propName: string, classes: string[]): string {\n // Handle $ref by resolving against schema definitions and generating the referenced class\n if (schema.$ref) {\n const typeName = typeToClassName(refTypeName(schema.$ref, rpcDefinitions));\n const refSchema = resolveRef(schema.$ref, rpcDefinitions);\n if (!refSchema) {\n return isRequired ? typeName : `${typeName}?`;\n }\n\n if (refSchema.enum && Array.isArray(refSchema.enum)) {\n const enumName = getOrCreateEnum(typeName, \"\", refSchema.enum as string[], rpcEnumOutput, refSchema.description, undefined, isSchemaDeprecated(refSchema));\n return isRequired ? enumName : `${enumName}?`;\n }\n\n if (refSchema.type === \"object\" && refSchema.properties) {\n const cls = emitRpcClass(typeName, refSchema, \"public\", classes);\n if (cls) classes.push(cls);\n return isRequired ? typeName : `${typeName}?`;\n }\n\n return resolveRpcType(refSchema, isRequired, parentClassName, propName, classes);\n }\n // Handle anyOf: [T, null/{not:{}}] → T? (nullable typed property)\n const nullableInner = getNullableInner(schema);\n if (nullableInner) {\n return resolveRpcType(nullableInner, false, parentClassName, propName, classes);\n }\n // Discriminated union: anyOf with multiple variants sharing a const discriminator\n if (schema.anyOf && Array.isArray(schema.anyOf)) {\n const nonNull = schema.anyOf.filter((s) => typeof s === \"object\" && s !== null && (s as JSONSchema7).type !== \"null\");\n if (nonNull.length > 1) {\n const variants = (nonNull as JSONSchema7[]).map((v) => {\n if (v.$ref) {\n const resolved = resolveRef(v.$ref, rpcDefinitions);\n return resolved ?? v;\n }\n return v;\n });\n const discriminatorInfo = findDiscriminator(variants);\n if (discriminatorInfo) {\n const hasNull = schema.anyOf.length > nonNull.length;\n const baseClassName = (schema.title as string) ?? `${parentClassName}${propName}`;\n if (!emittedRpcClassSchemas.has(baseClassName)) {\n emittedRpcClassSchemas.set(baseClassName, \"polymorphic\");\n const nestedMap = new Map();\n const rpcPropertyResolver: PropertyTypeResolver = (propSchema, parentClass, pName, isReq, _kt, nestedCls, enumOut) => {\n const nestedRpcClasses: string[] = [];\n const result = resolveRpcType(propSchema, isReq, parentClass, pName, nestedRpcClasses);\n for (const cls of nestedRpcClasses) {\n nestedCls.set(cls.match(/class (\\w+)/)?.[1] ?? cls.slice(0, 40), cls);\n }\n return result;\n };\n const polymorphicCode = generatePolymorphicClasses(baseClassName, discriminatorInfo.property, variants, rpcKnownTypes, nestedMap, rpcEnumOutput, schema.description, rpcPropertyResolver);\n classes.push(polymorphicCode);\n for (const nested of nestedMap.values()) classes.push(nested);\n }\n return isRequired && !hasNull ? baseClassName : `${baseClassName}?`;\n }\n }\n }\n // Handle enums (string unions like \"interactive\" | \"plan\" | \"autopilot\")\n if (schema.enum && Array.isArray(schema.enum)) {\n const enumName = getOrCreateEnum(\n parentClassName,\n propName,\n schema.enum as string[],\n rpcEnumOutput,\n schema.description,\n schema.title as string | undefined,\n isSchemaDeprecated(schema),\n );\n return isRequired ? enumName : `${enumName}?`;\n }\n if (schema.type === \"object\" && schema.properties) {\n const className = (schema.title as string) ?? `${parentClassName}${propName}`;\n classes.push(emitRpcClass(className, schema, \"public\", classes));\n return isRequired ? className : `${className}?`;\n }\n if (schema.type === \"array\" && schema.items) {\n const items = schema.items as JSONSchema7;\n if (items.type === \"object\" && items.properties) {\n const itemClass = (items.title as string) ?? `${parentClassName}${singularPascal(propName)}`;\n classes.push(emitRpcClass(itemClass, items, \"public\", classes));\n return isRequired ? `IList<${itemClass}>` : `IList<${itemClass}>?`;\n }\n const itemType = resolveRpcType(items, true, parentClassName, `${propName}Item`, classes);\n return isRequired ? `IList<${itemType}>` : `IList<${itemType}>?`;\n }\n if (schema.type === \"object\" && schema.additionalProperties && typeof schema.additionalProperties === \"object\") {\n const vs = schema.additionalProperties as JSONSchema7;\n const valueType = resolveRpcType(vs, true, parentClassName, `${propName}Value`, classes);\n return isRequired ? `IDictionary` : `IDictionary?`;\n }\n return schemaTypeToCSharp(schema, isRequired, rpcKnownTypes);\n}\n\nfunction emitRpcClass(\n className: string,\n schema: JSONSchema7,\n visibility: \"public\" | \"internal\",\n extraClasses: string[]\n): string {\n const effectiveSchema =\n resolveObjectSchema(schema, rpcDefinitions) ??\n resolveSchema(schema, rpcDefinitions) ??\n schema;\n const schemaKey = stableStringify(effectiveSchema);\n const existingSchema = emittedRpcClassSchemas.get(className);\n if (existingSchema) {\n if (existingSchema !== schemaKey) {\n throw new Error(\n `Conflicting RPC class name \"${className}\" for different schemas. Add a schema title/withTypeName to disambiguate.`\n );\n }\n return \"\";\n }\n\n emittedRpcClassSchemas.set(className, schemaKey);\n\n const requiredSet = new Set(effectiveSchema.required || []);\n const lines: string[] = [];\n lines.push(...xmlDocComment(schema.description || effectiveSchema.description || `RPC data type for ${className.replace(/(Request|Result|Params)$/, \"\")} operations.`, \"\"));\n if (experimentalRpcTypes.has(className)) {\n lines.push(`[Experimental(Diagnostics.Experimental)]`);\n }\n if (isSchemaDeprecated(schema) || isSchemaDeprecated(effectiveSchema)) {\n lines.push(`[Obsolete(\"This member is deprecated and will be removed in a future version.\")]`);\n }\n lines.push(`${visibility} sealed class ${className}`, `{`);\n\n const props = Object.entries(effectiveSchema.properties || {}).sort(([a], [b]) => a.localeCompare(b));\n for (let i = 0; i < props.length; i++) {\n const [propName, propSchema] = props[i];\n if (typeof propSchema !== \"object\") continue;\n const prop = propSchema as JSONSchema7;\n const isReq = requiredSet.has(propName);\n const csharpName = toPascalCase(propName);\n const csharpType = resolveRpcType(prop, isReq, className, csharpName, extraClasses);\n\n lines.push(...xmlDocPropertyComment(prop.description, propName, \" \"));\n lines.push(...emitDataAnnotations(prop, \" \"));\n if (isSchemaDeprecated(prop)) lines.push(` [Obsolete(\"This member is deprecated and will be removed in a future version.\")]`);\n if (isDurationProperty(prop)) lines.push(` [JsonConverter(typeof(MillisecondsTimeSpanConverter))]`);\n lines.push(` [JsonPropertyName(\"${propName}\")]`);\n\n let defaultVal = \"\";\n let propAccessors = \"{ get; set; }\";\n if (isReq && !csharpType.endsWith(\"?\")) {\n if (csharpType === \"string\") defaultVal = \" = string.Empty;\";\n else if (csharpType === \"object\") defaultVal = \" = null!;\";\n else if (csharpType.startsWith(\"IList<\")) {\n propAccessors = \"{ get => field ??= []; set; }\";\n } else if (csharpType.startsWith(\"IDictionary<\")) {\n const concreteType = csharpType.replace(\"IDictionary<\", \"Dictionary<\");\n propAccessors = `{ get => field ??= new ${concreteType}(); set; }`;\n } else if (emittedRpcClassSchemas.has(csharpType)) {\n propAccessors = \"{ get => field ??= new(); set; }\";\n }\n }\n lines.push(` public ${csharpType} ${csharpName} ${propAccessors}${defaultVal}`);\n if (i < props.length - 1) lines.push(\"\");\n }\n lines.push(`}`);\n return lines.join(\"\\n\");\n}\n\n/**\n * Emit the type for a non-object RPC result schema (e.g., a bare enum).\n * Returns the C# type name to use in method signatures. For enums, ensures the enum\n * is created via getOrCreateEnum. For other primitives, returns the mapped C# type.\n */\nfunction emitNonObjectResultType(typeName: string, schema: JSONSchema7, classes: string[]): string {\n if (schema.enum && Array.isArray(schema.enum)) {\n const enumName = getOrCreateEnum(\"\", typeName, schema.enum as string[], rpcEnumOutput, schema.description, typeName, isSchemaDeprecated(schema));\n emittedRpcEnumResultTypes.add(enumName);\n return enumName;\n }\n // For other non-object types, use the basic type mapping\n return schemaTypeToCSharp(schema, true, rpcKnownTypes);\n}\n\n/**\n * Emit ServerRpc as an instance class (like SessionRpc but without sessionId).\n */\nfunction emitServerRpcClasses(node: Record, classes: string[]): string[] {\n const result: string[] = [];\n\n // Find top-level groups (e.g. \"models\", \"tools\", \"account\")\n const groups = Object.entries(node).filter(([, v]) => typeof v === \"object\" && v !== null && !isRpcMethod(v));\n // Find top-level methods (e.g. \"ping\")\n const topLevelMethods = Object.entries(node).filter(([, v]) => isRpcMethod(v));\n\n // ServerRpc class\n const srLines: string[] = [];\n srLines.push(`/// Provides server-scoped RPC methods (no session required).`);\n srLines.push(`public sealed class ServerRpc`);\n srLines.push(`{`);\n srLines.push(` private readonly JsonRpc _rpc;`);\n srLines.push(\"\");\n srLines.push(` internal ServerRpc(JsonRpc rpc)`);\n srLines.push(` {`);\n srLines.push(` _rpc = rpc;`);\n for (const [groupName] of groups) {\n srLines.push(` ${toPascalCase(groupName)} = new Server${toPascalCase(groupName)}Api(rpc);`);\n }\n srLines.push(` }`);\n\n // Top-level methods (like ping)\n for (const [key, value] of topLevelMethods) {\n if (!isRpcMethod(value)) continue;\n emitServerInstanceMethod(key, value, srLines, classes, \" \", false, false);\n }\n\n // Group properties\n for (const [groupName] of groups) {\n srLines.push(\"\");\n srLines.push(` /// ${toPascalCase(groupName)} APIs.`);\n srLines.push(` public Server${toPascalCase(groupName)}Api ${toPascalCase(groupName)} { get; }`);\n }\n\n srLines.push(`}`);\n result.push(srLines.join(\"\\n\"));\n\n // Per-group API classes\n for (const [groupName, groupNode] of groups) {\n result.push(...emitServerApiClass(`Server${toPascalCase(groupName)}Api`, groupNode as Record, classes));\n }\n\n return result;\n}\n\nfunction emitServerApiClass(className: string, node: Record, classes: string[]): string[] {\n const parts: string[] = [];\n const lines: string[] = [];\n const displayName = className.replace(/^Server/, \"\").replace(/Api$/, \"\");\n const subGroups = Object.entries(node).filter(([, v]) => typeof v === \"object\" && v !== null && !isRpcMethod(v));\n\n lines.push(`/// Provides server-scoped ${displayName} APIs.`);\n const groupExperimental = isNodeFullyExperimental(node);\n const groupDeprecated = isNodeFullyDeprecated(node);\n if (groupExperimental) {\n lines.push(`[Experimental(Diagnostics.Experimental)]`);\n }\n if (groupDeprecated) {\n lines.push(`[Obsolete(\"This member is deprecated and will be removed in a future version.\")]`);\n }\n lines.push(`public sealed class ${className}`);\n lines.push(`{`);\n lines.push(` private readonly JsonRpc _rpc;`);\n lines.push(\"\");\n lines.push(` internal ${className}(JsonRpc rpc)`);\n lines.push(` {`);\n lines.push(` _rpc = rpc;`);\n for (const [subGroupName] of subGroups) {\n const subClassName = className.replace(/Api$/, \"\") + toPascalCase(subGroupName) + \"Api\";\n lines.push(` ${toPascalCase(subGroupName)} = new ${subClassName}(rpc);`);\n }\n lines.push(` }`);\n\n for (const [key, value] of Object.entries(node)) {\n if (!isRpcMethod(value)) continue;\n emitServerInstanceMethod(key, value, lines, classes, \" \", groupExperimental, groupDeprecated);\n }\n\n for (const [subGroupName] of subGroups) {\n const subClassName = className.replace(/Api$/, \"\") + toPascalCase(subGroupName) + \"Api\";\n lines.push(\"\");\n lines.push(` /// ${toPascalCase(subGroupName)} APIs.`);\n lines.push(` public ${subClassName} ${toPascalCase(subGroupName)} { get; }`);\n }\n\n lines.push(`}`);\n parts.push(lines.join(\"\\n\"));\n\n for (const [subGroupName, subGroupNode] of subGroups) {\n const subClassName = className.replace(/Api$/, \"\") + toPascalCase(subGroupName) + \"Api\";\n parts.push(...emitServerApiClass(subClassName, subGroupNode as Record, classes));\n }\n\n return parts;\n}\n\nfunction emitServerInstanceMethod(\n name: string,\n method: RpcMethod,\n lines: string[],\n classes: string[],\n indent: string,\n groupExperimental: boolean,\n groupDeprecated: boolean\n): void {\n const methodName = toPascalCase(name);\n const resultSchema = getMethodResultSchema(method);\n let resultClassName = !isVoidSchema(resultSchema) ? resultTypeName(method) : \"\";\n if (!isVoidSchema(resultSchema) && method.stability === \"experimental\") {\n experimentalRpcTypes.add(resultClassName);\n }\n if (isObjectSchema(resultSchema)) {\n const resultClass = emitRpcClass(resultClassName, resultSchema!, \"public\", classes);\n if (resultClass) classes.push(resultClass);\n } else if (!isVoidSchema(resultSchema)) {\n resultClassName = emitNonObjectResultType(resultClassName, resultSchema!, classes);\n }\n\n const effectiveParams = resolveMethodParamsSchema(method);\n const paramEntries = effectiveParams?.properties ? Object.entries(effectiveParams.properties) : [];\n const requiredSet = new Set(effectiveParams?.required || []);\n\n // Sort so required params come before optional (C# requires defaults at end)\n paramEntries.sort((a, b) => {\n const aReq = requiredSet.has(a[0]) ? 0 : 1;\n const bReq = requiredSet.has(b[0]) ? 0 : 1;\n return aReq - bReq;\n });\n\n let requestClassName: string | null = null;\n if (paramEntries.length > 0) {\n requestClassName = paramsTypeName(method);\n if (method.stability === \"experimental\") {\n experimentalRpcTypes.add(requestClassName);\n }\n const reqClass = emitRpcClass(requestClassName, effectiveParams!, \"internal\", classes);\n if (reqClass) classes.push(reqClass);\n }\n\n lines.push(\"\");\n lines.push(`${indent}/// Calls \"${method.rpcMethod}\".`);\n if (method.stability === \"experimental\" && !groupExperimental) {\n lines.push(`${indent}[Experimental(Diagnostics.Experimental)]`);\n }\n if (method.deprecated && !groupDeprecated) {\n lines.push(`${indent}[Obsolete(\"This member is deprecated and will be removed in a future version.\")]`);\n }\n\n const sigParams: string[] = [];\n const bodyAssignments: string[] = [];\n\n for (const [pName, pSchema] of paramEntries) {\n if (typeof pSchema !== \"object\") continue;\n const isReq = requiredSet.has(pName);\n const jsonSchema = pSchema as JSONSchema7;\n const csType = requestClassName\n ? resolveRpcType(jsonSchema, isReq, requestClassName, toPascalCase(pName), classes)\n : schemaTypeToCSharp(jsonSchema, isReq, rpcKnownTypes);\n sigParams.push(`${csType} ${pName}${isReq ? \"\" : \" = null\"}`);\n bodyAssignments.push(`${toPascalCase(pName)} = ${pName}`);\n }\n sigParams.push(\"CancellationToken cancellationToken = default\");\n\n const taskType = !isVoidSchema(resultSchema) ? `Task<${resultClassName}>` : \"Task\";\n lines.push(`${indent}public async ${taskType} ${methodName}Async(${sigParams.join(\", \")})`);\n lines.push(`${indent}{`);\n if (requestClassName && bodyAssignments.length > 0) {\n lines.push(`${indent} var request = new ${requestClassName} { ${bodyAssignments.join(\", \")} };`);\n if (!isVoidSchema(resultSchema)) {\n lines.push(`${indent} return await CopilotClient.InvokeRpcAsync<${resultClassName}>(_rpc, \"${method.rpcMethod}\", [request], cancellationToken);`);\n } else {\n lines.push(`${indent} await CopilotClient.InvokeRpcAsync(_rpc, \"${method.rpcMethod}\", [request], cancellationToken);`);\n }\n } else {\n if (!isVoidSchema(resultSchema)) {\n lines.push(`${indent} return await CopilotClient.InvokeRpcAsync<${resultClassName}>(_rpc, \"${method.rpcMethod}\", [], cancellationToken);`);\n } else {\n lines.push(`${indent} await CopilotClient.InvokeRpcAsync(_rpc, \"${method.rpcMethod}\", [], cancellationToken);`);\n }\n }\n lines.push(`${indent}}`);\n}\n\nfunction emitSessionRpcClasses(node: Record, classes: string[]): string[] {\n const result: string[] = [];\n const groups = Object.entries(node).filter(([, v]) => typeof v === \"object\" && v !== null && !isRpcMethod(v));\n const topLevelMethods = Object.entries(node).filter(([, v]) => isRpcMethod(v));\n\n const srLines = [`/// Provides typed session-scoped RPC methods.`, `public sealed class SessionRpc`, `{`, ` private readonly JsonRpc _rpc;`, ` private readonly string _sessionId;`, \"\"];\n srLines.push(` internal SessionRpc(JsonRpc rpc, string sessionId)`, ` {`, ` _rpc = rpc;`, ` _sessionId = sessionId;`);\n for (const [groupName] of groups) srLines.push(` ${toPascalCase(groupName)} = new ${toPascalCase(groupName)}Api(rpc, sessionId);`);\n srLines.push(` }`);\n for (const [groupName] of groups) srLines.push(\"\", ` /// ${toPascalCase(groupName)} APIs.`, ` public ${toPascalCase(groupName)}Api ${toPascalCase(groupName)} { get; }`);\n\n // Emit top-level session RPC methods directly on the SessionRpc class\n const topLevelLines: string[] = [];\n for (const [key, value] of topLevelMethods) {\n emitSessionMethod(key, value as RpcMethod, topLevelLines, classes, \" \", false, false);\n }\n srLines.push(...topLevelLines);\n\n srLines.push(`}`);\n result.push(srLines.join(\"\\n\"));\n\n for (const [groupName, groupNode] of groups) {\n result.push(...emitSessionApiClass(`${toPascalCase(groupName)}Api`, groupNode as Record, classes));\n }\n return result;\n}\n\nfunction emitSessionMethod(key: string, method: RpcMethod, lines: string[], classes: string[], indent: string, groupExperimental: boolean, groupDeprecated: boolean): void {\n const methodName = toPascalCase(key);\n const resultSchema = getMethodResultSchema(method);\n let resultClassName = !isVoidSchema(resultSchema) ? resultTypeName(method) : \"\";\n if (!isVoidSchema(resultSchema) && method.stability === \"experimental\") {\n experimentalRpcTypes.add(resultClassName);\n }\n if (isObjectSchema(resultSchema)) {\n const resultClass = emitRpcClass(resultClassName, resultSchema!, \"public\", classes);\n if (resultClass) classes.push(resultClass);\n } else if (!isVoidSchema(resultSchema)) {\n resultClassName = emitNonObjectResultType(resultClassName, resultSchema!, classes);\n }\n\n const effectiveParams = resolveMethodParamsSchema(method);\n const paramEntries = (effectiveParams?.properties ? Object.entries(effectiveParams.properties) : []).filter(([k]) => k !== \"sessionId\");\n const requiredSet = new Set(effectiveParams?.required || []);\n\n // Sort so required params come before optional (C# requires defaults at end)\n paramEntries.sort((a, b) => {\n const aReq = requiredSet.has(a[0]) ? 0 : 1;\n const bReq = requiredSet.has(b[0]) ? 0 : 1;\n return aReq - bReq;\n });\n\n const requestClassName = paramsTypeName(method);\n if (method.stability === \"experimental\") {\n experimentalRpcTypes.add(requestClassName);\n }\n if (effectiveParams?.properties && Object.keys(effectiveParams.properties).length > 0) {\n const reqClass = emitRpcClass(requestClassName, effectiveParams, \"internal\", classes);\n if (reqClass) classes.push(reqClass);\n }\n\n lines.push(\"\", `${indent}/// Calls \"${method.rpcMethod}\".`);\n if (method.stability === \"experimental\" && !groupExperimental) {\n lines.push(`${indent}[Experimental(Diagnostics.Experimental)]`);\n }\n if (method.deprecated && !groupDeprecated) {\n lines.push(`${indent}[Obsolete(\"This member is deprecated and will be removed in a future version.\")]`);\n }\n const sigParams: string[] = [];\n const bodyAssignments = [`SessionId = _sessionId`];\n\n for (const [pName, pSchema] of paramEntries) {\n if (typeof pSchema !== \"object\") continue;\n const isReq = requiredSet.has(pName);\n const csType = resolveRpcType(pSchema as JSONSchema7, isReq, requestClassName, toPascalCase(pName), classes);\n sigParams.push(`${csType} ${pName}${isReq ? \"\" : \" = null\"}`);\n bodyAssignments.push(`${toPascalCase(pName)} = ${pName}`);\n }\n sigParams.push(\"CancellationToken cancellationToken = default\");\n\n const taskType = !isVoidSchema(resultSchema) ? `Task<${resultClassName}>` : \"Task\";\n lines.push(`${indent}public async ${taskType} ${methodName}Async(${sigParams.join(\", \")})`);\n lines.push(`${indent}{`, `${indent} var request = new ${requestClassName} { ${bodyAssignments.join(\", \")} };`);\n if (!isVoidSchema(resultSchema)) {\n lines.push(`${indent} return await CopilotClient.InvokeRpcAsync<${resultClassName}>(_rpc, \"${method.rpcMethod}\", [request], cancellationToken);`, `${indent}}`);\n } else {\n lines.push(`${indent} await CopilotClient.InvokeRpcAsync(_rpc, \"${method.rpcMethod}\", [request], cancellationToken);`, `${indent}}`);\n }\n}\n\nfunction emitSessionApiClass(className: string, node: Record, classes: string[]): string[] {\n const parts: string[] = [];\n const displayName = className.replace(/Api$/, \"\");\n const groupExperimental = isNodeFullyExperimental(node);\n const groupDeprecated = isNodeFullyDeprecated(node);\n const experimentalAttr = groupExperimental ? `[Experimental(Diagnostics.Experimental)]\\n` : \"\";\n const deprecatedAttr = groupDeprecated ? `[Obsolete(\"This member is deprecated and will be removed in a future version.\")]\\n` : \"\";\n const subGroups = Object.entries(node).filter(([, v]) => typeof v === \"object\" && v !== null && !isRpcMethod(v));\n\n const lines = [`/// Provides session-scoped ${displayName} APIs.`, `${experimentalAttr}${deprecatedAttr}public sealed class ${className}`, `{`, ` private readonly JsonRpc _rpc;`, ` private readonly string _sessionId;`, \"\"];\n lines.push(` internal ${className}(JsonRpc rpc, string sessionId)`, ` {`, ` _rpc = rpc;`, ` _sessionId = sessionId;`);\n for (const [subGroupName] of subGroups) {\n const subClassName = className.replace(/Api$/, \"\") + toPascalCase(subGroupName) + \"Api\";\n lines.push(` ${toPascalCase(subGroupName)} = new ${subClassName}(rpc, sessionId);`);\n }\n lines.push(` }`);\n\n for (const [key, value] of Object.entries(node)) {\n if (!isRpcMethod(value)) continue;\n emitSessionMethod(key, value, lines, classes, \" \", groupExperimental, groupDeprecated);\n }\n\n for (const [subGroupName] of subGroups) {\n const subClassName = className.replace(/Api$/, \"\") + toPascalCase(subGroupName) + \"Api\";\n lines.push(\"\");\n lines.push(` /// ${toPascalCase(subGroupName)} APIs.`);\n lines.push(` public ${subClassName} ${toPascalCase(subGroupName)} { get; }`);\n }\n\n lines.push(`}`);\n parts.push(lines.join(\"\\n\"));\n\n for (const [subGroupName, subGroupNode] of subGroups) {\n const subClassName = className.replace(/Api$/, \"\") + toPascalCase(subGroupName) + \"Api\";\n parts.push(...emitSessionApiClass(subClassName, subGroupNode as Record, classes));\n }\n\n return parts;\n}\n\nfunction collectClientGroups(node: Record): Array<{ groupName: string; groupNode: Record; methods: RpcMethod[] }> {\n const groups: Array<{ groupName: string; groupNode: Record; methods: RpcMethod[] }> = [];\n for (const [groupName, groupNode] of Object.entries(node)) {\n if (typeof groupNode === \"object\" && groupNode !== null) {\n groups.push({\n groupName,\n groupNode: groupNode as Record,\n methods: collectRpcMethods(groupNode as Record),\n });\n }\n }\n return groups;\n}\n\nfunction clientHandlerInterfaceName(groupName: string): string {\n return `I${toPascalCase(groupName)}Handler`;\n}\n\nfunction clientHandlerMethodName(rpcMethod: string): string {\n const parts = rpcMethod.split(\".\");\n return `${toPascalCase(parts[parts.length - 1])}Async`;\n}\n\nfunction emitClientSessionApiRegistration(clientSchema: Record, classes: string[]): string[] {\n const lines: string[] = [];\n const groups = collectClientGroups(clientSchema);\n\n for (const { methods } of groups) {\n for (const method of methods) {\n const resultSchema = getMethodResultSchema(method);\n if (!isVoidSchema(resultSchema)) {\n if (isObjectSchema(resultSchema)) {\n const resultClass = emitRpcClass(resultTypeName(method), resultSchema!, \"public\", classes);\n if (resultClass) classes.push(resultClass);\n } else {\n emitNonObjectResultType(resultTypeName(method), resultSchema!, classes);\n }\n }\n\n const effectiveParams = resolveMethodParamsSchema(method);\n if (effectiveParams?.properties && Object.keys(effectiveParams.properties).length > 0) {\n const paramsClass = emitRpcClass(paramsTypeName(method), effectiveParams, \"public\", classes);\n if (paramsClass) classes.push(paramsClass);\n }\n }\n }\n\n for (const { groupName, groupNode, methods } of groups) {\n const interfaceName = clientHandlerInterfaceName(groupName);\n const groupExperimental = isNodeFullyExperimental(groupNode);\n const groupDeprecated = isNodeFullyDeprecated(groupNode);\n lines.push(`/// Handles \\`${groupName}\\` client session API methods.`);\n if (groupExperimental) {\n lines.push(`[Experimental(Diagnostics.Experimental)]`);\n }\n if (groupDeprecated) {\n lines.push(`[Obsolete(\"This member is deprecated and will be removed in a future version.\")]`);\n }\n lines.push(`public interface ${interfaceName}`);\n lines.push(`{`);\n for (const method of methods) {\n const effectiveParams = resolveMethodParamsSchema(method);\n const hasParams = !!effectiveParams?.properties && Object.keys(effectiveParams.properties).length > 0;\n const resultSchema = getMethodResultSchema(method);\n const taskType = resultTaskType(method);\n lines.push(` /// Handles \"${method.rpcMethod}\".`);\n if (method.stability === \"experimental\" && !groupExperimental) {\n lines.push(` [Experimental(Diagnostics.Experimental)]`);\n }\n if (method.deprecated && !groupDeprecated) {\n lines.push(` [Obsolete(\"This member is deprecated and will be removed in a future version.\")]`);\n }\n if (hasParams) {\n lines.push(` ${taskType} ${clientHandlerMethodName(method.rpcMethod)}(${paramsTypeName(method)} request, CancellationToken cancellationToken = default);`);\n } else {\n lines.push(` ${taskType} ${clientHandlerMethodName(method.rpcMethod)}(CancellationToken cancellationToken = default);`);\n }\n }\n lines.push(`}`);\n lines.push(\"\");\n }\n\n lines.push(`/// Provides all client session API handler groups for a session.`);\n lines.push(`public sealed class ClientSessionApiHandlers`);\n lines.push(`{`);\n for (const { groupName } of groups) {\n lines.push(` /// Optional handler for ${toPascalCase(groupName)} client session API methods.`);\n lines.push(` public ${clientHandlerInterfaceName(groupName)}? ${toPascalCase(groupName)} { get; set; }`);\n lines.push(\"\");\n }\n if (lines[lines.length - 1] === \"\") lines.pop();\n lines.push(`}`);\n lines.push(\"\");\n\n lines.push(`/// Registers client session API handlers on a JSON-RPC connection.`);\n lines.push(`internal static class ClientSessionApiRegistration`);\n lines.push(`{`);\n lines.push(` /// `);\n lines.push(` /// Registers handlers for server-to-client session API calls.`);\n lines.push(` /// Each incoming call includes a sessionId in its params object,`);\n lines.push(` /// which is used to resolve the session's handler group.`);\n lines.push(` /// `);\n lines.push(` public static void RegisterClientSessionApiHandlers(JsonRpc rpc, Func getHandlers)`);\n lines.push(` {`);\n for (const { groupName, methods } of groups) {\n for (const method of methods) {\n const handlerProperty = toPascalCase(groupName);\n const handlerMethod = clientHandlerMethodName(method.rpcMethod);\n const effectiveParams = resolveMethodParamsSchema(method);\n const hasParams = !!effectiveParams?.properties && Object.keys(effectiveParams.properties).length > 0;\n const resultSchema = getMethodResultSchema(method);\n const paramsClass = paramsTypeName(method);\n const taskType = handlerTaskType(method);\n\n if (hasParams) {\n lines.push(` rpc.SetLocalRpcMethod(\"${method.rpcMethod}\", (Func<${paramsClass}, CancellationToken, ${taskType}>)(async (request, cancellationToken) =>`);\n lines.push(` {`);\n lines.push(` var handler = getHandlers(request.SessionId).${handlerProperty};`);\n lines.push(` if (handler is null) throw new InvalidOperationException($\"No ${groupName} handler registered for session: {request.SessionId}\");`);\n if (!isVoidSchema(resultSchema)) {\n lines.push(` return await handler.${handlerMethod}(request, cancellationToken);`);\n } else {\n lines.push(` await handler.${handlerMethod}(request, cancellationToken);`);\n }\n lines.push(` }), singleObjectParam: true);`);\n } else {\n lines.push(` rpc.SetLocalRpcMethod(\"${method.rpcMethod}\", (Func)(_ =>`);\n lines.push(` throw new InvalidOperationException(\"No params provided for ${method.rpcMethod}\")));`);\n }\n }\n }\n lines.push(` }`);\n lines.push(`}`);\n\n return lines;\n}\n\nfunction generateRpcCode(schema: ApiSchema): string {\n emittedRpcClassSchemas.clear();\n emittedRpcEnumResultTypes.clear();\n experimentalRpcTypes.clear();\n rpcKnownTypes.clear();\n rpcEnumOutput = [];\n generatedEnums.clear(); // Clear shared enum deduplication map\n rpcDefinitions = collectDefinitionCollections(schema as Record);\n const classes: string[] = [];\n\n let serverRpcParts: string[] = [];\n if (schema.server) serverRpcParts = emitServerRpcClasses(schema.server, classes);\n\n let sessionRpcParts: string[] = [];\n if (schema.session) sessionRpcParts = emitSessionRpcClasses(schema.session, classes);\n\n let clientSessionParts: string[] = [];\n if (schema.clientSession) clientSessionParts = emitClientSessionApiRegistration(schema.clientSession, classes);\n\n const lines: string[] = [];\n lines.push(`${COPYRIGHT}\n\n// AUTO-GENERATED FILE - DO NOT EDIT\n// Generated from: api.schema.json\n\n#pragma warning disable CS0612 // Type or member is obsolete\n#pragma warning disable CS0618 // Type or member is obsolete (with message)\n\nusing System.ComponentModel.DataAnnotations;\nusing System.Diagnostics.CodeAnalysis;\nusing System.Text.Json;\nusing System.Text.Json.Serialization;\n\nnamespace GitHub.Copilot.SDK.Rpc;\n\n/// Diagnostic IDs for the Copilot SDK.\ninternal static class Diagnostics\n{\n /// Indicates an experimental API that may change or be removed.\n internal const string Experimental = \"GHCP001\";\n}\n`);\n\n for (const cls of classes) if (cls) lines.push(cls, \"\");\n for (const enumCode of rpcEnumOutput) lines.push(enumCode, \"\");\n for (const part of serverRpcParts) lines.push(part, \"\");\n for (const part of sessionRpcParts) lines.push(part, \"\");\n if (clientSessionParts.length > 0) lines.push(...clientSessionParts, \"\");\n\n // Add JsonSerializerContext for AOT/trimming support\n const typeNames = [...emittedRpcClassSchemas.keys(), ...emittedRpcEnumResultTypes].sort();\n if (typeNames.length > 0) {\n lines.push(`[JsonSourceGenerationOptions(`);\n lines.push(` JsonSerializerDefaults.Web,`);\n lines.push(` AllowOutOfOrderMetadataProperties = true,`);\n lines.push(` DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)]`);\n for (const t of [\"bool\", \"double\", \"int\", \"long\", \"string\"]) lines.push(`[JsonSerializable(typeof(${t}))]`);\n for (const t of typeNames) lines.push(`[JsonSerializable(typeof(${t}))]`);\n lines.push(`internal partial class RpcJsonContext : JsonSerializerContext;`);\n }\n\n return lines.join(\"\\n\");\n}\n\nexport async function generateRpc(schemaPath?: string): Promise {\n console.log(\"C#: generating RPC types...\");\n const resolvedPath = schemaPath ?? (await getApiSchemaPath());\n const schema = fixNullableRequiredRefsInApiSchema(cloneSchemaForCodegen(JSON.parse(await fs.readFile(resolvedPath, \"utf-8\")) as ApiSchema));\n const code = generateRpcCode(schema);\n const outPath = await writeGeneratedFile(\"dotnet/src/Generated/Rpc.cs\", code);\n console.log(` ✓ ${outPath}`);\n await formatCSharpFile(outPath);\n}\n\n// ══════════════════════════════════════════════════════════════════════════════\n// MAIN\n// ══════════════════════════════════════════════════════════════════════════════\n\nasync function generate(sessionSchemaPath?: string, apiSchemaPath?: string): Promise {\n await generateSessionEvents(sessionSchemaPath);\n try {\n await generateRpc(apiSchemaPath);\n } catch (err) {\n if ((err as NodeJS.ErrnoException).code === \"ENOENT\" && !apiSchemaPath) {\n console.log(\"C#: skipping RPC (api.schema.json not found)\");\n } else {\n throw err;\n }\n }\n}\n\nconst sessionArg = process.argv[2] || undefined;\nconst apiArg = process.argv[3] || undefined;\ngenerate(sessionArg, apiArg).catch((err) => {\n console.error(\"C# generation failed:\", err);\n process.exit(1);\n});\n" }, { "path": "scripts/codegen/go.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\n/**\n * Go code generator for session-events and RPC types.\n */\n\nimport { execFile } from \"child_process\";\nimport fs from \"fs/promises\";\nimport type { JSONSchema7 } from \"json-schema\";\nimport { FetchingJSONSchemaStore, InputData, JSONSchemaInput, quicktype } from \"quicktype-core\";\nimport { promisify } from \"util\";\nimport {\n cloneSchemaForCodegen,\n fixNullableRequiredRefsInApiSchema,\n getApiSchemaPath,\n getRpcSchemaTypeName,\n getSessionEventsSchemaPath,\n hasSchemaPayload,\n isNodeFullyExperimental,\n isNodeFullyDeprecated,\n isSchemaDeprecated,\n isVoidSchema,\n getNullableInner,\n isRpcMethod,\n postProcessSchema,\n writeGeneratedFile,\n collectDefinitionCollections,\n resolveObjectSchema,\n resolveSchema,\n withSharedDefinitions,\n refTypeName,\n resolveRef,\n getSessionEventVariantSchemas,\n getSharedSessionEventEnvelopeProperties,\n type ApiSchema,\n type DefinitionCollections,\n type RpcMethod,\n type SessionEventEnvelopeProperty,\n} from \"./utils.js\";\n\nconst execFileAsync = promisify(execFile);\n\n// ── Utilities ───────────────────────────────────────────────────────────────\n\n// Go initialisms that should be all-caps\nconst goInitialisms = new Set([\"id\", \"ui\", \"uri\", \"url\", \"api\", \"http\", \"https\", \"json\", \"xml\", \"html\", \"css\", \"sql\", \"ssh\", \"tcp\", \"udp\", \"ip\", \"rpc\", \"mime\"]);\n\nfunction toPascalCase(s: string): string {\n return s\n .split(/[._]/)\n .map((w) => goInitialisms.has(w.toLowerCase()) ? w.toUpperCase() : w.charAt(0).toUpperCase() + w.slice(1))\n .join(\"\");\n}\n\nfunction toGoFieldName(jsonName: string): string {\n // Handle camelCase field names like \"modelId\" -> \"ModelID\"\n return jsonName\n .replace(/([a-z])([A-Z])/g, \"$1_$2\")\n .split(\"_\")\n .map((w) => goInitialisms.has(w.toLowerCase()) ? w.toUpperCase() : w.charAt(0).toUpperCase() + w.slice(1).toLowerCase())\n .join(\"\");\n}\n\n/**\n * Post-process Go enum constants so every constant follows the canonical\n * Go `TypeNameValue` convention. quicktype disambiguates collisions with\n * whimsical prefixes (Purple, Fluffy, …) that we replace.\n */\nfunction postProcessEnumConstants(code: string): string {\n const renames = new Map();\n\n // Match constant declarations inside const ( … ) blocks.\n const constLineRe = /^\\s+(\\w+)\\s+(\\w+)\\s*=\\s*\"([^\"]+)\"/gm;\n let m;\n while ((m = constLineRe.exec(code)) !== null) {\n const [, constName, typeName, value] = m;\n if (constName.startsWith(typeName)) continue;\n\n // Use the same initialism logic as toPascalCase so \"url\" → \"URL\", \"mcp\" → \"MCP\", etc.\n const valuePascal = value\n .split(/[._-]/)\n .map((w) => goInitialisms.has(w.toLowerCase()) ? w.toUpperCase() : w.charAt(0).toUpperCase() + w.slice(1))\n .join(\"\");\n const desired = typeName + valuePascal;\n if (constName !== desired) {\n renames.set(constName, desired);\n }\n }\n\n // Replace each const block in place, then fix switch-case references\n // in marshal/unmarshal functions. This avoids renaming struct fields.\n\n // Phase 1: Rename inside const ( … ) blocks\n code = code.replace(/^(const \\([\\s\\S]*?\\n\\))/gm, (block) => {\n let b = block;\n for (const [oldName, newName] of renames) {\n b = b.replace(new RegExp(`\\\\b${oldName}\\\\b`, \"g\"), newName);\n }\n return b;\n });\n\n // Phase 2: Rename inside func bodies (marshal/unmarshal helpers use case statements)\n code = code.replace(/^(func \\([\\s\\S]*?\\n\\})/gm, (funcBlock) => {\n let b = funcBlock;\n for (const [oldName, newName] of renames) {\n b = b.replace(new RegExp(`\\\\b${oldName}\\\\b`, \"g\"), newName);\n }\n return b;\n });\n\n return code;\n}\n\nfunction collapsePlaceholderGoStructs(code: string, knownDefinitionNames?: Set): string {\n const structBlockRe = /((?:\\/\\/.*\\r?\\n)*)type\\s+(\\w+)\\s+struct\\s*\\{[\\s\\S]*?^\\}/gm;\n const matches = [...code.matchAll(structBlockRe)].map((match) => ({\n fullBlock: match[0],\n name: match[2],\n normalizedBody: normalizeGoStructBlock(match[0], match[2]),\n }));\n const groups = new Map();\n\n for (const match of matches) {\n const group = groups.get(match.normalizedBody) ?? [];\n group.push(match);\n groups.set(match.normalizedBody, group);\n }\n\n for (const group of groups.values()) {\n if (group.length < 2) continue;\n\n const canonical = chooseCanonicalPlaceholderDuplicate(group.map(({ name }) => name), knownDefinitionNames);\n if (!canonical) continue;\n\n for (const duplicate of group) {\n if (duplicate.name === canonical) continue;\n // Only collapse types that quicktype invented (Class suffix or not\n // in the schema's named definitions). Preserve intentionally-named types.\n if (!isPlaceholderTypeName(duplicate.name) && knownDefinitionNames?.has(duplicate.name.toLowerCase())) continue;\n\n code = code.replace(duplicate.fullBlock, \"\");\n code = code.replace(new RegExp(`\\\\b${duplicate.name}\\\\b`, \"g\"), canonical);\n }\n }\n\n return code.replace(/\\n{3,}/g, \"\\n\\n\");\n}\n\nfunction normalizeGoStructBlock(block: string, name: string): string {\n return block\n .replace(/^\\s*\\/\\/.*\\r?\\n/gm, \"\")\n .replace(new RegExp(`^type\\\\s+${name}\\\\s+struct\\\\s*\\\\{`, \"m\"), \"type struct {\")\n .split(/\\r?\\n/)\n .map((line) => line.trim())\n .filter((line) => line.length > 0)\n .join(\"\\n\");\n}\n\nfunction chooseCanonicalPlaceholderDuplicate(names: string[], knownDefinitionNames?: Set): string | undefined {\n // Prefer the name that matches a schema definition — it's intentionally named.\n if (knownDefinitionNames) {\n const definedName = names.find((name) => knownDefinitionNames.has(name.toLowerCase()));\n if (definedName) return definedName;\n }\n // Fallback for Class-suffix placeholders: pick the non-placeholder name.\n const specificNames = names.filter((name) => !isPlaceholderTypeName(name));\n if (specificNames.length === 0) return undefined;\n return specificNames[0];\n}\n\nfunction isPlaceholderTypeName(name: string): boolean {\n return name.endsWith(\"Class\");\n}\n\n/**\n * Extract a mapping from (structName, jsonFieldName) → goFieldName\n * so the wrapper code references the actual quicktype-generated field names.\n */\nfunction extractFieldNames(qtCode: string): Map> {\n const result = new Map>();\n const structRe = /^type\\s+(\\w+)\\s+struct\\s*\\{([^}]*)\\}/gm;\n let sm;\n while ((sm = structRe.exec(qtCode)) !== null) {\n const [, structName, body] = sm;\n const fields = new Map();\n const fieldRe = /^\\s+(\\w+)\\s+[^`\\n]+`json:\"([^\",]+)/gm;\n let fm;\n while ((fm = fieldRe.exec(body)) !== null) {\n fields.set(fm[2], fm[1]);\n }\n result.set(structName, fields);\n }\n return result;\n}\n\n/**\n * Add `,omitempty` to JSON tags for optional fields in quicktype-generated structs.\n *\n * Quicktype's Go renderer emits `omitempty` for most optional fields, but it can miss\n * some — notably fields whose type is `*Foo` where `Foo` is a `$ref` to an `anyOf` union\n * (e.g., `FilterMapping`). When such a pointer field is left without `omitempty`, the Go\n * struct serializes the nil pointer as `\"foo\": null`, which the runtime's Zod schema\n * rejects with a validation error.\n *\n * This pass walks each known struct (whose schema is in `definitions`) and rewrites any\n * `json:\"propName\"` tag (no comma, no modifier) to `json:\"propName,omitempty\"` when\n * `propName` is not listed in the schema's `required` array.\n */\nfunction addMissingOmitemptyToQuicktypeStructs(\n qtCode: string,\n definitions: Record\n): string {\n // Build a case-insensitive lookup from emitted Go type name → schema definition.\n const defByLower = new Map();\n for (const [name, def] of Object.entries(definitions)) {\n defByLower.set(name.toLowerCase(), def);\n }\n\n return qtCode.replace(\n /^(type\\s+(\\w+)\\s+struct\\s*\\{)([\\s\\S]*?)^\\}/gm,\n (match, header: string, typeName: string, body: string) => {\n const def = defByLower.get(typeName.toLowerCase());\n if (!def || typeof def !== \"object\") return match;\n\n // Build the union of (properties, required) across the schema. For a regular\n // object schema this is just (properties, required). For a discriminated union\n // (anyOf with $ref variants), quicktype emits a flat struct merging all variant\n // fields — we need to consider a property required only if it is required in\n // every variant and present in every variant.\n const merged = mergeSchemaPropertiesForOmitempty(def, defByLower);\n if (!merged) return match;\n const { properties, required } = merged;\n\n const newBody = body.replace(\n /(`json:\")([a-zA-Z0-9_]+)(\"`)/g,\n (tagMatch: string, open: string, propName: string, close: string) => {\n if (required.has(propName)) return tagMatch;\n if (!(propName in properties)) return tagMatch;\n return `${open}${propName},omitempty${close}`;\n }\n );\n return `${header}${newBody}}`;\n }\n );\n}\n\nfunction mergeSchemaPropertiesForOmitempty(\n def: JSONSchema7,\n defByLower: Map\n): { properties: Record; required: Set } | undefined {\n if (def.properties) {\n return {\n properties: def.properties as Record,\n required: new Set(def.required || []),\n };\n }\n if (Array.isArray(def.anyOf)) {\n const variantSchemas: JSONSchema7[] = [];\n for (const v of def.anyOf as JSONSchema7[]) {\n if (typeof v !== \"object\" || v === null) continue;\n if (v.$ref) {\n const refName = v.$ref.split(\"/\").pop();\n if (!refName) continue;\n const resolved = defByLower.get(refName.toLowerCase());\n if (resolved && resolved.properties) variantSchemas.push(resolved);\n } else if (v.properties) {\n variantSchemas.push(v);\n }\n }\n if (variantSchemas.length === 0) return undefined;\n\n const properties: Record = {};\n const presenceCount = new Map();\n const requiredEverywhere = new Set();\n let firstVariant = true;\n for (const variant of variantSchemas) {\n const variantRequired = new Set(variant.required || []);\n const propNames = Object.keys(variant.properties || {});\n if (firstVariant) {\n for (const name of variantRequired) requiredEverywhere.add(name);\n firstVariant = false;\n } else {\n for (const name of [...requiredEverywhere]) {\n if (!variantRequired.has(name)) requiredEverywhere.delete(name);\n }\n }\n for (const name of propNames) {\n presenceCount.set(name, (presenceCount.get(name) ?? 0) + 1);\n if (!(name in properties)) {\n properties[name] = (variant.properties as Record)[name];\n }\n }\n }\n const required = new Set();\n for (const name of requiredEverywhere) {\n if ((presenceCount.get(name) ?? 0) === variantSchemas.length) required.add(name);\n }\n return { properties, required };\n }\n return undefined;\n}\n\nfunction extractQuicktypeImports(qtCode: string): { code: string; imports: string[] } {\n const collectedImports: string[] = [];\n let code = qtCode.replace(/^import \\(\\n([\\s\\S]*?)^\\)\\n+/m, (_match, block: string) => {\n for (const line of block.split(/\\r?\\n/)) {\n const trimmed = line.trim();\n if (trimmed.length > 0) {\n collectedImports.push(trimmed);\n }\n }\n return \"\";\n });\n\n code = code.replace(/^import (\"[^\"]+\")\\n+/m, (_match, singleImport: string) => {\n collectedImports.push(singleImport.trim());\n return \"\";\n });\n\n return { code, imports: collectedImports };\n}\n\nasync function formatGoFile(filePath: string): Promise {\n try {\n await execFileAsync(\"go\", [\"fmt\", filePath]);\n console.log(` ✓ Formatted with go fmt`);\n } catch {\n // go fmt not available, skip\n }\n}\n\nfunction collectRpcMethods(node: Record): RpcMethod[] {\n const results: RpcMethod[] = [];\n for (const value of Object.values(node)) {\n if (isRpcMethod(value)) {\n results.push(value);\n } else if (typeof value === \"object\" && value !== null) {\n results.push(...collectRpcMethods(value as Record));\n }\n }\n return results;\n}\n\nlet rpcDefinitions: DefinitionCollections = { definitions: {}, $defs: {} };\n\nfunction withRootTitle(schema: JSONSchema7, title: string): JSONSchema7 {\n return { ...schema, title };\n}\n\nfunction goRequestFallbackName(method: RpcMethod): string {\n return toPascalCase(method.rpcMethod) + \"Request\";\n}\n\nfunction schemaSourceForNamedDefinition(\n schema: JSONSchema7 | null | undefined,\n resolvedSchema: JSONSchema7 | undefined\n): JSONSchema7 {\n if (schema?.$ref && resolvedSchema) {\n return resolvedSchema;\n }\n // When the schema is an anyOf/oneOf wrapper (e.g., Zod optional params producing\n // `anyOf: [{ not: {} }, { $ref }]`), use the resolved object schema to avoid\n // generating self-referential type aliases that crash quicktype.\n if ((schema?.anyOf || schema?.oneOf) && resolvedSchema?.properties) {\n return resolvedSchema;\n }\n return schema ?? resolvedSchema ?? { type: \"object\" };\n}\n\nfunction isNamedGoObjectSchema(schema: JSONSchema7 | undefined): schema is JSONSchema7 {\n return !!schema && schema.type === \"object\" && (schema.properties !== undefined || schema.additionalProperties === false);\n}\n\nfunction getMethodResultSchema(method: RpcMethod): JSONSchema7 | undefined {\n return resolveSchema(method.result, rpcDefinitions) ?? method.result ?? undefined;\n}\n\nfunction getMethodParamsSchema(method: RpcMethod): JSONSchema7 | undefined {\n return (\n resolveObjectSchema(method.params, rpcDefinitions) ??\n resolveSchema(method.params, rpcDefinitions) ??\n method.params ??\n undefined\n );\n}\n\nfunction goResultTypeName(method: RpcMethod): string {\n return getRpcSchemaTypeName(getMethodResultSchema(method), toPascalCase(method.rpcMethod) + \"Result\");\n}\n\nfunction goNullableResultTypeName(method: RpcMethod, innerSchema: JSONSchema7): string {\n if (innerSchema.$ref) {\n const refName = innerSchema.$ref.split(\"/\").pop();\n if (refName) return toPascalCase(refName);\n }\n return getRpcSchemaTypeName(innerSchema, toPascalCase(method.rpcMethod) + \"Result\");\n}\n\nfunction goParamsTypeName(method: RpcMethod): string {\n const fallback = goRequestFallbackName(method);\n if (method.rpcMethod.startsWith(\"session.\") && method.params?.$ref) {\n return fallback;\n }\n return getRpcSchemaTypeName(getMethodParamsSchema(method), fallback);\n}\n\n// ── Session Events (custom codegen — per-event-type data structs) ───────────\n\ninterface GoEventVariant {\n typeName: string;\n dataClassName: string;\n dataSchema: JSONSchema7;\n dataDescription?: string;\n}\n\ninterface GoEventEnvelopeProperty extends SessionEventEnvelopeProperty {\n fieldName: string;\n typeName: string;\n jsonTag: string;\n description?: string;\n}\n\ninterface GoCodegenCtx {\n structs: string[];\n enums: string[];\n enumsByName: Map; // enumName → enumName (dedup by type name, not values)\n generatedNames: Set;\n definitions?: DefinitionCollections;\n}\n\nfunction extractGoEventVariants(schema: JSONSchema7): GoEventVariant[] {\n const definitionCollections = collectDefinitionCollections(schema as Record);\n return getSessionEventVariantSchemas(schema, definitionCollections)\n .map((variant) => {\n const typeSchema = variant.properties!.type as JSONSchema7;\n const typeName = typeSchema?.const as string;\n if (!typeName) throw new Error(\"Variant must have type.const\");\n const dataSchema =\n resolveObjectSchema(variant.properties!.data as JSONSchema7, definitionCollections) ??\n resolveSchema(variant.properties!.data as JSONSchema7, definitionCollections) ??\n ((variant.properties!.data as JSONSchema7) || {});\n return {\n typeName,\n dataClassName: `${toPascalCase(typeName)}Data`,\n dataSchema,\n dataDescription: dataSchema.description,\n };\n });\n}\n\nfunction getGoSharedEventEnvelopeProperties(schema: JSONSchema7, ctx: GoCodegenCtx): GoEventEnvelopeProperty[] {\n return getSharedSessionEventEnvelopeProperties(schema, ctx.definitions)\n .map((property) => {\n const { name, schema, required } = property;\n const typeName = resolveGoPropertyType(schema, \"SessionEvent\", name, required && !getNullableInner(schema), ctx);\n const omit = required ? \"\" : \",omitempty\";\n\n return {\n name,\n schema,\n required,\n fieldName: toGoFieldName(name),\n typeName,\n jsonTag: `json:\"${name}${omit}\"`,\n description: schema.description,\n };\n });\n}\n\nfunction emitGoEnvelopeStructField(property: GoEventEnvelopeProperty, includeComment: boolean): string[] {\n const lines: string[] = [];\n if (includeComment && property.description) {\n for (const line of property.description.split(/\\r?\\n/)) {\n lines.push(`\\t// ${line}`);\n }\n }\n lines.push(`\\t${property.fieldName} ${property.typeName} \\`${property.jsonTag}\\``);\n return lines;\n}\n\n/**\n * Find a const-valued discriminator property shared by all anyOf variants.\n */\nfunction findGoDiscriminator(\n variants: JSONSchema7[]\n): { property: string; mapping: Map } | null {\n if (variants.length === 0) return null;\n const firstVariant = variants[0];\n if (!firstVariant.properties) return null;\n\n for (const [propName, propSchema] of Object.entries(firstVariant.properties)) {\n if (typeof propSchema !== \"object\") continue;\n if ((propSchema as JSONSchema7).const === undefined) continue;\n\n const mapping = new Map();\n let valid = true;\n for (const variant of variants) {\n if (!variant.properties) { valid = false; break; }\n const vp = variant.properties[propName];\n if (typeof vp !== \"object\" || (vp as JSONSchema7).const === undefined) { valid = false; break; }\n mapping.set(String((vp as JSONSchema7).const), variant);\n }\n if (valid && mapping.size === variants.length) {\n return { property: propName, mapping };\n }\n }\n return null;\n}\n\n/**\n * Get or create a Go enum type, deduplicating by type name (not by value set).\n * Two enums with the same values but different names are distinct types.\n */\nfunction getOrCreateGoEnum(\n enumName: string,\n values: string[],\n ctx: GoCodegenCtx,\n description?: string,\n deprecated?: boolean\n): string {\n const existing = ctx.enumsByName.get(enumName);\n if (existing) return existing;\n\n const lines: string[] = [];\n if (description) {\n for (const line of description.split(/\\r?\\n/)) {\n lines.push(`// ${line}`);\n }\n }\n if (deprecated) {\n lines.push(`// Deprecated: ${enumName} is deprecated and will be removed in a future version.`);\n }\n lines.push(`type ${enumName} string`);\n lines.push(``);\n lines.push(`const (`);\n for (const value of values) {\n const constSuffix = value\n .split(/[-_.]/)\n .map((w) =>\n goInitialisms.has(w.toLowerCase())\n ? w.toUpperCase()\n : w.charAt(0).toUpperCase() + w.slice(1)\n )\n .join(\"\");\n lines.push(`\\t${enumName}${constSuffix} ${enumName} = \"${value}\"`);\n }\n lines.push(`)`);\n\n ctx.enumsByName.set(enumName, enumName);\n ctx.enums.push(lines.join(\"\\n\"));\n return enumName;\n}\n\n/**\n * Resolve a JSON Schema property to a Go type string.\n * Emits nested struct/enum definitions into ctx as a side effect.\n */\nfunction resolveGoPropertyType(\n propSchema: JSONSchema7,\n parentTypeName: string,\n jsonPropName: string,\n isRequired: boolean,\n ctx: GoCodegenCtx\n): string {\n const nestedName = parentTypeName + toGoFieldName(jsonPropName);\n\n // Handle $ref — resolve the reference and generate the referenced type\n if (propSchema.$ref && typeof propSchema.$ref === \"string\") {\n const typeName = toGoFieldName(refTypeName(propSchema.$ref, ctx.definitions));\n const resolved = resolveRef(propSchema.$ref, ctx.definitions);\n if (resolved) {\n if (resolved.enum) {\n const enumType = getOrCreateGoEnum(typeName, resolved.enum as string[], ctx, resolved.description, isSchemaDeprecated(resolved));\n return isRequired ? enumType : `*${enumType}`;\n }\n if (isNamedGoObjectSchema(resolved)) {\n emitGoStruct(typeName, resolved, ctx);\n return isRequired ? typeName : `*${typeName}`;\n }\n return resolveGoPropertyType(resolved, parentTypeName, jsonPropName, isRequired, ctx);\n }\n // Fallback: use the type name directly\n return isRequired ? typeName : `*${typeName}`;\n }\n\n // Handle anyOf\n if (propSchema.anyOf) {\n const nullableInnerSchema = getNullableInner(propSchema);\n if (nullableInnerSchema) {\n // anyOf [T, null/{not:{}}] → nullable T\n const innerType = resolveGoPropertyType(nullableInnerSchema, parentTypeName, jsonPropName, true, ctx);\n if (isRequired) return innerType;\n // Pointer-wrap if not already a pointer, slice, or map\n if (innerType.startsWith(\"*\") || innerType.startsWith(\"[]\") || innerType.startsWith(\"map[\")) {\n return innerType;\n }\n return `*${innerType}`;\n }\n const nonNull = (propSchema.anyOf as JSONSchema7[]).filter((s) => s.type !== \"null\");\n const hasNull = (propSchema.anyOf as JSONSchema7[]).some((s) => s.type === \"null\");\n\n if (nonNull.length === 1) {\n // anyOf [T, null] → nullable T\n const innerType = resolveGoPropertyType(nonNull[0], parentTypeName, jsonPropName, true, ctx);\n if (isRequired && !hasNull) return innerType;\n if (innerType.startsWith(\"*\") || innerType.startsWith(\"[]\") || innerType.startsWith(\"map[\")) {\n return innerType;\n }\n return `*${innerType}`;\n }\n\n if (nonNull.length > 1) {\n // Resolve $refs in variants before discriminator analysis\n const resolvedVariants = nonNull.map((v) => {\n if (v.$ref && typeof v.$ref === \"string\") {\n return resolveRef(v.$ref, ctx.definitions) ?? v;\n }\n return v;\n });\n // Check for discriminated union\n const disc = findGoDiscriminator(resolvedVariants);\n if (disc) {\n const unionName = (propSchema.title as string) || nestedName;\n emitGoFlatDiscriminatedUnion(unionName, disc.property, disc.mapping, ctx, propSchema.description);\n return isRequired && !hasNull ? unionName : `*${unionName}`;\n }\n // Non-discriminated multi-type union → any\n return \"any\";\n }\n }\n\n // Handle enum\n if (propSchema.enum && Array.isArray(propSchema.enum)) {\n const enumType = getOrCreateGoEnum((propSchema.title as string) || nestedName, propSchema.enum as string[], ctx, propSchema.description, isSchemaDeprecated(propSchema));\n return isRequired ? enumType : `*${enumType}`;\n }\n\n // Handle const (discriminator markers) — just use string\n if (propSchema.const !== undefined) {\n return isRequired ? \"string\" : \"*string\";\n }\n\n const type = propSchema.type;\n const format = propSchema.format;\n\n // Handle type arrays like [\"string\", \"null\"]\n if (Array.isArray(type)) {\n const nonNullTypes = (type as string[]).filter((t) => t !== \"null\");\n if (nonNullTypes.length === 1) {\n const inner = resolveGoPropertyType(\n { ...propSchema, type: nonNullTypes[0] as JSONSchema7[\"type\"] },\n parentTypeName,\n jsonPropName,\n true,\n ctx\n );\n if (inner.startsWith(\"*\") || inner.startsWith(\"[]\") || inner.startsWith(\"map[\")) return inner;\n return `*${inner}`;\n }\n }\n\n // Simple types\n if (type === \"string\") {\n if (format === \"date-time\") {\n return isRequired ? \"time.Time\" : \"*time.Time\";\n }\n return isRequired ? \"string\" : \"*string\";\n }\n if (type === \"number\") return isRequired ? \"float64\" : \"*float64\";\n if (type === \"integer\") return isRequired ? \"int64\" : \"*int64\";\n if (type === \"boolean\") return isRequired ? \"bool\" : \"*bool\";\n\n // Array type\n if (type === \"array\") {\n const items = propSchema.items as JSONSchema7 | undefined;\n if (items) {\n // Discriminated union items\n if (items.anyOf) {\n const itemVariants = (items.anyOf as JSONSchema7[]).filter((v) => v.type !== \"null\");\n const disc = findGoDiscriminator(itemVariants);\n if (disc) {\n const itemTypeName = (items.title as string) || (nestedName + \"Item\");\n emitGoFlatDiscriminatedUnion(itemTypeName, disc.property, disc.mapping, ctx, items.description);\n return `[]${itemTypeName}`;\n }\n }\n const itemType = resolveGoPropertyType(items, parentTypeName, jsonPropName + \"Item\", true, ctx);\n return `[]${itemType}`;\n }\n return \"[]any\";\n }\n\n // Object type\n if (type === \"object\" || (propSchema.properties && !type)) {\n if (propSchema.properties && Object.keys(propSchema.properties).length > 0) {\n const structName = (propSchema.title as string) || nestedName;\n emitGoStruct(structName, propSchema, ctx);\n return isRequired ? structName : `*${structName}`;\n }\n if (propSchema.additionalProperties) {\n if (\n typeof propSchema.additionalProperties === \"object\" &&\n Object.keys(propSchema.additionalProperties as Record).length > 0\n ) {\n const ap = propSchema.additionalProperties as JSONSchema7;\n if (ap.type === \"object\" && ap.properties) {\n const valueName = (ap.title as string) || `${nestedName}Value`;\n emitGoStruct(valueName, ap, ctx);\n return `map[string]${valueName}`;\n }\n const valueType = resolveGoPropertyType(ap, parentTypeName, jsonPropName + \"Value\", true, ctx);\n return `map[string]${valueType}`;\n }\n return \"map[string]any\";\n }\n // Empty object or untyped\n return \"any\";\n }\n\n return \"any\";\n}\n\n/**\n * Emit a Go struct definition from an object schema.\n */\nfunction emitGoStruct(\n typeName: string,\n schema: JSONSchema7,\n ctx: GoCodegenCtx,\n description?: string\n): void {\n if (ctx.generatedNames.has(typeName)) return;\n ctx.generatedNames.add(typeName);\n\n const required = new Set(schema.required || []);\n const lines: string[] = [];\n const desc = description || schema.description;\n if (desc) {\n for (const line of desc.split(/\\r?\\n/)) {\n lines.push(`// ${line}`);\n }\n }\n if (isSchemaDeprecated(schema)) {\n lines.push(`// Deprecated: ${typeName} is deprecated and will be removed in a future version.`);\n }\n lines.push(`type ${typeName} struct {`);\n\n for (const [propName, propSchema] of Object.entries(schema.properties || {}).sort(([a], [b]) => a.localeCompare(b))) {\n if (typeof propSchema !== \"object\") continue;\n const prop = propSchema as JSONSchema7;\n const isReq = required.has(propName);\n const goName = toGoFieldName(propName);\n const goType = resolveGoPropertyType(prop, typeName, propName, isReq, ctx);\n const omit = isReq ? \"\" : \",omitempty\";\n\n if (prop.description) {\n lines.push(`\\t// ${prop.description}`);\n }\n if (isSchemaDeprecated(prop)) {\n lines.push(`\\t// Deprecated: ${goName} is deprecated.`);\n }\n lines.push(`\\t${goName} ${goType} \\`json:\"${propName}${omit}\"\\``);\n }\n\n lines.push(`}`);\n ctx.structs.push(lines.join(\"\\n\"));\n}\n\n/**\n * Emit a flat Go struct for a discriminated union (anyOf with const discriminator).\n * Merges all variant properties into a single struct.\n */\nfunction emitGoFlatDiscriminatedUnion(\n typeName: string,\n discriminatorProp: string,\n mapping: Map,\n ctx: GoCodegenCtx,\n description?: string\n): void {\n if (ctx.generatedNames.has(typeName)) return;\n ctx.generatedNames.add(typeName);\n\n // Collect all properties across variants, determining which are required in all\n const allProps = new Map<\n string,\n { schema: JSONSchema7; requiredInAll: boolean }\n >();\n\n for (const [, variant] of mapping) {\n const required = new Set(variant.required || []);\n for (const [propName, propSchema] of Object.entries(variant.properties || {})) {\n if (typeof propSchema !== \"object\") continue;\n if (!allProps.has(propName)) {\n allProps.set(propName, {\n schema: propSchema as JSONSchema7,\n requiredInAll: required.has(propName),\n });\n } else {\n const existing = allProps.get(propName)!;\n if (!required.has(propName)) {\n existing.requiredInAll = false;\n }\n }\n }\n }\n\n // Properties not present in all variants must be optional\n const variantCount = mapping.size;\n for (const [propName, info] of allProps) {\n let presentCount = 0;\n for (const [, variant] of mapping) {\n if (variant.properties && propName in variant.properties) {\n presentCount++;\n }\n }\n if (presentCount < variantCount) {\n info.requiredInAll = false;\n }\n }\n\n // Discriminator field: generate an enum from the const values\n const discGoName = toGoFieldName(discriminatorProp);\n const discValues = [...mapping.keys()];\n const discEnumName = getOrCreateGoEnum(\n typeName + discGoName,\n discValues,\n ctx,\n `${discGoName} discriminator for ${typeName}.`\n );\n\n const lines: string[] = [];\n if (description) {\n for (const line of description.split(/\\r?\\n/)) {\n lines.push(`// ${line}`);\n }\n }\n lines.push(`type ${typeName} struct {`);\n\n // Emit discriminator field first\n lines.push(`\\t// ${discGoName} discriminator`);\n lines.push(`\\t${discGoName} ${discEnumName} \\`json:\"${discriminatorProp}\"\\``);\n\n // Emit remaining fields\n for (const [propName, info] of [...allProps.entries()].sort(([a], [b]) => a.localeCompare(b))) {\n if (propName === discriminatorProp) continue;\n const goName = toGoFieldName(propName);\n const goType = resolveGoPropertyType(info.schema, typeName, propName, info.requiredInAll, ctx);\n const omit = info.requiredInAll ? \"\" : \",omitempty\";\n if (info.schema.description) {\n lines.push(`\\t// ${info.schema.description}`);\n }\n if (isSchemaDeprecated(info.schema)) {\n lines.push(`\\t// Deprecated: ${goName} is deprecated.`);\n }\n lines.push(`\\t${goName} ${goType} \\`json:\"${propName}${omit}\"\\``);\n }\n\n lines.push(`}`);\n ctx.structs.push(lines.join(\"\\n\"));\n}\n\n/**\n * Generate the complete Go session-events file content.\n */\nfunction generateGoSessionEventsCode(schema: JSONSchema7): string {\n const variants = extractGoEventVariants(schema);\n const ctx: GoCodegenCtx = {\n structs: [],\n enums: [],\n enumsByName: new Map(),\n generatedNames: new Set(),\n definitions: collectDefinitionCollections(schema as Record),\n };\n const envelopeProperties = getGoSharedEventEnvelopeProperties(schema, ctx);\n\n // Generate per-event data structs\n const dataStructs: string[] = [];\n for (const variant of variants) {\n const required = new Set(variant.dataSchema.required || []);\n const lines: string[] = [];\n\n if (variant.dataDescription) {\n for (const line of variant.dataDescription.split(/\\r?\\n/)) {\n lines.push(`// ${line}`);\n }\n } else {\n lines.push(`// ${variant.dataClassName} holds the payload for ${variant.typeName} events.`);\n }\n lines.push(`type ${variant.dataClassName} struct {`);\n\n for (const [propName, propSchema] of Object.entries(variant.dataSchema.properties || {}).sort(([a], [b]) => a.localeCompare(b))) {\n if (typeof propSchema !== \"object\") continue;\n const prop = propSchema as JSONSchema7;\n const isReq = required.has(propName);\n const goName = toGoFieldName(propName);\n const goType = resolveGoPropertyType(prop, variant.dataClassName, propName, isReq, ctx);\n const omit = isReq ? \"\" : \",omitempty\";\n\n if (prop.description) {\n lines.push(`\\t// ${prop.description}`);\n }\n if (isSchemaDeprecated(prop)) {\n lines.push(`\\t// Deprecated: ${goName} is deprecated.`);\n }\n lines.push(`\\t${goName} ${goType} \\`json:\"${propName}${omit}\"\\``);\n }\n\n lines.push(`}`);\n lines.push(``);\n lines.push(`func (*${variant.dataClassName}) sessionEventData() {}`);\n\n dataStructs.push(lines.join(\"\\n\"));\n }\n\n // Generate SessionEventType enum\n const eventTypeEnum: string[] = [];\n eventTypeEnum.push(`// SessionEventType identifies the kind of session event.`);\n eventTypeEnum.push(`type SessionEventType string`);\n eventTypeEnum.push(``);\n eventTypeEnum.push(`const (`);\n for (const variant of variants) {\n const constName =\n \"SessionEventType\" +\n variant.typeName\n .split(/[._]/)\n .map((w) =>\n goInitialisms.has(w.toLowerCase())\n ? w.toUpperCase()\n : w.charAt(0).toUpperCase() + w.slice(1)\n )\n .join(\"\");\n eventTypeEnum.push(`\\t${constName} SessionEventType = \"${variant.typeName}\"`);\n }\n eventTypeEnum.push(`)`);\n\n // Assemble file\n const out: string[] = [];\n out.push(`// AUTO-GENERATED FILE - DO NOT EDIT`);\n out.push(`// Generated from: session-events.schema.json`);\n out.push(``);\n out.push(`package copilot`);\n out.push(``);\n\n // Imports — time is always needed for SessionEvent.Timestamp\n out.push(`import (`);\n out.push(`\\t\"encoding/json\"`);\n out.push(`\\t\"time\"`);\n out.push(`)`);\n out.push(``);\n\n // SessionEventData interface\n out.push(`// SessionEventData is the interface implemented by all per-event data types.`);\n out.push(`type SessionEventData interface {`);\n out.push(`\\tsessionEventData()`);\n out.push(`}`);\n out.push(``);\n\n // RawSessionEventData for unknown event types\n out.push(`// RawSessionEventData holds unparsed JSON data for unrecognized event types.`);\n out.push(`type RawSessionEventData struct {`);\n out.push(`\\tRaw json.RawMessage`);\n out.push(`}`);\n out.push(``);\n out.push(`func (RawSessionEventData) sessionEventData() {}`);\n out.push(``);\n out.push(`// MarshalJSON returns the original raw JSON so round-tripping preserves the payload.`);\n out.push(`func (r RawSessionEventData) MarshalJSON() ([]byte, error) { return r.Raw, nil }`);\n out.push(``);\n\n // SessionEvent struct\n out.push(`// SessionEvent represents a single session event with a typed data payload.`);\n out.push(`type SessionEvent struct {`);\n for (const property of envelopeProperties) {\n out.push(...emitGoEnvelopeStructField(property, true));\n }\n out.push(`\\t// The event type discriminator.`);\n out.push(`\\tType SessionEventType \\`json:\"type\"\\``);\n out.push(`\\t// Typed event payload. Use a type switch to access per-event fields.`);\n out.push(`\\tData SessionEventData \\`json:\"-\"\\``);\n out.push(`}`);\n out.push(``);\n\n // UnmarshalSessionEvent\n out.push(`// UnmarshalSessionEvent parses JSON bytes into a SessionEvent.`);\n out.push(`func UnmarshalSessionEvent(data []byte) (SessionEvent, error) {`);\n out.push(`\\tvar r SessionEvent`);\n out.push(`\\terr := json.Unmarshal(data, &r)`);\n out.push(`\\treturn r, err`);\n out.push(`}`);\n out.push(``);\n\n // Marshal\n out.push(`// Marshal serializes the SessionEvent to JSON.`);\n out.push(`func (r *SessionEvent) Marshal() ([]byte, error) {`);\n out.push(`\\treturn json.Marshal(r)`);\n out.push(`}`);\n out.push(``);\n\n // Custom UnmarshalJSON\n out.push(`func (e *SessionEvent) UnmarshalJSON(data []byte) error {`);\n out.push(`\\ttype rawEvent struct {`);\n for (const property of envelopeProperties) {\n for (const line of emitGoEnvelopeStructField(property, false)) {\n out.push(`\\t${line}`);\n }\n }\n out.push(`\\t\\tType SessionEventType \\`json:\"type\"\\``);\n out.push(`\\t\\tData json.RawMessage \\`json:\"data\"\\``);\n out.push(`\\t}`);\n out.push(`\\tvar raw rawEvent`);\n out.push(`\\tif err := json.Unmarshal(data, &raw); err != nil {`);\n out.push(`\\t\\treturn err`);\n out.push(`\\t}`);\n for (const property of envelopeProperties) {\n out.push(`\\te.${property.fieldName} = raw.${property.fieldName}`);\n }\n out.push(`\\te.Type = raw.Type`);\n out.push(``);\n out.push(`\\tswitch raw.Type {`);\n for (const variant of variants) {\n const constName =\n \"SessionEventType\" +\n variant.typeName\n .split(/[._]/)\n .map((w) =>\n goInitialisms.has(w.toLowerCase())\n ? w.toUpperCase()\n : w.charAt(0).toUpperCase() + w.slice(1)\n )\n .join(\"\");\n out.push(`\\tcase ${constName}:`);\n out.push(`\\t\\tvar d ${variant.dataClassName}`);\n out.push(`\\t\\tif err := json.Unmarshal(raw.Data, &d); err != nil {`);\n out.push(`\\t\\t\\treturn err`);\n out.push(`\\t\\t}`);\n out.push(`\\t\\te.Data = &d`);\n }\n out.push(`\\tdefault:`);\n out.push(`\\t\\te.Data = &RawSessionEventData{Raw: raw.Data}`);\n out.push(`\\t}`);\n out.push(`\\treturn nil`);\n out.push(`}`);\n out.push(``);\n\n // Custom MarshalJSON\n out.push(`func (e SessionEvent) MarshalJSON() ([]byte, error) {`);\n out.push(`\\ttype rawEvent struct {`);\n for (const property of envelopeProperties) {\n for (const line of emitGoEnvelopeStructField(property, false)) {\n out.push(`\\t${line}`);\n }\n }\n out.push(`\\t\\tType SessionEventType \\`json:\"type\"\\``);\n out.push(`\\t\\tData any \\`json:\"data\"\\``);\n out.push(`\\t}`);\n out.push(`\\treturn json.Marshal(rawEvent{`);\n for (const property of envelopeProperties) {\n out.push(`\\t\\t${property.fieldName}: e.${property.fieldName},`);\n }\n out.push(`\\t\\tType: e.Type,`);\n out.push(`\\t\\tData: e.Data,`);\n out.push(`\\t})`);\n out.push(`}`);\n out.push(``);\n\n // Event type enum\n out.push(eventTypeEnum.join(\"\\n\"));\n out.push(``);\n\n // Per-event data structs\n for (const ds of dataStructs.sort()) {\n out.push(ds);\n out.push(``);\n }\n\n // Nested structs\n for (const s of ctx.structs.sort()) {\n out.push(s);\n out.push(``);\n }\n\n // Enums\n for (const e of ctx.enums.sort()) {\n out.push(e);\n out.push(``);\n }\n\n // Type aliases for types referenced by non-generated SDK code under their short names.\n const TYPE_ALIASES: Record = {\n PermissionRequestCommand: \"PermissionRequestShellCommand\",\n PossibleURL: \"PermissionRequestShellPossibleURL\",\n Attachment: \"UserMessageAttachment\",\n AttachmentType: \"UserMessageAttachmentType\",\n };\n const CONST_ALIASES: Record = {\n AttachmentTypeFile: \"UserMessageAttachmentTypeFile\",\n AttachmentTypeDirectory: \"UserMessageAttachmentTypeDirectory\",\n AttachmentTypeSelection: \"UserMessageAttachmentTypeSelection\",\n AttachmentTypeGithubReference: \"UserMessageAttachmentTypeGithubReference\",\n AttachmentTypeBlob: \"UserMessageAttachmentTypeBlob\",\n };\n out.push(`// Type aliases for convenience.`);\n out.push(`type (`);\n for (const [alias, target] of Object.entries(TYPE_ALIASES)) {\n out.push(`\\t${alias} = ${target}`);\n }\n out.push(`)`);\n out.push(``);\n out.push(`// Constant aliases for convenience.`);\n out.push(`const (`);\n for (const [alias, target] of Object.entries(CONST_ALIASES)) {\n out.push(`\\t${alias} = ${target}`);\n }\n out.push(`)`);\n out.push(``);\n\n return out.join(\"\\n\");\n}\n\nasync function generateSessionEvents(schemaPath?: string): Promise {\n console.log(\"Go: generating session-events...\");\n\n const resolvedPath = schemaPath ?? (await getSessionEventsSchemaPath());\n const schema = cloneSchemaForCodegen(JSON.parse(await fs.readFile(resolvedPath, \"utf-8\")) as JSONSchema7);\n const processed = postProcessSchema(schema);\n\n const code = generateGoSessionEventsCode(processed);\n\n const outPath = await writeGeneratedFile(\"go/generated_session_events.go\", code);\n console.log(` ✓ ${outPath}`);\n\n await formatGoFile(outPath);\n}\n\n// ── RPC Types ───────────────────────────────────────────────────────────────\n\nasync function generateRpc(schemaPath?: string): Promise {\n console.log(\"Go: generating RPC types...\");\n\n const resolvedPath = schemaPath ?? (await getApiSchemaPath());\n const schema = fixNullableRequiredRefsInApiSchema(cloneSchemaForCodegen(JSON.parse(await fs.readFile(resolvedPath, \"utf-8\")) as ApiSchema));\n\n const allMethods = [\n ...collectRpcMethods(schema.server || {}),\n ...collectRpcMethods(schema.session || {}),\n ...collectRpcMethods(schema.clientSession || {}),\n ];\n\n // Build a combined schema for quicktype — prefix types to avoid conflicts.\n // Include shared definitions from the API schema for $ref resolution.\n rpcDefinitions = collectDefinitionCollections(schema as Record);\n const combinedSchema = withSharedDefinitions(\n {\n $schema: \"http://json-schema.org/draft-07/schema#\",\n },\n rpcDefinitions\n );\n\n for (const method of allMethods) {\n const resultSchema = getMethodResultSchema(method);\n const nullableInner = resultSchema ? getNullableInner(resultSchema) : undefined;\n if (nullableInner) {\n // Nullable results (e.g., *SessionFSError) don't need a wrapper type;\n // the inner type is already in definitions via shared hoisting.\n } else if (isVoidSchema(resultSchema)) {\n // Emit an empty struct for void results (forward-compatible with adding fields later)\n combinedSchema.definitions![goResultTypeName(method)] = {\n title: goResultTypeName(method),\n type: \"object\",\n properties: {},\n additionalProperties: false,\n };\n } else if (method.result) {\n combinedSchema.definitions![goResultTypeName(method)] = withRootTitle(\n schemaSourceForNamedDefinition(method.result, resultSchema),\n goResultTypeName(method)\n );\n }\n const resolvedParams = getMethodParamsSchema(method);\n if (method.params && hasSchemaPayload(resolvedParams)) {\n // For session methods, filter out sessionId from params type\n if (method.rpcMethod.startsWith(\"session.\") && resolvedParams?.properties) {\n const filtered: JSONSchema7 = {\n ...resolvedParams,\n properties: Object.fromEntries(\n Object.entries(resolvedParams.properties).filter(([k]) => k !== \"sessionId\")\n ),\n required: resolvedParams.required?.filter((r) => r !== \"sessionId\"),\n };\n if (hasSchemaPayload(filtered)) {\n combinedSchema.definitions![goParamsTypeName(method)] = withRootTitle(\n filtered,\n goParamsTypeName(method)\n );\n }\n } else {\n combinedSchema.definitions![goParamsTypeName(method)] = withRootTitle(\n schemaSourceForNamedDefinition(method.params, resolvedParams),\n goParamsTypeName(method)\n );\n }\n }\n }\n\n const allDefinitions = combinedSchema.definitions! as Record;\n const allDefinitionCollections: DefinitionCollections = {\n definitions: { ...(combinedSchema.$defs ?? {}), ...allDefinitions },\n $defs: { ...allDefinitions, ...(combinedSchema.$defs ?? {}) },\n };\n\n // Generate types via quicktype — use a single combined schema source so quicktype\n // sees each definition exactly once, preventing whimsical prefix disambiguation.\n const schemaInput = new JSONSchemaInput(new FetchingJSONSchemaStore());\n const singleSchema: JSONSchema7 = {\n $schema: \"http://json-schema.org/draft-07/schema#\",\n type: \"object\",\n definitions: allDefinitions as Record,\n properties: Object.fromEntries(\n Object.keys(allDefinitions).map((name) => [name, { $ref: `#/definitions/${name}` }])\n ),\n required: Object.keys(allDefinitions),\n };\n await schemaInput.addSource({ name: \"RpcTypes\", schema: JSON.stringify(singleSchema) });\n\n const inputData = new InputData();\n inputData.addInput(schemaInput);\n\n const qtResult = await quicktype({\n inputData,\n lang: \"go\",\n rendererOptions: { package: \"copilot\", \"just-types\": \"true\" },\n });\n\n // Post-process quicktype output: hoist quicktype's imports into the file-level import block\n let qtCode = qtResult.lines.filter((l) => !l.startsWith(\"package \")).join(\"\\n\");\n const quicktypeImports = extractQuicktypeImports(qtCode);\n qtCode = quicktypeImports.code;\n qtCode = postProcessEnumConstants(qtCode);\n const knownDefNames = new Set(Object.keys(allDefinitions).map((n) => n.toLowerCase()));\n qtCode = collapsePlaceholderGoStructs(qtCode, knownDefNames);\n // Strip trailing whitespace from quicktype output (gofmt requirement)\n qtCode = qtCode.replace(/[ \\t]+$/gm, \"\");\n\n // Extract actual type names generated by quicktype (may differ from toPascalCase)\n const actualTypeNames = new Map();\n const typeRe = /^type\\s+(\\w+)\\b/gm;\n let sm;\n while ((sm = typeRe.exec(qtCode)) !== null) {\n actualTypeNames.set(sm[1].toLowerCase(), sm[1]);\n }\n const resolveType = (name: string): string => actualTypeNames.get(name.toLowerCase()) ?? name;\n\n // Extract field name mappings (quicktype may rename fields to avoid Go keyword conflicts)\n const fieldNames = extractFieldNames(qtCode);\n\n // Annotate experimental data types\n const experimentalTypeNames = new Set();\n for (const method of allMethods) {\n if (method.stability !== \"experimental\") continue;\n experimentalTypeNames.add(goResultTypeName(method));\n const paramsTypeName = goParamsTypeName(method);\n if (allDefinitions[paramsTypeName]) {\n experimentalTypeNames.add(paramsTypeName);\n }\n }\n for (const typeName of experimentalTypeNames) {\n qtCode = qtCode.replace(\n new RegExp(`^(type ${typeName} struct)`, \"m\"),\n `// Experimental: ${typeName} is part of an experimental API and may change or be removed.\\n$1`\n );\n }\n\n // Annotate deprecated data types\n const deprecatedTypeNames = new Set();\n for (const method of allMethods) {\n if (!method.deprecated) continue;\n if (!method.result?.$ref) {\n deprecatedTypeNames.add(goResultTypeName(method));\n }\n if (!method.params?.$ref) {\n const paramsTypeName = goParamsTypeName(method);\n if (allDefinitions[paramsTypeName]) {\n deprecatedTypeNames.add(paramsTypeName);\n }\n }\n }\n for (const typeName of deprecatedTypeNames) {\n qtCode = qtCode.replace(\n new RegExp(`^(type ${typeName} struct)`, \"m\"),\n `// Deprecated: ${typeName} is deprecated and will be removed in a future version.\\n$1`\n );\n }\n // Remove trailing blank lines from quicktype output before appending\n qtCode = qtCode.replace(/\\n+$/, \"\");\n // Replace interface{} with any (quicktype emits the pre-1.18 form)\n qtCode = qtCode.replace(/\\binterface\\{\\}/g, \"any\");\n\n // Post-process: add ,omitempty to optional fields that quicktype emitted without it.\n // Quicktype's Go renderer correctly emits omitempty for most optional fields, but it\n // misses some (notably $ref-to-anyOf union types like FilterMapping). For each struct\n // type we know from the schema, walk its fields and add omitempty if the field is not\n // listed in `required` and the tag does not already include any modifier.\n qtCode = addMissingOmitemptyToQuicktypeStructs(qtCode, allDefinitions);\n\n // Build method wrappers\n const lines: string[] = [];\n lines.push(`// AUTO-GENERATED FILE - DO NOT EDIT`);\n lines.push(`// Generated from: api.schema.json`);\n lines.push(``);\n lines.push(`package rpc`);\n lines.push(``);\n const imports = [`\"context\"`, `\"encoding/json\"`];\n for (const imp of quicktypeImports.imports) {\n if (!imports.includes(imp)) {\n imports.push(imp);\n }\n }\n if (schema.clientSession) {\n imports.push(`\"errors\"`, `\"fmt\"`);\n }\n imports.push(`\"github.com/github/copilot-sdk/go/internal/jsonrpc2\"`);\n\n lines.push(`import (`);\n for (const imp of imports) {\n lines.push(`\\t${imp}`);\n }\n lines.push(`)`);\n lines.push(``);\n\n lines.push(qtCode);\n lines.push(``);\n\n // Emit ServerRpc\n if (schema.server) {\n emitRpcWrapper(lines, schema.server, false, resolveType, fieldNames);\n }\n\n // Emit SessionRpc\n if (schema.session) {\n emitRpcWrapper(lines, schema.session, true, resolveType, fieldNames);\n }\n\n if (schema.clientSession) {\n emitClientSessionApiRegistration(lines, schema.clientSession, resolveType);\n }\n\n const outPath = await writeGeneratedFile(\"go/rpc/generated_rpc.go\", lines.join(\"\\n\"));\n console.log(` ✓ ${outPath}`);\n\n await formatGoFile(outPath);\n}\n\nfunction emitApiGroup(\n lines: string[],\n apiName: string,\n node: Record,\n isSession: boolean,\n serviceName: string,\n resolveType: (name: string) => string,\n fieldNames: Map>,\n groupExperimental: boolean,\n groupDeprecated: boolean = false\n): void {\n const subGroups = Object.entries(node).filter(([, v]) => typeof v === \"object\" && v !== null && !isRpcMethod(v));\n\n if (groupDeprecated) {\n lines.push(`// Deprecated: ${apiName} contains deprecated APIs that will be removed in a future version.`);\n }\n if (groupExperimental) {\n lines.push(`// Experimental: ${apiName} contains experimental APIs that may change or be removed.`);\n }\n lines.push(`type ${apiName} ${serviceName}`);\n lines.push(``);\n\n for (const [key, value] of Object.entries(node)) {\n if (!isRpcMethod(value)) continue;\n emitMethod(lines, apiName, key, value, isSession, resolveType, fieldNames, groupExperimental, false, groupDeprecated);\n }\n\n for (const [subGroupName, subGroupNode] of subGroups) {\n const subApiName = apiName.replace(/Api$/, \"\") + toPascalCase(subGroupName) + \"Api\";\n const subGroupExperimental = isNodeFullyExperimental(subGroupNode as Record);\n const subGroupDeprecated = isNodeFullyDeprecated(subGroupNode as Record);\n emitApiGroup(lines, subApiName, subGroupNode as Record, isSession, serviceName, resolveType, fieldNames, subGroupExperimental, subGroupDeprecated);\n\n if (subGroupExperimental) {\n lines.push(`// Experimental: ${toPascalCase(subGroupName)} returns experimental APIs that may change or be removed.`);\n }\n lines.push(`func (s *${apiName}) ${toPascalCase(subGroupName)}() *${subApiName} {`);\n lines.push(`\\treturn (*${subApiName})(s)`);\n lines.push(`}`);\n lines.push(``);\n }\n}\n\nfunction emitRpcWrapper(lines: string[], node: Record, isSession: boolean, resolveType: (name: string) => string, fieldNames: Map>): void {\n const groups = Object.entries(node).filter(([, v]) => typeof v === \"object\" && v !== null && !isRpcMethod(v));\n const topLevelMethods = Object.entries(node).filter(([, v]) => isRpcMethod(v));\n\n const wrapperName = isSession ? \"SessionRpc\" : \"ServerRpc\";\n const apiSuffix = \"Api\";\n const serviceName = isSession ? \"sessionApi\" : \"serverApi\";\n\n // Emit the common service struct (unexported, shared by all API groups via type cast)\n lines.push(`type ${serviceName} struct {`);\n lines.push(`\\tclient *jsonrpc2.Client`);\n if (isSession) lines.push(`\\tsessionID string`);\n lines.push(`}`);\n lines.push(``);\n\n // Emit API types for groups\n for (const [groupName, groupNode] of groups) {\n const prefix = isSession ? \"\" : \"Server\";\n const apiName = prefix + toPascalCase(groupName) + apiSuffix;\n const groupExperimental = isNodeFullyExperimental(groupNode as Record);\n const groupDeprecated = isNodeFullyDeprecated(groupNode as Record);\n emitApiGroup(lines, apiName, groupNode as Record, isSession, serviceName, resolveType, fieldNames, groupExperimental, groupDeprecated);\n }\n\n // Compute field name lengths for gofmt-compatible column alignment\n const groupPascalNames = groups.map(([g]) => toPascalCase(g));\n const allFieldNames = isSession ? [\"common\", ...groupPascalNames] : [\"common\", ...groupPascalNames];\n const maxFieldLen = Math.max(...allFieldNames.map((n) => n.length));\n const pad = (name: string) => name.padEnd(maxFieldLen);\n\n // Emit wrapper struct\n lines.push(`// ${wrapperName} provides typed ${isSession ? \"session\" : \"server\"}-scoped RPC methods.`);\n lines.push(`type ${wrapperName} struct {`);\n lines.push(`\\t${pad(\"common\")} ${serviceName} // Reuse a single struct instead of allocating one for each service on the heap.`);\n lines.push(``);\n for (const [groupName] of groups) {\n const prefix = isSession ? \"\" : \"Server\";\n lines.push(`\\t${pad(toPascalCase(groupName))} *${prefix}${toPascalCase(groupName)}${apiSuffix}`);\n }\n lines.push(`}`);\n lines.push(``);\n\n // Top-level methods on the wrapper use the common service fields\n for (const [key, value] of topLevelMethods) {\n if (!isRpcMethod(value)) continue;\n emitMethod(lines, wrapperName, key, value, isSession, resolveType, fieldNames, false, true);\n }\n\n // Constructor\n const ctorParams = isSession ? \"client *jsonrpc2.Client, sessionID string\" : \"client *jsonrpc2.Client\";\n lines.push(`func New${wrapperName}(${ctorParams}) *${wrapperName} {`);\n lines.push(`\\tr := &${wrapperName}{}`);\n if (isSession) {\n lines.push(`\\tr.common = ${serviceName}{client: client, sessionID: sessionID}`);\n } else {\n lines.push(`\\tr.common = ${serviceName}{client: client}`);\n }\n for (const [groupName] of groups) {\n const prefix = isSession ? \"\" : \"Server\";\n lines.push(`\\tr.${toPascalCase(groupName)} = (*${prefix}${toPascalCase(groupName)}${apiSuffix})(&r.common)`);\n }\n lines.push(`\\treturn r`);\n lines.push(`}`);\n lines.push(``);\n}\n\nfunction emitMethod(lines: string[], receiver: string, name: string, method: RpcMethod, isSession: boolean, resolveType: (name: string) => string, fieldNames: Map>, groupExperimental = false, isWrapper = false, groupDeprecated = false): void {\n const methodName = toPascalCase(name);\n const resultSchema = getMethodResultSchema(method);\n const nullableInner = resultSchema ? getNullableInner(resultSchema) : undefined;\n const resultType = nullableInner\n ? resolveType(goNullableResultTypeName(method, nullableInner))\n : resolveType(goResultTypeName(method));\n\n const effectiveParams = getMethodParamsSchema(method);\n const paramProps = effectiveParams?.properties || {};\n const requiredParams = new Set(effectiveParams?.required || []);\n const nonSessionParams = Object.keys(paramProps).filter((k) => k !== \"sessionId\");\n const hasParams = isSession ? nonSessionParams.length > 0 : hasSchemaPayload(effectiveParams);\n const paramsType = hasParams ? resolveType(goParamsTypeName(method)) : \"\";\n\n // For wrapper-level methods, access fields through a.common; for service type aliases, use a directly\n const clientRef = isWrapper ? \"a.common.client\" : \"a.client\";\n const sessionIDRef = isWrapper ? \"a.common.sessionID\" : \"a.sessionID\";\n\n if (method.deprecated && !groupDeprecated) {\n lines.push(`// Deprecated: ${methodName} is deprecated and will be removed in a future version.`);\n }\n if (method.stability === \"experimental\" && !groupExperimental) {\n lines.push(`// Experimental: ${methodName} is an experimental API and may change or be removed in future versions.`);\n }\n const sig = hasParams\n ? `func (a *${receiver}) ${methodName}(ctx context.Context, params *${paramsType}) (*${resultType}, error)`\n : `func (a *${receiver}) ${methodName}(ctx context.Context) (*${resultType}, error)`;\n\n lines.push(sig + ` {`);\n\n if (isSession) {\n lines.push(`\\treq := map[string]any{\"sessionId\": ${sessionIDRef}}`);\n if (hasParams) {\n lines.push(`\\tif params != nil {`);\n for (const pName of nonSessionParams) {\n const goField = fieldNames.get(paramsType)?.get(pName) ?? toGoFieldName(pName);\n const isOptional = !requiredParams.has(pName);\n if (isOptional) {\n // Optional fields are pointers - only add when non-nil and dereference\n lines.push(`\\t\\tif params.${goField} != nil {`);\n lines.push(`\\t\\t\\treq[\"${pName}\"] = *params.${goField}`);\n lines.push(`\\t\\t}`);\n } else {\n lines.push(`\\t\\treq[\"${pName}\"] = params.${goField}`);\n }\n }\n lines.push(`\\t}`);\n }\n lines.push(`\\traw, err := ${clientRef}.Request(\"${method.rpcMethod}\", req)`);\n } else {\n const arg = hasParams ? \"params\" : \"nil\";\n lines.push(`\\traw, err := ${clientRef}.Request(\"${method.rpcMethod}\", ${arg})`);\n }\n\n lines.push(`\\tif err != nil {`);\n lines.push(`\\t\\treturn nil, err`);\n lines.push(`\\t}`);\n lines.push(`\\tvar result ${resultType}`);\n lines.push(`\\tif err := json.Unmarshal(raw, &result); err != nil {`);\n lines.push(`\\t\\treturn nil, err`);\n lines.push(`\\t}`);\n lines.push(`\\treturn &result, nil`);\n lines.push(`}`);\n lines.push(``);\n}\n\ninterface ClientGroup {\n groupName: string;\n groupNode: Record;\n methods: RpcMethod[];\n}\n\nfunction collectClientGroups(node: Record): ClientGroup[] {\n const groups: ClientGroup[] = [];\n for (const [groupName, groupNode] of Object.entries(node)) {\n if (typeof groupNode === \"object\" && groupNode !== null) {\n groups.push({\n groupName,\n groupNode: groupNode as Record,\n methods: collectRpcMethods(groupNode as Record),\n });\n }\n }\n return groups;\n}\n\nfunction clientHandlerInterfaceName(groupName: string): string {\n return `${toPascalCase(groupName)}Handler`;\n}\n\nfunction clientHandlerMethodName(rpcMethod: string): string {\n return toPascalCase(rpcMethod.split(\".\").at(-1)!);\n}\n\nfunction emitClientSessionApiRegistration(lines: string[], clientSchema: Record, resolveType: (name: string) => string): void {\n const groups = collectClientGroups(clientSchema);\n\n for (const { groupName, groupNode, methods } of groups) {\n const interfaceName = clientHandlerInterfaceName(groupName);\n const groupExperimental = isNodeFullyExperimental(groupNode);\n const groupDeprecated = isNodeFullyDeprecated(groupNode);\n if (groupDeprecated) {\n lines.push(`// Deprecated: ${interfaceName} contains deprecated APIs that will be removed in a future version.`);\n }\n if (groupExperimental) {\n lines.push(`// Experimental: ${interfaceName} contains experimental APIs that may change or be removed.`);\n }\n lines.push(`type ${interfaceName} interface {`);\n for (const method of methods) {\n if (method.deprecated && !groupDeprecated) {\n lines.push(`\\t// Deprecated: ${clientHandlerMethodName(method.rpcMethod)} is deprecated and will be removed in a future version.`);\n }\n if (method.stability === \"experimental\" && !groupExperimental) {\n lines.push(`\\t// Experimental: ${clientHandlerMethodName(method.rpcMethod)} is an experimental API and may change or be removed in future versions.`);\n }\n const paramsType = resolveType(goParamsTypeName(method));\n const resultSchema = getMethodResultSchema(method);\n const nullableInner = resultSchema ? getNullableInner(resultSchema) : undefined;\n const resultType = nullableInner\n ? resolveType(goNullableResultTypeName(method, nullableInner))\n : resolveType(goResultTypeName(method));\n lines.push(`\\t${clientHandlerMethodName(method.rpcMethod)}(request *${paramsType}) (*${resultType}, error)`);\n }\n lines.push(`}`);\n lines.push(``);\n }\n\n lines.push(`// ClientSessionApiHandlers provides all client session API handler groups for a session.`);\n lines.push(`type ClientSessionApiHandlers struct {`);\n for (const { groupName } of groups) {\n lines.push(`\\t${toPascalCase(groupName)} ${clientHandlerInterfaceName(groupName)}`);\n }\n lines.push(`}`);\n lines.push(``);\n\n lines.push(`func clientSessionHandlerError(err error) *jsonrpc2.Error {`);\n lines.push(`\\tif err == nil {`);\n lines.push(`\\t\\treturn nil`);\n lines.push(`\\t}`);\n lines.push(`\\tvar rpcErr *jsonrpc2.Error`);\n lines.push(`\\tif errors.As(err, &rpcErr) {`);\n lines.push(`\\t\\treturn rpcErr`);\n lines.push(`\\t}`);\n lines.push(`\\treturn &jsonrpc2.Error{Code: -32603, Message: err.Error()}`);\n lines.push(`}`);\n lines.push(``);\n\n lines.push(`// RegisterClientSessionApiHandlers registers handlers for server-to-client session API calls.`);\n lines.push(`func RegisterClientSessionApiHandlers(client *jsonrpc2.Client, getHandlers func(sessionID string) *ClientSessionApiHandlers) {`);\n for (const { groupName, methods } of groups) {\n const handlerField = toPascalCase(groupName);\n for (const method of methods) {\n const paramsType = resolveType(goParamsTypeName(method));\n lines.push(`\\tclient.SetRequestHandler(\"${method.rpcMethod}\", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) {`);\n lines.push(`\\t\\tvar request ${paramsType}`);\n lines.push(`\\t\\tif err := json.Unmarshal(params, &request); err != nil {`);\n lines.push(`\\t\\t\\treturn nil, &jsonrpc2.Error{Code: -32602, Message: fmt.Sprintf(\"Invalid params: %v\", err)}`);\n lines.push(`\\t\\t}`);\n lines.push(`\\t\\thandlers := getHandlers(request.SessionID)`);\n lines.push(`\\t\\tif handlers == nil || handlers.${handlerField} == nil {`);\n lines.push(`\\t\\t\\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"No ${groupName} handler registered for session: %s\", request.SessionID)}`);\n lines.push(`\\t\\t}`);\n lines.push(`\\t\\tresult, err := handlers.${handlerField}.${clientHandlerMethodName(method.rpcMethod)}(&request)`);\n lines.push(`\\t\\tif err != nil {`);\n lines.push(`\\t\\t\\treturn nil, clientSessionHandlerError(err)`);\n lines.push(`\\t\\t}`);\n lines.push(`\\t\\traw, err := json.Marshal(result)`);\n lines.push(`\\t\\tif err != nil {`);\n lines.push(`\\t\\t\\treturn nil, &jsonrpc2.Error{Code: -32603, Message: fmt.Sprintf(\"Failed to marshal response: %v\", err)}`);\n lines.push(`\\t\\t}`);\n lines.push(`\\t\\treturn raw, nil`);\n lines.push(`\\t})`);\n }\n }\n lines.push(`}`);\n lines.push(``);\n}\n\n// ── Main ────────────────────────────────────────────────────────────────────\n\nasync function generate(sessionSchemaPath?: string, apiSchemaPath?: string): Promise {\n await generateSessionEvents(sessionSchemaPath);\n try {\n await generateRpc(apiSchemaPath);\n } catch (err) {\n if ((err as NodeJS.ErrnoException).code === \"ENOENT\" && !apiSchemaPath) {\n console.log(\"Go: skipping RPC (api.schema.json not found)\");\n } else {\n throw err;\n }\n }\n}\n\nconst sessionArg = process.argv[2] || undefined;\nconst apiArg = process.argv[3] || undefined;\ngenerate(sessionArg, apiArg).catch((err) => {\n console.error(\"Go generation failed:\", err);\n process.exit(1);\n});\n" }, { "path": "scripts/codegen/package.json", "content": "{\n \"name\": \"codegen\",\n \"private\": true,\n \"type\": \"module\",\n \"scripts\": {\n \"generate\": \"tsx typescript.ts && tsx csharp.ts && tsx python.ts && tsx go.ts\",\n \"generate:ts\": \"tsx typescript.ts\",\n \"generate:csharp\": \"tsx csharp.ts\",\n \"generate:python\": \"tsx python.ts\",\n \"generate:go\": \"tsx go.ts\"\n },\n \"dependencies\": {\n \"json-schema\": \"^0.4.0\",\n \"json-schema-to-typescript\": \"^15.0.4\",\n \"quicktype-core\": \"^23.2.6\",\n \"tsx\": \"^4.20.6\"\n }\n}\n" }, { "path": "scripts/codegen/python.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\n/**\n * Python code generator for session-events and RPC types.\n */\n\nimport fs from \"fs/promises\";\nimport path from \"path\";\nimport type { JSONSchema7 } from \"json-schema\";\nimport { fileURLToPath } from \"url\";\nimport {\n cloneSchemaForCodegen,\n fixNullableRequiredRefsInApiSchema,\n getApiSchemaPath,\n getRpcSchemaTypeName,\n getSessionEventsSchemaPath,\n isObjectSchema,\n isVoidSchema,\n getNullableInner,\n isRpcMethod,\n isNodeFullyExperimental,\n isNodeFullyDeprecated,\n isSchemaDeprecated,\n postProcessSchema,\n writeGeneratedFile,\n collectDefinitionCollections,\n hasSchemaPayload,\n refTypeName,\n resolveObjectSchema,\n resolveSchema,\n withSharedDefinitions,\n getSessionEventVariantSchemas,\n getSharedSessionEventEnvelopeProperties,\n type ApiSchema,\n type DefinitionCollections,\n type RpcMethod,\n type SessionEventEnvelopeProperty,\n} from \"./utils.js\";\n\n// ── Utilities ───────────────────────────────────────────────────────────────\n\n/**\n * Modernize quicktype's Python 3.7 output to Python 3.11+ syntax:\n * - Optional[T] → T | None\n * - List[T] → list[T]\n * - Dict[K, V] → dict[K, V]\n * - Type[T] → type[T]\n * - Callable from collections.abc instead of typing\n * - Clean up unused typing imports\n */\nfunction replaceBalancedBrackets(code: string, prefix: string, replacer: (inner: string) => string): string {\n let result = \"\";\n let i = 0;\n while (i < code.length) {\n const idx = code.indexOf(prefix + \"[\", i);\n if (idx === -1) {\n result += code.slice(i);\n break;\n }\n result += code.slice(i, idx);\n const start = idx + prefix.length + 1; // after '['\n let depth = 1;\n let j = start;\n while (j < code.length && depth > 0) {\n if (code[j] === \"[\") depth++;\n else if (code[j] === \"]\") depth--;\n j++;\n }\n const inner = code.slice(start, j - 1);\n result += replacer(inner);\n i = j;\n }\n return result;\n}\n\n/** Split a string by commas, but only at the top bracket depth (ignores commas inside [...]) */\nfunction splitTopLevelCommas(s: string): string[] {\n const parts: string[] = [];\n let depth = 0;\n let start = 0;\n for (let i = 0; i < s.length; i++) {\n if (s[i] === \"[\") depth++;\n else if (s[i] === \"]\") depth--;\n else if (s[i] === \",\" && depth === 0) {\n parts.push(s.slice(start, i));\n start = i + 1;\n }\n }\n parts.push(s.slice(start));\n return parts;\n}\n\nfunction pyDocstringLiteral(text: string): string {\n const normalized = text\n .split(/\\r?\\n/)\n .map((line) => line.replace(/\\s+$/g, \"\"))\n .join(\"\\n\");\n return JSON.stringify(normalized);\n}\n\nfunction modernizePython(code: string): string {\n // Replace Optional[X] with X | None (handles arbitrarily nested brackets)\n code = replaceBalancedBrackets(code, \"Optional\", (inner) => `${inner} | None`);\n\n // Replace Union[X, Y] with X | Y (split only at top-level commas, not inside brackets)\n // Run iteratively to handle nested Union inside Dict/List\n let prev = \"\";\n while (prev !== code) {\n prev = code;\n code = replaceBalancedBrackets(code, \"Union\", (inner) => {\n return splitTopLevelCommas(inner).map((s: string) => s.trim()).join(\" | \");\n });\n }\n\n // Replace List[X] with list[X]\n code = code.replace(/\\bList\\[/g, \"list[\");\n\n // Replace Dict[K, V] with dict[K, V]\n code = code.replace(/\\bDict\\[/g, \"dict[\");\n\n // Replace Type[T] with type[T]\n code = code.replace(/\\bType\\[/g, \"type[\");\n\n // Move Callable from typing to collections.abc\n code = code.replace(\n /from typing import (.*), Callable$/m,\n \"from typing import $1\\nfrom collections.abc import Callable\"\n );\n code = code.replace(\n /from typing import Callable, (.*)$/m,\n \"from typing import $1\\nfrom collections.abc import Callable\"\n );\n\n // Remove now-unused imports from typing (Optional, List, Dict, Type)\n code = code.replace(/from typing import (.+)$/m, (_match, imports: string) => {\n const items = imports.split(\",\").map((s: string) => s.trim());\n const remove = new Set([\"Optional\", \"List\", \"Dict\", \"Type\", \"Union\"]);\n const kept = items.filter((i: string) => !remove.has(i));\n return `from typing import ${kept.join(\", \")}`;\n });\n\n return code;\n}\n\n/**\n * Collapse lambdas that only forward their single argument into another callable.\n * This keeps the generated Python readable and avoids CodeQL \"unnecessary lambda\" findings.\n */\nfunction unwrapRedundantPythonLambdas(code: string): string {\n return code.replace(\n /lambda\\s+([A-Za-z_][A-Za-z0-9_]*)\\s*:\\s*((?:[A-Za-z_][A-Za-z0-9_]*)(?:\\.[A-Za-z_][A-Za-z0-9_]*)*)\\(\\1\\)/g,\n \"$2\"\n );\n}\n\nfunction collapsePlaceholderPythonDataclasses(code: string, knownDefinitionNames?: Set): string {\n const classBlockRe = /(@dataclass\\r?\\nclass\\s+(\\w+):[\\s\\S]*?)(?=^@dataclass|^class\\s+\\w+|^def\\s+\\w+|\\Z)/gm;\n const matches = [...code.matchAll(classBlockRe)].map((match) => ({\n fullBlock: match[1],\n name: match[2],\n normalizedBody: normalizePythonDataclassBlock(match[1], match[2]),\n }));\n const groups = new Map();\n\n for (const match of matches) {\n const group = groups.get(match.normalizedBody) ?? [];\n group.push(match);\n groups.set(match.normalizedBody, group);\n }\n\n for (const group of groups.values()) {\n if (group.length < 2) continue;\n\n const canonical = chooseCanonicalPlaceholderDuplicate(group.map(({ name }) => name), knownDefinitionNames);\n if (!canonical) continue;\n\n for (const duplicate of group) {\n if (duplicate.name === canonical) continue;\n // Only collapse types that quicktype invented (Class suffix or not\n // in the schema's named definitions). Preserve intentionally-named types.\n if (!isPlaceholderTypeName(duplicate.name) && knownDefinitionNames?.has(duplicate.name.toLowerCase())) continue;\n\n code = code.replace(duplicate.fullBlock, \"\");\n code = code.replace(new RegExp(`\\\\b${duplicate.name}\\\\b`, \"g\"), canonical);\n }\n }\n\n return code.replace(/\\n{3,}/g, \"\\n\\n\");\n}\n\n/**\n * Reorder Python class/enum definitions so forward references are resolved.\n * Quicktype may emit classes in an order where a class references another\n * that hasn't been defined yet, causing NameError at import time.\n * This performs a topological sort of type definitions while preserving\n * the relative position of non-class blocks (functions, standalone code).\n */\nfunction reorderPythonForwardRefs(code: string): string {\n // Split code into top-level blocks. Each block starts at an unindented\n // line that begins a class, decorated class, enum, or function definition.\n const lines = code.split(\"\\n\");\n\n interface Block {\n name: string;\n code: string;\n isType: boolean; // true for class/enum definitions\n }\n\n const blocks: Block[] = [];\n let currentLines: string[] = [];\n let currentName: string | null = null;\n let isType = false;\n\n function flushBlock() {\n if (currentLines.length === 0) return;\n const blockCode = currentLines.join(\"\\n\");\n blocks.push({\n name: currentName ?? `__anon_${blocks.length}`,\n code: blockCode,\n isType,\n });\n currentLines = [];\n currentName = null;\n isType = false;\n }\n\n for (let i = 0; i < lines.length; i++) {\n const line = lines[i];\n const isTopLevel = line.length > 0 && line[0] !== \" \" && line[0] !== \"\\t\";\n\n if (isTopLevel) {\n const classMatch = line.match(/^class\\s+(\\w+)/);\n const defMatch = line.match(/^def\\s+(\\w+)/);\n const decoratorMatch = line === \"@dataclass\";\n const commentMatch = line.startsWith(\"# \");\n\n if (classMatch) {\n // If previous block was just a decorator waiting for a class, merge\n if (currentLines.length > 0 && currentName === null && isType) {\n // This is the class line following @dataclass\n currentName = classMatch[1];\n currentLines.push(line);\n continue;\n }\n flushBlock();\n currentLines = [line];\n currentName = classMatch[1];\n isType = true;\n } else if (decoratorMatch) {\n flushBlock();\n currentLines = [line];\n isType = true;\n } else if (defMatch) {\n flushBlock();\n currentLines = [line];\n currentName = defMatch[1];\n isType = false;\n } else if (commentMatch && currentLines.length === 0) {\n // Standalone comment — attach to next block\n currentLines = [line];\n } else {\n currentLines.push(line);\n }\n } else {\n currentLines.push(line);\n }\n }\n flushBlock();\n\n if (blocks.length === 0) return code;\n\n // Collect all type names (classes and enums)\n const typeNames = new Set(blocks.filter((b) => b.isType).map((b) => b.name));\n if (typeNames.size === 0) return code;\n\n // Build dependency graph: for each type block, find references to other type names\n const deps = new Map>();\n for (const block of blocks) {\n if (!block.isType) continue;\n const blockDeps = new Set();\n for (const tn of typeNames) {\n if (tn === block.name) continue;\n if (new RegExp(`\\\\b${tn}\\\\b`).test(block.code)) {\n blockDeps.add(tn);\n }\n }\n deps.set(block.name, blockDeps);\n }\n\n // Kahn's algorithm for topological sort\n const inDegree = new Map();\n for (const tn of typeNames) inDegree.set(tn, deps.get(tn)?.size ?? 0);\n\n const dependents = new Map();\n for (const tn of typeNames) dependents.set(tn, []);\n for (const [name, d] of deps) {\n for (const dep of d) {\n dependents.get(dep)!.push(name);\n }\n }\n\n const queue: string[] = [];\n for (const [tn, deg] of inDegree) {\n if (deg === 0) queue.push(tn);\n }\n\n const sorted: string[] = [];\n while (queue.length > 0) {\n const node = queue.shift()!;\n sorted.push(node);\n for (const dep of dependents.get(node) ?? []) {\n const newDeg = inDegree.get(dep)! - 1;\n inDegree.set(dep, newDeg);\n if (newDeg === 0) queue.push(dep);\n }\n }\n\n // If there are cycles, keep remaining nodes in original order\n for (const block of blocks) {\n if (block.isType && !sorted.includes(block.name)) {\n sorted.push(block.name);\n }\n }\n\n // Rebuild: place type blocks in sorted order at the positions\n // where type blocks originally appeared\n const typeBlockMap = new Map(blocks.filter((b) => b.isType).map((b) => [b.name, b]));\n let sortIdx = 0;\n const result: string[] = [];\n for (const block of blocks) {\n if (block.isType) {\n result.push(typeBlockMap.get(sorted[sortIdx])!.code);\n sortIdx++;\n } else {\n result.push(block.code);\n }\n }\n\n return result.join(\"\\n\");\n}\n\nfunction normalizePythonDataclassBlock(block: string, name: string): string {\n return block\n .replace(/^@dataclass\\r?\\nclass\\s+\\w+:/, \"@dataclass\\nclass:\")\n .replace(new RegExp(`\\\\b${name}\\\\b`, \"g\"), \"SelfType\")\n .split(/\\r?\\n/)\n .map((line) => line.trim())\n .filter((line) => line.length > 0)\n .join(\"\\n\");\n}\n\nfunction chooseCanonicalPlaceholderDuplicate(names: string[], knownDefinitionNames?: Set): string | undefined {\n // Prefer the name that matches a schema definition — it's intentionally named.\n if (knownDefinitionNames) {\n const definedName = names.find((name) => knownDefinitionNames.has(name.toLowerCase()));\n if (definedName) return definedName;\n }\n // Fallback for Class-suffix placeholders: pick the non-placeholder name.\n const specificNames = names.filter((name) => !isPlaceholderTypeName(name));\n if (specificNames.length === 0) return undefined;\n return specificNames[0];\n}\n\nfunction isPlaceholderTypeName(name: string): boolean {\n return name.endsWith(\"Class\") || name.endsWith(\"Enum\");\n}\n\n\nfunction toSnakeCase(s: string): string {\n return s\n .replace(/([a-z])([A-Z])/g, \"$1_$2\")\n .replace(/[._]/g, \"_\")\n .toLowerCase();\n}\n\nfunction toPascalCase(s: string): string {\n return s\n .split(/[._]/)\n .map((w) => w.charAt(0).toUpperCase() + w.slice(1))\n .join(\"\");\n}\n\nfunction collectRpcMethods(node: Record): RpcMethod[] {\n const results: RpcMethod[] = [];\n for (const value of Object.values(node)) {\n if (isRpcMethod(value)) {\n results.push(value);\n } else if (typeof value === \"object\" && value !== null) {\n results.push(...collectRpcMethods(value as Record));\n }\n }\n return results;\n}\n\nlet rpcDefinitions: DefinitionCollections = { definitions: {}, $defs: {} };\n\nfunction withRootTitle(schema: JSONSchema7, title: string): JSONSchema7 {\n return { ...schema, title };\n}\n\nfunction pythonRequestFallbackName(method: RpcMethod): string {\n return toPascalCase(method.rpcMethod) + \"Request\";\n}\n\nfunction schemaSourceForNamedDefinition(\n schema: JSONSchema7 | null | undefined,\n resolvedSchema: JSONSchema7 | undefined\n): JSONSchema7 {\n if (schema?.$ref && resolvedSchema) {\n return resolvedSchema;\n }\n // When the schema is an anyOf/oneOf wrapper (e.g., Zod optional params producing\n // `anyOf: [{ not: {} }, { $ref }]`), use the resolved object schema to avoid\n // generating self-referential type aliases that crash quicktype.\n if ((schema?.anyOf || schema?.oneOf) && resolvedSchema?.properties) {\n return resolvedSchema;\n }\n return schema ?? resolvedSchema ?? { type: \"object\" };\n}\n\nfunction isNamedPyObjectSchema(schema: JSONSchema7 | undefined): schema is JSONSchema7 {\n return !!schema && schema.type === \"object\" && (schema.properties !== undefined || schema.additionalProperties === false);\n}\n\nfunction getMethodResultSchema(method: RpcMethod): JSONSchema7 | undefined {\n return resolveSchema(method.result, rpcDefinitions) ?? method.result ?? undefined;\n}\n\nfunction getMethodParamsSchema(method: RpcMethod): JSONSchema7 | undefined {\n return (\n resolveObjectSchema(method.params, rpcDefinitions) ??\n resolveSchema(method.params, rpcDefinitions) ??\n method.params ??\n undefined\n );\n}\n\nfunction pythonResultTypeName(method: RpcMethod, schemaOverride?: JSONSchema7): string {\n const schema = schemaOverride ?? getMethodResultSchema(method);\n // If schema is a $ref, derive the type name from the ref path\n if (schema?.$ref) {\n const refName = schema.$ref.split(\"/\").pop();\n if (refName) return toPascalCase(refName);\n }\n return getRpcSchemaTypeName(schema, toPascalCase(method.rpcMethod) + \"Result\");\n}\n\n/** Detect the Zod optional params pattern: `anyOf: [{ not: {} }, { $ref }]` */\nfunction isParamsOptional(method: RpcMethod): boolean {\n const schema = method.params;\n if (!schema?.anyOf) return false;\n return schema.anyOf.some(\n (item) =>\n typeof item === \"object\" &&\n (item as JSONSchema7).not !== undefined &&\n typeof (item as JSONSchema7).not === \"object\" &&\n Object.keys((item as JSONSchema7).not as object).length === 0\n );\n}\n\nfunction pythonParamsTypeName(method: RpcMethod): string {\n const fallback = pythonRequestFallbackName(method);\n if (method.rpcMethod.startsWith(\"session.\") && method.params?.$ref) {\n return fallback;\n }\n return getRpcSchemaTypeName(getMethodParamsSchema(method), fallback);\n}\n\n// ── Session Events ──────────────────────────────────────────────────────────\n// ── Session Events (custom codegen — dedicated per-event payload types) ─────\n\ninterface PyEventVariant {\n typeName: string;\n dataClassName: string;\n dataSchema: JSONSchema7;\n dataDescription?: string;\n}\n\ninterface PyEventEnvelopeProperty extends SessionEventEnvelopeProperty {\n jsonName: string;\n fieldName: string;\n hasDefault: boolean;\n resolved: PyResolvedType;\n}\n\ninterface PyResolvedType {\n annotation: string;\n fromExpr: (expr: string) => string;\n toExpr: (expr: string) => string;\n}\n\ninterface PyCodegenCtx {\n classes: string[];\n enums: string[];\n enumsByName: Map;\n generatedNames: Set;\n usesTimedelta: boolean;\n usesIntegerTimedelta: boolean;\n definitions: DefinitionCollections;\n}\n\nfunction toEnumMemberName(value: string): string {\n const cleaned = value\n .replace(/([a-z])([A-Z])/g, \"$1_$2\")\n .replace(/[^A-Za-z0-9]+/g, \"_\")\n .replace(/^_+|_+$/g, \"\")\n .toUpperCase();\n if (!cleaned) {\n return \"VALUE\";\n }\n return /^[0-9]/.test(cleaned) ? `VALUE_${cleaned}` : cleaned;\n}\n\nfunction wrapParser(resolved: PyResolvedType, arg = \"x\"): string {\n return `lambda ${arg}: ${resolved.fromExpr(arg)}`;\n}\n\nfunction wrapSerializer(resolved: PyResolvedType, arg = \"x\"): string {\n return `lambda ${arg}: ${resolved.toExpr(arg)}`;\n}\n\nconst PY_SESSION_EVENT_TYPE_RENAMES: Record = {\n AssistantMessageDataToolRequestsItem: \"AssistantMessageToolRequest\",\n AssistantMessageDataToolRequestsItemType: \"AssistantMessageToolRequestType\",\n AssistantUsageDataCopilotUsage: \"AssistantUsageCopilotUsage\",\n AssistantUsageDataCopilotUsageTokenDetailsItem: \"AssistantUsageCopilotUsageTokenDetail\",\n AssistantUsageDataQuotaSnapshotsValue: \"AssistantUsageQuotaSnapshot\",\n CapabilitiesChangedDataUi: \"CapabilitiesChangedUI\",\n CommandsChangedDataCommandsItem: \"CommandsChangedCommand\",\n ElicitationCompletedDataAction: \"ElicitationCompletedAction\",\n ElicitationRequestedDataMode: \"ElicitationRequestedMode\",\n ElicitationRequestedDataRequestedSchema: \"ElicitationRequestedSchema\",\n McpOauthRequiredDataStaticClientConfig: \"MCPOauthRequiredStaticClientConfig\",\n PermissionCompletedDataResultKind: \"PermissionCompletedKind\",\n PermissionRequestedDataPermissionRequest: \"PermissionRequest\",\n PermissionRequestedDataPermissionRequestAction: \"PermissionRequestMemoryAction\",\n PermissionRequestedDataPermissionRequestCommandsItem: \"PermissionRequestShellCommand\",\n PermissionRequestedDataPermissionRequestDirection: \"PermissionRequestMemoryDirection\",\n PermissionRequestedDataPermissionRequestPossibleUrlsItem: \"PermissionRequestShellPossibleURL\",\n SessionCompactionCompleteDataCompactionTokensUsed: \"CompactionCompleteCompactionTokensUsed\",\n SessionCustomAgentsUpdatedDataAgentsItem: \"CustomAgentsUpdatedAgent\",\n SessionExtensionsLoadedDataExtensionsItem: \"ExtensionsLoadedExtension\",\n SessionExtensionsLoadedDataExtensionsItemSource: \"ExtensionsLoadedExtensionSource\",\n SessionExtensionsLoadedDataExtensionsItemStatus: \"ExtensionsLoadedExtensionStatus\",\n SessionHandoffDataRepository: \"HandoffRepository\",\n SessionHandoffDataSourceType: \"HandoffSourceType\",\n SessionMcpServersLoadedDataServersItem: \"MCPServersLoadedServer\",\n SessionMcpServersLoadedDataServersItemStatus: \"MCPServerStatus\",\n SessionShutdownDataCodeChanges: \"ShutdownCodeChanges\",\n SessionShutdownDataModelMetricsValue: \"ShutdownModelMetric\",\n SessionShutdownDataModelMetricsValueRequests: \"ShutdownModelMetricRequests\",\n SessionShutdownDataModelMetricsValueUsage: \"ShutdownModelMetricUsage\",\n SessionShutdownDataShutdownType: \"ShutdownType\",\n SessionSkillsLoadedDataSkillsItem: \"SkillsLoadedSkill\",\n UserMessageDataAgentMode: \"UserMessageAgentMode\",\n UserMessageDataAttachmentsItem: \"UserMessageAttachment\",\n UserMessageDataAttachmentsItemLineRange: \"UserMessageAttachmentFileLineRange\",\n UserMessageDataAttachmentsItemReferenceType: \"UserMessageAttachmentGithubReferenceType\",\n UserMessageDataAttachmentsItemSelection: \"UserMessageAttachmentSelectionDetails\",\n UserMessageDataAttachmentsItemSelectionEnd: \"UserMessageAttachmentSelectionDetailsEnd\",\n UserMessageDataAttachmentsItemSelectionStart: \"UserMessageAttachmentSelectionDetailsStart\",\n UserMessageDataAttachmentsItemType: \"UserMessageAttachmentType\",\n};\n\nfunction postProcessPythonSessionEventCode(code: string): string {\n for (const [from, to] of Object.entries(PY_SESSION_EVENT_TYPE_RENAMES).sort(\n ([left], [right]) => right.length - left.length\n )) {\n code = code.replace(new RegExp(`\\\\b${from}\\\\b`, \"g\"), to);\n }\n return unwrapRedundantPythonLambdas(code);\n}\n\nfunction pyPrimitiveResolvedType(annotation: string, fromFn: string, toFn = fromFn): PyResolvedType {\n return {\n annotation,\n fromExpr: (expr) => `${fromFn}(${expr})`,\n toExpr: (expr) => `${toFn}(${expr})`,\n };\n}\n\nfunction pyOptionalResolvedType(inner: PyResolvedType): PyResolvedType {\n return {\n annotation: `${inner.annotation} | None`,\n fromExpr: (expr) => `from_union([from_none, ${wrapParser(inner)}], ${expr})`,\n toExpr: (expr) => `from_union([from_none, ${wrapSerializer(inner)}], ${expr})`,\n };\n}\n\nfunction pyAnyResolvedType(): PyResolvedType {\n return {\n annotation: \"Any\",\n fromExpr: (expr) => expr,\n toExpr: (expr) => expr,\n };\n}\n\nfunction pyDurationResolvedType(ctx: PyCodegenCtx, isInteger: boolean): PyResolvedType {\n ctx.usesTimedelta = true;\n if (isInteger) {\n ctx.usesIntegerTimedelta = true;\n }\n return {\n annotation: \"timedelta\",\n fromExpr: (expr) => `from_timedelta(${expr})`,\n toExpr: (expr) => (isInteger ? `to_timedelta_int(${expr})` : `to_timedelta(${expr})`),\n };\n}\n\nfunction isPyBase64StringSchema(schema: JSONSchema7): boolean {\n return schema.format === \"byte\" || (schema as Record).contentEncoding === \"base64\";\n}\n\nfunction toPythonLiteral(value: unknown): string | undefined {\n if (typeof value === \"string\") {\n return JSON.stringify(value);\n }\n if (typeof value === \"number\") {\n return Number.isFinite(value) ? String(value) : undefined;\n }\n if (typeof value === \"boolean\") {\n return value ? \"True\" : \"False\";\n }\n if (value === null) {\n return \"None\";\n }\n return undefined;\n}\n\nfunction extractPyEventVariants(schema: JSONSchema7): PyEventVariant[] {\n const definitionCollections = collectDefinitionCollections(schema as Record);\n return getSessionEventVariantSchemas(schema, definitionCollections)\n .map((variant) => {\n const typeSchema = variant.properties!.type as JSONSchema7;\n const typeName = typeSchema?.const as string;\n if (!typeName) {\n throw new Error(\"Event variant must define type.const\");\n }\n\n const dataSchema =\n resolveObjectSchema(variant.properties!.data as JSONSchema7, definitionCollections) ??\n resolveSchema(variant.properties!.data as JSONSchema7, definitionCollections) ??\n ((variant.properties!.data as JSONSchema7) || {});\n return {\n typeName,\n dataClassName: `${toPascalCase(typeName)}Data`,\n dataSchema,\n dataDescription: dataSchema.description,\n };\n });\n}\n\nfunction getPySharedEventEnvelopeProperties(schema: JSONSchema7, ctx: PyCodegenCtx): PyEventEnvelopeProperty[] {\n return getSharedSessionEventEnvelopeProperties(schema, ctx.definitions)\n .map((property) => {\n const { name, schema, required } = property;\n const resolved = resolvePyPropertyType(schema, \"SessionEvent\", name, required, ctx);\n\n return {\n ...property,\n jsonName: name,\n fieldName: toSnakeCase(name),\n required,\n hasDefault: !required || resolved.annotation.includes(\" | None\"),\n resolved,\n };\n });\n}\n\nfunction findPyDiscriminator(\n variants: JSONSchema7[]\n): { property: string; mapping: Map } | null {\n if (variants.length === 0) {\n return null;\n }\n\n const firstVariant = variants[0];\n if (!firstVariant.properties) {\n return null;\n }\n\n for (const [propName, propSchema] of Object.entries(firstVariant.properties)) {\n if (typeof propSchema !== \"object\") {\n continue;\n }\n if ((propSchema as JSONSchema7).const === undefined) {\n continue;\n }\n\n const mapping = new Map();\n let valid = true;\n for (const variant of variants) {\n if (!variant.properties) {\n valid = false;\n break;\n }\n\n const variantProp = variant.properties[propName];\n if (typeof variantProp !== \"object\" || (variantProp as JSONSchema7).const === undefined) {\n valid = false;\n break;\n }\n\n mapping.set(String((variantProp as JSONSchema7).const), variant);\n }\n\n if (valid && mapping.size === variants.length) {\n return { property: propName, mapping };\n }\n }\n\n return null;\n}\n\nfunction getOrCreatePyEnum(\n enumName: string,\n values: string[],\n ctx: PyCodegenCtx,\n description?: string,\n deprecated?: boolean\n): string {\n const existing = ctx.enumsByName.get(enumName);\n if (existing) {\n return existing;\n }\n\n const lines: string[] = [];\n if (deprecated) {\n lines.push(`# Deprecated: this enum is deprecated and will be removed in a future version.`);\n }\n if (description) {\n lines.push(`class ${enumName}(Enum):`);\n lines.push(` ${pyDocstringLiteral(description)}`);\n } else {\n lines.push(`class ${enumName}(Enum):`);\n }\n for (const value of values) {\n lines.push(` ${toEnumMemberName(value)} = ${JSON.stringify(value)}`);\n }\n ctx.enumsByName.set(enumName, enumName);\n ctx.enums.push(lines.join(\"\\n\"));\n return enumName;\n}\n\nfunction resolvePyPropertyType(\n propSchema: JSONSchema7,\n parentTypeName: string,\n jsonPropName: string,\n isRequired: boolean,\n ctx: PyCodegenCtx\n): PyResolvedType {\n const fallbackName = parentTypeName + toPascalCase(jsonPropName);\n const nestedName = typeof propSchema.title === \"string\" ? propSchema.title : fallbackName;\n\n if (propSchema.$ref && typeof propSchema.$ref === \"string\") {\n const typeName = toPascalCase(refTypeName(propSchema.$ref, ctx.definitions));\n const resolved = resolveSchema(propSchema, ctx.definitions);\n if (resolved && resolved !== propSchema) {\n if (resolved.enum && Array.isArray(resolved.enum) && resolved.enum.every((value) => typeof value === \"string\")) {\n const enumType = getOrCreatePyEnum(typeName, resolved.enum as string[], ctx, resolved.description, isSchemaDeprecated(resolved));\n const enumResolved: PyResolvedType = {\n annotation: enumType,\n fromExpr: (expr) => `parse_enum(${enumType}, ${expr})`,\n toExpr: (expr) => `to_enum(${enumType}, ${expr})`,\n };\n return isRequired ? enumResolved : pyOptionalResolvedType(enumResolved);\n }\n\n const resolvedObject = resolveObjectSchema(propSchema, ctx.definitions);\n if (isNamedPyObjectSchema(resolvedObject)) {\n emitPyClass(typeName, resolvedObject, ctx, resolvedObject.description);\n const objectResolved: PyResolvedType = {\n annotation: typeName,\n fromExpr: (expr) => `${typeName}.from_dict(${expr})`,\n toExpr: (expr) => `to_class(${typeName}, ${expr})`,\n };\n return isRequired ? objectResolved : pyOptionalResolvedType(objectResolved);\n }\n\n return resolvePyPropertyType(resolved, parentTypeName, jsonPropName, isRequired, ctx);\n }\n }\n\n if (propSchema.allOf && propSchema.allOf.length === 1 && typeof propSchema.allOf[0] === \"object\") {\n return resolvePyPropertyType(\n propSchema.allOf[0] as JSONSchema7,\n parentTypeName,\n jsonPropName,\n isRequired,\n ctx\n );\n }\n\n if (propSchema.anyOf) {\n const variants = (propSchema.anyOf as JSONSchema7[])\n .filter((item) => typeof item === \"object\")\n .map(\n (item) =>\n resolveObjectSchema(item as JSONSchema7, ctx.definitions) ??\n resolveSchema(item as JSONSchema7, ctx.definitions) ??\n (item as JSONSchema7)\n );\n const nonNull = variants.filter((item) => item.type !== \"null\");\n const hasNull = variants.length !== nonNull.length;\n\n if (nonNull.length === 1) {\n const inner = resolvePyPropertyType(nonNull[0], parentTypeName, jsonPropName, true, ctx);\n return hasNull || !isRequired ? pyOptionalResolvedType(inner) : inner;\n }\n\n if (nonNull.length > 1) {\n const discriminator = findPyDiscriminator(nonNull);\n if (discriminator) {\n emitPyFlatDiscriminatedUnion(\n nestedName,\n discriminator.property,\n discriminator.mapping,\n ctx,\n propSchema.description\n );\n const resolved: PyResolvedType = {\n annotation: nestedName,\n fromExpr: (expr) => `${nestedName}.from_dict(${expr})`,\n toExpr: (expr) => `to_class(${nestedName}, ${expr})`,\n };\n return hasNull || !isRequired ? pyOptionalResolvedType(resolved) : resolved;\n }\n\n return pyAnyResolvedType();\n }\n }\n\n if (propSchema.enum && Array.isArray(propSchema.enum) && propSchema.enum.every((value) => typeof value === \"string\")) {\n const enumType = getOrCreatePyEnum(\n nestedName,\n propSchema.enum as string[],\n ctx,\n propSchema.description,\n isSchemaDeprecated(propSchema)\n );\n const resolved: PyResolvedType = {\n annotation: enumType,\n fromExpr: (expr) => `parse_enum(${enumType}, ${expr})`,\n toExpr: (expr) => `to_enum(${enumType}, ${expr})`,\n };\n return isRequired ? resolved : pyOptionalResolvedType(resolved);\n }\n\n if (propSchema.const !== undefined) {\n if (typeof propSchema.const === \"string\") {\n const resolved = pyPrimitiveResolvedType(\"str\", \"from_str\");\n return isRequired ? resolved : pyOptionalResolvedType(resolved);\n }\n if (typeof propSchema.const === \"boolean\") {\n const resolved = pyPrimitiveResolvedType(\"bool\", \"from_bool\");\n return isRequired ? resolved : pyOptionalResolvedType(resolved);\n }\n if (typeof propSchema.const === \"number\") {\n const resolved = Number.isInteger(propSchema.const)\n ? pyPrimitiveResolvedType(\"int\", \"from_int\", \"to_int\")\n : pyPrimitiveResolvedType(\"float\", \"from_float\", \"to_float\");\n return isRequired ? resolved : pyOptionalResolvedType(resolved);\n }\n }\n\n const type = propSchema.type;\n const format = propSchema.format;\n\n if (Array.isArray(type)) {\n const nonNullTypes = type.filter((value) => value !== \"null\");\n if (nonNullTypes.length === 1) {\n const inner = resolvePyPropertyType(\n { ...propSchema, type: nonNullTypes[0] as JSONSchema7[\"type\"] },\n parentTypeName,\n jsonPropName,\n true,\n ctx\n );\n return pyOptionalResolvedType(inner);\n }\n }\n\n if (type === \"string\") {\n if (format === \"date-time\") {\n const resolved = pyPrimitiveResolvedType(\"datetime\", \"from_datetime\", \"to_datetime\");\n return isRequired ? resolved : pyOptionalResolvedType(resolved);\n }\n if (format === \"uuid\") {\n const resolved = pyPrimitiveResolvedType(\"UUID\", \"from_uuid\", \"to_uuid\");\n return isRequired ? resolved : pyOptionalResolvedType(resolved);\n }\n if (format === \"uri\" || format === \"regex\" || isPyBase64StringSchema(propSchema)) {\n const resolved = pyPrimitiveResolvedType(\"str\", \"from_str\");\n return isRequired ? resolved : pyOptionalResolvedType(resolved);\n }\n const resolved = pyPrimitiveResolvedType(\"str\", \"from_str\");\n return isRequired ? resolved : pyOptionalResolvedType(resolved);\n }\n\n if (type === \"integer\") {\n if (format === \"duration\") {\n const resolved = pyDurationResolvedType(ctx, true);\n return isRequired ? resolved : pyOptionalResolvedType(resolved);\n }\n const resolved = pyPrimitiveResolvedType(\"int\", \"from_int\", \"to_int\");\n return isRequired ? resolved : pyOptionalResolvedType(resolved);\n }\n\n if (type === \"number\") {\n if (format === \"duration\") {\n const resolved = pyDurationResolvedType(ctx, false);\n return isRequired ? resolved : pyOptionalResolvedType(resolved);\n }\n const resolved = pyPrimitiveResolvedType(\"float\", \"from_float\", \"to_float\");\n return isRequired ? resolved : pyOptionalResolvedType(resolved);\n }\n\n if (type === \"boolean\") {\n const resolved = pyPrimitiveResolvedType(\"bool\", \"from_bool\");\n return isRequired ? resolved : pyOptionalResolvedType(resolved);\n }\n\n if (type === \"array\") {\n const items = propSchema.items as JSONSchema7 | undefined;\n if (!items) {\n const resolved: PyResolvedType = {\n annotation: \"list[Any]\",\n fromExpr: (expr) => `from_list(lambda x: x, ${expr})`,\n toExpr: (expr) => `from_list(lambda x: x, ${expr})`,\n };\n return isRequired ? resolved : pyOptionalResolvedType(resolved);\n }\n\n if (items.allOf && items.allOf.length === 1 && typeof items.allOf[0] === \"object\") {\n return resolvePyPropertyType(\n { ...propSchema, items: items.allOf[0] as JSONSchema7 },\n parentTypeName,\n jsonPropName,\n isRequired,\n ctx\n );\n }\n\n if (items.anyOf) {\n const itemVariants = (items.anyOf as JSONSchema7[])\n .filter((variant) => typeof variant === \"object\")\n .map(\n (variant) =>\n resolveObjectSchema(variant as JSONSchema7, ctx.definitions) ??\n resolveSchema(variant as JSONSchema7, ctx.definitions) ??\n (variant as JSONSchema7)\n )\n .filter((variant) => variant.type !== \"null\");\n const discriminator = findPyDiscriminator(itemVariants);\n if (discriminator) {\n const itemTypeName = nestedName + \"Item\";\n emitPyFlatDiscriminatedUnion(\n itemTypeName,\n discriminator.property,\n discriminator.mapping,\n ctx,\n items.description\n );\n const resolved: PyResolvedType = {\n annotation: `list[${itemTypeName}]`,\n fromExpr: (expr) => `from_list(${itemTypeName}.from_dict, ${expr})`,\n toExpr: (expr) => `from_list(lambda x: to_class(${itemTypeName}, x), ${expr})`,\n };\n return isRequired ? resolved : pyOptionalResolvedType(resolved);\n }\n }\n\n const itemType = resolvePyPropertyType(items, parentTypeName, jsonPropName + \"Item\", true, ctx);\n const resolved: PyResolvedType = {\n annotation: `list[${itemType.annotation}]`,\n fromExpr: (expr) => `from_list(${wrapParser(itemType)}, ${expr})`,\n toExpr: (expr) => `from_list(${wrapSerializer(itemType)}, ${expr})`,\n };\n return isRequired ? resolved : pyOptionalResolvedType(resolved);\n }\n\n if (type === \"object\" || (propSchema.properties && !type)) {\n if (propSchema.properties) {\n emitPyClass(nestedName, propSchema, ctx, propSchema.description);\n const resolved: PyResolvedType = {\n annotation: nestedName,\n fromExpr: (expr) => `${nestedName}.from_dict(${expr})`,\n toExpr: (expr) => `to_class(${nestedName}, ${expr})`,\n };\n return isRequired ? resolved : pyOptionalResolvedType(resolved);\n }\n\n if (propSchema.additionalProperties) {\n if (\n typeof propSchema.additionalProperties === \"object\" &&\n Object.keys(propSchema.additionalProperties as Record).length > 0\n ) {\n const valueType = resolvePyPropertyType(\n propSchema.additionalProperties as JSONSchema7,\n parentTypeName,\n jsonPropName + \"Value\",\n true,\n ctx\n );\n const resolved: PyResolvedType = {\n annotation: `dict[str, ${valueType.annotation}]`,\n fromExpr: (expr) => `from_dict(${wrapParser(valueType)}, ${expr})`,\n toExpr: (expr) => `from_dict(${wrapSerializer(valueType)}, ${expr})`,\n };\n return isRequired ? resolved : pyOptionalResolvedType(resolved);\n }\n\n const resolved: PyResolvedType = {\n annotation: \"dict[str, Any]\",\n fromExpr: (expr) => `from_dict(lambda x: x, ${expr})`,\n toExpr: (expr) => `from_dict(lambda x: x, ${expr})`,\n };\n return isRequired ? resolved : pyOptionalResolvedType(resolved);\n }\n\n return pyAnyResolvedType();\n }\n\n return pyAnyResolvedType();\n}\n\nfunction emitPyClass(\n typeName: string,\n schema: JSONSchema7,\n ctx: PyCodegenCtx,\n description?: string\n): void {\n if (ctx.generatedNames.has(typeName)) {\n return;\n }\n ctx.generatedNames.add(typeName);\n\n const required = new Set(schema.required || []);\n const fieldEntries = Object.entries(schema.properties || {}).filter(\n ([, value]) => typeof value === \"object\"\n ) as Array<[string, JSONSchema7]>;\n const orderedFieldEntries = [\n ...fieldEntries.filter(([name]) => required.has(name)).sort(([a], [b]) => a.localeCompare(b)),\n ...fieldEntries.filter(([name]) => !required.has(name)).sort(([a], [b]) => a.localeCompare(b)),\n ];\n\n const fieldInfos = orderedFieldEntries.map(([propName, propSchema]) => {\n const isRequired = required.has(propName);\n const resolved = resolvePyPropertyType(propSchema, typeName, propName, isRequired, ctx);\n return {\n jsonName: propName,\n fieldName: toSnakeCase(propName),\n isRequired,\n resolved,\n defaultLiteral: isRequired ? undefined : toPythonLiteral(\n propSchema.default ?? resolveSchema(propSchema, ctx.definitions)?.default\n ),\n };\n });\n\n const lines: string[] = [];\n if (isSchemaDeprecated(schema)) {\n lines.push(`# Deprecated: this type is deprecated and will be removed in a future version.`);\n }\n lines.push(`@dataclass`);\n lines.push(`class ${typeName}:`);\n if (description || schema.description) {\n lines.push(` ${pyDocstringLiteral(description || schema.description || \"\")}`);\n }\n\n if (fieldInfos.length === 0) {\n lines.push(` @staticmethod`);\n lines.push(` def from_dict(obj: Any) -> \"${typeName}\":`);\n lines.push(` assert isinstance(obj, dict)`);\n lines.push(` return ${typeName}()`);\n lines.push(``);\n lines.push(` def to_dict(self) -> dict:`);\n lines.push(` return {}`);\n ctx.classes.push(lines.join(\"\\n\"));\n return;\n }\n\n for (const field of fieldInfos) {\n const suffix = field.isRequired ? \"\" : \" = None\";\n if (isSchemaDeprecated(orderedFieldEntries.find(([n]) => n === field.jsonName)?.[1] as JSONSchema7)) {\n lines.push(` # Deprecated: this field is deprecated.`);\n }\n lines.push(` ${field.fieldName}: ${field.resolved.annotation}${suffix}`);\n }\n\n lines.push(``);\n lines.push(` @staticmethod`);\n lines.push(` def from_dict(obj: Any) -> \"${typeName}\":`);\n lines.push(` assert isinstance(obj, dict)`);\n for (const field of fieldInfos) {\n const sourceExpr = field.defaultLiteral\n ? `obj.get(${JSON.stringify(field.jsonName)}, ${field.defaultLiteral})`\n : `obj.get(${JSON.stringify(field.jsonName)})`;\n lines.push(\n ` ${field.fieldName} = ${field.resolved.fromExpr(sourceExpr)}`\n );\n }\n lines.push(` return ${typeName}(`);\n for (const field of fieldInfos) {\n lines.push(` ${field.fieldName}=${field.fieldName},`);\n }\n lines.push(` )`);\n lines.push(``);\n lines.push(` def to_dict(self) -> dict:`);\n lines.push(` result: dict = {}`);\n for (const field of fieldInfos) {\n const valueExpr = field.resolved.toExpr(`self.${field.fieldName}`);\n if (field.isRequired) {\n lines.push(` result[${JSON.stringify(field.jsonName)}] = ${valueExpr}`);\n } else {\n lines.push(` if self.${field.fieldName} is not None:`);\n lines.push(` result[${JSON.stringify(field.jsonName)}] = ${valueExpr}`);\n }\n }\n lines.push(` return result`);\n\n ctx.classes.push(lines.join(\"\\n\"));\n}\n\nfunction emitPyFlatDiscriminatedUnion(\n typeName: string,\n discriminatorProp: string,\n mapping: Map,\n ctx: PyCodegenCtx,\n description?: string\n): void {\n if (ctx.generatedNames.has(typeName)) {\n return;\n }\n ctx.generatedNames.add(typeName);\n\n const allProps = new Map();\n for (const [, variant] of mapping) {\n const required = new Set(variant.required || []);\n for (const [propName, propSchema] of Object.entries(variant.properties || {})) {\n if (typeof propSchema !== \"object\") {\n continue;\n }\n if (!allProps.has(propName)) {\n allProps.set(propName, {\n schema: propSchema as JSONSchema7,\n requiredInAll: required.has(propName),\n });\n } else if (!required.has(propName)) {\n allProps.get(propName)!.requiredInAll = false;\n }\n }\n }\n\n const variantCount = mapping.size;\n for (const [propName, info] of allProps) {\n let presentCount = 0;\n for (const [, variant] of mapping) {\n if (variant.properties && propName in variant.properties) {\n presentCount++;\n }\n }\n if (presentCount < variantCount) {\n info.requiredInAll = false;\n }\n }\n\n const discriminatorEnumName = getOrCreatePyEnum(\n typeName + toPascalCase(discriminatorProp),\n [...mapping.keys()],\n ctx,\n description ? `${description} discriminator` : `${typeName} discriminator`\n );\n\n const fieldEntries: Array<[string, JSONSchema7, boolean]> = [\n [\n discriminatorProp,\n {\n type: \"string\",\n enum: [...mapping.keys()],\n },\n true,\n ],\n ...[...allProps.entries()]\n .filter(([propName]) => propName !== discriminatorProp)\n .map(([propName, info]) => [propName, info.schema, info.requiredInAll] as [string, JSONSchema7, boolean]),\n ];\n\n const orderedFieldEntries = [\n ...fieldEntries.filter(([, , requiredInAll]) => requiredInAll).sort(([a], [b]) => a.localeCompare(b)),\n ...fieldEntries.filter(([, , requiredInAll]) => !requiredInAll).sort(([a], [b]) => a.localeCompare(b)),\n ];\n\n const fieldInfos = orderedFieldEntries.map(([propName, propSchema, requiredInAll]) => {\n let resolved: PyResolvedType;\n if (propName === discriminatorProp) {\n resolved = {\n annotation: discriminatorEnumName,\n fromExpr: (expr) => `parse_enum(${discriminatorEnumName}, ${expr})`,\n toExpr: (expr) => `to_enum(${discriminatorEnumName}, ${expr})`,\n };\n } else {\n resolved = resolvePyPropertyType(propSchema, typeName, propName, requiredInAll, ctx);\n }\n\n return {\n jsonName: propName,\n fieldName: toSnakeCase(propName),\n isRequired: requiredInAll,\n resolved,\n defaultLiteral: requiredInAll ? undefined : toPythonLiteral(\n propSchema.default ?? resolveSchema(propSchema, ctx.definitions)?.default\n ),\n };\n });\n\n const lines: string[] = [];\n lines.push(`@dataclass`);\n lines.push(`class ${typeName}:`);\n if (description) {\n lines.push(` ${pyDocstringLiteral(description)}`);\n }\n for (const field of fieldInfos) {\n const suffix = field.isRequired ? \"\" : \" = None\";\n const fieldSchema = orderedFieldEntries.find(([n]) => n === field.jsonName)?.[1];\n if (fieldSchema && isSchemaDeprecated(fieldSchema)) {\n lines.push(` # Deprecated: this field is deprecated.`);\n }\n lines.push(` ${field.fieldName}: ${field.resolved.annotation}${suffix}`);\n }\n lines.push(``);\n lines.push(` @staticmethod`);\n lines.push(` def from_dict(obj: Any) -> \"${typeName}\":`);\n lines.push(` assert isinstance(obj, dict)`);\n for (const field of fieldInfos) {\n const sourceExpr = field.defaultLiteral\n ? `obj.get(${JSON.stringify(field.jsonName)}, ${field.defaultLiteral})`\n : `obj.get(${JSON.stringify(field.jsonName)})`;\n lines.push(\n ` ${field.fieldName} = ${field.resolved.fromExpr(sourceExpr)}`\n );\n }\n lines.push(` return ${typeName}(`);\n for (const field of fieldInfos) {\n lines.push(` ${field.fieldName}=${field.fieldName},`);\n }\n lines.push(` )`);\n lines.push(``);\n lines.push(` def to_dict(self) -> dict:`);\n lines.push(` result: dict = {}`);\n for (const field of fieldInfos) {\n const valueExpr = field.resolved.toExpr(`self.${field.fieldName}`);\n if (field.isRequired) {\n lines.push(` result[${JSON.stringify(field.jsonName)}] = ${valueExpr}`);\n } else {\n lines.push(` if self.${field.fieldName} is not None:`);\n lines.push(` result[${JSON.stringify(field.jsonName)}] = ${valueExpr}`);\n }\n }\n lines.push(` return result`);\n\n ctx.classes.push(lines.join(\"\\n\"));\n}\n\nexport function generatePythonSessionEventsCode(schema: JSONSchema7): string {\n const variants = extractPyEventVariants(schema);\n const ctx: PyCodegenCtx = {\n classes: [],\n enums: [],\n enumsByName: new Map(),\n generatedNames: new Set(),\n usesTimedelta: false,\n usesIntegerTimedelta: false,\n definitions: collectDefinitionCollections(schema as Record),\n };\n\n for (const variant of variants) {\n emitPyClass(variant.dataClassName, variant.dataSchema, ctx, variant.dataDescription);\n }\n const envelopeProperties = getPySharedEventEnvelopeProperties(schema, ctx);\n const envelopePropertiesWithoutDefaults = envelopeProperties.filter((property) => !property.hasDefault);\n const envelopePropertiesWithDefaults = envelopeProperties.filter((property) => property.hasDefault);\n\n const eventTypeLines: string[] = [];\n eventTypeLines.push(`class SessionEventType(Enum):`);\n for (const variant of variants) {\n eventTypeLines.push(` ${toEnumMemberName(variant.typeName)} = ${JSON.stringify(variant.typeName)}`);\n }\n eventTypeLines.push(` UNKNOWN = \"unknown\"`);\n eventTypeLines.push(``);\n eventTypeLines.push(` @classmethod`);\n eventTypeLines.push(` def _missing_(cls, value: object) -> \"SessionEventType\":`);\n eventTypeLines.push(` return cls.UNKNOWN`);\n\n const out: string[] = [];\n out.push(`\"\"\"`);\n out.push(`AUTO-GENERATED FILE - DO NOT EDIT`);\n out.push(`Generated from: session-events.schema.json`);\n out.push(`\"\"\"`);\n out.push(``);\n out.push(`from __future__ import annotations`);\n out.push(``);\n out.push(`from collections.abc import Callable`);\n out.push(`from dataclasses import dataclass`);\n out.push(ctx.usesTimedelta ? `from datetime import datetime, timedelta` : `from datetime import datetime`);\n out.push(`from enum import Enum`);\n out.push(`from typing import Any, TypeVar, cast`);\n out.push(`from uuid import UUID`);\n out.push(``);\n out.push(`import dateutil.parser`);\n out.push(``);\n out.push(`T = TypeVar(\"T\")`);\n out.push(`EnumT = TypeVar(\"EnumT\", bound=Enum)`);\n out.push(``);\n out.push(``);\n out.push(`def from_str(x: Any) -> str:`);\n out.push(` assert isinstance(x, str)`);\n out.push(` return x`);\n out.push(``);\n out.push(``);\n out.push(`def from_int(x: Any) -> int:`);\n out.push(` assert isinstance(x, int) and not isinstance(x, bool)`);\n out.push(` return x`);\n out.push(``);\n out.push(``);\n out.push(`def to_int(x: Any) -> int:`);\n out.push(` assert isinstance(x, int) and not isinstance(x, bool)`);\n out.push(` return x`);\n out.push(``);\n out.push(``);\n out.push(`def from_float(x: Any) -> float:`);\n out.push(` assert isinstance(x, (float, int)) and not isinstance(x, bool)`);\n out.push(` return float(x)`);\n out.push(``);\n out.push(``);\n out.push(`def to_float(x: Any) -> float:`);\n out.push(` assert isinstance(x, (float, int)) and not isinstance(x, bool)`);\n out.push(` return float(x)`);\n out.push(``);\n out.push(``);\n if (ctx.usesTimedelta) {\n out.push(`def from_timedelta(x: Any) -> timedelta:`);\n out.push(` assert isinstance(x, (float, int)) and not isinstance(x, bool)`);\n out.push(` return timedelta(milliseconds=float(x))`);\n out.push(``);\n out.push(``);\n if (ctx.usesIntegerTimedelta) {\n out.push(`def to_timedelta_int(x: timedelta) -> int:`);\n out.push(` assert isinstance(x, timedelta)`);\n out.push(` milliseconds = x.total_seconds() * 1000.0`);\n out.push(` assert milliseconds.is_integer()`);\n out.push(` return int(milliseconds)`);\n out.push(``);\n out.push(``);\n }\n out.push(`def to_timedelta(x: timedelta) -> float:`);\n out.push(` assert isinstance(x, timedelta)`);\n out.push(` return x.total_seconds() * 1000.0`);\n out.push(``);\n out.push(``);\n }\n out.push(`def from_bool(x: Any) -> bool:`);\n out.push(` assert isinstance(x, bool)`);\n out.push(` return x`);\n out.push(``);\n out.push(``);\n out.push(`def from_none(x: Any) -> Any:`);\n out.push(` assert x is None`);\n out.push(` return x`);\n out.push(``);\n out.push(``);\n out.push(`def from_union(fs: list[Callable[[Any], T]], x: Any) -> T:`);\n out.push(` for f in fs:`);\n out.push(` try:`);\n out.push(` return f(x)`);\n out.push(` except Exception:`);\n out.push(` pass`);\n out.push(` assert False`);\n out.push(``);\n out.push(``);\n out.push(`def from_list(f: Callable[[Any], T], x: Any) -> list[T]:`);\n out.push(` assert isinstance(x, list)`);\n out.push(` return [f(item) for item in x]`);\n out.push(``);\n out.push(``);\n out.push(`def from_dict(f: Callable[[Any], T], x: Any) -> dict[str, T]:`);\n out.push(` assert isinstance(x, dict)`);\n out.push(` return {key: f(value) for key, value in x.items()}`);\n out.push(``);\n out.push(``);\n out.push(`def from_datetime(x: Any) -> datetime:`);\n out.push(` return dateutil.parser.parse(from_str(x))`);\n out.push(``);\n out.push(``);\n out.push(`def to_datetime(x: datetime) -> str:`);\n out.push(` return x.isoformat()`);\n out.push(``);\n out.push(``);\n out.push(`def from_uuid(x: Any) -> UUID:`);\n out.push(` return UUID(from_str(x))`);\n out.push(``);\n out.push(``);\n out.push(`def to_uuid(x: UUID) -> str:`);\n out.push(` return str(x)`);\n out.push(``);\n out.push(``);\n out.push(`def parse_enum(c: type[EnumT], x: Any) -> EnumT:`);\n out.push(` assert isinstance(x, str)`);\n out.push(` return c(x)`);\n out.push(``);\n out.push(``);\n out.push(`def to_class(c: type[T], x: Any) -> dict:`);\n out.push(` assert isinstance(x, c)`);\n out.push(` return cast(Any, x).to_dict()`);\n out.push(``);\n out.push(``);\n out.push(`def to_enum(c: type[EnumT], x: Any) -> str:`);\n out.push(` assert isinstance(x, c)`);\n out.push(` return cast(str, x.value)`);\n out.push(``);\n out.push(``);\n out.push(eventTypeLines.join(\"\\n\"));\n out.push(``);\n out.push(``);\n out.push(`@dataclass`);\n out.push(`class RawSessionEventData:`);\n out.push(` raw: Any`);\n out.push(``);\n out.push(` @staticmethod`);\n out.push(` def from_dict(obj: Any) -> \"RawSessionEventData\":`);\n out.push(` return RawSessionEventData(obj)`);\n out.push(``);\n out.push(` def to_dict(self) -> Any:`);\n out.push(` return self.raw`);\n out.push(``);\n out.push(``);\n out.push(`def _compat_to_python_key(name: str) -> str:`);\n out.push(` normalized = name.replace(\".\", \"_\")`);\n out.push(` result: list[str] = []`);\n out.push(` for index, char in enumerate(normalized):`);\n out.push(\n ` if char.isupper() and index > 0 and (not normalized[index - 1].isupper() or (index + 1 < len(normalized) and normalized[index + 1].islower())):`\n );\n out.push(` result.append(\"_\")`);\n out.push(` result.append(char.lower())`);\n out.push(` return \"\".join(result)`);\n out.push(``);\n out.push(``);\n out.push(`def _compat_to_json_key(name: str) -> str:`);\n out.push(` parts = name.split(\"_\")`);\n out.push(` if not parts:`);\n out.push(` return name`);\n out.push(` return parts[0] + \"\".join(part[:1].upper() + part[1:] for part in parts[1:])`);\n out.push(``);\n out.push(``);\n out.push(`def _compat_to_json_value(value: Any) -> Any:`);\n out.push(` if hasattr(value, \"to_dict\"):`);\n out.push(` return cast(Any, value).to_dict()`);\n out.push(` if isinstance(value, Enum):`);\n out.push(` return value.value`);\n out.push(` if isinstance(value, datetime):`);\n out.push(` return value.isoformat()`);\n if (ctx.usesTimedelta) {\n out.push(` if isinstance(value, timedelta):`);\n out.push(` return value.total_seconds() * 1000.0`);\n }\n out.push(` if isinstance(value, UUID):`);\n out.push(` return str(value)`);\n out.push(` if isinstance(value, list):`);\n out.push(` return [_compat_to_json_value(item) for item in value]`);\n out.push(` if isinstance(value, dict):`);\n out.push(` return {key: _compat_to_json_value(item) for key, item in value.items()}`);\n out.push(` return value`);\n out.push(``);\n out.push(``);\n out.push(`def _compat_from_json_value(value: Any) -> Any:`);\n out.push(` return value`);\n out.push(``);\n out.push(``);\n out.push(`class Data:`);\n out.push(` \"\"\"Backward-compatible shim for manually constructed event payloads.\"\"\"`);\n out.push(``);\n out.push(` def __init__(self, **kwargs: Any):`);\n out.push(` self._values = {key: _compat_from_json_value(value) for key, value in kwargs.items()}`);\n out.push(` for key, value in self._values.items():`);\n out.push(` setattr(self, key, value)`);\n out.push(``);\n out.push(` @staticmethod`);\n out.push(` def from_dict(obj: Any) -> \"Data\":`);\n out.push(` assert isinstance(obj, dict)`);\n out.push(\n ` return Data(**{_compat_to_python_key(key): _compat_from_json_value(value) for key, value in obj.items()})`\n );\n out.push(``);\n out.push(` def to_dict(self) -> dict:`);\n out.push(\n ` return {_compat_to_json_key(key): _compat_to_json_value(value) for key, value in self._values.items() if value is not None}`\n );\n out.push(``);\n out.push(``);\n for (const classDef of ctx.classes.sort()) {\n out.push(classDef);\n out.push(``);\n out.push(``);\n }\n for (const enumDef of ctx.enums.sort()) {\n out.push(enumDef);\n out.push(``);\n out.push(``);\n }\n\n const sessionEventDataTypes = [\n ...variants.map((variant) => variant.dataClassName),\n \"RawSessionEventData\",\n \"Data\",\n ];\n out.push(`SessionEventData = ${sessionEventDataTypes.join(\" | \")}`);\n out.push(``);\n out.push(``);\n out.push(`@dataclass`);\n out.push(`class SessionEvent:`);\n out.push(` data: SessionEventData`);\n for (const property of envelopePropertiesWithoutDefaults) {\n out.push(` ${property.fieldName}: ${property.resolved.annotation}`);\n }\n out.push(` type: SessionEventType`);\n for (const property of envelopePropertiesWithDefaults) {\n out.push(` ${property.fieldName}: ${property.resolved.annotation} = None`);\n }\n out.push(` raw_type: str | None = None`);\n out.push(``);\n out.push(` @staticmethod`);\n out.push(` def from_dict(obj: Any) -> \"SessionEvent\":`);\n out.push(` assert isinstance(obj, dict)`);\n out.push(` raw_type = from_str(obj.get(\"type\"))`);\n out.push(` event_type = SessionEventType(raw_type)`);\n for (const property of envelopeProperties) {\n out.push(` ${property.fieldName} = ${property.resolved.fromExpr(`obj.get(${JSON.stringify(property.jsonName)})`)}`);\n }\n out.push(` data_obj = obj.get(\"data\")`);\n out.push(` match event_type:`);\n for (const variant of variants) {\n out.push(\n ` case SessionEventType.${toEnumMemberName(variant.typeName)}: data = ${variant.dataClassName}.from_dict(data_obj)`\n );\n }\n out.push(` case _: data = RawSessionEventData.from_dict(data_obj)`);\n out.push(` return SessionEvent(`);\n out.push(` data=data,`);\n for (const property of envelopePropertiesWithoutDefaults) {\n out.push(` ${property.fieldName}=${property.fieldName},`);\n }\n out.push(` type=event_type,`);\n for (const property of envelopePropertiesWithDefaults) {\n out.push(` ${property.fieldName}=${property.fieldName},`);\n }\n out.push(` raw_type=raw_type if event_type == SessionEventType.UNKNOWN else None,`);\n out.push(` )`);\n out.push(``);\n out.push(` def to_dict(self) -> dict:`);\n out.push(` result: dict = {}`);\n out.push(` result[\"data\"] = self.data.to_dict()`);\n for (const property of envelopePropertiesWithoutDefaults) {\n out.push(` result[${JSON.stringify(property.jsonName)}] = ${property.resolved.toExpr(`self.${property.fieldName}`)}`);\n }\n out.push(\n ` result[\"type\"] = self.raw_type if self.type == SessionEventType.UNKNOWN and self.raw_type is not None else to_enum(SessionEventType, self.type)`\n );\n for (const property of envelopePropertiesWithDefaults) {\n const valueExpr = property.resolved.toExpr(`self.${property.fieldName}`);\n if (property.required) {\n out.push(` result[${JSON.stringify(property.jsonName)}] = ${valueExpr}`);\n } else {\n out.push(` if self.${property.fieldName} is not None:`);\n out.push(` result[${JSON.stringify(property.jsonName)}] = ${valueExpr}`);\n }\n }\n out.push(` return result`);\n out.push(``);\n out.push(``);\n out.push(`def session_event_from_dict(s: Any) -> SessionEvent:`);\n out.push(` return SessionEvent.from_dict(s)`);\n out.push(``);\n out.push(``);\n out.push(`def session_event_to_dict(x: SessionEvent) -> Any:`);\n out.push(` return x.to_dict()`);\n out.push(``);\n out.push(``);\n\n return postProcessPythonSessionEventCode(out.join(\"\\n\"));\n}\n\nasync function generateSessionEvents(schemaPath?: string): Promise {\n console.log(\"Python: generating session-events...\");\n\n const resolvedPath = schemaPath ?? (await getSessionEventsSchemaPath());\n const schema = JSON.parse(await fs.readFile(resolvedPath, \"utf-8\")) as JSONSchema7;\n const processed = postProcessSchema(schema);\n const code = generatePythonSessionEventsCode(processed);\n\n const outPath = await writeGeneratedFile(\"python/copilot/generated/session_events.py\", code);\n console.log(` ✓ ${outPath}`);\n}\n\n// ── RPC Types ───────────────────────────────────────────────────────────────\n\nasync function generateRpc(schemaPath?: string): Promise {\n console.log(\"Python: generating RPC types...\");\n const { FetchingJSONSchemaStore, InputData, JSONSchemaInput, quicktype } = await import(\"quicktype-core\");\n\n const resolvedPath = schemaPath ?? (await getApiSchemaPath());\n const schema = fixNullableRequiredRefsInApiSchema(cloneSchemaForCodegen(JSON.parse(await fs.readFile(resolvedPath, \"utf-8\")) as ApiSchema));\n\n const allMethods = [\n ...collectRpcMethods(schema.server || {}),\n ...collectRpcMethods(schema.session || {}),\n ...collectRpcMethods(schema.clientSession || {}),\n ];\n\n // Build a combined schema for quicktype, including shared definitions from the API schema\n rpcDefinitions = collectDefinitionCollections(schema as Record);\n const combinedSchema = withSharedDefinitions(\n {\n $schema: \"http://json-schema.org/draft-07/schema#\",\n },\n rpcDefinitions\n );\n\n for (const method of allMethods) {\n const resultSchema = getMethodResultSchema(method);\n if (!isVoidSchema(resultSchema)) {\n const nullableInner = resultSchema ? getNullableInner(resultSchema) : undefined;\n if (!nullableInner) {\n combinedSchema.definitions![pythonResultTypeName(method)] = withRootTitle(\n schemaSourceForNamedDefinition(method.result, resultSchema),\n pythonResultTypeName(method)\n );\n }\n // For nullable results, the inner type (e.g., SessionFsError) is already in definitions\n }\n const resolvedParams = getMethodParamsSchema(method);\n if (method.params && hasSchemaPayload(resolvedParams)) {\n if (method.rpcMethod.startsWith(\"session.\") && resolvedParams?.properties) {\n const filtered: JSONSchema7 = {\n ...resolvedParams,\n properties: Object.fromEntries(\n Object.entries(resolvedParams.properties).filter(([k]) => k !== \"sessionId\")\n ),\n required: resolvedParams.required?.filter((r) => r !== \"sessionId\"),\n };\n if (hasSchemaPayload(filtered)) {\n combinedSchema.definitions![pythonParamsTypeName(method)] = withRootTitle(\n filtered,\n pythonParamsTypeName(method)\n );\n }\n } else {\n combinedSchema.definitions![pythonParamsTypeName(method)] = withRootTitle(\n schemaSourceForNamedDefinition(method.params, resolvedParams),\n pythonParamsTypeName(method)\n );\n }\n }\n }\n\n const allDefinitions = combinedSchema.definitions! as Record;\n const allDefinitionCollections: DefinitionCollections = {\n definitions: { ...(combinedSchema.$defs ?? {}), ...allDefinitions },\n $defs: { ...allDefinitions, ...(combinedSchema.$defs ?? {}) },\n };\n\n // Generate types via quicktype — use a single combined schema source to avoid\n // quicktype inventing Purple/Fluffy disambiguation prefixes for shared types\n const schemaInput = new JSONSchemaInput(new FetchingJSONSchemaStore());\n const singleSchema: Record = {\n $schema: \"http://json-schema.org/draft-07/schema#\",\n type: \"object\",\n definitions: allDefinitions,\n properties: Object.fromEntries(\n Object.keys(allDefinitions).map((name) => [name, { $ref: `#/definitions/${name}` }])\n ),\n required: Object.keys(allDefinitions),\n };\n await schemaInput.addSource({ name: \"RPC\", schema: JSON.stringify(singleSchema) });\n\n const inputData = new InputData();\n inputData.addInput(schemaInput);\n\n const qtResult = await quicktype({\n inputData,\n lang: \"python\",\n rendererOptions: { \"python-version\": \"3.7\" },\n });\n\n let typesCode = qtResult.lines.join(\"\\n\");\n // Fix dataclass field ordering\n typesCode = typesCode.replace(/: Any$/gm, \": Any = None\");\n // Fix bare except: to use Exception (required by ruff/pylint)\n typesCode = typesCode.replace(/except:/g, \"except Exception:\");\n // Remove unnecessary pass when class has methods (quicktype generates pass for empty schemas)\n typesCode = typesCode.replace(/^(\\s*)pass\\n\\n(\\s*@staticmethod)/gm, \"$2\");\n // Modernize to Python 3.11+ syntax\n typesCode = modernizePython(typesCode);\n const knownDefNames = new Set(Object.keys(allDefinitions).map((n) => n.toLowerCase()));\n typesCode = collapsePlaceholderPythonDataclasses(typesCode, knownDefNames);\n\n // Fix quicktype's Enum-suffix renaming: quicktype sometimes renames \"Xyz\" to\n // \"XyzEnum\" to avoid internal collisions. Strip the suffix to match our schema\n // definition names, but fail the build if that introduces a duplicate definition.\n for (const defName of Object.keys(allDefinitions)) {\n const enumSuffixed = defName + \"Enum\";\n if (!new RegExp(`\\\\bclass ${enumSuffixed}\\\\b`).test(typesCode)) continue;\n const renamed = typesCode.replace(new RegExp(`\\\\b${enumSuffixed}\\\\b`, \"g\"), defName);\n const classCount = (renamed.match(new RegExp(`^class ${defName}\\\\b`, \"gm\")) ?? []).length;\n if (classCount > 1) {\n throw new Error(\n `Python codegen: stripping quicktype's \"Enum\" suffix from \"${enumSuffixed}\" ` +\n `would produce a duplicate definition for \"${defName}\". ` +\n `Fix the schema definition name or add .withTypeName() to disambiguate.`\n );\n }\n typesCode = renamed;\n }\n\n // Reorder class/enum definitions to resolve forward references.\n // Quicktype may emit classes before their dependencies are defined.\n typesCode = reorderPythonForwardRefs(typesCode);\n\n // Strip quicktype's import block and preamble — we provide our own unified header.\n // The preamble ends just before the first helper function (e.g. \"def from_str\")\n // or class definition.\n typesCode = typesCode.replace(/^[\\s\\S]*?(?=^(?:def |@dataclass|class )\\w)/m, \"\");\n\n // Strip trailing whitespace from blank lines (e.g. inside multi-line docstrings)\n typesCode = typesCode.replace(/^\\s+$/gm, \"\");\n\n // Annotate experimental data types\n const experimentalTypeNames = new Set();\n for (const method of allMethods) {\n if (method.stability !== \"experimental\") continue;\n experimentalTypeNames.add(pythonResultTypeName(method));\n const paramsTypeName = pythonParamsTypeName(method);\n if (allDefinitions[paramsTypeName]) {\n experimentalTypeNames.add(paramsTypeName);\n }\n }\n for (const typeName of experimentalTypeNames) {\n typesCode = typesCode.replace(\n new RegExp(`^(@dataclass\\\\n)?class ${typeName}[:(]`, \"m\"),\n (match) => `# Experimental: this type is part of an experimental API and may change or be removed.\\n${match}`\n );\n }\n\n // Annotate deprecated data types\n const deprecatedTypeNames = new Set();\n for (const method of allMethods) {\n if (!method.deprecated) continue;\n if (!method.result?.$ref) {\n deprecatedTypeNames.add(pythonResultTypeName(method));\n }\n if (!method.params?.$ref) {\n const paramsTypeName = pythonParamsTypeName(method);\n if (allDefinitions[paramsTypeName]) {\n deprecatedTypeNames.add(paramsTypeName);\n }\n }\n }\n for (const typeName of deprecatedTypeNames) {\n typesCode = typesCode.replace(\n new RegExp(`^(@dataclass\\\\n)?class ${typeName}[:(]`, \"m\"),\n (match) => `# Deprecated: this type is part of a deprecated API and will be removed in a future version.\\n${match}`\n );\n }\n\n // Extract actual class names generated by quicktype (may differ from toPascalCase,\n // e.g. quicktype produces \"SessionMCPList\" not \"SessionMcpList\")\n const actualTypeNames = new Map();\n const classRe = /^class\\s+(\\w+)\\b/gm;\n let cm;\n while ((cm = classRe.exec(typesCode)) !== null) {\n actualTypeNames.set(cm[1].toLowerCase(), cm[1]);\n }\n const resolveType = (name: string): string => actualTypeNames.get(name.toLowerCase()) ?? name;\n\n const lines: string[] = [];\n lines.push(`\"\"\"\nAUTO-GENERATED FILE - DO NOT EDIT\nGenerated from: api.schema.json\n\"\"\"\n\nfrom typing import TYPE_CHECKING\n\nif TYPE_CHECKING:\n from .._jsonrpc import JsonRpcClient\n\nfrom collections.abc import Callable\nfrom dataclasses import dataclass\nfrom datetime import datetime\nfrom enum import Enum\nfrom typing import Any, Protocol, TypeVar, cast\nfrom uuid import UUID\n\nimport dateutil.parser\n\nT = TypeVar(\"T\")\nEnumT = TypeVar(\"EnumT\", bound=Enum)\n\n`);\n lines.push(typesCode);\n lines.push(`\ndef _timeout_kwargs(timeout: float | None) -> dict:\n \"\"\"Build keyword arguments for optional timeout forwarding.\"\"\"\n if timeout is not None:\n return {\"timeout\": timeout}\n return {}\n\ndef _patch_model_capabilities(data: dict) -> dict:\n \"\"\"Ensure model capabilities have required fields.\n\n TODO: Remove once the runtime schema correctly marks these fields as optional.\n Some models (e.g. embedding models) may omit 'limits' or 'supports' in their\n capabilities, or omit 'max_context_window_tokens' within limits. The generated\n deserializer requires these fields, so we supply defaults here.\n \"\"\"\n for model in data.get(\"models\", []):\n caps = model.get(\"capabilities\")\n if caps is None:\n model[\"capabilities\"] = {\"supports\": {}, \"limits\": {\"max_context_window_tokens\": 0}}\n continue\n if \"supports\" not in caps:\n caps[\"supports\"] = {}\n if \"limits\" not in caps:\n caps[\"limits\"] = {\"max_context_window_tokens\": 0}\n elif \"max_context_window_tokens\" not in caps[\"limits\"]:\n caps[\"limits\"][\"max_context_window_tokens\"] = 0\n return data\n\n`);\n\n // Emit RPC wrapper classes\n if (schema.server) {\n emitRpcWrapper(lines, schema.server, false, resolveType);\n }\n if (schema.session) {\n emitRpcWrapper(lines, schema.session, true, resolveType);\n }\n if (schema.clientSession) {\n emitClientSessionApiRegistration(lines, schema.clientSession, resolveType);\n }\n\n // Patch models.list to normalize capabilities before deserialization\n let finalCode = lines.join(\"\\n\");\n finalCode = finalCode.replace(\n `ModelList.from_dict(await self._client.request(\"models.list\"`,\n `ModelList.from_dict(_patch_model_capabilities(await self._client.request(\"models.list\"`,\n );\n // Close the extra paren opened by _patch_model_capabilities(\n // Match everything from _patch_model_capabilities( up to the end of the return statement\n finalCode = finalCode.replace(\n /(_patch_model_capabilities\\(await self\\._client\\.request\\(\"models\\.list\"[^)]*\\)[^)]*\\))/,\n \"$1)\",\n );\n finalCode = unwrapRedundantPythonLambdas(finalCode);\n\n const outPath = await writeGeneratedFile(\"python/copilot/generated/rpc.py\", finalCode);\n console.log(` ✓ ${outPath}`);\n}\n\nfunction emitPyApiGroup(\n lines: string[],\n apiName: string,\n node: Record,\n isSession: boolean,\n resolveType: (name: string) => string,\n groupExperimental: boolean,\n groupDeprecated: boolean = false\n): void {\n const subGroups = Object.entries(node).filter(([, v]) => typeof v === \"object\" && v !== null && !isRpcMethod(v));\n\n // Emit sub-group classes first (Python needs definitions before use)\n for (const [subGroupName, subGroupNode] of subGroups) {\n const subApiName = apiName.replace(/Api$/, \"\") + toPascalCase(subGroupName) + \"Api\";\n const subGroupExperimental = isNodeFullyExperimental(subGroupNode as Record);\n const subGroupDeprecated = isNodeFullyDeprecated(subGroupNode as Record);\n emitPyApiGroup(lines, subApiName, subGroupNode as Record, isSession, resolveType, subGroupExperimental, subGroupDeprecated);\n }\n\n // Emit this class\n if (groupDeprecated) {\n lines.push(`# Deprecated: this API group is deprecated and will be removed in a future version.`);\n }\n if (groupExperimental) {\n lines.push(`# Experimental: this API group is experimental and may change or be removed.`);\n }\n lines.push(`class ${apiName}:`);\n if (isSession) {\n lines.push(` def __init__(self, client: \"JsonRpcClient\", session_id: str):`);\n lines.push(` self._client = client`);\n lines.push(` self._session_id = session_id`);\n for (const [subGroupName] of subGroups) {\n const subApiName = apiName.replace(/Api$/, \"\") + toPascalCase(subGroupName) + \"Api\";\n lines.push(` self.${toSnakeCase(subGroupName)} = ${subApiName}(client, session_id)`);\n }\n } else {\n lines.push(` def __init__(self, client: \"JsonRpcClient\"):`);\n lines.push(` self._client = client`);\n for (const [subGroupName] of subGroups) {\n const subApiName = apiName.replace(/Api$/, \"\") + toPascalCase(subGroupName) + \"Api\";\n lines.push(` self.${toSnakeCase(subGroupName)} = ${subApiName}(client)`);\n }\n }\n lines.push(``);\n\n for (const [key, value] of Object.entries(node)) {\n if (!isRpcMethod(value)) continue;\n emitMethod(lines, key, value, isSession, resolveType, groupExperimental, groupDeprecated);\n }\n lines.push(``);\n}\n\nfunction emitRpcWrapper(lines: string[], node: Record, isSession: boolean, resolveType: (name: string) => string): void {\n const groups = Object.entries(node).filter(([, v]) => typeof v === \"object\" && v !== null && !isRpcMethod(v));\n const topLevelMethods = Object.entries(node).filter(([, v]) => isRpcMethod(v));\n\n const wrapperName = isSession ? \"SessionRpc\" : \"ServerRpc\";\n\n // Emit API classes for groups (recursively handles sub-groups)\n for (const [groupName, groupNode] of groups) {\n const prefix = isSession ? \"\" : \"Server\";\n const apiName = prefix + toPascalCase(groupName) + \"Api\";\n const groupExperimental = isNodeFullyExperimental(groupNode as Record);\n const groupDeprecated = isNodeFullyDeprecated(groupNode as Record);\n emitPyApiGroup(lines, apiName, groupNode as Record, isSession, resolveType, groupExperimental, groupDeprecated);\n }\n\n // Emit wrapper class\n if (isSession) {\n lines.push(`class ${wrapperName}:`);\n lines.push(` \"\"\"Typed session-scoped RPC methods.\"\"\"`);\n lines.push(` def __init__(self, client: \"JsonRpcClient\", session_id: str):`);\n lines.push(` self._client = client`);\n lines.push(` self._session_id = session_id`);\n for (const [groupName] of groups) {\n lines.push(` self.${toSnakeCase(groupName)} = ${toPascalCase(groupName)}Api(client, session_id)`);\n }\n } else {\n lines.push(`class ${wrapperName}:`);\n lines.push(` \"\"\"Typed server-scoped RPC methods.\"\"\"`);\n lines.push(` def __init__(self, client: \"JsonRpcClient\"):`);\n lines.push(` self._client = client`);\n for (const [groupName] of groups) {\n lines.push(` self.${toSnakeCase(groupName)} = Server${toPascalCase(groupName)}Api(client)`);\n }\n }\n lines.push(``);\n\n // Top-level methods\n for (const [key, value] of topLevelMethods) {\n if (!isRpcMethod(value)) continue;\n emitMethod(lines, key, value, isSession, resolveType, false);\n }\n lines.push(``);\n}\n\nfunction emitMethod(lines: string[], name: string, method: RpcMethod, isSession: boolean, resolveType: (name: string) => string, groupExperimental = false, groupDeprecated = false): void {\n const methodName = toSnakeCase(name);\n const resultSchema = getMethodResultSchema(method);\n const nullableInner = resultSchema ? getNullableInner(resultSchema) : undefined;\n const effectiveResultSchema = nullableInner ?? resultSchema;\n const hasResult = !isVoidSchema(resultSchema) && !nullableInner;\n const hasNullableResult = !!nullableInner;\n const resultIsObject = isObjectSchema(effectiveResultSchema);\n\n let resultType: string;\n if (hasNullableResult) {\n const innerTypeName = resolveType(pythonResultTypeName(method, nullableInner));\n resultType = `${innerTypeName} | None`;\n } else if (hasResult) {\n resultType = resolveType(pythonResultTypeName(method));\n } else {\n resultType = \"None\";\n }\n\n const effectiveParams = getMethodParamsSchema(method);\n const paramProps = effectiveParams?.properties || {};\n const nonSessionParams = Object.keys(paramProps).filter((k) => k !== \"sessionId\");\n const hasParams = isSession ? nonSessionParams.length > 0 : hasSchemaPayload(effectiveParams);\n const paramsType = resolveType(pythonParamsTypeName(method));\n const paramsOptional = isParamsOptional(method);\n\n // Build signature with typed params + optional timeout\n const sig = hasParams\n ? paramsOptional\n ? ` async def ${methodName}(self, params: ${paramsType} | None = None, *, timeout: float | None = None) -> ${resultType}:`\n : ` async def ${methodName}(self, params: ${paramsType}, *, timeout: float | None = None) -> ${resultType}:`\n : ` async def ${methodName}(self, *, timeout: float | None = None) -> ${resultType}:`;\n\n lines.push(sig);\n\n if (method.deprecated && !groupDeprecated) {\n lines.push(` \"\"\".. deprecated:: This API is deprecated and will be removed in a future version.\"\"\"`);\n }\n if (method.stability === \"experimental\" && !groupExperimental) {\n lines.push(` \"\"\".. warning:: This API is experimental and may change or be removed in future versions.\"\"\"`);\n }\n\n // Deserialize helper\n const innerTypeName = hasNullableResult ? resolveType(pythonResultTypeName(method, nullableInner)) : resultType;\n const deserialize = (expr: string) => {\n if (hasNullableResult) {\n return resultIsObject\n ? `${innerTypeName}.from_dict(${expr}) if ${expr} is not None else None`\n : `${innerTypeName}(${expr}) if ${expr} is not None else None`;\n }\n return resultIsObject ? `${innerTypeName}.from_dict(${expr})` : `${innerTypeName}(${expr})`;\n };\n\n // Build request body with proper serialization/deserialization\n const emitRequestCall = (paramsExpr: string) => {\n const callExpr = `await self._client.request(\"${method.rpcMethod}\", ${paramsExpr}, **_timeout_kwargs(timeout))`;\n if (hasResult || hasNullableResult) {\n if (hasNullableResult) {\n lines.push(` _result = ${callExpr}`);\n lines.push(` return ${deserialize(\"_result\")}`);\n } else {\n lines.push(` return ${deserialize(callExpr)}`);\n }\n } else {\n lines.push(` ${callExpr}`);\n }\n };\n\n if (isSession) {\n if (hasParams) {\n if (paramsOptional) {\n lines.push(` params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None} if params is not None else {}`);\n } else {\n lines.push(` params_dict: dict[str, Any] = {k: v for k, v in params.to_dict().items() if v is not None}`);\n }\n lines.push(` params_dict[\"sessionId\"] = self._session_id`);\n emitRequestCall(\"params_dict\");\n } else {\n emitRequestCall(`{\"sessionId\": self._session_id}`);\n }\n } else {\n if (hasParams) {\n if (paramsOptional) {\n lines.push(` params_dict = {k: v for k, v in params.to_dict().items() if v is not None} if params is not None else {}`);\n } else {\n lines.push(` params_dict = {k: v for k, v in params.to_dict().items() if v is not None}`);\n }\n emitRequestCall(\"params_dict\");\n } else {\n emitRequestCall(\"{}\");\n }\n }\n lines.push(``);\n}\n\nfunction emitClientSessionApiRegistration(\n lines: string[],\n node: Record,\n resolveType: (name: string) => string\n): void {\n const groups = Object.entries(node).filter(([, value]) => typeof value === \"object\" && value !== null && !isRpcMethod(value));\n\n for (const [groupName, groupNode] of groups) {\n const handlerName = `${toPascalCase(groupName)}Handler`;\n const groupExperimental = isNodeFullyExperimental(groupNode as Record);\n const groupDeprecated = isNodeFullyDeprecated(groupNode as Record);\n if (groupDeprecated) {\n lines.push(`# Deprecated: this API group is deprecated and will be removed in a future version.`);\n }\n if (groupExperimental) {\n lines.push(`# Experimental: this API group is experimental and may change or be removed.`);\n }\n lines.push(`class ${handlerName}(Protocol):`);\n for (const [methodName, value] of Object.entries(groupNode as Record)) {\n if (!isRpcMethod(value)) continue;\n emitClientSessionHandlerMethod(lines, methodName, value, resolveType, groupExperimental, groupDeprecated);\n }\n lines.push(``);\n }\n\n lines.push(`@dataclass`);\n lines.push(`class ClientSessionApiHandlers:`);\n if (groups.length === 0) {\n lines.push(` pass`);\n } else {\n for (const [groupName] of groups) {\n lines.push(` ${toSnakeCase(groupName)}: ${toPascalCase(groupName)}Handler | None = None`);\n }\n }\n lines.push(``);\n\n lines.push(`def register_client_session_api_handlers(`);\n lines.push(` client: \"JsonRpcClient\",`);\n lines.push(` get_handlers: Callable[[str], ClientSessionApiHandlers],`);\n lines.push(`) -> None:`);\n lines.push(` \"\"\"Register client-session request handlers on a JSON-RPC connection.\"\"\"`);\n if (groups.length === 0) {\n lines.push(` return`);\n } else {\n for (const [groupName, groupNode] of groups) {\n for (const [methodName, value] of Object.entries(groupNode as Record)) {\n if (!isRpcMethod(value)) continue;\n emitClientSessionRegistrationMethod(\n lines,\n groupName,\n methodName,\n value,\n resolveType\n );\n }\n }\n }\n lines.push(``);\n}\n\nfunction emitClientSessionHandlerMethod(\n lines: string[],\n name: string,\n method: RpcMethod,\n resolveType: (name: string) => string,\n groupExperimental = false,\n groupDeprecated = false\n): void {\n const paramsType = resolveType(pythonParamsTypeName(method));\n const resultSchema = getMethodResultSchema(method);\n const nullableInner = resultSchema ? getNullableInner(resultSchema) : undefined;\n let resultType: string;\n if (nullableInner) {\n resultType = `${resolveType(pythonResultTypeName(method, nullableInner))} | None`;\n } else if (!isVoidSchema(resultSchema)) {\n resultType = resolveType(pythonResultTypeName(method));\n } else {\n resultType = \"None\";\n }\n lines.push(` async def ${toSnakeCase(name)}(self, params: ${paramsType}) -> ${resultType}:`);\n if (method.deprecated && !groupDeprecated) {\n lines.push(` \"\"\".. deprecated:: This API is deprecated and will be removed in a future version.\"\"\"`);\n }\n if (method.stability === \"experimental\" && !groupExperimental) {\n lines.push(` \"\"\".. warning:: This API is experimental and may change or be removed in future versions.\"\"\"`);\n }\n lines.push(` pass`);\n}\n\nfunction emitClientSessionRegistrationMethod(\n lines: string[],\n groupName: string,\n methodName: string,\n method: RpcMethod,\n resolveType: (name: string) => string\n): void {\n const handlerVariableName = `handle_${toSnakeCase(groupName)}_${toSnakeCase(methodName)}`;\n const paramsType = resolveType(pythonParamsTypeName(method));\n const resultSchema = getMethodResultSchema(method);\n const nullableInner = resultSchema ? getNullableInner(resultSchema) : undefined;\n const hasResult = !isVoidSchema(resultSchema) && !nullableInner;\n const handlerField = toSnakeCase(groupName);\n const handlerMethod = toSnakeCase(methodName);\n\n lines.push(` async def ${handlerVariableName}(params: dict) -> dict | None:`);\n lines.push(` request = ${paramsType}.from_dict(params)`);\n lines.push(` handler = get_handlers(request.session_id).${handlerField}`);\n lines.push(\n ` if handler is None: raise RuntimeError(f\"No ${handlerField} handler registered for session: {request.session_id}\")`\n );\n if (hasResult) {\n lines.push(` result = await handler.${handlerMethod}(request)`);\n if (isObjectSchema(resultSchema)) {\n lines.push(` return result.to_dict()`);\n } else {\n lines.push(` return result.value if hasattr(result, 'value') else result`);\n }\n } else if (nullableInner) {\n lines.push(` result = await handler.${handlerMethod}(request)`);\n const resolvedInner = resolveSchema(nullableInner, rpcDefinitions) ?? nullableInner;\n if (isObjectSchema(resolvedInner) || nullableInner.$ref) {\n lines.push(` return result.to_dict() if result is not None else None`);\n } else {\n lines.push(` return result`);\n }\n } else {\n lines.push(` await handler.${handlerMethod}(request)`);\n lines.push(` return None`);\n }\n lines.push(` client.set_request_handler(\"${method.rpcMethod}\", ${handlerVariableName})`);\n}\n\n// ── Main ────────────────────────────────────────────────────────────────────\n\nasync function generate(sessionSchemaPath?: string, apiSchemaPath?: string): Promise {\n await generateSessionEvents(sessionSchemaPath);\n try {\n await generateRpc(apiSchemaPath);\n } catch (err) {\n if ((err as NodeJS.ErrnoException).code === \"ENOENT\" && !apiSchemaPath) {\n console.log(\"Python: skipping RPC (api.schema.json not found)\");\n } else {\n throw err;\n }\n }\n}\n\nconst __filename = fileURLToPath(import.meta.url);\n\nif (process.argv[1] && path.resolve(process.argv[1]) === __filename) {\n const sessionArg = process.argv[2] || undefined;\n const apiArg = process.argv[3] || undefined;\n generate(sessionArg, apiArg).catch((err) => {\n console.error(\"Python generation failed:\", err);\n process.exit(1);\n });\n}\n" }, { "path": "scripts/codegen/typescript.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\n/**\n * TypeScript code generator for session-events and RPC types.\n */\n\nimport fs from \"fs/promises\";\nimport type { JSONSchema7 } from \"json-schema\";\nimport { compile } from \"json-schema-to-typescript\";\nimport {\n getApiSchemaPath,\n fixNullableRequiredRefsInApiSchema,\n getNullableInner,\n getRpcSchemaTypeName,\n getSessionEventsSchemaPath,\n postProcessSchema,\n writeGeneratedFile,\n collectDefinitionCollections,\n hasSchemaPayload,\n resolveObjectSchema,\n resolveSchema,\n withSharedDefinitions,\n isRpcMethod,\n isNodeFullyExperimental,\n isNodeFullyDeprecated,\n isVoidSchema,\n type ApiSchema,\n type DefinitionCollections,\n type RpcMethod,\n} from \"./utils.js\";\n\nfunction toPascalCase(s: string): string {\n return s.charAt(0).toUpperCase() + s.slice(1);\n}\n\nfunction appendUniqueExportBlocks(output: string[], compiled: string, seenBlocks: Map): void {\n for (const block of splitExportBlocks(compiled)) {\n const nameMatch = /^export\\s+(?:interface|type)\\s+(\\w+)/m.exec(block);\n if (!nameMatch) {\n output.push(block);\n continue;\n }\n\n const name = nameMatch[1];\n const normalizedBlock = normalizeExportBlock(block);\n const existing = seenBlocks.get(name);\n if (existing) {\n if (existing !== normalizedBlock) {\n throw new Error(`Duplicate generated TypeScript declaration for \"${name}\" with different content.`);\n }\n continue;\n }\n\n seenBlocks.set(name, normalizedBlock);\n output.push(block);\n }\n}\n\nfunction splitExportBlocks(compiled: string): string[] {\n const normalizedCompiled = compiled\n .trim()\n .replace(/;(export\\s+(?:interface|type)\\s+)/g, \";\\n$1\")\n .replace(/}(export\\s+(?:interface|type)\\s+)/g, \"}\\n$1\");\n const lines = normalizedCompiled.split(/\\r?\\n/);\n const blocks: string[] = [];\n let pending: string[] = [];\n\n for (let index = 0; index < lines.length;) {\n const line = lines[index];\n if (!/^export\\s+(?:interface|type)\\s+\\w+/.test(line)) {\n pending.push(line);\n index++;\n continue;\n }\n\n const blockLines = [...pending, line];\n pending = [];\n let braceDepth = countBraces(line);\n index++;\n\n if (braceDepth === 0 && line.trim().endsWith(\";\")) {\n blocks.push(blockLines.join(\"\\n\").trim());\n continue;\n }\n\n while (index < lines.length) {\n const nextLine = lines[index];\n blockLines.push(nextLine);\n braceDepth += countBraces(nextLine);\n index++;\n\n const trimmed = nextLine.trim();\n if (braceDepth === 0 && (trimmed === \"}\" || trimmed.endsWith(\";\"))) {\n break;\n }\n }\n\n blocks.push(blockLines.join(\"\\n\").trim());\n }\n\n return blocks;\n}\n\nfunction countBraces(line: string): number {\n let depth = 0;\n for (const char of line) {\n if (char === \"{\") depth++;\n if (char === \"}\") depth--;\n }\n return depth;\n}\n\nfunction normalizeExportBlock(block: string): string {\n return block\n .replace(/\\/\\*\\*[\\s\\S]*?\\*\\//g, \"\")\n .split(/\\r?\\n/)\n .map((line) => line.trim())\n .filter((line) => line.length > 0)\n .join(\"\\n\");\n}\n\nfunction collectRpcMethods(node: Record): RpcMethod[] {\n const results: RpcMethod[] = [];\n for (const value of Object.values(node)) {\n if (isRpcMethod(value)) {\n results.push(value);\n } else if (typeof value === \"object\" && value !== null) {\n results.push(...collectRpcMethods(value as Record));\n }\n }\n return results;\n}\n\nfunction normalizeSchemaForTypeScript(schema: JSONSchema7): JSONSchema7 {\n const root = structuredClone(schema) as JSONSchema7 & {\n definitions?: Record;\n $defs?: Record;\n };\n const definitions = { ...(root.definitions ?? {}) };\n const draftDefinitionAliases = new Map();\n\n for (const [key, value] of Object.entries(root.$defs ?? {})) {\n if (key in definitions) {\n // The definitions entry is authoritative (it went through the full pipeline).\n // Drop the $defs duplicate and rewrite any $ref pointing at it to use definitions.\n draftDefinitionAliases.set(key, key);\n } else {\n draftDefinitionAliases.set(key, key);\n definitions[key] = value;\n }\n }\n\n root.definitions = definitions;\n delete root.$defs;\n\n const rewrite = (value: unknown): unknown => {\n if (Array.isArray(value)) {\n return value.map(rewrite);\n }\n if (!value || typeof value !== \"object\") {\n return value;\n }\n\n const rewritten = Object.fromEntries(\n Object.entries(value as Record).map(([key, child]) => [key, rewrite(child)])\n ) as Record;\n\n if (typeof rewritten.$ref === \"string\") {\n if (rewritten.$ref.startsWith(\"#/$defs/\")) {\n const definitionName = rewritten.$ref.slice(\"#/$defs/\".length);\n rewritten.$ref = `#/definitions/${draftDefinitionAliases.get(definitionName) ?? definitionName}`;\n }\n // json-schema-to-typescript treats sibling keywords alongside $ref as a\n // new inline type instead of reusing the referenced definition. Strip\n // siblings so that $ref-only objects compile to a single shared type.\n for (const key of Object.keys(rewritten)) {\n if (key !== \"$ref\") {\n delete rewritten[key];\n }\n }\n }\n\n return rewritten;\n };\n\n return rewrite(root) as JSONSchema7;\n}\n\n// ── Session Events ──────────────────────────────────────────────────────────\n\nasync function generateSessionEvents(schemaPath?: string): Promise {\n console.log(\"TypeScript: generating session-events...\");\n\n const resolvedPath = schemaPath ?? (await getSessionEventsSchemaPath());\n const schema = JSON.parse(await fs.readFile(resolvedPath, \"utf-8\")) as JSONSchema7;\n const processed = postProcessSchema(schema);\n const definitionCollections = collectDefinitionCollections(processed as Record);\n const sessionEvent =\n resolveSchema({ $ref: \"#/definitions/SessionEvent\" }, definitionCollections) ??\n resolveSchema({ $ref: \"#/$defs/SessionEvent\" }, definitionCollections) ??\n processed;\n const schemaForCompile = withSharedDefinitions(sessionEvent, definitionCollections);\n\n const ts = await compile(normalizeSchemaForTypeScript(schemaForCompile), \"SessionEvent\", {\n bannerComment: `/**\n * AUTO-GENERATED FILE - DO NOT EDIT\n * Generated from: session-events.schema.json\n */`,\n style: { semi: true, singleQuote: false, trailingComma: \"all\" },\n additionalProperties: false,\n });\n\n const outPath = await writeGeneratedFile(\"nodejs/src/generated/session-events.ts\", ts);\n console.log(` ✓ ${outPath}`);\n}\n\n// ── RPC Types ───────────────────────────────────────────────────────────────\n\nlet rpcDefinitions: DefinitionCollections = { definitions: {}, $defs: {} };\n\nfunction withRootTitle(schema: JSONSchema7, title: string): JSONSchema7 {\n return { ...schema, title };\n}\n\nfunction rpcRequestFallbackName(method: RpcMethod): string {\n return method.rpcMethod.split(\".\").map(toPascalCase).join(\"\") + \"Request\";\n}\n\nfunction schemaSourceForNamedDefinition(\n schema: JSONSchema7 | null | undefined,\n resolvedSchema: JSONSchema7 | undefined\n): JSONSchema7 {\n if (schema?.$ref && resolvedSchema) {\n return resolvedSchema;\n }\n // When the schema is an anyOf/oneOf wrapper (e.g., Zod optional params producing\n // `anyOf: [{ not: {} }, { $ref }]`), use the resolved object schema to avoid\n // generating self-referential type aliases.\n if ((schema?.anyOf || schema?.oneOf) && resolvedSchema?.properties) {\n return resolvedSchema;\n }\n return schema ?? resolvedSchema ?? { type: \"object\" };\n}\n\nfunction getMethodResultSchema(method: RpcMethod): JSONSchema7 | undefined {\n return resolveSchema(method.result, rpcDefinitions) ?? method.result ?? undefined;\n}\n\nfunction getMethodParamsSchema(method: RpcMethod): JSONSchema7 | undefined {\n return (\n resolveObjectSchema(method.params, rpcDefinitions) ??\n resolveSchema(method.params, rpcDefinitions) ??\n method.params ??\n undefined\n );\n}\n\n/** True when the raw params schema uses `anyOf: [{ not: {} }, …]` — Zod's pattern for `.optional()`. */\nfunction isParamsOptional(method: RpcMethod): boolean {\n const schema = method.params;\n if (!schema?.anyOf) return false;\n return schema.anyOf.some(\n (item) =>\n typeof item === \"object\" &&\n (item as JSONSchema7).not !== undefined &&\n typeof (item as JSONSchema7).not === \"object\" &&\n Object.keys((item as JSONSchema7).not as object).length === 0\n );\n}\n\nfunction resultTypeName(method: RpcMethod): string {\n return getRpcSchemaTypeName(\n getMethodResultSchema(method),\n method.rpcMethod.split(\".\").map(toPascalCase).join(\"\") + \"Result\"\n );\n}\n\nfunction tsNullableResultTypeName(method: RpcMethod): string | undefined {\n const resultSchema = getMethodResultSchema(method);\n if (!resultSchema) return undefined;\n const inner = getNullableInner(resultSchema);\n if (!inner) return undefined;\n // Resolve $ref to a type name\n if (inner.$ref) {\n const refName = inner.$ref.split(\"/\").pop();\n if (refName) return `${toPascalCase(refName)} | undefined`;\n }\n const innerName = getRpcSchemaTypeName(inner, method.rpcMethod.split(\".\").map(toPascalCase).join(\"\") + \"Result\");\n return `${innerName} | undefined`;\n}\n\nfunction tsResultType(method: RpcMethod): string {\n if (isVoidSchema(getMethodResultSchema(method))) return \"void\";\n return tsNullableResultTypeName(method) ?? resultTypeName(method);\n}\n\nfunction paramsTypeName(method: RpcMethod): string {\n const fallback = rpcRequestFallbackName(method);\n if (method.rpcMethod.startsWith(\"session.\") && method.params?.$ref) {\n return fallback;\n }\n return getRpcSchemaTypeName(getMethodParamsSchema(method), fallback);\n}\n\nasync function generateRpc(schemaPath?: string): Promise {\n console.log(\"TypeScript: generating RPC types...\");\n\n const resolvedPath = schemaPath ?? (await getApiSchemaPath());\n const schema = fixNullableRequiredRefsInApiSchema(JSON.parse(await fs.readFile(resolvedPath, \"utf-8\")) as ApiSchema);\n\n const lines: string[] = [];\n lines.push(`/**\n * AUTO-GENERATED FILE - DO NOT EDIT\n * Generated from: api.schema.json\n */\n\nimport type { MessageConnection } from \"vscode-jsonrpc/node.js\";\n`);\n\n const allMethods = [...collectRpcMethods(schema.server || {}), ...collectRpcMethods(schema.session || {})];\n const clientSessionMethods = collectRpcMethods(schema.clientSession || {});\n const seenBlocks = new Map();\n\n // Build a single combined schema with shared definitions and all method types.\n // This ensures $ref-referenced types are generated exactly once.\n rpcDefinitions = collectDefinitionCollections(schema as Record);\n const combinedSchema = withSharedDefinitions(\n {\n $schema: \"http://json-schema.org/draft-07/schema#\",\n type: \"object\",\n },\n rpcDefinitions\n );\n\n // Track which type names come from experimental methods for JSDoc annotations.\n const experimentalTypes = new Set();\n // Track which type names come from deprecated methods for JSDoc annotations.\n const deprecatedTypes = new Set();\n\n for (const method of [...allMethods, ...clientSessionMethods]) {\n const resultSchema = getMethodResultSchema(method);\n if (!isVoidSchema(resultSchema) && !getNullableInner(resultSchema)) {\n combinedSchema.definitions![resultTypeName(method)] = withRootTitle(\n schemaSourceForNamedDefinition(method.result, resultSchema),\n resultTypeName(method)\n );\n if (method.stability === \"experimental\") {\n experimentalTypes.add(resultTypeName(method));\n }\n if (method.deprecated && !method.result?.$ref) {\n deprecatedTypes.add(resultTypeName(method));\n }\n }\n\n const resolvedParams = getMethodParamsSchema(method);\n if (method.params && hasSchemaPayload(resolvedParams)) {\n if (method.rpcMethod.startsWith(\"session.\") && resolvedParams?.properties) {\n const filtered: JSONSchema7 = {\n ...resolvedParams,\n properties: Object.fromEntries(\n Object.entries(resolvedParams.properties).filter(([k]) => k !== \"sessionId\")\n ),\n required: resolvedParams.required?.filter((r) => r !== \"sessionId\"),\n };\n if (hasSchemaPayload(filtered)) {\n combinedSchema.definitions![paramsTypeName(method)] = withRootTitle(\n filtered,\n paramsTypeName(method)\n );\n if (method.stability === \"experimental\") {\n experimentalTypes.add(paramsTypeName(method));\n }\n if (method.deprecated) {\n deprecatedTypes.add(paramsTypeName(method));\n }\n }\n } else {\n combinedSchema.definitions![paramsTypeName(method)] = withRootTitle(\n schemaSourceForNamedDefinition(method.params, resolvedParams),\n paramsTypeName(method)\n );\n if (method.stability === \"experimental\") {\n experimentalTypes.add(paramsTypeName(method));\n }\n if (method.deprecated && !method.params?.$ref) {\n deprecatedTypes.add(paramsTypeName(method));\n }\n }\n }\n }\n\n const schemaForCompile = combinedSchema;\n\n const compiled = await compile(normalizeSchemaForTypeScript(schemaForCompile), \"_RpcSchemaRoot\", {\n bannerComment: \"\",\n additionalProperties: false,\n unreachableDefinitions: true,\n });\n\n // Strip the placeholder root type and keep only the definition-generated types\n const strippedTs = compiled\n .replace(\n /\\/\\*\\*\\n \\* This (?:interface|type) was referenced by `_RpcSchemaRoot`'s JSON-Schema\\n \\* via the `definition` \"[^\"]+\"\\.\\n \\*\\/\\n/g,\n \"\\n\"\n )\n .replace(/export interface _RpcSchemaRoot\\s*\\{[^}]*\\}\\s*/g, \"\")\n .replace(/export type _RpcSchemaRoot = [^;]+;\\s*/g, \"\")\n .trim();\n\n if (strippedTs) {\n // Add @experimental JSDoc annotations for types from experimental methods\n let annotatedTs = strippedTs;\n for (const expType of experimentalTypes) {\n annotatedTs = annotatedTs.replace(\n new RegExp(`(^|\\\\n)(export (?:interface|type) ${expType}\\\\b)`, \"m\"),\n `$1/** @experimental */\\n$2`\n );\n }\n // Add @deprecated JSDoc annotations for types from deprecated methods\n for (const depType of deprecatedTypes) {\n annotatedTs = annotatedTs.replace(\n new RegExp(`(^|\\\\n)(export (?:interface|type) ${depType}\\\\b)`, \"m\"),\n `$1/** @deprecated */\\n$2`\n );\n }\n lines.push(annotatedTs);\n lines.push(\"\");\n }\n\n // Generate factory functions\n if (schema.server) {\n lines.push(`/** Create typed server-scoped RPC methods (no session required). */`);\n lines.push(`export function createServerRpc(connection: MessageConnection) {`);\n lines.push(` return {`);\n lines.push(...emitGroup(schema.server, \" \", false));\n lines.push(` };`);\n lines.push(`}`);\n lines.push(\"\");\n }\n\n if (schema.session) {\n lines.push(`/** Create typed session-scoped RPC methods. */`);\n lines.push(`export function createSessionRpc(connection: MessageConnection, sessionId: string) {`);\n lines.push(` return {`);\n lines.push(...emitGroup(schema.session, \" \", true));\n lines.push(` };`);\n lines.push(`}`);\n lines.push(\"\");\n }\n\n // Generate client session API handler interfaces and registration function\n if (schema.clientSession) {\n lines.push(...emitClientSessionApiRegistration(schema.clientSession));\n }\n\n const outPath = await writeGeneratedFile(\"nodejs/src/generated/rpc.ts\", lines.join(\"\\n\"));\n console.log(` ✓ ${outPath}`);\n}\n\nfunction emitGroup(node: Record, indent: string, isSession: boolean, parentExperimental = false, parentDeprecated = false): string[] {\n const lines: string[] = [];\n for (const [key, value] of Object.entries(node)) {\n if (isRpcMethod(value)) {\n const { rpcMethod, params } = value;\n const resultType = tsResultType(value);\n const paramsType = paramsTypeName(value);\n const effectiveParams = getMethodParamsSchema(value);\n\n const paramEntries = effectiveParams?.properties\n ? Object.entries(effectiveParams.properties).filter(([k]) => k !== \"sessionId\")\n : [];\n const hasParams = hasSchemaPayload(effectiveParams);\n const hasNonSessionParams = paramEntries.length > 0;\n\n const sigParams: string[] = [];\n let bodyArg: string;\n\n if (isSession) {\n if (hasNonSessionParams) {\n const optMark = isParamsOptional(value) ? \"?\" : \"\";\n // sessionId is already stripped from the generated type definition,\n // so no need for Omit<..., \"sessionId\">\n sigParams.push(`params${optMark}: ${paramsType}`);\n bodyArg = \"{ sessionId, ...params }\";\n } else {\n bodyArg = \"{ sessionId }\";\n }\n } else {\n if (hasParams) {\n const optMark = isParamsOptional(value) ? \"?\" : \"\";\n sigParams.push(`params${optMark}: ${paramsType}`);\n bodyArg = \"params\";\n } else {\n bodyArg = \"{}\";\n }\n }\n\n if ((value as RpcMethod).deprecated && !parentDeprecated) {\n lines.push(`${indent}/** @deprecated */`);\n }\n if ((value as RpcMethod).stability === \"experimental\" && !parentExperimental) {\n lines.push(`${indent}/** @experimental */`);\n }\n lines.push(`${indent}${key}: async (${sigParams.join(\", \")}): Promise<${resultType}> =>`);\n lines.push(`${indent} connection.sendRequest(\"${rpcMethod}\", ${bodyArg}),`);\n } else if (typeof value === \"object\" && value !== null) {\n const groupExperimental = isNodeFullyExperimental(value as Record);\n const groupDeprecated = isNodeFullyDeprecated(value as Record);\n if (groupDeprecated) {\n lines.push(`${indent}/** @deprecated */`);\n }\n if (groupExperimental) {\n lines.push(`${indent}/** @experimental */`);\n }\n lines.push(`${indent}${key}: {`);\n lines.push(...emitGroup(value as Record, indent + \" \", isSession, groupExperimental, groupDeprecated));\n lines.push(`${indent}},`);\n }\n }\n return lines;\n}\n\n// ── Client Session API Handler Generation ───────────────────────────────────\n\n/**\n * Collect client API methods grouped by their top-level namespace.\n * Returns a map like: { sessionFs: [{ rpcMethod, params, result }, ...] }\n */\nfunction collectClientGroups(node: Record): Map {\n const groups = new Map();\n for (const [groupName, groupNode] of Object.entries(node)) {\n if (typeof groupNode === \"object\" && groupNode !== null) {\n groups.set(groupName, collectRpcMethods(groupNode as Record));\n }\n }\n return groups;\n}\n\n/**\n * Derive the handler method name from the full RPC method name.\n * e.g., \"sessionFs.readFile\" → \"readFile\"\n */\nfunction handlerMethodName(rpcMethod: string): string {\n const parts = rpcMethod.split(\".\");\n return parts[parts.length - 1];\n}\n\n/**\n * Generate handler interfaces and a registration function for client session API groups.\n *\n * Client session API methods have `sessionId` on the wire (injected by the\n * runtime's proxy layer). The generated registration function accepts a\n * `getHandler` callback that resolves a sessionId to a handler object.\n * Param types include sessionId — handler code can simply ignore it.\n */\nfunction emitClientSessionApiRegistration(clientSchema: Record): string[] {\n const lines: string[] = [];\n const groups = collectClientGroups(clientSchema);\n\n // Emit a handler interface per group\n for (const [groupName, methods] of groups) {\n const interfaceName = toPascalCase(groupName) + \"Handler\";\n const groupDeprecated = isNodeFullyDeprecated(clientSchema[groupName] as Record);\n if (groupDeprecated) {\n lines.push(`/** @deprecated Handler for \\`${groupName}\\` client session API methods. */`);\n } else {\n lines.push(`/** Handler for \\`${groupName}\\` client session API methods. */`);\n }\n lines.push(`export interface ${interfaceName} {`);\n for (const method of methods) {\n const name = handlerMethodName(method.rpcMethod);\n const hasParams = hasSchemaPayload(getMethodParamsSchema(method));\n const pType = hasParams ? paramsTypeName(method) : \"\";\n const rType = tsResultType(method);\n\n if (method.deprecated && !groupDeprecated) {\n lines.push(` /** @deprecated */`);\n }\n if (hasParams) {\n lines.push(` ${name}(params: ${pType}): Promise<${rType}>;`);\n } else {\n lines.push(` ${name}(): Promise<${rType}>;`);\n }\n }\n lines.push(`}`);\n lines.push(\"\");\n }\n\n // Emit combined ClientSessionApiHandlers type\n lines.push(`/** All client session API handler groups. */`);\n lines.push(`export interface ClientSessionApiHandlers {`);\n for (const [groupName] of groups) {\n const interfaceName = toPascalCase(groupName) + \"Handler\";\n lines.push(` ${groupName}?: ${interfaceName};`);\n }\n lines.push(`}`);\n lines.push(\"\");\n\n // Emit registration function\n lines.push(`/**`);\n lines.push(` * Register client session API handlers on a JSON-RPC connection.`);\n lines.push(` * The server calls these methods to delegate work to the client.`);\n lines.push(` * Each incoming call includes a \\`sessionId\\` in the params; the registration`);\n lines.push(` * function uses \\`getHandlers\\` to resolve the session's handlers.`);\n lines.push(` */`);\n lines.push(`export function registerClientSessionApiHandlers(`);\n lines.push(` connection: MessageConnection,`);\n lines.push(` getHandlers: (sessionId: string) => ClientSessionApiHandlers,`);\n lines.push(`): void {`);\n\n for (const [groupName, methods] of groups) {\n for (const method of methods) {\n const name = handlerMethodName(method.rpcMethod);\n const pType = paramsTypeName(method);\n const hasParams = hasSchemaPayload(getMethodParamsSchema(method));\n\n if (hasParams) {\n lines.push(` connection.onRequest(\"${method.rpcMethod}\", async (params: ${pType}) => {`);\n lines.push(` const handler = getHandlers(params.sessionId).${groupName};`);\n lines.push(` if (!handler) throw new Error(\\`No ${groupName} handler registered for session: \\${params.sessionId}\\`);`);\n lines.push(` return handler.${name}(params);`);\n lines.push(` });`);\n } else {\n lines.push(` connection.onRequest(\"${method.rpcMethod}\", async () => {`);\n lines.push(` throw new Error(\"No params provided for ${method.rpcMethod}\");`);\n lines.push(` });`);\n }\n }\n }\n\n lines.push(`}`);\n lines.push(\"\");\n\n return lines;\n}\n\n// ── Main ────────────────────────────────────────────────────────────────────\n\nasync function generate(sessionSchemaPath?: string, apiSchemaPath?: string): Promise {\n await generateSessionEvents(sessionSchemaPath);\n try {\n await generateRpc(apiSchemaPath);\n } catch (err) {\n if ((err as NodeJS.ErrnoException).code === \"ENOENT\" && !apiSchemaPath) {\n console.log(\"TypeScript: skipping RPC (api.schema.json not found)\");\n } else {\n throw err;\n }\n }\n}\n\nconst sessionArg = process.argv[2] || undefined;\nconst apiArg = process.argv[3] || undefined;\ngenerate(sessionArg, apiArg).catch((err) => {\n console.error(\"TypeScript generation failed:\", err);\n process.exit(1);\n});\n" }, { "path": "scripts/codegen/utils.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\n/**\n * Shared utilities for code generation - schema loading, file I/O, schema processing.\n */\n\nimport { execFile } from \"child_process\";\nimport fs from \"fs/promises\";\nimport path from \"path\";\nimport { fileURLToPath } from \"url\";\nimport { promisify } from \"util\";\nimport type { JSONSchema7, JSONSchema7Definition } from \"json-schema\";\n\nexport const execFileAsync = promisify(execFile);\n\nconst __filename = fileURLToPath(import.meta.url);\nconst __dirname = path.dirname(__filename);\n\n/** Root of the copilot-sdk repo */\nexport const REPO_ROOT = path.resolve(__dirname, \"../..\");\n\n/** Event types to exclude from generation (internal/legacy types) */\nexport const EXCLUDED_EVENT_TYPES = new Set([\"session.import_legacy\"]);\n\nexport interface DefinitionCollections {\n definitions?: Record;\n $defs?: Record;\n}\n\nexport interface SessionEventEnvelopeProperty {\n name: string;\n schema: JSONSchema7;\n required: boolean;\n}\n\nexport interface JSONSchema7WithDefs extends JSONSchema7, DefinitionCollections {}\n\nexport type SchemaWithSharedDefinitions = T & {\n definitions: Record;\n $defs: Record;\n};\n// ── Schema paths ────────────────────────────────────────────────────────────\n\nexport async function getSessionEventsSchemaPath(): Promise {\n const schemaPath = path.join(\n REPO_ROOT,\n \"nodejs/node_modules/@github/copilot/schemas/session-events.schema.json\"\n );\n await fs.access(schemaPath);\n return schemaPath;\n}\n\nexport async function getApiSchemaPath(cliArg?: string): Promise {\n if (cliArg) return cliArg;\n const schemaPath = path.join(\n REPO_ROOT,\n \"nodejs/node_modules/@github/copilot/schemas/api.schema.json\"\n );\n await fs.access(schemaPath);\n return schemaPath;\n}\n\n// ── Schema processing ───────────────────────────────────────────────────────\n\n/**\n * Post-process JSON Schema for quicktype compatibility.\n * Converts boolean const values to enum.\n */\nexport function postProcessSchema(schema: JSONSchema7): JSONSchema7 {\n if (typeof schema !== \"object\" || schema === null) return schema;\n\n const processed = { ...schema } as JSONSchema7WithDefs;\n\n if (\"const\" in processed && typeof processed.const === \"boolean\") {\n processed.enum = [processed.const];\n delete processed.const;\n }\n\n if (processed.properties) {\n const newProps: Record = {};\n for (const [key, value] of Object.entries(processed.properties).sort(([a], [b]) => a.localeCompare(b))) {\n newProps[key] = typeof value === \"object\" ? postProcessSchema(value as JSONSchema7) : value;\n }\n processed.properties = newProps;\n }\n\n if (processed.items) {\n if (typeof processed.items === \"object\" && !Array.isArray(processed.items)) {\n processed.items = postProcessSchema(processed.items as JSONSchema7);\n } else if (Array.isArray(processed.items)) {\n processed.items = processed.items.map((item) =>\n typeof item === \"object\" ? postProcessSchema(item as JSONSchema7) : item\n ) as JSONSchema7Definition[];\n }\n }\n\n for (const combiner of [\"anyOf\", \"allOf\", \"oneOf\"] as const) {\n if (processed[combiner]) {\n processed[combiner] = processed[combiner]!.map((item) =>\n typeof item === \"object\" ? postProcessSchema(item as JSONSchema7) : item\n ) as JSONSchema7Definition[];\n }\n }\n\n const { definitions, $defs } = collectDefinitionCollections(processed as Record);\n let newDefs: Record | undefined;\n if (Object.keys(definitions).length > 0) {\n newDefs = {};\n for (const [key, value] of Object.entries(definitions)) {\n newDefs[key] = typeof value === \"object\" ? postProcessSchema(value as JSONSchema7) : value;\n }\n processed.definitions = newDefs;\n }\n let newDraftDefs: Record | undefined;\n if (Object.keys($defs).length > 0) {\n newDraftDefs = {};\n for (const [key, value] of Object.entries($defs)) {\n newDraftDefs[key] = typeof value === \"object\" ? postProcessSchema(value as JSONSchema7) : value;\n }\n processed.$defs = newDraftDefs;\n }\n if (processed.definitions && !processed.$defs) {\n processed.$defs = { ...(newDefs ?? processed.definitions) };\n } else if (processed.$defs && !processed.definitions) {\n processed.definitions = { ...processed.$defs };\n }\n\n if (typeof processed.additionalProperties === \"object\") {\n processed.additionalProperties = postProcessSchema(processed.additionalProperties as JSONSchema7);\n }\n\n return processed;\n}\n\n/**\n * Normalize schema defects where a required property with a `$ref` to an object type\n * has a description explicitly mentioning \"null\" as a valid value.\n *\n * In JSON Schema, `required` only means the key must be present — it doesn't prevent\n * the value from being null. Some schemas mark properties as required but describe them\n * as nullable (e.g., \"Currently selected agent, or null if using the default\").\n *\n * This function converts such properties from:\n * `{ \"$ref\": \"#/definitions/Foo\", \"description\": \"...null...\" }`\n * to:\n * `{ \"anyOf\": [{ \"$ref\": \"#/definitions/Foo\" }, { \"type\": \"null\" }], \"description\": \"...null...\" }`\n *\n * This makes all downstream codegen (Go, C#, Python/quicktype, TypeScript) correctly\n * emit nullable/optional types without per-language heuristics.\n */\nexport function normalizeNullableRequiredRefs(schema: JSONSchema7): JSONSchema7 {\n if (typeof schema !== \"object\" || schema === null) return schema;\n\n const processed = { ...schema };\n\n if (processed.properties && processed.required) {\n const requiredSet = new Set(processed.required);\n const newProps: Record = {};\n const newRequired = [...processed.required];\n\n for (const [key, value] of Object.entries(processed.properties)) {\n if (typeof value !== \"object\" || value === null) {\n newProps[key] = value;\n continue;\n }\n const prop = value as JSONSchema7;\n if (\n requiredSet.has(key) &&\n prop.$ref &&\n typeof prop.description === \"string\" &&\n /\\bnull\\b/i.test(prop.description)\n ) {\n // Convert to anyOf: [$ref, null] and remove from required\n const { $ref, ...rest } = prop;\n newProps[key] = {\n ...rest,\n anyOf: [{ $ref }, { type: \"null\" as const }],\n };\n const idx = newRequired.indexOf(key);\n if (idx !== -1) newRequired.splice(idx, 1);\n } else {\n newProps[key] = normalizeNullableRequiredRefs(prop);\n }\n }\n\n processed.properties = newProps;\n processed.required = newRequired;\n }\n\n // Recurse into nested schemas\n if (processed.items) {\n if (typeof processed.items === \"object\" && !Array.isArray(processed.items)) {\n processed.items = normalizeNullableRequiredRefs(processed.items as JSONSchema7);\n }\n }\n for (const combiner of [\"anyOf\", \"allOf\", \"oneOf\"] as const) {\n if (processed[combiner]) {\n processed[combiner] = processed[combiner]!.map((item) =>\n typeof item === \"object\" ? normalizeNullableRequiredRefs(item as JSONSchema7) : item\n ) as JSONSchema7Definition[];\n }\n }\n\n return processed;\n}\n\n// ── File output ─────────────────────────────────────────────────────────────\n\nexport async function writeGeneratedFile(relativePath: string, content: string): Promise {\n const fullPath = path.join(REPO_ROOT, relativePath);\n await fs.mkdir(path.dirname(fullPath), { recursive: true });\n await fs.writeFile(fullPath, content, \"utf-8\");\n return fullPath;\n}\n\n// ── RPC schema types ────────────────────────────────────────────────────────\n\nexport interface RpcMethod {\n rpcMethod: string;\n params: JSONSchema7 | null;\n result: JSONSchema7 | null;\n stability?: string;\n deprecated?: boolean;\n}\n\nexport function getRpcSchemaTypeName(schema: JSONSchema7 | null | undefined, fallback: string): string {\n if (typeof schema?.title === \"string\") return schema.title;\n return fallback;\n}\n\n/**\n * Returns true if the schema represents an object with properties (i.e., a type that should\n * be generated as a class/struct/dataclass). Returns false for enums, primitives, arrays,\n * and other non-object schemas.\n */\nexport function isObjectSchema(schema: JSONSchema7 | null | undefined): boolean {\n if (!schema) return false;\n if (schema.type === \"object\" && schema.properties) return true;\n return false;\n}\n\n/**\n * Returns true if the schema represents a void/null result (type: \"null\").\n * These carry a title for languages that need a named empty type (e.g., Go)\n * but should be treated as void in other languages.\n */\nexport function isVoidSchema(schema: JSONSchema7 | null | undefined): boolean {\n if (!schema) return true;\n return schema.type === \"null\";\n}\n\n/**\n * If the schema is a nullable anyOf (anyOf: [nullLike, T] or [T, nullLike]),\n * returns the non-null inner schema. Recognizes both `{ type: \"null\" }` and\n * `{ not: {} }` (zod-to-json-schema 2019-09 format for undefined).\n * Returns undefined if the schema is not a nullable wrapper.\n */\nexport function getNullableInner(schema: JSONSchema7): JSONSchema7 | undefined {\n if (!schema.anyOf || !Array.isArray(schema.anyOf) || schema.anyOf.length !== 2) return undefined;\n const [a, b] = schema.anyOf;\n if (isNullLike(a) && !isNullLike(b)) return b as JSONSchema7;\n if (isNullLike(b) && !isNullLike(a)) return a as JSONSchema7;\n return undefined;\n}\n\nfunction isNullLike(s: unknown): boolean {\n if (!s || typeof s !== \"object\") return false;\n const obj = s as Record;\n if (obj.type === \"null\") return true;\n if (\"not\" in obj && typeof obj.not === \"object\" && obj.not !== null && Object.keys(obj.not).length === 0) return true;\n return false;\n}\n\nexport function cloneSchemaForCodegen(value: T): T {\n if (Array.isArray(value)) {\n return value.map((item) => cloneSchemaForCodegen(item)) as T;\n }\n\n if (value && typeof value === \"object\") {\n const source = value as Record;\n const result: Record = {};\n\n for (const [key, child] of Object.entries(source)) {\n result[key] = cloneSchemaForCodegen(child);\n }\n\n return result as T;\n }\n\n return value;\n}\n\nexport interface ApiSchema {\n definitions?: Record;\n $defs?: Record;\n server?: Record;\n session?: Record;\n clientSession?: Record;\n}\n\nexport function isRpcMethod(node: unknown): node is RpcMethod {\n return typeof node === \"object\" && node !== null && \"rpcMethod\" in node;\n}\n\n/**\n * Apply `normalizeNullableRequiredRefs` to every JSON Schema reachable from the API schema\n * (method params, results, and shared definitions). Call after `cloneSchemaForCodegen` to\n * fix schema defects before any per-language codegen runs.\n */\nexport function fixNullableRequiredRefsInApiSchema(schema: ApiSchema): ApiSchema {\n function walkApiNode(node: Record | undefined): Record | undefined {\n if (!node) return undefined;\n const result: Record = {};\n for (const [key, value] of Object.entries(node)) {\n if (isRpcMethod(value)) {\n const method = value as RpcMethod;\n result[key] = {\n ...method,\n params: method.params ? normalizeNullableRequiredRefs(method.params) : method.params,\n result: method.result ? normalizeNullableRequiredRefs(method.result) : method.result,\n };\n } else if (typeof value === \"object\" && value !== null) {\n result[key] = walkApiNode(value as Record);\n } else {\n result[key] = value;\n }\n }\n return result;\n }\n\n function normalizeDefs(defs: Record | undefined): Record | undefined {\n if (!defs) return undefined;\n return Object.fromEntries(\n Object.entries(defs).map(([key, value]) => [\n key,\n typeof value === \"object\" && value !== null ? normalizeNullableRequiredRefs(value as JSONSchema7) : value,\n ])\n );\n }\n\n return {\n ...schema,\n definitions: normalizeDefs(schema.definitions),\n $defs: normalizeDefs(schema.$defs),\n server: walkApiNode(schema.server),\n session: walkApiNode(schema.session),\n clientSession: walkApiNode(schema.clientSession),\n };\n}\n\n/** Returns true when every leaf RPC method inside `node` is marked experimental. */\nexport function isNodeFullyExperimental(node: Record): boolean {\n const methods: RpcMethod[] = [];\n (function collect(n: Record) {\n for (const value of Object.values(n)) {\n if (isRpcMethod(value)) {\n methods.push(value);\n } else if (typeof value === \"object\" && value !== null) {\n collect(value as Record);\n }\n }\n })(node);\n return methods.length > 0 && methods.every(m => m.stability === \"experimental\");\n}\n\n/** Returns true when every leaf RPC method inside `node` is marked deprecated. */\nexport function isNodeFullyDeprecated(node: Record): boolean {\n const methods: RpcMethod[] = [];\n (function collect(n: Record) {\n for (const value of Object.values(n)) {\n if (isRpcMethod(value)) {\n methods.push(value);\n } else if (typeof value === \"object\" && value !== null) {\n collect(value as Record);\n }\n }\n })(node);\n return methods.length > 0 && methods.every(m => m.deprecated === true);\n}\n\n/** Returns true when a JSON Schema node is marked as deprecated. */\nexport function isSchemaDeprecated(schema: JSONSchema7 | null | undefined): boolean {\n return typeof schema === \"object\" && schema !== null && (schema as Record).deprecated === true;\n}\n\n// ── $ref resolution ─────────────────────────────────────────────────────────\n\n/** Extract the generated type name from a `$ref` path (e.g. \"#/definitions/Model\" → \"Model\"). */\nexport function refTypeName(ref: string, definitions?: DefinitionCollections): string {\n const baseName = ref.split(\"/\").pop()!;\n const match = ref.match(/^#\\/(definitions|\\$defs)\\/(.+)$/);\n if (!match || match[1] !== \"$defs\" || !definitions) return baseName;\n\n const key = match[2];\n const legacyDefinition = definitions.definitions?.[key];\n const draftDefinition = definitions.$defs?.[key];\n if (\n legacyDefinition !== undefined &&\n draftDefinition !== undefined &&\n stableStringify(legacyDefinition) !== stableStringify(draftDefinition)\n ) {\n return `Draft${baseName}`;\n }\n\n return baseName;\n}\n\n/** Resolve a `$ref` path against a definitions map, returning the referenced schema. */\nexport function resolveRef(\n ref: string,\n definitions: DefinitionCollections | undefined\n): JSONSchema7 | undefined {\n const match = ref.match(/^#\\/(definitions|\\$defs)\\/(.+)$/);\n if (!match || !definitions) return undefined;\n const [, namespace, key] = match;\n const primary = namespace === \"$defs\" ? definitions.$defs : definitions.definitions;\n const fallback = namespace === \"$defs\" ? definitions.definitions : definitions.$defs;\n const def = primary?.[key] ?? fallback?.[key];\n return typeof def === \"object\" ? (def as JSONSchema7) : undefined;\n}\n\nexport function resolveSchema(\n schema: JSONSchema7 | null | undefined,\n definitions: DefinitionCollections | undefined\n): JSONSchema7 | undefined {\n let current = schema ?? undefined;\n const seenRefs = new Set();\n while (current?.$ref) {\n if (seenRefs.has(current.$ref)) break;\n seenRefs.add(current.$ref);\n const resolved = resolveRef(current.$ref, definitions);\n if (!resolved) break;\n current = resolved;\n }\n return current;\n}\n\nexport function resolveObjectSchema(\n schema: JSONSchema7 | null | undefined,\n definitions: DefinitionCollections | undefined\n): JSONSchema7 | undefined {\n const resolved = resolveSchema(schema, definitions) ?? schema ?? undefined;\n if (!resolved) return undefined;\n if (resolved.properties || resolved.additionalProperties || resolved.type === \"object\") return resolved;\n\n if (resolved.allOf) {\n const mergedProperties: Record = {};\n const mergedRequired = new Set();\n const merged: JSONSchema7 = {\n type: \"object\",\n description: resolved.description,\n };\n let hasObjectShape = false;\n\n for (const item of resolved.allOf) {\n if (typeof item !== \"object\") continue;\n const objectSchema = resolveObjectSchema(item as JSONSchema7, definitions);\n if (!objectSchema) continue;\n\n if (objectSchema.properties) {\n Object.assign(mergedProperties, objectSchema.properties);\n hasObjectShape = true;\n }\n if (objectSchema.required) {\n for (const name of objectSchema.required) {\n mergedRequired.add(name);\n }\n }\n if (objectSchema.additionalProperties !== undefined) {\n merged.additionalProperties = objectSchema.additionalProperties;\n hasObjectShape = true;\n }\n if (!merged.description && objectSchema.description) {\n merged.description = objectSchema.description;\n }\n }\n\n if (!hasObjectShape) return resolved;\n if (Object.keys(mergedProperties).length > 0) {\n merged.properties = mergedProperties;\n }\n if (mergedRequired.size > 0) {\n merged.required = [...mergedRequired];\n }\n return merged;\n }\n\n const singleBranch = (resolved.anyOf ?? resolved.oneOf)\n ?.filter((item): item is JSONSchema7 => {\n if (!item || typeof item !== \"object\") return false;\n const s = item as JSONSchema7;\n // Filter out null types and `{ not: {} }` (Zod's representation of \"nothing\" in optional anyOf)\n if (s.type === \"null\") return false;\n if (s.not && typeof s.not === \"object\" && Object.keys(s.not).length === 0) return false;\n return true;\n });\n if (singleBranch && singleBranch.length === 1) {\n return resolveObjectSchema(singleBranch[0], definitions);\n }\n\n return resolved;\n}\n\nexport function getSessionEventVariantSchemas(\n schema: JSONSchema7,\n definitionCollections: DefinitionCollections = collectDefinitionCollections(schema as Record)\n): JSONSchema7[] {\n const sessionEvent =\n resolveSchema({ $ref: \"#/definitions/SessionEvent\" }, definitionCollections) ??\n resolveSchema({ $ref: \"#/$defs/SessionEvent\" }, definitionCollections);\n if (!sessionEvent?.anyOf) throw new Error(\"Schema must have SessionEvent definition with anyOf\");\n\n return (sessionEvent.anyOf as JSONSchema7[]).map((variant) => {\n const resolvedVariant =\n resolveObjectSchema(variant, definitionCollections) ??\n resolveSchema(variant, definitionCollections) ??\n variant;\n if (typeof resolvedVariant !== \"object\" || !resolvedVariant.properties) throw new Error(\"Invalid event variant\");\n return resolvedVariant;\n });\n}\n\nexport function getSharedSessionEventEnvelopeProperties(\n schema: JSONSchema7,\n definitionCollections: DefinitionCollections = collectDefinitionCollections(schema as Record)\n): SessionEventEnvelopeProperty[] {\n const variants = getSessionEventVariantSchemas(schema, definitionCollections);\n const firstVariant = variants[0];\n const firstProperties = firstVariant.properties ?? {};\n\n return Object.entries(firstProperties)\n .filter(([name]) => name !== \"type\" && name !== \"data\")\n .map(([name]) => {\n const propertySchemas = variants\n .map((variant) => variant.properties?.[name])\n .filter((propSchema): propSchema is JSONSchema7 => typeof propSchema === \"object\" && propSchema !== null);\n\n if (propertySchemas.length !== variants.length) return undefined;\n\n return {\n name,\n schema: selectSessionEventEnvelopePropertySchema(propertySchemas),\n required: variants.every((variant) => (variant.required ?? []).includes(name)),\n };\n })\n .filter((property): property is SessionEventEnvelopeProperty => property !== undefined);\n}\n\nfunction selectSessionEventEnvelopePropertySchema(propertySchemas: JSONSchema7[]): JSONSchema7 {\n // Some variants further constrain a shared envelope property, e.g. ephemeral const true.\n // Generate the base property from the least restrictive schema that has useful metadata.\n return (\n propertySchemas.find((schema) => !isConstOrEnumSchema(schema) && schema.description) ??\n propertySchemas.find((schema) => !isConstOrEnumSchema(schema)) ??\n propertySchemas.find((schema) => schema.description) ??\n propertySchemas[0]\n );\n}\n\nfunction isConstOrEnumSchema(schema: JSONSchema7): boolean {\n return \"const\" in schema || (Array.isArray(schema.enum) && schema.enum.length > 0);\n}\n\nexport function hasSchemaPayload(schema: JSONSchema7 | null | undefined): boolean {\n if (!schema) return false;\n if (schema.properties) return Object.keys(schema.properties).length > 0;\n if (schema.additionalProperties) return true;\n if (schema.items) return true;\n if (schema.anyOf || schema.oneOf || schema.allOf) return true;\n if (schema.enum && schema.enum.length > 0) return true;\n if (schema.const !== undefined) return true;\n if (schema.$ref) return true;\n if (Array.isArray(schema.type)) return schema.type.length > 0 && !(schema.type.length === 1 && schema.type[0] === \"object\");\n return schema.type !== undefined && schema.type !== \"object\";\n}\n\nexport function collectDefinitionCollections(\n schema: Record\n): Required {\n return {\n definitions: { ...((schema.definitions ?? {}) as Record) },\n $defs: { ...((schema.$defs ?? {}) as Record) },\n };\n}\n\n/** Collect the shared definitions from a schema (handles both `definitions` and `$defs`). */\nexport function collectDefinitions(\n schema: Record\n): Record {\n const { definitions, $defs } = collectDefinitionCollections(schema);\n return { ...$defs, ...definitions };\n}\n\nexport function withSharedDefinitions(\n schema: T,\n definitions: DefinitionCollections\n): SchemaWithSharedDefinitions {\n const legacyDefinitions = { ...(definitions.definitions ?? {}) };\n const draft2019Definitions = { ...(definitions.$defs ?? {}) };\n\n const sharedLegacyDefinitions =\n Object.keys(legacyDefinitions).length > 0 ? legacyDefinitions : { ...draft2019Definitions };\n const sharedDraftDefinitions =\n Object.keys(draft2019Definitions).length > 0 ? draft2019Definitions : { ...legacyDefinitions };\n\n return {\n ...schema,\n definitions: sharedLegacyDefinitions,\n $defs: sharedDraftDefinitions,\n };\n}\n" }, { "path": "scripts/corrections/.gitignore", "content": "node_modules/\n" }, { "path": "scripts/corrections/collect-corrections.js", "content": "// @ts-check\n\n/** @typedef {ReturnType} GitHub */\n/** @typedef {typeof import('@actions/github').context} Context */\n/** @typedef {{ number: number, body?: string | null, assignees?: Array<{login: string}> | null }} TrackingIssue */\n\nconst TRACKING_LABEL = \"triage-agent-tracking\";\nconst CCA_THRESHOLD = 10;\nconst MAX_TITLE_LENGTH = 50;\n\nconst TRACKING_ISSUE_BODY = `# Triage Agent Corrections\n\nThis issue tracks corrections to the triage agent system. When assigned to\nCopilot, analyze the corrections and generate an improvement PR.\n\n## Instructions for Copilot\n\nWhen assigned:\n1. Read each linked correction comment and the original issue for full context\n2. Identify patterns (e.g., the classifier frequently confuses X with Y)\n3. Determine which workflow file(s) need improvement\n4. Use the \\`agentic-workflows\\` agent in this repo for guidance on workflow syntax and conventions\n5. Open a PR with targeted changes to the relevant \\`.md\\` workflow files in \\`.github/workflows/\\`\n6. **If you changed the YAML frontmatter** (between the \\`---\\` markers) of any workflow, run \\`gh aw compile\\` and commit the updated \\`.lock.yml\\` files. Changes to the markdown body (instructions) do NOT require recompilation.\n7. Reference this issue in the PR description using \\`Closes #\\`\n8. Include a summary of which corrections motivated each change\n\n## Corrections\n\n| Issue | Feedback | Submitted by | Date |\n|-------|----------|--------------|------|\n`;\n\n/**\n * Truncates a title to the maximum length, adding ellipsis if needed.\n * @param {string} title\n * @returns {string}\n */\nfunction truncateTitle(title) {\n if (title.length <= MAX_TITLE_LENGTH) return title;\n return title.substring(0, MAX_TITLE_LENGTH - 3).trimEnd() + \"...\";\n}\n\n/**\n * Sanitizes text for use inside a markdown table cell by normalizing\n * newlines, collapsing whitespace, and trimming.\n * @param {string} text\n * @returns {string}\n */\nfunction sanitizeText(text) {\n return text\n .replace(/\\r\\n|\\r|\\n/g, \" \")\n .replace(//gi, \" \")\n .replace(/\\s+/g, \" \")\n .trim();\n}\n\n/**\n * Escapes backslash and pipe characters so they don't break markdown table columns.\n * @param {string} text\n * @returns {string}\n */\nfunction escapeForTable(text) {\n return text.replace(/\\\\/g, \"\\\\\\\\\").replace(/\\|/g, \"\\\\|\");\n}\n\n/**\n * Resolves the feedback context from either a slash command or manual CLI dispatch.\n * @param {any} payload\n * @param {string} sender\n * @returns {{ issueNumber: number, feedback: string, sender: string }}\n */\nfunction resolveContext(payload, sender) {\n const issueNumber =\n payload.command?.resource?.number ?? payload.issue_number;\n const feedback = payload.data?.Feedback ?? payload.feedback;\n\n if (!issueNumber) {\n throw new Error(\"Missing issue_number in payload\");\n }\n if (!feedback) {\n throw new Error(\"Missing feedback in payload\");\n }\n\n const parsed = Number(issueNumber);\n if (!Number.isFinite(parsed) || parsed < 1 || !Number.isInteger(parsed)) {\n throw new Error(`Invalid issue_number: ${issueNumber}`);\n }\n\n return { issueNumber: parsed, feedback, sender };\n}\n\n/**\n * Finds an open tracking issue with no assignees, or creates a new one.\n * @param {GitHub} github - Octokit instance\n * @param {string} owner\n * @param {string} repo\n */\nasync function findOrCreateTrackingIssue(github, owner, repo) {\n const { data: issues } = await github.rest.issues.listForRepo({\n owner,\n repo,\n labels: TRACKING_LABEL,\n state: \"open\",\n });\n\n const available = issues.find((issue) => (issue.assignees ?? []).length === 0);\n\n if (available) {\n console.log(`Found existing tracking issue #${available.number}`);\n return available;\n }\n\n console.log(\"No available tracking issue found, creating one...\");\n const { data: created } = await github.rest.issues.create({\n owner,\n repo,\n title: \"Triage Agent Corrections\",\n labels: [TRACKING_LABEL],\n body: TRACKING_ISSUE_BODY,\n });\n console.log(`Created tracking issue #${created.number}`);\n return created;\n}\n\n/**\n * Appends a correction row to the tracking issue's markdown table.\n * Returns the new correction count.\n * @param {GitHub} github - Octokit instance\n * @param {string} owner\n * @param {string} repo\n * @param {TrackingIssue} trackingIssue\n * @param {{ issueNumber: number, feedback: string, sender: string }} correction\n * @returns {Promise}\n */\nasync function appendCorrection(github, owner, repo, trackingIssue, correction) {\n const { issueNumber, feedback, sender } = correction;\n\n const { data: issue } = await github.rest.issues.get({\n owner,\n repo,\n issue_number: issueNumber,\n });\n\n const body = trackingIssue.body || \"\";\n const tableHeader = \"|-------|----------|--------------|------|\";\n const tableStart = body.indexOf(tableHeader);\n const existingRows =\n tableStart === -1\n ? 0\n : body\n .slice(tableStart)\n .split(\"\\n\")\n .filter((line) => line.startsWith(\"| \")).length;\n const correctionCount = existingRows + 1;\n const today = new Date().toISOString().split(\"T\")[0];\n\n const cleanTitle = sanitizeText(issue.title);\n const displayTitle = escapeForTable(truncateTitle(cleanTitle));\n const safeFeedback = escapeForTable(sanitizeText(feedback));\n\n const issueUrl = `https://github.com/${owner}/${repo}/issues/${issueNumber}`;\n const newRow = `| [#${issueNumber}] ${displayTitle} | ${safeFeedback} | @${sender} | ${today} |`;\n const updatedBody = body.trimEnd() + \"\\n\" + newRow + \"\\n\";\n\n await github.rest.issues.update({\n owner,\n repo,\n issue_number: trackingIssue.number,\n body: updatedBody,\n });\n\n console.log(\n `Appended correction #${correctionCount} to tracking issue #${trackingIssue.number}`,\n );\n return correctionCount;\n}\n\n/**\n * Auto-assigns CCA if the correction threshold is reached.\n * @param {GitHub} github - Octokit instance\n * @param {string} owner\n * @param {string} repo\n * @param {TrackingIssue} trackingIssue\n * @param {number} correctionCount\n */\nasync function maybeAssignCCA(github, owner, repo, trackingIssue, correctionCount) {\n if (correctionCount >= CCA_THRESHOLD) {\n console.log(\n `Threshold reached (${correctionCount} >= ${CCA_THRESHOLD}). Assigning CCA...`,\n );\n await github.rest.issues.addAssignees({\n owner,\n repo,\n issue_number: trackingIssue.number,\n assignees: [\"copilot\"],\n });\n } else {\n console.log(\n `Threshold not reached (${correctionCount}/${CCA_THRESHOLD}) or CCA already assigned.`,\n );\n }\n}\n\n/**\n * Main entrypoint for actions/github-script.\n * @param {{ github: GitHub, context: Context }} params\n */\nmodule.exports = async ({ github, context }) => {\n const { owner, repo } = context.repo;\n const payload = context.payload.client_payload ?? context.payload.inputs ?? {};\n const sender = context.payload.sender?.login ?? \"unknown\";\n\n const correction = resolveContext(payload, sender);\n console.log(\n `Processing feedback for issue #${correction.issueNumber} from @${correction.sender}`,\n );\n\n const trackingIssue = await findOrCreateTrackingIssue(github, owner, repo);\n const correctionCount = await appendCorrection(\n github,\n owner,\n repo,\n trackingIssue,\n correction,\n );\n await maybeAssignCCA(github, owner, repo, trackingIssue, correctionCount);\n};\n\n// Export internals for testing\nmodule.exports.truncateTitle = truncateTitle;\nmodule.exports.sanitizeText = sanitizeText;\nmodule.exports.escapeForTable = escapeForTable;\nmodule.exports.resolveContext = resolveContext;\nmodule.exports.findOrCreateTrackingIssue = findOrCreateTrackingIssue;\nmodule.exports.appendCorrection = appendCorrection;\nmodule.exports.maybeAssignCCA = maybeAssignCCA;\n" }, { "path": "scripts/corrections/package.json", "content": "{\n \"name\": \"triage-agent-scripts\",\n \"private\": true,\n \"scripts\": {\n \"test\": \"vitest run\",\n \"test:watch\": \"vitest\"\n },\n \"devDependencies\": {\n \"@actions/github\": \"^9.0.0\",\n \"@octokit/rest\": \"^22.0.1\",\n \"@types/node\": \"^22.0.0\",\n \"typescript\": \"^5.8.0\",\n \"vitest\": \"^3.1.0\"\n }\n}\n" }, { "path": "scripts/corrections/test/collect-corrections.test.ts", "content": "import { describe, expect, it, vi } from \"vitest\";\n\nconst mod = await import(\"../collect-corrections.js\");\nconst {\n truncateTitle,\n sanitizeText,\n escapeForTable,\n resolveContext,\n findOrCreateTrackingIssue,\n appendCorrection,\n maybeAssignCCA,\n} = mod;\n\n// ---------------------------------------------------------------------------\n// Pure functions\n// ---------------------------------------------------------------------------\n\ndescribe(\"truncateTitle\", () => {\n it(\"returns short titles unchanged\", () => {\n expect(truncateTitle(\"Short title\")).toBe(\"Short title\");\n });\n\n it(\"returns titles at exactly the max length unchanged\", () => {\n const title = \"a\".repeat(50);\n expect(truncateTitle(title)).toBe(title);\n });\n\n it(\"truncates long titles with ellipsis\", () => {\n const title = \"a\".repeat(60);\n const result = truncateTitle(title);\n expect(result.length).toBeLessThanOrEqual(50);\n expect(result).toMatch(/\\.\\.\\.$/);\n });\n\n it(\"trims trailing whitespace before ellipsis\", () => {\n const title = \"a\".repeat(44) + \" \" + \"b\".repeat(10);\n const result = truncateTitle(title);\n expect(result).not.toMatch(/\\s\\.\\.\\.$/);\n expect(result).toMatch(/\\.\\.\\.$/);\n });\n});\n\ndescribe(\"sanitizeText\", () => {\n it(\"collapses newlines into spaces\", () => {\n expect(sanitizeText(\"line1\\nline2\\r\\nline3\\rline4\")).toBe(\n \"line1 line2 line3 line4\",\n );\n });\n\n it(\"replaces
tags with spaces\", () => {\n expect(sanitizeText(\"hello
world
there\")).toBe(\n \"hello world there\",\n );\n });\n\n it(\"collapses multiple spaces\", () => {\n expect(sanitizeText(\"too many spaces\")).toBe(\"too many spaces\");\n });\n\n it(\"trims leading and trailing whitespace\", () => {\n expect(sanitizeText(\" padded \")).toBe(\"padded\");\n });\n\n it(\"handles empty string\", () => {\n expect(sanitizeText(\"\")).toBe(\"\");\n });\n});\n\ndescribe(\"escapeForTable\", () => {\n it(\"escapes pipe characters\", () => {\n expect(escapeForTable(\"a | b\")).toBe(\"a \\\\| b\");\n });\n\n it(\"escapes backslashes\", () => {\n expect(escapeForTable(\"path\\\\to\\\\file\")).toBe(\"path\\\\\\\\to\\\\\\\\file\");\n });\n\n it(\"escapes both pipes and backslashes\", () => {\n expect(escapeForTable(\"a\\\\|b\")).toBe(\"a\\\\\\\\\\\\|b\");\n });\n\n it(\"returns clean text unchanged\", () => {\n expect(escapeForTable(\"no special chars\")).toBe(\"no special chars\");\n });\n});\n\ndescribe(\"resolveContext\", () => {\n it(\"resolves from slash command payload\", () => {\n const payload = {\n command: { resource: { number: 42 } },\n data: { Feedback: \"Wrong label\" },\n };\n const result = resolveContext(payload, \"testuser\");\n expect(result).toEqual({\n issueNumber: 42,\n feedback: \"Wrong label\",\n sender: \"testuser\",\n });\n });\n\n it(\"resolves from manual dispatch payload\", () => {\n const payload = {\n issue_number: \"7\",\n feedback: \"Should be enhancement\",\n };\n const result = resolveContext(payload, \"admin\");\n expect(result).toEqual({\n issueNumber: 7,\n feedback: \"Should be enhancement\",\n sender: \"admin\",\n });\n });\n\n it(\"prefers slash command fields over dispatch fields\", () => {\n const payload = {\n command: { resource: { number: 10 } },\n data: { Feedback: \"From slash\" },\n issue_number: \"99\",\n feedback: \"From dispatch\",\n };\n const result = resolveContext(payload, \"user\");\n expect(result.issueNumber).toBe(10);\n expect(result.feedback).toBe(\"From slash\");\n });\n\n it(\"throws on missing issue number\", () => {\n expect(() => resolveContext({ feedback: \"oops\" }, \"u\")).toThrow(\n \"Missing issue_number\",\n );\n });\n\n it(\"throws on missing feedback\", () => {\n expect(() =>\n resolveContext({ issue_number: \"1\" }, \"u\"),\n ).toThrow(\"Missing feedback\");\n });\n\n it(\"throws on non-numeric issue number\", () => {\n expect(() =>\n resolveContext({ issue_number: \"abc\", feedback: \"test\" }, \"u\"),\n ).toThrow(\"Invalid issue_number: abc\");\n });\n\n it(\"throws on negative issue number\", () => {\n expect(() =>\n resolveContext({ issue_number: \"-1\", feedback: \"test\" }, \"u\"),\n ).toThrow(\"Invalid issue_number: -1\");\n });\n\n it(\"throws on decimal issue number\", () => {\n expect(() =>\n resolveContext({ issue_number: \"1.5\", feedback: \"test\" }, \"u\"),\n ).toThrow(\"Invalid issue_number: 1.5\");\n });\n});\n\n// ---------------------------------------------------------------------------\n// Octokit-dependent functions\n// ---------------------------------------------------------------------------\n\nfunction mockGitHub(overrides: Record = {}) {\n return {\n rest: {\n issues: {\n listForRepo: vi.fn().mockResolvedValue({ data: [] }),\n create: vi.fn().mockResolvedValue({\n data: { number: 100, body: \"\" },\n }),\n get: vi.fn().mockResolvedValue({\n data: { title: \"Test issue title\", number: 1 },\n }),\n update: vi.fn().mockResolvedValue({}),\n addAssignees: vi.fn().mockResolvedValue({}),\n ...overrides,\n },\n },\n } as any;\n}\n\nconst OWNER = \"test-owner\";\nconst REPO = \"test-repo\";\n\ndescribe(\"findOrCreateTrackingIssue\", () => {\n it(\"returns existing unassigned tracking issue\", async () => {\n const existing = { number: 5, assignees: [], body: \"...\" };\n const github = mockGitHub({\n listForRepo: vi.fn().mockResolvedValue({ data: [existing] }),\n });\n\n const result = await findOrCreateTrackingIssue(github, OWNER, REPO);\n expect(result).toBe(existing);\n expect(github.rest.issues.create).not.toHaveBeenCalled();\n });\n\n it(\"skips issues with assignees and creates a new one\", async () => {\n const assigned = {\n number: 5,\n assignees: [{ login: \"copilot\" }],\n body: \"...\",\n };\n const github = mockGitHub({\n listForRepo: vi.fn().mockResolvedValue({ data: [assigned] }),\n });\n\n const result = await findOrCreateTrackingIssue(github, OWNER, REPO);\n expect(result.number).toBe(100); // from create mock\n expect(github.rest.issues.create).toHaveBeenCalledWith(\n expect.objectContaining({\n owner: OWNER,\n repo: REPO,\n title: \"Triage Agent Corrections\",\n }),\n );\n });\n\n it(\"creates a new issue when none exist\", async () => {\n const github = mockGitHub();\n\n const result = await findOrCreateTrackingIssue(github, OWNER, REPO);\n expect(result.number).toBe(100);\n expect(github.rest.issues.create).toHaveBeenCalled();\n });\n});\n\ndescribe(\"appendCorrection\", () => {\n const trackingBody = [\n \"# Triage Agent Corrections\",\n \"\",\n \"| Issue | Feedback | Submitted by | Date |\",\n \"|-------|----------|--------------|------|\",\n \"\",\n ].join(\"\\n\");\n\n it(\"appends a row and returns correction count of 1\", async () => {\n const github = mockGitHub();\n const trackingIssue = { number: 10, body: trackingBody } as any;\n const correction = {\n issueNumber: 3,\n feedback: \"Wrong label\",\n sender: \"alice\",\n };\n\n const count = await appendCorrection(\n github,\n OWNER,\n REPO,\n trackingIssue,\n correction,\n );\n\n expect(count).toBe(1);\n expect(github.rest.issues.update).toHaveBeenCalledWith(\n expect.objectContaining({\n issue_number: 10,\n body: expect.stringContaining(\"[#3]\"),\n }),\n );\n });\n\n it(\"counts existing rows correctly\", async () => {\n const bodyWithRows =\n trackingBody.trimEnd() +\n \"\\n| [#1] Title | feedback | @bob | 2026-01-01 |\\n\";\n const github = mockGitHub();\n const trackingIssue = { number: 10, body: bodyWithRows } as any;\n const correction = {\n issueNumber: 2,\n feedback: \"Also wrong\",\n sender: \"carol\",\n };\n\n const count = await appendCorrection(\n github,\n OWNER,\n REPO,\n trackingIssue,\n correction,\n );\n\n expect(count).toBe(2);\n });\n\n it(\"handles empty tracking issue body\", async () => {\n const github = mockGitHub();\n const trackingIssue = { number: 10, body: \"\" } as any;\n const correction = {\n issueNumber: 1,\n feedback: \"test\",\n sender: \"user\",\n };\n\n const count = await appendCorrection(\n github,\n OWNER,\n REPO,\n trackingIssue,\n correction,\n );\n\n // No table header found → 0 existing rows + 1\n expect(count).toBe(1);\n });\n\n it(\"sanitizes and escapes feedback in the row\", async () => {\n const github = mockGitHub();\n const trackingIssue = { number: 10, body: trackingBody } as any;\n const correction = {\n issueNumber: 1,\n feedback: \"has | pipe\\nand newline\",\n sender: \"user\",\n };\n\n await appendCorrection(github, OWNER, REPO, trackingIssue, correction);\n\n const updatedBody =\n github.rest.issues.update.mock.calls[0][0].body as string;\n expect(updatedBody).toContain(\"has \\\\| pipe and newline\");\n // Verify the feedback cell doesn't contain raw newlines\n const rows = updatedBody.split(\"\\n\").filter((l) => l.startsWith(\"| {\n it(\"processes feedback from workflow_dispatch inputs\", async () => {\n const github = mockGitHub({\n listForRepo: vi.fn().mockResolvedValue({\n data: [{ number: 50, assignees: [], body: trackingBodyForEntrypoint }],\n }),\n });\n const context = {\n repo: { owner: OWNER, repo: REPO },\n payload: {\n // workflow_dispatch has no client_payload; inputs carry the data\n inputs: { issue_number: \"7\", feedback: \"Should be enhancement\" },\n sender: { login: \"dispatcher\" },\n },\n };\n\n await mod.default({ github, context });\n\n // Verify the correction was appended referencing the right issue\n expect(github.rest.issues.update).toHaveBeenCalledWith(\n expect.objectContaining({\n issue_number: 50,\n body: expect.stringContaining(\"[#7]\"),\n }),\n );\n });\n});\n\nconst trackingBodyForEntrypoint = [\n \"# Triage Agent Corrections\",\n \"\",\n \"| Issue | Feedback | Submitted by | Date |\",\n \"|-------|----------|--------------|------|\",\n \"\",\n].join(\"\\n\");\n\ndescribe(\"maybeAssignCCA\", () => {\n it(\"assigns CCA when threshold is reached\", async () => {\n const github = mockGitHub();\n const trackingIssue = { number: 10 } as any;\n\n await maybeAssignCCA(github, OWNER, REPO, trackingIssue, 10);\n\n expect(github.rest.issues.addAssignees).toHaveBeenCalledWith({\n owner: OWNER,\n repo: REPO,\n issue_number: 10,\n assignees: [\"copilot\"],\n });\n });\n\n it(\"assigns CCA when threshold is exceeded\", async () => {\n const github = mockGitHub();\n const trackingIssue = { number: 10 } as any;\n\n await maybeAssignCCA(github, OWNER, REPO, trackingIssue, 15);\n\n expect(github.rest.issues.addAssignees).toHaveBeenCalled();\n });\n\n it(\"does not assign CCA below threshold\", async () => {\n const github = mockGitHub();\n const trackingIssue = { number: 10 } as any;\n\n await maybeAssignCCA(github, OWNER, REPO, trackingIssue, 9);\n\n expect(github.rest.issues.addAssignees).not.toHaveBeenCalled();\n });\n});\n" }, { "path": "scripts/corrections/tsconfig.json", "content": "{\n \"compilerOptions\": {\n \"target\": \"ES2022\",\n \"module\": \"ESNext\",\n \"moduleResolution\": \"bundler\",\n \"strict\": true,\n \"esModuleInterop\": true,\n \"skipLibCheck\": true,\n \"allowJs\": true,\n \"noEmit\": true\n },\n \"include\": [\"test/**/*.ts\", \"*.js\"]\n}\n" }, { "path": "scripts/docs-validation/.gitignore", "content": "node_modules/\n" }, { "path": "scripts/docs-validation/extract.ts", "content": "/**\n * Extracts code blocks from markdown documentation files.\n * Outputs individual files for validation by language-specific tools.\n */\n\nimport * as fs from \"fs\";\nimport * as path from \"path\";\nimport { glob } from \"glob\";\n\nconst DOCS_DIR = path.resolve(import.meta.dirname, \"../../docs\");\nconst OUTPUT_DIR = path.resolve(import.meta.dirname, \"../../docs/.validation\");\n\n// Map markdown language tags to our canonical names\nconst LANGUAGE_MAP: Record = {\n typescript: \"typescript\",\n ts: \"typescript\",\n javascript: \"typescript\", // Treat JS as TS for validation\n js: \"typescript\",\n python: \"python\",\n py: \"python\",\n go: \"go\",\n golang: \"go\",\n csharp: \"csharp\",\n \"c#\": \"csharp\",\n cs: \"csharp\",\n};\n\ninterface CodeBlock {\n language: string;\n code: string;\n file: string;\n line: number;\n skip: boolean;\n hidden: boolean;\n wrapAsync: boolean;\n}\n\ninterface ExtractionManifest {\n extractedAt: string;\n blocks: {\n id: string;\n sourceFile: string;\n sourceLine: number;\n language: string;\n outputFile: string;\n }[];\n}\n\nfunction parseMarkdownCodeBlocks(\n content: string,\n filePath: string\n): CodeBlock[] {\n const blocks: CodeBlock[] = [];\n const lines = content.split(\"\\n\");\n\n let inCodeBlock = false;\n let currentLang = \"\";\n let currentCode: string[] = [];\n let blockStartLine = 0;\n let skipNext = false;\n let wrapAsync = false;\n let inHiddenBlock = false;\n\n for (let i = 0; i < lines.length; i++) {\n const line = lines[i];\n\n // Check for validation directives\n if (line.includes(\"\")) {\n skipNext = true;\n continue;\n }\n if (line.includes(\"\")) {\n wrapAsync = true;\n continue;\n }\n if (line.includes(\"\")) {\n inHiddenBlock = true;\n continue;\n }\n if (line.includes(\"\")) {\n inHiddenBlock = false;\n // Skip the next visible code block since the hidden one replaces it\n skipNext = true;\n continue;\n }\n\n // Start of code block\n if (!inCodeBlock && line.startsWith(\"```\")) {\n const lang = line.slice(3).trim().toLowerCase();\n if (lang && LANGUAGE_MAP[lang]) {\n inCodeBlock = true;\n currentLang = LANGUAGE_MAP[lang];\n currentCode = [];\n blockStartLine = i + 1; // 1-indexed line number\n }\n continue;\n }\n\n // End of code block\n if (inCodeBlock && line.startsWith(\"```\")) {\n blocks.push({\n language: currentLang,\n code: currentCode.join(\"\\n\"),\n file: filePath,\n line: blockStartLine,\n skip: skipNext,\n hidden: inHiddenBlock,\n wrapAsync: wrapAsync,\n });\n inCodeBlock = false;\n currentLang = \"\";\n currentCode = [];\n // Only reset skipNext when NOT in a hidden block — hidden blocks\n // can contain multiple code fences that all get validated.\n if (!inHiddenBlock) {\n skipNext = false;\n }\n wrapAsync = false;\n continue;\n }\n\n // Inside code block\n if (inCodeBlock) {\n currentCode.push(line);\n }\n }\n\n return blocks;\n}\n\nfunction generateFileName(\n block: CodeBlock,\n index: number,\n langCounts: Map\n): string {\n const count = langCounts.get(block.language) || 0;\n langCounts.set(block.language, count + 1);\n\n const sourceBasename = path.basename(block.file, \".md\");\n const ext = getExtension(block.language);\n\n return `${sourceBasename}_${count}${ext}`;\n}\n\nfunction getExtension(language: string): string {\n switch (language) {\n case \"typescript\":\n return \".ts\";\n case \"python\":\n return \".py\";\n case \"go\":\n return \".go\";\n case \"csharp\":\n return \".cs\";\n default:\n return \".txt\";\n }\n}\n\n/**\n * Detect code fragments that can't be validated as standalone files.\n * These are typically partial snippets showing configuration options\n * or code that's meant to be part of a larger context.\n */\nfunction shouldSkipFragment(block: CodeBlock): boolean {\n const code = block.code.trim();\n\n // TypeScript/JavaScript: Skip bare object literals (config snippets)\n if (block.language === \"typescript\") {\n // Starts with property: value pattern (e.g., \"provider: {\")\n if (/^[a-zA-Z_]+\\s*:\\s*[\\{\\[]/.test(code)) {\n return true;\n }\n // Starts with just an object/array that's not assigned\n if (/^\\{[\\s\\S]*\\}$/.test(code) && !code.includes(\"import \") && !code.includes(\"export \")) {\n return true;\n }\n }\n\n // Go: Skip fragments that are just type definitions without package\n if (block.language === \"go\") {\n // Function signatures without bodies (interface definitions shown in docs)\n if (/^func\\s+\\w+\\([^)]*\\)\\s*\\([^)]*\\)\\s*$/.test(code)) {\n return true;\n }\n }\n\n return false;\n}\n\nfunction wrapCodeForValidation(block: CodeBlock): string {\n let code = block.code;\n\n // Python: auto-detect async code and wrap if needed\n if (block.language === \"python\") {\n const hasAwait = /\\bawait\\b/.test(code);\n const hasAsyncDef = /\\basync\\s+def\\b/.test(code);\n\n // Check if await is used outside of any async def\n // Simple heuristic: if await appears at column 0 or after assignment at column 0\n const lines = code.split(\"\\n\");\n let awaitOutsideFunction = false;\n let inAsyncFunction = false;\n let indentLevel = 0;\n\n for (const line of lines) {\n const trimmed = line.trimStart();\n const leadingSpaces = line.length - trimmed.length;\n\n // Track if we're in an async function\n if (trimmed.startsWith(\"async def \")) {\n inAsyncFunction = true;\n indentLevel = leadingSpaces;\n } else if (inAsyncFunction && leadingSpaces <= indentLevel && trimmed && !trimmed.startsWith(\"#\")) {\n // Dedented back, we're out of the function\n inAsyncFunction = false;\n }\n\n // Check for await outside function\n if (trimmed.includes(\"await \") && !inAsyncFunction) {\n awaitOutsideFunction = true;\n break;\n }\n }\n\n const needsWrap = block.wrapAsync || awaitOutsideFunction || (hasAwait && !hasAsyncDef);\n\n if (needsWrap) {\n const indented = code\n .split(\"\\n\")\n .map((l) => \" \" + l)\n .join(\"\\n\");\n code = `import asyncio\\n\\nasync def main():\\n${indented}\\n\\nasyncio.run(main())`;\n }\n }\n\n // Go: ensure package declaration\n if (block.language === \"go\" && !code.includes(\"package \")) {\n code = `package main\\n\\n${code}`;\n }\n\n // Go: add main function if missing and has statements outside functions\n if (block.language === \"go\" && !code.includes(\"func main()\")) {\n // Check if code has statements that need to be in main\n const hasStatements = /^[a-z]/.test(code.trim().split(\"\\n\").pop() || \"\");\n if (hasStatements) {\n // This is a snippet, wrap it\n const lines = code.split(\"\\n\");\n const packageLine = lines.find((l) => l.startsWith(\"package \")) || \"\";\n const imports = lines.filter(\n (l) => l.startsWith(\"import \") || l.startsWith('import (')\n );\n const rest = lines.filter(\n (l) =>\n !l.startsWith(\"package \") &&\n !l.startsWith(\"import \") &&\n !l.startsWith(\"import (\") &&\n !l.startsWith(\")\") &&\n !l.startsWith(\"\\t\") // import block lines\n );\n\n // Only wrap if there are loose statements (not type/func definitions)\n const hasLooseStatements = rest.some(\n (l) =>\n l.trim() &&\n !l.startsWith(\"type \") &&\n !l.startsWith(\"func \") &&\n !l.startsWith(\"//\") &&\n !l.startsWith(\"var \") &&\n !l.startsWith(\"const \")\n );\n\n if (!hasLooseStatements) {\n // Code has proper structure, just ensure it has a main\n code = code + \"\\n\\nfunc main() {}\";\n }\n }\n }\n\n // C#: wrap in a class to avoid top-level statements conflicts\n // (C# only allows one file with top-level statements per project)\n if (block.language === \"csharp\") {\n // Check if it's a complete file (has namespace or class)\n const hasStructure =\n code.includes(\"namespace \") ||\n code.includes(\"class \") ||\n code.includes(\"record \") ||\n code.includes(\"public delegate \");\n\n if (!hasStructure) {\n // Extract any existing using statements\n const lines = code.split(\"\\n\");\n const usings: string[] = [];\n const rest: string[] = [];\n\n for (const line of lines) {\n if (line.trim().startsWith(\"using \") && line.trim().endsWith(\";\")) {\n usings.push(line);\n } else {\n rest.push(line);\n }\n }\n\n // Always ensure SDK using is present\n if (!usings.some(u => u.includes(\"GitHub.Copilot.SDK\"))) {\n usings.push(\"using GitHub.Copilot.SDK;\");\n }\n\n // Generate a unique class name based on block location\n const className = `ValidationClass_${block.file.replace(/[^a-zA-Z0-9]/g, \"_\")}_${block.line}`;\n\n // Wrap in async method to support await\n const hasAwait = code.includes(\"await \");\n const indentedCode = rest.map(l => \" \" + l).join(\"\\n\");\n\n if (hasAwait) {\n code = `${usings.join(\"\\n\")}\n\npublic static class ${className}\n{\n public static async Task Main()\n {\n${indentedCode}\n }\n}`;\n } else {\n code = `${usings.join(\"\\n\")}\n\npublic static class ${className}\n{\n public static void Main()\n {\n${indentedCode}\n }\n}`;\n }\n } else {\n // Has structure, but may still need using directive\n if (!code.includes(\"using GitHub.Copilot.SDK;\")) {\n code = \"using GitHub.Copilot.SDK;\\n\" + code;\n }\n }\n }\n\n return code;\n}\n\nasync function main() {\n console.log(\"📖 Extracting code blocks from documentation...\\n\");\n\n // Clean output directory\n if (fs.existsSync(OUTPUT_DIR)) {\n fs.rmSync(OUTPUT_DIR, { recursive: true });\n }\n fs.mkdirSync(OUTPUT_DIR, { recursive: true });\n\n // Create language subdirectories\n for (const lang of [\"typescript\", \"python\", \"go\", \"csharp\"]) {\n fs.mkdirSync(path.join(OUTPUT_DIR, lang), { recursive: true });\n }\n\n // Find all markdown files\n const mdFiles = await glob(\"**/*.md\", {\n cwd: DOCS_DIR,\n ignore: [\".validation/**\", \"node_modules/**\", \"IMPROVEMENT_PLAN.md\"],\n });\n\n console.log(`Found ${mdFiles.length} markdown files\\n`);\n\n const manifest: ExtractionManifest = {\n extractedAt: new Date().toISOString(),\n blocks: [],\n };\n\n const langCounts = new Map();\n let totalBlocks = 0;\n let skippedBlocks = 0;\n let hiddenBlocks = 0;\n\n for (const mdFile of mdFiles) {\n const fullPath = path.join(DOCS_DIR, mdFile);\n const content = fs.readFileSync(fullPath, \"utf-8\");\n const blocks = parseMarkdownCodeBlocks(content, mdFile);\n\n for (const block of blocks) {\n if (block.skip) {\n skippedBlocks++;\n continue;\n }\n\n if (block.hidden) {\n hiddenBlocks++;\n }\n\n // Skip empty or trivial blocks\n if (block.code.trim().length < 10) {\n continue;\n }\n\n // Skip incomplete code fragments that can't be validated standalone\n if (shouldSkipFragment(block)) {\n skippedBlocks++;\n continue;\n }\n\n const fileName = generateFileName(block, totalBlocks, langCounts);\n const outputPath = path.join(OUTPUT_DIR, block.language, fileName);\n\n const wrappedCode = wrapCodeForValidation(block);\n\n // Add source location comment\n const sourceComment = getSourceComment(\n block.language,\n block.file,\n block.line\n );\n const finalCode = sourceComment + \"\\n\" + wrappedCode;\n\n fs.writeFileSync(outputPath, finalCode);\n\n manifest.blocks.push({\n id: `${block.language}/${fileName}`,\n sourceFile: block.file,\n sourceLine: block.line,\n language: block.language,\n outputFile: `${block.language}/${fileName}`,\n });\n\n totalBlocks++;\n }\n }\n\n // Write manifest\n fs.writeFileSync(\n path.join(OUTPUT_DIR, \"manifest.json\"),\n JSON.stringify(manifest, null, 2)\n );\n\n // Summary\n console.log(\"Extraction complete!\\n\");\n console.log(\" Language Count\");\n console.log(\" ─────────────────────\");\n for (const [lang, count] of langCounts) {\n console.log(` ${lang.padEnd(14)} ${count}`);\n }\n console.log(\" ─────────────────────\");\n console.log(` Total ${totalBlocks}`);\n if (skippedBlocks > 0) {\n console.log(` Skipped ${skippedBlocks}`);\n }\n if (hiddenBlocks > 0) {\n console.log(` Hidden ${hiddenBlocks}`);\n }\n console.log(`\\nOutput: ${OUTPUT_DIR}`);\n}\n\nfunction getSourceComment(\n language: string,\n file: string,\n line: number\n): string {\n const location = `Source: ${file}:${line}`;\n switch (language) {\n case \"typescript\":\n case \"go\":\n case \"csharp\":\n return `// ${location}`;\n case \"python\":\n return `# ${location}`;\n default:\n return `// ${location}`;\n }\n}\n\nmain().catch((err) => {\n console.error(\"Extraction failed:\", err);\n process.exit(1);\n});\n" }, { "path": "scripts/docs-validation/package.json", "content": "{\n \"name\": \"docs-validation\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"type\": \"module\",\n \"scripts\": {\n \"extract\": \"tsx extract.ts\",\n \"validate\": \"tsx validate.ts\",\n \"validate:ts\": \"tsx validate.ts --lang typescript\",\n \"validate:py\": \"tsx validate.ts --lang python\",\n \"validate:go\": \"tsx validate.ts --lang go\",\n \"validate:cs\": \"tsx validate.ts --lang csharp\"\n },\n \"dependencies\": {\n \"glob\": \"^11.0.0\",\n \"tsx\": \"^4.19.0\",\n \"typescript\": \"^5.7.0\"\n }\n}\n" }, { "path": "scripts/docs-validation/validate.ts", "content": "/**\n * Validates extracted documentation code blocks.\n * Runs language-specific type/compile checks.\n */\n\nimport * as fs from \"fs\";\nimport * as path from \"path\";\nimport { execFileSync } from \"child_process\";\nimport { glob } from \"glob\";\n\nconst ROOT_DIR = path.resolve(import.meta.dirname, \"../..\");\nconst VALIDATION_DIR = path.join(ROOT_DIR, \"docs/.validation\");\n\ninterface ValidationResult {\n file: string;\n sourceFile: string;\n sourceLine: number;\n success: boolean;\n errors: string[];\n}\n\ninterface Manifest {\n blocks: {\n id: string;\n sourceFile: string;\n sourceLine: number;\n language: string;\n outputFile: string;\n }[];\n}\n\nfunction loadManifest(): Manifest {\n const manifestPath = path.join(VALIDATION_DIR, \"manifest.json\");\n if (!fs.existsSync(manifestPath)) {\n console.error(\n \"❌ No manifest found. Run extraction first: npm run extract\"\n );\n process.exit(1);\n }\n return JSON.parse(fs.readFileSync(manifestPath, \"utf-8\"));\n}\n\nasync function validateTypeScript(): Promise {\n const results: ValidationResult[] = [];\n const tsDir = path.join(VALIDATION_DIR, \"typescript\");\n const manifest = loadManifest();\n\n if (!fs.existsSync(tsDir)) {\n console.log(\" No TypeScript files to validate\");\n return results;\n }\n\n // Create a temporary tsconfig for validation\n const tsconfig = {\n compilerOptions: {\n target: \"ES2022\",\n module: \"NodeNext\",\n moduleResolution: \"NodeNext\",\n strict: true,\n skipLibCheck: true,\n noEmit: true,\n esModuleInterop: true,\n allowSyntheticDefaultImports: true,\n resolveJsonModule: true,\n types: [\"node\"],\n paths: {\n \"@github/copilot-sdk\": [path.join(ROOT_DIR, \"nodejs/src/index.ts\")],\n },\n },\n include: [\"./**/*.ts\"],\n };\n\n const tsconfigPath = path.join(tsDir, \"tsconfig.json\");\n fs.writeFileSync(tsconfigPath, JSON.stringify(tsconfig, null, 2));\n\n try {\n // Run tsc\n const tscPath = path.join(ROOT_DIR, \"nodejs/node_modules/.bin/tsc\");\n execFileSync(tscPath, [\"--project\", tsconfigPath], {\n encoding: \"utf-8\",\n cwd: tsDir,\n });\n\n // All files passed\n const files = await glob(\"*.ts\", { cwd: tsDir });\n for (const file of files) {\n if (file === \"tsconfig.json\") continue;\n const block = manifest.blocks.find(\n (b) => b.outputFile === `typescript/${file}`\n );\n results.push({\n file: `typescript/${file}`,\n sourceFile: block?.sourceFile || \"unknown\",\n sourceLine: block?.sourceLine || 0,\n success: true,\n errors: [],\n });\n }\n } catch (err: any) {\n // Parse tsc output for errors\n const output = err.stdout || err.stderr || err.message || \"\";\n const errorLines = output.split(\"\\n\");\n const fileErrors = new Map();\n let currentFile = \"\";\n\n for (const line of errorLines) {\n const match = line.match(/^(.+\\.ts)\\((\\d+),(\\d+)\\): error/);\n if (match) {\n currentFile = match[1];\n if (!fileErrors.has(currentFile)) {\n fileErrors.set(currentFile, []);\n }\n fileErrors.get(currentFile)!.push(line);\n } else if (currentFile && line.trim()) {\n fileErrors.get(currentFile)?.push(line);\n }\n }\n\n // Create results\n const files = await glob(\"*.ts\", { cwd: tsDir });\n for (const file of files) {\n if (file === \"tsconfig.json\") continue;\n const fullPath = path.join(tsDir, file);\n const block = manifest.blocks.find(\n (b) => b.outputFile === `typescript/${file}`\n );\n const errors = fileErrors.get(fullPath) || fileErrors.get(file) || [];\n\n results.push({\n file: `typescript/${file}`,\n sourceFile: block?.sourceFile || \"unknown\",\n sourceLine: block?.sourceLine || 0,\n success: errors.length === 0,\n errors,\n });\n }\n }\n\n return results;\n}\n\nasync function validatePython(): Promise {\n const results: ValidationResult[] = [];\n const pyDir = path.join(VALIDATION_DIR, \"python\");\n const manifest = loadManifest();\n\n if (!fs.existsSync(pyDir)) {\n console.log(\" No Python files to validate\");\n return results;\n }\n\n const files = await glob(\"*.py\", { cwd: pyDir });\n\n for (const file of files) {\n const fullPath = path.join(pyDir, file);\n const block = manifest.blocks.find(\n (b) => b.outputFile === `python/${file}`\n );\n const errors: string[] = [];\n\n // Syntax check with py_compile\n try {\n execFileSync(\"python3\", [\"-m\", \"py_compile\", fullPath], {\n encoding: \"utf-8\",\n });\n } catch (err: any) {\n errors.push(err.stdout || err.stderr || err.message || \"Syntax error\");\n }\n\n // Type check with mypy (if available)\n if (errors.length === 0) {\n try {\n execFileSync(\n \"python3\",\n [\"-m\", \"mypy\", fullPath, \"--ignore-missing-imports\", \"--no-error-summary\"],\n { encoding: \"utf-8\" }\n );\n } catch (err: any) {\n const output = err.stdout || err.stderr || err.message || \"\";\n // Filter out \"Success\" messages and notes\n const typeErrors = output\n .split(\"\\n\")\n .filter(\n (l: string) =>\n l.includes(\": error:\") &&\n !l.includes(\"Cannot find implementation\")\n );\n if (typeErrors.length > 0) {\n errors.push(...typeErrors);\n }\n }\n }\n\n results.push({\n file: `python/${file}`,\n sourceFile: block?.sourceFile || \"unknown\",\n sourceLine: block?.sourceLine || 0,\n success: errors.length === 0,\n errors,\n });\n }\n\n return results;\n}\n\nasync function validateGo(): Promise {\n const results: ValidationResult[] = [];\n const goDir = path.join(VALIDATION_DIR, \"go\");\n const manifest = loadManifest();\n\n if (!fs.existsSync(goDir)) {\n console.log(\" No Go files to validate\");\n return results;\n }\n\n // Create a go.mod for the validation directory\n const goMod = `module docs-validation\n\ngo 1.21\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nreplace github.com/github/copilot-sdk/go => ${path.join(ROOT_DIR, \"go\")}\n`;\n fs.writeFileSync(path.join(goDir, \"go.mod\"), goMod);\n\n // Run go mod tidy to fetch dependencies\n try {\n execFileSync(\"go\", [\"mod\", \"tidy\"], {\n encoding: \"utf-8\",\n cwd: goDir,\n env: { ...process.env, GO111MODULE: \"on\" },\n });\n } catch (err: any) {\n // go mod tidy might fail if there are syntax errors, continue anyway\n }\n\n const files = await glob(\"*.go\", { cwd: goDir });\n\n // Try to compile each file individually\n for (const file of files) {\n const fullPath = path.join(goDir, file);\n const block = manifest.blocks.find((b) => b.outputFile === `go/${file}`);\n const errors: string[] = [];\n\n try {\n // Use go vet for syntax and basic checks\n execFileSync(\"go\", [\"build\", \"-o\", \"/dev/null\", fullPath], {\n encoding: \"utf-8\",\n cwd: goDir,\n env: { ...process.env, GO111MODULE: \"on\" },\n });\n } catch (err: any) {\n const output = err.stdout || err.stderr || err.message || \"\";\n errors.push(\n ...output.split(\"\\n\").filter((l: string) => l.trim() && !l.startsWith(\"#\"))\n );\n }\n\n results.push({\n file: `go/${file}`,\n sourceFile: block?.sourceFile || \"unknown\",\n sourceLine: block?.sourceLine || 0,\n success: errors.length === 0,\n errors,\n });\n }\n\n return results;\n}\n\nasync function validateCSharp(): Promise {\n const results: ValidationResult[] = [];\n const csDir = path.join(VALIDATION_DIR, \"csharp\");\n const manifest = loadManifest();\n\n if (!fs.existsSync(csDir)) {\n console.log(\" No C# files to validate\");\n return results;\n }\n\n // Create a minimal csproj for validation\n const csproj = `\n \n Library\n net8.0\n enable\n enable\n CS8019;CS0168;CS0219\n \n \n \n \n`;\n\n fs.writeFileSync(path.join(csDir, \"DocsValidation.csproj\"), csproj);\n\n const files = await glob(\"*.cs\", { cwd: csDir });\n\n // Compile all files together\n try {\n execFileSync(\"dotnet\", [\"build\", path.join(csDir, \"DocsValidation.csproj\")], {\n encoding: \"utf-8\",\n cwd: csDir,\n });\n\n // All files passed\n for (const file of files) {\n const block = manifest.blocks.find(\n (b) => b.outputFile === `csharp/${file}`\n );\n results.push({\n file: `csharp/${file}`,\n sourceFile: block?.sourceFile || \"unknown\",\n sourceLine: block?.sourceLine || 0,\n success: true,\n errors: [],\n });\n }\n } catch (err: any) {\n const output = err.stdout || err.stderr || err.message || \"\";\n\n // Parse errors by file\n const fileErrors = new Map();\n\n for (const line of output.split(\"\\n\")) {\n const match = line.match(/([^/\\\\]+\\.cs)\\((\\d+),(\\d+)\\): error/);\n if (match) {\n const fileName = match[1];\n if (!fileErrors.has(fileName)) {\n fileErrors.set(fileName, []);\n }\n fileErrors.get(fileName)!.push(line);\n }\n }\n\n for (const file of files) {\n const block = manifest.blocks.find(\n (b) => b.outputFile === `csharp/${file}`\n );\n const errors = fileErrors.get(file) || [];\n\n results.push({\n file: `csharp/${file}`,\n sourceFile: block?.sourceFile || \"unknown\",\n sourceLine: block?.sourceLine || 0,\n success: errors.length === 0,\n errors,\n });\n }\n }\n\n return results;\n}\n\nfunction printResults(results: ValidationResult[], language: string): { failed: number; passed: number; failures: ValidationResult[] } {\n const failed = results.filter((r) => !r.success);\n const passed = results.filter((r) => r.success);\n\n if (failed.length === 0) {\n console.log(` ✅ ${passed.length} files passed`);\n return { failed: 0, passed: passed.length, failures: [] };\n }\n\n console.log(` ❌ ${failed.length} failed, ${passed.length} passed\\n`);\n\n for (const result of failed) {\n console.log(` ┌─ ${result.sourceFile}:${result.sourceLine}`);\n console.log(` │ Extracted to: ${result.file}`);\n for (const error of result.errors.slice(0, 5)) {\n console.log(` │ ${error}`);\n }\n if (result.errors.length > 5) {\n console.log(` │ ... and ${result.errors.length - 5} more errors`);\n }\n console.log(` └─`);\n }\n\n return { failed: failed.length, passed: passed.length, failures: failed };\n}\n\nfunction writeGitHubSummary(summaryData: { language: string; passed: number; failed: number; failures: ValidationResult[] }[]) {\n const summaryFile = process.env.GITHUB_STEP_SUMMARY;\n if (!summaryFile) return;\n\n const totalPassed = summaryData.reduce((sum, d) => sum + d.passed, 0);\n const totalFailed = summaryData.reduce((sum, d) => sum + d.failed, 0);\n const allPassed = totalFailed === 0;\n\n let summary = `## 📖 Documentation Validation Results\\n\\n`;\n\n if (allPassed) {\n summary += `✅ **All ${totalPassed} code blocks passed validation**\\n\\n`;\n } else {\n summary += `❌ **${totalFailed} failures** out of ${totalPassed + totalFailed} code blocks\\n\\n`;\n }\n\n summary += `| Language | Status | Passed | Failed |\\n`;\n summary += `|----------|--------|--------|--------|\\n`;\n\n for (const { language, passed, failed } of summaryData) {\n const status = failed === 0 ? \"✅\" : \"❌\";\n summary += `| ${language} | ${status} | ${passed} | ${failed} |\\n`;\n }\n\n if (totalFailed > 0) {\n summary += `\\n### Failures\\n\\n`;\n for (const { language, failures } of summaryData) {\n if (failures.length === 0) continue;\n summary += `#### ${language}\\n\\n`;\n for (const f of failures) {\n summary += `- **${f.sourceFile}:${f.sourceLine}**\\n`;\n summary += ` \\`\\`\\`\\n ${f.errors.slice(0, 3).join(\"\\n \")}\\n \\`\\`\\`\\n`;\n }\n }\n }\n\n fs.appendFileSync(summaryFile, summary);\n}\n\nasync function main() {\n const args = process.argv.slice(2);\n const langArg = args.find((a) => a.startsWith(\"--lang=\"));\n const targetLang = langArg?.split(\"=\")[1];\n\n console.log(\"🔍 Validating documentation code blocks...\\n\");\n\n if (!fs.existsSync(VALIDATION_DIR)) {\n console.error(\"❌ No extracted code found. Run extraction first:\");\n console.error(\" npm run extract\");\n process.exit(1);\n }\n\n let totalFailed = 0;\n const summaryData: { language: string; passed: number; failed: number; failures: ValidationResult[] }[] = [];\n\n const validators: [string, () => Promise][] = [\n [\"TypeScript\", validateTypeScript],\n [\"Python\", validatePython],\n [\"Go\", validateGo],\n [\"C#\", validateCSharp],\n ];\n\n for (const [name, validator] of validators) {\n const langKey = name.toLowerCase().replace(\"#\", \"sharp\");\n if (targetLang && langKey !== targetLang) continue;\n\n console.log(`\\n${name}:`);\n const results = await validator();\n const { failed, passed, failures } = printResults(results, name);\n totalFailed += failed;\n summaryData.push({ language: name, passed, failed, failures });\n }\n\n // Write GitHub Actions summary\n writeGitHubSummary(summaryData);\n\n console.log(\"\\n\" + \"─\".repeat(40));\n\n if (totalFailed > 0) {\n console.log(`\\n❌ Validation failed: ${totalFailed} file(s) have errors`);\n console.log(\"\\nTo fix:\");\n console.log(\" 1. Check the error messages above\");\n console.log(\" 2. Update the code blocks in the markdown files\");\n console.log(\" 3. Re-run: npm run validate\");\n console.log(\"\\nTo skip a code block, add before it:\");\n console.log(\" \");\n console.log(\"\\nTo validate a complete version while showing a snippet:\");\n console.log(\" \");\n console.log(\" ```lang\");\n console.log(\" // full compilable code\");\n console.log(\" ```\");\n console.log(\" \");\n console.log(\" ```lang\");\n console.log(\" // visible snippet (auto-skipped)\");\n console.log(\" ```\");\n process.exit(1);\n }\n\n console.log(\"\\n✅ All documentation code blocks are valid!\");\n}\n\nmain().catch((err) => {\n console.error(\"Validation failed:\", err);\n process.exit(1);\n});\n" }, { "path": "sdk-protocol-version.json", "content": "{\n \"version\": 3\n}\n" }, { "path": "test/harness/.gitignore", "content": "node_modules/\n" }, { "path": "test/harness/capturingHttpProxy.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport http from \"http\";\nimport { afterEach, beforeEach, describe, expect, test } from \"vitest\";\nimport { CapturedExchange, CapturingHttpProxy } from \"./capturingHttpProxy\";\n\ndescribe(\"Capturing HTTP Proxy\", () => {\n let proxy: CapturingHttpProxy;\n let testServer: http.Server;\n let testServerAddress: string;\n\n beforeEach(async () => {\n testServer = http.createServer((req, res) => {\n res.writeHead(200, { \"content-type\": \"application/json\" });\n res.end(JSON.stringify({ message: \"Hello\", path: req.url }));\n });\n\n await new Promise((resolve, reject) => {\n testServer.listen(0, \"127.0.0.1\", () => {\n const addr = testServer.address();\n if (addr instanceof Object) {\n testServerAddress = `http://${addr.address}:${addr.port}`;\n resolve();\n } else {\n reject(new Error(\"Failed to get test server address\"));\n }\n });\n });\n });\n\n afterEach(async () => {\n if (proxy) {\n await proxy.stop();\n }\n\n if (testServer) {\n await new Promise((resolve, reject) =>\n testServer.close((err) => {\n if (err) {\n reject(err);\n } else {\n resolve();\n }\n }),\n );\n }\n });\n\n test(\"captures HTTP requests and responses\", async () => {\n proxy = new CapturingHttpProxy(testServerAddress);\n const proxyUrl = await proxy.start();\n\n const response = await fetch(`${proxyUrl}/api/test`);\n expect(response.status).toBe(200);\n\n // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n const data = await response.json();\n expect(data).toEqual({ message: \"Hello\", path: \"/api/test\" });\n expect(proxy.exchanges).toMatchObject([\n {\n request: {\n url: \"/api/test\",\n method: \"GET\",\n },\n response: {\n statusCode: 200,\n body: JSON.stringify({ message: \"Hello\", path: \"/api/test\" }),\n },\n } as CapturedExchange,\n ]);\n });\n});\n" }, { "path": "test/harness/capturingHttpProxy.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport http, { RequestOptions } from \"http\";\nimport https from \"https\";\n\n/**\n * Intended to be used in E2E tests so they can assert about requests/responses.\n */\nexport class CapturingHttpProxy {\n private readonly capturedExchanges: CapturedExchange[] = [];\n private server?: http.Server;\n\n constructor(private targetUrl: string) {}\n\n get exchanges(): ReadonlyArray {\n return this.capturedExchanges;\n }\n\n async start(): Promise {\n const targetUrlObj = new URL(this.targetUrl);\n const isHttps = targetUrlObj.protocol === \"https:\";\n\n this.server = http.createServer((req, res) => {\n const chunks: Buffer[] = [];\n\n req.on(\"data\", (chunk: Buffer) => {\n chunks.push(chunk);\n });\n\n req.on(\"end\", () => {\n const body = Buffer.concat(chunks).toString(\"utf8\");\n const startTime = Date.now();\n\n const capturedRequest: CapturedRequest = {\n method: req.method || \"GET\",\n url: req.url || \"/\",\n headers: req.headers,\n body,\n startTime,\n };\n\n const exchange: CapturedExchange = {\n request: capturedRequest,\n };\n\n this.capturedExchanges.push(exchange);\n\n // Copy headers but update Host to match target\n const proxyHeaders = { ...req.headers };\n proxyHeaders.host = targetUrlObj.host;\n delete proxyHeaders.connection;\n\n let responseStatusCode: number | undefined;\n let responseHeaders: http.IncomingHttpHeaders | undefined;\n const responseChunks: Buffer[] = [];\n this.performRequest({\n isHttps,\n requestOptions: {\n hostname: targetUrlObj.hostname,\n port: targetUrlObj.port || (isHttps ? 443 : 80),\n path: req.url,\n method: req.method,\n headers: proxyHeaders,\n },\n body,\n onResponseStart: (statusCode, headers) => {\n responseStatusCode = statusCode;\n responseHeaders = headers;\n res.writeHead(statusCode, responseHeaders);\n },\n onData: (chunk) => {\n responseChunks.push(chunk);\n res.write(chunk);\n },\n onResponseEnd: () => {\n const endTime = Date.now();\n const responseBody = Buffer.concat(responseChunks).toString(\"utf8\");\n\n exchange.response = {\n statusCode: responseStatusCode || 500,\n headers: responseHeaders || {},\n body: responseBody,\n endTime,\n };\n\n exchange.durationMs = endTime - startTime;\n\n res.end();\n },\n onError: (err) => {\n console.error(\"Error in proxying request:\", err);\n const endTime = Date.now();\n const formattedError =\n err instanceof Error\n ? `${err.message}\\n${err.stack}`\n : String(err);\n const errorHeaders = { \"x-github-request-id\": \"proxy-error\" };\n exchange.response = {\n statusCode: 500,\n headers: errorHeaders,\n body: `Proxy error: ${formattedError}`,\n endTime,\n };\n\n exchange.durationMs = endTime - startTime;\n\n res.writeHead(exchange.response.statusCode, errorHeaders);\n res.end(\"Proxy error\");\n },\n });\n });\n });\n\n return new Promise((resolve, reject) => {\n this.server!.on(\"error\", (err) => {\n reject(err);\n });\n\n this.server!.listen(0, \"127.0.0.1\", () => {\n const addr = this.server!.address();\n if (addr instanceof Object) {\n resolve(`http://${addr.address}:${addr.port}`);\n } else {\n reject(new Error(\"Failed to start proxy server\"));\n }\n });\n });\n }\n\n async stop(): Promise {\n if (this.server) {\n return new Promise((resolve, reject) => {\n this.server!.close((err) => {\n if (err) {\n reject(err);\n } else {\n resolve();\n }\n });\n });\n }\n }\n\n performRequest(options: PerformRequestOptions): void {\n const protocol = options.isHttps ? https : http;\n const upstreamRequest = protocol.request(\n options.requestOptions,\n (upstreamResponse) => {\n options.onResponseStart(\n upstreamResponse.statusCode || 500,\n upstreamResponse.headers,\n );\n upstreamResponse.on(\"data\", options.onData);\n upstreamResponse.on(\"end\", options.onResponseEnd);\n },\n );\n\n upstreamRequest.on(\"error\", options.onError);\n\n if (options.body) {\n upstreamRequest.write(options.body);\n }\n\n upstreamRequest.end();\n }\n\n protected clearExchanges(): void {\n this.capturedExchanges.length = 0;\n }\n}\n\nexport interface PerformRequestOptions {\n isHttps: boolean;\n requestOptions: RequestOptions;\n body: string | undefined;\n onResponseStart: (\n statusCode: number,\n responseHeaders: http.IncomingHttpHeaders,\n ) => void;\n onData: (chunk: Buffer) => void;\n onResponseEnd: () => void;\n onError: (err: Error | string) => void;\n}\n\nexport interface CapturedRequest {\n readonly method: string;\n readonly url: string;\n readonly headers: http.IncomingHttpHeaders;\n readonly body: string;\n readonly startTime: number;\n}\n\nexport interface CapturedResponse {\n readonly statusCode: number;\n readonly headers: http.IncomingHttpHeaders;\n readonly body: string;\n readonly endTime: number;\n}\n\nexport interface CapturedExchange {\n request: CapturedRequest;\n response?: CapturedResponse;\n durationMs?: number;\n}\n" }, { "path": "test/harness/package.json", "content": "{\n \"name\": \"harness\",\n \"version\": \"1.0.0\",\n \"description\": \"Test infrastructure for this repo. Not to be published.\",\n \"license\": \"ISC\",\n \"author\": \"\",\n \"type\": \"module\",\n \"main\": \"server.ts\",\n \"scripts\": {\n \"start\": \"tsx server.ts\",\n \"test\": \"vitest run\"\n },\n \"devDependencies\": {\n \"@github/copilot\": \"^1.0.40\",\n \"@modelcontextprotocol/sdk\": \"^1.26.0\",\n \"@types/node\": \"^25.3.3\",\n \"openai\": \"^6.17.0\",\n \"tsx\": \"^4.21.0\",\n \"typescript\": \"^5.9.3\",\n \"vitest\": \"^4.0.18\",\n \"yaml\": \"^2.8.2\"\n }\n}\n" }, { "path": "test/harness/replayingCapiProxy.test.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { mkdtemp, readFile, rm, writeFile } from \"fs/promises\";\nimport http from \"http\";\nimport type {\n ChatCompletion,\n ChatCompletionChunk,\n ChatCompletionMessageFunctionToolCall,\n} from \"openai/resources/chat/completions\";\nimport os from \"os\";\nimport path from \"path\";\nimport { afterEach, beforeEach, describe, expect, test } from \"vitest\";\nimport yaml from \"yaml\";\nimport {\n NormalizedData,\n ReplayingCapiProxy,\n ToolResultNormalizer,\n workingDirPlaceholder,\n} from \"./replayingCapiProxy\";\nimport { ShellConfig } from \"./util\";\n\ndescribe(\"ReplayingCapiProxy\", () => {\n let tempDir: string;\n let workDir: string;\n\n beforeEach(async () => {\n tempDir = await mkdtemp(path.join(os.tmpdir(), \"capi-proxy-test-\"));\n workDir = path.join(tempDir, \"work\");\n });\n\n afterEach(async () => {\n await rm(tempDir, { recursive: true, force: true });\n });\n\n async function createProxy(\n httpExchanges: Array<{\n url: string;\n requestBody: string;\n responseBody: string;\n }>,\n options?: { toolResultNormalizers?: ToolResultNormalizer[] },\n ) {\n const outputPath = path.join(tempDir, \"output.yaml\");\n const proxy = new ReplayingCapiProxy(\n \"http://localhost\",\n outputPath,\n workDir,\n );\n\n for (const normalizer of options?.toolResultNormalizers ?? []) {\n proxy.addToolResultNormalizer(normalizer.toolName, normalizer.normalizer);\n }\n\n for (const exchange of httpExchanges) {\n (proxy.exchanges as Array).push({\n request: {\n url: exchange.url,\n method: \"POST\",\n body: exchange.requestBody,\n },\n response: { statusCode: 200, body: exchange.responseBody },\n });\n }\n\n await proxy.stop();\n return outputPath;\n }\n\n async function readYamlOutput(outputPath: string): Promise {\n const content = await readFile(outputPath, \"utf-8\");\n return yaml.parse(content) as NormalizedData;\n }\n\n test(\"does not write file when no chat completion exchanges\", async () => {\n const outputPath = path.join(tempDir, \"output.yaml\");\n const proxy = new ReplayingCapiProxy(\n \"http://localhost\",\n outputPath,\n workDir,\n );\n await proxy.stop();\n\n await expect(readFile(outputPath)).rejects.toThrow(/ENOENT/);\n });\n\n test(\"captures chat completion request and response\", async () => {\n const requestBody = JSON.stringify({\n messages: [\n { role: \"system\", content: \"You are helpful\" },\n { role: \"user\", content: \"Hello\" },\n ],\n });\n const responseBody = JSON.stringify({\n choices: [{ message: { role: \"assistant\", content: \"Hi there!\" } }],\n });\n\n const outputPath = await createProxy([\n { url: \"/chat/completions\", requestBody, responseBody },\n ]);\n\n const result = await readYamlOutput(outputPath);\n expect(result.conversations).toHaveLength(1);\n expect(result.conversations[0].messages).toEqual([\n { role: \"system\", content: \"${system}\" },\n { role: \"user\", content: \"Hello\" },\n { role: \"assistant\", content: \"Hi there!\" },\n ]);\n });\n\n test(\"normalizes tool call IDs to sequential values\", async () => {\n const requestBody = JSON.stringify({\n messages: [{ role: \"user\", content: \"Do something\" }],\n });\n const responseBody = JSON.stringify({\n choices: [\n {\n message: {\n role: \"assistant\",\n tool_calls: [\n {\n id: \"toolu_abc123xyz\",\n type: \"function\",\n function: { name: \"view\", arguments: \"{}\" },\n },\n ],\n },\n },\n ],\n });\n\n const outputPath = await createProxy([\n { url: \"/chat/completions\", requestBody, responseBody },\n ]);\n\n const result = await readYamlOutput(outputPath);\n expect(result.conversations[0].messages[1].tool_calls![0].id).toBe(\n \"toolcall_0\",\n );\n });\n\n test(\"normalizes shell tool names to platform-agnostic placeholders\", async () => {\n const originalShellConfig =\n process.platform === \"win32\" ? ShellConfig.powerShell : ShellConfig.bash;\n const requestBody = JSON.stringify({\n messages: [{ role: \"user\", content: \"Do something\" }],\n });\n const responseBody = JSON.stringify({\n choices: [\n {\n message: {\n role: \"assistant\",\n tool_calls: [\n {\n id: \"t0\",\n type: \"function\",\n function: {\n name: originalShellConfig.shellToolName,\n arguments: \"{}\",\n },\n },\n {\n id: \"t1\",\n type: \"function\",\n function: {\n name: originalShellConfig.readShellToolName,\n arguments: \"{}\",\n },\n },\n {\n id: \"t2\",\n type: \"function\",\n function: {\n name: originalShellConfig.writeShellToolName,\n arguments: \"{}\",\n },\n },\n {\n id: \"t3\",\n type: \"function\",\n function: { name: \"someOtherName\", arguments: \"{}\" },\n },\n ],\n },\n },\n ],\n });\n\n const outputPath = await createProxy([\n { url: \"/chat/completions\", requestBody, responseBody },\n ]);\n\n const result = await readYamlOutput(outputPath);\n expect(\n result.conversations[0].messages[1].tool_calls![0].function?.name,\n ).toBe(\"${shell}\");\n expect(\n result.conversations[0].messages[1].tool_calls![1].function?.name,\n ).toBe(\"${read_shell}\");\n expect(\n result.conversations[0].messages[1].tool_calls![2].function?.name,\n ).toBe(\"${write_shell}\");\n expect(\n result.conversations[0].messages[1].tool_calls![3].function?.name,\n ).toBe(\"someOtherName\");\n });\n\n test(\"normalizes workDir paths to placeholder with forward slashes\", async () => {\n const requestBody = JSON.stringify({\n messages: [{ role: \"user\", content: \"Read file\" }],\n });\n const responseBody = JSON.stringify({\n choices: [\n {\n message: {\n role: \"assistant\",\n tool_calls: [\n {\n id: \"tc1\",\n type: \"function\",\n function: {\n name: \"view\",\n arguments: JSON.stringify({\n path: workDir + \"\\\\subdir\\\\file.txt\",\n }),\n },\n },\n ],\n },\n },\n ],\n });\n\n const outputPath = await createProxy([\n { url: \"/chat/completions\", requestBody, responseBody },\n ]);\n\n const result = await readYamlOutput(outputPath);\n const args =\n result.conversations[0].messages[1].tool_calls![0].function!.arguments;\n expect(args).toBe(`{\"path\":\"${workingDirPlaceholder}/subdir/file.txt\"}`);\n });\n\n test(\"removes prefix exchanges keeping only the longest conversation\", async () => {\n const turn1Request = JSON.stringify({\n messages: [{ role: \"user\", content: \"Hello\" }],\n });\n const turn1Response = JSON.stringify({\n choices: [{ message: { role: \"assistant\", content: \"Hi\" } }],\n });\n const turn2Request = JSON.stringify({\n messages: [\n { role: \"user\", content: \"Hello\" },\n { role: \"assistant\", content: \"Hi\" },\n { role: \"user\", content: \"How are you?\" },\n ],\n });\n const turn2Response = JSON.stringify({\n choices: [{ message: { role: \"assistant\", content: \"Good!\" } }],\n });\n\n const outputPath = await createProxy([\n {\n url: \"/chat/completions\",\n requestBody: turn1Request,\n responseBody: turn1Response,\n },\n {\n url: \"/chat/completions\",\n requestBody: turn2Request,\n responseBody: turn2Response,\n },\n ]);\n\n const result = await readYamlOutput(outputPath);\n expect(result.conversations).toHaveLength(1);\n expect(result.conversations[0].messages).toHaveLength(4);\n });\n\n test(\"strips current_datetime from user messages\", async () => {\n const requestBody = JSON.stringify({\n messages: [\n {\n role: \"user\",\n content:\n \"2025-12-09 What time is it?\",\n },\n ],\n });\n const responseBody = JSON.stringify({\n choices: [{ message: { role: \"assistant\", content: \"It's now\" } }],\n });\n\n const outputPath = await createProxy([\n { url: \"/chat/completions\", requestBody, responseBody },\n ]);\n\n const result = await readYamlOutput(outputPath);\n expect(result.conversations[0].messages[0].content).toBe(\n \"What time is it?\",\n );\n });\n\n test(\"strips system_reminder from user messages\", async () => {\n const requestBody = JSON.stringify({\n messages: [\n {\n role: \"user\",\n content:\n \"What is 2+2?\\n\\n\\nNo tables currently exist.\\n\",\n },\n ],\n });\n const responseBody = JSON.stringify({\n choices: [{ message: { role: \"assistant\", content: \"4\" } }],\n });\n\n const outputPath = await createProxy([\n { url: \"/chat/completions\", requestBody, responseBody },\n ]);\n\n const result = await readYamlOutput(outputPath);\n expect(result.conversations[0].messages[0].content).toBe(\"What is 2+2?\");\n });\n\n test(\"strips agent_instructions from user messages\", async () => {\n const requestBody = JSON.stringify({\n messages: [\n {\n role: \"user\",\n content:\n \"\\nYou are a helpful test agent.\\n\\n\\n\\n\\nSay hello briefly.\",\n },\n ],\n });\n const responseBody = JSON.stringify({\n choices: [{ message: { role: \"assistant\", content: \"Hello!\" } }],\n });\n\n const outputPath = await createProxy([\n { url: \"/chat/completions\", requestBody, responseBody },\n ]);\n\n const result = await readYamlOutput(outputPath);\n expect(result.conversations[0].messages[0].content).toBe(\n \"Say hello briefly.\",\n );\n });\n\n test(\"strips agent_instructions containing skill-context from user messages\", async () => {\n const requestBody = JSON.stringify({\n messages: [\n {\n role: \"user\",\n content:\n '\\n\\nSkill content here\\n\\nYou are a helpful agent.\\n\\n\\nSay hello.',\n },\n ],\n });\n const responseBody = JSON.stringify({\n choices: [{ message: { role: \"assistant\", content: \"Hi!\" } }],\n });\n\n const outputPath = await createProxy([\n { url: \"/chat/completions\", requestBody, responseBody },\n ]);\n\n const result = await readYamlOutput(outputPath);\n expect(result.conversations[0].messages[0].content).toBe(\"Say hello.\");\n });\n\n test(\"applies tool result normalizers to tool response content\", async () => {\n const requestBody = JSON.stringify({\n messages: [\n { role: \"user\", content: \"Help me\" },\n {\n role: \"assistant\",\n tool_calls: [\n {\n id: \"tc1\",\n type: \"function\",\n function: { name: \"tool_alpha\", arguments: \"{}\" },\n },\n {\n id: \"tc2\",\n type: \"function\",\n function: { name: \"tool_beta\", arguments: \"{}\" },\n },\n ],\n },\n { role: \"tool\", tool_call_id: \"tc1\", content: \"alpha result\" },\n { role: \"tool\", tool_call_id: \"tc2\", content: \"beta result\" },\n ],\n });\n const responseBody = JSON.stringify({\n choices: [{ message: { role: \"assistant\", content: \"Done\" } }],\n });\n\n const outputPath = await createProxy(\n [{ url: \"/chat/completions\", requestBody, responseBody }],\n {\n toolResultNormalizers: [\n { toolName: \"tool_alpha\", normalizer: (r) => r.toUpperCase() },\n { toolName: \"tool_beta\", normalizer: (r) => `[${r}]` },\n ],\n },\n );\n\n const result = await readYamlOutput(outputPath);\n const toolMessages = result.conversations[0].messages.filter(\n (m) => m.role === \"tool\",\n );\n expect(toolMessages[0].content).toBe(\"ALPHA RESULT\");\n expect(toolMessages[1].content).toBe(\"[beta result]\");\n });\n\n test(\"ignores non-chat-completion endpoints\", async () => {\n const outputPath = await createProxy([\n { url: \"/models\", requestBody: \"{}\", responseBody: \"{}\" },\n { url: \"/embeddings\", requestBody: \"{}\", responseBody: \"{}\" },\n ]);\n\n await expect(readFile(outputPath)).rejects.toThrow(/ENOENT/);\n });\n\n describe(\"cache replay\", () => {\n async function makeRequest(\n proxyUrl: string,\n requestPath: string,\n options?: { method?: string; body?: object },\n ): Promise<{ status: number; body: string }> {\n return new Promise((resolve, reject) => {\n const url = new URL(proxyUrl);\n const req = http.request(\n {\n hostname: url.hostname,\n port: url.port,\n path: requestPath,\n method: options?.method ?? \"POST\",\n headers: { \"content-type\": \"application/json\" },\n },\n (res) => {\n const chunks: Buffer[] = [];\n res.on(\"data\", (chunk: Buffer) => chunks.push(chunk));\n res.on(\"end\", () => {\n resolve({\n status: res.statusCode || 500,\n body: Buffer.concat(chunks).toString(\"utf-8\"),\n });\n });\n },\n );\n req.on(\"error\", reject);\n if (options?.body) {\n req.write(JSON.stringify(options.body));\n }\n req.end();\n });\n }\n\n test(\"returns cached response when request matches prefix\", async () => {\n const cachePath = path.join(tempDir, \"cache.yaml\");\n const cacheContent = yaml.stringify({\n models: [\"test-model\"],\n conversations: [\n {\n messages: [\n { role: \"system\", content: \"${system}\" },\n { role: \"user\", content: \"Hello\" },\n { role: \"assistant\", content: \"Hi there!\" },\n ],\n },\n ],\n } satisfies NormalizedData);\n await writeFile(cachePath, cacheContent);\n\n const proxy = new ReplayingCapiProxy(\n \"http://localhost:9999\",\n cachePath,\n workDir,\n );\n const proxyUrl = await proxy.start();\n\n try {\n const response = await makeRequest(proxyUrl, \"/chat/completions\", {\n body: {\n model: \"test-model\",\n messages: [\n { role: \"system\", content: \"You are helpful\" },\n { role: \"user\", content: \"Hello\" },\n ],\n },\n });\n\n expect(response.status).toBe(200);\n const parsed = JSON.parse(response.body) as ChatCompletion;\n expect(parsed.choices[0].message.content).toBe(\"Hi there!\");\n } finally {\n await proxy.stop();\n }\n });\n\n test(\"returns cached response with tool calls\", async () => {\n const cachePath = path.join(tempDir, \"cache.yaml\");\n const cacheContent = yaml.stringify({\n models: [\"test-model\"],\n conversations: [\n {\n messages: [\n { role: \"system\", content: \"${system}\" },\n { role: \"user\", content: \"List files\" },\n {\n role: \"assistant\",\n tool_calls: [\n {\n id: \"toolcall_0\",\n type: \"function\",\n function: { name: \"list_files\", arguments: '{\"path\":\".\"}' },\n },\n ],\n },\n ],\n },\n ],\n } satisfies NormalizedData);\n await writeFile(cachePath, cacheContent);\n\n const proxy = new ReplayingCapiProxy(\n \"http://localhost:9999\",\n cachePath,\n workDir,\n );\n const proxyUrl = await proxy.start();\n\n try {\n const response = await makeRequest(proxyUrl, \"/chat/completions\", {\n body: {\n model: \"test-model\",\n messages: [\n { role: \"system\", content: \"System prompt\" },\n { role: \"user\", content: \"List files\" },\n ],\n },\n });\n\n expect(response.status).toBe(200);\n const parsed = JSON.parse(response.body) as ChatCompletion;\n expect(parsed.choices[0].message.tool_calls).toHaveLength(1);\n const toolCall = parsed.choices[0].message\n .tool_calls![0] as ChatCompletionMessageFunctionToolCall;\n expect(toolCall.function.name).toBe(\"list_files\");\n } finally {\n await proxy.stop();\n }\n });\n\n test(\"expands workdir placeholder in cached response\", async () => {\n const cachePath = path.join(tempDir, \"cache.yaml\");\n const cacheContent = yaml.stringify({\n models: [\"test-model\"],\n conversations: [\n {\n messages: [\n { role: \"system\", content: \"${system}\" },\n { role: \"user\", content: \"Read file\" },\n {\n role: \"assistant\",\n tool_calls: [\n {\n id: \"toolcall_0\",\n type: \"function\",\n function: {\n name: \"read_file\",\n arguments: `{\"path\":\"${workingDirPlaceholder}/test.txt\"}`,\n },\n },\n ],\n },\n ],\n },\n ],\n } satisfies NormalizedData);\n await writeFile(cachePath, cacheContent);\n\n const proxy = new ReplayingCapiProxy(\n \"http://localhost:9999\",\n cachePath,\n workDir,\n );\n const proxyUrl = await proxy.start();\n\n try {\n const response = await makeRequest(proxyUrl, \"/chat/completions\", {\n body: {\n model: \"test-model\",\n messages: [\n { role: \"system\", content: \"System\" },\n { role: \"user\", content: \"Read file\" },\n ],\n },\n });\n\n expect(response.status).toBe(200);\n const parsed = JSON.parse(response.body) as ChatCompletion;\n const toolCall = parsed.choices[0].message\n .tool_calls![0] as ChatCompletionMessageFunctionToolCall;\n const args = JSON.parse(toolCall.function.arguments) as {\n path: string;\n };\n expect(args.path).toBe(workDir + \"/test.txt\");\n } finally {\n await proxy.stop();\n }\n });\n\n test(\"matches multi-turn conversation\", async () => {\n const cachePath = path.join(tempDir, \"cache.yaml\");\n const cacheContent = yaml.stringify({\n models: [\"test-model\"],\n conversations: [\n {\n messages: [\n { role: \"system\", content: \"${system}\" },\n { role: \"user\", content: \"Hello\" },\n { role: \"assistant\", content: \"Hi!\" },\n { role: \"user\", content: \"How are you?\" },\n { role: \"assistant\", content: \"I am fine!\" },\n ],\n },\n ],\n } satisfies NormalizedData);\n await writeFile(cachePath, cacheContent);\n\n const proxy = new ReplayingCapiProxy(\n \"http://localhost:9999\",\n cachePath,\n workDir,\n );\n const proxyUrl = await proxy.start();\n\n try {\n // First turn\n const response1 = await makeRequest(proxyUrl, \"/chat/completions\", {\n body: {\n model: \"test-model\",\n messages: [\n { role: \"system\", content: \"Be helpful\" },\n { role: \"user\", content: \"Hello\" },\n ],\n },\n });\n expect(\n (JSON.parse(response1.body) as ChatCompletion).choices[0].message\n .content,\n ).toBe(\"Hi!\");\n\n // Second turn\n const response2 = await makeRequest(proxyUrl, \"/chat/completions\", {\n body: {\n model: \"test-model\",\n messages: [\n { role: \"system\", content: \"Be helpful\" },\n { role: \"user\", content: \"Hello\" },\n { role: \"assistant\", content: \"Hi!\" },\n { role: \"user\", content: \"How are you?\" },\n ],\n },\n });\n expect(\n (JSON.parse(response2.body) as ChatCompletion).choices[0].message\n .content,\n ).toBe(\"I am fine!\");\n } finally {\n await proxy.stop();\n }\n });\n\n test(\"returns streaming response when stream: true\", async () => {\n const cachePath = path.join(tempDir, \"cache.yaml\");\n const cacheContent = yaml.stringify({\n models: [\"test-model\"],\n conversations: [\n {\n messages: [\n { role: \"system\", content: \"${system}\" },\n { role: \"user\", content: \"Hello\" },\n { role: \"assistant\", content: \"Hi there!\" },\n ],\n },\n ],\n } satisfies NormalizedData);\n await writeFile(cachePath, cacheContent);\n\n const proxy = new ReplayingCapiProxy(\n \"http://localhost:9999\",\n cachePath,\n workDir,\n );\n const proxyUrl = await proxy.start();\n\n try {\n const response = await makeRequest(proxyUrl, \"/chat/completions\", {\n body: {\n model: \"test-model\",\n messages: [\n { role: \"system\", content: \"You are helpful\" },\n { role: \"user\", content: \"Hello\" },\n ],\n stream: true,\n },\n });\n\n expect(response.status).toBe(200);\n expect(response.body).toContain(\"data: \");\n expect(response.body).toContain(\"[DONE]\");\n\n // Parse the SSE chunk\n const dataLine = response.body\n .split(\"\\n\")\n .find((line) => line.startsWith(\"data: {\"));\n expect(dataLine).toBeDefined();\n const chunk = JSON.parse(dataLine!.slice(6)) as ChatCompletionChunk;\n expect(chunk.object).toBe(\"chat.completion.chunk\");\n expect(chunk.choices[0].delta.content).toBe(\"Hi there!\");\n } finally {\n await proxy.stop();\n }\n });\n\n test(\"returns cached models for /models endpoint\", async () => {\n const cachePath = path.join(tempDir, \"cache.yaml\");\n const cacheContent = yaml.stringify({\n models: [\"gpt-4o\", \"claude-sonnet-4\"],\n conversations: [],\n } satisfies NormalizedData);\n await writeFile(cachePath, cacheContent);\n\n const proxy = new ReplayingCapiProxy(\n \"http://localhost:9999\",\n cachePath,\n workDir,\n );\n const proxyUrl = await proxy.start();\n\n try {\n const response = await makeRequest(proxyUrl, \"/models\", {\n method: \"GET\",\n });\n\n expect(response.status).toBe(200);\n const parsed = JSON.parse(response.body) as {\n data: Array<{ id: string; name: string }>;\n };\n expect(parsed.data).toHaveLength(2);\n expect(parsed.data[0].id).toBe(\"gpt-4o\");\n expect(parsed.data[1].id).toBe(\"claude-sonnet-4\");\n } finally {\n await proxy.stop();\n }\n });\n });\n});\n" }, { "path": "test/harness/replayingCapiProxy.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { existsSync } from \"fs\";\nimport { mkdir, readFile, writeFile } from \"fs/promises\";\nimport type {\n ChatCompletion,\n ChatCompletionChunk,\n ChatCompletionCreateParamsBase,\n ChatCompletionMessageFunctionToolCall,\n ChatCompletionMessageParam,\n} from \"openai/resources/chat/completions\";\nimport { ChatCompletionStream } from \"openai/resources/chat/completions\";\nimport path from \"path\";\nimport yaml from \"yaml\";\nimport {\n CapturedExchange,\n CapturingHttpProxy,\n PerformRequestOptions,\n} from \"./capturingHttpProxy\";\nimport { iife, ShellConfig, sleep } from \"./util\";\n\nexport const workingDirPlaceholder = \"${workdir}\";\nconst chatCompletionEndpoint = \"/chat/completions\";\nconst shellConfig =\n process.platform === \"win32\" ? ShellConfig.powerShell : ShellConfig.bash;\nconst normalizedToolNames = {\n [shellConfig.shellToolName]: \"${shell}\",\n [shellConfig.readShellToolName]: \"${read_shell}\",\n [shellConfig.writeShellToolName]: \"${write_shell}\",\n};\n\n/**\n * Default model to use when no stored data is available for a given test.\n * This enables responding to /models without needing to have a capture file.\n */\nconst defaultModel = \"claude-sonnet-4.5\";\n\n/**\n * An HTTP proxy that not only captures HTTP exchanges, but also stores them in a file on disk and\n * replays the stored responses on subsequent runs.\n *\n * This only stores and matches CAPI-provided OpenAI chat completions, not arbitrary HTTP traffic, since\n * the core idea is to store and compare in a normalized form that (1) ignores irrelevant differences (like\n * timestamps, or references to your working directory path) and (2) writes data files in a simple,\n * human-readable format where it's easy to reason about diffs when things change.\n *\n * To avoid leaving stale files around as tests are modified, it stores things on a one-file-per-test basis,\n * which is overwritten on each test run. So for as long as a test exists, its data will be kept up-to-date.\n */\nexport class ReplayingCapiProxy extends CapturingHttpProxy {\n private state: ReplayingCapiProxyState | null = null;\n private startPromise: Promise | null = null;\n private defaultToolResultNormalizers: ToolResultNormalizer[] = [\n { toolName: \"*\", normalizer: normalizeLargeOutputFilepaths },\n { toolName: \"*\", normalizer: normalizeGhAuthMessages },\n ];\n\n /**\n * Per-token responses for `/copilot_internal/user` endpoint.\n * Key is the Bearer token (without \"Bearer \" prefix), value is the response body.\n * When a request arrives with `Authorization: Bearer `, the matching response is returned.\n * If no match is found, a 401 Unauthorized response is returned.\n */\n private copilotUserByToken = new Map();\n\n /**\n * If true, cached responses are played back slowly (~ 2KiB/sec). Otherwise streaming responses are sent as fast as possible.\n */\n slowStreaming = false;\n\n constructor(\n targetUrl: string,\n filePath?: string,\n workDir?: string,\n testInfo?: { file: string; line?: number },\n ) {\n super(targetUrl);\n\n // If the instantiator wants to supply config up front as ctor params, we can\n // skip the need to do a /config POST before other requests. This only makes\n // sense if the config will be static for the lifetime of the proxy.\n if (filePath && workDir) {\n this.state = {\n filePath,\n workDir,\n testInfo,\n toolResultNormalizers: [...this.defaultToolResultNormalizers],\n };\n }\n }\n\n async start(): Promise {\n return (this.startPromise ??= (async () => {\n await this.loadStoredData();\n return super.start();\n })());\n }\n\n async updateConfig(config: Partial): Promise {\n if (!config.filePath || !config.workDir) {\n throw new Error(\"filePath and workDir must be provided in config\");\n }\n\n // Since we're about to switch to a new file, write out any captured exchanges\n // Note that the final call to stop() will also write out any remaining exchanges.\n // In CI mode (GITHUB_ACTIONS=true) we never write — the snapshots are read-only.\n // Otherwise tests that exercise only a subset of a multi-conversation snapshot\n // would silently overwrite the file with that subset, breaking subsequent runs.\n if (this.state && process.env.GITHUB_ACTIONS !== \"true\") {\n await writeCapturesToDisk(this.exchanges, this.state);\n }\n\n this.state = {\n filePath: config.filePath,\n workDir: config.workDir,\n testInfo: config.testInfo,\n toolResultNormalizers: [...this.defaultToolResultNormalizers],\n };\n\n this.clearExchanges();\n await this.loadStoredData();\n }\n\n private async loadStoredData(): Promise {\n if (this.state && existsSync(this.state.filePath)) {\n const content = await readFile(this.state.filePath, \"utf-8\");\n this.state.storedData = yaml.parse(content) as NormalizedData;\n }\n }\n\n async stop(skipWritingCache?: boolean): Promise {\n await super.stop();\n\n // In CI mode we never write — the snapshots are read-only.\n if (\n this.state &&\n !skipWritingCache &&\n process.env.GITHUB_ACTIONS !== \"true\"\n ) {\n await writeCapturesToDisk(this.exchanges, this.state);\n }\n }\n\n addToolResultNormalizer(\n toolName: string,\n normalizer: (result: string) => string,\n ) {\n if (!this.state) {\n throw new Error(\n \"ReplayingCapiProxy not yet initialized. Cannot add tool result normalizer.\",\n );\n }\n\n this.state.toolResultNormalizers.push({ toolName, normalizer });\n }\n\n /**\n * Register a per-token response for the `/copilot_internal/user` endpoint.\n * When a request with `Authorization: Bearer ` arrives, the matching response is returned.\n */\n setCopilotUserByToken(token: string, response: CopilotUserResponse): void {\n this.copilotUserByToken.set(token, response);\n }\n\n override performRequest(options: PerformRequestOptions): void {\n void iife(async () => {\n const commonResponseHeaders = {\n \"x-github-request-id\": \"some-request-id\",\n };\n\n try {\n // Handle /copilot-user-config endpoint for configuring per-token user responses\n if (\n options.requestOptions.path === \"/copilot-user-config\" &&\n options.requestOptions.method === \"POST\"\n ) {\n const config = JSON.parse(options.body!) as { token: string; response: CopilotUserResponse };\n this.copilotUserByToken.set(config.token, config.response);\n options.onResponseStart(200, {});\n options.onResponseEnd();\n return;\n }\n\n // Handle /config endpoint for updating proxy configuration\n if (\n options.requestOptions.path === \"/config\" &&\n options.requestOptions.method === \"POST\"\n ) {\n await this.updateConfig(JSON.parse(options.body!));\n options.onResponseStart(200, {});\n options.onResponseEnd();\n return;\n }\n\n // Handle /stop endpoint for stopping the proxy\n if (\n options.requestOptions.path?.startsWith(\"/stop\") &&\n options.requestOptions.method === \"POST\"\n ) {\n const skipWritingCache = options.requestOptions.path.includes(\n \"skipWritingCache=true\",\n );\n options.onResponseStart(200, {});\n options.onResponseEnd();\n await this.stop(skipWritingCache);\n process.exit(0);\n }\n\n // Handle /exchanges endpoint for retrieving captured exchanges\n if (\n options.requestOptions.path === \"/exchanges\" &&\n options.requestOptions.method === \"GET\"\n ) {\n const chatCompletionExchanges = this.exchanges.filter(\n (e) => e.request.url === chatCompletionEndpoint,\n );\n const parsedExchanges = await Promise.all(\n chatCompletionExchanges.map((e) =>\n parseHttpExchange(e.request.body, e.response?.body, e.request.headers),\n ),\n );\n options.onResponseStart(200, {});\n options.onData(Buffer.from(JSON.stringify(parsedExchanges)));\n options.onResponseEnd();\n return;\n }\n\n const state = this.state;\n if (!state) {\n throw new Error(\n \"ReplayingCapiProxy not yet initialized. Either pass filePath and workDir to the constructor, \" +\n \"or post configuration to /config before making other HTTP requests.\",\n );\n }\n\n // Handle /models endpoint\n // Use stored models if available, otherwise use default model\n if (options.requestOptions.path === \"/models\") {\n const models =\n state.storedData?.models && state.storedData.models.length > 0\n ? state.storedData.models\n : [defaultModel];\n const modelsResponse = createGetModelsResponse(models);\n const body = JSON.stringify(modelsResponse);\n const headers = {\n \"content-type\": \"application/json\",\n ...commonResponseHeaders,\n };\n options.onResponseStart(200, headers);\n options.onData(Buffer.from(body));\n options.onResponseEnd();\n return;\n }\n\n // Handle /copilot_internal/user endpoint for per-session auth\n if (options.requestOptions.path === \"/copilot_internal/user\") {\n const authHeader = options.requestOptions.headers?.[\"authorization\"] as string | undefined;\n const token = authHeader?.replace(\"Bearer \", \"\");\n const userResponse = token ? this.copilotUserByToken.get(token) : undefined;\n if (userResponse) {\n const headers = {\n \"content-type\": \"application/json\",\n ...commonResponseHeaders,\n };\n options.onResponseStart(200, headers);\n options.onData(Buffer.from(JSON.stringify(userResponse)));\n options.onResponseEnd();\n } else {\n options.onResponseStart(401, commonResponseHeaders);\n options.onData(Buffer.from(JSON.stringify({ message: \"Bad credentials\" })));\n options.onResponseEnd();\n }\n return;\n }\n\n // Handle memory endpoints - return stub responses in tests\n // Matches: /agents/*/memory/*/enabled, /agents/*/memory/*/recent, etc.\n if (options.requestOptions.path?.match(/\\/agents\\/.*\\/memory\\//)) {\n let body: string;\n if (options.requestOptions.path.includes(\"/enabled\")) {\n body = JSON.stringify({ enabled: false });\n } else if (options.requestOptions.path.includes(\"/recent\")) {\n body = JSON.stringify({ memories: [] });\n } else {\n body = JSON.stringify({});\n }\n const headers = {\n \"content-type\": \"application/json\",\n ...commonResponseHeaders,\n };\n options.onResponseStart(200, headers);\n options.onData(Buffer.from(body));\n options.onResponseEnd();\n return;\n }\n\n // Handle /chat/completions endpoint\n if (\n state.storedData &&\n options.requestOptions.path === chatCompletionEndpoint &&\n options.body\n ) {\n const savedResponse = await findSavedChatCompletionResponse(\n state.storedData,\n options.body,\n state.workDir,\n state.toolResultNormalizers,\n );\n\n if (savedResponse) {\n const streamingIsRequested =\n options.body &&\n (JSON.parse(options.body) as { stream?: boolean }).stream ===\n true;\n\n if (streamingIsRequested) {\n const headers = {\n \"content-type\": \"text/event-stream\",\n ...commonResponseHeaders,\n };\n options.onResponseStart(200, headers);\n for (const chunk of convertToStreamingResponseChunks(\n savedResponse,\n )) {\n options.onData(\n Buffer.from(`data: ${JSON.stringify(chunk)}\\n\\n`),\n );\n if (this.slowStreaming) {\n await sleep(100);\n }\n }\n options.onData(Buffer.from(\"data: [DONE]\\n\\n\"));\n options.onResponseEnd();\n } else {\n const body = JSON.stringify(savedResponse);\n const headers = {\n \"content-type\": \"application/json\",\n ...commonResponseHeaders,\n };\n options.onResponseStart(200, headers);\n options.onData(Buffer.from(body));\n options.onResponseEnd();\n }\n\n return;\n }\n\n // Check if this request matches a snapshot with no response (e.g., timeout tests).\n // If so, hang forever so the client-side timeout can trigger.\n if (\n await isRequestOnlySnapshot(\n state.storedData,\n options.body,\n state.workDir,\n state.toolResultNormalizers,\n )\n ) {\n const streamingIsRequested =\n options.body &&\n (JSON.parse(options.body) as { stream?: boolean }).stream ===\n true;\n const headers = {\n \"content-type\": streamingIsRequested\n ? \"text/event-stream\"\n : \"application/json\",\n ...commonResponseHeaders,\n };\n options.onResponseStart(200, headers);\n // Never call onResponseEnd - hang indefinitely for timeout tests.\n // Returning here keeps the HTTP response open without leaking a pending Promise.\n return;\n }\n }\n\n // Beyond this point, we're only going to be able to supply responses in CI if we have a snapshot,\n // and we only store snapshots for chat completion. For anything else (e.g., custom-agents fetches),\n // return 404 so the CLI treats them as unavailable instead of erroring.\n if (options.requestOptions.path !== chatCompletionEndpoint) {\n const headers = {\n \"content-type\": \"application/json\",\n \"x-github-request-id\": \"proxy-not-found\",\n };\n options.onResponseStart(404, headers);\n options.onData(\n Buffer.from(JSON.stringify({ error: \"Not found by test proxy\" })),\n );\n options.onResponseEnd();\n return;\n }\n\n // Fallback to normal proxying if no cached response found\n // This implicitly captures the new exchange too\n const isCI = process.env.GITHUB_ACTIONS === \"true\";\n if (isCI) {\n await exitWithNoMatchingRequestError(\n options,\n state.testInfo,\n state.workDir,\n state.toolResultNormalizers,\n state.storedData,\n );\n return;\n }\n super.performRequest(options);\n } catch (err) {\n options.onError(err as Error | string);\n }\n });\n }\n}\n\nasync function writeCapturesToDisk(\n exchanges: readonly CapturedExchange[],\n state: ReplayingCapiProxyState,\n) {\n const data = await transformHttpExchanges(\n exchanges,\n state.workDir,\n state.toolResultNormalizers,\n );\n if (data.conversations.length > 0) {\n let yamlText = yaml.stringify(data, { lineWidth: 120 });\n\n // We have to normalize line endings explicitly, because yaml.stringify uses Unix-style even on Windows,\n // and Git will restore the files with CRLF on Windows so they will appear to be changed\n if (process.platform === \"win32\") {\n yamlText = yamlText.replace(/\\r?\\n/g, \"\\r\\n\");\n }\n\n await mkdir(path.dirname(state.filePath), { recursive: true });\n await writeFileIfDifferent(state.filePath, yamlText);\n }\n}\n\n/**\n * Produces a human-readable explanation of why no stored conversation matched\n * a given request. For each stored conversation it reports the first reason\n * matching failed, mirroring the logic in {@link findAssistantIndexAfterPrefix}.\n */\nfunction diagnoseMatchFailure(\n requestMessages: NormalizedMessage[],\n rawMessages: unknown[],\n storedData: NormalizedData | undefined,\n): string {\n const lines: string[] = [];\n lines.push(`Request has ${requestMessages.length} normalized messages (${rawMessages.length} raw).`);\n\n if (!storedData || storedData.conversations.length === 0) {\n lines.push(\"No stored conversations to match against.\");\n return lines.join(\"\\n\");\n }\n\n for (let c = 0; c < storedData.conversations.length; c++) {\n const saved = storedData.conversations[c].messages;\n\n // Same check as findAssistantIndexAfterPrefix: request must be a strict prefix\n if (requestMessages.length >= saved.length) {\n lines.push(\n `Conversation ${c} (${saved.length} messages): ` +\n `skipped — request has ${requestMessages.length} messages, need fewer than ${saved.length}.`,\n );\n continue;\n }\n\n // Find the first message that doesn't match\n let mismatchIndex = -1;\n for (let i = 0; i < requestMessages.length; i++) {\n if (JSON.stringify(requestMessages[i]) !== JSON.stringify(saved[i])) {\n mismatchIndex = i;\n break;\n }\n }\n\n if (mismatchIndex >= 0) {\n const raw = mismatchIndex < rawMessages.length\n ? JSON.stringify(rawMessages[mismatchIndex]).slice(0, 300)\n : \"(no raw message)\";\n lines.push(\n `Conversation ${c} (${saved.length} messages): mismatch at message ${mismatchIndex}:`,\n ` request: ${JSON.stringify(requestMessages[mismatchIndex]).slice(0, 200)}`,\n ` saved: ${JSON.stringify(saved[mismatchIndex]).slice(0, 200)}`,\n ` raw (pre-normalization): ${raw}`,\n );\n } else {\n // Prefix matched, but the next saved message isn't an assistant turn\n const nextRole = saved[requestMessages.length]?.role ?? \"(end of conversation)\";\n lines.push(\n `Conversation ${c} (${saved.length} messages): ` +\n `prefix matched, but next saved message is \"${nextRole}\" (need \"assistant\").`,\n );\n }\n }\n\n return lines.join(\"\\n\");\n}\n\nasync function exitWithNoMatchingRequestError(\n options: PerformRequestOptions,\n testInfo: { file: string; line?: number } | undefined,\n workDir: string,\n toolResultNormalizers: ToolResultNormalizer[],\n storedData?: NormalizedData,\n) {\n let diagnostics: string;\n try {\n const normalized = await parseAndNormalizeRequest(options.body, workDir, toolResultNormalizers);\n const requestMessages = normalized.conversations[0]?.messages ?? [];\n\n let rawMessages: unknown[] = [];\n try {\n rawMessages = (JSON.parse(options.body ?? \"{}\") as { messages?: unknown[] }).messages ?? [];\n } catch { /* non-JSON body */ }\n\n diagnostics = diagnoseMatchFailure(requestMessages, rawMessages, storedData);\n } catch (e) {\n diagnostics = `(unable to parse request for diagnostics: ${e})`;\n }\n\n const errorMessage =\n `No cached response found for ${options.requestOptions.method} ${options.requestOptions.path}.\\n${diagnostics}`;\n\n // Format as GitHub Actions annotation when test location is available\n const annotation = [\n testInfo?.file ? `file=${testInfo.file}` : \"\",\n typeof testInfo?.line === \"number\" ? `line=${testInfo.line}` : \"\",\n ].filter(Boolean).join(\",\");\n process.stderr.write(`::error${annotation ? ` ${annotation}` : \"\"}::${errorMessage}\\n`);\n\n options.onError(new Error(errorMessage));\n}\n\nasync function findSavedChatCompletionResponse(\n storedData: NormalizedData,\n requestBody: string | undefined,\n workDir: string,\n toolResultNormalizers: ToolResultNormalizer[],\n): Promise {\n // Normalize the incoming request the same way we normalize for caching\n const normalized = await parseAndNormalizeRequest(\n requestBody,\n workDir,\n toolResultNormalizers,\n );\n const requestMessages = normalized.conversations[0]?.messages ?? [];\n const requestModel = normalized.models[0];\n if (!requestModel) {\n throw new Error(\"Unable to determine model from request\");\n }\n\n // Now find a matching cached conversation (i.e., one for which this request is a prefix)\n for (const conversation of storedData.conversations) {\n const replyIndex = findAssistantIndexAfterPrefix(\n requestMessages,\n conversation.messages,\n );\n if (replyIndex !== undefined) {\n return createOpenAIResponse(\n requestModel,\n conversation.messages,\n replyIndex,\n workDir,\n );\n }\n }\n\n return undefined;\n}\n\n// Checks if the request matches a snapshot that has no assistant response.\n// This handles timeout test scenarios where the snapshot only records the request.\nasync function isRequestOnlySnapshot(\n storedData: NormalizedData,\n requestBody: string | undefined,\n workDir: string,\n toolResultNormalizers: ToolResultNormalizer[],\n): Promise {\n const normalized = await parseAndNormalizeRequest(\n requestBody,\n workDir,\n toolResultNormalizers,\n );\n const requestMessages = normalized.conversations[0]?.messages ?? [];\n\n for (const conversation of storedData.conversations) {\n if (\n requestMessages.length === conversation.messages.length &&\n requestMessages.every(\n (msg, i) =>\n JSON.stringify(msg) === JSON.stringify(conversation.messages[i]),\n )\n ) {\n return true;\n }\n }\n return false;\n}\n\nasync function parseAndNormalizeRequest(\n requestBody: string | undefined,\n workDir: string,\n toolResultNormalizers: ToolResultNormalizer[],\n) {\n const fakeRequest = {\n request: { url: chatCompletionEndpoint, body: requestBody },\n } as CapturedExchange;\n return await transformHttpExchanges(\n [fakeRequest],\n workDir,\n toolResultNormalizers,\n );\n}\n\n// Takes raw HTTP traffic and turns it into the normalized form that we store on disk\nasync function transformHttpExchanges(\n httpExchanges: readonly CapturedExchange[],\n workDir: string,\n toolResultNormalizers: ToolResultNormalizer[],\n): Promise {\n const chatCompletionExchanges = httpExchanges\n .filter((e) => e.request.url === chatCompletionEndpoint)\n .filter(excludeFailedResponses);\n const allTurns = await Promise.all(\n chatCompletionExchanges.map((e) =>\n transformHttpExchange(e.request.body, e.response?.body),\n ),\n );\n const dedupedExchanges = removePrefixConversations(\n allTurns.map((t) => t.conversation),\n );\n const dedupedModels = new Set(\n allTurns.map((t) => t.model ?? \"\").filter((m) => !!m),\n );\n\n normalizeToolCalls(dedupedExchanges, toolResultNormalizers);\n normalizeFilenames(dedupedExchanges, workDir);\n return { models: Array.from(dedupedModels), conversations: dedupedExchanges };\n}\n\nfunction normalizeFilenames(\n conversations: NormalizedConversation[],\n workDir: string,\n): void {\n // Replace occurrences of the workDir path with workingDirPlaceholder to avoid diffs due to different test run locations\n // We do so case-insensitively and with both / and \\ to cover different OSes\n // We also normalize any slashes in the rest of the path (e.g., C:\\my\\workdir\\path\\to\\file.txt -> ${workdir}/path/to/file.txt)\n workDir = workDir.replace(/\\\\/g, \"/\").replace(/\\/+$/, \"\");\n const escaped = workDir.replace(/[.*+?^${}()|[\\]\\\\]/g, \"\\\\$&\");\n const workDirPattern = new RegExp(\n escaped.replace(/\\//g, \"[\\\\\\\\/]+\") + \"([\\\\\\\\/]+[^\\\\s\\\"'`,]*)?\",\n \"gi\",\n );\n const workDirReplacer = (_: string, rest?: string) =>\n workingDirPlaceholder + (rest?.replace(/[\\\\/]+/g, \"/\") ?? \"\");\n\n // Match non-rooted Windows paths like abc\\def\\something.ext and flip slashes to /\n // We don't need to match absolute paths because the only legit ones should be inside workdir which\n // is handled above. Plus there's nothing we could do to normalize them since we don't know their base.\n const windowsFnPattern =\n /(?\n path.replace(/\\\\/g, \"/\");\n\n for (const conv of conversations) {\n for (const msg of conv.messages) {\n if (msg.content) {\n msg.content = msg.content.replace(workDirPattern, workDirReplacer);\n msg.content = msg.content.replace(windowsFnPattern, windowsFnReplacer);\n }\n for (const tc of msg.tool_calls ?? []) {\n if (tc.function?.arguments) {\n tc.function.arguments = tc.function.arguments.replace(\n workDirPattern,\n workDirReplacer,\n );\n tc.function.arguments = tc.function.arguments.replace(\n windowsFnPattern,\n windowsFnReplacer,\n );\n }\n }\n }\n }\n}\n\nfunction normalizeToolCalls(\n conversations: NormalizedConversation[],\n resultNormalizers: ToolResultNormalizer[],\n) {\n // We normalize:\n // - Tool call IDs (mapping from tooluse_rjaaFdJRRhqAZevU_1aBSA etc to toolcall_0, toolcall_1, etc)\n // - Tool names (e.g., bash/powershell -> ${shell})\n // - Tool call results that may vary between execution environments\n // This is so that we're not storing random or environment-specific data in snapshots, and so we can\n // still match cached responses even if these details change.\n for (const conv of conversations) {\n const idMap = new Map();\n const precedingMessages: NormalizedMessage[] = [];\n let counter = 0;\n for (const msg of conv.messages) {\n for (const tc of msg.tool_calls ?? []) {\n // Normalize ID in tool calls\n idMap.set(tc.id, (tc.id = idMap.get(tc.id) ?? `toolcall_${counter++}`));\n\n // Normalize name\n const originalToolName = tc.function?.name;\n const normalizedToolName =\n originalToolName && normalizedToolNames[originalToolName];\n if (normalizedToolName) {\n tc.function!.name = normalizedToolName;\n }\n }\n\n if (msg.role === \"tool\" && msg.tool_call_id) {\n // Normalize ID in tool results\n msg.tool_call_id = idMap.get(msg.tool_call_id) ?? msg.tool_call_id;\n\n // Normalize result\n if (msg.content) {\n const precedingToolCall = precedingMessages\n .flatMap((m) => m.tool_calls ?? [])\n .find((tc) => tc.id === msg.tool_call_id);\n if (precedingToolCall) {\n for (const normalizer of resultNormalizers) {\n if (\n precedingToolCall.function?.name === normalizer.toolName ||\n normalizer.toolName === \"*\"\n ) {\n msg.content = normalizer.normalizer(msg.content);\n }\n }\n }\n }\n }\n\n precedingMessages.push(msg);\n }\n }\n}\n\n// As we capture LLM calls, we see:\n// - Request A, response AB\n// - Request ABC, response ABCD\n// - Request ABCDE, response ABCDEF\n// Among these, it's only necessary to keep the longest conversation (ABCDEF) since this contains all\n// information from the shorter ones. Avoiding duplication makes it reasonable for humans to reason\n// about diffs in the stored conversations when things change.\nfunction removePrefixConversations(\n conversations: NormalizedConversation[],\n): NormalizedConversation[] {\n const result = [...conversations];\n for (let i = result.length - 1; i >= 0; i--) {\n for (let j = i - 1; j >= 0; j--) {\n if (isPrefix(result[j].messages, result[i].messages)) {\n result.splice(j, 1);\n i--; // adjust index since we removed an element before current position\n }\n }\n }\n return result;\n}\n\nfunction isPrefix(\n shorter: NormalizedMessage[],\n longer: NormalizedMessage[],\n): boolean {\n if (shorter.length >= longer.length) {\n return false;\n }\n return shorter.every(\n (msg, idx) => JSON.stringify(msg) === JSON.stringify(longer[idx]),\n );\n}\n\nasync function parseHttpExchange(\n requestBody: string,\n responseBody: string | undefined,\n requestHeaders?: Record,\n): Promise {\n const request = JSON.parse(requestBody) as ChatCompletionCreateParamsBase;\n const response = await parseOpenAIResponse(responseBody);\n return { request, response, requestHeaders };\n}\n\n// Converts a single HTTP exchange (request + response) into a normalized conversation\nasync function transformHttpExchange(\n requestBody: string,\n responseBody: string | undefined,\n): Promise<{ conversation: NormalizedConversation; model?: string }> {\n const { request, response } = await parseHttpExchange(\n requestBody,\n responseBody,\n );\n const messages = request.messages.map(transformOpenAIRequestMessage);\n\n if (response?.choices?.length) {\n messages.push(...transformOpenAIResponseChoice(response.choices));\n }\n\n return { conversation: { messages }, model: request.model };\n}\n\n// Transforms a single OpenAI-style outbound request message into normalized form\n// We use this to look up whether we already have a cached response for it\nfunction transformOpenAIRequestMessage(\n m: ChatCompletionMessageParam,\n): NormalizedMessage {\n let content: string | undefined;\n if (m.role === \"system\") {\n // System message changes too often to include in snapshots - just store placeholder\n content = \"${system}\";\n } else if (m.role === \"user\" && typeof m.content === \"string\") {\n content = normalizeUserMessage(m.content);\n } else if (m.role === \"user\" && Array.isArray(m.content)) {\n // Multimodal user messages have array content with text and image_url parts.\n // Extract and normalize text parts; represent image_url parts as a stable marker.\n const parts: string[] = [];\n for (const part of m.content) {\n if (typeof part === \"object\" && part.type === \"text\" && typeof part.text === \"string\") {\n parts.push(normalizeUserMessage(part.text));\n } else if (typeof part === \"object\" && part.type === \"image_url\") {\n parts.push(\"[image]\");\n }\n }\n content = parts.join(\"\\n\") || undefined;\n } else if (m.role === \"tool\" && typeof m.content === \"string\") {\n // If it's a JSON tool call result, normalize the whitespace and property ordering.\n // For successful tool results wrapped in {resultType, textResultForLlm}, unwrap to\n // just the inner value so snapshots stay stable across envelope format changes.\n try {\n const parsed = JSON.parse(m.content);\n if (\n parsed &&\n typeof parsed === \"object\" &&\n parsed.resultType === \"success\" &&\n \"textResultForLlm\" in parsed\n ) {\n content = typeof parsed.textResultForLlm === \"string\"\n ? parsed.textResultForLlm\n : JSON.stringify(sortJsonKeys(parsed.textResultForLlm));\n } else {\n content = JSON.stringify(sortJsonKeys(parsed));\n }\n } catch {\n content = m.content.trim();\n }\n } else if (typeof m.content === \"string\") {\n content = m.content;\n }\n\n const msg: NormalizedMessage = { role: m.role };\n if (\"tool_call_id\" in m && m.tool_call_id) {\n msg.tool_call_id = m.tool_call_id;\n }\n if (content) msg.content = content;\n if (\"tool_calls\" in m && m.tool_calls?.length) {\n msg.tool_calls = m.tool_calls.map(transformOpenAIToolCall);\n }\n return msg;\n}\n\nfunction normalizeUserMessage(content: string): string {\n return content\n .replace(/.*?<\\/current_datetime>/g, \"\")\n .replace(/[\\s\\S]*?<\\/reminder>/g, \"\")\n .replace(/[\\s\\S]*?<\\/system_reminder>/g, \"\")\n .replace(/[\\s\\S]*?<\\/agent_instructions>/g, \"\")\n .replace(\n /Please create a detailed summary of the conversation so far\\. The history is being compacted[\\s\\S]*/,\n \"${compaction_prompt}\",\n )\n .trim();\n}\n\nfunction normalizeLargeOutputFilepaths(result: string): string {\n // Replaces filenames like 1774637043987-copilot-tool-output-tk7puw.txt with PLACEHOLDER-copilot-tool-output-PLACEHOLDER\n return result\n .replace(\n /\\d+-copilot-tool-output-[a-z0-9.]+/g,\n \"PLACEHOLDER-copilot-tool-output-PLACEHOLDER\",\n )\n .replace(\n /(?:[A-Za-z]:)?[^\\s\"'`]*[\\\\/]session-state[\\\\/]temp[\\\\/]PLACEHOLDER-copilot-tool-output-PLACEHOLDER/g,\n \"/session-state/temp/PLACEHOLDER-copilot-tool-output-PLACEHOLDER\",\n );\n}\n\n// The `gh` CLI emits different \"not authenticated\" help text depending on the\n// environment (local dev vs. inside GitHub Actions). Normalize both forms to a\n// stable placeholder so snapshots don't drift between environments.\nfunction normalizeGhAuthMessages(result: string): string {\n let normalized = result;\n // GitHub Actions form\n normalized = normalized.replace(\n /gh: To use GitHub CLI in a GitHub Actions workflow, set the GH_TOKEN environment variable\\. Example:\\s*\\n\\s*env:\\s*\\n\\s*GH_TOKEN: \\$\\{\\{ github\\.token \\}\\}/g,\n \"${gh_auth_required}\",\n );\n // Local dev form\n normalized = normalized.replace(\n /To get started with GitHub CLI, please run:\\s*gh auth login\\s*\\n\\s*Alternatively, populate the GH_TOKEN environment variable with a GitHub API authentication token\\./g,\n \"${gh_auth_required}\",\n );\n return normalized;\n}\n\n// Transforms a single OpenAI-style inbound response message into normalized form\nfunction transformOpenAIResponseChoice(\n choices: ChatCompletion.Choice[],\n): NormalizedMessage[] {\n // Maps each choice to a separate assistant message.\n // This is clearly wrong, since choices are meant to be alternatives (from which the client\n // should pick one). However CAPI frequently returns collections of tool calls as separate choices,\n // and our chat-completion-client.ts logic handles this by treating them as sequential messages.\n // So, we have to do the same thing here.\n return choices.map((choice) => {\n const tool_calls =\n choice.message.tool_calls?.map(transformOpenAIToolCall) ?? [];\n const msg: NormalizedMessage = { role: \"assistant\" };\n msg.content = choice.message.content ?? undefined;\n msg.refusal = choice.message.refusal ?? undefined;\n if (tool_calls.length) msg.tool_calls = tool_calls;\n return msg;\n });\n}\n\nfunction transformOpenAIToolCall(tc: {\n id: string;\n type: string;\n function?: { name: string; arguments: string };\n}): NormalizedToolCall {\n return {\n id: tc.id,\n type: tc.type,\n function: tc.function && {\n name: tc.function.name,\n arguments: normalizeToolCallArguments(tc.function.arguments),\n },\n };\n}\n\nfunction normalizeToolCallArguments(args: string): string {\n if (!args || args.trim() === \"\") {\n return \"{}\";\n }\n try {\n return JSON.stringify(JSON.parse(args));\n } catch {\n return args;\n }\n}\n\n// Takes raw HTTP response data and turns it into an OpenAI ChatCompletion object, regardless of whether\n// it's a streaming or non-streaming response\nasync function parseOpenAIResponse(\n responseBody: string | undefined,\n): Promise {\n // Check if it's a streaming response (Server-Sent Events format)\n if (responseBody?.startsWith(\"data:\")) {\n const lines = responseBody\n .split(\"\\n\")\n .filter((line) => line.startsWith(\"data:\") && !line.includes(\"[DONE]\"));\n const chunks = lines.map(\n (line) => JSON.parse(line.slice(5)) as ChatCompletionChunk,\n );\n\n // Convert the sequence of chunks into a final ChatCompletion object\n // TODO: Do we need to apply fixCAPIStreamingToolCalling normalization here?\n const readableStream = new ReadableStream({\n async start(controller) {\n for (const chunk of chunks) {\n controller.enqueue(\n new TextEncoder().encode(JSON.stringify(chunk) + \"\\n\"),\n );\n }\n controller.close();\n },\n });\n\n return await ChatCompletionStream.fromReadableStream(\n readableStream,\n ).finalChatCompletion();\n } else if (responseBody) {\n return JSON.parse(responseBody) as ChatCompletion;\n }\n}\n\n// Checks if requestMessages is a prefix of savedMessages,\n// and returns the index of the next assistant message if found.\nfunction findAssistantIndexAfterPrefix(\n requestMessages: NormalizedMessage[],\n savedMessages: NormalizedMessage[],\n): number | undefined {\n if (requestMessages.length >= savedMessages.length) {\n return undefined;\n }\n\n for (let i = 0; i < requestMessages.length; i++) {\n const reqMsg = JSON.stringify(requestMessages[i]);\n const savedMsg = JSON.stringify(savedMessages[i]);\n if (reqMsg !== savedMsg) {\n return undefined;\n }\n }\n\n // The next message after the prefix should be an assistant message\n const nextIndex = requestMessages.length;\n if (\n nextIndex < savedMessages.length &&\n savedMessages[nextIndex].role === \"assistant\"\n ) {\n return nextIndex;\n }\n\n return undefined;\n}\n\nfunction expandWorkDir(\n content: string | undefined,\n workDir: string,\n jsonEscape: boolean,\n): string | undefined {\n if (!content) {\n return content;\n }\n\n const workDirValue = jsonEscape\n ? JSON.stringify(workDir).replaceAll('\"', \"\")\n : workDir;\n return content.replace(/\\$\\{workdir\\}/g, workDirValue);\n}\n\nfunction expandToolName(name: string): string {\n for (const [fullName, normalized] of Object.entries(normalizedToolNames)) {\n if (name === normalized) {\n return fullName;\n }\n }\n\n return name;\n}\n\n// Turns a normalized message back into a full OpenAI ChatCompletion that we can replay as a response\nfunction createOpenAIResponse(\n model: string,\n messages: NormalizedMessage[],\n responseStartIndex: number,\n workDir: string,\n): ChatCompletion {\n // Here we recreate the strange CAPI/productcode behavior of using multiple choices to represent\n // multiple assistant messages in a row. This is the inverse of the logic in transformOpenAIResponseChoice().\n // So, find all successive assistant messages starting from responseStartIndex.\n const choices: ChatCompletion.Choice[] = [];\n for (\n let index = 0;\n messages[responseStartIndex + index]?.role === \"assistant\";\n index++\n ) {\n const assistantMessage = messages[responseStartIndex + index];\n const toolCalls = assistantMessage.tool_calls?.map((tc, idx) => ({\n id: tc.id || `call_${idx}`,\n type: \"function\" as const,\n function: {\n name: expandToolName(tc.function?.name ?? \"\"),\n arguments: expandWorkDir(tc.function?.arguments, workDir, true) ?? \"{}\",\n },\n }));\n\n choices.push({\n index,\n message: {\n role: \"assistant\",\n content:\n expandWorkDir(assistantMessage.content, workDir, false) ?? null,\n refusal: assistantMessage.refusal ?? null,\n tool_calls: toolCalls,\n },\n finish_reason: toolCalls?.length ? \"tool_calls\" : \"stop\",\n logprobs: null,\n });\n }\n\n return {\n id: \"cached-completion\",\n object: \"chat.completion\",\n created: Math.floor(Date.now() / 1000),\n model,\n choices,\n usage: {\n prompt_tokens: 0,\n completion_tokens: 0,\n total_tokens: 0,\n },\n };\n}\n\nconst STREAM_CHUNK_SIZE = 200;\n\nfunction convertToStreamingResponseChunks(\n completion: ChatCompletion,\n): ChatCompletionChunk[] {\n const choice = completion.choices[0];\n const content = choice.message.content ?? \"\";\n const toolCalls = choice.message.tool_calls?.filter(\n (tc): tc is ChatCompletionMessageFunctionToolCall => tc.type === \"function\",\n );\n\n const makeChunk = (\n delta: ChatCompletionChunk.Choice.Delta,\n ): ChatCompletionChunk => ({\n id: completion.id,\n object: \"chat.completion.chunk\",\n created: completion.created,\n model: completion.model,\n choices: [{ index: 0, delta, finish_reason: null, logprobs: null }],\n });\n\n const chunks: ChatCompletionChunk[] = [];\n\n // Content chunks\n for (let i = 0; i < content.length; i += STREAM_CHUNK_SIZE) {\n chunks.push(\n makeChunk({\n role: \"assistant\",\n content: content.slice(i, i + STREAM_CHUNK_SIZE),\n }),\n );\n }\n\n // Tool call argument chunks\n for (const [tcIdx, tc] of (toolCalls ?? []).entries()) {\n const args = tc.function.arguments;\n for (let i = 0; i < args.length; i += STREAM_CHUNK_SIZE) {\n chunks.push(\n makeChunk({\n role: \"assistant\",\n tool_calls: [\n {\n index: tcIdx,\n id: tc.id,\n type: \"function\",\n function: {\n name: i === 0 ? tc.function.name : \"\",\n arguments: args.slice(i, i + STREAM_CHUNK_SIZE),\n },\n },\n ],\n }),\n );\n }\n }\n\n // Set finish_reason on last chunk\n if (chunks.length === 0) {\n chunks.push(makeChunk({ role: \"assistant\" }));\n }\n chunks[chunks.length - 1].choices[0].finish_reason = choice.finish_reason;\n\n return chunks;\n}\n\nfunction createGetModelsResponse(modelIds: string[]) {\n // Obviously the following might not match any given model. We could track the original responses from /models,\n // but that risks invalidating the caches too frequently and making this unmaintainable. If this approximation\n // turns out to be insufficient, we can tweak the logic here based on known model IDs.\n return {\n data: modelIds.map((id) => ({\n id,\n name: id,\n capabilities: {\n supports: { vision: true },\n limits: { max_context_window_tokens: 128000 },\n },\n })),\n };\n}\n\nasync function writeFileIfDifferent(filePath: string, contents: string) {\n if (existsSync(filePath)) {\n const existingContents = await readFile(filePath, \"utf-8\");\n if (existingContents === contents) {\n return;\n }\n }\n\n await writeFile(filePath, contents, \"utf-8\");\n}\n\nfunction excludeFailedResponses(exchange: CapturedExchange): boolean {\n const status = exchange.response?.statusCode;\n return status === undefined || (status >= 200 && status < 300);\n}\n\nexport type ToolResultNormalizer = {\n toolName: string;\n normalizer: (result: string) => string;\n};\n\n/**\n * Response shape for the `/copilot_internal/user` endpoint.\n * Used by per-session auth tests to mock GitHub identity resolution.\n */\nexport type CopilotUserResponse = {\n login: string;\n copilot_plan?: string;\n endpoints?: {\n api?: string;\n telemetry?: string;\n };\n analytics_tracking_id?: string;\n quota_snapshots?: Record<\n string,\n {\n entitlement?: number;\n overage_count?: number;\n overage_permitted?: boolean;\n percent_remaining?: number;\n timestamp_utc?: string;\n unlimited?: boolean;\n }\n >;\n};\n\nexport type ParsedHttpExchange = {\n request: ChatCompletionCreateParamsBase;\n response: ChatCompletion | undefined;\n requestHeaders?: Record;\n};\n\n// We want to be able to reuse the proxy across multiple tests, so it needs to be reconfigurable\n// and resettable on demand. By holding all state in one place it's easy to manage.\ntype ReplayingCapiProxyState = {\n filePath: string;\n workDir: string;\n testInfo?: { file: string; line?: number };\n storedData?: NormalizedData | undefined;\n toolResultNormalizers: ToolResultNormalizer[];\n};\n\ninterface NormalizedToolCall {\n id: string;\n type: string;\n function?: {\n name: string;\n arguments: string;\n };\n}\n\ninterface NormalizedMessage {\n role: string;\n content?: string;\n refusal?: string;\n tool_calls?: NormalizedToolCall[];\n tool_call_id?: string;\n}\n\ninterface NormalizedConversation {\n messages: NormalizedMessage[];\n}\n\nexport interface NormalizedData {\n models: string[];\n conversations: NormalizedConversation[];\n}\n\nfunction sortJsonKeys(obj: unknown): unknown {\n if (Array.isArray(obj)) return obj.map(sortJsonKeys);\n if (obj && typeof obj === \"object\") {\n return Object.keys(obj)\n .sort()\n .reduce(\n (acc, key) => {\n acc[key] = sortJsonKeys((obj as Record)[key]);\n return acc;\n },\n {} as Record,\n );\n }\n return obj;\n}\n" }, { "path": "test/harness/server.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport { ReplayingCapiProxy } from \"./replayingCapiProxy\";\n\n// Starts up an instance of the ReplayingCapiProxy server\n// The intention is for this to be usable in E2E tests across all languages\n\nconst proxy = new ReplayingCapiProxy(\"https://api.githubcopilot.com\");\nconst proxyUrl = await proxy.start();\n\nconsole.log(`Listening: ${proxyUrl}`);\n" }, { "path": "test/harness/test-mcp-server.mjs", "content": "#!/usr/bin/env node\n/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\n/**\n * Minimal MCP server that exposes a `get_env` tool.\n * Returns the value of a named environment variable from this process.\n * Used by SDK E2E tests to verify that literal env values reach MCP server subprocesses.\n *\n * Usage: npx tsx test-mcp-server.mjs\n */\n\nimport { McpServer } from \"@modelcontextprotocol/sdk/server/mcp.js\";\nimport { StdioServerTransport } from \"@modelcontextprotocol/sdk/server/stdio.js\";\nimport { z } from \"zod\";\n\nconst server = new McpServer({ name: \"env-echo\", version: \"1.0.0\" });\n\nserver.tool(\n \"get_env\",\n \"Returns the value of the specified environment variable.\",\n { name: z.string().describe(\"Environment variable name\") },\n async ({ name }) => ({\n content: [{ type: \"text\", text: process.env[name] ?? \"\" }],\n }),\n);\n\nconst transport = new StdioServerTransport();\nawait server.connect(transport);\n\n" }, { "path": "test/harness/tsconfig.json", "content": "{\n \"compilerOptions\": {\n \"target\": \"ES2022\",\n \"module\": \"esnext\",\n \"moduleResolution\": \"node\",\n \"esModuleInterop\": true,\n \"strict\": true,\n \"skipLibCheck\": true,\n \"noEmit\": true,\n \"types\": [\"node\"]\n },\n \"include\": [\"*.ts\"]\n}\n" }, { "path": "test/harness/util.ts", "content": "/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/\n\nimport type { SessionOptions } from \"@github/copilot/sdk\";\n\nexport function iife(fn: () => Promise): Promise {\n return fn();\n}\n\nexport function sleep(ms: number): Promise {\n return new Promise((resolve) => setTimeout(resolve, ms));\n}\n\ntype ShellConfigType = NonNullable;\n\n/**\n * Shell configuration for platform-specific tool names.\n * Values duplicated from SDK since ShellConfig class isn't exported as a runtime value.\n */\nexport const ShellConfig: {\n powerShell: ShellConfigType;\n bash: ShellConfigType;\n} = {\n powerShell: {\n shellToolName: \"powershell\",\n readShellToolName: \"read_powershell\",\n writeShellToolName: \"write_powershell\",\n } as ShellConfigType,\n bash: {\n shellToolName: \"bash\",\n readShellToolName: \"read_bash\",\n writeShellToolName: \"write_bash\",\n } as ShellConfigType,\n};\n" }, { "path": "test/harness/vitest.config.ts", "content": "import { defineConfig } from \"vitest/config\";\n\nexport default defineConfig({\n test: {\n globals: true,\n environment: \"node\",\n name: \"e2e_harness\",\n },\n});\n" }, { "path": "test/scenarios/.gitignore", "content": "# Dependencies\nnode_modules/\n.venv/\nvendor/\n\n# E2E run artifacts (agents may create files during verify.sh runs)\n**/sessions/**/plan.md\n**/tools/**/plan.md\n**/callbacks/**/plan.md\n**/prompts/**/plan.md\n\n# Build output\ndist/\ntarget/\nbuild/\n*.exe\n*.dll\n*.so\n*.dylib\n\n# Go\n*.test\nfully-bundled-go\napp-direct-server-go\ncontainer-proxy-go\ncontainer-relay-go\napp-backend-to-server-go\ncustom-agents-go\nmcp-servers-go\nno-tools-go\nvirtual-filesystem-go\nsystem-message-go\nskills-go\nstreaming-go\nattachments-go\ntool-filtering-go\npermissions-go\nhooks-go\nuser-input-go\nconcurrent-sessions-go\nsession-resume-go\nstdio-go\ntcp-go\ngh-app-go\ncli-preset-go\nfilesystem-preset-go\nminimal-preset-go\ndefault-go\nminimal-go\n\n# Python\n__pycache__/\n*.pyc\n*.pyo\n*.egg-info/\n*.egg\n.eggs/\n\n# TypeScript\n*.tsbuildinfo\npackage-lock.json\n\n# C# / .NET\nbin/\nobj/\n*.csproj.nuget.*\n\n# IDE / OS\n.DS_Store\n.idea/\n.vscode/\n*.swp\n*.swo\n*~\n\n# Multi-user scenario temp directories\n**/sessions/multi-user-long-lived/tmp/\n\n# Logs\n*.log\nnpm-debug.log*\ninfinite-sessions-go\nreasoning-effort-go\nreconnect-go\nbyok-openai-go\ntoken-sources-go\n" }, { "path": "test/scenarios/README.md", "content": "# SDK E2E Scenario Tests\n\nEnd-to-end scenario tests for the Copilot SDK. Each scenario demonstrates a specific SDK capability with implementations in TypeScript, Python, and Go.\n\n## Structure\n\n```\nscenarios/\n├── auth/ # Authentication flows (OAuth, BYOK, token sources)\n├── bundling/ # Deployment architectures (stdio, TCP, containers)\n├── callbacks/ # Lifecycle hooks, permissions, user input\n├── modes/ # Preset modes (CLI, filesystem, minimal)\n├── prompts/ # Prompt configuration (attachments, system messages, reasoning)\n├── sessions/ # Session management (streaming, resume, concurrent, infinite)\n├── tools/ # Tool capabilities (custom agents, MCP, skills, filtering)\n├── transport/ # Wire protocols (stdio, TCP, WASM, reconnect)\n└── verify.sh # Run all scenarios\n```\n\n## Running\n\nRun all scenarios:\n\n```bash\nCOPILOT_CLI_PATH=/path/to/copilot GITHUB_TOKEN=$(gh auth token) bash verify.sh\n```\n\nRun a single scenario:\n\n```bash\nCOPILOT_CLI_PATH=/path/to/copilot GITHUB_TOKEN=$(gh auth token) bash //verify.sh\n```\n\n## Prerequisites\n\n- **Copilot CLI** — set `COPILOT_CLI_PATH`\n- **GitHub token** — set `GITHUB_TOKEN` or use `gh auth login`\n- **Node.js 20+**, **Python 3.10+**, **Go 1.24+** (per language)\n" }, { "path": "test/scenarios/auth/byok-anthropic/README.md", "content": "# Auth Sample: BYOK Anthropic\n\nThis sample shows how to use Copilot SDK in **BYOK** mode with an Anthropic provider.\n\n## What this sample does\n\n1. Creates a session with a custom provider (`type: \"anthropic\"`)\n2. Uses your `ANTHROPIC_API_KEY` instead of GitHub auth\n3. Sends a prompt and prints the response\n\n## Prerequisites\n\n- `copilot` binary (`COPILOT_CLI_PATH`, or auto-detected by SDK)\n- Node.js 20+\n- `ANTHROPIC_API_KEY`\n\n## Run\n\n```bash\ncd typescript\nnpm install --ignore-scripts\nnpm run build\nANTHROPIC_API_KEY=sk-ant-... node dist/index.js\n```\n\nOptional environment variables:\n\n- `ANTHROPIC_BASE_URL` (default: `https://api.anthropic.com`)\n- `ANTHROPIC_MODEL` (default: `claude-sonnet-4-20250514`)\n\n## Verify\n\n```bash\n./verify.sh\n```\n\nBuild checks run by default. E2E run is optional and requires both `BYOK_SAMPLE_RUN_E2E=1` and `ANTHROPIC_API_KEY`.\n" }, { "path": "test/scenarios/auth/byok-anthropic/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nvar apiKey = Environment.GetEnvironmentVariable(\"ANTHROPIC_API_KEY\");\nvar model = Environment.GetEnvironmentVariable(\"ANTHROPIC_MODEL\") ?? \"claude-sonnet-4-20250514\";\nvar baseUrl = Environment.GetEnvironmentVariable(\"ANTHROPIC_BASE_URL\") ?? \"https://api.anthropic.com\";\n\nif (string.IsNullOrEmpty(apiKey))\n{\n Console.Error.WriteLine(\"Missing ANTHROPIC_API_KEY.\");\n return 1;\n}\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = model,\n Provider = new ProviderConfig\n {\n Type = \"anthropic\",\n BaseUrl = baseUrl,\n ApiKey = apiKey,\n },\n AvailableTools = [],\n SystemMessage = new SystemMessageConfig\n {\n Mode = SystemMessageMode.Replace,\n Content = \"You are a helpful assistant. Answer concisely.\",\n },\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is the capital of France?\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n}\nfinally\n{\n await client.StopAsync();\n}\nreturn 0;\n\n" }, { "path": "test/scenarios/auth/byok-anthropic/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/auth/byok-anthropic/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/auth/byok-anthropic/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/auth/byok-anthropic/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/auth/byok-anthropic/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tapiKey := os.Getenv(\"ANTHROPIC_API_KEY\")\n\tif apiKey == \"\" {\n\t\tlog.Fatal(\"Missing ANTHROPIC_API_KEY.\")\n\t}\n\n\tbaseUrl := os.Getenv(\"ANTHROPIC_BASE_URL\")\n\tif baseUrl == \"\" {\n\t\tbaseUrl = \"https://api.anthropic.com\"\n\t}\n\n\tmodel := os.Getenv(\"ANTHROPIC_MODEL\")\n\tif model == \"\" {\n\t\tmodel = \"claude-sonnet-4-20250514\"\n\t}\n\n\tclient := copilot.NewClient(&copilot.ClientOptions{})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: model,\n\t\tProvider: &copilot.ProviderConfig{\n\t\t\tType: \"anthropic\",\n\t\t\tBaseURL: baseUrl,\n\t\t\tAPIKey: apiKey,\n\t\t},\n\t\tAvailableTools: []string{},\n\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\tMode: \"replace\",\n\t\t\tContent: \"You are a helpful assistant. Answer concisely.\",\n\t\t},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What is the capital of France?\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n}\n" }, { "path": "test/scenarios/auth/byok-anthropic/python/main.py", "content": "import asyncio\nimport os\nimport sys\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\nANTHROPIC_API_KEY = os.environ.get(\"ANTHROPIC_API_KEY\")\nANTHROPIC_MODEL = os.environ.get(\"ANTHROPIC_MODEL\", \"claude-sonnet-4-20250514\")\nANTHROPIC_BASE_URL = os.environ.get(\"ANTHROPIC_BASE_URL\", \"https://api.anthropic.com\")\n\nif not ANTHROPIC_API_KEY:\n print(\"Missing ANTHROPIC_API_KEY.\", file=sys.stderr)\n sys.exit(1)\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session({\n \"model\": ANTHROPIC_MODEL,\n \"provider\": {\n \"type\": \"anthropic\",\n \"base_url\": ANTHROPIC_BASE_URL,\n \"api_key\": ANTHROPIC_API_KEY,\n },\n \"available_tools\": [],\n \"system_message\": {\n \"mode\": \"replace\",\n \"content\": \"You are a helpful assistant. Answer concisely.\",\n },\n })\n\n response = await session.send_and_wait(\n \"What is the capital of France?\"\n )\n\n if response:\n print(response.data.content)\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/auth/byok-anthropic/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/auth/byok-anthropic/typescript/package.json", "content": "{\n \"name\": \"auth-byok-anthropic-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Auth sample — BYOK with Anthropic\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/auth/byok-anthropic/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const apiKey = process.env.ANTHROPIC_API_KEY;\n const model = process.env.ANTHROPIC_MODEL || \"claude-sonnet-4-20250514\";\n\n if (!apiKey) {\n console.error(\"Required: ANTHROPIC_API_KEY\");\n process.exit(1);\n }\n\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n });\n\n try {\n const session = await client.createSession({\n model,\n provider: {\n type: \"anthropic\",\n baseUrl: process.env.ANTHROPIC_BASE_URL || \"https://api.anthropic.com\",\n apiKey,\n },\n availableTools: [],\n systemMessage: {\n mode: \"replace\",\n content: \"You are a helpful assistant. Answer concisely.\",\n },\n });\n\n const response = await session.sendAndWait({\n prompt: \"What is the capital of France?\",\n });\n\n if (response) {\n console.log(response.data.content);\n }\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/auth/byok-anthropic/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n elif [ \"$code\" -eq 124 ]; then\n echo \"${output:-(no output)}\"\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"${output:-(empty output)}\"\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying auth/byok-anthropic\"\necho \"══════════════════════════════════════\"\necho \"\"\n\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\nif [ \"${BYOK_SAMPLE_RUN_E2E:-}\" = \"1\" ] && [ -n \"${ANTHROPIC_API_KEY:-}\" ]; then\n run_with_timeout \"TypeScript (run)\" bash -c \"\n cd '$SCRIPT_DIR/typescript' && \\\n output=\\$(node dist/index.js 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital\\|France\\|response\\|hello'\n \"\n run_with_timeout \"C# (run)\" bash -c \"\n cd '$SCRIPT_DIR/csharp' && \\\n output=\\$(dotnet run --no-build 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital\\|France\\|response\\|hello'\n \"\nelse\n echo \"⚠️ WARNING: E2E run was SKIPPED — only build was verified, not runtime behavior.\"\n echo \" To run fully: set BYOK_SAMPLE_RUN_E2E=1 and ANTHROPIC_API_KEY.\"\n echo \"\"\nfi\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/auth/byok-azure/README.md", "content": "# Auth Sample: BYOK Azure OpenAI\n\nThis sample shows how to use Copilot SDK in **BYOK** mode with an Azure OpenAI provider.\n\n## What this sample does\n\n1. Creates a session with a custom provider (`type: \"azure\"`)\n2. Uses your Azure OpenAI endpoint and API key instead of GitHub auth\n3. Configures the Azure-specific `apiVersion` field\n4. Sends a prompt and prints the response\n\n## Prerequisites\n\n- `copilot` binary (`COPILOT_CLI_PATH`, or auto-detected by SDK)\n- Node.js 20+\n- An Azure OpenAI resource with a deployed model\n\n## Run\n\n```bash\ncd typescript\nnpm install --ignore-scripts\nnpm run build\nAZURE_OPENAI_ENDPOINT=https://your-resource.openai.azure.com AZURE_OPENAI_API_KEY=... node dist/index.js\n```\n\n### Environment variables\n\n| Variable | Required | Default | Description |\n|---|---|---|---|\n| `AZURE_OPENAI_ENDPOINT` | Yes | — | Azure OpenAI resource endpoint URL |\n| `AZURE_OPENAI_API_KEY` | Yes | — | Azure OpenAI API key |\n| `AZURE_OPENAI_MODEL` | No | `gpt-4.1` | Deployment / model name |\n| `AZURE_API_VERSION` | No | `2024-10-21` | Azure OpenAI API version |\n| `COPILOT_CLI_PATH` | No | auto-detected | Path to `copilot` binary |\n\n## Provider configuration\n\nThe key difference from standard OpenAI BYOK is the `azure` block in the provider config:\n\n```typescript\nprovider: {\n type: \"azure\",\n baseUrl: endpoint,\n apiKey,\n azure: {\n apiVersion: \"2024-10-21\",\n },\n}\n```\n\n## Verify\n\n```bash\n./verify.sh\n```\n\nBuild checks run by default. E2E run requires `AZURE_OPENAI_ENDPOINT` and `AZURE_OPENAI_API_KEY` to be set.\n" }, { "path": "test/scenarios/auth/byok-azure/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nvar endpoint = Environment.GetEnvironmentVariable(\"AZURE_OPENAI_ENDPOINT\");\nvar apiKey = Environment.GetEnvironmentVariable(\"AZURE_OPENAI_API_KEY\");\nvar model = Environment.GetEnvironmentVariable(\"AZURE_OPENAI_MODEL\") ?? \"claude-haiku-4.5\";\nvar apiVersion = Environment.GetEnvironmentVariable(\"AZURE_API_VERSION\") ?? \"2024-10-21\";\n\nif (string.IsNullOrEmpty(endpoint) || string.IsNullOrEmpty(apiKey))\n{\n Console.Error.WriteLine(\"Required: AZURE_OPENAI_ENDPOINT and AZURE_OPENAI_API_KEY\");\n return 1;\n}\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = model,\n Provider = new ProviderConfig\n {\n Type = \"azure\",\n BaseUrl = endpoint,\n ApiKey = apiKey,\n Azure = new AzureOptions\n {\n ApiVersion = apiVersion,\n },\n },\n AvailableTools = [],\n SystemMessage = new SystemMessageConfig\n {\n Mode = SystemMessageMode.Replace,\n Content = \"You are a helpful assistant. Answer concisely.\",\n },\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is the capital of France?\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n}\nfinally\n{\n await client.StopAsync();\n}\nreturn 0;\n\n" }, { "path": "test/scenarios/auth/byok-azure/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/auth/byok-azure/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/auth/byok-azure/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/auth/byok-azure/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/auth/byok-azure/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tendpoint := os.Getenv(\"AZURE_OPENAI_ENDPOINT\")\n\tapiKey := os.Getenv(\"AZURE_OPENAI_API_KEY\")\n\tif endpoint == \"\" || apiKey == \"\" {\n\t\tlog.Fatal(\"Required: AZURE_OPENAI_ENDPOINT and AZURE_OPENAI_API_KEY\")\n\t}\n\n\tmodel := os.Getenv(\"AZURE_OPENAI_MODEL\")\n\tif model == \"\" {\n\t\tmodel = \"claude-haiku-4.5\"\n\t}\n\n\tapiVersion := os.Getenv(\"AZURE_API_VERSION\")\n\tif apiVersion == \"\" {\n\t\tapiVersion = \"2024-10-21\"\n\t}\n\n\tclient := copilot.NewClient(&copilot.ClientOptions{})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: model,\n\t\tProvider: &copilot.ProviderConfig{\n\t\t\tType: \"azure\",\n\t\t\tBaseURL: endpoint,\n\t\t\tAPIKey: apiKey,\n\t\t\tAzure: &copilot.AzureProviderOptions{\n\t\t\t\tAPIVersion: apiVersion,\n\t\t\t},\n\t\t},\n\t\tAvailableTools: []string{},\n\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\tMode: \"replace\",\n\t\t\tContent: \"You are a helpful assistant. Answer concisely.\",\n\t\t},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What is the capital of France?\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n}\n" }, { "path": "test/scenarios/auth/byok-azure/python/main.py", "content": "import asyncio\nimport os\nimport sys\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\nAZURE_OPENAI_ENDPOINT = os.environ.get(\"AZURE_OPENAI_ENDPOINT\")\nAZURE_OPENAI_API_KEY = os.environ.get(\"AZURE_OPENAI_API_KEY\")\nAZURE_OPENAI_MODEL = os.environ.get(\"AZURE_OPENAI_MODEL\", \"claude-haiku-4.5\")\nAZURE_API_VERSION = os.environ.get(\"AZURE_API_VERSION\", \"2024-10-21\")\n\nif not AZURE_OPENAI_ENDPOINT or not AZURE_OPENAI_API_KEY:\n print(\"Required: AZURE_OPENAI_ENDPOINT and AZURE_OPENAI_API_KEY\", file=sys.stderr)\n sys.exit(1)\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session({\n \"model\": AZURE_OPENAI_MODEL,\n \"provider\": {\n \"type\": \"azure\",\n \"base_url\": AZURE_OPENAI_ENDPOINT,\n \"api_key\": AZURE_OPENAI_API_KEY,\n \"azure\": {\n \"api_version\": AZURE_API_VERSION,\n },\n },\n \"available_tools\": [],\n \"system_message\": {\n \"mode\": \"replace\",\n \"content\": \"You are a helpful assistant. Answer concisely.\",\n },\n })\n\n response = await session.send_and_wait(\n \"What is the capital of France?\"\n )\n\n if response:\n print(response.data.content)\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/auth/byok-azure/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/auth/byok-azure/typescript/package.json", "content": "{\n \"name\": \"auth-byok-azure-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Auth sample — BYOK with Azure OpenAI\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/auth/byok-azure/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const endpoint = process.env.AZURE_OPENAI_ENDPOINT;\n const apiKey = process.env.AZURE_OPENAI_API_KEY;\n const model = process.env.AZURE_OPENAI_MODEL || \"claude-haiku-4.5\";\n\n if (!endpoint || !apiKey) {\n console.error(\"Required: AZURE_OPENAI_ENDPOINT and AZURE_OPENAI_API_KEY\");\n process.exit(1);\n }\n\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n });\n\n try {\n const session = await client.createSession({\n model,\n provider: {\n type: \"azure\",\n baseUrl: endpoint,\n apiKey,\n azure: {\n apiVersion: process.env.AZURE_API_VERSION || \"2024-10-21\",\n },\n },\n availableTools: [],\n systemMessage: {\n mode: \"replace\",\n content: \"You are a helpful assistant. Answer concisely.\",\n },\n });\n\n const response = await session.sendAndWait({\n prompt: \"What is the capital of France?\",\n });\n\n if (response) {\n console.log(response.data.content);\n }\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/auth/byok-azure/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n elif [ \"$code\" -eq 124 ]; then\n echo \"${output:-(no output)}\"\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"${output:-(empty output)}\"\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying auth/byok-azure\"\necho \"══════════════════════════════════════\"\necho \"\"\n\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\nif [ -n \"${AZURE_OPENAI_ENDPOINT:-}\" ] && [ -n \"${AZURE_OPENAI_API_KEY:-}\" ]; then\n run_with_timeout \"TypeScript (run)\" bash -c \"\n cd '$SCRIPT_DIR/typescript' && \\\n output=\\$(node dist/index.js 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital\\|France\\|response\\|hello'\n \"\n run_with_timeout \"C# (run)\" bash -c \"\n cd '$SCRIPT_DIR/csharp' && \\\n output=\\$(dotnet run --no-build 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital\\|France\\|response\\|hello'\n \"\nelse\n echo \"⚠️ WARNING: E2E run was SKIPPED — only build was verified, not runtime behavior.\"\n echo \" To run fully: set AZURE_OPENAI_ENDPOINT and AZURE_OPENAI_API_KEY.\"\n echo \"\"\nfi\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/auth/byok-ollama/README.md", "content": "# Auth Sample: BYOK Ollama (Compact Context)\n\nThis sample shows BYOK with **local Ollama** and intentionally trims session context so it works better with smaller local models.\n\n## What this sample does\n\n1. Uses a custom provider pointed at Ollama (`http://localhost:11434/v1`)\n2. Replaces the default system prompt with a short compact prompt\n3. Sets `availableTools: []` to remove built-in tool definitions from model context\n4. Sends a prompt and prints the response\n\nThis creates a small assistant profile suitable for constrained context windows.\n\n## Prerequisites\n\n- `copilot` binary (`COPILOT_CLI_PATH`, or auto-detected by SDK)\n- Node.js 20+\n- Ollama running locally (`ollama serve`)\n- A local model pulled (for example: `ollama pull llama3.2:3b`)\n\n## Run\n\n```bash\ncd typescript\nnpm install --ignore-scripts\nnpm run build\nnode dist/index.js\n```\n\nOptional environment variables:\n\n- `OLLAMA_BASE_URL` (default: `http://localhost:11434/v1`)\n- `OLLAMA_MODEL` (default: `llama3.2:3b`)\n\n## Verify\n\n```bash\n./verify.sh\n```\n\nBuild checks run by default. E2E run is optional and requires `BYOK_SAMPLE_RUN_E2E=1`.\n" }, { "path": "test/scenarios/auth/byok-ollama/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nvar baseUrl = Environment.GetEnvironmentVariable(\"OLLAMA_BASE_URL\") ?? \"http://localhost:11434/v1\";\nvar model = Environment.GetEnvironmentVariable(\"OLLAMA_MODEL\") ?? \"llama3.2:3b\";\n\nvar compactSystemPrompt =\n \"You are a compact local assistant. Keep answers short, concrete, and under 80 words.\";\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = model,\n Provider = new ProviderConfig\n {\n Type = \"openai\",\n BaseUrl = baseUrl,\n },\n AvailableTools = [],\n SystemMessage = new SystemMessageConfig\n {\n Mode = SystemMessageMode.Replace,\n Content = compactSystemPrompt,\n },\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is the capital of France?\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/auth/byok-ollama/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/auth/byok-ollama/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/auth/byok-ollama/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/auth/byok-ollama/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/auth/byok-ollama/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nconst compactSystemPrompt = \"You are a compact local assistant. Keep answers short, concrete, and under 80 words.\"\n\nfunc main() {\n\tbaseUrl := os.Getenv(\"OLLAMA_BASE_URL\")\n\tif baseUrl == \"\" {\n\t\tbaseUrl = \"http://localhost:11434/v1\"\n\t}\n\n\tmodel := os.Getenv(\"OLLAMA_MODEL\")\n\tif model == \"\" {\n\t\tmodel = \"llama3.2:3b\"\n\t}\n\n\tclient := copilot.NewClient(&copilot.ClientOptions{})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: model,\n\t\tProvider: &copilot.ProviderConfig{\n\t\t\tType: \"openai\",\n\t\t\tBaseURL: baseUrl,\n\t\t},\n\t\tAvailableTools: []string{},\n\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\tMode: \"replace\",\n\t\t\tContent: compactSystemPrompt,\n\t\t},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What is the capital of France?\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n}\n" }, { "path": "test/scenarios/auth/byok-ollama/python/main.py", "content": "import asyncio\nimport os\nimport sys\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\nOLLAMA_BASE_URL = os.environ.get(\"OLLAMA_BASE_URL\", \"http://localhost:11434/v1\")\nOLLAMA_MODEL = os.environ.get(\"OLLAMA_MODEL\", \"llama3.2:3b\")\n\nCOMPACT_SYSTEM_PROMPT = (\n \"You are a compact local assistant. Keep answers short, concrete, and under 80 words.\"\n)\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session({\n \"model\": OLLAMA_MODEL,\n \"provider\": {\n \"type\": \"openai\",\n \"base_url\": OLLAMA_BASE_URL,\n },\n \"available_tools\": [],\n \"system_message\": {\n \"mode\": \"replace\",\n \"content\": COMPACT_SYSTEM_PROMPT,\n },\n })\n\n response = await session.send_and_wait(\n \"What is the capital of France?\"\n )\n\n if response:\n print(response.data.content)\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/auth/byok-ollama/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/auth/byok-ollama/typescript/package.json", "content": "{\n \"name\": \"auth-byok-ollama-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"BYOK Ollama sample with compact context settings\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\",\n \"typescript\": \"^5.5.0\"\n }\n}\n" }, { "path": "test/scenarios/auth/byok-ollama/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nconst OLLAMA_BASE_URL = process.env.OLLAMA_BASE_URL ?? \"http://localhost:11434/v1\";\nconst OLLAMA_MODEL = process.env.OLLAMA_MODEL ?? \"llama3.2:3b\";\n\nconst COMPACT_SYSTEM_PROMPT =\n \"You are a compact local assistant. Keep answers short, concrete, and under 80 words.\";\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n });\n\n try {\n const session = await client.createSession({\n model: OLLAMA_MODEL,\n provider: {\n type: \"openai\",\n baseUrl: OLLAMA_BASE_URL,\n },\n // Use a compact replacement prompt and no tools to minimize request context.\n systemMessage: { mode: \"replace\", content: COMPACT_SYSTEM_PROMPT },\n availableTools: [],\n });\n\n const response = await session.sendAndWait({\n prompt: \"What is the capital of France?\",\n });\n\n if (response) {\n console.log(response.data.content);\n }\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/auth/byok-ollama/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n elif [ \"$code\" -eq 124 ]; then\n echo \"${output:-(no output)}\"\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"${output:-(empty output)}\"\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying auth/byok-ollama\"\necho \"══════════════════════════════════════\"\necho \"\"\n\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\nif [ \"${BYOK_SAMPLE_RUN_E2E:-}\" = \"1\" ]; then\n run_with_timeout \"TypeScript (run)\" bash -c \"\n cd '$SCRIPT_DIR/typescript' && \\\n output=\\$(node dist/index.js 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital\\|France\\|response\\|hello'\n \"\n run_with_timeout \"C# (run)\" bash -c \"\n cd '$SCRIPT_DIR/csharp' && \\\n output=\\$(dotnet run --no-build 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital\\|France\\|response\\|hello'\n \"\nelse\n echo \"⚠️ WARNING: E2E run was SKIPPED — only build was verified, not runtime behavior.\"\n echo \" To run fully: set BYOK_SAMPLE_RUN_E2E=1 (and ensure Ollama is running).\"\n echo \"\"\nfi\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/auth/byok-openai/README.md", "content": "# Auth Sample: BYOK OpenAI\n\nThis sample shows how to use Copilot SDK in **BYOK** mode with an OpenAI-compatible provider.\n\n## What this sample does\n\n1. Creates a session with a custom provider (`type: \"openai\"`)\n2. Uses your `OPENAI_API_KEY` instead of GitHub auth\n3. Sends a prompt and prints the response\n\n## Prerequisites\n\n- `copilot` binary (`COPILOT_CLI_PATH`, or auto-detected by SDK)\n- Node.js 20+\n- `OPENAI_API_KEY`\n\n## Run\n\n```bash\ncd typescript\nnpm install --ignore-scripts\nnpm run build\nOPENAI_API_KEY=sk-... node dist/index.js\n```\n\nOptional environment variables:\n\n- `OPENAI_BASE_URL` (default: `https://api.openai.com/v1`)\n- `OPENAI_MODEL` (default: `gpt-4.1-mini`)\n\n## Verify\n\n```bash\n./verify.sh\n```\n\nBuild checks run by default. E2E run is optional and requires both `BYOK_SAMPLE_RUN_E2E=1` and `OPENAI_API_KEY`.\n" }, { "path": "test/scenarios/auth/byok-openai/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nvar apiKey = Environment.GetEnvironmentVariable(\"OPENAI_API_KEY\");\nvar model = Environment.GetEnvironmentVariable(\"OPENAI_MODEL\") ?? \"claude-haiku-4.5\";\nvar baseUrl = Environment.GetEnvironmentVariable(\"OPENAI_BASE_URL\") ?? \"https://api.openai.com/v1\";\n\nif (string.IsNullOrEmpty(apiKey))\n{\n Console.Error.WriteLine(\"Missing OPENAI_API_KEY.\");\n return 1;\n}\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = model,\n Provider = new ProviderConfig\n {\n Type = \"openai\",\n BaseUrl = baseUrl,\n ApiKey = apiKey,\n },\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is the capital of France?\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n}\nfinally\n{\n await client.StopAsync();\n}\nreturn 0;\n\n" }, { "path": "test/scenarios/auth/byok-openai/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/auth/byok-openai/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/auth/byok-openai/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/auth/byok-openai/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/auth/byok-openai/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tapiKey := os.Getenv(\"OPENAI_API_KEY\")\n\tif apiKey == \"\" {\n\t\tlog.Fatal(\"Missing OPENAI_API_KEY.\")\n\t}\n\n\tbaseUrl := os.Getenv(\"OPENAI_BASE_URL\")\n\tif baseUrl == \"\" {\n\t\tbaseUrl = \"https://api.openai.com/v1\"\n\t}\n\n\tmodel := os.Getenv(\"OPENAI_MODEL\")\n\tif model == \"\" {\n\t\tmodel = \"claude-haiku-4.5\"\n\t}\n\n\tclient := copilot.NewClient(&copilot.ClientOptions{})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: model,\n\t\tProvider: &copilot.ProviderConfig{\n\t\t\tType: \"openai\",\n\t\t\tBaseURL: baseUrl,\n\t\t\tAPIKey: apiKey,\n\t\t},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What is the capital of France?\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n}\n" }, { "path": "test/scenarios/auth/byok-openai/python/main.py", "content": "import asyncio\nimport os\nimport sys\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\nOPENAI_BASE_URL = os.environ.get(\"OPENAI_BASE_URL\", \"https://api.openai.com/v1\")\nOPENAI_MODEL = os.environ.get(\"OPENAI_MODEL\", \"claude-haiku-4.5\")\nOPENAI_API_KEY = os.environ.get(\"OPENAI_API_KEY\")\n\nif not OPENAI_API_KEY:\n print(\"Missing OPENAI_API_KEY.\", file=sys.stderr)\n sys.exit(1)\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session({\n \"model\": OPENAI_MODEL,\n \"provider\": {\n \"type\": \"openai\",\n \"base_url\": OPENAI_BASE_URL,\n \"api_key\": OPENAI_API_KEY,\n },\n })\n\n response = await session.send_and_wait(\n \"What is the capital of France?\"\n )\n\n if response:\n print(response.data.content)\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/auth/byok-openai/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/auth/byok-openai/typescript/package.json", "content": "{\n \"name\": \"auth-byok-openai-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"BYOK OpenAI provider sample for Copilot SDK\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\",\n \"typescript\": \"^5.5.0\"\n }\n}\n" }, { "path": "test/scenarios/auth/byok-openai/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nconst OPENAI_BASE_URL = process.env.OPENAI_BASE_URL ?? \"https://api.openai.com/v1\";\nconst OPENAI_MODEL = process.env.OPENAI_MODEL ?? \"claude-haiku-4.5\";\nconst OPENAI_API_KEY = process.env.OPENAI_API_KEY;\n\nif (!OPENAI_API_KEY) {\n console.error(\"Missing OPENAI_API_KEY.\");\n process.exit(1);\n}\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n });\n\n try {\n const session = await client.createSession({\n model: OPENAI_MODEL,\n provider: {\n type: \"openai\",\n baseUrl: OPENAI_BASE_URL,\n apiKey: OPENAI_API_KEY,\n },\n });\n\n const response = await session.sendAndWait({\n prompt: \"What is the capital of France?\",\n });\n\n if (response) {\n console.log(response.data.content);\n }\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/auth/byok-openai/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n elif [ \"$code\" -eq 124 ]; then\n echo \"${output:-(no output)}\"\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"${output:-(empty output)}\"\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying auth/byok-openai\"\necho \"══════════════════════════════════════\"\necho \"\"\n\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o byok-openai-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\nif [ \"${BYOK_SAMPLE_RUN_E2E:-}\" = \"1\" ] && [ -n \"${OPENAI_API_KEY:-}\" ]; then\n run_with_timeout \"TypeScript (run)\" bash -c \"\n cd '$SCRIPT_DIR/typescript' && \\\n output=\\$(node dist/index.js 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital\\|France\\|response\\|hello'\n \"\n run_with_timeout \"Python (run)\" bash -c \"\n cd '$SCRIPT_DIR/python' && \\\n output=\\$(python3 main.py 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital\\|France\\|response\\|hello'\n \"\n run_with_timeout \"Go (run)\" bash -c \"\n cd '$SCRIPT_DIR/go' && \\\n output=\\$(./byok-openai-go 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital\\|France\\|response\\|hello'\n \"\n run_with_timeout \"C# (run)\" bash -c \"\n cd '$SCRIPT_DIR/csharp' && \\\n output=\\$(dotnet run --no-build 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital\\|France\\|response\\|hello'\n \"\nelse\n echo \"⚠️ WARNING: E2E run was SKIPPED — only build was verified, not runtime behavior.\"\n echo \" To run fully: set BYOK_SAMPLE_RUN_E2E=1 and OPENAI_API_KEY.\"\n echo \"\"\nfi\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/auth/gh-app/README.md", "content": "# Auth Sample: GitHub OAuth App (Scenario 1)\n\nThis scenario demonstrates how a packaged app can let end users sign in with GitHub using OAuth Device Flow, then use that user token to call Copilot with their own subscription.\n\n## What this sample does\n\n1. Starts GitHub OAuth Device Flow\n2. Prompts the user to open the verification URL and enter the code\n3. Polls for the access token\n4. Fetches the signed-in user profile\n5. Calls Copilot with that OAuth token (SDK clients in TypeScript/Python/Go)\n\n## Prerequisites\n\n- A GitHub OAuth App client ID (`GITHUB_OAUTH_CLIENT_ID`)\n- `copilot` binary (`COPILOT_CLI_PATH`, or auto-detected by SDK)\n- Node.js 20+\n- Python 3.10+\n- Go 1.24+\n\n## Run\n\n### TypeScript\n\n```bash\ncd typescript\nnpm install --ignore-scripts\nnpm run build\nGITHUB_OAUTH_CLIENT_ID=Ivxxxxxxxxxxxx node dist/index.js\n```\n\n### Python\n\n```bash\ncd python\npip3 install -r requirements.txt --quiet\nGITHUB_OAUTH_CLIENT_ID=Ivxxxxxxxxxxxx python3 main.py\n```\n\n### Go\n\n```bash\ncd go\ngo run main.go\n```\n\n## Verify\n\n```bash\n./verify.sh\n```\n\n`verify.sh` checks install/build for all languages. Interactive runs are skipped by default and can be enabled by setting both `GITHUB_OAUTH_CLIENT_ID` and `AUTH_SAMPLE_RUN_INTERACTIVE=1`.\n\nTo include this sample in the full suite, run `./verify.sh` from the `samples/` root.\n" }, { "path": "test/scenarios/auth/gh-app/csharp/Program.cs", "content": "using System.Net.Http.Json;\nusing System.Text.Json;\nusing GitHub.Copilot.SDK;\n\n// GitHub OAuth Device Flow\nvar clientId = Environment.GetEnvironmentVariable(\"GITHUB_OAUTH_CLIENT_ID\")\n ?? throw new InvalidOperationException(\"Missing GITHUB_OAUTH_CLIENT_ID\");\n\nvar httpClient = new HttpClient();\nhttpClient.DefaultRequestHeaders.Add(\"Accept\", \"application/json\");\nhttpClient.DefaultRequestHeaders.Add(\"User-Agent\", \"copilot-sdk-csharp\");\n\n// Step 1: Request device code\nvar deviceCodeResponse = await httpClient.PostAsync(\n \"https://github.com/login/device/code\",\n new FormUrlEncodedContent(new Dictionary { { \"client_id\", clientId } }));\nvar deviceCode = await deviceCodeResponse.Content.ReadFromJsonAsync();\n\nvar userCode = deviceCode.GetProperty(\"user_code\").GetString();\nvar verificationUri = deviceCode.GetProperty(\"verification_uri\").GetString();\nvar code = deviceCode.GetProperty(\"device_code\").GetString();\nvar interval = deviceCode.GetProperty(\"interval\").GetInt32();\n\nConsole.WriteLine($\"Please visit: {verificationUri}\");\nConsole.WriteLine($\"Enter code: {userCode}\");\n\n// Step 2: Poll for access token\nstring? accessToken = null;\nwhile (accessToken == null)\n{\n await Task.Delay(interval * 1000);\n var tokenResponse = await httpClient.PostAsync(\n \"https://github.com/login/oauth/access_token\",\n new FormUrlEncodedContent(new Dictionary\n {\n { \"client_id\", clientId },\n { \"device_code\", code! },\n { \"grant_type\", \"urn:ietf:params:oauth:grant-type:device_code\" },\n }));\n var tokenData = await tokenResponse.Content.ReadFromJsonAsync();\n\n if (tokenData.TryGetProperty(\"access_token\", out var token))\n {\n accessToken = token.GetString();\n }\n else if (tokenData.TryGetProperty(\"error\", out var error))\n {\n var err = error.GetString();\n if (err == \"authorization_pending\") continue;\n if (err == \"slow_down\") { interval += 5; continue; }\n throw new Exception($\"OAuth error: {err}\");\n }\n}\n\n// Step 3: Verify authentication\nhttpClient.DefaultRequestHeaders.Add(\"Authorization\", $\"Bearer {accessToken}\");\nvar userResponse = await httpClient.GetFromJsonAsync(\"https://api.github.com/user\");\nConsole.WriteLine($\"Authenticated as: {userResponse.GetProperty(\"login\").GetString()}\");\n\n// Step 4: Use the token with Copilot\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = accessToken,\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is the capital of France?\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/auth/gh-app/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/auth/gh-app/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/auth/gh-app/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/auth/gh-app/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/auth/gh-app/go/main.go", "content": "package main\n\nimport (\n\t\"bytes\"\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io\"\n\t\"log\"\n\t\"net/http\"\n\t\"os\"\n\t\"time\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nconst (\n\tdeviceCodeURL = \"https://github.com/login/device/code\"\n\taccessTokenURL = \"https://github.com/login/oauth/access_token\"\n\tuserURL = \"https://api.github.com/user\"\n)\n\ntype deviceCodeResponse struct {\n\tDeviceCode string `json:\"device_code\"`\n\tUserCode string `json:\"user_code\"`\n\tVerificationURI string `json:\"verification_uri\"`\n\tInterval int `json:\"interval\"`\n}\n\ntype tokenResponse struct {\n\tAccessToken string `json:\"access_token\"`\n\tError string `json:\"error\"`\n\tErrorDescription string `json:\"error_description\"`\n\tInterval int `json:\"interval\"`\n}\n\ntype githubUser struct {\n\tLogin string `json:\"login\"`\n\tName string `json:\"name\"`\n}\n\nfunc postJSON(url string, payload any, target any) error {\n\tbody, err := json.Marshal(payload)\n\tif err != nil {\n\t\treturn err\n\t}\n\treq, err := http.NewRequest(http.MethodPost, url, bytes.NewReader(body))\n\tif err != nil {\n\t\treturn err\n\t}\n\treq.Header.Set(\"Accept\", \"application/json\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer resp.Body.Close()\n\tif resp.StatusCode < 200 || resp.StatusCode > 299 {\n\t\tresponseBody, _ := io.ReadAll(resp.Body)\n\t\treturn fmt.Errorf(\"request failed: %s %s\", resp.Status, string(responseBody))\n\t}\n\treturn json.NewDecoder(resp.Body).Decode(target)\n}\n\nfunc getUser(token string) (*githubUser, error) {\n\treq, err := http.NewRequest(http.MethodGet, userURL, nil)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treq.Header.Set(\"Accept\", \"application/json\")\n\treq.Header.Set(\"Authorization\", \"Bearer \"+token)\n\treq.Header.Set(\"User-Agent\", \"copilot-sdk-samples-auth-gh-app\")\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer resp.Body.Close()\n\tif resp.StatusCode < 200 || resp.StatusCode > 299 {\n\t\tresponseBody, _ := io.ReadAll(resp.Body)\n\t\treturn nil, fmt.Errorf(\"github API failed: %s %s\", resp.Status, string(responseBody))\n\t}\n\tvar user githubUser\n\tif err := json.NewDecoder(resp.Body).Decode(&user); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &user, nil\n}\n\nfunc startDeviceFlow(clientID string) (*deviceCodeResponse, error) {\n\tvar resp deviceCodeResponse\n\terr := postJSON(deviceCodeURL, map[string]any{\n\t\t\"client_id\": clientID,\n\t\t\"scope\": \"read:user\",\n\t}, &resp)\n\treturn &resp, err\n}\n\nfunc pollForToken(clientID, deviceCode string, interval int) (string, error) {\n\tdelaySeconds := interval\n\tfor {\n\t\ttime.Sleep(time.Duration(delaySeconds) * time.Second)\n\t\tvar resp tokenResponse\n\t\tif err := postJSON(accessTokenURL, map[string]any{\n\t\t\t\"client_id\": clientID,\n\t\t\t\"device_code\": deviceCode,\n\t\t\t\"grant_type\": \"urn:ietf:params:oauth:grant-type:device_code\",\n\t\t}, &resp); err != nil {\n\t\t\treturn \"\", err\n\t\t}\n\t\tif resp.AccessToken != \"\" {\n\t\t\treturn resp.AccessToken, nil\n\t\t}\n\t\tif resp.Error == \"authorization_pending\" {\n\t\t\tcontinue\n\t\t}\n\t\tif resp.Error == \"slow_down\" {\n\t\t\tif resp.Interval > 0 {\n\t\t\t\tdelaySeconds = resp.Interval\n\t\t\t} else {\n\t\t\t\tdelaySeconds += 5\n\t\t\t}\n\t\t\tcontinue\n\t\t}\n\t\tif resp.ErrorDescription != \"\" {\n\t\t\treturn \"\", fmt.Errorf(resp.ErrorDescription)\n\t\t}\n\t\tif resp.Error != \"\" {\n\t\t\treturn \"\", fmt.Errorf(resp.Error)\n\t\t}\n\t\treturn \"\", fmt.Errorf(\"OAuth polling failed\")\n\t}\n}\n\nfunc main() {\n\tclientID := os.Getenv(\"GITHUB_OAUTH_CLIENT_ID\")\n\tif clientID == \"\" {\n\t\tlog.Fatal(\"Missing GITHUB_OAUTH_CLIENT_ID\")\n\t}\n\n\tfmt.Println(\"Starting GitHub OAuth device flow...\")\n\tdevice, err := startDeviceFlow(clientID)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"Open %s and enter code: %s\\n\", device.VerificationURI, device.UserCode)\n\tfmt.Print(\"Press Enter after you authorize this app...\")\n\tfmt.Scanln()\n\n\ttoken, err := pollForToken(clientID, device.DeviceCode, device.Interval)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tuser, err := getUser(token)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tif user.Name != \"\" {\n\t\tfmt.Printf(\"Authenticated as: %s (%s)\\n\", user.Login, user.Name)\n\t} else {\n\t\tfmt.Printf(\"Authenticated as: %s\\n\", user.Login)\n\t}\n\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: token,\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What is the capital of France?\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n}\n" }, { "path": "test/scenarios/auth/gh-app/python/main.py", "content": "import asyncio\nimport json\nimport os\nimport time\nimport urllib.request\n\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\n\nDEVICE_CODE_URL = \"https://github.com/login/device/code\"\nACCESS_TOKEN_URL = \"https://github.com/login/oauth/access_token\"\nUSER_URL = \"https://api.github.com/user\"\n\n\ndef post_json(url: str, payload: dict) -> dict:\n req = urllib.request.Request(\n url=url,\n data=json.dumps(payload).encode(\"utf-8\"),\n headers={\"Accept\": \"application/json\", \"Content-Type\": \"application/json\"},\n method=\"POST\",\n )\n with urllib.request.urlopen(req) as response:\n return json.loads(response.read().decode(\"utf-8\"))\n\n\ndef get_json(url: str, token: str) -> dict:\n req = urllib.request.Request(\n url=url,\n headers={\n \"Accept\": \"application/json\",\n \"Authorization\": f\"Bearer {token}\",\n \"User-Agent\": \"copilot-sdk-samples-auth-gh-app\",\n },\n method=\"GET\",\n )\n with urllib.request.urlopen(req) as response:\n return json.loads(response.read().decode(\"utf-8\"))\n\n\ndef start_device_flow(client_id: str) -> dict:\n return post_json(DEVICE_CODE_URL, {\"client_id\": client_id, \"scope\": \"read:user\"})\n\n\ndef poll_for_access_token(client_id: str, device_code: str, interval: int) -> str:\n delay_seconds = interval\n while True:\n time.sleep(delay_seconds)\n data = post_json(\n ACCESS_TOKEN_URL,\n {\n \"client_id\": client_id,\n \"device_code\": device_code,\n \"grant_type\": \"urn:ietf:params:oauth:grant-type:device_code\",\n },\n )\n if data.get(\"access_token\"):\n return data[\"access_token\"]\n if data.get(\"error\") == \"authorization_pending\":\n continue\n if data.get(\"error\") == \"slow_down\":\n delay_seconds = int(data.get(\"interval\", delay_seconds + 5))\n continue\n raise RuntimeError(data.get(\"error_description\") or data.get(\"error\") or \"OAuth polling failed\")\n\n\nasync def main():\n client_id = os.environ.get(\"GITHUB_OAUTH_CLIENT_ID\")\n if not client_id:\n raise RuntimeError(\"Missing GITHUB_OAUTH_CLIENT_ID\")\n\n print(\"Starting GitHub OAuth device flow...\")\n device = start_device_flow(client_id)\n print(f\"Open {device['verification_uri']} and enter code: {device['user_code']}\")\n input(\"Press Enter after you authorize this app...\")\n\n token = poll_for_access_token(client_id, device[\"device_code\"], int(device[\"interval\"]))\n user = get_json(USER_URL, token)\n display_name = f\" ({user.get('name')})\" if user.get(\"name\") else \"\"\n print(f\"Authenticated as: {user.get('login')}{display_name}\")\n\n client = CopilotClient(SubprocessConfig(\n github_token=token,\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session({\"model\": \"claude-haiku-4.5\"})\n response = await session.send_and_wait(\"What is the capital of France?\")\n if response:\n print(response.data.content)\n await session.disconnect()\n finally:\n await client.stop()\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n" }, { "path": "test/scenarios/auth/gh-app/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/auth/gh-app/typescript/package.json", "content": "{\n \"name\": \"auth-gh-app-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"GitHub OAuth App device flow sample for Copilot SDK\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\",\n \"typescript\": \"^5.5.0\"\n }\n}\n" }, { "path": "test/scenarios/auth/gh-app/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\nimport readline from \"node:readline/promises\";\nimport { stdin as input, stdout as output } from \"node:process\";\n\ntype DeviceCodeResponse = {\n device_code: string;\n user_code: string;\n verification_uri: string;\n expires_in: number;\n interval: number;\n};\n\ntype OAuthTokenResponse = {\n access_token?: string;\n error?: string;\n error_description?: string;\n interval?: number;\n};\n\ntype GitHubUser = {\n login: string;\n name: string | null;\n};\n\nconst DEVICE_CODE_URL = \"https://github.com/login/device/code\";\nconst ACCESS_TOKEN_URL = \"https://github.com/login/oauth/access_token\";\nconst USER_URL = \"https://api.github.com/user\";\n\nconst CLIENT_ID = process.env.GITHUB_OAUTH_CLIENT_ID;\n\nif (!CLIENT_ID) {\n console.error(\"Missing GITHUB_OAUTH_CLIENT_ID.\");\n process.exit(1);\n}\n\nasync function postJson(url: string, body: Record): Promise {\n const response = await fetch(url, {\n method: \"POST\",\n headers: {\n Accept: \"application/json\",\n \"Content-Type\": \"application/json\",\n },\n body: JSON.stringify(body),\n });\n\n if (!response.ok) {\n throw new Error(`Request failed: ${response.status} ${response.statusText}`);\n }\n\n return (await response.json()) as T;\n}\n\nasync function getJson(url: string, token: string): Promise {\n const response = await fetch(url, {\n headers: {\n Accept: \"application/json\",\n Authorization: `Bearer ${token}`,\n \"User-Agent\": \"copilot-sdk-samples-auth-gh-app\",\n },\n });\n\n if (!response.ok) {\n throw new Error(`GitHub API failed: ${response.status} ${response.statusText}`);\n }\n\n return (await response.json()) as T;\n}\n\nasync function startDeviceFlow(): Promise {\n return postJson(DEVICE_CODE_URL, {\n client_id: CLIENT_ID,\n scope: \"read:user\",\n });\n}\n\nasync function pollForAccessToken(deviceCode: string, intervalSeconds: number): Promise {\n let interval = intervalSeconds;\n\n while (true) {\n await new Promise((resolve) => setTimeout(resolve, interval * 1000));\n\n const data = await postJson(ACCESS_TOKEN_URL, {\n client_id: CLIENT_ID,\n device_code: deviceCode,\n grant_type: \"urn:ietf:params:oauth:grant-type:device_code\",\n });\n\n if (data.access_token) return data.access_token;\n if (data.error === \"authorization_pending\") continue;\n if (data.error === \"slow_down\") {\n interval = data.interval ?? interval + 5;\n continue;\n }\n\n throw new Error(data.error_description ?? data.error ?? \"OAuth token polling failed\");\n }\n}\n\nasync function main() {\n console.log(\"Starting GitHub OAuth device flow...\");\n const device = await startDeviceFlow();\n\n console.log(`Open ${device.verification_uri} and enter code: ${device.user_code}`);\n const rl = readline.createInterface({ input, output });\n await rl.question(\"Press Enter after you authorize this app...\");\n rl.close();\n\n const accessToken = await pollForAccessToken(device.device_code, device.interval);\n const user = await getJson(USER_URL, accessToken);\n console.log(`Authenticated as: ${user.login}${user.name ? ` (${user.name})` : \"\"}`);\n\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: accessToken,\n });\n\n try {\n const session = await client.createSession({ model: \"claude-haiku-4.5\" });\n const response = await session.sendAndWait({\n prompt: \"What is the capital of France?\",\n });\n\n if (response) console.log(response.data.content);\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((error) => {\n console.error(error);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/auth/gh-app/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=180\n\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n elif [ \"$code\" -eq 124 ]; then\n echo \"${output:-(no output)}\"\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"${output:-(empty output)}\"\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying auth/gh-app scenario 1\"\necho \"══════════════════════════════════════\"\necho \"\"\n\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go mod tidy && go build -o gh-app-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\nif [ -n \"${GITHUB_OAUTH_CLIENT_ID:-}\" ] && [ \"${AUTH_SAMPLE_RUN_INTERACTIVE:-}\" = \"1\" ]; then\n run_with_timeout \"TypeScript (run)\" bash -c \"\n cd '$SCRIPT_DIR/typescript' && \\\n output=\\$(printf '\\\\n' | node dist/index.js 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'device\\|code\\|http\\|login\\|verify\\|oauth\\|github'\n \"\n run_with_timeout \"Python (run)\" bash -c \"\n cd '$SCRIPT_DIR/python' && \\\n output=\\$(printf '\\\\n' | python3 main.py 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'device\\|code\\|http\\|login\\|verify\\|oauth\\|github'\n \"\n run_with_timeout \"Go (run)\" bash -c \"\n cd '$SCRIPT_DIR/go' && \\\n output=\\$(printf '\\\\n' | ./gh-app-go 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'device\\|code\\|http\\|login\\|verify\\|oauth\\|github'\n \"\n run_with_timeout \"C# (run)\" bash -c \"\n cd '$SCRIPT_DIR/csharp' && \\\n output=\\$(printf '\\\\n' | dotnet run --no-build 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'device\\|code\\|http\\|login\\|verify\\|oauth\\|github'\n \"\nelse\n echo \"⚠️ WARNING: E2E run was SKIPPED — only build was verified, not runtime behavior.\"\n echo \" To run fully: set GITHUB_OAUTH_CLIENT_ID and AUTH_SAMPLE_RUN_INTERACTIVE=1.\"\n echo \"\"\nfi\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/bundling/app-backend-to-server/README.md", "content": "# App-Backend-to-Server Samples\n\nSamples that demonstrate the **app-backend-to-server** deployment architecture of the Copilot SDK. In this scenario a web backend connects to a **pre-running** `copilot` TCP server and exposes a `POST /chat` HTTP endpoint. The HTTP server receives a prompt from the client, forwards it to Copilot CLI, and returns the response.\n\n```\n┌────────┐ HTTP POST /chat ┌─────────────┐ TCP (JSON-RPC) ┌──────────────┐\n│ Client │ ──────────────────▶ │ Web Backend │ ─────────────────▶ │ Copilot CLI │\n│ (curl) │ ◀────────────────── │ (HTTP server)│ ◀───────────────── │ (TCP server) │\n└────────┘ └─────────────┘ └──────────────┘\n```\n\nEach sample follows the same flow:\n\n1. **Start** an HTTP server with a `POST /chat` endpoint\n2. **Receive** a JSON request `{ \"prompt\": \"...\" }`\n3. **Connect** to a running `copilot` server via TCP\n4. **Open a session** targeting the `gpt-4.1` model\n5. **Forward the prompt** and collect the response\n6. **Return** a JSON response `{ \"response\": \"...\" }`\n\n## Languages\n\n| Directory | SDK / Approach | Language | HTTP Framework |\n|-----------|---------------|----------|----------------|\n| `typescript/` | `@github/copilot-sdk` | TypeScript (Node.js) | Express |\n| `python/` | `github-copilot-sdk` | Python | Flask |\n| `go/` | `github.com/github/copilot-sdk/go` | Go | net/http |\n\n## Prerequisites\n\n- **Copilot CLI** — set `COPILOT_CLI_PATH`\n- **Authentication** — set `GITHUB_TOKEN`, or run `gh auth login`\n- **Node.js 20+** (TypeScript sample)\n- **Python 3.10+** (Python sample)\n- **Go 1.24+** (Go sample)\n\n## Starting the Server\n\nStart `copilot` as a TCP server before running any sample:\n\n```bash\ncopilot --port 3000 --headless --auth-token-env GITHUB_TOKEN\n```\n\n## Quick Start\n\n**TypeScript**\n```bash\ncd typescript\nnpm install && npm run build\nCLI_URL=localhost:3000 npm start\n# In another terminal:\ncurl -X POST http://localhost:8080/chat \\\n -H \"Content-Type: application/json\" \\\n -d '{\"prompt\": \"What is the capital of France?\"}'\n```\n\n**Python**\n```bash\ncd python\npip install -r requirements.txt\nCLI_URL=localhost:3000 python main.py\n# In another terminal:\ncurl -X POST http://localhost:8080/chat \\\n -H \"Content-Type: application/json\" \\\n -d '{\"prompt\": \"What is the capital of France?\"}'\n```\n\n**Go**\n```bash\ncd go\nCLI_URL=localhost:3000 go run main.go\n# In another terminal:\ncurl -X POST http://localhost:8080/chat \\\n -H \"Content-Type: application/json\" \\\n -d '{\"prompt\": \"What is the capital of France?\"}'\n```\n\nAll samples default to `localhost:3000` for the Copilot CLI and port `8080` for the HTTP server. Override with `CLI_URL` (or `COPILOT_CLI_URL`) and `PORT` environment variables:\n\n```bash\nCLI_URL=localhost:4000 PORT=9090 npm start\n```\n\n## Verification\n\nA script is included that starts the server, builds, and end-to-end tests every sample:\n\n```bash\n./verify.sh\n```\n\nIt runs in three phases:\n\n1. **Server** — starts `copilot` on a random port\n2. **Build** — installs dependencies and compiles each sample\n3. **E2E Run** — starts each HTTP server, sends a `POST /chat` request via curl, and verifies it returns a response\n\nThe server is automatically stopped when the script exits.\n" }, { "path": "test/scenarios/bundling/app-backend-to-server/csharp/Program.cs", "content": "using System.Text.Json;\nusing GitHub.Copilot.SDK;\n\nvar port = Environment.GetEnvironmentVariable(\"PORT\") ?? \"8080\";\nvar cliUrl = Environment.GetEnvironmentVariable(\"CLI_URL\")\n ?? Environment.GetEnvironmentVariable(\"COPILOT_CLI_URL\")\n ?? \"localhost:3000\";\n\nvar builder = WebApplication.CreateBuilder(args);\nbuilder.WebHost.UseUrls($\"http://0.0.0.0:{port}\");\nvar app = builder.Build();\n\napp.MapPost(\"/chat\", async (HttpContext ctx) =>\n{\n var body = await JsonSerializer.DeserializeAsync(ctx.Request.Body);\n var prompt = body.TryGetProperty(\"prompt\", out var p) ? p.GetString() : null;\n if (string.IsNullOrEmpty(prompt))\n {\n ctx.Response.StatusCode = 400;\n await ctx.Response.WriteAsJsonAsync(new { error = \"Missing 'prompt' in request body\" });\n return;\n }\n\n using var client = new CopilotClient(new CopilotClientOptions { CliUrl = cliUrl });\n await client.StartAsync();\n\n try\n {\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = prompt,\n });\n\n if (response?.Data?.Content != null)\n {\n await ctx.Response.WriteAsJsonAsync(new { response = response.Data.Content });\n }\n else\n {\n ctx.Response.StatusCode = 502;\n await ctx.Response.WriteAsJsonAsync(new { error = \"No response content from Copilot CLI\" });\n }\n }\n finally\n {\n await client.StopAsync();\n }\n});\n\nConsole.WriteLine($\"Listening on port {port}\");\napp.Run();\n" }, { "path": "test/scenarios/bundling/app-backend-to-server/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/bundling/app-backend-to-server/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/bundling/app-backend-to-server/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/bundling/app-backend-to-server/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/bundling/app-backend-to-server/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io\"\n\t\"log\"\n\t\"net\"\n\t\"net/http\"\n\t\"os\"\n\t\"strings\"\n\t\"time\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc cliURL() string {\n\tif u := os.Getenv(\"CLI_URL\"); u != \"\" {\n\t\treturn u\n\t}\n\tif u := os.Getenv(\"COPILOT_CLI_URL\"); u != \"\" {\n\t\treturn u\n\t}\n\treturn \"localhost:3000\"\n}\n\ntype chatRequest struct {\n\tPrompt string `json:\"prompt\"`\n}\n\ntype chatResponse struct {\n\tResponse string `json:\"response,omitempty\"`\n\tError string `json:\"error,omitempty\"`\n}\n\nfunc chatHandler(w http.ResponseWriter, r *http.Request) {\n\tif r.Method != http.MethodPost {\n\t\tw.WriteHeader(http.StatusMethodNotAllowed)\n\t\treturn\n\t}\n\n\tbody, err := io.ReadAll(r.Body)\n\tif err != nil {\n\t\twriteJSON(w, http.StatusBadRequest, chatResponse{Error: \"Failed to read body\"})\n\t\treturn\n\t}\n\n\tvar req chatRequest\n\tif err := json.Unmarshal(body, &req); err != nil || req.Prompt == \"\" {\n\t\twriteJSON(w, http.StatusBadRequest, chatResponse{Error: \"Missing 'prompt' in request body\"})\n\t\treturn\n\t}\n\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tCLIUrl: cliURL(),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\twriteJSON(w, http.StatusInternalServerError, chatResponse{Error: err.Error()})\n\t\treturn\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t})\n\tif err != nil {\n\t\twriteJSON(w, http.StatusInternalServerError, chatResponse{Error: err.Error()})\n\t\treturn\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: req.Prompt,\n\t})\n\tif err != nil {\n\t\twriteJSON(w, http.StatusInternalServerError, chatResponse{Error: err.Error()})\n\t\treturn\n\t}\n\n\tif response != nil {\n\t\tif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\n\t\t\twriteJSON(w, http.StatusOK, chatResponse{Response: d.Content})\n\t\t} else {\n\t\t\twriteJSON(w, http.StatusBadGateway, chatResponse{Error: \"No response content from Copilot CLI\"})\n\t\t}\n\t} else {\n\t\twriteJSON(w, http.StatusBadGateway, chatResponse{Error: \"No response content from Copilot CLI\"})\n\t}\n}\n\nfunc writeJSON(w http.ResponseWriter, status int, v interface{}) {\n\tw.Header().Set(\"Content-Type\", \"application/json\")\n\tw.WriteHeader(status)\n\tjson.NewEncoder(w).Encode(v)\n}\n\nfunc main() {\n\tport := os.Getenv(\"PORT\")\n\tif port == \"\" {\n\t\tport = \"8080\"\n\t}\n\n\tmux := http.NewServeMux()\n\tmux.HandleFunc(\"/chat\", chatHandler)\n\n\tlistener, err := net.Listen(\"tcp\", \":\"+port)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"Listening on port %s\\n\", port)\n\n\tif os.Getenv(\"SELF_TEST\") == \"1\" {\n\t\tgo func() {\n\t\t\thttp.Serve(listener, mux)\n\t\t}()\n\n\t\ttime.Sleep(500 * time.Millisecond)\n\t\turl := fmt.Sprintf(\"http://localhost:%s/chat\", port)\n\t\tresp, err := http.Post(url, \"application/json\",\n\t\t\tstrings.NewReader(`{\"prompt\":\"What is the capital of France?\"}`))\n\t\tif err != nil {\n\t\t\tlog.Fatal(\"Self-test error:\", err)\n\t\t}\n\t\tdefer resp.Body.Close()\n\n\t\tvar result chatResponse\n\t\tjson.NewDecoder(resp.Body).Decode(&result)\n\t\tif result.Response != \"\" {\n\t\t\tfmt.Println(result.Response)\n\t\t} else {\n\t\t\tlog.Fatal(\"Self-test failed:\", result.Error)\n\t\t}\n\t} else {\n\t\thttp.Serve(listener, mux)\n\t}\n}\n" }, { "path": "test/scenarios/bundling/app-backend-to-server/python/main.py", "content": "import asyncio\nimport json\nimport os\nimport sys\nimport urllib.request\n\nfrom flask import Flask, request, jsonify\nfrom copilot import CopilotClient\nfrom copilot.client import ExternalServerConfig\n\napp = Flask(__name__)\n\nCLI_URL = os.environ.get(\"CLI_URL\", os.environ.get(\"COPILOT_CLI_URL\", \"localhost:3000\"))\n\n\nasync def ask_copilot(prompt: str) -> str:\n client = CopilotClient(ExternalServerConfig(url=CLI_URL))\n\n try:\n session = await client.create_session({\"model\": \"claude-haiku-4.5\"})\n\n response = await session.send_and_wait(prompt)\n\n await session.disconnect()\n\n if response:\n return response.data.content\n return \"\"\n finally:\n await client.stop()\n\n\n@app.route(\"/chat\", methods=[\"POST\"])\ndef chat():\n data = request.get_json(force=True)\n prompt = data.get(\"prompt\", \"\")\n if not prompt:\n return jsonify({\"error\": \"Missing 'prompt' in request body\"}), 400\n\n content = asyncio.run(ask_copilot(prompt))\n if content:\n return jsonify({\"response\": content})\n return jsonify({\"error\": \"No response content from Copilot CLI\"}), 502\n\n\ndef self_test(port: int):\n \"\"\"Send a test request to ourselves and print the response.\"\"\"\n url = f\"http://localhost:{port}/chat\"\n payload = json.dumps({\"prompt\": \"What is the capital of France?\"}).encode()\n req = urllib.request.Request(url, data=payload, headers={\"Content-Type\": \"application/json\"})\n with urllib.request.urlopen(req) as resp:\n result = json.loads(resp.read().decode())\n if result.get(\"response\"):\n print(result[\"response\"])\n else:\n print(\"Self-test failed:\", result, file=sys.stderr)\n sys.exit(1)\n\n\nif __name__ == \"__main__\":\n import threading\n\n port = int(os.environ.get(\"PORT\", \"8080\"))\n\n if os.environ.get(\"SELF_TEST\") == \"1\":\n # Start server in a background thread, run self-test, then exit\n server_thread = threading.Thread(\n target=lambda: app.run(host=\"0.0.0.0\", port=port, debug=False),\n daemon=True,\n )\n server_thread.start()\n import time\n time.sleep(1)\n self_test(port)\n else:\n app.run(host=\"0.0.0.0\", port=port, debug=False)\n" }, { "path": "test/scenarios/bundling/app-backend-to-server/python/requirements.txt", "content": "flask\n-e ../../../../../python\n" }, { "path": "test/scenarios/bundling/app-backend-to-server/typescript/package.json", "content": "{\n \"name\": \"bundling-app-backend-to-server-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"App-backend-to-server Copilot SDK sample — web backend proxies to Copilot CLI TCP server\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\",\n \"express\": \"^4.21.0\"\n },\n \"devDependencies\": {\n \"@types/express\": \"^4.17.0\",\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\",\n \"typescript\": \"^5.5.0\"\n }\n}\n" }, { "path": "test/scenarios/bundling/app-backend-to-server/typescript/src/index.ts", "content": "import express from \"express\";\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\nconst PORT = parseInt(process.env.PORT || \"8080\", 10);\nconst CLI_URL = process.env.CLI_URL || process.env.COPILOT_CLI_URL || \"localhost:3000\";\n\nconst app = express();\napp.use(express.json());\n\napp.post(\"/chat\", async (req, res) => {\n const { prompt } = req.body;\n if (!prompt || typeof prompt !== \"string\") {\n res.status(400).json({ error: \"Missing 'prompt' in request body\" });\n return;\n }\n\n const client = new CopilotClient({ cliUrl: CLI_URL });\n\n try {\n const session = await client.createSession({ model: \"claude-haiku-4.5\" });\n\n const response = await session.sendAndWait({ prompt });\n\n await session.disconnect();\n\n if (response?.data.content) {\n res.json({ response: response.data.content });\n } else {\n res.status(502).json({ error: \"No response content from Copilot CLI\" });\n }\n } catch (err) {\n res.status(500).json({ error: String(err) });\n } finally {\n await client.stop();\n }\n});\n\n// When run directly, start server and optionally self-test\nconst server = app.listen(PORT, async () => {\n console.log(`Listening on port ${PORT}`);\n\n // Self-test mode: send a request and exit\n if (process.env.SELF_TEST === \"1\") {\n try {\n const resp = await fetch(`http://localhost:${PORT}/chat`, {\n method: \"POST\",\n headers: { \"Content-Type\": \"application/json\" },\n body: JSON.stringify({ prompt: \"What is the capital of France?\" }),\n });\n const data = await resp.json();\n if (data.response) {\n console.log(data.response);\n } else {\n console.error(\"Self-test failed:\", data);\n process.exit(1);\n }\n } catch (err) {\n console.error(\"Self-test error:\", err);\n process.exit(1);\n } finally {\n server.close();\n }\n }\n});\n" }, { "path": "test/scenarios/bundling/app-backend-to-server/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\nSERVER_PID=\"\"\nSERVER_PORT_FILE=\"\"\nAPP_PID=\"\"\n\ncleanup() {\n if [ -n \"${APP_PID:-}\" ] && kill -0 \"$APP_PID\" 2>/dev/null; then\n kill \"$APP_PID\" 2>/dev/null || true\n wait \"$APP_PID\" 2>/dev/null || true\n fi\n if [ -n \"$SERVER_PID\" ] && kill -0 \"$SERVER_PID\" 2>/dev/null; then\n echo \"\"\n echo \"Stopping Copilot CLI server (PID $SERVER_PID)...\"\n kill \"$SERVER_PID\" 2>/dev/null || true\n wait \"$SERVER_PID\" 2>/dev/null || true\n fi\n [ -n \"$SERVER_PORT_FILE\" ] && rm -f \"$SERVER_PORT_FILE\"\n}\ntrap cleanup EXIT\n\n# Resolve Copilot CLI binary: use COPILOT_CLI_PATH env var or find the SDK bundled CLI.\nif [ -z \"${COPILOT_CLI_PATH:-}\" ]; then\n # Try to resolve from the TypeScript sample node_modules\n TS_DIR=\"$SCRIPT_DIR/typescript\"\n if [ -d \"$TS_DIR/node_modules/@github/copilot\" ]; then\n COPILOT_CLI_PATH=\"$(node -e \"console.log(require.resolve('@github/copilot'))\" 2>/dev/null || true)\"\n fi\n # Fallback: check PATH\n if [ -z \"${COPILOT_CLI_PATH:-}\" ]; then\n COPILOT_CLI_PATH=\"$(command -v copilot 2>/dev/null || true)\"\n fi\nfi\nif [ -z \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"❌ Could not find Copilot CLI binary.\"\n echo \" Set COPILOT_CLI_PATH or run: cd typescript && npm install\"\n exit 1\nfi\necho \"Using CLI: $COPILOT_CLI_PATH\"\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n echo \"$output\"\n echo \"✅ $name passed (got response)\"\n PASS=$((PASS + 1))\n elif [ \"$code\" -eq 124 ]; then\n echo \"${output:-(no output)}\"\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"${output:-(empty output)}\"\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\n# Helper: start an HTTP server, curl it, stop it\nrun_http_test() {\n local name=\"$1\"\n local start_cmd=\"$2\"\n local app_port=\"$3\"\n local max_retries=\"${4:-15}\"\n\n printf \"━━━ %s ━━━\\n\" \"$name\"\n\n # Start the HTTP server in the background\n eval \"$start_cmd\" &\n APP_PID=$!\n\n # Wait for server to be ready\n local ready=false\n for i in $(seq 1 \"$max_retries\"); do\n if curl -sf \"http://localhost:${app_port}/chat\" -X POST \\\n -H \"Content-Type: application/json\" \\\n -d '{\"prompt\":\"ping\"}' >/dev/null 2>&1; then\n ready=true\n break\n fi\n if ! kill -0 \"$APP_PID\" 2>/dev/null; then\n break\n fi\n sleep 1\n done\n\n if [ \"$ready\" = false ]; then\n echo \"Server did not become ready\"\n echo \"❌ $name failed (server not ready)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (server not ready)\"\n kill \"$APP_PID\" 2>/dev/null || true\n wait \"$APP_PID\" 2>/dev/null || true\n APP_PID=\"\"\n echo \"\"\n return\n fi\n\n # Send the real test request with timeout\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" curl -sf \"http://localhost:${app_port}/chat\" \\\n -X POST -H \"Content-Type: application/json\" \\\n -d '{\"prompt\":\"What is the capital of France?\"}' 2>&1) && code=0 || code=$?\n else\n output=$(curl -sf \"http://localhost:${app_port}/chat\" \\\n -X POST -H \"Content-Type: application/json\" \\\n -d '{\"prompt\":\"What is the capital of France?\"}' 2>&1) && code=0 || code=$?\n fi\n\n # Stop the HTTP server\n kill \"$APP_PID\" 2>/dev/null || true\n wait \"$APP_PID\" 2>/dev/null || true\n APP_PID=\"\"\n\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n echo \"$output\"\n if echo \"$output\" | grep -qi 'Paris\\|capital\\|France'; then\n echo \"✅ $name passed (got response with expected content)\"\n PASS=$((PASS + 1))\n else\n echo \"❌ $name failed (response missing expected content)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (no expected content)\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"${output:-(no output)}\"\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"${output:-(empty output)}\"\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\n# Kill any stale processes on the test ports from previous interrupted runs\nfor test_port in 18081 18082 18083 18084; do\n stale_pid=$(lsof -ti \":$test_port\" 2>/dev/null || true)\n if [ -n \"$stale_pid\" ]; then\n echo \"Killing stale process on port $test_port (PID $stale_pid)\"\n kill $stale_pid 2>/dev/null || true\n fi\ndone\n\necho \"══════════════════════════════════════\"\necho \" Starting Copilot CLI TCP server\"\necho \"══════════════════════════════════════\"\necho \"\"\n\nSERVER_PORT_FILE=$(mktemp)\n\"$COPILOT_CLI_PATH\" --headless --auth-token-env GITHUB_TOKEN > \"$SERVER_PORT_FILE\" 2>&1 &\nSERVER_PID=$!\n\n# Wait for server to announce its port\necho \"Waiting for server to be ready...\"\nPORT=\"\"\nfor i in $(seq 1 30); do\n if ! kill -0 \"$SERVER_PID\" 2>/dev/null; then\n echo \"❌ Server process exited unexpectedly\"\n cat \"$SERVER_PORT_FILE\" 2>/dev/null\n exit 1\n fi\n PORT=$(grep -o 'listening on port [0-9]*' \"$SERVER_PORT_FILE\" 2>/dev/null | grep -o '[0-9]*' || true)\n if [ -n \"$PORT\" ]; then\n break\n fi\n if [ \"$i\" -eq 30 ]; then\n echo \"❌ Server did not announce port within 30 seconds\"\n exit 1\n fi\n sleep 1\ndone\nexport COPILOT_CLI_URL=\"localhost:$PORT\"\necho \"Server is ready on port $PORT (PID $SERVER_PID)\"\necho \"\"\n\necho \"══════════════════════════════════════\"\necho \" Verifying app-backend-to-server samples\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o app-backend-to-server-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: start server, curl, stop\nrun_http_test \"TypeScript (run)\" \\\n \"cd '$SCRIPT_DIR/typescript' && PORT=18081 CLI_URL=$COPILOT_CLI_URL node dist/index.js\" \\\n 18081\n\n# Python: start server, curl, stop\nrun_http_test \"Python (run)\" \\\n \"cd '$SCRIPT_DIR/python' && PORT=18082 CLI_URL=$COPILOT_CLI_URL python3 main.py\" \\\n 18082\n\n# Go: start server, curl, stop\nrun_http_test \"Go (run)\" \\\n \"cd '$SCRIPT_DIR/go' && PORT=18083 CLI_URL=$COPILOT_CLI_URL ./app-backend-to-server-go\" \\\n 18083\n\n# C#: start server, curl, stop (extra retries for JIT startup)\nrun_http_test \"C# (run)\" \\\n \"cd '$SCRIPT_DIR/csharp' && PORT=18084 COPILOT_CLI_URL=$COPILOT_CLI_URL dotnet run --no-build\" \\\n 18084 \\\n 30\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/bundling/app-direct-server/README.md", "content": "# App-Direct-Server Samples\n\nSamples that demonstrate the **app-direct-server** deployment architecture of the Copilot SDK. In this scenario the SDK connects to a **pre-running** `copilot` TCP server — the app does not spawn or manage the server process.\n\n```\n┌─────────────┐ TCP (JSON-RPC) ┌──────────────┐\n│ Your App │ ─────────────────▶ │ Copilot CLI │\n│ (SDK) │ ◀───────────────── │ (TCP server) │\n└─────────────┘ └──────────────┘\n```\n\nEach sample follows the same flow:\n\n1. **Connect** to a running `copilot` server via TCP\n2. **Open a session** targeting the `gpt-4.1` model\n3. **Send a prompt** (\"What is the capital of France?\")\n4. **Print the response** and clean up\n\n## Languages\n\n| Directory | SDK / Approach | Language |\n|-----------|---------------|----------|\n| `typescript/` | `@github/copilot-sdk` | TypeScript (Node.js) |\n| `python/` | `github-copilot-sdk` | Python |\n| `go/` | `github.com/github/copilot-sdk/go` | Go |\n\n## Prerequisites\n\n- **Copilot CLI** — set `COPILOT_CLI_PATH`\n- **Authentication** — set `GITHUB_TOKEN`, or run `gh auth login`\n- **Node.js 20+** (TypeScript sample)\n- **Python 3.10+** (Python sample)\n- **Go 1.24+** (Go sample)\n\n## Starting the Server\n\nStart `copilot` as a TCP server before running any sample:\n\n```bash\ncopilot --port 3000 --headless --auth-token-env GITHUB_TOKEN\n```\n\n## Quick Start\n\n**TypeScript**\n```bash\ncd typescript\nnpm install && npm run build && npm start\n```\n\n**Python**\n```bash\ncd python\npip install -r requirements.txt\npython main.py\n```\n\n**Go**\n```bash\ncd go\ngo run main.go\n```\n\nAll samples default to `localhost:3000`. Override with the `COPILOT_CLI_URL` environment variable:\n\n```bash\nCOPILOT_CLI_URL=localhost:8080 npm start\n```\n\n## Verification\n\nA script is included that starts the server, builds, and end-to-end tests every sample:\n\n```bash\n./verify.sh\n```\n\nIt runs in three phases:\n\n1. **Server** — starts `copilot` on a random port (auto-detected from server output)\n2. **Build** — installs dependencies and compiles each sample\n3. **E2E Run** — executes each sample with a 60-second timeout and verifies it produces output\n\nThe server is automatically stopped when the script exits.\n" }, { "path": "test/scenarios/bundling/app-direct-server/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nvar cliUrl = Environment.GetEnvironmentVariable(\"COPILOT_CLI_URL\") ?? \"localhost:3000\";\n\nusing var client = new CopilotClient(new CopilotClientOptions { CliUrl = cliUrl });\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is the capital of France?\",\n });\n\n if (response?.Data?.Content != null)\n {\n Console.WriteLine(response.Data.Content);\n }\n else\n {\n Console.Error.WriteLine(\"No response content received\");\n Environment.Exit(1);\n }\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/bundling/app-direct-server/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/bundling/app-direct-server/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/bundling/app-direct-server/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/bundling/app-direct-server/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/bundling/app-direct-server/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tcliUrl := os.Getenv(\"COPILOT_CLI_URL\")\n\tif cliUrl == \"\" {\n\t\tcliUrl = \"localhost:3000\"\n\t}\n\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tCLIUrl: cliUrl,\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What is the capital of France?\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n}\n" }, { "path": "test/scenarios/bundling/app-direct-server/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import ExternalServerConfig\n\n\nasync def main():\n client = CopilotClient(ExternalServerConfig(\n url=os.environ.get(\"COPILOT_CLI_URL\", \"localhost:3000\"),\n ))\n\n try:\n session = await client.create_session({\"model\": \"claude-haiku-4.5\"})\n\n response = await session.send_and_wait(\n \"What is the capital of France?\"\n )\n\n if response:\n print(response.data.content)\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/bundling/app-direct-server/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/bundling/app-direct-server/typescript/package.json", "content": "{\n \"name\": \"bundling-app-direct-server-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"App-direct-server Copilot SDK sample — connects to a running Copilot CLI TCP server\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\",\n \"typescript\": \"^5.5.0\"\n }\n}\n" }, { "path": "test/scenarios/bundling/app-direct-server/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const client = new CopilotClient({\n cliUrl: process.env.COPILOT_CLI_URL || \"localhost:3000\",\n });\n\n try {\n const session = await client.createSession({ model: \"claude-haiku-4.5\" });\n\n const response = await session.sendAndWait({\n prompt: \"What is the capital of France?\",\n });\n\n if (response?.data.content) {\n console.log(response.data.content);\n } else {\n console.error(\"No response content received\");\n process.exit(1);\n }\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/bundling/app-direct-server/typescript/tsconfig.json", "content": "{\n \"compilerOptions\": {\n \"target\": \"ES2022\",\n \"module\": \"Node16\",\n \"moduleResolution\": \"Node16\",\n \"outDir\": \"dist\",\n \"rootDir\": \"src\",\n \"strict\": true,\n \"esModuleInterop\": true,\n \"skipLibCheck\": true\n },\n \"include\": [\"src\"]\n}\n" }, { "path": "test/scenarios/bundling/app-direct-server/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\nSERVER_PID=\"\"\nSERVER_PORT_FILE=\"\"\n\ncleanup() {\n if [ -n \"$SERVER_PID\" ] && kill -0 \"$SERVER_PID\" 2>/dev/null; then\n echo \"\"\n echo \"Stopping Copilot CLI server (PID $SERVER_PID)...\"\n kill \"$SERVER_PID\" 2>/dev/null || true\n wait \"$SERVER_PID\" 2>/dev/null || true\n fi\n [ -n \"$SERVER_PORT_FILE\" ] && rm -f \"$SERVER_PORT_FILE\"\n}\ntrap cleanup EXIT\n\n# Resolve Copilot CLI binary: use COPILOT_CLI_PATH env var or find the SDK bundled CLI.\nif [ -z \"${COPILOT_CLI_PATH:-}\" ]; then\n # Try to resolve from the TypeScript sample node_modules\n TS_DIR=\"$SCRIPT_DIR/typescript\"\n if [ -d \"$TS_DIR/node_modules/@github/copilot\" ]; then\n COPILOT_CLI_PATH=\"$(node -e \"console.log(require.resolve('@github/copilot'))\" 2>/dev/null || true)\"\n fi\n # Fallback: check PATH\n if [ -z \"${COPILOT_CLI_PATH:-}\" ]; then\n COPILOT_CLI_PATH=\"$(command -v copilot 2>/dev/null || true)\"\n fi\nfi\nif [ -z \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"❌ Could not find Copilot CLI binary.\"\n echo \" Set COPILOT_CLI_PATH or run: cd typescript && npm install\"\n exit 1\nfi\necho \"Using CLI: $COPILOT_CLI_PATH\"\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n echo \"$output\"\n echo \"✅ $name passed (got response)\"\n PASS=$((PASS + 1))\n elif [ \"$code\" -eq 124 ]; then\n echo \"${output:-(no output)}\"\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"${output:-(empty output)}\"\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Starting Copilot CLI TCP server\"\necho \"══════════════════════════════════════\"\necho \"\"\n\nSERVER_PORT_FILE=$(mktemp)\n\"$COPILOT_CLI_PATH\" --headless --auth-token-env GITHUB_TOKEN > \"$SERVER_PORT_FILE\" 2>&1 &\nSERVER_PID=$!\n\n# Wait for server to announce its port\necho \"Waiting for server to be ready...\"\nPORT=\"\"\nfor i in $(seq 1 30); do\n if ! kill -0 \"$SERVER_PID\" 2>/dev/null; then\n echo \"❌ Server process exited unexpectedly\"\n cat \"$SERVER_PORT_FILE\" 2>/dev/null\n exit 1\n fi\n PORT=$(grep -o 'listening on port [0-9]*' \"$SERVER_PORT_FILE\" 2>/dev/null | grep -o '[0-9]*' || true)\n if [ -n \"$PORT\" ]; then\n break\n fi\n if [ \"$i\" -eq 30 ]; then\n echo \"❌ Server did not announce port within 30 seconds\"\n exit 1\n fi\n sleep 1\ndone\nexport COPILOT_CLI_URL=\"localhost:$PORT\"\necho \"Server is ready on port $PORT (PID $SERVER_PID)\"\necho \"\"\n\necho \"══════════════════════════════════════\"\necho \" Verifying app-direct-server samples\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o app-direct-server-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"\n cd '$SCRIPT_DIR/typescript' && \\\n output=\\$(node dist/index.js 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital\\|France\\|response'\n\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"\n cd '$SCRIPT_DIR/python' && \\\n output=\\$(python3 main.py 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital\\|France\\|response'\n\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"\n cd '$SCRIPT_DIR/go' && \\\n output=\\$(./app-direct-server-go 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital\\|France\\|response'\n\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"\n cd '$SCRIPT_DIR/csharp' && \\\n output=\\$(COPILOT_CLI_URL=$COPILOT_CLI_URL dotnet run --no-build 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital\\|France\\|response'\n\"\n\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/bundling/container-proxy/.dockerignore", "content": "*\n!experimental-copilot-server/\nexperimental-copilot-server/target/\n" }, { "path": "test/scenarios/bundling/container-proxy/Dockerfile", "content": "# syntax=docker/dockerfile:1\n\n# Runtime image for Copilot CLI\n# The final image contains ONLY the binary — no source code, no credentials.\n# Requires a pre-built Copilot CLI binary to be copied in.\n\nFROM debian:bookworm-slim\n\nRUN apt-get update && apt-get install -y --no-install-recommends ca-certificates && rm -rf /var/lib/apt/lists/*\n\n# Copy a pre-built Copilot CLI binary\n# Set COPILOT_CLI_PATH build arg or provide the binary at build context root\nARG COPILOT_CLI_PATH=copilot\nCOPY ${COPILOT_CLI_PATH} /usr/local/bin/copilot\nRUN chmod +x /usr/local/bin/copilot\n\nEXPOSE 3000\n\nENTRYPOINT [\"copilot\", \"--headless\", \"--port\", \"3000\", \"--host\", \"0.0.0.0\", \"--auth-token-env\", \"GITHUB_TOKEN\"]\n" }, { "path": "test/scenarios/bundling/container-proxy/README.md", "content": "# Container-Proxy Samples\n\nRun the Copilot CLI inside a Docker container with a simple proxy on the host that returns canned responses. This demonstrates the deployment pattern where an external service intercepts the agent's LLM calls — in production the proxy would add credentials and forward to a real provider; here it just returns a fixed reply as proof-of-concept.\n\n```\n Host Machine\n┌──────────────────────────────────────────────────────┐\n│ │\n│ ┌─────────────┐ │\n│ │ Your App │ TCP :3000 │\n│ │ (SDK) │ ────────────────┐ │\n│ └─────────────┘ │ │\n│ ▼ │\n│ ┌──────────────────────────┐ │\n│ │ Docker Container │ │\n│ │ Copilot CLI │ │\n│ │ --port 3000 --headless │ │\n│ │ --host 0.0.0.0 │ │\n│ │ --auth-token-env │ │\n│ └────────────┬─────────────┘ │\n│ │ │\n│ HTTP to host.docker.internal:4000 │\n│ │ │\n│ ┌───────────▼──────────────┐ │\n│ │ proxy.py │ │\n│ │ (port 4000) │ │\n│ │ Returns canned response │ │\n│ └─────────────────────────-┘ │\n│ │\n└──────────────────────────────────────────────────────┘\n```\n\n## Why This Pattern?\n\nThe agent runtime (Copilot CLI) has **no access to API keys**. All LLM traffic flows through a proxy on the host. In production you would replace `proxy.py` with a real proxy that injects credentials and forwards to OpenAI/Anthropic/etc. This means:\n\n- **No secrets in the image** — safe to share, scan, deploy anywhere\n- **No secrets at runtime** — even if the container is compromised, there are no tokens to steal\n- **Swap providers freely** — change the proxy target without rebuilding the container\n- **Centralized key management** — one proxy manages keys for all your agents/services\n\n## Prerequisites\n\n- **Docker** with Docker Compose\n- **Python 3** (for the proxy — uses only stdlib, no pip install needed)\n\n## Setup\n\n### 1. Start the proxy\n\n```bash\npython3 proxy.py 4000\n```\n\nThis starts a minimal OpenAI-compatible HTTP server on port 4000 that returns a canned \"The capital of France is Paris.\" response for every request.\n\n### 2. Start the Copilot CLI in Docker\n\n```bash\ndocker compose up -d --build\n```\n\nThis builds the Copilot CLI from source and starts it on port 3000. It sends LLM requests to `host.docker.internal:4000` — no API keys are passed into the container.\n\n### 3. Run a client sample\n\n**TypeScript**\n```bash\ncd typescript && npm install && npm run build && npm start\n```\n\n**Python**\n```bash\ncd python && pip install -r requirements.txt && python main.py\n```\n\n**Go**\n```bash\ncd go && go run main.go\n```\n\nAll samples connect to `localhost:3000` by default. Override with `COPILOT_CLI_URL`.\n\n## Verification\n\nRun all samples end-to-end:\n\n```bash\nchmod +x verify.sh\n./verify.sh\n```\n\n## Languages\n\n| Directory | SDK / Approach | Language |\n|-----------|---------------|----------|\n| `typescript/` | `@github/copilot-sdk` | TypeScript (Node.js) |\n| `python/` | `github-copilot-sdk` | Python |\n| `go/` | `github.com/github/copilot-sdk/go` | Go |\n\n## How It Works\n\n1. **Copilot CLI** starts in Docker with `COPILOT_API_URL=http://host.docker.internal:4000` — this overrides the default Copilot API endpoint to point at the proxy\n2. When the agent needs to call an LLM, it sends a standard OpenAI-format request to the proxy\n3. **proxy.py** receives the request and returns a canned response (in production, this would inject credentials and forward to a real provider)\n4. The response flows back: proxy → Copilot CLI → your app\n\nThe container never sees or needs any API credentials.\n" }, { "path": "test/scenarios/bundling/container-proxy/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nvar cliUrl = Environment.GetEnvironmentVariable(\"COPILOT_CLI_URL\") ?? \"localhost:3000\";\n\nusing var client = new CopilotClient(new CopilotClientOptions { CliUrl = cliUrl });\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is the capital of France?\",\n });\n\n if (response?.Data?.Content != null)\n {\n Console.WriteLine(response.Data.Content);\n }\n else\n {\n Console.Error.WriteLine(\"No response content received\");\n Environment.Exit(1);\n }\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/bundling/container-proxy/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/bundling/container-proxy/docker-compose.yml", "content": "# Container-proxy sample: Copilot CLI in Docker, simple proxy on host.\n#\n# The proxy (proxy.py) runs on the host and returns canned responses.\n# This demonstrates the network path without needing real LLM credentials.\n#\n# Usage:\n# 1. Start the proxy on the host: python3 proxy.py 4000\n# 2. Start the container: docker compose up -d\n# 3. Run client samples against localhost:3000\n\nservices:\n copilot-cli:\n build:\n context: ../../../..\n dockerfile: test/scenarios/bundling/container-proxy/Dockerfile\n ports:\n - \"3000:3000\"\n environment:\n # Point LLM requests at the host proxy — returns canned responses\n COPILOT_API_URL: \"http://host.docker.internal:4000\"\n # Dummy token so Copilot CLI enters the Token auth path\n GITHUB_TOKEN: \"not-used\"\n extra_hosts:\n - \"host.docker.internal:host-gateway\"\n" }, { "path": "test/scenarios/bundling/container-proxy/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/bundling/container-proxy/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/bundling/container-proxy/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/bundling/container-proxy/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tcliUrl := os.Getenv(\"COPILOT_CLI_URL\")\n\tif cliUrl == \"\" {\n\t\tcliUrl = \"localhost:3000\"\n\t}\n\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tCLIUrl: cliUrl,\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What is the capital of France?\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n}\n" }, { "path": "test/scenarios/bundling/container-proxy/proxy.py", "content": "#!/usr/bin/env python3\n\"\"\"\nMinimal OpenAI-compatible proxy for the container-proxy sample.\n\nThis replaces a real LLM provider — Copilot CLI (running in Docker) sends\nits model requests here and gets back a canned response. The point is to\nprove the network path:\n\n client → Copilot CLI (container :3000) → this proxy (host :4000)\n\"\"\"\n\nimport json\nimport sys\nimport time\nfrom http.server import HTTPServer, BaseHTTPRequestHandler\n\n\nclass ProxyHandler(BaseHTTPRequestHandler):\n def do_POST(self):\n length = int(self.headers.get(\"Content-Length\", 0))\n body = json.loads(self.rfile.read(length)) if length else {}\n\n model = body.get(\"model\", \"claude-haiku-4.5\")\n stream = body.get(\"stream\", False)\n\n if stream:\n self._handle_stream(model)\n else:\n self._handle_non_stream(model)\n\n def do_GET(self):\n # Health check\n self.send_response(200)\n self.send_header(\"Content-Type\", \"application/json\")\n self.end_headers()\n self.wfile.write(json.dumps({\"status\": \"ok\"}).encode())\n\n # ── Non-streaming ────────────────────────────────────────────────\n\n def _handle_non_stream(self, model: str):\n resp = {\n \"id\": \"chatcmpl-proxy-0001\",\n \"object\": \"chat.completion\",\n \"created\": int(time.time()),\n \"model\": model,\n \"choices\": [\n {\n \"index\": 0,\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"The capital of France is Paris.\",\n },\n \"finish_reason\": \"stop\",\n }\n ],\n \"usage\": {\"prompt_tokens\": 0, \"completion_tokens\": 0, \"total_tokens\": 0},\n }\n payload = json.dumps(resp).encode()\n self.send_response(200)\n self.send_header(\"Content-Type\", \"application/json\")\n self.send_header(\"Content-Length\", str(len(payload)))\n self.end_headers()\n self.wfile.write(payload)\n\n # ── Streaming (SSE) ──────────────────────────────────────────────\n\n def _handle_stream(self, model: str):\n self.send_response(200)\n self.send_header(\"Content-Type\", \"text/event-stream\")\n self.send_header(\"Cache-Control\", \"no-cache\")\n self.end_headers()\n\n ts = int(time.time())\n\n # Single content chunk\n chunk = {\n \"id\": \"chatcmpl-proxy-0001\",\n \"object\": \"chat.completion.chunk\",\n \"created\": ts,\n \"model\": model,\n \"choices\": [\n {\n \"index\": 0,\n \"delta\": {\"role\": \"assistant\", \"content\": \"The capital of France is Paris.\"},\n \"finish_reason\": None,\n }\n ],\n }\n self.wfile.write(f\"data: {json.dumps(chunk)}\\n\\n\".encode())\n self.wfile.flush()\n\n # Final chunk with finish_reason\n done_chunk = {\n \"id\": \"chatcmpl-proxy-0001\",\n \"object\": \"chat.completion.chunk\",\n \"created\": ts,\n \"model\": model,\n \"choices\": [\n {\n \"index\": 0,\n \"delta\": {},\n \"finish_reason\": \"stop\",\n }\n ],\n }\n self.wfile.write(f\"data: {json.dumps(done_chunk)}\\n\\n\".encode())\n self.wfile.write(b\"data: [DONE]\\n\\n\")\n self.wfile.flush()\n\n def log_message(self, format, *args):\n print(f\"[proxy] {args[0]}\", file=sys.stderr)\n\n\ndef main():\n port = int(sys.argv[1]) if len(sys.argv) > 1 else 4000\n server = HTTPServer((\"0.0.0.0\", port), ProxyHandler)\n print(f\"Proxy listening on :{port}\", flush=True)\n server.serve_forever()\n\n\nif __name__ == \"__main__\":\n main()\n" }, { "path": "test/scenarios/bundling/container-proxy/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import ExternalServerConfig\n\n\nasync def main():\n client = CopilotClient(ExternalServerConfig(\n url=os.environ.get(\"COPILOT_CLI_URL\", \"localhost:3000\"),\n ))\n\n try:\n session = await client.create_session({\"model\": \"claude-haiku-4.5\"})\n\n response = await session.send_and_wait(\n \"What is the capital of France?\"\n )\n\n if response:\n print(response.data.content)\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/bundling/container-proxy/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/bundling/container-proxy/typescript/package.json", "content": "{\n \"name\": \"bundling-container-proxy-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Container-proxy Copilot SDK sample — connects to Copilot CLI running in Docker\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\",\n \"typescript\": \"^5.5.0\"\n }\n}\n" }, { "path": "test/scenarios/bundling/container-proxy/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const client = new CopilotClient({\n cliUrl: process.env.COPILOT_CLI_URL || \"localhost:3000\",\n });\n\n try {\n const session = await client.createSession({ model: \"claude-haiku-4.5\" });\n\n const response = await session.sendAndWait({\n prompt: \"What is the capital of France?\",\n });\n\n if (response?.data.content) {\n console.log(response.data.content);\n } else {\n console.error(\"No response content received\");\n process.exit(1);\n }\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/bundling/container-proxy/typescript/tsconfig.json", "content": "{\n \"compilerOptions\": {\n \"target\": \"ES2022\",\n \"module\": \"Node16\",\n \"moduleResolution\": \"Node16\",\n \"outDir\": \"dist\",\n \"rootDir\": \"src\",\n \"strict\": true,\n \"esModuleInterop\": true,\n \"skipLibCheck\": true\n },\n \"include\": [\"src\"]\n}\n" }, { "path": "test/scenarios/bundling/container-proxy/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\n# Skip if runtime source not available (needed for Docker build)\nif [ ! -d \"$ROOT_DIR/runtime\" ]; then\n echo \"SKIP: runtime/ directory not found — cannot build Copilot CLI Docker image\"\n exit 0\nfi\n\ncleanup() {\n echo \"\"\n if [ -n \"${PROXY_PID:-}\" ] && kill -0 \"$PROXY_PID\" 2>/dev/null; then\n echo \"Stopping proxy (PID $PROXY_PID)...\"\n kill \"$PROXY_PID\" 2>/dev/null || true\n fi\n echo \"Stopping Docker container...\"\n docker compose -f \"$SCRIPT_DIR/docker-compose.yml\" down --timeout 5 2>/dev/null || true\n}\ntrap cleanup EXIT\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n echo \"$output\"\n echo \"✅ $name passed (got response)\"\n PASS=$((PASS + 1))\n elif [ \"$code\" -eq 124 ]; then\n echo \"${output:-(no output)}\"\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"${output:-(empty output)}\"\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\n# Kill any stale processes on test ports from previous interrupted runs\nfor test_port in 3000 4000; do\n stale_pid=$(lsof -ti \":$test_port\" 2>/dev/null || true)\n if [ -n \"$stale_pid\" ]; then\n echo \"Cleaning up stale process on port $test_port (PID $stale_pid)\"\n kill $stale_pid 2>/dev/null || true\n fi\ndone\ndocker compose -f \"$SCRIPT_DIR/docker-compose.yml\" down --timeout 5 2>/dev/null || true\n\n# ── Start the simple proxy ───────────────────────────────────────────\nPROXY_PORT=4000\nPROXY_PID=\"\"\n\necho \"══════════════════════════════════════\"\necho \" Starting proxy on port $PROXY_PORT\"\necho \"══════════════════════════════════════\"\necho \"\"\n\npython3 \"$SCRIPT_DIR/proxy.py\" \"$PROXY_PORT\" &\nPROXY_PID=$!\nsleep 1\n\nif kill -0 \"$PROXY_PID\" 2>/dev/null; then\n echo \"✅ Proxy running (PID $PROXY_PID)\"\nelse\n echo \"❌ Proxy failed to start\"\n exit 1\nfi\necho \"\"\n\n# ── Build and start container ────────────────────────────────────────\necho \"══════════════════════════════════════\"\necho \" Building and starting Copilot CLI container\"\necho \"══════════════════════════════════════\"\necho \"\"\n\ndocker compose -f \"$SCRIPT_DIR/docker-compose.yml\" up -d --build\n\n# Wait for Copilot CLI to be ready\necho \"Waiting for Copilot CLI to be ready...\"\nfor i in $(seq 1 30); do\n if (echo > /dev/tcp/localhost/3000) 2>/dev/null; then\n echo \"✅ Copilot CLI is ready on port 3000\"\n break\n fi\n if [ \"$i\" -eq 30 ]; then\n echo \"❌ Copilot CLI did not become ready within 30 seconds\"\n docker compose -f \"$SCRIPT_DIR/docker-compose.yml\" logs\n exit 1\n fi\n sleep 1\ndone\necho \"\"\n\nexport COPILOT_CLI_URL=\"localhost:3000\"\n\necho \"══════════════════════════════════════\"\necho \" Phase 1: Build client samples\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o container-proxy-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"\n cd '$SCRIPT_DIR/typescript' && \\\n output=\\$(node dist/index.js 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital'\n\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"\n cd '$SCRIPT_DIR/python' && \\\n output=\\$(python3 main.py 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital'\n\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"\n cd '$SCRIPT_DIR/go' && \\\n output=\\$(./container-proxy-go 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital'\n\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"\n cd '$SCRIPT_DIR/csharp' && \\\n output=\\$(COPILOT_CLI_URL=$COPILOT_CLI_URL dotnet run --no-build 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital'\n\"\n\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/bundling/fully-bundled/README.md", "content": "# Fully-Bundled Samples\n\nSelf-contained samples that demonstrate the **fully-bundled** deployment architecture of the Copilot SDK. In this scenario the SDK spawns `copilot` as a child process over stdio — no external server or container is required.\n\nEach sample follows the same flow:\n\n1. **Create a client** that spawns `copilot` automatically\n2. **Open a session** targeting the `gpt-4.1` model\n3. **Send a prompt** (\"What is the capital of France?\")\n4. **Print the response** and clean up\n\n## Languages\n\n| Directory | SDK / Approach | Language |\n|-----------|---------------|----------|\n| `typescript/` | `@github/copilot-sdk` | TypeScript (Node.js) |\n| `typescript-wasm/` | `@github/copilot-sdk` with WASM runtime | TypeScript (Node.js) |\n| `python/` | `github-copilot-sdk` | Python |\n| `go/` | `github.com/github/copilot-sdk/go` | Go |\n\n## Prerequisites\n\n- **Copilot CLI** — set `COPILOT_CLI_PATH`\n- **Authentication** — set `GITHUB_TOKEN`, or run `gh auth login`\n- **Node.js 20+** (TypeScript samples)\n- **Python 3.10+** (Python sample)\n- **Go 1.24+** (Go sample)\n\n## Quick Start\n\n**TypeScript**\n```bash\ncd typescript\nnpm install && npm run build && npm start\n```\n\n**TypeScript (WASM)**\n```bash\ncd typescript-wasm\nnpm install && npm run build && npm start\n```\n\n**Python**\n```bash\ncd python\npip install -r requirements.txt\npython main.py\n```\n\n**Go**\n```bash\ncd go\ngo run main.go\n```\n\n## Verification\n\nA script is included to build and end-to-end test every sample:\n\n```bash\n./verify.sh\n```\n\nIt runs in two phases:\n\n1. **Build** — installs dependencies and compiles each sample\n2. **E2E Run** — executes each sample with a 60-second timeout and verifies it produces output\n\nSet `COPILOT_CLI_PATH` to point at your `copilot` binary if it isn't in the default location.\n" }, { "path": "test/scenarios/bundling/fully-bundled/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is the capital of France?\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/bundling/fully-bundled/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/bundling/fully-bundled/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/bundling/fully-bundled/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/bundling/fully-bundled/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/bundling/fully-bundled/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\t// Go SDK auto-reads COPILOT_CLI_PATH from env\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What is the capital of France?\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n}\n" }, { "path": "test/scenarios/bundling/fully-bundled/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session({\"model\": \"claude-haiku-4.5\"})\n\n response = await session.send_and_wait(\n \"What is the capital of France?\"\n )\n\n if response:\n print(response.data.content)\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/bundling/fully-bundled/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/bundling/fully-bundled/typescript/package.json", "content": "{\n \"name\": \"bundling-fully-bundled-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Fully-bundled Copilot SDK sample — spawns Copilot CLI via stdio\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\",\n \"typescript\": \"^5.5.0\"\n }\n}\n" }, { "path": "test/scenarios/bundling/fully-bundled/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n const session = await client.createSession({ model: \"claude-haiku-4.5\" });\n\n const response = await session.sendAndWait({\n prompt: \"What is the capital of France?\",\n });\n\n if (response) {\n console.log(response.data.content);\n }\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/bundling/fully-bundled/typescript/tsconfig.json", "content": "{\n \"compilerOptions\": {\n \"target\": \"ES2022\",\n \"module\": \"Node16\",\n \"moduleResolution\": \"Node16\",\n \"outDir\": \"dist\",\n \"rootDir\": \"src\",\n \"strict\": true,\n \"esModuleInterop\": true,\n \"skipLibCheck\": true\n },\n \"include\": [\"src\"]\n}\n" }, { "path": "test/scenarios/bundling/fully-bundled/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n echo \"$output\"\n echo \"✅ $name passed (got response)\"\n PASS=$((PASS + 1))\n elif [ \"$code\" -eq 124 ]; then\n echo \"${output:-(no output)}\"\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"${output:-(empty output)}\"\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying fully-bundled samples\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o fully-bundled-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"\n cd '$SCRIPT_DIR/typescript' && \\\n output=\\$(node dist/index.js 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital\\|France\\|response'\n\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"\n cd '$SCRIPT_DIR/python' && \\\n output=\\$(python3 main.py 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital\\|France\\|response'\n\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"\n cd '$SCRIPT_DIR/go' && \\\n output=\\$(./fully-bundled-go 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital\\|France\\|response'\n\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"\n cd '$SCRIPT_DIR/csharp' && \\\n output=\\$(dotnet run --no-build 2>&1) && \\\n echo \\\"\\$output\\\" && \\\n echo \\\"\\$output\\\" | grep -qi 'Paris\\|capital\\|France\\|response'\n\"\n\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/callbacks/hooks/README.md", "content": "# configs/hooks — Session Lifecycle Hooks\n\nDemonstrates all SDK session lifecycle hooks firing during a typical prompt–tool–response cycle.\n\n## Hooks Tested\n\n| Hook | When It Fires | Purpose |\n|------|---------------|---------|\n| `onSessionStart` | Session is created | Initialize logging, metrics, or state |\n| `onSessionEnd` | Session is destroyed | Clean up resources, flush logs |\n| `onPreToolUse` | Before a tool executes | Approve/deny tool calls, audit usage |\n| `onPostToolUse` | After a tool executes | Log results, collect metrics |\n| `onUserPromptSubmitted` | User sends a prompt | Transform, validate, or log prompts |\n| `onErrorOccurred` | An error is raised | Centralized error handling |\n\n## What This Scenario Does\n\n1. Creates a session with **all** lifecycle hooks registered.\n2. Each hook appends its name to a log list when invoked.\n3. Sends a prompt that triggers tool use (glob file listing).\n4. Prints the model's response followed by the hook execution log showing which hooks fired and in what order.\n\n## Run\n\n```bash\n# TypeScript\ncd typescript && npm install && npm run build && node dist/index.js\n\n# Python\ncd python && pip install -r requirements.txt && python3 main.py\n\n# Go\ncd go && go run .\n```\n\n## Verify All\n\n```bash\n./verify.sh\n```\n" }, { "path": "test/scenarios/callbacks/hooks/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nvar hookLog = new List();\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n OnPermissionRequest = (request, invocation) =>\n Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved }),\n Hooks = new SessionHooks\n {\n OnSessionStart = (input, invocation) =>\n {\n hookLog.Add(\"onSessionStart\");\n return Task.FromResult(null);\n },\n OnSessionEnd = (input, invocation) =>\n {\n hookLog.Add(\"onSessionEnd\");\n return Task.FromResult(null);\n },\n OnPreToolUse = (input, invocation) =>\n {\n hookLog.Add($\"onPreToolUse:{input.ToolName}\");\n return Task.FromResult(new PreToolUseHookOutput { PermissionDecision = \"allow\" });\n },\n OnPostToolUse = (input, invocation) =>\n {\n hookLog.Add($\"onPostToolUse:{input.ToolName}\");\n return Task.FromResult(null);\n },\n OnUserPromptSubmitted = (input, invocation) =>\n {\n hookLog.Add(\"onUserPromptSubmitted\");\n return Task.FromResult(null);\n },\n OnErrorOccurred = (input, invocation) =>\n {\n hookLog.Add($\"onErrorOccurred:{input.Error}\");\n return Task.FromResult(null);\n },\n },\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"List the files in the current directory using the glob tool with pattern '*.md'.\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n\n Console.WriteLine(\"\\n--- Hook execution log ---\");\n foreach (var entry in hookLog)\n {\n Console.WriteLine($\" {entry}\");\n }\n Console.WriteLine($\"\\nTotal hooks fired: {hookLog.Count}\");\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/callbacks/hooks/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/callbacks/hooks/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/callbacks/hooks/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/callbacks/hooks/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/callbacks/hooks/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\t\"sync\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tvar (\n\t\thookLog []string\n\t\thookLogMu sync.Mutex\n\t)\n\n\tappendLog := func(entry string) {\n\t\thookLogMu.Lock()\n\t\thookLog = append(hookLog, entry)\n\t\thookLogMu.Unlock()\n\t}\n\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t\tOnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\treturn copilot.PermissionRequestResult{Kind: \"approved\"}, nil\n\t\t},\n\t\tHooks: &copilot.SessionHooks{\n\t\t\tOnSessionStart: func(input copilot.SessionStartHookInput, inv copilot.HookInvocation) (*copilot.SessionStartHookOutput, error) {\n\t\t\t\tappendLog(\"onSessionStart\")\n\t\t\t\treturn nil, nil\n\t\t\t},\n\t\t\tOnSessionEnd: func(input copilot.SessionEndHookInput, inv copilot.HookInvocation) (*copilot.SessionEndHookOutput, error) {\n\t\t\t\tappendLog(\"onSessionEnd\")\n\t\t\t\treturn nil, nil\n\t\t\t},\n\t\t\tOnPreToolUse: func(input copilot.PreToolUseHookInput, inv copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {\n\t\t\t\tappendLog(fmt.Sprintf(\"onPreToolUse:%s\", input.ToolName))\n\t\t\t\treturn &copilot.PreToolUseHookOutput{PermissionDecision: \"allow\"}, nil\n\t\t\t},\n\t\t\tOnPostToolUse: func(input copilot.PostToolUseHookInput, inv copilot.HookInvocation) (*copilot.PostToolUseHookOutput, error) {\n\t\t\t\tappendLog(fmt.Sprintf(\"onPostToolUse:%s\", input.ToolName))\n\t\t\t\treturn nil, nil\n\t\t\t},\n\t\t\tOnUserPromptSubmitted: func(input copilot.UserPromptSubmittedHookInput, inv copilot.HookInvocation) (*copilot.UserPromptSubmittedHookOutput, error) {\n\t\t\t\tappendLog(\"onUserPromptSubmitted\")\n\t\t\t\treturn &copilot.UserPromptSubmittedHookOutput{ModifiedPrompt: input.Prompt}, nil\n\t\t\t},\n\t\t\tOnErrorOccurred: func(input copilot.ErrorOccurredHookInput, inv copilot.HookInvocation) (*copilot.ErrorOccurredHookOutput, error) {\n\t\t\t\tappendLog(fmt.Sprintf(\"onErrorOccurred:%s\", input.Error))\n\t\t\t\treturn nil, nil\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"List the files in the current directory using the glob tool with pattern '*.md'.\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n\n\tfmt.Println(\"\\n--- Hook execution log ---\")\n\thookLogMu.Lock()\n\tfor _, entry := range hookLog {\n\t\tfmt.Printf(\" %s\\n\", entry)\n\t}\n\tfmt.Printf(\"\\nTotal hooks fired: %d\\n\", len(hookLog))\n\thookLogMu.Unlock()\n}\n" }, { "path": "test/scenarios/callbacks/hooks/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\n\nhook_log: list[str] = []\n\n\nasync def auto_approve_permission(request, invocation):\n return {\"kind\": \"approved\"}\n\n\nasync def on_session_start(input_data, invocation):\n hook_log.append(\"onSessionStart\")\n\n\nasync def on_session_end(input_data, invocation):\n hook_log.append(\"onSessionEnd\")\n\n\nasync def on_pre_tool_use(input_data, invocation):\n tool_name = input_data.get(\"toolName\", \"unknown\")\n hook_log.append(f\"onPreToolUse:{tool_name}\")\n return {\"permissionDecision\": \"allow\"}\n\n\nasync def on_post_tool_use(input_data, invocation):\n tool_name = input_data.get(\"toolName\", \"unknown\")\n hook_log.append(f\"onPostToolUse:{tool_name}\")\n\n\nasync def on_user_prompt_submitted(input_data, invocation):\n hook_log.append(\"onUserPromptSubmitted\")\n return input_data\n\n\nasync def on_error_occurred(input_data, invocation):\n error = input_data.get(\"error\", \"unknown\")\n hook_log.append(f\"onErrorOccurred:{error}\")\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session(\n {\n \"model\": \"claude-haiku-4.5\",\n \"on_permission_request\": auto_approve_permission,\n \"hooks\": {\n \"on_session_start\": on_session_start,\n \"on_session_end\": on_session_end,\n \"on_pre_tool_use\": on_pre_tool_use,\n \"on_post_tool_use\": on_post_tool_use,\n \"on_user_prompt_submitted\": on_user_prompt_submitted,\n \"on_error_occurred\": on_error_occurred,\n },\n }\n )\n\n response = await session.send_and_wait(\n \"List the files in the current directory using the glob tool with pattern '*.md'.\"\n )\n\n if response:\n print(response.data.content)\n\n await session.disconnect()\n\n print(\"\\n--- Hook execution log ---\")\n for entry in hook_log:\n print(f\" {entry}\")\n print(f\"\\nTotal hooks fired: {len(hook_log)}\")\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/callbacks/hooks/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/callbacks/hooks/typescript/package.json", "content": "{\n \"name\": \"callbacks-hooks-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Config sample — session lifecycle hooks\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/callbacks/hooks/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const hookLog: string[] = [];\n\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n const session = await client.createSession({\n model: \"claude-haiku-4.5\",\n onPermissionRequest: async () => ({ kind: \"approved\" as const }),\n hooks: {\n onSessionStart: async () => {\n hookLog.push(\"onSessionStart\");\n },\n onSessionEnd: async () => {\n hookLog.push(\"onSessionEnd\");\n },\n onPreToolUse: async (input) => {\n hookLog.push(`onPreToolUse:${input.toolName}`);\n return { permissionDecision: \"allow\" as const };\n },\n onPostToolUse: async (input) => {\n hookLog.push(`onPostToolUse:${input.toolName}`);\n },\n onUserPromptSubmitted: async (input) => {\n hookLog.push(\"onUserPromptSubmitted\");\n return input;\n },\n onErrorOccurred: async (input) => {\n hookLog.push(`onErrorOccurred:${input.error}`);\n },\n },\n });\n\n const response = await session.sendAndWait({\n prompt: \"List the files in the current directory using the glob tool with pattern '*.md'.\",\n });\n\n if (response) {\n console.log(response.data.content);\n }\n\n await session.disconnect();\n\n console.log(\"\\n--- Hook execution log ---\");\n for (const entry of hookLog) {\n console.log(` ${entry}`);\n }\n console.log(`\\nTotal hooks fired: ${hookLog.length}`);\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/callbacks/hooks/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n echo \"$output\"\n\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n local missing=\"\"\n if ! echo \"$output\" | grep -q \"onSessionStart\\|on_session_start\\|OnSessionStart\"; then\n missing=\"$missing onSessionStart\"\n fi\n if ! echo \"$output\" | grep -q \"onPreToolUse\\|on_pre_tool_use\\|OnPreToolUse\"; then\n missing=\"$missing onPreToolUse\"\n fi\n if ! echo \"$output\" | grep -q \"onPostToolUse\\|on_post_tool_use\\|OnPostToolUse\"; then\n missing=\"$missing onPostToolUse\"\n fi\n if ! echo \"$output\" | grep -q \"onSessionEnd\\|on_session_end\\|OnSessionEnd\"; then\n missing=\"$missing onSessionEnd\"\n fi\n if [ -z \"$missing\" ]; then\n echo \"✅ $name passed (all hooks confirmed)\"\n PASS=$((PASS + 1))\n else\n echo \"❌ $name failed (missing hooks:$missing)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (missing:$missing)\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying callbacks/hooks\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + build\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o hooks-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./hooks-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/callbacks/permissions/README.md", "content": "# Config Sample: Permissions\n\nDemonstrates the **permission request flow** — the runtime asks the SDK for permission before executing tools, and the SDK can approve or deny each request. This sample approves all requests while logging which tools were invoked.\n\nThis pattern is the foundation for:\n- **Enterprise policy enforcement** where certain tools are restricted\n- **Audit logging** where all tool invocations must be recorded\n- **Interactive approval UIs** where a human confirms sensitive operations\n- **Fine-grained access control** based on tool name, arguments, or context\n\n## How It Works\n\n1. **Enable `onPermissionRequest` handler** on the session config\n2. **Track which tools requested permission** in a log array\n3. **Approve all permission requests** (return `kind: \"approved\"`)\n4. **Send a prompt that triggers tool use** (e.g., listing files via glob)\n5. **Print the permission log** showing which tools were approved\n\n## What Each Sample Does\n\n1. Creates a session with an `onPermissionRequest` callback that logs and approves\n2. Sends: _\"List the files in the current directory using glob with pattern '*'.\"_\n3. The runtime calls `onPermissionRequest` before each tool execution\n4. The callback records `approved:` and returns approval\n5. Prints the agent's response\n6. Dumps the permission log showing all approved tool invocations\n\n## Configuration\n\n| Option | Value | Effect |\n|--------|-------|--------|\n| `onPermissionRequest` | Log + approve | Records tool name, returns `approved` |\n| `hooks.onPreToolUse` | Auto-allow | No tool confirmation prompts |\n\n## Key Insight\n\nThe `onPermissionRequest` handler gives the integrator full control over which tools the agent can execute. By inspecting the request (tool name, arguments), you can implement allow/deny lists, require human approval for dangerous operations, or log every action for compliance. Returning `{ kind: \"denied\" }` blocks the tool from running.\n\n## Run\n\n```bash\n./verify.sh\n```\n\nRequires the `copilot` binary (auto-detected or set `COPILOT_CLI_PATH`) and `GITHUB_TOKEN`.\n" }, { "path": "test/scenarios/callbacks/permissions/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nvar permissionLog = new List();\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n OnPermissionRequest = (request, invocation) =>\n {\n var toolName = request switch\n {\n PermissionRequestCustomTool ct => ct.ToolName,\n PermissionRequestShell sh => \"shell\",\n PermissionRequestWrite wr => wr.FileName ?? \"write\",\n PermissionRequestRead rd => rd.Path ?? \"read\",\n PermissionRequestMcp mcp => mcp.ToolName ?? \"mcp\",\n _ => request.Kind,\n };\n permissionLog.Add($\"approved:{toolName}\");\n return Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved });\n },\n Hooks = new SessionHooks\n {\n OnPreToolUse = (input, invocation) =>\n Task.FromResult(new PreToolUseHookOutput { PermissionDecision = \"allow\" }),\n },\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"List the files in the current directory using glob with pattern '*.md'.\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n\n Console.WriteLine(\"\\n--- Permission request log ---\");\n foreach (var entry in permissionLog)\n {\n Console.WriteLine($\" {entry}\");\n }\n Console.WriteLine($\"\\nTotal permission requests: {permissionLog.Count}\");\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/callbacks/permissions/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/callbacks/permissions/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/callbacks/permissions/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/callbacks/permissions/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/callbacks/permissions/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\t\"sync\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tvar (\n\t\tpermissionLog []string\n\t\tpermissionLogMu sync.Mutex\n\t)\n\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t\tOnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\tpermissionLogMu.Lock()\n\t\t\ttoolName := \"\"\n\t\t\tif req.ToolName != nil {\n\t\t\t\ttoolName = *req.ToolName\n\t\t\t}\n\t\t\tpermissionLog = append(permissionLog, fmt.Sprintf(\"approved:%s\", toolName))\n\t\t\tpermissionLogMu.Unlock()\n\t\t\treturn copilot.PermissionRequestResult{Kind: \"approved\"}, nil\n\t\t},\n\t\tHooks: &copilot.SessionHooks{\n\t\t\tOnPreToolUse: func(input copilot.PreToolUseHookInput, inv copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {\n\t\t\t\treturn &copilot.PreToolUseHookOutput{PermissionDecision: \"allow\"}, nil\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"List the files in the current directory using glob with pattern '*.md'.\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n\n\tfmt.Println(\"\\n--- Permission request log ---\")\n\tfor _, entry := range permissionLog {\n\t\tfmt.Printf(\" %s\\n\", entry)\n\t}\n\tfmt.Printf(\"\\nTotal permission requests: %d\\n\", len(permissionLog))\n}\n" }, { "path": "test/scenarios/callbacks/permissions/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\n# Track which tools requested permission\npermission_log: list[str] = []\n\n\nasync def log_permission(request, invocation):\n permission_log.append(f\"approved:{request.tool_name}\")\n return {\"kind\": \"approved\"}\n\n\nasync def auto_approve_tool(input_data, invocation):\n return {\"permissionDecision\": \"allow\"}\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session(\n {\n \"model\": \"claude-haiku-4.5\",\n \"on_permission_request\": log_permission,\n \"hooks\": {\"on_pre_tool_use\": auto_approve_tool},\n }\n )\n\n response = await session.send_and_wait(\n \"List the files in the current directory using glob with pattern '*.md'.\"\n )\n\n if response:\n print(response.data.content)\n\n await session.disconnect()\n\n print(\"\\n--- Permission request log ---\")\n for entry in permission_log:\n print(f\" {entry}\")\n print(f\"\\nTotal permission requests: {len(permission_log)}\")\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/callbacks/permissions/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/callbacks/permissions/typescript/package.json", "content": "{\n \"name\": \"callbacks-permissions-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Config sample — permission request flow for tool execution\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/callbacks/permissions/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const permissionLog: string[] = [];\n\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && {\n cliPath: process.env.COPILOT_CLI_PATH,\n }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n const session = await client.createSession({\n model: \"claude-haiku-4.5\",\n onPermissionRequest: async (request) => {\n permissionLog.push(`approved:${request.toolName}`);\n return { kind: \"approved\" as const };\n },\n hooks: {\n onPreToolUse: async () => ({ permissionDecision: \"allow\" as const }),\n },\n });\n\n const response = await session.sendAndWait({\n prompt:\n \"List the files in the current directory using glob with pattern '*.md'.\",\n });\n\n if (response) {\n console.log(response.data.content);\n }\n\n await session.disconnect();\n\n console.log(\"\\n--- Permission request log ---\");\n for (const entry of permissionLog) {\n console.log(` ${entry}`);\n }\n console.log(`\\nTotal permission requests: ${permissionLog.length}`);\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/callbacks/permissions/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n echo \"$output\"\n\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n local missing=\"\"\n if ! echo \"$output\" | grep -qi \"approved:\"; then\n missing=\"$missing approved-string\"\n fi\n if ! echo \"$output\" | grep -qE \"Total permission requests: [1-9]\"; then\n missing=\"$missing permission-count>0\"\n fi\n if [ -z \"$missing\" ]; then\n echo \"✅ $name passed (permission flow confirmed)\"\n PASS=$((PASS + 1))\n else\n echo \"❌ $name failed (missing:$missing)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (missing:$missing)\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying callbacks/permissions\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o permissions-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./permissions-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/callbacks/user-input/README.md", "content": "# Config Sample: User Input Request\n\nDemonstrates the **user input request flow** — the runtime's `ask_user` tool triggers a callback to the SDK, allowing the host application to programmatically respond to agent questions without human interaction.\n\nThis pattern is useful for:\n- **Automated pipelines** where answers are predetermined or fetched from config\n- **Custom UIs** that intercept user input requests and present their own dialogs\n- **Testing** agent flows that require user interaction\n\n## How It Works\n\n1. **Enable `onUserInputRequest` callback** on the session\n2. The callback auto-responds with `\"Paris\"` whenever the agent asks a question via `ask_user`\n3. **Send a prompt** that instructs the agent to use `ask_user` to ask which city the user is interested in\n4. The agent receives `\"Paris\"` as the answer and tells us about it\n5. Print the response and confirm the user input flow worked via a log\n\n## Configuration\n\n| Option | Value | Effect |\n|--------|-------|--------|\n| `onUserInputRequest` | Returns `{ answer: \"Paris\", wasFreeform: true }` | Auto-responds to `ask_user` tool calls |\n| `onPermissionRequest` | Auto-approve | No permission dialogs |\n| `hooks.onPreToolUse` | Auto-allow | No tool confirmation prompts |\n\n## Run\n\n```bash\n./verify.sh\n```\n\nRequires the `copilot` binary (auto-detected or set `COPILOT_CLI_PATH`) and `GITHUB_TOKEN`.\n" }, { "path": "test/scenarios/callbacks/user-input/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nvar inputLog = new List();\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n OnPermissionRequest = (request, invocation) =>\n Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved }),\n OnUserInputRequest = (request, invocation) =>\n {\n inputLog.Add($\"question: {request.Question}\");\n return Task.FromResult(new UserInputResponse { Answer = \"Paris\", WasFreeform = true });\n },\n Hooks = new SessionHooks\n {\n OnPreToolUse = (input, invocation) =>\n Task.FromResult(new PreToolUseHookOutput { PermissionDecision = \"allow\" }),\n },\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"I want to learn about a city. Use the ask_user tool to ask me which city I'm interested in. Then tell me about that city.\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n\n Console.WriteLine(\"\\n--- User input log ---\");\n foreach (var entry in inputLog)\n {\n Console.WriteLine($\" {entry}\");\n }\n Console.WriteLine($\"\\nTotal user input requests: {inputLog.Count}\");\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/callbacks/user-input/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/callbacks/user-input/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/callbacks/user-input/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/callbacks/user-input/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/callbacks/user-input/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\t\"sync\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nvar (\n\tinputLog []string\n\tinputLogMu sync.Mutex\n)\n\nfunc main() {\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t\tOnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\treturn copilot.PermissionRequestResult{Kind: \"approved\"}, nil\n\t\t},\n\t\tOnUserInputRequest: func(req copilot.UserInputRequest, inv copilot.UserInputInvocation) (copilot.UserInputResponse, error) {\n\t\t\tinputLogMu.Lock()\n\t\t\tinputLog = append(inputLog, fmt.Sprintf(\"question: %s\", req.Question))\n\t\t\tinputLogMu.Unlock()\n\t\t\treturn copilot.UserInputResponse{Answer: \"Paris\", WasFreeform: true}, nil\n\t\t},\n\t\tHooks: &copilot.SessionHooks{\n\t\t\tOnPreToolUse: func(input copilot.PreToolUseHookInput, inv copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {\n\t\t\t\treturn &copilot.PreToolUseHookOutput{PermissionDecision: \"allow\"}, nil\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"I want to learn about a city. Use the ask_user tool to ask me \" +\n\t\t\t\"which city I'm interested in. Then tell me about that city.\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n\n\tfmt.Println(\"\\n--- User input log ---\")\n\tfor _, entry := range inputLog {\n\t\tfmt.Printf(\" %s\\n\", entry)\n\t}\n\tfmt.Printf(\"\\nTotal user input requests: %d\\n\", len(inputLog))\n}\n" }, { "path": "test/scenarios/callbacks/user-input/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\n\ninput_log: list[str] = []\n\n\nasync def auto_approve_permission(request, invocation):\n return {\"kind\": \"approved\"}\n\n\nasync def auto_approve_tool(input_data, invocation):\n return {\"permissionDecision\": \"allow\"}\n\n\nasync def handle_user_input(request, invocation):\n input_log.append(f\"question: {request['question']}\")\n return {\"answer\": \"Paris\", \"wasFreeform\": True}\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session(\n {\n \"model\": \"claude-haiku-4.5\",\n \"on_permission_request\": auto_approve_permission,\n \"on_user_input_request\": handle_user_input,\n \"hooks\": {\"on_pre_tool_use\": auto_approve_tool},\n }\n )\n\n response = await session.send_and_wait(\n \"I want to learn about a city. Use the ask_user tool to ask me \"\n \"which city I'm interested in. Then tell me about that city.\"\n )\n\n if response:\n print(response.data.content)\n\n await session.disconnect()\n\n print(\"\\n--- User input log ---\")\n for entry in input_log:\n print(f\" {entry}\")\n print(f\"\\nTotal user input requests: {len(input_log)}\")\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/callbacks/user-input/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/callbacks/user-input/typescript/package.json", "content": "{\n \"name\": \"callbacks-user-input-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Config sample — user input request flow via ask_user tool\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/callbacks/user-input/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const inputLog: string[] = [];\n\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n const session = await client.createSession({\n model: \"claude-haiku-4.5\",\n onPermissionRequest: async () => ({ kind: \"approved\" as const }),\n onUserInputRequest: async (request) => {\n inputLog.push(`question: ${request.question}`);\n return { answer: \"Paris\", wasFreeform: true };\n },\n hooks: {\n onPreToolUse: async () => ({ permissionDecision: \"allow\" as const }),\n },\n });\n\n const response = await session.sendAndWait({\n prompt: \"I want to learn about a city. Use the ask_user tool to ask me which city I'm interested in. Then tell me about that city.\",\n });\n\n if (response) {\n console.log(response.data.content);\n }\n\n await session.disconnect();\n\n console.log(\"\\n--- User input log ---\");\n for (const entry of inputLog) {\n console.log(` ${entry}`);\n }\n console.log(`\\nTotal user input requests: ${inputLog.length}`);\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/callbacks/user-input/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n echo \"$output\"\n\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n local missing=\"\"\n if ! echo \"$output\" | grep -qE \"Total user input requests: [1-9]\"; then\n missing=\"$missing input-count>0\"\n fi\n if ! echo \"$output\" | grep -qi \"Paris\"; then\n missing=\"$missing Paris-in-output\"\n fi\n if [ -z \"$missing\" ]; then\n echo \"✅ $name passed (user input flow confirmed)\"\n PASS=$((PASS + 1))\n else\n echo \"❌ $name failed (missing:$missing)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (missing:$missing)\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying callbacks/user-input\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + build\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o user-input-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./user-input-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/modes/default/README.md", "content": "# modes/default\n\nDemonstrates the default agent mode with standard built-in tools.\n\nCreates a session with only a model specified (no tool overrides), sends a prompt,\nand prints the response. The agent has access to all default tools provided by the\nCopilot CLI.\n" }, { "path": "test/scenarios/modes/default/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Use the grep tool to search for the word 'SDK' in README.md and show the matching lines.\",\n });\n\n if (response != null)\n {\n Console.WriteLine($\"Response: {response.Data?.Content}\");\n }\n\n Console.WriteLine(\"Default mode test complete\");\n\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/modes/default/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/modes/default/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/modes/default/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/modes/default/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/modes/default/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"Use the grep tool to search for the word 'SDK' in README.md and show the matching lines.\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Printf(\"Response: %s\\n\", d.Content)\n}\n}\n\n\tfmt.Println(\"Default mode test complete\")\n}\n" }, { "path": "test/scenarios/modes/default/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session({\n \"model\": \"claude-haiku-4.5\",\n })\n\n response = await session.send_and_wait(\"Use the grep tool to search for the word 'SDK' in README.md and show the matching lines.\")\n if response:\n print(f\"Response: {response.data.content}\")\n\n print(\"Default mode test complete\")\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/modes/default/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/modes/default/typescript/package.json", "content": "{\n \"name\": \"modes-default-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Config sample — default agent mode with standard built-in tools\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/modes/default/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n const session = await client.createSession({\n model: \"claude-haiku-4.5\",\n });\n\n const response = await session.sendAndWait({\n prompt: \"Use the grep tool to search for the word 'SDK' in README.md and show the matching lines.\",\n });\n\n if (response) {\n console.log(`Response: ${response.data.content}`);\n }\n\n console.log(\"Default mode test complete\");\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/modes/default/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n echo \"$output\"\n\n # Check that the response shows evidence of tool usage or SDK-related content\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n if echo \"$output\" | grep -qi \"SDK\\|readme\\|grep\\|match\\|search\"; then\n echo \"✅ $name passed (confirmed tool usage or SDK content)\"\n PASS=$((PASS + 1))\n else\n echo \"⚠️ $name ran but response may not confirm tool usage\"\n echo \"❌ $name failed (expected pattern not found)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying modes/default samples\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o default-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./default-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/modes/minimal/README.md", "content": "# modes/minimal\n\nDemonstrates a locked-down agent with all tools removed.\n\nCreates a session with `availableTools: []` and a custom system message instructing\nthe agent to respond with text only. Sends a prompt and verifies a text-only response\nis returned.\n" }, { "path": "test/scenarios/modes/minimal/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n AvailableTools = new List(),\n SystemMessage = new SystemMessageConfig\n {\n Mode = SystemMessageMode.Replace,\n Content = \"You have no tools. Respond with text only.\",\n },\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Use the grep tool to search for 'SDK' in README.md.\",\n });\n\n if (response != null)\n {\n Console.WriteLine($\"Response: {response.Data?.Content}\");\n }\n\n Console.WriteLine(\"Minimal mode test complete\");\n\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/modes/minimal/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/modes/minimal/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/modes/minimal/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/modes/minimal/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/modes/minimal/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t\tAvailableTools: []string{},\n\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\tMode: \"replace\",\n\t\t\tContent: \"You have no tools. Respond with text only.\",\n\t\t},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"Use the grep tool to search for 'SDK' in README.md.\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Printf(\"Response: %s\\n\", d.Content)\n}\n}\n\n\tfmt.Println(\"Minimal mode test complete\")\n}\n" }, { "path": "test/scenarios/modes/minimal/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session({\n \"model\": \"claude-haiku-4.5\",\n \"available_tools\": [],\n \"system_message\": {\n \"mode\": \"replace\",\n \"content\": \"You have no tools. Respond with text only.\",\n },\n })\n\n response = await session.send_and_wait(\"Use the grep tool to search for 'SDK' in README.md.\")\n if response:\n print(f\"Response: {response.data.content}\")\n\n print(\"Minimal mode test complete\")\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/modes/minimal/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/modes/minimal/typescript/package.json", "content": "{\n \"name\": \"modes-minimal-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Config sample — locked-down agent with all tools removed\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/modes/minimal/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n const session = await client.createSession({\n model: \"claude-haiku-4.5\",\n availableTools: [],\n systemMessage: {\n mode: \"replace\",\n content: \"You have no tools. Respond with text only.\",\n },\n });\n\n const response = await session.sendAndWait({\n prompt: \"Use the grep tool to search for 'SDK' in README.md.\",\n });\n\n if (response) {\n console.log(`Response: ${response.data.content}`);\n }\n\n console.log(\"Minimal mode test complete\");\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/modes/minimal/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n echo \"$output\"\n\n # Check that the response indicates it can't use tools\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n if echo \"$output\" | grep -qi \"no tool\\|can't\\|cannot\\|unable\\|don't have\\|do not have\\|not available\\|not have access\\|no access\"; then\n echo \"✅ $name passed (confirmed no tools)\"\n PASS=$((PASS + 1))\n else\n echo \"⚠️ $name ran but response may not confirm tool-less state\"\n echo \"❌ $name failed (expected pattern not found)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying modes/minimal samples\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o minimal-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./minimal-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/prompts/attachments/README.md", "content": "# Config Sample: File Attachments\n\nDemonstrates sending **file attachments** alongside a prompt using the Copilot SDK. This validates that the SDK correctly passes file content to the model and the model can reference it in its response.\n\n## What Each Sample Does\n\n1. Creates a session with a custom system prompt in `replace` mode\n2. Resolves the path to `sample-data.txt` (a small text file in the scenario root)\n3. Sends: _\"What languages are listed in the attached file?\"_ with the file as an attachment\n4. Prints the response — which should list TypeScript, Python, and Go\n\n## Attachment Format\n\n### File Attachment\n\n| Field | Value | Description |\n|-------|-------|-------------|\n| `type` | `\"file\"` | Indicates a local file attachment |\n| `path` | Absolute path to file | The SDK reads and sends the file content to the model |\n\n### Blob Attachment\n\n| Field | Value | Description |\n|-------|-------|-------------|\n| `type` | `\"blob\"` | Indicates an inline data attachment |\n| `data` | Base64-encoded string | The file content encoded as base64 |\n| `mimeType` | MIME type string | The MIME type of the data (e.g., `\"image/png\"`) |\n| `displayName` | *(optional)* string | User-facing display name for the attachment |\n\n### Language-Specific Usage\n\n| Language | File Attachment Syntax |\n|----------|------------------------|\n| TypeScript | `attachments: [{ type: \"file\", path: sampleFile }]` |\n| Python | `\"attachments\": [{\"type\": \"file\", \"path\": sample_file}]` |\n| Go | `Attachments: []copilot.Attachment{{Type: \"file\", Path: sampleFile}}` |\n\n| Language | Blob Attachment Syntax |\n|----------|------------------------|\n| TypeScript | `attachments: [{ type: \"blob\", data: base64Data, mimeType: \"image/png\" }]` |\n| Python | `\"attachments\": [{\"type\": \"blob\", \"data\": base64_data, \"mimeType\": \"image/png\"}]` |\n| Go | `Attachments: []copilot.Attachment{{Type: copilot.AttachmentTypeBlob, Data: &data, MIMEType: &mime}}` |\n\n## Sample Data\n\nThe `sample-data.txt` file contains basic project metadata used as the attachment target:\n\n```\nProject: Copilot SDK Samples\nVersion: 1.0.0\nDescription: Minimal buildable samples demonstrating the Copilot SDK\nLanguages: TypeScript, Python, Go\n```\n\n## Run\n\n```bash\n./verify.sh\n```\n\nRequires the `copilot` binary (auto-detected or set `COPILOT_CLI_PATH`) and `GITHUB_TOKEN`.\n" }, { "path": "test/scenarios/prompts/attachments/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n SystemMessage = new SystemMessageConfig { Mode = SystemMessageMode.Replace, Content = \"You are a helpful assistant. Answer questions about attached files concisely.\" },\n AvailableTools = [],\n });\n\n var sampleFile = Path.GetFullPath(Path.Combine(AppContext.BaseDirectory, \"..\", \"..\", \"..\", \"..\", \"sample-data.txt\"));\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What languages are listed in the attached file?\",\n Attachments =\n [\n new UserMessageAttachmentFile { Path = sampleFile, DisplayName = \"sample-data.txt\" },\n ],\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/prompts/attachments/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/prompts/attachments/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/prompts/attachments/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/prompts/attachments/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/prompts/attachments/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\t\"path/filepath\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nconst systemPrompt = `You are a helpful assistant. Answer questions about attached files concisely.`\n\nfunc main() {\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\tMode: \"replace\",\n\t\t\tContent: systemPrompt,\n\t\t},\n\t\tAvailableTools: []string{},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\texe, err := os.Executable()\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tsampleFile := filepath.Join(filepath.Dir(exe), \"..\", \"sample-data.txt\")\n\tsampleFile, err = filepath.Abs(sampleFile)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What languages are listed in the attached file?\",\n\t\tAttachments: []copilot.Attachment{\n\t\t\t{Type: \"file\", Path: &sampleFile},\n\t\t},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n}\n" }, { "path": "test/scenarios/prompts/attachments/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\nSYSTEM_PROMPT = \"\"\"You are a helpful assistant. Answer questions about attached files concisely.\"\"\"\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session(\n {\n \"model\": \"claude-haiku-4.5\",\n \"system_message\": {\"mode\": \"replace\", \"content\": SYSTEM_PROMPT},\n \"available_tools\": [],\n }\n )\n\n sample_file = os.path.join(os.path.dirname(__file__), \"..\", \"sample-data.txt\")\n sample_file = os.path.abspath(sample_file)\n\n response = await session.send_and_wait(\n \"What languages are listed in the attached file?\",\n attachments=[{\"type\": \"file\", \"path\": sample_file}],\n )\n\n if response:\n print(response.data.content)\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/prompts/attachments/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/prompts/attachments/sample-data.txt", "content": "Project: Copilot SDK Samples\nVersion: 1.0.0\nDescription: Minimal buildable samples demonstrating the Copilot SDK\nLanguages: TypeScript, Python, Go\n" }, { "path": "test/scenarios/prompts/attachments/typescript/package.json", "content": "{\n \"name\": \"prompts-attachments-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Config sample — file attachments in messages\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/prompts/attachments/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\nimport path from \"path\";\nimport { fileURLToPath } from \"url\";\n\nconst __dirname = path.dirname(fileURLToPath(import.meta.url));\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n const session = await client.createSession({\n model: \"claude-haiku-4.5\",\n availableTools: [],\n systemMessage: {\n mode: \"replace\",\n content: \"You are a helpful assistant. Answer questions about attached files concisely.\",\n },\n });\n\n const sampleFile = path.resolve(__dirname, \"../../sample-data.txt\");\n\n const response = await session.sendAndWait({\n prompt: \"What languages are listed in the attached file?\",\n attachments: [{ type: \"file\", path: sampleFile }],\n });\n\n if (response) {\n console.log(response.data.content);\n }\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/prompts/attachments/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n echo \"$output\"\n\n # Check that the response references languages from the attached file\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n if echo \"$output\" | grep -qi \"TypeScript\\|Python\\|Go\"; then\n echo \"✅ $name passed (confirmed file content referenced)\"\n PASS=$((PASS + 1))\n else\n echo \"⚠️ $name ran but response may not reference attached file content\"\n echo \"❌ $name failed (expected pattern not found)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying prompts/attachments samples\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o attachments-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./attachments-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/prompts/reasoning-effort/README.md", "content": "# Config Sample: Reasoning Effort\n\nDemonstrates configuring the Copilot SDK with different **reasoning effort** levels. The `reasoningEffort` session config controls how much compute the model spends thinking before responding.\n\n## Reasoning Effort Levels\n\n| Level | Effect |\n|-------|--------|\n| `low` | Fastest responses, minimal reasoning |\n| `medium` | Balanced speed and depth |\n| `high` | Deeper reasoning, slower responses |\n| `xhigh` | Maximum reasoning effort |\n\n## What This Sample Does\n\n1. Creates a session with `reasoningEffort: \"low\"` and `availableTools: []`\n2. Sends: _\"What is the capital of France?\"_\n3. Prints the response — confirming the model responds correctly at low effort\n\n## Configuration\n\n| Option | Value | Effect |\n|--------|-------|--------|\n| `reasoningEffort` | `\"low\"` | Sets minimal reasoning effort |\n| `availableTools` | `[]` (empty array) | Removes all built-in tools |\n| `systemMessage.mode` | `\"replace\"` | Replaces the default system prompt |\n| `systemMessage.content` | Custom concise prompt | Instructs the agent to answer concisely |\n\n## Languages\n\n| Directory | SDK / Approach | Language |\n|-----------|---------------|----------|\n| `typescript/` | `@github/copilot-sdk` | TypeScript (Node.js) |\n| `python/` | `github-copilot-sdk` | Python |\n| `go/` | `github.com/github/copilot-sdk/go` | Go |\n\n## Run\n\n```bash\n./verify.sh\n```\n\nRequires the `copilot` binary (auto-detected or set `COPILOT_CLI_PATH`) and `GITHUB_TOKEN`.\n" }, { "path": "test/scenarios/prompts/reasoning-effort/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-opus-4.6\",\n ReasoningEffort = \"low\",\n AvailableTools = new List(),\n SystemMessage = new SystemMessageConfig\n {\n Mode = SystemMessageMode.Replace,\n Content = \"You are a helpful assistant. Answer concisely.\",\n },\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is the capital of France?\",\n });\n\n if (response != null)\n {\n Console.WriteLine(\"Reasoning effort: low\");\n Console.WriteLine($\"Response: {response.Data?.Content}\");\n }\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/prompts/reasoning-effort/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/prompts/reasoning-effort/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/prompts/reasoning-effort/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/prompts/reasoning-effort/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/prompts/reasoning-effort/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-opus-4.6\",\n\t\tReasoningEffort: \"low\",\n\t\tAvailableTools: []string{},\n\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\tMode: \"replace\",\n\t\t\tContent: \"You are a helpful assistant. Answer concisely.\",\n\t\t},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What is the capital of France?\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\n\t\tif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\n\t\t\tfmt.Println(\"Reasoning effort: low\")\n\t\t\tfmt.Printf(\"Response: %s\\n\", d.Content)\n\t\t}\n\t}\n}\n" }, { "path": "test/scenarios/prompts/reasoning-effort/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session({\n \"model\": \"claude-opus-4.6\",\n \"reasoning_effort\": \"low\",\n \"available_tools\": [],\n \"system_message\": {\n \"mode\": \"replace\",\n \"content\": \"You are a helpful assistant. Answer concisely.\",\n },\n })\n\n response = await session.send_and_wait(\n \"What is the capital of France?\"\n )\n\n if response:\n print(\"Reasoning effort: low\")\n print(f\"Response: {response.data.content}\")\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/prompts/reasoning-effort/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/prompts/reasoning-effort/typescript/package.json", "content": "{\n \"name\": \"prompts-reasoning-effort-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Config sample — reasoning effort levels\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/prompts/reasoning-effort/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n // Test with \"low\" reasoning effort\n const session = await client.createSession({\n model: \"claude-opus-4.6\",\n reasoningEffort: \"low\",\n availableTools: [],\n systemMessage: {\n mode: \"replace\",\n content: \"You are a helpful assistant. Answer concisely.\",\n },\n });\n\n const response = await session.sendAndWait({\n prompt: \"What is the capital of France?\",\n });\n\n if (response) {\n console.log(`Reasoning effort: low`);\n console.log(`Response: ${response.data.content}`);\n }\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/prompts/reasoning-effort/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n echo \"$output\"\n\n # Note: reasoning effort is configuration-only and can't be verified from output alone.\n # We can only confirm a response with actual content was received.\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n if echo \"$output\" | grep -qi \"Response:\\|capital\\|Paris\\|France\"; then\n echo \"✅ $name passed (confirmed reasoning effort response)\"\n PASS=$((PASS + 1))\n else\n echo \"⚠️ $name ran but response may not contain expected content\"\n echo \"❌ $name failed (expected pattern not found)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying prompts/reasoning-effort samples\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + build\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o reasoning-effort-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./reasoning-effort-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/prompts/system-message/README.md", "content": "# Config Sample: System Message\n\nDemonstrates configuring the Copilot SDK's **system message** using `replace` mode. This validates that a custom system prompt fully replaces the default system prompt, changing the agent's personality and response style.\n\n## Append vs Replace Modes\n\n| Mode | Behavior |\n|------|----------|\n| `\"append\"` | Adds your content **after** the default system prompt. The agent retains its base personality plus your additions. |\n| `\"replace\"` | **Replaces** the entire default system prompt with your content. The agent's personality is fully defined by your prompt. |\n\n## What Each Sample Does\n\n1. Creates a session with `systemMessage` in `replace` mode using a pirate personality prompt\n2. Sends: _\"What is the capital of France?\"_\n3. Prints the response — which should be in pirate speak (containing \"Arrr!\", nautical terms, etc.)\n\n## Configuration\n\n| Option | Value | Effect |\n|--------|-------|--------|\n| `systemMessage.mode` | `\"replace\"` | Replaces the default system prompt entirely |\n| `systemMessage.content` | Pirate personality prompt | Instructs the agent to always respond in pirate speak |\n| `availableTools` | `[]` (empty array) | No tools — focuses the test on system message behavior |\n\n## Run\n\n```bash\n./verify.sh\n```\n\nRequires the `copilot` binary (auto-detected or set `COPILOT_CLI_PATH`) and `GITHUB_TOKEN`.\n" }, { "path": "test/scenarios/prompts/system-message/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nvar piratePrompt = \"You are a pirate. Always respond in pirate speak. Say 'Arrr!' in every response. Use nautical terms and pirate slang throughout.\";\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n SystemMessage = new SystemMessageConfig\n {\n Mode = SystemMessageMode.Replace,\n Content = piratePrompt,\n },\n AvailableTools = [],\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is the capital of France?\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/prompts/system-message/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/prompts/system-message/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/prompts/system-message/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/prompts/system-message/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/prompts/system-message/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nconst piratePrompt = `You are a pirate. Always respond in pirate speak. Say 'Arrr!' in every response. Use nautical terms and pirate slang throughout.`\n\nfunc main() {\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\tMode: \"replace\",\n\t\t\tContent: piratePrompt,\n\t\t},\n\t\tAvailableTools: []string{},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What is the capital of France?\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n}\n" }, { "path": "test/scenarios/prompts/system-message/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\nPIRATE_PROMPT = \"\"\"You are a pirate. Always respond in pirate speak. Say 'Arrr!' in every response. Use nautical terms and pirate slang throughout.\"\"\"\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session(\n {\n \"model\": \"claude-haiku-4.5\",\n \"system_message\": {\"mode\": \"replace\", \"content\": PIRATE_PROMPT},\n \"available_tools\": [],\n }\n )\n\n response = await session.send_and_wait(\n \"What is the capital of France?\"\n )\n\n if response:\n print(response.data.content)\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/prompts/system-message/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/prompts/system-message/typescript/package.json", "content": "{\n \"name\": \"prompts-system-message-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Config sample — system message append vs replace modes\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/prompts/system-message/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nconst PIRATE_PROMPT = `You are a pirate. Always respond in pirate speak. Say 'Arrr!' in every response. Use nautical terms and pirate slang throughout.`;\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n const session = await client.createSession({\n model: \"claude-haiku-4.5\",\n systemMessage: { mode: \"replace\", content: PIRATE_PROMPT },\n availableTools: [],\n });\n\n const response = await session.sendAndWait({\n prompt: \"What is the capital of France?\",\n });\n\n if (response) {\n console.log(response.data.content);\n }\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/prompts/system-message/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n echo \"$output\"\n\n # Check that the response contains pirate language\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n if echo \"$output\" | grep -qi \"arrr\\|pirate\\|matey\\|ahoy\\|ye\\|sail\"; then\n echo \"✅ $name passed (confirmed pirate speak)\"\n PASS=$((PASS + 1))\n else\n echo \"⚠️ $name ran but response may not contain pirate language\"\n echo \"❌ $name failed (expected pattern not found)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying prompts/system-message samples\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o system-message-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./system-message-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/sessions/concurrent-sessions/README.md", "content": "# Config Sample: Concurrent Sessions\n\nDemonstrates creating **multiple sessions on the same client** with different configurations and verifying that each session maintains its own isolated state.\n\n## What This Tests\n\n1. **Session isolation** — Two sessions created on the same client receive different system prompts and respond according to their own persona, not the other's.\n2. **Concurrent operation** — Both sessions can be used in parallel without interference.\n\n## What Each Sample Does\n\n1. Creates a client, then opens two sessions concurrently:\n - **Session 1** — system prompt: _\"You are a pirate. Always say Arrr!\"_\n - **Session 2** — system prompt: _\"You are a robot. Always say BEEP BOOP!\"_\n2. Sends the same question (_\"What is the capital of France?\"_) to both sessions\n3. Prints both responses with labels (`Session 1 (pirate):` and `Session 2 (robot):`)\n4. Destroys both sessions\n\n## Configuration\n\n| Option | Session 1 | Session 2 |\n|--------|-----------|-----------|\n| `systemMessage.mode` | `\"replace\"` | `\"replace\"` |\n| `systemMessage.content` | Pirate persona | Robot persona |\n| `availableTools` | `[]` | `[]` |\n\n## Run\n\n```bash\n./verify.sh\n```\n\nRequires the `copilot` binary (auto-detected or set `COPILOT_CLI_PATH`) and `GITHUB_TOKEN`.\n" }, { "path": "test/scenarios/sessions/concurrent-sessions/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nconst string PiratePrompt = \"You are a pirate. Always say Arrr!\";\nconst string RobotPrompt = \"You are a robot. Always say BEEP BOOP!\";\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n var session1Task = client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n SystemMessage = new SystemMessageConfig { Mode = SystemMessageMode.Replace, Content = PiratePrompt },\n AvailableTools = [],\n });\n\n var session2Task = client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n SystemMessage = new SystemMessageConfig { Mode = SystemMessageMode.Replace, Content = RobotPrompt },\n AvailableTools = [],\n });\n\n await using var session1 = await session1Task;\n await using var session2 = await session2Task;\n\n var response1Task = session1.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is the capital of France?\",\n });\n\n var response2Task = session2.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is the capital of France?\",\n });\n\n var response1 = await response1Task;\n var response2 = await response2Task;\n\n if (response1 != null)\n {\n Console.WriteLine($\"Session 1 (pirate): {response1.Data?.Content}\");\n }\n if (response2 != null)\n {\n Console.WriteLine($\"Session 2 (robot): {response2.Data?.Content}\");\n }\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/sessions/concurrent-sessions/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/sessions/concurrent-sessions/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/sessions/concurrent-sessions/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/sessions/concurrent-sessions/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/sessions/concurrent-sessions/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\t\"sync\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nconst piratePrompt = `You are a pirate. Always say Arrr!`\nconst robotPrompt = `You are a robot. Always say BEEP BOOP!`\n\nfunc main() {\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession1, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\tMode: \"replace\",\n\t\t\tContent: piratePrompt,\n\t\t},\n\t\tAvailableTools: []string{},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session1.Disconnect()\n\n\tsession2, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\tMode: \"replace\",\n\t\t\tContent: robotPrompt,\n\t\t},\n\t\tAvailableTools: []string{},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session2.Disconnect()\n\n\ttype result struct {\n\t\tlabel string\n\t\tcontent string\n\t}\n\n\tvar wg sync.WaitGroup\n\tresults := make([]result, 2)\n\n\twg.Add(2)\n\tgo func() {\n\t\tdefer wg.Done()\n\t\tresp, err := session1.SendAndWait(ctx, copilot.MessageOptions{\n\t\t\tPrompt: \"What is the capital of France?\",\n\t\t})\n\t\tif err != nil {\n\t\t\tlog.Fatal(err)\n\t\t}\n\t\tif resp != nil {\n\t\t\tif d, ok := resp.Data.(*copilot.AssistantMessageData); ok {\n\t\t\t\tresults[0] = result{label: \"Session 1 (pirate)\", content: d.Content}\n\t\t\t}\n\t\t}\n\t}()\n\tgo func() {\n\t\tdefer wg.Done()\n\t\tresp, err := session2.SendAndWait(ctx, copilot.MessageOptions{\n\t\t\tPrompt: \"What is the capital of France?\",\n\t\t})\n\t\tif err != nil {\n\t\t\tlog.Fatal(err)\n\t\t}\n\t\tif resp != nil {\n\t\t\tif d, ok := resp.Data.(*copilot.AssistantMessageData); ok {\n\t\t\t\tresults[1] = result{label: \"Session 2 (robot)\", content: d.Content}\n\t\t\t}\n\t\t}\n\t}()\n\twg.Wait()\n\n\tfor _, r := range results {\n\t\tif r.label != \"\" {\n\t\t\tfmt.Printf(\"%s: %s\\n\", r.label, r.content)\n\t\t}\n\t}\n}\n" }, { "path": "test/scenarios/sessions/concurrent-sessions/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\nPIRATE_PROMPT = \"You are a pirate. Always say Arrr!\"\nROBOT_PROMPT = \"You are a robot. Always say BEEP BOOP!\"\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session1, session2 = await asyncio.gather(\n client.create_session(\n {\n \"model\": \"claude-haiku-4.5\",\n \"system_message\": {\"mode\": \"replace\", \"content\": PIRATE_PROMPT},\n \"available_tools\": [],\n }\n ),\n client.create_session(\n {\n \"model\": \"claude-haiku-4.5\",\n \"system_message\": {\"mode\": \"replace\", \"content\": ROBOT_PROMPT},\n \"available_tools\": [],\n }\n ),\n )\n\n response1, response2 = await asyncio.gather(\n session1.send_and_wait(\n \"What is the capital of France?\"\n ),\n session2.send_and_wait(\n \"What is the capital of France?\"\n ),\n )\n\n if response1:\n print(\"Session 1 (pirate):\", response1.data.content)\n if response2:\n print(\"Session 2 (robot):\", response2.data.content)\n\n await asyncio.gather(session1.disconnect(), session2.disconnect())\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/sessions/concurrent-sessions/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/sessions/concurrent-sessions/typescript/package.json", "content": "{\n \"name\": \"sessions-concurrent-sessions-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Config sample — concurrent session isolation\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/sessions/concurrent-sessions/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nconst PIRATE_PROMPT = `You are a pirate. Always say Arrr!`;\nconst ROBOT_PROMPT = `You are a robot. Always say BEEP BOOP!`;\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n const [session1, session2] = await Promise.all([\n client.createSession({\n model: \"claude-haiku-4.5\",\n systemMessage: { mode: \"replace\", content: PIRATE_PROMPT },\n availableTools: [],\n }),\n client.createSession({\n model: \"claude-haiku-4.5\",\n systemMessage: { mode: \"replace\", content: ROBOT_PROMPT },\n availableTools: [],\n }),\n ]);\n\n const [response1, response2] = await Promise.all([\n session1.sendAndWait({ prompt: \"What is the capital of France?\" }),\n session2.sendAndWait({ prompt: \"What is the capital of France?\" }),\n ]);\n\n if (response1) {\n console.log(\"Session 1 (pirate):\", response1.data.content);\n }\n if (response2) {\n console.log(\"Session 2 (robot):\", response2.data.content);\n }\n\n await Promise.all([session1.disconnect(), session2.disconnect()]);\n } finally {\n await client.stop();\n process.exit(0);\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/sessions/concurrent-sessions/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=120\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n echo \"$output\"\n\n # Check that both sessions produced output\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n local has_session1=false\n local has_session2=false\n if echo \"$output\" | grep -q \"Session 1\"; then\n has_session1=true\n fi\n if echo \"$output\" | grep -q \"Session 2\"; then\n has_session2=true\n fi\n if $has_session1 && $has_session2; then\n # Verify persona isolation: pirate language from session 1, robot language from session 2\n local persona_ok=true\n if ! echo \"$output\" | grep -qi \"arrr\\|pirate\\|matey\\|ahoy\"; then\n echo \"⚠️ $name: pirate persona words not found in output\"\n persona_ok=false\n fi\n if ! echo \"$output\" | grep -qi \"beep\\|boop\\|robot\"; then\n echo \"⚠️ $name: robot persona words not found in output\"\n persona_ok=false\n fi\n if $persona_ok; then\n echo \"✅ $name passed (both sessions responded with correct personas)\"\n PASS=$((PASS + 1))\n else\n echo \"❌ $name failed (persona isolation not verified)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (persona check)\"\n fi\n elif $has_session1 || $has_session2; then\n echo \"⚠️ $name ran but only one session responded\"\n echo \"❌ $name failed (expected both to respond)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (partial)\"\n else\n echo \"⚠️ $name ran but session labels not found in output\"\n echo \"❌ $name failed (expected pattern not found)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying sessions/concurrent-sessions samples\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o concurrent-sessions-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./concurrent-sessions-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/sessions/infinite-sessions/README.md", "content": "# Config Sample: Infinite Sessions\n\nDemonstrates configuring the Copilot SDK with **infinite sessions** enabled, which uses context compaction to allow sessions to continue beyond the model's context window limit.\n\n## What This Tests\n\n1. **Config acceptance** — The `infiniteSessions` configuration with compaction thresholds is accepted by the server without errors.\n2. **Session continuity** — Multiple messages are sent and responses received successfully with infinite sessions enabled.\n\n## Configuration\n\n| Option | Value | Effect |\n|--------|-------|--------|\n| `infiniteSessions.enabled` | `true` | Enables context compaction for the session |\n| `infiniteSessions.backgroundCompactionThreshold` | `0.80` | Triggers background compaction at 80% context usage |\n| `infiniteSessions.bufferExhaustionThreshold` | `0.95` | Forces compaction at 95% context usage |\n| `availableTools` | `[]` | No tools — keeps context small for testing |\n| `systemMessage.mode` | `\"replace\"` | Replaces the default system prompt |\n\n## How It Works\n\nWhen `infiniteSessions` is enabled, the server monitors context window usage. As the conversation grows:\n\n- At `backgroundCompactionThreshold` (80%), the server begins compacting older messages in the background.\n- At `bufferExhaustionThreshold` (95%), compaction is forced before the next message is processed.\n\nThis allows sessions to run indefinitely without hitting context limits.\n\n## Languages\n\n| Directory | SDK / Approach | Language |\n|-----------|---------------|----------|\n| `typescript/` | `@github/copilot-sdk` | TypeScript (Node.js) |\n| `python/` | `github-copilot-sdk` | Python |\n| `go/` | `github.com/github/copilot-sdk/go` | Go |\n\n## Run\n\n```bash\n./verify.sh\n```\n\nRequires the `copilot` binary (auto-detected or set `COPILOT_CLI_PATH`) and `GITHUB_TOKEN`.\n" }, { "path": "test/scenarios/sessions/infinite-sessions/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n AvailableTools = new List(),\n SystemMessage = new SystemMessageConfig\n {\n Mode = SystemMessageMode.Replace,\n Content = \"You are a helpful assistant. Answer concisely in one sentence.\",\n },\n InfiniteSessions = new InfiniteSessionConfig\n {\n Enabled = true,\n BackgroundCompactionThreshold = 0.80,\n BufferExhaustionThreshold = 0.95,\n },\n });\n\n var prompts = new[]\n {\n \"What is the capital of France?\",\n \"What is the capital of Japan?\",\n \"What is the capital of Brazil?\",\n };\n\n foreach (var prompt in prompts)\n {\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = prompt,\n });\n\n if (response != null)\n {\n Console.WriteLine($\"Q: {prompt}\");\n Console.WriteLine($\"A: {response.Data?.Content}\\n\");\n }\n }\n\n Console.WriteLine(\"Infinite sessions test complete — all messages processed successfully\");\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/sessions/infinite-sessions/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/sessions/infinite-sessions/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/sessions/infinite-sessions/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/sessions/infinite-sessions/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/sessions/infinite-sessions/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc boolPtr(b bool) *bool { return &b }\nfunc float64Ptr(f float64) *float64 { return &f }\n\nfunc main() {\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t\tAvailableTools: []string{},\n\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\tMode: \"replace\",\n\t\t\tContent: \"You are a helpful assistant. Answer concisely in one sentence.\",\n\t\t},\n\t\tInfiniteSessions: &copilot.InfiniteSessionConfig{\n\t\t\tEnabled: boolPtr(true),\n\t\t\tBackgroundCompactionThreshold: float64Ptr(0.80),\n\t\t\tBufferExhaustionThreshold: float64Ptr(0.95),\n\t\t},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tprompts := []string{\n\t\t\"What is the capital of France?\",\n\t\t\"What is the capital of Japan?\",\n\t\t\"What is the capital of Brazil?\",\n\t}\n\n\tfor _, prompt := range prompts {\n\t\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\t\tPrompt: prompt,\n\t\t})\n\t\tif err != nil {\n\t\t\tlog.Fatal(err)\n\t\t}\n\t\tif response != nil {\n\t\t\tif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\n\t\t\t\tfmt.Printf(\"Q: %s\\n\", prompt)\n\t\t\t\tfmt.Printf(\"A: %s\\n\\n\", d.Content)\n\t\t\t}\n\t\t}\n\t}\n\n\tfmt.Println(\"Infinite sessions test complete — all messages processed successfully\")\n}\n" }, { "path": "test/scenarios/sessions/infinite-sessions/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session({\n \"model\": \"claude-haiku-4.5\",\n \"available_tools\": [],\n \"system_message\": {\n \"mode\": \"replace\",\n \"content\": \"You are a helpful assistant. Answer concisely in one sentence.\",\n },\n \"infinite_sessions\": {\n \"enabled\": True,\n \"background_compaction_threshold\": 0.80,\n \"buffer_exhaustion_threshold\": 0.95,\n },\n })\n\n prompts = [\n \"What is the capital of France?\",\n \"What is the capital of Japan?\",\n \"What is the capital of Brazil?\",\n ]\n\n for prompt in prompts:\n response = await session.send_and_wait(prompt)\n if response:\n print(f\"Q: {prompt}\")\n print(f\"A: {response.data.content}\\n\")\n\n print(\"Infinite sessions test complete — all messages processed successfully\")\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/sessions/infinite-sessions/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/sessions/infinite-sessions/typescript/package.json", "content": "{\n \"name\": \"sessions-infinite-sessions-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Config sample — infinite sessions with context compaction\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/sessions/infinite-sessions/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n const session = await client.createSession({\n model: \"claude-haiku-4.5\",\n availableTools: [],\n systemMessage: {\n mode: \"replace\",\n content: \"You are a helpful assistant. Answer concisely in one sentence.\",\n },\n infiniteSessions: {\n enabled: true,\n backgroundCompactionThreshold: 0.80,\n bufferExhaustionThreshold: 0.95,\n },\n });\n\n const prompts = [\n \"What is the capital of France?\",\n \"What is the capital of Japan?\",\n \"What is the capital of Brazil?\",\n ];\n\n for (const prompt of prompts) {\n const response = await session.sendAndWait({ prompt });\n if (response) {\n console.log(`Q: ${prompt}`);\n console.log(`A: ${response.data.content}\\n`);\n }\n }\n\n console.log(\"Infinite sessions test complete — all messages processed successfully\");\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/sessions/infinite-sessions/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=120\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n echo \"$output\"\n\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n if echo \"$output\" | grep -q \"Infinite sessions test complete\"; then\n # Verify all 3 questions got meaningful responses (country/capital names)\n if echo \"$output\" | grep -qiE \"France|Japan|Brazil|Paris|Tokyo|Bras[ií]lia\"; then\n echo \"✅ $name passed (infinite sessions confirmed with all responses)\"\n PASS=$((PASS + 1))\n else\n echo \"⚠️ $name completed but expected country/capital responses not found\"\n echo \"❌ $name failed (responses missing for some questions)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (incomplete responses)\"\n fi\n else\n echo \"⚠️ $name ran but completion message not found\"\n echo \"❌ $name failed (expected pattern not found)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying sessions/infinite-sessions\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o infinite-sessions-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./infinite-sessions-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/sessions/multi-user-long-lived/README.md", "content": "# Multi-User Long-Lived Sessions\n\nDemonstrates a **production-like multi-user setup** where multiple clients share a single `copilot` server with **persistent, long-lived sessions** stored on disk.\n\n## Architecture\n\n```\n┌──────────────────────┐\n│ Copilot CLI │ (headless TCP server)\n│ (shared server) │\n└───┬──────┬───────┬───┘\n │ │ │ JSON-RPC over TCP (cliUrl)\n │ │ │\n┌───┴──┐ ┌┴────┐ ┌┴─────┐\n│ C1 │ │ C2 │ │ C3 │\n│UserA │ │UserA│ │UserB │\n│Sess1 │ │Sess1│ │Sess2 │\n│ │ │(resume)│ │\n└──────┘ └─────┘ └──────┘\n```\n\n## What This Demonstrates\n\n1. **Shared server** — A single `copilot` instance serves multiple users and sessions over TCP.\n2. **Per-user config isolation** — Each user gets their own `configDir` on disk (`tmp/user-a/`, `tmp/user-b/`), so configuration, logs, and state are fully separated.\n3. **Session sharing across clients** — User A's Client 1 creates a session and teaches it a fact. Client 2 resumes the same session (by `sessionId`) and retrieves the fact — demonstrating cross-client session continuity.\n4. **Session isolation between users** — User B operates in a completely separate session and cannot see User A's conversation history.\n5. **Disk persistence** — Session state is written to a real `tmp/` directory, simulating production persistence (cleaned up after the run).\n\n## What Each Client Does\n\n| Client | User | Action |\n|--------|------|--------|\n| **C1** | A | Creates session `user-a-project-session`, teaches it a codename |\n| **C2** | A | Resumes `user-a-project-session`, confirms it remembers the codename |\n| **C3** | B | Creates separate session `user-b-solo-session`, verifies it has no knowledge of User A's data |\n\n## Configuration\n\n| Option | User A | User B |\n|--------|--------|--------|\n| `cliUrl` | Shared server | Shared server |\n| `configDir` | `tmp/user-a/` | `tmp/user-b/` |\n| `sessionId` | `user-a-project-session` | `user-b-solo-session` |\n| `availableTools` | `[]` | `[]` |\n\n## When to Use This Pattern\n\n- **SaaS platforms** — Each tenant gets isolated config and persistent sessions\n- **Team collaboration tools** — Multiple team members share sessions on the same project\n- **IDE backends** — User opens the same project in multiple editors/tabs\n\n## Run\n\n```bash\n./verify.sh\n```\n\nRequires the `copilot` binary (auto-detected or set `COPILOT_CLI_PATH`) and `GITHUB_TOKEN`.\n" }, { "path": "test/scenarios/sessions/multi-user-long-lived/csharp/Program.cs", "content": "Console.WriteLine(\"SKIP: multi-user-long-lived is not yet implemented for C#\");\n" }, { "path": "test/scenarios/sessions/multi-user-long-lived/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/sessions/multi-user-long-lived/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/sessions/multi-user-long-lived/go\n\ngo 1.24\n" }, { "path": "test/scenarios/sessions/multi-user-long-lived/go/main.go", "content": "package main\n\nimport \"fmt\"\n\nfunc main() {\n\tfmt.Println(\"SKIP: multi-user-long-lived is not yet implemented for Go\")\n}\n" }, { "path": "test/scenarios/sessions/multi-user-long-lived/python/main.py", "content": "print(\"SKIP: multi-user-long-lived is not yet implemented for Python\")\n" }, { "path": "test/scenarios/sessions/multi-user-long-lived/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/sessions/multi-user-long-lived/typescript/package.json", "content": "{\n \"name\": \"sessions-multi-user-long-lived-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Multi-user long-lived sessions — shared server, isolated config, disk persistence\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/sessions/multi-user-long-lived/typescript/src/index.ts", "content": "console.log(\"SKIP: multi-user-long-lived requires memory FS and preset features which is not supported by the old SDK\");\nprocess.exit(0);\n" }, { "path": "test/scenarios/sessions/multi-user-long-lived/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=120\nSERVER_PID=\"\"\nSERVER_PORT_FILE=\"\"\n\ncleanup() {\n if [ -n \"$SERVER_PID\" ] && kill -0 \"$SERVER_PID\" 2>/dev/null; then\n echo \"\"\n echo \"Stopping Copilot CLI server (PID $SERVER_PID)...\"\n kill \"$SERVER_PID\" 2>/dev/null || true\n wait \"$SERVER_PID\" 2>/dev/null || true\n fi\n [ -n \"$SERVER_PORT_FILE\" ] && rm -f \"$SERVER_PORT_FILE\"\n # Clean up tmp directories created by the scenario\n rm -rf \"$SCRIPT_DIR/tmp\" 2>/dev/null || true\n}\ntrap cleanup EXIT\n\n# Resolve Copilot CLI binary: use COPILOT_CLI_PATH env var or find the SDK bundled CLI.\nif [ -z \"${COPILOT_CLI_PATH:-}\" ]; then\n # Try to resolve from the TypeScript sample node_modules\n TS_DIR=\"$SCRIPT_DIR/typescript\"\n if [ -d \"$TS_DIR/node_modules/@github/copilot\" ]; then\n COPILOT_CLI_PATH=\"$(node -e \"console.log(require.resolve('@github/copilot'))\" 2>/dev/null || true)\"\n fi\n # Fallback: check PATH\n if [ -z \"${COPILOT_CLI_PATH:-}\" ]; then\n COPILOT_CLI_PATH=\"$(command -v copilot 2>/dev/null || true)\"\n fi\nfi\nif [ -z \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"❌ Could not find Copilot CLI binary.\"\n echo \" Set COPILOT_CLI_PATH or run: cd typescript && npm install\"\n exit 1\nfi\necho \"Using CLI: $COPILOT_CLI_PATH\"\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n echo \"$output\"\n\n # Check for multi-user output markers\n local has_user_a=false\n local has_user_b=false\n if echo \"$output\" | grep -q \"User A\"; then has_user_a=true; fi\n if echo \"$output\" | grep -q \"User B\"; then has_user_b=true; fi\n\n if $has_user_a && $has_user_b; then\n echo \"✅ $name passed (both users responded)\"\n PASS=$((PASS + 1))\n elif $has_user_a || $has_user_b; then\n echo \"⚠️ $name ran but only one user responded\"\n echo \"❌ $name failed (expected both to respond)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (partial)\"\n else\n echo \"❌ $name failed (expected pattern not found)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"${output:-(no output)}\"\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"${output:-(empty output)}\"\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Starting Copilot CLI TCP server\"\necho \"══════════════════════════════════════\"\necho \"\"\n\nSERVER_PORT_FILE=$(mktemp)\n\"$COPILOT_CLI_PATH\" --headless --auth-token-env GITHUB_TOKEN > \"$SERVER_PORT_FILE\" 2>&1 &\nSERVER_PID=$!\n\necho \"Waiting for server to be ready...\"\nPORT=\"\"\nfor i in $(seq 1 30); do\n if ! kill -0 \"$SERVER_PID\" 2>/dev/null; then\n echo \"❌ Server process exited unexpectedly\"\n cat \"$SERVER_PORT_FILE\" 2>/dev/null\n exit 1\n fi\n PORT=$(grep -o 'listening on port [0-9]*' \"$SERVER_PORT_FILE\" 2>/dev/null | grep -o '[0-9]*' || true)\n if [ -n \"$PORT\" ]; then\n break\n fi\n if [ \"$i\" -eq 30 ]; then\n echo \"❌ Server did not announce port within 30 seconds\"\n exit 1\n fi\n sleep 1\ndone\nexport COPILOT_CLI_URL=\"localhost:$PORT\"\necho \"Server is ready on port $PORT (PID $SERVER_PID)\"\necho \"\"\n\necho \"══════════════════════════════════════\"\necho \" Verifying sessions/multi-user-long-lived\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && COPILOT_CLI_URL=$COPILOT_CLI_URL dotnet run --no-build 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/sessions/multi-user-short-lived/README.md", "content": "# Multi-User Short-Lived Sessions\n\nDemonstrates a **stateless backend pattern** where multiple users interact with a shared `copilot` server through **ephemeral sessions** that are created and destroyed per request, with per-user virtual filesystems for isolation.\n\n## Architecture\n\n```\n┌──────────────────────┐\n│ Copilot CLI │ (headless TCP server)\n│ (shared server) │\n└───┬──────┬───────┬───┘\n │ │ │ JSON-RPC over TCP (cliUrl)\n │ │ │\n┌───┴──┐ ┌┴────┐ ┌┴─────┐\n│ C1 │ │ C2 │ │ C3 │\n│UserA │ │UserA│ │UserB │\n│(new) │ │(new)│ │(new) │\n└──────┘ └─────┘ └──────┘\n\nEach request → new session → disconnect after response\nVirtual FS per user (in-memory, not shared across users)\n```\n\n## What This Demonstrates\n\n1. **Ephemeral sessions** — Each interaction creates a fresh session and destroys it immediately after. No state persists between requests on the server side.\n2. **Per-user virtual filesystem** — Custom tools (`write_file`, `read_file`, `list_files`) backed by in-memory Maps. Each user gets their own isolated filesystem instance — User A's files are invisible to User B.\n3. **Application-layer state** — While sessions are stateless, the application maintains state (the virtual FS) between requests for the same user. This mirrors real backends where session state lives in your database, not in the LLM session.\n4. **Custom tools** — Uses `defineTool` with `availableTools: []` to replace all built-in tools with a controlled virtual filesystem.\n5. **Multi-client isolation** — User A's two clients share the same virtual FS (same user), but User B's virtual FS is completely separate.\n\n## What Each Client Does\n\n| Client | User | Action |\n|--------|------|--------|\n| **C1** | A | Creates `notes.md` in User A's virtual FS |\n| **C2** | A | Lists files and reads `notes.md` (sees C1's file because same user FS) |\n| **C3** | B | Lists files in User B's virtual FS (empty — completely isolated) |\n\n## Configuration\n\n| Option | Value |\n|--------|-------|\n| `cliUrl` | Shared server |\n| `availableTools` | `[]` (no built-in tools) |\n| `tools` | `[write_file, read_file, list_files]` (per-user virtual FS) |\n| `sessionId` | Auto-generated (ephemeral) |\n\n## When to Use This Pattern\n\n- **API backends** — Stateless request/response with no session persistence\n- **Serverless functions** — Each invocation is independent\n- **High-throughput services** — No session overhead between requests\n- **Privacy-sensitive apps** — Conversation history never persists\n\n## Run\n\n```bash\n./verify.sh\n```\n\nRequires the `copilot` binary (auto-detected or set `COPILOT_CLI_PATH`) and `GITHUB_TOKEN`.\n" }, { "path": "test/scenarios/sessions/multi-user-short-lived/csharp/Program.cs", "content": "Console.WriteLine(\"SKIP: multi-user-short-lived is not yet implemented for C#\");\n" }, { "path": "test/scenarios/sessions/multi-user-short-lived/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/sessions/multi-user-short-lived/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/sessions/multi-user-short-lived/go\n\ngo 1.24\n" }, { "path": "test/scenarios/sessions/multi-user-short-lived/go/main.go", "content": "package main\n\nimport \"fmt\"\n\nfunc main() {\n\tfmt.Println(\"SKIP: multi-user-short-lived is not yet implemented for Go\")\n}\n" }, { "path": "test/scenarios/sessions/multi-user-short-lived/python/main.py", "content": "print(\"SKIP: multi-user-short-lived is not yet implemented for Python\")\n" }, { "path": "test/scenarios/sessions/multi-user-short-lived/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/sessions/multi-user-short-lived/typescript/package.json", "content": "{\n \"name\": \"sessions-multi-user-short-lived-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Multi-user short-lived sessions — ephemeral per-request sessions with virtual FS\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\",\n \"zod\": \"^4.3.6\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/sessions/multi-user-short-lived/typescript/src/index.ts", "content": "console.log(\"SKIP: multi-user-short-lived requires memory FS and preset features which is not supported by the old SDK\");\nprocess.exit(0);\n" }, { "path": "test/scenarios/sessions/multi-user-short-lived/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=120\nSERVER_PID=\"\"\nSERVER_PORT_FILE=\"\"\n\ncleanup() {\n if [ -n \"$SERVER_PID\" ] && kill -0 \"$SERVER_PID\" 2>/dev/null; then\n echo \"\"\n echo \"Stopping Copilot CLI server (PID $SERVER_PID)...\"\n kill \"$SERVER_PID\" 2>/dev/null || true\n wait \"$SERVER_PID\" 2>/dev/null || true\n fi\n [ -n \"$SERVER_PORT_FILE\" ] && rm -f \"$SERVER_PORT_FILE\"\n}\ntrap cleanup EXIT\n\n# Resolve Copilot CLI binary: use COPILOT_CLI_PATH env var or find the SDK bundled CLI.\nif [ -z \"${COPILOT_CLI_PATH:-}\" ]; then\n # Try to resolve from the TypeScript sample node_modules\n TS_DIR=\"$SCRIPT_DIR/typescript\"\n if [ -d \"$TS_DIR/node_modules/@github/copilot\" ]; then\n COPILOT_CLI_PATH=\"$(node -e \"console.log(require.resolve('@github/copilot'))\" 2>/dev/null || true)\"\n fi\n # Fallback: check PATH\n if [ -z \"${COPILOT_CLI_PATH:-}\" ]; then\n COPILOT_CLI_PATH=\"$(command -v copilot 2>/dev/null || true)\"\n fi\nfi\nif [ -z \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"❌ Could not find Copilot CLI binary.\"\n echo \" Set COPILOT_CLI_PATH or run: cd typescript && npm install\"\n exit 1\nfi\necho \"Using CLI: $COPILOT_CLI_PATH\"\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n echo \"$output\"\n\n local has_user_a=false\n local has_user_b=false\n if echo \"$output\" | grep -q \"User A\"; then has_user_a=true; fi\n if echo \"$output\" | grep -q \"User B\"; then has_user_b=true; fi\n\n if $has_user_a && $has_user_b; then\n echo \"✅ $name passed (both users responded)\"\n PASS=$((PASS + 1))\n elif $has_user_a || $has_user_b; then\n echo \"⚠️ $name ran but only one user responded\"\n echo \"❌ $name failed (expected both to respond)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (partial)\"\n else\n echo \"❌ $name failed (expected pattern not found)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"${output:-(no output)}\"\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"${output:-(empty output)}\"\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Starting Copilot CLI TCP server\"\necho \"══════════════════════════════════════\"\necho \"\"\n\nSERVER_PORT_FILE=$(mktemp)\n\"$COPILOT_CLI_PATH\" --headless --auth-token-env GITHUB_TOKEN > \"$SERVER_PORT_FILE\" 2>&1 &\nSERVER_PID=$!\n\necho \"Waiting for server to be ready...\"\nPORT=\"\"\nfor i in $(seq 1 30); do\n if ! kill -0 \"$SERVER_PID\" 2>/dev/null; then\n echo \"❌ Server process exited unexpectedly\"\n cat \"$SERVER_PORT_FILE\" 2>/dev/null\n exit 1\n fi\n PORT=$(grep -o 'listening on port [0-9]*' \"$SERVER_PORT_FILE\" 2>/dev/null | grep -o '[0-9]*' || true)\n if [ -n \"$PORT\" ]; then\n break\n fi\n if [ \"$i\" -eq 30 ]; then\n echo \"❌ Server did not announce port within 30 seconds\"\n exit 1\n fi\n sleep 1\ndone\nexport COPILOT_CLI_URL=\"localhost:$PORT\"\necho \"Server is ready on port $PORT (PID $SERVER_PID)\"\necho \"\"\n\necho \"══════════════════════════════════════\"\necho \" Verifying sessions/multi-user-short-lived\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && COPILOT_CLI_URL=$COPILOT_CLI_URL dotnet run --no-build 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/sessions/session-resume/README.md", "content": "# Config Sample: Session Resume\n\nDemonstrates session persistence and resume with the Copilot SDK. This validates that a destroyed session can be resumed by its ID, retaining full conversation history.\n\n## What Each Sample Does\n\n1. Creates a session with `availableTools: []` and model `gpt-4.1`\n2. Sends: _\"Remember this: the secret word is PINEAPPLE.\"_\n3. Captures the session ID and destroys the session\n4. Resumes the session using the same session ID\n5. Sends: _\"What was the secret word I told you?\"_\n6. Prints the response — which should mention **PINEAPPLE**\n\n## Configuration\n\n| Option | Value | Effect |\n|--------|-------|--------|\n| `availableTools` | `[]` (empty array) | Keeps the session simple with no tools |\n| `model` | `\"gpt-4.1\"` | Uses GPT-4.1 for both the initial and resumed session |\n\n## Run\n\n```bash\n./verify.sh\n```\n\nRequires the `copilot` binary (auto-detected or set `COPILOT_CLI_PATH`) and `GITHUB_TOKEN`.\n" }, { "path": "test/scenarios/sessions/session-resume/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n // 1. Create a session\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Model = \"claude-haiku-4.5\",\n AvailableTools = new List(),\n });\n\n // 2. Send the secret word\n await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Remember this: the secret word is PINEAPPLE.\",\n });\n\n // 3. Get the session ID\n var sessionId = session.SessionId;\n\n // 4. Resume the session with the same ID\n await using var resumed = await client.ResumeSessionAsync(sessionId, new ResumeSessionConfig\n {\n OnPermissionRequest = PermissionHandler.ApproveAll,\n });\n Console.WriteLine(\"Session resumed\");\n\n // 5. Ask for the secret word\n var response = await resumed.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What was the secret word I told you?\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/sessions/session-resume/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/sessions/session-resume/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/sessions/session-resume/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/sessions/session-resume/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/sessions/session-resume/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\t// 1. Create a session\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\tModel: \"claude-haiku-4.5\",\n\t\tAvailableTools: []string{},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\t// 2. Send the secret word\n\t_, err = session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"Remember this: the secret word is PINEAPPLE.\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\t// 3. Get the session ID (don't disconnect — resume needs the session to persist)\n\tsessionID := session.SessionID\n\n\t// 4. Resume the session with the same ID\n\tresumed, err := client.ResumeSession(ctx, sessionID, &copilot.ResumeSessionConfig{\n\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Println(\"Session resumed\")\n\tdefer resumed.Disconnect()\n\n\t// 5. Ask for the secret word\n\tresponse, err := resumed.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What was the secret word I told you?\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n}\n" }, { "path": "test/scenarios/sessions/session-resume/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n # 1. Create a session\n session = await client.create_session(\n {\n \"model\": \"claude-haiku-4.5\",\n \"available_tools\": [],\n }\n )\n\n # 2. Send the secret word\n await session.send_and_wait(\n \"Remember this: the secret word is PINEAPPLE.\"\n )\n\n # 3. Get the session ID (don't disconnect — resume needs the session to persist)\n session_id = session.session_id\n\n # 4. Resume the session with the same ID\n resumed = await client.resume_session(session_id)\n print(\"Session resumed\")\n\n # 5. Ask for the secret word\n response = await resumed.send_and_wait(\n \"What was the secret word I told you?\"\n )\n\n if response:\n print(response.data.content)\n\n await resumed.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/sessions/session-resume/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/sessions/session-resume/typescript/package.json", "content": "{\n \"name\": \"sessions-session-resume-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Config sample — session persistence and resume\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/sessions/session-resume/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n // 1. Create a session\n const session = await client.createSession({\n model: \"claude-haiku-4.5\",\n availableTools: [],\n });\n\n // 2. Send the secret word\n await session.sendAndWait({\n prompt: \"Remember this: the secret word is PINEAPPLE.\",\n });\n\n // 3. Get the session ID (don't disconnect — resume needs the session to persist)\n const sessionId = session.sessionId;\n\n // 4. Resume the session with the same ID\n const resumed = await client.resumeSession(sessionId);\n console.log(\"Session resumed\");\n\n // 5. Ask for the secret word\n const response = await resumed.sendAndWait({\n prompt: \"What was the secret word I told you?\",\n });\n\n if (response) {\n console.log(response.data.content);\n }\n\n await resumed.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/sessions/session-resume/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=120\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n echo \"$output\"\n\n # Check that the response mentions the secret word\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n if echo \"$output\" | grep -qi \"pineapple\"; then\n # Also verify session resume indication in output\n if echo \"$output\" | grep -qi \"session.*resum\\|resum.*session\\|Session resumed\"; then\n echo \"✅ $name passed (confirmed session resume — found PINEAPPLE and session resume)\"\n PASS=$((PASS + 1))\n else\n echo \"⚠️ $name found PINEAPPLE but no session resume indication in output\"\n echo \"❌ $name failed (session resume not confirmed)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (no resume indication)\"\n fi\n else\n echo \"⚠️ $name ran but response does not mention PINEAPPLE\"\n echo \"❌ $name failed (secret word not recalled)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (PINEAPPLE not found)\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying sessions/session-resume samples\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o session-resume-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./session-resume-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/sessions/streaming/README.md", "content": "# Config Sample: Streaming\n\nDemonstrates configuring the Copilot SDK with **`streaming: true`** to receive incremental response chunks. This validates that the server sends multiple `assistant.message_delta` events before the final `assistant.message` event.\n\n## What Each Sample Does\n\n1. Creates a session with `streaming: true`\n2. Registers an event listener to count `assistant.message_delta` events\n3. Sends: _\"What is the capital of France?\"_\n4. Prints the final response and the number of streaming chunks received\n\n## Configuration\n\n| Option | Value | Effect |\n|--------|-------|--------|\n| `streaming` | `true` | Enables incremental streaming — the server emits `assistant.message_delta` events as tokens are generated |\n\n## Run\n\n```bash\n./verify.sh\n```\n\nRequires the `copilot` binary (auto-detected or set `COPILOT_CLI_PATH`) and `GITHUB_TOKEN`.\n" }, { "path": "test/scenarios/sessions/streaming/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nvar options = new CopilotClientOptions\n{\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n};\n\nvar cliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\");\nif (!string.IsNullOrEmpty(cliPath))\n{\n options.CliPath = cliPath;\n}\n\nusing var client = new CopilotClient(options);\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n Streaming = true,\n });\n\n var chunkCount = 0;\n using var subscription = session.On(evt =>\n {\n if (evt is AssistantMessageDeltaEvent)\n {\n chunkCount++;\n }\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is the capital of France?\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data.Content);\n }\n Console.WriteLine($\"\\nStreaming chunks received: {chunkCount}\");\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/sessions/streaming/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/sessions/streaming/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/sessions/streaming/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/sessions/streaming/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/sessions/streaming/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t\tStreaming: true,\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tchunkCount := 0\n\tsession.On(func(event copilot.SessionEvent) {\n\t\tif event.Type == \"assistant.message_delta\" {\n\t\t\tchunkCount++\n\t\t}\n\t})\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What is the capital of France?\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n\tfmt.Printf(\"\\nStreaming chunks received: %d\\n\", chunkCount)\n}\n" }, { "path": "test/scenarios/sessions/streaming/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session(\n {\n \"model\": \"claude-haiku-4.5\",\n \"streaming\": True,\n }\n )\n\n chunk_count = 0\n\n def on_event(event):\n nonlocal chunk_count\n if event.type.value == \"assistant.message_delta\":\n chunk_count += 1\n\n session.on(on_event)\n\n response = await session.send_and_wait(\n \"What is the capital of France?\"\n )\n\n if response:\n print(response.data.content)\n print(f\"\\nStreaming chunks received: {chunk_count}\")\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/sessions/streaming/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/sessions/streaming/typescript/package.json", "content": "{\n \"name\": \"sessions-streaming-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Config sample — streaming response chunks\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/sessions/streaming/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n const session = await client.createSession({\n model: \"claude-haiku-4.5\",\n streaming: true,\n });\n\n let chunkCount = 0;\n session.on(\"assistant.message_delta\", () => {\n chunkCount++;\n });\n\n const response = await session.sendAndWait({\n prompt: \"What is the capital of France?\",\n });\n\n if (response) {\n console.log(response.data.content);\n }\n console.log(`\\nStreaming chunks received: ${chunkCount}`);\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/sessions/streaming/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n echo \"$output\"\n\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n if echo \"$output\" | grep -qE \"Streaming chunks received: [1-9]\"; then\n # Also verify a final response was received (content printed before chunk count)\n if echo \"$output\" | grep -qiE \"Paris|France|capital\"; then\n echo \"✅ $name passed (confirmed streaming chunks and final response)\"\n PASS=$((PASS + 1))\n else\n echo \"⚠️ $name had streaming chunks but no final response content detected\"\n echo \"❌ $name failed (final response not found)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (no final response)\"\n fi\n else\n echo \"⚠️ $name ran but response may not confirm streaming\"\n echo \"❌ $name failed (expected streaming chunk pattern not found)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying sessions/streaming samples\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o streaming-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./streaming-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/tools/custom-agents/README.md", "content": "# Config Sample: Custom Agents\n\nDemonstrates configuring the Copilot SDK with **custom agent definitions** that restrict which tools an agent can use, and **agent-exclusive tools** that are hidden from the main agent. This validates:\n\n1. **Agent definition** — The `customAgents` session config accepts agent definitions with name, description, tool lists, and custom prompts.\n2. **Tool scoping** — Each custom agent can be restricted to a subset of available tools (e.g. read-only tools like `grep`, `glob`, `view`).\n3. **Agent-exclusive tools** — The `defaultAgent.excludedTools` option hides tools from the main agent while keeping them available to sub-agents.\n4. **Agent awareness** — The model recognizes and can describe the configured custom agents.\n\n## What Each Sample Does\n\n1. Creates a session with a custom `analyze-codebase` tool and a `customAgents` array containing a \"researcher\" agent\n2. Uses `defaultAgent.excludedTools` to hide `analyze-codebase` from the main agent\n3. The researcher agent is scoped to read-only tools plus `analyze-codebase`: `grep`, `glob`, `view`, `analyze-codebase`\n4. Sends: _\"What custom agents are available? Describe the researcher agent and its capabilities.\"_\n5. Prints the response — which should describe the researcher agent and its tool restrictions\n\n## Configuration\n\n| Option | Value | Effect |\n|--------|-------|--------|\n| `tools` | `[analyze-codebase]` | Registers custom tool at session level |\n| `defaultAgent.excludedTools` | `[\"analyze-codebase\"]` | Hides tool from main agent |\n| `customAgents[0].name` | `\"researcher\"` | Internal identifier for the agent |\n| `customAgents[0].displayName` | `\"Research Agent\"` | Human-readable name |\n| `customAgents[0].description` | Custom text | Describes agent purpose |\n| `customAgents[0].tools` | `[\"grep\", \"glob\", \"view\", \"analyze-codebase\"]` | Restricts agent to read-only tools + analysis |\n| `customAgents[0].prompt` | Custom text | Sets agent behavior instructions |\n\n## Run\n\n```bash\n./verify.sh\n```\n\nRequires the `copilot` binary (auto-detected or set `COPILOT_CLI_PATH`) and `GITHUB_TOKEN`.\n" }, { "path": "test/scenarios/tools/custom-agents/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\nusing Microsoft.Extensions.AI;\n\nvar cliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\");\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = cliPath,\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n var analyzeCodebase = AIFunctionFactory.Create(\n (string query) => $\"Analysis result for: {query}\",\n new AIFunctionFactoryOptions\n {\n Name = \"analyze-codebase\",\n Description = \"Performs deep analysis of the codebase\",\n });\n\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n Tools = [analyzeCodebase],\n DefaultAgent = new DefaultAgentConfig\n {\n ExcludedTools = [\"analyze-codebase\"],\n },\n CustomAgents =\n [\n new CustomAgentConfig\n {\n Name = \"researcher\",\n DisplayName = \"Research Agent\",\n Description = \"A research agent that can only read and search files, not modify them\",\n Tools = [\"grep\", \"glob\", \"view\", \"analyze-codebase\"],\n Prompt = \"You are a research assistant. You can search and read files but cannot modify anything. When asked about your capabilities, list the tools you have access to.\",\n },\n ],\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What custom agents are available? Describe the researcher agent and its capabilities.\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data.Content);\n }\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/tools/custom-agents/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/tools/custom-agents/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/tools/custom-agents/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/tools/custom-agents/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/tools/custom-agents/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\ttype AnalyzeParams struct {\n\t\tQuery string `json:\"query\" jsonschema:\"the analysis query\"`\n\t}\n\n\tanalyzeCodebase := copilot.DefineTool(\"analyze-codebase\",\n\t\t\"Performs deep analysis of the codebase\",\n\t\tfunc(params AnalyzeParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\treturn fmt.Sprintf(\"Analysis result for: %s\", params.Query), nil\n\t\t},\n\t)\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t\tTools: []copilot.Tool{analyzeCodebase},\n\t\tDefaultAgent: &copilot.DefaultAgentConfig{\n\t\t\tExcludedTools: []string{\"analyze-codebase\"},\n\t\t},\n\t\tCustomAgents: []copilot.CustomAgentConfig{\n\t\t\t{\n\t\t\t\tName: \"researcher\",\n\t\t\t\tDisplayName: \"Research Agent\",\n\t\t\t\tDescription: \"A research agent that can only read and search files, not modify them\",\n\t\t\t\tTools: []string{\"grep\", \"glob\", \"view\", \"analyze-codebase\"},\n\t\t\t\tPrompt: \"You are a research assistant. You can search and read files but cannot modify anything. When asked about your capabilities, list the tools you have access to.\",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What custom agents are available? Describe the researcher agent and its capabilities.\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n}\n" }, { "path": "test/scenarios/tools/custom-agents/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\nfrom copilot.tools import Tool\n\n\nasync def analyze_handler(args):\n return f\"Analysis result for: {args.get('query', '')}\"\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session(\n model=\"claude-haiku-4.5\",\n tools=[\n Tool(\n name=\"analyze-codebase\",\n description=\"Performs deep analysis of the codebase\",\n handler=analyze_handler,\n parameters={\n \"type\": \"object\",\n \"properties\": {\"query\": {\"type\": \"string\"}},\n },\n ),\n ],\n default_agent={\"excluded_tools\": [\"analyze-codebase\"]},\n custom_agents=[\n {\n \"name\": \"researcher\",\n \"display_name\": \"Research Agent\",\n \"description\": \"A research agent that can only read and search files, not modify them\",\n \"tools\": [\"grep\", \"glob\", \"view\", \"analyze-codebase\"],\n \"prompt\": \"You are a research assistant. You can search and read files but cannot modify anything. When asked about your capabilities, list the tools you have access to.\",\n },\n ],\n on_permission_request=lambda _: {\"action\": \"allow\"},\n )\n\n response = await session.send_and_wait(\n \"What custom agents are available? Describe the researcher agent and its capabilities.\"\n )\n\n if response:\n print(response.data.content)\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/tools/custom-agents/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/tools/custom-agents/typescript/package.json", "content": "{\n \"name\": \"tools-custom-agents-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Config sample — custom agent definitions with tool scoping\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/tools/custom-agents/typescript/src/index.ts", "content": "import { CopilotClient, defineTool } from \"@github/copilot-sdk\";\nimport { z } from \"zod\";\n\nconst analyzeCodebase = defineTool(\"analyze-codebase\", {\n description: \"Performs deep analysis of the codebase, generating extensive context\",\n parameters: z.object({ query: z.string().describe(\"The analysis query\") }),\n handler: async ({ query }) => {\n return `Analysis result for: ${query}`;\n },\n});\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n const session = await client.createSession({\n model: \"claude-haiku-4.5\",\n tools: [analyzeCodebase],\n defaultAgent: {\n excludedTools: [\"analyze-codebase\"],\n },\n customAgents: [\n {\n name: \"researcher\",\n displayName: \"Research Agent\",\n description: \"A research agent that can only read and search files, not modify them\",\n tools: [\"grep\", \"glob\", \"view\", \"analyze-codebase\"],\n prompt: \"You are a research assistant. You can search and read files but cannot modify anything. When asked about your capabilities, list the tools you have access to.\",\n },\n ],\n });\n\n const response = await session.sendAndWait({\n prompt: \"What custom agents are available? Describe the researcher agent and its capabilities.\",\n });\n\n if (response) {\n console.log(response.data.content);\n }\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/tools/custom-agents/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n echo \"$output\"\n\n # Check that the response mentions the researcher agent or its tools\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n if echo \"$output\" | grep -qi \"researcher\\|Research\"; then\n echo \"✅ $name passed (confirmed custom agent)\"\n PASS=$((PASS + 1))\n else\n echo \"⚠️ $name ran but response may not confirm custom agent\"\n echo \"❌ $name failed (expected pattern not found)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying tools/custom-agents samples\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o custom-agents-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./custom-agents-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/tools/mcp-servers/README.md", "content": "# Config Sample: MCP Servers\n\nDemonstrates configuring the Copilot SDK with **MCP (Model Context Protocol) server** integration. This validates that the SDK correctly passes `mcpServers` configuration to the runtime for connecting to external tool providers via stdio.\n\n## What Each Sample Does\n\n1. Checks for `MCP_SERVER_CMD` environment variable\n2. If set, configures an MCP server entry of type `stdio` in the session config\n3. Creates a session with `availableTools: []` and optionally `mcpServers`\n4. Sends: _\"What is the capital of France?\"_ as a fallback test prompt\n5. Prints the response and whether MCP servers were configured\n\n## Configuration\n\n| Option | Value | Effect |\n|--------|-------|--------|\n| `mcpServers` | Map of server configs | Connects to external MCP servers that expose tools |\n| `mcpServers.*.type` | `\"stdio\"` | Communicates with the MCP server via stdin/stdout |\n| `mcpServers.*.command` | Executable path | The MCP server binary to spawn |\n| `mcpServers.*.args` | String array | Arguments passed to the MCP server |\n| `availableTools` | `[]` (empty array) | No built-in tools; MCP tools used if available |\n\n## Environment Variables\n\n| Variable | Required | Description |\n|----------|----------|-------------|\n| `COPILOT_CLI_PATH` | No | Path to `copilot` binary (auto-detected) |\n| `GITHUB_TOKEN` | Yes | GitHub auth token (falls back to `gh auth token`) |\n| `MCP_SERVER_CMD` | No | MCP server executable — when set, enables MCP integration |\n| `MCP_SERVER_ARGS` | No | Space-separated arguments for the MCP server command |\n\n## Run\n\n```bash\n# Without MCP server (build + basic integration test)\n./verify.sh\n\n# With a real MCP server\nMCP_SERVER_CMD=npx MCP_SERVER_ARGS=\"@modelcontextprotocol/server-filesystem /tmp\" ./verify.sh\n```\n\nRequires the `copilot` binary (auto-detected or set `COPILOT_CLI_PATH`) and `GITHUB_TOKEN`.\n" }, { "path": "test/scenarios/tools/mcp-servers/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n var mcpServers = new Dictionary();\n var mcpServerCmd = Environment.GetEnvironmentVariable(\"MCP_SERVER_CMD\");\n if (!string.IsNullOrEmpty(mcpServerCmd))\n {\n var mcpArgs = Environment.GetEnvironmentVariable(\"MCP_SERVER_ARGS\");\n mcpServers[\"example\"] = new McpStdioServerConfig\n {\n Command = mcpServerCmd,\n Args = string.IsNullOrEmpty(mcpArgs) ? [] : [.. mcpArgs.Split(' ')],\n Tools = [\"*\"],\n };\n }\n\n var config = new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n AvailableTools = new List(),\n SystemMessage = new SystemMessageConfig\n {\n Mode = SystemMessageMode.Replace,\n Content = \"You are a helpful assistant. Answer questions concisely.\",\n },\n };\n\n if (mcpServers.Count > 0)\n {\n config.McpServers = mcpServers;\n }\n\n await using var session = await client.CreateSessionAsync(config);\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is the capital of France?\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n\n if (mcpServers.Count > 0)\n {\n Console.WriteLine($\"\\nMCP servers configured: {string.Join(\", \", mcpServers.Keys)}\");\n }\n else\n {\n Console.WriteLine(\"\\nNo MCP servers configured (set MCP_SERVER_CMD to test with a real server)\");\n }\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/tools/mcp-servers/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/tools/mcp-servers/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/tools/mcp-servers/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/tools/mcp-servers/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/tools/mcp-servers/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\t\"strings\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\t// MCP server config — demonstrates the configuration pattern.\n\t// When MCP_SERVER_CMD is set, connects to a real MCP server.\n\t// Otherwise, runs without MCP tools as a build/integration test.\n\tmcpServers := map[string]copilot.MCPServerConfig{}\n\tif cmd := os.Getenv(\"MCP_SERVER_CMD\"); cmd != \"\" {\n\t\tvar args []string\n\t\tif argsStr := os.Getenv(\"MCP_SERVER_ARGS\"); argsStr != \"\" {\n\t\t\targs = strings.Split(argsStr, \" \")\n\t\t}\n\t\tmcpServers[\"example\"] = copilot.MCPStdioServerConfig{\n\t\t\tCommand: cmd,\n\t\t\tArgs: args,\n\t\t\tTools: []string{\"*\"},\n\t\t}\n\t}\n\n\tsessionConfig := &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\tMode: \"replace\",\n\t\t\tContent: \"You are a helpful assistant. Answer questions concisely.\",\n\t\t},\n\t\tAvailableTools: []string{},\n\t}\n\tif len(mcpServers) > 0 {\n\t\tsessionConfig.MCPServers = mcpServers\n\t}\n\n\tsession, err := client.CreateSession(ctx, sessionConfig)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What is the capital of France?\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n\n\tif len(mcpServers) > 0 {\n\t\tkeys := make([]string, 0, len(mcpServers))\n\t\tfor k := range mcpServers {\n\t\t\tkeys = append(keys, k)\n\t\t}\n\t\tfmt.Printf(\"\\nMCP servers configured: %s\\n\", strings.Join(keys, \", \"))\n\t} else {\n\t\tfmt.Println(\"\\nNo MCP servers configured (set MCP_SERVER_CMD to test with a real server)\")\n\t}\n}\n" }, { "path": "test/scenarios/tools/mcp-servers/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n # MCP server config — demonstrates the configuration pattern.\n # When MCP_SERVER_CMD is set, connects to a real MCP server.\n # Otherwise, runs without MCP tools as a build/integration test.\n mcp_servers = {}\n if os.environ.get(\"MCP_SERVER_CMD\"):\n args = os.environ.get(\"MCP_SERVER_ARGS\", \"\").split() if os.environ.get(\"MCP_SERVER_ARGS\") else []\n mcp_servers[\"example\"] = {\n \"type\": \"stdio\",\n \"command\": os.environ[\"MCP_SERVER_CMD\"],\n \"args\": args,\n }\n\n session_config = {\n \"model\": \"claude-haiku-4.5\",\n \"available_tools\": [],\n \"system_message\": {\n \"mode\": \"replace\",\n \"content\": \"You are a helpful assistant. Answer questions concisely.\",\n },\n }\n if mcp_servers:\n session_config[\"mcp_servers\"] = mcp_servers\n\n session = await client.create_session(session_config)\n\n response = await session.send_and_wait(\n \"What is the capital of France?\"\n )\n\n if response:\n print(response.data.content)\n\n if mcp_servers:\n print(f\"\\nMCP servers configured: {', '.join(mcp_servers.keys())}\")\n else:\n print(\"\\nNo MCP servers configured (set MCP_SERVER_CMD to test with a real server)\")\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/tools/mcp-servers/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/tools/mcp-servers/typescript/package.json", "content": "{\n \"name\": \"tools-mcp-servers-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Config sample — MCP server integration\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/tools/mcp-servers/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n // MCP server config — demonstrates the configuration pattern.\n // When MCP_SERVER_CMD is set, connects to a real MCP server.\n // Otherwise, runs without MCP tools as a build/integration test.\n const mcpServers: Record = {};\n if (process.env.MCP_SERVER_CMD) {\n mcpServers[\"example\"] = {\n type: \"stdio\",\n command: process.env.MCP_SERVER_CMD,\n args: process.env.MCP_SERVER_ARGS ? process.env.MCP_SERVER_ARGS.split(\" \") : [],\n };\n }\n\n const session = await client.createSession({\n model: \"claude-haiku-4.5\",\n ...(Object.keys(mcpServers).length > 0 && { mcpServers }),\n availableTools: [],\n systemMessage: {\n mode: \"replace\",\n content: \"You are a helpful assistant. Answer questions concisely.\",\n },\n });\n\n const response = await session.sendAndWait({\n prompt: \"What is the capital of France?\",\n });\n\n if (response) {\n console.log(response.data.content);\n }\n\n if (Object.keys(mcpServers).length > 0) {\n console.log(\"\\nMCP servers configured: \" + Object.keys(mcpServers).join(\", \"));\n } else {\n console.log(\"\\nNo MCP servers configured (set MCP_SERVER_CMD to test with a real server)\");\n }\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/tools/mcp-servers/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n echo \"$output\"\n\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ] && echo \"$output\" | grep -qi \"MCP\\|mcp\\|capital\\|France\\|Paris\\|configured\"; then\n echo \"✅ $name passed (got meaningful response)\"\n PASS=$((PASS + 1))\n elif [ \"$code\" -eq 124 ]; then\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n elif [ \"$code\" -eq 0 ]; then\n echo \"❌ $name failed (expected pattern not found)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n else\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying tools/mcp-servers samples\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o mcp-servers-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./mcp-servers-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/tools/no-tools/README.md", "content": "# Config Sample: No Tools\n\nDemonstrates configuring the Copilot SDK with **zero tools** and a custom system prompt that reflects the tool-less state. This validates two things:\n\n1. **Tool removal** — Setting `availableTools: []` removes all built-in tools (bash, view, edit, grep, glob, etc.) from the agent's capabilities.\n2. **Agent awareness** — The replaced system prompt tells the agent it has no tools, and the agent's response confirms this.\n\n## What Each Sample Does\n\n1. Creates a session with `availableTools: []` and a `systemMessage` in `replace` mode\n2. Sends: _\"What tools do you have available? List them.\"_\n3. Prints the response — which should confirm the agent has no tools\n\n## Configuration\n\n| Option | Value | Effect |\n|--------|-------|--------|\n| `availableTools` | `[]` (empty array) | Whitelists zero tools — all built-in tools are removed |\n| `systemMessage.mode` | `\"replace\"` | Replaces the default system prompt entirely |\n| `systemMessage.content` | Custom minimal prompt | Tells the agent it has no tools and can only respond with text |\n\n## Run\n\n```bash\n./verify.sh\n```\n\nRequires the `copilot` binary (auto-detected or set `COPILOT_CLI_PATH`) and `GITHUB_TOKEN`.\n" }, { "path": "test/scenarios/tools/no-tools/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nconst string SystemPrompt = \"\"\"\n You are a minimal assistant with no tools available.\n You cannot execute code, read files, edit files, search, or perform any actions.\n You can only respond with text based on your training data.\n If asked about your capabilities or tools, clearly state that you have no tools available.\n \"\"\";\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n SystemMessage = new SystemMessageConfig\n {\n Mode = SystemMessageMode.Replace,\n Content = SystemPrompt,\n },\n AvailableTools = [],\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Use the bash tool to run 'echo hello'.\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/tools/no-tools/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/tools/no-tools/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/tools/no-tools/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/tools/no-tools/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/tools/no-tools/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nconst systemPrompt = `You are a minimal assistant with no tools available.\nYou cannot execute code, read files, edit files, search, or perform any actions.\nYou can only respond with text based on your training data.\nIf asked about your capabilities or tools, clearly state that you have no tools available.`\n\nfunc main() {\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\tMode: \"replace\",\n\t\t\tContent: systemPrompt,\n\t\t},\n\t\tAvailableTools: []string{},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"Use the bash tool to run 'echo hello'.\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n}\n" }, { "path": "test/scenarios/tools/no-tools/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\nSYSTEM_PROMPT = \"\"\"You are a minimal assistant with no tools available.\nYou cannot execute code, read files, edit files, search, or perform any actions.\nYou can only respond with text based on your training data.\nIf asked about your capabilities or tools, clearly state that you have no tools available.\"\"\"\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session(\n {\n \"model\": \"claude-haiku-4.5\",\n \"system_message\": {\"mode\": \"replace\", \"content\": SYSTEM_PROMPT},\n \"available_tools\": [],\n }\n )\n\n response = await session.send_and_wait(\n \"Use the bash tool to run 'echo hello'.\"\n )\n\n if response:\n print(response.data.content)\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/tools/no-tools/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/tools/no-tools/typescript/package.json", "content": "{\n \"name\": \"tools-no-tools-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Config sample — no tools, minimal system prompt\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/tools/no-tools/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nconst SYSTEM_PROMPT = `You are a minimal assistant with no tools available.\nYou cannot execute code, read files, edit files, search, or perform any actions.\nYou can only respond with text based on your training data.\nIf asked about your capabilities or tools, clearly state that you have no tools available.`;\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n const session = await client.createSession({\n model: \"claude-haiku-4.5\",\n systemMessage: { mode: \"replace\", content: SYSTEM_PROMPT },\n availableTools: [],\n });\n\n const response = await session.sendAndWait({\n prompt: \"Use the bash tool to run 'echo hello'.\",\n });\n\n if (response) {\n console.log(response.data.content);\n }\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/tools/no-tools/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n echo \"$output\"\n\n # Check that the response indicates no tools are available\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n if echo \"$output\" | grep -qi \"no tool\\|can't\\|cannot\\|unable\\|don't have\\|do not have\\|not available\"; then\n echo \"✅ $name passed (confirmed no tools)\"\n PASS=$((PASS + 1))\n else\n echo \"⚠️ $name ran but response may not confirm tool-less state\"\n echo \"❌ $name failed (expected pattern not found)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying tools/no-tools samples\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o no-tools-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./no-tools-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/tools/skills/README.md", "content": "# Config Sample: Skills (SKILL.md Discovery)\n\nDemonstrates configuring the Copilot SDK with **skill directories** that contain `SKILL.md` files. The agent discovers and uses skills defined in these markdown files at runtime.\n\n## What This Tests\n\n1. **Skill discovery** — Setting `skillDirectories` points the agent to directories containing `SKILL.md` files that define available skills.\n2. **Skill execution** — The agent reads the skill definition and follows its instructions when prompted to use the skill.\n3. **SKILL.md format** — Skills are defined as markdown files with a name, description, and usage instructions.\n\n## SKILL.md Format\n\nA `SKILL.md` file is a markdown document placed in a named directory under a skills root:\n\n```\nsample-skills/\n└── greeting/\n └── SKILL.md # Defines the \"greeting\" skill\n```\n\nThe file contains:\n- **Title** (`# skill-name`) — The skill's identifier\n- **Description** — What the skill does\n- **Usage** — Instructions the agent follows when the skill is invoked\n\n## What Each Sample Does\n\n1. Creates a session with `skillDirectories` pointing to `sample-skills/`\n2. Sends: _\"Use the greeting skill to greet someone named Alice.\"_\n3. The agent discovers the greeting skill from `SKILL.md` and generates a personalized greeting\n4. Prints the response and confirms skill directory configuration\n\n## Configuration\n\n| Option | Value | Effect |\n|--------|-------|--------|\n| `skillDirectories` | `[\"path/to/sample-skills\"]` | Points the agent to directories containing skill definitions |\n\n## Run\n\n```bash\n./verify.sh\n```\n\nRequires the `copilot` binary (auto-detected or set `COPILOT_CLI_PATH`) and `GITHUB_TOKEN`.\n" }, { "path": "test/scenarios/tools/skills/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n var skillsDir = Path.GetFullPath(Path.Combine(AppContext.BaseDirectory, \"..\", \"..\", \"..\", \"..\", \"sample-skills\"));\n\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n SkillDirectories = [skillsDir],\n OnPermissionRequest = (request, invocation) =>\n Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved }),\n Hooks = new SessionHooks\n {\n OnPreToolUse = (input, invocation) =>\n Task.FromResult(new PreToolUseHookOutput { PermissionDecision = \"allow\" }),\n },\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Use the greeting skill to greet someone named Alice.\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n\n Console.WriteLine(\"\\nSkill directories configured successfully\");\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/tools/skills/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/tools/skills/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/tools/skills/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/tools/skills/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/tools/skills/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"runtime\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\t_, thisFile, _, _ := runtime.Caller(0)\n\tskillsDir := filepath.Join(filepath.Dir(thisFile), \"..\", \"sample-skills\")\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t\tSkillDirectories: []string{skillsDir},\n\t\tOnPermissionRequest: func(request copilot.PermissionRequest, invocation copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\treturn copilot.PermissionRequestResult{Kind: \"approved\"}, nil\n\t\t},\n\t\tHooks: &copilot.SessionHooks{\n\t\t\tOnPreToolUse: func(input copilot.PreToolUseHookInput, invocation copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {\n\t\t\t\treturn &copilot.PreToolUseHookOutput{PermissionDecision: \"allow\"}, nil\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"Use the greeting skill to greet someone named Alice.\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n\n\tfmt.Println(\"\\nSkill directories configured successfully\")\n}\n" }, { "path": "test/scenarios/tools/skills/python/main.py", "content": "import asyncio\nimport os\nfrom pathlib import Path\n\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n skills_dir = str(Path(__file__).resolve().parent.parent / \"sample-skills\")\n\n session = await client.create_session(\n on_permission_request=lambda _, __: {\"kind\": \"approved\"},\n model=\"claude-haiku-4.5\",\n skill_directories=[skills_dir],\n hooks={\n \"on_pre_tool_use\": lambda _, __: {\"permissionDecision\": \"allow\"},\n },\n )\n\n response = await session.send_and_wait(\n \"Use the greeting skill to greet someone named Alice.\"\n )\n\n if response:\n print(response.data.content)\n\n print(\"\\nSkill directories configured successfully\")\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/tools/skills/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/tools/skills/sample-skills/greeting/SKILL.md", "content": "# greeting\n\nA skill that generates personalized greetings.\n\n## Usage\n\nWhen asked to greet someone, generate a warm, personalized greeting message.\nAlways include the person's name and a fun fact about their name.\n" }, { "path": "test/scenarios/tools/skills/typescript/package.json", "content": "{\n \"name\": \"tools-skills-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Config sample — skill discovery and execution via SKILL.md\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/tools/skills/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\nimport path from \"path\";\nimport { fileURLToPath } from \"url\";\n\nconst __dirname = path.dirname(fileURLToPath(import.meta.url));\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n const skillsDir = path.resolve(__dirname, \"../../sample-skills\");\n\n const session = await client.createSession({\n model: \"claude-haiku-4.5\",\n skillDirectories: [skillsDir],\n onPermissionRequest: async () => ({ kind: \"approved\" as const }),\n hooks: {\n onPreToolUse: async () => ({ permissionDecision: \"allow\" as const }),\n },\n });\n\n const response = await session.sendAndWait({\n prompt: \"Use the greeting skill to greet someone named Alice.\",\n });\n\n if (response) {\n console.log(response.data.content);\n }\n\n console.log(\"\\nSkill directories configured successfully\");\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/tools/skills/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=120\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n echo \"$output\"\n\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n if echo \"$output\" | grep -qi \"skill\\|Skill\\|greeting\\|Alice\"; then\n echo \"✅ $name passed (confirmed skill execution)\"\n PASS=$((PASS + 1))\n else\n echo \"⚠️ $name ran but response may not confirm skill execution\"\n echo \"❌ $name failed (expected pattern not found)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying tools/skills samples\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o skills-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./skills-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/tools/tool-filtering/README.md", "content": "# Config Sample: Tool Filtering\n\nDemonstrates advanced tool filtering using the `availableTools` whitelist. This restricts the agent to only the specified read-only tools, removing all others (bash, edit, create_file, etc.).\n\nThe Copilot SDK supports two complementary filtering mechanisms:\n\n- **`availableTools`** (whitelist) — Only the listed tools are available. All others are removed.\n- **`excludedTools`** (blacklist) — All tools are available *except* the listed ones.\n\nThis sample tests the **whitelist** approach with `[\"grep\", \"glob\", \"view\"]`.\n\n## What Each Sample Does\n\n1. Creates a session with `availableTools: [\"grep\", \"glob\", \"view\"]` and a `systemMessage` in `replace` mode\n2. Sends: _\"What tools do you have available? List each one by name.\"_\n3. Prints the response — which should list only grep, glob, and view\n\n## Configuration\n\n| Option | Value | Effect |\n|--------|-------|--------|\n| `availableTools` | `[\"grep\", \"glob\", \"view\"]` | Whitelists only read-only tools |\n| `systemMessage.mode` | `\"replace\"` | Replaces the default system prompt entirely |\n| `systemMessage.content` | Custom prompt | Instructs the agent to list its available tools |\n\n## Run\n\n```bash\n./verify.sh\n```\n\nRequires the `copilot` binary (auto-detected or set `COPILOT_CLI_PATH`) and `GITHUB_TOKEN`.\n\n## Verification\n\nThe verify script checks that:\n- The response mentions at least one whitelisted tool (grep, glob, or view)\n- The response does **not** mention excluded tools (bash, edit, or create_file)\n" }, { "path": "test/scenarios/tools/tool-filtering/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n SystemMessage = new SystemMessageConfig\n {\n Mode = SystemMessageMode.Replace,\n Content = \"You are a helpful assistant. You have access to a limited set of tools. When asked about your tools, list exactly which tools you have available.\",\n },\n AvailableTools = [\"grep\", \"glob\", \"view\"],\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What tools do you have available? List each one by name.\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/tools/tool-filtering/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/tools/tool-filtering/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/tools/tool-filtering/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/tools/tool-filtering/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/tools/tool-filtering/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nconst systemPrompt = `You are a helpful assistant. You have access to a limited set of tools. When asked about your tools, list exactly which tools you have available.`\n\nfunc main() {\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t\tSystemMessage: &copilot.SystemMessageConfig{\n\t\t\tMode: \"replace\",\n\t\t\tContent: systemPrompt,\n\t\t},\n\t\tAvailableTools: []string{\"grep\", \"glob\", \"view\"},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What tools do you have available? List each one by name.\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n}\n" }, { "path": "test/scenarios/tools/tool-filtering/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\nSYSTEM_PROMPT = \"\"\"You are a helpful assistant. You have access to a limited set of tools. When asked about your tools, list exactly which tools you have available.\"\"\"\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session(\n {\n \"model\": \"claude-haiku-4.5\",\n \"system_message\": {\"mode\": \"replace\", \"content\": SYSTEM_PROMPT},\n \"available_tools\": [\"grep\", \"glob\", \"view\"],\n }\n )\n\n response = await session.send_and_wait(\n \"What tools do you have available? List each one by name.\"\n )\n\n if response:\n print(response.data.content)\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/tools/tool-filtering/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/tools/tool-filtering/typescript/package.json", "content": "{\n \"name\": \"tools-tool-filtering-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Config sample — advanced tool filtering with availableTools whitelist\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/tools/tool-filtering/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n const session = await client.createSession({\n model: \"claude-haiku-4.5\",\n systemMessage: {\n mode: \"replace\",\n content: \"You are a helpful assistant. You have access to a limited set of tools. When asked about your tools, list exactly which tools you have available.\",\n },\n availableTools: [\"grep\", \"glob\", \"view\"],\n });\n\n const response = await session.sendAndWait({\n prompt: \"What tools do you have available? List each one by name.\",\n });\n\n if (response) {\n console.log(response.data.content);\n }\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/tools/tool-filtering/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n echo \"$output\"\n\n # Check that whitelisted tools are mentioned and blacklisted tools are NOT\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n local has_whitelisted=false\n local has_blacklisted=false\n\n if echo \"$output\" | grep -qi \"grep\\|glob\\|view\"; then\n has_whitelisted=true\n fi\n if echo \"$output\" | grep -qiw \"bash\\|edit\\|create_file\"; then\n has_blacklisted=true\n fi\n\n if $has_whitelisted && ! $has_blacklisted; then\n echo \"✅ $name passed (confirmed whitelisted tools only)\"\n PASS=$((PASS + 1))\n else\n echo \"⚠️ $name ran but response mentions excluded tools or missing whitelisted tools\"\n echo \"❌ $name failed (expected pattern not found)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying tools/tool-filtering samples\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o tool-filtering-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./tool-filtering-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/tools/tool-overrides/README.md", "content": "# Config Sample: Tool Overrides\n\nDemonstrates how to override a built-in tool with a custom implementation using the `overridesBuiltInTool` flag. When this flag is set on a custom tool, the SDK knows to disable the corresponding built-in tool so your implementation is used instead.\n\n## What Each Sample Does\n\n1. Creates a session with a custom `grep` tool (with `overridesBuiltInTool` enabled) that returns `\"CUSTOM_GREP_RESULT: \"`\n2. Sends: _\"Use grep to search for the word 'hello'\"_\n3. Prints the response — which should contain `CUSTOM_GREP_RESULT` (proving the custom tool ran, not the built-in)\n\n## Configuration\n\n| Option | Value | Effect |\n|--------|-------|--------|\n| `tools` | Custom `grep` tool | Provides a custom grep implementation |\n| `overridesBuiltInTool` | `true` | Tells the SDK to disable the built-in `grep` in favor of the custom one |\n\nThe flag is set per-tool in TypeScript (`overridesBuiltInTool: true`), Python (`overrides_built_in_tool=True`), and Go (`OverridesBuiltInTool: true`). In C#, set `is_override` in the tool's `AdditionalProperties` via `AIFunctionFactoryOptions`.\n\n## Run\n\n```bash\n./verify.sh\n```\n\nRequires the `copilot` binary (auto-detected or set `COPILOT_CLI_PATH`) and `GITHUB_TOKEN`.\n\n## Verification\n\nThe verify script checks that:\n- The response contains `CUSTOM_GREP_RESULT` (custom tool was invoked)\n- The response does **not** contain typical built-in grep output patterns\n" }, { "path": "test/scenarios/tools/tool-overrides/csharp/Program.cs", "content": "using System.Collections.ObjectModel;\nusing System.ComponentModel;\nusing GitHub.Copilot.SDK;\nusing Microsoft.Extensions.AI;\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n OnPermissionRequest = PermissionHandler.ApproveAll,\n Tools = [AIFunctionFactory.Create((Delegate)CustomGrep, new AIFunctionFactoryOptions\n {\n Name = \"grep\",\n AdditionalProperties = new ReadOnlyDictionary(\n new Dictionary { [\"is_override\"] = true })\n })],\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Use grep to search for the word 'hello'\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n}\nfinally\n{\n await client.StopAsync();\n}\n\n[Description(\"A custom grep implementation that overrides the built-in\")]\nstatic string CustomGrep([Description(\"Search query\")] string query)\n => $\"CUSTOM_GREP_RESULT: {query}\";\n" }, { "path": "test/scenarios/tools/tool-overrides/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/tools/tool-overrides/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/tools/tool-overrides/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/tools/tool-overrides/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/tools/tool-overrides/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\ntype GrepParams struct {\n\tQuery string `json:\"query\" jsonschema:\"Search query\"`\n}\n\nfunc main() {\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tgrepTool := copilot.DefineTool(\"grep\", \"A custom grep implementation that overrides the built-in\",\n\t\tfunc(params GrepParams, inv copilot.ToolInvocation) (string, error) {\n\t\t\treturn \"CUSTOM_GREP_RESULT: \" + params.Query, nil\n\t\t})\n\tgrepTool.OverridesBuiltInTool = true\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t\tOnPermissionRequest: copilot.PermissionHandler.ApproveAll,\n\t\tTools: []copilot.Tool{grepTool},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"Use grep to search for the word 'hello'\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n}\n" }, { "path": "test/scenarios/tools/tool-overrides/python/main.py", "content": "import asyncio\nimport os\n\nfrom pydantic import BaseModel, Field\n\nfrom copilot import CopilotClient, define_tool\nfrom copilot.client import SubprocessConfig\nfrom copilot.session import PermissionHandler\n\n\nclass GrepParams(BaseModel):\n query: str = Field(description=\"Search query\")\n\n\n@define_tool(\"grep\", description=\"A custom grep implementation that overrides the built-in\", overrides_built_in_tool=True)\ndef custom_grep(params: GrepParams) -> str:\n return f\"CUSTOM_GREP_RESULT: {params.query}\"\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session(\n on_permission_request=PermissionHandler.approve_all, model=\"claude-haiku-4.5\", tools=[custom_grep]\n )\n\n response = await session.send_and_wait(\n \"Use grep to search for the word 'hello'\"\n )\n\n if response:\n print(response.data.content)\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/tools/tool-overrides/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/tools/tool-overrides/typescript/package.json", "content": "{\n \"name\": \"tools-tool-overrides-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Config sample — custom tool overriding a built-in tool\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/tools/tool-overrides/typescript/src/index.ts", "content": "import { CopilotClient, defineTool, approveAll } from \"@github/copilot-sdk\";\nimport { z } from \"zod\";\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n const session = await client.createSession({\n model: \"claude-haiku-4.5\",\n onPermissionRequest: approveAll,\n tools: [\n defineTool(\"grep\", {\n description: \"A custom grep implementation that overrides the built-in\",\n parameters: z.object({\n query: z.string().describe(\"Search query\"),\n }),\n overridesBuiltInTool: true,\n handler: ({ query }) => `CUSTOM_GREP_RESULT: ${query}`,\n }),\n ],\n });\n\n const response = await session.sendAndWait({\n prompt: \"Use grep to search for the word 'hello'\",\n });\n\n if (response) {\n console.log(response.data.content);\n }\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/tools/tool-overrides/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n echo \"$output\"\n\n # Check that custom grep tool was used (not built-in)\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n if echo \"$output\" | grep -q \"CUSTOM_GREP_RESULT\"; then\n echo \"✅ $name passed (confirmed custom tool override)\"\n PASS=$((PASS + 1))\n else\n echo \"⚠️ $name ran but response doesn't contain CUSTOM_GREP_RESULT\"\n echo \"❌ $name failed (expected pattern not found)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying tools/tool-overrides samples\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o tool-overrides-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./tool-overrides-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/tools/virtual-filesystem/README.md", "content": "# Config Sample: Virtual Filesystem\n\nDemonstrates running the Copilot agent with **custom tool implementations backed by an in-memory store** instead of the real filesystem. The agent doesn't know it's virtual — it sees `create_file`, `read_file`, and `list_files` tools that work normally, but zero bytes ever touch disk.\n\nThis pattern is the foundation for:\n- **WASM / browser agents** where there's no real filesystem\n- **Cloud-hosted sandboxes** where file ops go to object storage\n- **Multi-tenant platforms** where each user gets isolated virtual storage\n- **Office add-ins** where \"files\" are document sections in memory\n\n## How It Works\n\n1. **Disable all built-in tools** with `availableTools: []`\n2. **Provide custom tools** (`create_file`, `read_file`, `list_files`) whose handlers read/write a `Map` / `dict` / `HashMap` in the host process\n3. **Auto-approve permissions** — no dialogs since the tools are entirely user-controlled\n4. The agent uses the tools normally — it doesn't know they're virtual\n\n## What Each Sample Does\n\n1. Creates a session with no built-in tools + 3 custom virtual FS tools\n2. Sends: _\"Create a file called plan.md with a brief 3-item project plan for building a CLI tool. Then read it back and tell me what you wrote.\"_\n3. The agent calls `create_file` → writes to in-memory map\n4. The agent calls `read_file` → reads from in-memory map\n5. Prints the agent's response\n6. Dumps the in-memory store to prove files exist only in memory\n\n## Configuration\n\n| Option | Value | Effect |\n|--------|-------|--------|\n| `availableTools` | `[]` (empty) | Removes all built-in tools (bash, view, edit, create_file, grep, glob, etc.) |\n| `tools` | `[create_file, read_file, list_files]` | Custom tools backed by in-memory storage |\n| `onPermissionRequest` | Auto-approve | No permission dialogs |\n| `hooks.onPreToolUse` | Auto-allow | No tool confirmation prompts |\n\n## Key Insight\n\nThe integrator controls the tool layer. By replacing built-in tools with custom implementations, you can swap the backing store to anything — `Map`, Redis, S3, SQLite, IndexedDB — without the agent knowing or caring. The system prompt stays the same. The agent plans and operates normally.\n\nCustom tools with the same name as a built-in automatically override the built-in — no need to explicitly exclude them. `availableTools: []` removes all built-ins while keeping your custom tools available.\n\n## Run\n\n```bash\n./verify.sh\n```\n\nRequires the `copilot` binary (auto-detected or set `COPILOT_CLI_PATH`) and `GITHUB_TOKEN`.\n" }, { "path": "test/scenarios/tools/virtual-filesystem/csharp/Program.cs", "content": "using System.ComponentModel;\nusing GitHub.Copilot.SDK;\nusing Microsoft.Extensions.AI;\n\n// In-memory virtual filesystem\nvar virtualFs = new Dictionary();\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n AvailableTools = [],\n Tools =\n [\n AIFunctionFactory.Create(\n ([Description(\"File path\")] string path, [Description(\"File content\")] string content) =>\n {\n virtualFs[path] = content;\n return $\"Created {path} ({content.Length} bytes)\";\n },\n \"create_file\",\n \"Create or overwrite a file at the given path with the provided content\"),\n AIFunctionFactory.Create(\n ([Description(\"File path\")] string path) =>\n {\n return virtualFs.TryGetValue(path, out var content)\n ? content\n : $\"Error: file not found: {path}\";\n },\n \"read_file\",\n \"Read the contents of a file at the given path\"),\n AIFunctionFactory.Create(\n () =>\n {\n return virtualFs.Count == 0\n ? \"No files\"\n : string.Join(\"\\n\", virtualFs.Keys);\n },\n \"list_files\",\n \"List all files in the virtual filesystem\"),\n ],\n OnPermissionRequest = (request, invocation) =>\n Task.FromResult(new PermissionRequestResult { Kind = PermissionRequestResultKind.Approved }),\n Hooks = new SessionHooks\n {\n OnPreToolUse = (input, invocation) =>\n Task.FromResult(new PreToolUseHookOutput { PermissionDecision = \"allow\" }),\n },\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"Create a file called plan.md with a brief 3-item project plan for building a CLI tool. Then read it back and tell me what you wrote.\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n\n // Dump the virtual filesystem to prove nothing touched disk\n Console.WriteLine(\"\\n--- Virtual filesystem contents ---\");\n foreach (var (path, content) in virtualFs)\n {\n Console.WriteLine($\"\\n[{path}]\");\n Console.WriteLine(content);\n }\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/tools/virtual-filesystem/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/tools/virtual-filesystem/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/tools/virtual-filesystem/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/tools/virtual-filesystem/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/tools/virtual-filesystem/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\t\"strings\"\n\t\"sync\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\n// In-memory virtual filesystem\nvar (\n\tvirtualFs = make(map[string]string)\n\tvirtualFsMu sync.Mutex\n)\n\ntype CreateFileArgs struct {\n\tPath string `json:\"path\" description:\"File path\"`\n\tContent string `json:\"content\" description:\"File content\"`\n}\n\ntype ReadFileArgs struct {\n\tPath string `json:\"path\" description:\"File path\"`\n}\n\nfunc main() {\n\tcreateFile := copilot.DefineTool[CreateFileArgs, string](\n\t\t\"create_file\",\n\t\t\"Create or overwrite a file at the given path with the provided content\",\n\t\tfunc(args CreateFileArgs, inv copilot.ToolInvocation) (string, error) {\n\t\t\tvirtualFsMu.Lock()\n\t\t\tvirtualFs[args.Path] = args.Content\n\t\t\tvirtualFsMu.Unlock()\n\t\t\treturn fmt.Sprintf(\"Created %s (%d bytes)\", args.Path, len(args.Content)), nil\n\t\t},\n\t)\n\n\treadFile := copilot.DefineTool[ReadFileArgs, string](\n\t\t\"read_file\",\n\t\t\"Read the contents of a file at the given path\",\n\t\tfunc(args ReadFileArgs, inv copilot.ToolInvocation) (string, error) {\n\t\t\tvirtualFsMu.Lock()\n\t\t\tcontent, ok := virtualFs[args.Path]\n\t\t\tvirtualFsMu.Unlock()\n\t\t\tif !ok {\n\t\t\t\treturn fmt.Sprintf(\"Error: file not found: %s\", args.Path), nil\n\t\t\t}\n\t\t\treturn content, nil\n\t\t},\n\t)\n\n\tlistFiles := copilot.Tool{\n\t\tName: \"list_files\",\n\t\tDescription: \"List all files in the virtual filesystem\",\n\t\tParameters: map[string]any{\n\t\t\t\"type\": \"object\",\n\t\t\t\"properties\": map[string]any{},\n\t\t},\n\t\tHandler: func(inv copilot.ToolInvocation) (copilot.ToolResult, error) {\n\t\t\tvirtualFsMu.Lock()\n\t\t\tdefer virtualFsMu.Unlock()\n\t\t\tif len(virtualFs) == 0 {\n\t\t\t\treturn copilot.ToolResult{TextResultForLLM: \"No files\"}, nil\n\t\t\t}\n\t\t\tpaths := make([]string, 0, len(virtualFs))\n\t\t\tfor p := range virtualFs {\n\t\t\t\tpaths = append(paths, p)\n\t\t\t}\n\t\t\treturn copilot.ToolResult{TextResultForLLM: strings.Join(paths, \"\\n\")}, nil\n\t\t},\n\t}\n\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t\t// Remove all built-in tools — only our custom virtual FS tools are available\n\t\tAvailableTools: []string{},\n\t\tTools: []copilot.Tool{createFile, readFile, listFiles},\n\t\tOnPermissionRequest: func(req copilot.PermissionRequest, inv copilot.PermissionInvocation) (copilot.PermissionRequestResult, error) {\n\t\t\treturn copilot.PermissionRequestResult{Kind: \"approved\"}, nil\n\t\t},\n\t\tHooks: &copilot.SessionHooks{\n\t\t\tOnPreToolUse: func(input copilot.PreToolUseHookInput, inv copilot.HookInvocation) (*copilot.PreToolUseHookOutput, error) {\n\t\t\t\treturn &copilot.PreToolUseHookOutput{PermissionDecision: \"allow\"}, nil\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"Create a file called plan.md with a brief 3-item project plan \" +\n\t\t\t\"for building a CLI tool. Then read it back and tell me what you wrote.\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n\n\t// Dump the virtual filesystem to prove nothing touched disk\n\tfmt.Println(\"\\n--- Virtual filesystem contents ---\")\n\tfor path, content := range virtualFs {\n\t\tfmt.Printf(\"\\n[%s]\\n\", path)\n\t\tfmt.Println(content)\n\t}\n}\n" }, { "path": "test/scenarios/tools/virtual-filesystem/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient, define_tool\nfrom copilot.client import SubprocessConfig\nfrom pydantic import BaseModel, Field\n\n# In-memory virtual filesystem\nvirtual_fs: dict[str, str] = {}\n\n\nclass CreateFileParams(BaseModel):\n path: str = Field(description=\"File path\")\n content: str = Field(description=\"File content\")\n\n\nclass ReadFileParams(BaseModel):\n path: str = Field(description=\"File path\")\n\n\n@define_tool(description=\"Create or overwrite a file at the given path with the provided content\")\ndef create_file(params: CreateFileParams) -> str:\n virtual_fs[params.path] = params.content\n return f\"Created {params.path} ({len(params.content)} bytes)\"\n\n\n@define_tool(description=\"Read the contents of a file at the given path\")\ndef read_file(params: ReadFileParams) -> str:\n content = virtual_fs.get(params.path)\n if content is None:\n return f\"Error: file not found: {params.path}\"\n return content\n\n\n@define_tool(description=\"List all files in the virtual filesystem\")\ndef list_files() -> str:\n if not virtual_fs:\n return \"No files\"\n return \"\\n\".join(virtual_fs.keys())\n\n\nasync def auto_approve_permission(request, invocation):\n return {\"kind\": \"approved\"}\n\n\nasync def auto_approve_tool(input_data, invocation):\n return {\"permissionDecision\": \"allow\"}\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session(\n on_permission_request=auto_approve_permission,\n model=\"claude-haiku-4.5\",\n available_tools=[],\n tools=[create_file, read_file, list_files],\n hooks={\"on_pre_tool_use\": auto_approve_tool},\n )\n\n response = await session.send_and_wait(\n \"Create a file called plan.md with a brief 3-item project plan \"\n \"for building a CLI tool. Then read it back and tell me what you wrote.\"\n )\n\n if response:\n print(response.data.content)\n\n # Dump the virtual filesystem to prove nothing touched disk\n print(\"\\n--- Virtual filesystem contents ---\")\n for path, content in virtual_fs.items():\n print(f\"\\n[{path}]\")\n print(content)\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/tools/virtual-filesystem/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/tools/virtual-filesystem/typescript/package.json", "content": "{\n \"name\": \"tools-virtual-filesystem-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Config sample — virtual filesystem sandbox with auto-approved permissions\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\",\n \"zod\": \"^4.3.6\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\"\n }\n}\n" }, { "path": "test/scenarios/tools/virtual-filesystem/typescript/src/index.ts", "content": "import { CopilotClient, defineTool } from \"@github/copilot-sdk\";\nimport { z } from \"zod\";\n\n// In-memory virtual filesystem\nconst virtualFs = new Map();\n\nconst createFile = defineTool(\"create_file\", {\n description: \"Create or overwrite a file at the given path with the provided content\",\n parameters: z.object({\n path: z.string().describe(\"File path\"),\n content: z.string().describe(\"File content\"),\n }),\n handler: async (args) => {\n virtualFs.set(args.path, args.content);\n return `Created ${args.path} (${args.content.length} bytes)`;\n },\n});\n\nconst readFile = defineTool(\"read_file\", {\n description: \"Read the contents of a file at the given path\",\n parameters: z.object({\n path: z.string().describe(\"File path\"),\n }),\n handler: async (args) => {\n const content = virtualFs.get(args.path);\n if (content === undefined) return `Error: file not found: ${args.path}`;\n return content;\n },\n});\n\nconst listFiles = defineTool(\"list_files\", {\n description: \"List all files in the virtual filesystem\",\n parameters: z.object({}),\n handler: async () => {\n if (virtualFs.size === 0) return \"No files\";\n return [...virtualFs.keys()].join(\"\\n\");\n },\n});\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && {\n cliPath: process.env.COPILOT_CLI_PATH,\n }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n const session = await client.createSession({\n model: \"claude-haiku-4.5\",\n // Remove all built-in tools — only our custom virtual FS tools are available\n availableTools: [],\n tools: [createFile, readFile, listFiles],\n onPermissionRequest: async () => ({ kind: \"approved\" as const }),\n hooks: {\n onPreToolUse: async () => ({ permissionDecision: \"allow\" as const }),\n },\n });\n\n const response = await session.sendAndWait({\n prompt:\n \"Create a file called plan.md with a brief 3-item project plan for building a CLI tool. \" +\n \"Then read it back and tell me what you wrote.\",\n });\n\n if (response) {\n console.log(response.data.content);\n }\n\n // Dump the virtual filesystem to prove nothing touched disk\n console.log(\"\\n--- Virtual filesystem contents ---\");\n for (const [path, content] of virtualFs) {\n console.log(`\\n[${path}]`);\n console.log(content);\n }\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/tools/virtual-filesystem/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=120\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n\n echo \"$output\"\n\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n if echo \"$output\" | grep -qi \"Virtual filesystem contents\" && echo \"$output\" | grep -qi \"plan\\.md\"; then\n echo \"✅ $name passed (virtual FS operations confirmed)\"\n PASS=$((PASS + 1))\n else\n echo \"❌ $name failed (expected pattern not found)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n elif [ \"$code\" -eq 124 ]; then\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying tools/virtual-filesystem\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o virtual-filesystem-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./virtual-filesystem-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/transport/README.md", "content": "# Transport Samples\n\nMinimal samples organized by **transport model** — the wire protocol used to communicate with `copilot`. Each subfolder demonstrates one transport with the same \"What is the capital of France?\" flow.\n\n## Transport Models\n\n| Transport | Description | Languages |\n|-----------|-------------|-----------|\n| **[stdio](stdio/)** | SDK spawns `copilot` as a child process and communicates via stdin/stdout | TypeScript, Python, Go |\n| **[tcp](tcp/)** | SDK connects to a pre-running `copilot` TCP server | TypeScript, Python, Go |\n| **[wasm](wasm/)** | SDK loads `copilot` as an in-process WASM module | TypeScript |\n\n## How They Differ\n\n| | stdio | tcp | wasm |\n|---|---|---|---|\n| **Process model** | Child process | External server | In-process |\n| **Binary required** | Yes (auto-spawned) | Yes (pre-started) | No (WASM module) |\n| **Wire protocol** | Content-Length framed JSON-RPC over pipes | Content-Length framed JSON-RPC over TCP | In-memory function calls |\n| **Best for** | CLI tools, desktop apps | Shared servers, multi-tenant | Serverless, edge, sandboxed |\n\n## Prerequisites\n\n- **Authentication** — set `GITHUB_TOKEN`, or run `gh auth login`\n- **Copilot CLI** — required for stdio and tcp (set `COPILOT_CLI_PATH`)\n- Language toolchains as needed (Node.js 20+, Python 3.10+, Go 1.24+)\n\n## Verification\n\nEach transport has its own `verify.sh` that builds and runs all language samples:\n\n```bash\ncd stdio && ./verify.sh\ncd tcp && ./verify.sh\ncd wasm && ./verify.sh\n```\n" }, { "path": "test/scenarios/transport/reconnect/README.md", "content": "# TCP Reconnection Sample\n\nTests that a **pre-running** `copilot` TCP server correctly handles **multiple sequential sessions**. The SDK connects, creates a session, exchanges a message, destroys the session, then repeats the process — verifying the server remains responsive across session lifecycles.\n\n```\n┌─────────────┐ TCP (JSON-RPC) ┌──────────────┐\n│ Your App │ ─────────────────▶ │ Copilot CLI │\n│ (SDK) │ ◀───────────────── │ (TCP server) │\n└─────────────┘ └──────────────┘\n Session 1: create → send → disconnect\n Session 2: create → send → disconnect\n```\n\n## What This Tests\n\n- The TCP server accepts a new session after a previous session is destroyed\n- Server state is properly cleaned up between sessions\n- The SDK client can reuse the same connection for multiple session lifecycles\n- No resource leaks or port conflicts across sequential sessions\n\n## Languages\n\n| Directory | SDK / Approach | Language |\n|-----------|---------------|----------|\n| `typescript/` | `@github/copilot-sdk` | TypeScript (Node.js) |\n\n> **TypeScript-only:** This scenario tests SDK-level session lifecycle over TCP. The reconnection behavior is an SDK concern, so only one language is needed to verify it.\n\n## Prerequisites\n\n- **Copilot CLI** — set `COPILOT_CLI_PATH`\n- **Authentication** — set `GITHUB_TOKEN`, or run `gh auth login`\n- **Node.js 20+** (TypeScript sample)\n\n## Quick Start\n\nStart the TCP server:\n\n```bash\ncopilot --port 3000 --headless --auth-token-env GITHUB_TOKEN\n```\n\nRun the sample:\n\n```bash\ncd typescript\nnpm install && npm run build\nCOPILOT_CLI_URL=localhost:3000 npm start\n```\n\n## Verification\n\n```bash\n./verify.sh\n```\n\nRuns in three phases:\n\n1. **Server** — starts `copilot` as a TCP server (auto-detects port)\n2. **Build** — installs dependencies and compiles the TypeScript sample\n3. **E2E Run** — executes the sample with a 120-second timeout, verifies both sessions complete and prints \"Reconnect test passed\"\n\nThe server is automatically stopped when the script exits.\n" }, { "path": "test/scenarios/transport/reconnect/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nvar cliUrl = Environment.GetEnvironmentVariable(\"COPILOT_CLI_URL\") ?? \"localhost:3000\";\n\nusing var client = new CopilotClient(new CopilotClientOptions { CliUrl = cliUrl });\nawait client.StartAsync();\n\ntry\n{\n // First session\n Console.WriteLine(\"--- Session 1 ---\");\n await using var session1 = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n });\n\n var response1 = await session1.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is the capital of France?\",\n });\n\n if (response1?.Data?.Content != null)\n {\n Console.WriteLine(response1.Data.Content);\n }\n else\n {\n Console.Error.WriteLine(\"No response content received for session 1\");\n Environment.Exit(1);\n }\n Console.WriteLine(\"Session 1 disconnected\\n\");\n\n // Second session — tests that the server accepts new sessions\n Console.WriteLine(\"--- Session 2 ---\");\n await using var session2 = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n });\n\n var response2 = await session2.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is the capital of France?\",\n });\n\n if (response2?.Data?.Content != null)\n {\n Console.WriteLine(response2.Data.Content);\n }\n else\n {\n Console.Error.WriteLine(\"No response content received for session 2\");\n Environment.Exit(1);\n }\n Console.WriteLine(\"Session 2 disconnected\");\n\n Console.WriteLine(\"\\nReconnect test passed — both sessions completed successfully\");\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/transport/reconnect/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/transport/reconnect/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/transport/reconnect/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/transport/reconnect/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/transport/reconnect/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tcliUrl := os.Getenv(\"COPILOT_CLI_URL\")\n\tif cliUrl == \"\" {\n\t\tcliUrl = \"localhost:3000\"\n\t}\n\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tCLIUrl: cliUrl,\n\t})\n\n\tctx := context.Background()\n\n\t// Session 1\n\tfmt.Println(\"--- Session 1 ---\")\n\tsession1, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tresponse1, err := session1.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What is the capital of France?\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response1 != nil {\nif d, ok := response1.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n} else {\n\t\tlog.Fatal(\"No response content received for session 1\")\n\t}\n\n\tsession1.Disconnect()\n\tfmt.Println(\"Session 1 disconnected\")\n\tfmt.Println()\n\n\t// Session 2 — tests that the server accepts new sessions\n\tfmt.Println(\"--- Session 2 ---\")\n\tsession2, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tresponse2, err := session2.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What is the capital of France?\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response2 != nil {\nif d, ok := response2.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n} else {\n\t\tlog.Fatal(\"No response content received for session 2\")\n\t}\n\n\tsession2.Disconnect()\n\tfmt.Println(\"Session 2 disconnected\")\n\n\tfmt.Println(\"\\nReconnect test passed — both sessions completed successfully\")\n}\n" }, { "path": "test/scenarios/transport/reconnect/python/main.py", "content": "import asyncio\nimport os\nimport sys\nfrom copilot import CopilotClient\nfrom copilot.client import ExternalServerConfig\n\n\nasync def main():\n client = CopilotClient(ExternalServerConfig(\n url=os.environ.get(\"COPILOT_CLI_URL\", \"localhost:3000\"),\n ))\n\n try:\n # First session\n print(\"--- Session 1 ---\")\n session1 = await client.create_session({\"model\": \"claude-haiku-4.5\"})\n\n response1 = await session1.send_and_wait(\n \"What is the capital of France?\"\n )\n\n if response1 and response1.data.content:\n print(response1.data.content)\n else:\n print(\"No response content received for session 1\", file=sys.stderr)\n sys.exit(1)\n\n await session1.disconnect()\n print(\"Session 1 disconnected\\n\")\n\n # Second session — tests that the server accepts new sessions\n print(\"--- Session 2 ---\")\n session2 = await client.create_session({\"model\": \"claude-haiku-4.5\"})\n\n response2 = await session2.send_and_wait(\n \"What is the capital of France?\"\n )\n\n if response2 and response2.data.content:\n print(response2.data.content)\n else:\n print(\"No response content received for session 2\", file=sys.stderr)\n sys.exit(1)\n\n await session2.disconnect()\n print(\"Session 2 disconnected\")\n\n print(\"\\nReconnect test passed — both sessions completed successfully\")\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/transport/reconnect/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/transport/reconnect/typescript/package.json", "content": "{\n \"name\": \"transport-reconnect-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Transport sample — TCP reconnection and session reuse\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\",\n \"typescript\": \"^5.5.0\"\n }\n}\n" }, { "path": "test/scenarios/transport/reconnect/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const client = new CopilotClient({\n cliUrl: process.env.COPILOT_CLI_URL || \"localhost:3000\",\n });\n\n try {\n // First session\n console.log(\"--- Session 1 ---\");\n const session1 = await client.createSession({ model: \"claude-haiku-4.5\" });\n\n const response1 = await session1.sendAndWait({\n prompt: \"What is the capital of France?\",\n });\n\n if (response1?.data.content) {\n console.log(response1.data.content);\n } else {\n console.error(\"No response content received for session 1\");\n process.exit(1);\n }\n\n await session1.disconnect();\n console.log(\"Session 1 disconnected\\n\");\n\n // Second session — tests that the server accepts new sessions\n console.log(\"--- Session 2 ---\");\n const session2 = await client.createSession({ model: \"claude-haiku-4.5\" });\n\n const response2 = await session2.sendAndWait({\n prompt: \"What is the capital of France?\",\n });\n\n if (response2?.data.content) {\n console.log(response2.data.content);\n } else {\n console.error(\"No response content received for session 2\");\n process.exit(1);\n }\n\n await session2.disconnect();\n console.log(\"Session 2 disconnected\");\n\n console.log(\"\\nReconnect test passed — both sessions completed successfully\");\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/transport/reconnect/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=120\nSERVER_PID=\"\"\nSERVER_PORT_FILE=\"\"\n\ncleanup() {\n if [ -n \"$SERVER_PID\" ] && kill -0 \"$SERVER_PID\" 2>/dev/null; then\n echo \"\"\n echo \"Stopping Copilot CLI server (PID $SERVER_PID)...\"\n kill \"$SERVER_PID\" 2>/dev/null || true\n wait \"$SERVER_PID\" 2>/dev/null || true\n fi\n [ -n \"$SERVER_PORT_FILE\" ] && rm -f \"$SERVER_PORT_FILE\"\n}\ntrap cleanup EXIT\n\n# Resolve Copilot CLI binary: use COPILOT_CLI_PATH env var or find the SDK bundled CLI.\nif [ -z \"${COPILOT_CLI_PATH:-}\" ]; then\n # Try to resolve from the TypeScript sample node_modules\n TS_DIR=\"$SCRIPT_DIR/typescript\"\n if [ -d \"$TS_DIR/node_modules/@github/copilot\" ]; then\n COPILOT_CLI_PATH=\"$(node -e \"console.log(require.resolve('@github/copilot'))\" 2>/dev/null || true)\"\n fi\n # Fallback: check PATH\n if [ -z \"${COPILOT_CLI_PATH:-}\" ]; then\n COPILOT_CLI_PATH=\"$(command -v copilot 2>/dev/null || true)\"\n fi\nfi\nif [ -z \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"❌ Could not find Copilot CLI binary.\"\n echo \" Set COPILOT_CLI_PATH or run: cd typescript && npm install\"\n exit 1\nfi\necho \"Using CLI: $COPILOT_CLI_PATH\"\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n if [ \"$code\" -eq 0 ] && echo \"$output\" | grep -q \"Reconnect test passed\"; then\n echo \"$output\"\n echo \"✅ $name passed (reconnect verified)\"\n PASS=$((PASS + 1))\n elif [ \"$code\" -eq 124 ]; then\n echo \"${output:-(no output)}\"\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"${output:-(empty output)}\"\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Starting Copilot CLI TCP server\"\necho \"══════════════════════════════════════\"\necho \"\"\n\nSERVER_PORT_FILE=$(mktemp)\n\"$COPILOT_CLI_PATH\" --headless --auth-token-env GITHUB_TOKEN > \"$SERVER_PORT_FILE\" 2>&1 &\nSERVER_PID=$!\n\n# Wait for server to announce its port\necho \"Waiting for server to be ready...\"\nPORT=\"\"\nfor i in $(seq 1 30); do\n if ! kill -0 \"$SERVER_PID\" 2>/dev/null; then\n echo \"❌ Server process exited unexpectedly\"\n cat \"$SERVER_PORT_FILE\" 2>/dev/null\n exit 1\n fi\n PORT=$(grep -o 'listening on port [0-9]*' \"$SERVER_PORT_FILE\" 2>/dev/null | grep -o '[0-9]*' || true)\n if [ -n \"$PORT\" ]; then\n break\n fi\n if [ \"$i\" -eq 30 ]; then\n echo \"❌ Server did not announce port within 30 seconds\"\n exit 1\n fi\n sleep 1\ndone\nexport COPILOT_CLI_URL=\"localhost:$PORT\"\necho \"Server is ready on port $PORT (PID $SERVER_PID)\"\necho \"\"\n\necho \"══════════════════════════════════════\"\necho \" Verifying transport/reconnect\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o reconnect-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && CLI_URL=$COPILOT_CLI_URL node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && CLI_URL=$COPILOT_CLI_URL python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && CLI_URL=$COPILOT_CLI_URL ./reconnect-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && COPILOT_CLI_URL=$COPILOT_CLI_URL dotnet run --no-build 2>&1\"\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/transport/stdio/README.md", "content": "# Stdio Transport Samples\n\nSamples demonstrating the **stdio** transport model. The SDK spawns `copilot` as a child process and communicates over standard input/output using Content-Length-framed JSON-RPC 2.0 messages.\n\n```\n┌─────────────┐ stdin/stdout (JSON-RPC) ┌──────────────┐\n│ Your App │ ──────────────────────────▶ │ Copilot CLI │\n│ (SDK) │ ◀────────────────────────── │ (child proc) │\n└─────────────┘ └──────────────┘\n```\n\nEach sample follows the same flow:\n\n1. **Create a client** that spawns `copilot` automatically\n2. **Open a session** targeting the `gpt-4.1` model\n3. **Send a prompt** (\"What is the capital of France?\")\n4. **Print the response** and clean up\n\n## Languages\n\n| Directory | SDK / Approach | Language |\n|-----------|---------------|----------|\n| `typescript/` | `@github/copilot-sdk` | TypeScript (Node.js) |\n| `python/` | `github-copilot-sdk` | Python |\n| `go/` | `github.com/github/copilot-sdk/go` | Go |\n\n## Prerequisites\n\n- **Copilot CLI** — set `COPILOT_CLI_PATH`\n- **Authentication** — set `GITHUB_TOKEN`, or run `gh auth login`\n- **Node.js 20+** (TypeScript sample)\n- **Python 3.10+** (Python sample)\n- **Go 1.24+** (Go sample)\n\n## Quick Start\n\n**TypeScript**\n```bash\ncd typescript\nnpm install && npm run build && npm start\n```\n\n**Python**\n```bash\ncd python\npip install -r requirements.txt\npython main.py\n```\n\n**Go**\n```bash\ncd go\ngo run main.go\n```\n\n## Verification\n\n```bash\n./verify.sh\n```\n\nRuns in two phases:\n\n1. **Build** — installs dependencies and compiles each sample\n2. **E2E Run** — executes each sample with a 60-second timeout and verifies it produces output\n" }, { "path": "test/scenarios/transport/stdio/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliPath = Environment.GetEnvironmentVariable(\"COPILOT_CLI_PATH\"),\n GitHubToken = Environment.GetEnvironmentVariable(\"GITHUB_TOKEN\"),\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is the capital of France?\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/transport/stdio/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/transport/stdio/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/transport/stdio/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/transport/stdio/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/transport/stdio/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\t// Go SDK auto-reads COPILOT_CLI_PATH from env\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tGitHubToken: os.Getenv(\"GITHUB_TOKEN\"),\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What is the capital of France?\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n}\n" }, { "path": "test/scenarios/transport/stdio/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import SubprocessConfig\n\n\nasync def main():\n client = CopilotClient(SubprocessConfig(\n github_token=os.environ.get(\"GITHUB_TOKEN\"),\n cli_path=os.environ.get(\"COPILOT_CLI_PATH\"),\n ))\n\n try:\n session = await client.create_session({\"model\": \"claude-haiku-4.5\"})\n\n response = await session.send_and_wait(\n \"What is the capital of France?\"\n )\n\n if response:\n print(response.data.content)\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/transport/stdio/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/transport/stdio/typescript/package.json", "content": "{\n \"name\": \"transport-stdio-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"Stdio transport sample — spawns Copilot CLI as a child process\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\",\n \"typescript\": \"^5.5.0\"\n }\n}\n" }, { "path": "test/scenarios/transport/stdio/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const client = new CopilotClient({\n ...(process.env.COPILOT_CLI_PATH && { cliPath: process.env.COPILOT_CLI_PATH }),\n githubToken: process.env.GITHUB_TOKEN,\n });\n\n try {\n const session = await client.createSession({ model: \"claude-haiku-4.5\" });\n\n const response = await session.sendAndWait({\n prompt: \"What is the capital of France?\",\n });\n\n if (response) {\n console.log(response.data.content);\n }\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/transport/stdio/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\n\n# COPILOT_CLI_PATH is optional — the SDK discovers the bundled CLI automatically.\n# Set it only to override with a custom binary path.\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nfi\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\necho \"\"\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ] && echo \"$output\" | grep -qi \"Paris\\|capital\\|France\\|response\"; then\n echo \"$output\"\n echo \"✅ $name passed (content validated)\"\n PASS=$((PASS + 1))\n elif [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n echo \"$output\"\n echo \"❌ $name failed (no meaningful content in response)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (no content match)\"\n elif [ \"$code\" -eq 124 ]; then\n echo \"${output:-(no output)}\"\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"${output:-(empty output)}\"\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Verifying stdio transport samples\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o stdio-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./stdio-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/transport/tcp/README.md", "content": "# TCP Transport Samples\n\nSamples demonstrating the **TCP** transport model. The SDK connects to a **pre-running** `copilot` TCP server using Content-Length-framed JSON-RPC 2.0 messages over a TCP socket.\n\n```\n┌─────────────┐ TCP (JSON-RPC) ┌──────────────┐\n│ Your App │ ─────────────────▶ │ Copilot CLI │\n│ (SDK) │ ◀───────────────── │ (TCP server) │\n└─────────────┘ └──────────────┘\n```\n\nEach sample follows the same flow:\n\n1. **Connect** to a running `copilot` server via TCP\n2. **Open a session** targeting the `gpt-4.1` model\n3. **Send a prompt** (\"What is the capital of France?\")\n4. **Print the response** and clean up\n\n## Languages\n\n| Directory | SDK / Approach | Language |\n|-----------|---------------|----------|\n| `typescript/` | `@github/copilot-sdk` | TypeScript (Node.js) |\n| `python/` | `github-copilot-sdk` | Python |\n| `go/` | `github.com/github/copilot-sdk/go` | Go |\n\n## Prerequisites\n\n- **Copilot CLI** — set `COPILOT_CLI_PATH`\n- **Authentication** — set `GITHUB_TOKEN`, or run `gh auth login`\n- **Node.js 20+** (TypeScript sample)\n- **Python 3.10+** (Python sample)\n- **Go 1.24+** (Go sample)\n\n## Starting the Server\n\nStart `copilot` as a TCP server before running any sample:\n\n```bash\ncopilot --port 3000 --headless --auth-token-env GITHUB_TOKEN\n```\n\n## Quick Start\n\n**TypeScript**\n```bash\ncd typescript\nnpm install && npm run build && npm start\n```\n\n**Python**\n```bash\ncd python\npip install -r requirements.txt\npython main.py\n```\n\n**Go**\n```bash\ncd go\ngo run main.go\n```\n\nAll samples default to `localhost:3000`. Override with the `COPILOT_CLI_URL` environment variable:\n\n```bash\nCOPILOT_CLI_URL=localhost:8080 npm start\n```\n\n## Verification\n\n```bash\n./verify.sh\n```\n\nRuns in three phases:\n\n1. **Server** — starts `copilot` as a TCP server (auto-detects port)\n2. **Build** — installs dependencies and compiles each sample\n3. **E2E Run** — executes each sample with a 60-second timeout and verifies it produces output\n\nThe server is automatically stopped when the script exits.\n" }, { "path": "test/scenarios/transport/tcp/csharp/Program.cs", "content": "using GitHub.Copilot.SDK;\n\nvar cliUrl = Environment.GetEnvironmentVariable(\"COPILOT_CLI_URL\") ?? \"localhost:3000\";\n\nusing var client = new CopilotClient(new CopilotClientOptions\n{\n CliUrl = cliUrl,\n});\n\nawait client.StartAsync();\n\ntry\n{\n await using var session = await client.CreateSessionAsync(new SessionConfig\n {\n Model = \"claude-haiku-4.5\",\n });\n\n var response = await session.SendAndWaitAsync(new MessageOptions\n {\n Prompt = \"What is the capital of France?\",\n });\n\n if (response != null)\n {\n Console.WriteLine(response.Data?.Content);\n }\n else\n {\n Console.WriteLine(\"(no response)\");\n }\n}\nfinally\n{\n await client.StopAsync();\n}\n" }, { "path": "test/scenarios/transport/tcp/csharp/csharp.csproj", "content": "\n \n Exe\n net8.0\n LatestMajor\n enable\n enable\n true\n \n \n \n \n\n" }, { "path": "test/scenarios/transport/tcp/go/go.mod", "content": "module github.com/github/copilot-sdk/samples/transport/tcp/go\n\ngo 1.24\n\nrequire github.com/github/copilot-sdk/go v0.0.0\n\nrequire (\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-logr/stdr v1.2.2 // indirect\n\tgithub.com/google/jsonschema-go v0.4.2 // indirect\n\tgithub.com/google/uuid v1.6.0 // indirect\n\tgo.opentelemetry.io/auto/sdk v1.1.0 // indirect\n\tgo.opentelemetry.io/otel v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/metric v1.35.0 // indirect\n\tgo.opentelemetry.io/otel/trace v1.35.0 // indirect\n)\n\nreplace github.com/github/copilot-sdk/go => ../../../../../go\n" }, { "path": "test/scenarios/transport/tcp/go/go.sum", "content": "github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=\ngithub.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/jsonschema-go v0.4.2 h1:tmrUohrwoLZZS/P3x7ex0WAVknEkBZM46iALbcqoRA8=\ngithub.com/google/jsonschema-go v0.4.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=\ngithub.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=\ngo.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=\ngo.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=\ngo.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=\ngo.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=\ngo.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=\ngo.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=\ngo.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=\ngo.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n" }, { "path": "test/scenarios/transport/tcp/go/main.go", "content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\tcopilot \"github.com/github/copilot-sdk/go\"\n)\n\nfunc main() {\n\tcliUrl := os.Getenv(\"COPILOT_CLI_URL\")\n\tif cliUrl == \"\" {\n\t\tcliUrl = \"localhost:3000\"\n\t}\n\n\tclient := copilot.NewClient(&copilot.ClientOptions{\n\t\tCLIUrl: cliUrl,\n\t})\n\n\tctx := context.Background()\n\tif err := client.Start(ctx); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer client.Stop()\n\n\tsession, err := client.CreateSession(ctx, &copilot.SessionConfig{\n\t\tModel: \"claude-haiku-4.5\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer session.Disconnect()\n\n\tresponse, err := session.SendAndWait(ctx, copilot.MessageOptions{\n\t\tPrompt: \"What is the capital of France?\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tif response != nil {\nif d, ok := response.Data.(*copilot.AssistantMessageData); ok {\nfmt.Println(d.Content)\n}\n}\n}\n" }, { "path": "test/scenarios/transport/tcp/python/main.py", "content": "import asyncio\nimport os\nfrom copilot import CopilotClient\nfrom copilot.client import ExternalServerConfig\n\n\nasync def main():\n client = CopilotClient(ExternalServerConfig(\n url=os.environ.get(\"COPILOT_CLI_URL\", \"localhost:3000\"),\n ))\n\n try:\n session = await client.create_session({\"model\": \"claude-haiku-4.5\"})\n\n response = await session.send_and_wait(\n \"What is the capital of France?\"\n )\n\n if response:\n print(response.data.content)\n\n await session.disconnect()\n finally:\n await client.stop()\n\n\nasyncio.run(main())\n" }, { "path": "test/scenarios/transport/tcp/python/requirements.txt", "content": "-e ../../../../../python\n" }, { "path": "test/scenarios/transport/tcp/typescript/package.json", "content": "{\n \"name\": \"transport-tcp-typescript\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"description\": \"TCP transport sample — connects to a running Copilot CLI TCP server\",\n \"type\": \"module\",\n \"scripts\": {\n \"build\": \"esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js=\\\"import { createRequire } from 'module'; const require = createRequire(import.meta.url);\\\"\",\n \"start\": \"node dist/index.js\"\n },\n \"dependencies\": {\n \"@github/copilot-sdk\": \"file:../../../../../nodejs\"\n },\n \"devDependencies\": {\n \"@types/node\": \"^20.0.0\",\n \"esbuild\": \"^0.24.0\",\n \"typescript\": \"^5.5.0\"\n }\n}\n" }, { "path": "test/scenarios/transport/tcp/typescript/src/index.ts", "content": "import { CopilotClient } from \"@github/copilot-sdk\";\n\nasync function main() {\n const client = new CopilotClient({\n cliUrl: process.env.COPILOT_CLI_URL || \"localhost:3000\",\n });\n\n try {\n const session = await client.createSession({ model: \"claude-haiku-4.5\" });\n\n const response = await session.sendAndWait({\n prompt: \"What is the capital of France?\",\n });\n\n if (response?.data.content) {\n console.log(response.data.content);\n } else {\n console.error(\"No response content received\");\n process.exit(1);\n }\n\n await session.disconnect();\n } finally {\n await client.stop();\n }\n}\n\nmain().catch((err) => {\n console.error(err);\n process.exit(1);\n});\n" }, { "path": "test/scenarios/transport/tcp/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../../..\" && pwd)\"\nPASS=0\nFAIL=0\nERRORS=\"\"\nTIMEOUT=60\nSERVER_PID=\"\"\nSERVER_PORT_FILE=\"\"\n\ncleanup() {\n if [ -n \"$SERVER_PID\" ] && kill -0 \"$SERVER_PID\" 2>/dev/null; then\n echo \"\"\n echo \"Stopping Copilot CLI server (PID $SERVER_PID)...\"\n kill \"$SERVER_PID\" 2>/dev/null || true\n wait \"$SERVER_PID\" 2>/dev/null || true\n fi\n [ -n \"$SERVER_PORT_FILE\" ] && rm -f \"$SERVER_PORT_FILE\"\n}\ntrap cleanup EXIT\n\n# Resolve Copilot CLI binary: use COPILOT_CLI_PATH env var or find the SDK bundled CLI.\nif [ -z \"${COPILOT_CLI_PATH:-}\" ]; then\n # Try to resolve from the TypeScript sample node_modules\n TS_DIR=\"$SCRIPT_DIR/typescript\"\n if [ -d \"$TS_DIR/node_modules/@github/copilot\" ]; then\n COPILOT_CLI_PATH=\"$(node -e \"console.log(require.resolve('@github/copilot'))\" 2>/dev/null || true)\"\n fi\n # Fallback: check PATH\n if [ -z \"${COPILOT_CLI_PATH:-}\" ]; then\n COPILOT_CLI_PATH=\"$(command -v copilot 2>/dev/null || true)\"\n fi\nfi\nif [ -z \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"❌ Could not find Copilot CLI binary.\"\n echo \" Set COPILOT_CLI_PATH or run: cd typescript && npm install\"\n exit 1\nfi\necho \"Using CLI: $COPILOT_CLI_PATH\"\n\n# Ensure GITHUB_TOKEN is set for auth\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set and gh auth not available. E2E runs will fail.\"\nfi\n\n# Use gtimeout on macOS, timeout on Linux\nif command -v gtimeout &>/dev/null; then\n TIMEOUT_CMD=\"gtimeout\"\nelif command -v timeout &>/dev/null; then\n TIMEOUT_CMD=\"timeout\"\nelse\n echo \"⚠️ No timeout command found. Install coreutils (brew install coreutils).\"\n echo \" Running without timeouts.\"\n TIMEOUT_CMD=\"\"\nfi\n\ncheck() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n if output=$(\"$@\" 2>&1); then\n echo \"$output\"\n echo \"✅ $name passed\"\n PASS=$((PASS + 1))\n else\n echo \"$output\"\n echo \"❌ $name failed\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\nrun_with_timeout() {\n local name=\"$1\"\n shift\n printf \"━━━ %s ━━━\\n\" \"$name\"\n local output=\"\"\n local code=0\n if [ -n \"$TIMEOUT_CMD\" ]; then\n output=$($TIMEOUT_CMD \"$TIMEOUT\" \"$@\" 2>&1) && code=0 || code=$?\n else\n output=$(\"$@\" 2>&1) && code=0 || code=$?\n fi\n if [ \"$code\" -eq 0 ] && [ -n \"$output\" ] && echo \"$output\" | grep -qi \"Paris\\|capital\\|France\\|response\"; then\n echo \"$output\"\n echo \"✅ $name passed (content validated)\"\n PASS=$((PASS + 1))\n elif [ \"$code\" -eq 0 ] && [ -n \"$output\" ]; then\n echo \"$output\"\n echo \"❌ $name failed (no meaningful content in response)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (no content match)\"\n elif [ \"$code\" -eq 124 ]; then\n echo \"${output:-(no output)}\"\n echo \"❌ $name failed (timed out after ${TIMEOUT}s)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name (timeout)\"\n else\n echo \"${output:-(empty output)}\"\n echo \"❌ $name failed (exit code $code)\"\n FAIL=$((FAIL + 1))\n ERRORS=\"$ERRORS\\n - $name\"\n fi\n echo \"\"\n}\n\necho \"══════════════════════════════════════\"\necho \" Starting Copilot CLI TCP server\"\necho \"══════════════════════════════════════\"\necho \"\"\n\nSERVER_PORT_FILE=$(mktemp)\n\"$COPILOT_CLI_PATH\" --headless --auth-token-env GITHUB_TOKEN > \"$SERVER_PORT_FILE\" 2>&1 &\nSERVER_PID=$!\n\n# Wait for server to announce its port\necho \"Waiting for server to be ready...\"\nPORT=\"\"\nfor i in $(seq 1 30); do\n if ! kill -0 \"$SERVER_PID\" 2>/dev/null; then\n echo \"❌ Server process exited unexpectedly\"\n cat \"$SERVER_PORT_FILE\" 2>/dev/null\n exit 1\n fi\n PORT=$(grep -o 'listening on port [0-9]*' \"$SERVER_PORT_FILE\" 2>/dev/null | grep -o '[0-9]*' || true)\n if [ -n \"$PORT\" ]; then\n break\n fi\n if [ \"$i\" -eq 30 ]; then\n echo \"❌ Server did not announce port within 30 seconds\"\n exit 1\n fi\n sleep 1\ndone\nexport COPILOT_CLI_URL=\"localhost:$PORT\"\necho \"Server is ready on port $PORT (PID $SERVER_PID)\"\necho \"\"\n\necho \"══════════════════════════════════════\"\necho \" Verifying TCP transport samples\"\necho \" Phase 1: Build\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: install + compile\ncheck \"TypeScript (install)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm install --ignore-scripts 2>&1\"\ncheck \"TypeScript (build)\" bash -c \"cd '$SCRIPT_DIR/typescript' && npm run build 2>&1\"\n\n# Python: install + syntax\ncheck \"Python (install)\" bash -c \"python3 -c 'import copilot' 2>/dev/null || (cd '$SCRIPT_DIR/python' && pip3 install -r requirements.txt --quiet 2>&1)\"\ncheck \"Python (syntax)\" bash -c \"python3 -c \\\"import ast; ast.parse(open('$SCRIPT_DIR/python/main.py').read()); print('Syntax OK')\\\"\"\n\n# Go: build\ncheck \"Go (build)\" bash -c \"cd '$SCRIPT_DIR/go' && go build -o tcp-go . 2>&1\"\n\n# C#: build\ncheck \"C# (build)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet build --nologo -v q 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Phase 2: E2E Run (timeout ${TIMEOUT}s each)\"\necho \"══════════════════════════════════════\"\necho \"\"\n\n# TypeScript: run\nrun_with_timeout \"TypeScript (run)\" bash -c \"cd '$SCRIPT_DIR/typescript' && node dist/index.js\"\n\n# Python: run\nrun_with_timeout \"Python (run)\" bash -c \"cd '$SCRIPT_DIR/python' && python3 main.py\"\n\n# Go: run\nrun_with_timeout \"Go (run)\" bash -c \"cd '$SCRIPT_DIR/go' && ./tcp-go\"\n\n# C#: run\nrun_with_timeout \"C# (run)\" bash -c \"cd '$SCRIPT_DIR/csharp' && dotnet run --no-build 2>&1\"\n\n\necho \"══════════════════════════════════════\"\necho \" Results: $PASS passed, $FAIL failed\"\necho \"══════════════════════════════════════\"\nif [ \"$FAIL\" -gt 0 ]; then\n echo -e \"Failures:$ERRORS\"\n exit 1\nfi\n" }, { "path": "test/scenarios/verify.sh", "content": "#!/usr/bin/env bash\nset -euo pipefail\n\nSCRIPT_DIR=\"$(cd \"$(dirname \"$0\")\" && pwd)\"\nROOT_DIR=\"$(cd \"$SCRIPT_DIR/../..\" && pwd)\"\nTMP_DIR=\"$(mktemp -d)\"\nMAX_PARALLEL=\"${SCENARIO_PARALLEL:-6}\"\n\ncleanup() { rm -rf \"$TMP_DIR\"; }\ntrap cleanup EXIT\n\n# ── CLI path (optional) ──────────────────────────────────────────────\nif [ -n \"${COPILOT_CLI_PATH:-}\" ]; then\n echo \"Using CLI override: $COPILOT_CLI_PATH\"\nelse\n echo \"No COPILOT_CLI_PATH set — SDKs will use their bundled CLI.\"\nfi\n\n# ── Auth ────────────────────────────────────────────────────────────\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n if command -v gh &>/dev/null; then\n export GITHUB_TOKEN=$(gh auth token 2>/dev/null || true)\n fi\nfi\nif [ -z \"${GITHUB_TOKEN:-}\" ]; then\n echo \"⚠️ GITHUB_TOKEN not set\"\nfi\n\n# ── Pre-install shared dependencies ────────────────────────────────\n# Install Python SDK once to avoid parallel pip install races\nif command -v pip3 &>/dev/null; then\n pip3 install -e \"$ROOT_DIR/python\" --quiet 2>/dev/null || true\nfi\n\n# ── Discover verify scripts ────────────────────────────────────────\nVERIFY_SCRIPTS=()\nwhile IFS= read -r script; do\n VERIFY_SCRIPTS+=(\"$script\")\ndone < <(find \"$SCRIPT_DIR\" -mindepth 3 -maxdepth 3 -name verify.sh -type f | sort)\n\nTOTAL=${#VERIFY_SCRIPTS[@]}\n\n# ── SDK icon helpers ────────────────────────────────────────────────\nsdk_icons() {\n local log=\"$1\"\n local ts py go cs\n ts=\"$(sdk_status \"$log\" \"TypeScript\")\"\n py=\"$(sdk_status \"$log\" \"Python\")\"\n go=\"$(sdk_status \"$log\" \"Go \")\"\n cs=\"$(sdk_status \"$log\" \"C#\")\"\n printf \"TS %s PY %s GO %s C# %s\" \"$ts\" \"$py\" \"$go\" \"$cs\"\n}\n\nsdk_status() {\n local log=\"$1\" sdk=\"$2\"\n if ! grep -q \"$sdk\" \"$log\" 2>/dev/null; then\n printf \"·\"; return\n fi\n if grep \"$sdk\" \"$log\" | grep -q \"❌\"; then\n printf \"✗\"; return\n fi\n if grep \"$sdk\" \"$log\" | grep -q \"⏭\\|SKIP\"; then\n printf \"⊘\"; return\n fi\n printf \"✓\"\n}\n\n# ── Display helpers ─────────────────────────────────────────────────\nBOLD=\"\\033[1m\"\nDIM=\"\\033[2m\"\nRESET=\"\\033[0m\"\nRED=\"\\033[31m\"\nGREEN=\"\\033[32m\"\nYELLOW=\"\\033[33m\"\nCYAN=\"\\033[36m\"\nCLR_LINE=\"\\033[2K\"\n\nBAR_WIDTH=20\n\nprogress_bar() {\n local done_count=\"$1\" total=\"$2\"\n local filled=$(( done_count * BAR_WIDTH / total ))\n local empty=$(( BAR_WIDTH - filled ))\n printf \"${DIM}[\"\n [ \"$filled\" -gt 0 ] && printf \"%0.s█\" $(seq 1 \"$filled\")\n [ \"$empty\" -gt 0 ] && printf \"%0.s░\" $(seq 1 \"$empty\")\n printf \"]${RESET}\"\n}\n\ndeclare -a SCENARIO_NAMES=()\ndeclare -a SCENARIO_STATES=() # waiting | running | done\ndeclare -a SCENARIO_RESULTS=() # \"\" | PASS | FAIL | SKIP\ndeclare -a SCENARIO_PIDS=()\ndeclare -a SCENARIO_ICONS=()\n\nfor script in \"${VERIFY_SCRIPTS[@]}\"; do\n rel=\"${script#\"$SCRIPT_DIR\"/}\"\n name=\"${rel%/verify.sh}\"\n SCENARIO_NAMES+=(\"$name\")\n SCENARIO_STATES+=(\"waiting\")\n SCENARIO_RESULTS+=(\"\")\n SCENARIO_PIDS+=(\"\")\n SCENARIO_ICONS+=(\"\")\ndone\n\n# ── Execution ───────────────────────────────────────────────────────\nRUNNING_COUNT=0\nNEXT_IDX=0\nPASSED=0; FAILED=0; SKIPPED=0\nDONE_COUNT=0\n\n# The progress line is the ONE line we update in-place via \\r.\n# When a scenario completes, we print its result as a permanent line\n# above the progress line.\nCOLS=\"${COLUMNS:-$(tput cols 2>/dev/null || echo 80)}\"\n\nprint_progress() {\n local running_names=\"\"\n for i in \"${!SCENARIO_STATES[@]}\"; do\n if [ \"${SCENARIO_STATES[$i]}\" = \"running\" ]; then\n [ -n \"$running_names\" ] && running_names=\"$running_names, \"\n running_names=\"$running_names${SCENARIO_NAMES[$i]}\"\n fi\n done\n # Build the prefix: \" 3/33 [████░░░░░░░░░░░░░░░░] \"\n local prefix\n prefix=$(printf \" %d/%d \" \"$DONE_COUNT\" \"$TOTAL\")\n local prefix_len=$(( ${#prefix} + BAR_WIDTH + 4 )) # +4 for []+ spaces\n # Truncate running names to fit in one terminal line\n local max_names=$(( COLS - prefix_len - 1 ))\n if [ \"${#running_names}\" -gt \"$max_names\" ] && [ \"$max_names\" -gt 3 ]; then\n running_names=\"${running_names:0:$((max_names - 1))}…\"\n fi\n printf \"\\r${CLR_LINE}\"\n printf \"%s\" \"$prefix\"\n progress_bar \"$DONE_COUNT\" \"$TOTAL\"\n printf \" ${CYAN}%s${RESET}\" \"$running_names\"\n}\n\nprint_result() {\n local i=\"$1\"\n local name=\"${SCENARIO_NAMES[$i]}\"\n local result=\"${SCENARIO_RESULTS[$i]}\"\n local icons=\"${SCENARIO_ICONS[$i]}\"\n\n # Clear the progress line, print result, then reprint progress below\n printf \"\\r${CLR_LINE}\"\n case \"$result\" in\n PASS) printf \" ${GREEN}✅${RESET} %-36s %s\\n\" \"$name\" \"$icons\" ;;\n FAIL) printf \" ${RED}❌${RESET} %-36s %s\\n\" \"$name\" \"$icons\" ;;\n SKIP) printf \" ${YELLOW}⏭${RESET} %-36s %s\\n\" \"$name\" \"$icons\" ;;\n esac\n}\n\nstart_scenario() {\n local i=\"$1\"\n local script=\"${VERIFY_SCRIPTS[$i]}\"\n local name=\"${SCENARIO_NAMES[$i]}\"\n local log_file=\"$TMP_DIR/${name//\\//__}.log\"\n\n bash \"$script\" >\"$log_file\" 2>&1 &\n SCENARIO_PIDS[$i]=$!\n SCENARIO_STATES[$i]=\"running\"\n RUNNING_COUNT=$((RUNNING_COUNT + 1))\n}\n\nfinish_scenario() {\n local i=\"$1\" exit_code=\"$2\"\n local name=\"${SCENARIO_NAMES[$i]}\"\n local log_file=\"$TMP_DIR/${name//\\//__}.log\"\n\n SCENARIO_STATES[$i]=\"done\"\n RUNNING_COUNT=$((RUNNING_COUNT - 1))\n DONE_COUNT=$((DONE_COUNT + 1))\n\n if grep -q \"^SKIP:\" \"$log_file\" 2>/dev/null; then\n SCENARIO_RESULTS[$i]=\"SKIP\"\n SKIPPED=$((SKIPPED + 1))\n elif [ \"$exit_code\" -eq 0 ]; then\n SCENARIO_RESULTS[$i]=\"PASS\"\n PASSED=$((PASSED + 1))\n else\n SCENARIO_RESULTS[$i]=\"FAIL\"\n FAILED=$((FAILED + 1))\n fi\n\n SCENARIO_ICONS[$i]=\"$(sdk_icons \"$log_file\")\"\n print_result \"$i\"\n}\n\necho \"\"\n\n# Launch initial batch\nwhile [ \"$NEXT_IDX\" -lt \"$TOTAL\" ] && [ \"$RUNNING_COUNT\" -lt \"$MAX_PARALLEL\" ]; do\n start_scenario \"$NEXT_IDX\"\n NEXT_IDX=$((NEXT_IDX + 1))\ndone\nprint_progress\n\n# Poll for completion and launch new scenarios\nwhile [ \"$RUNNING_COUNT\" -gt 0 ]; do\n for i in \"${!SCENARIO_STATES[@]}\"; do\n if [ \"${SCENARIO_STATES[$i]}\" = \"running\" ]; then\n pid=\"${SCENARIO_PIDS[$i]}\"\n if ! kill -0 \"$pid\" 2>/dev/null; then\n wait \"$pid\" 2>/dev/null && exit_code=0 || exit_code=$?\n finish_scenario \"$i\" \"$exit_code\"\n\n # Launch next if available\n if [ \"$NEXT_IDX\" -lt \"$TOTAL\" ] && [ \"$RUNNING_COUNT\" -lt \"$MAX_PARALLEL\" ]; then\n start_scenario \"$NEXT_IDX\"\n NEXT_IDX=$((NEXT_IDX + 1))\n fi\n\n print_progress\n fi\n fi\n done\n sleep 0.2\ndone\n\n# Clear the progress line\nprintf \"\\r${CLR_LINE}\"\necho \"\"\n\n# ── Final summary ──────────────────────────────────────────────────\nprintf \" ${BOLD}%d${RESET} scenarios\" \"$TOTAL\"\n[ \"$PASSED\" -gt 0 ] && printf \" ${GREEN}${BOLD}%d passed${RESET}\" \"$PASSED\"\n[ \"$FAILED\" -gt 0 ] && printf \" ${RED}${BOLD}%d failed${RESET}\" \"$FAILED\"\n[ \"$SKIPPED\" -gt 0 ] && printf \" ${YELLOW}${BOLD}%d skipped${RESET}\" \"$SKIPPED\"\necho \"\"\n\n# ── Failed scenario logs ───────────────────────────────────────────\nif [ \"$FAILED\" -gt 0 ]; then\n echo \"\"\n printf \"${BOLD}══════════════════════════════════════════════════════════════════════════${RESET}\\n\"\n printf \"${RED}${BOLD} Failed Scenario Logs${RESET}\\n\"\n printf \"${BOLD}══════════════════════════════════════════════════════════════════════════${RESET}\\n\"\n for i in \"${!SCENARIO_NAMES[@]}\"; do\n if [ \"${SCENARIO_RESULTS[$i]}\" = \"FAIL\" ]; then\n local_name=\"${SCENARIO_NAMES[$i]}\"\n local_log=\"$TMP_DIR/${local_name//\\//__}.log\"\n echo \"\"\n printf \"${RED}━━━ %s ━━━${RESET}\\n\" \"$local_name\"\n printf \" %s\\n\" \"${SCENARIO_ICONS[$i]}\"\n echo \"\"\n tail -30 \"$local_log\" | sed 's/^/ /'\n fi\n done\n exit 1\nfi\n" }, { "path": "test/snapshots/agent_and_compact_rpc/should_compact_session_history_after_messages.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 2+2?\n - role: assistant\n content: 2 + 2 = 4\n - role: user\n content: ${compaction_prompt}\n - role: assistant\n content: >-\n \n\n The user asked a simple arithmetic question: \"What is 2+2?\". I provided the answer (4). No technical work,\n code changes, or file modifications were involved. This was a brief, standalone interaction with no ongoing\n tasks or development work.\n\n \n\n\n \n\n 1. The user asked \"What is 2+2?\"\n - I responded with the answer: 4\n - No further questions or requests followed\n \n\n\n \n\n No files were created, modified, or deleted. No code changes were made. This was a conversational response to\n a basic arithmetic question with no technical implementation.\n\n \n\n\n \n\n No technical work was performed. The conversation consisted solely of a simple math question and answer.\n\n \n\n\n \n\n No files were involved in this conversation.\n\n \n\n\n \n\n No pending work or next steps. The user's question was answered completely.\n\n \n\n\n Answered arithmetic question\n" }, { "path": "test/snapshots/ask-user/should_handle_freeform_user_input_response.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Ask me a question using ask_user and then include my answer in your response. The question should be 'What is\n your favorite color?'\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: ask_user\n arguments: '{\"question\":\"What is your favorite color?\",\"allow_freeform\":true}'\n - role: tool\n tool_call_id: toolcall_0\n content: \"User responded: This is my custom freeform answer that was not in the choices\"\n - role: assistant\n content: 'You answered: \"This is my custom freeform answer that was not in the choices\"'\n" }, { "path": "test/snapshots/ask-user/should_invoke_user_input_handler_when_model_uses_ask_user_tool.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Ask me to choose between 'Option A' and 'Option B' using the ask_user tool. Wait for my response before\n continuing.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: ask_user\n arguments: '{\"question\":\"Please choose one of the following options:\",\"choices\":[\"Option A\",\"Option B\"]}'\n - role: tool\n tool_call_id: toolcall_0\n content: \"User selected: Option A\"\n - role: assistant\n content: You selected **Option A**. How would you like to proceed?\n" }, { "path": "test/snapshots/ask-user/should_receive_choices_in_user_input_request.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: \"Use the ask_user tool to ask me to pick between exactly two options: 'Red' and 'Blue'. These should be\n provided as choices. Wait for my answer.\"\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: ask_user\n arguments: '{\"question\":\"Please pick one of the following options:\",\"choices\":[\"Red\",\"Blue\"],\"allow_freeform\":false}'\n - role: tool\n tool_call_id: toolcall_0\n content: \"User selected: Red\"\n - role: assistant\n content: You selected **Red**.\n" }, { "path": "test/snapshots/ask_user/handle_freeform_user_input_response.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Ask me a question using ask_user and then include my answer in your response. The question should be 'What is\n your favorite color?'\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: ask_user\n arguments: '{\"question\":\"What is your favorite color?\",\"allow_freeform\":true}'\n - role: tool\n tool_call_id: toolcall_0\n content: \"User responded: This is my custom freeform answer that was not in the choices\"\n - role: assistant\n content: 'You answered: \"This is my custom freeform answer that was not in the choices\"'\n" }, { "path": "test/snapshots/ask_user/invoke_user_input_handler_when_model_uses_ask_user_tool.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Ask me to choose between 'Option A' and 'Option B' using the ask_user tool. Wait for my response before\n continuing.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: ask_user\n arguments: '{\"question\":\"Please choose between the following options:\",\"choices\":[\"Option A\",\"Option B\"]}'\n - role: tool\n tool_call_id: toolcall_0\n content: \"User selected: Option A\"\n - role: assistant\n content: You selected **Option A**. How would you like to proceed?\n" }, { "path": "test/snapshots/ask_user/receive_choices_in_user_input_request.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: \"Use the ask_user tool to ask me to pick between exactly two options: 'Red' and 'Blue'. These should be\n provided as choices. Wait for my answer.\"\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: ask_user\n arguments: '{\"question\":\"Please pick one of the following options:\",\"choices\":[\"Red\",\"Blue\"],\"allow_freeform\":false}'\n - role: tool\n tool_call_id: toolcall_0\n content: \"User selected: Red\"\n - role: assistant\n content: You selected **Red**.\n" }, { "path": "test/snapshots/ask_user/should_handle_freeform_user_input_response.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Ask me a question using ask_user and then include my answer in your response. The question should be 'What is\n your favorite color?'\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: ask_user\n arguments: '{\"question\":\"What is your favorite color?\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: \"User responded: This is my custom freeform answer that was not in the choices\"\n - role: assistant\n content: 'You answered: \"This is my custom freeform answer that was not in the choices\"'\n" }, { "path": "test/snapshots/ask_user/should_invoke_user_input_handler_when_model_uses_ask_user_tool.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Ask me to choose between 'Option A' and 'Option B' using the ask_user tool. Wait for my response before\n continuing.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: ask_user\n arguments: '{\"question\":\"Please choose between the following options:\",\"choices\":[\"Option A\",\"Option B\"]}'\n - role: tool\n tool_call_id: toolcall_0\n content: \"User selected: Option A\"\n - role: assistant\n content: You selected **Option A**. What would you like me to do next?\n" }, { "path": "test/snapshots/ask_user/should_receive_choices_in_user_input_request.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: \"Use the ask_user tool to ask me to pick between exactly two options: 'Red' and 'Blue'. These should be\n provided as choices. Wait for my answer.\"\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: ask_user\n arguments: '{\"question\":\"Please pick one of the following options:\",\"choices\":[\"Red\",\"Blue\"],\"allow_freeform\":false}'\n - role: tool\n tool_call_id: toolcall_0\n content: \"User selected: Red\"\n - role: assistant\n content: You selected **Red**.\n" }, { "path": "test/snapshots/askuser/should_handle_freeform_user_input_response.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Ask me a question using ask_user and then include my answer in your response. The question should be 'What is\n your favorite color?'\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: ask_user\n arguments: '{\"question\":\"What is your favorite color?\",\"allow_freeform\":true}'\n - role: tool\n tool_call_id: toolcall_0\n content: \"User responded: This is my custom freeform answer that was not in the choices\"\n - role: assistant\n content: 'You answered: \"This is my custom freeform answer that was not in the choices\"'\n" }, { "path": "test/snapshots/askuser/should_invoke_user_input_handler_when_model_uses_ask_user_tool.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Ask me to choose between 'Option A' and 'Option B' using the ask_user tool. Wait for my response before\n continuing.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: ask_user\n arguments: '{\"question\":\"Please choose between the following options:\",\"choices\":[\"Option A\",\"Option B\"]}'\n - role: tool\n tool_call_id: toolcall_0\n content: \"User selected: Option A\"\n - role: assistant\n content: You selected **Option A**. How would you like to proceed?\n" }, { "path": "test/snapshots/askuser/should_receive_choices_in_user_input_request.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: \"Use the ask_user tool to ask me to pick between exactly two options: 'Red' and 'Blue'. These should be\n provided as choices. Wait for my answer.\"\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: ask_user\n arguments: '{\"question\":\"Please pick one of the following options:\",\"choices\":[\"Red\",\"Blue\"],\"allow_freeform\":false}'\n - role: tool\n tool_call_id: toolcall_0\n content: \"User selected: Red\"\n - role: assistant\n content: You selected **Red**.\n" }, { "path": "test/snapshots/builtin_tools/should_capture_exit_code_in_output.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'echo hello && echo world'. Tell me the exact output.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running echo commands\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"echo hello && echo world\",\"description\":\"Run echo hello && echo world\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'echo hello && echo world'. Tell me the exact output.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running echo commands\"}'\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"echo hello && echo world\",\"description\":\"Run echo hello && echo world\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: |-\n hello\n world\n \n - role: assistant\n content: |-\n The exact output is:\n ```\n hello\n world\n ```\n" }, { "path": "test/snapshots/builtin_tools/should_capture_stderr_output.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'echo error_msg >&2; echo ok' and tell me what stderr said. Reply with just the stderr content.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"echo error_msg >&2; echo ok\",\"description\":\"Run command with stderr output\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: |-\n error_msg\n ok\n \n - role: assistant\n content: error_msg\n" }, { "path": "test/snapshots/builtin_tools/should_create_a_new_file.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Create a file called 'new_file.txt' with the content 'Created by test'. Then read it back to confirm.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Creating new file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: create\n arguments: '{\"path\":\"${workdir}/new_file.txt\",\"file_text\":\"Created by test\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Create a file called 'new_file.txt' with the content 'Created by test'. Then read it back to confirm.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Creating new file\"}'\n - id: toolcall_1\n type: function\n function:\n name: create\n arguments: '{\"path\":\"${workdir}/new_file.txt\",\"file_text\":\"Created by test\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: Created file ${workdir}/new_file.txt with 15 characters\n - role: assistant\n tool_calls:\n - id: toolcall_2\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/new_file.txt\"}'\n - role: tool\n tool_call_id: toolcall_2\n content: 1. Created by test\n - role: assistant\n content: File created and confirmed! The file 'new_file.txt' contains \"Created by test\" as expected.\n" }, { "path": "test/snapshots/builtin_tools/should_edit_a_file_successfully.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: \"Edit the file 'edit_me.txt': replace 'Hello World' with 'Hi Universe'. Then read it back and tell me its\n contents.\"\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Editing file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: edit\n arguments: '{\"path\":\"${workdir}/edit_me.txt\",\"old_str\":\"Hello World\",\"new_str\":\"Hi Universe\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: \"Edit the file 'edit_me.txt': replace 'Hello World' with 'Hi Universe'. Then read it back and tell me its\n contents.\"\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Editing file\"}'\n - id: toolcall_1\n type: function\n function:\n name: edit\n arguments: '{\"path\":\"${workdir}/edit_me.txt\",\"old_str\":\"Hello World\",\"new_str\":\"Hi Universe\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: File ${workdir}/edit_me.txt updated with changes.\n - role: assistant\n tool_calls:\n - id: toolcall_2\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/edit_me.txt\"}'\n - role: tool\n tool_call_id: toolcall_2\n content: |-\n 1. Hi Universe\n 2. Goodbye World\n 3.\n - role: assistant\n content: |-\n The file now contains:\n 1. Hi Universe\n 2. Goodbye World\n" }, { "path": "test/snapshots/builtin_tools/should_find_files_by_pattern.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Find all .ts files in this directory (recursively). List the filenames you found.\n - role: assistant\n content: I'll search for all TypeScript files recursively in the current directory.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Finding TypeScript files\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: glob\n arguments: '{\"pattern\":\"**/*.ts\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Find all .ts files in this directory (recursively). List the filenames you found.\n - role: assistant\n content: I'll search for all TypeScript files recursively in the current directory.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Finding TypeScript files\"}'\n - id: toolcall_1\n type: function\n function:\n name: glob\n arguments: '{\"pattern\":\"**/*.ts\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: ./src/index.ts\n - role: assistant\n content: |-\n Found **1 TypeScript file**:\n - `src/index.ts`\n" }, { "path": "test/snapshots/builtin_tools/should_handle_nonexistent_file_gracefully.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Try to read the file 'does_not_exist.txt'. If it doesn't exist, say 'FILE_NOT_FOUND'.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/does_not_exist.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Try to read the file 'does_not_exist.txt'. If it doesn't exist, say 'FILE_NOT_FOUND'.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/does_not_exist.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: Path ${workdir}/does_not_exist.txt does not exist. Please provide a valid path.\n - role: assistant\n content: FILE_NOT_FOUND\n" }, { "path": "test/snapshots/builtin_tools/should_read_file_with_line_range.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read lines 2 through 4 of the file 'lines.txt' in this directory. Tell me what those lines contain.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading specific file lines\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/lines.txt\",\"view_range\":[2,4]}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read lines 2 through 4 of the file 'lines.txt' in this directory. Tell me what those lines contain.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading specific file lines\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/lines.txt\",\"view_range\":[2,4]}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: |-\n 2. line2\n 3. line3\n 4. line4\n - role: assistant\n content: |-\n Lines 2 through 4 contain:\n - Line 2: \"line2\"\n - Line 3: \"line3\" \n - Line 4: \"line4\"\n" }, { "path": "test/snapshots/builtin_tools/should_search_for_patterns_in_files.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Search for lines starting with 'ap' in the file 'data.txt'. Tell me which lines matched.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Searching file for pattern\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: grep\n arguments: '{\"pattern\":\"^ap\",\"path\":\"${workdir}/data.txt\",\"output_mode\":\"content\",\"-n\":true}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Search for lines starting with 'ap' in the file 'data.txt'. Tell me which lines matched.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Searching file for pattern\"}'\n - id: toolcall_1\n type: function\n function:\n name: grep\n arguments: '{\"pattern\":\"^ap\",\"path\":\"${workdir}/data.txt\",\"output_mode\":\"content\",\"-n\":true}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: |-\n ./data.txt:1:apple\n ./data.txt:3:apricot\n - role: assistant\n content: |-\n The search found **2 lines** starting with 'ap':\n - Line 1: `apple`\n - Line 3: `apricot`\n" }, { "path": "test/snapshots/client_api/should_delete_session_by_id.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say OK.\n - role: assistant\n content: OK.\n" }, { "path": "test/snapshots/client_api/should_track_last_session_id_after_session_created.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say OK.\n - role: assistant\n content: OK.\n" }, { "path": "test/snapshots/client_lifecycle/should_emit_session_lifecycle_events.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say hello\n - role: assistant\n content: Hello! I'm GitHub Copilot CLI, ready to help you with software engineering tasks. How can I assist you today?\n" }, { "path": "test/snapshots/client_lifecycle/should_return_last_session_id_after_sending_a_message.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say hello\n - role: assistant\n content: Hello! I'm GitHub Copilot CLI, ready to help with your software engineering tasks.\n" }, { "path": "test/snapshots/client_options/should_use_client_cwd_for_default_workingdirectory.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the file marker.txt and tell me what it says\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/client-cwd/marker.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. I am in the client cwd\n - role: assistant\n content: |-\n The file `marker.txt` says:\n\n ```\n I am in the client cwd\n ```\n" }, { "path": "test/snapshots/combinedconfiguration/accept_mcp_servers_and_custom_agents.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 7+7?\n - role: assistant\n content: 7 + 7 = 14\n" }, { "path": "test/snapshots/compaction/should_not_emit_compaction_events_when_infinite_sessions_disabled.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 2+2?\n - role: assistant\n content: 2+2 equals 4.\n" }, { "path": "test/snapshots/compaction/should_trigger_compaction_with_low_threshold_and_emit_events.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Tell me a story about a dragon. Be detailed.\n - role: assistant\n content: >-\n # The Last Ember of Thornkeep\n\n\n In the craggy peaks of the Ashfall Mountains, where volcanic vents still breathed smoke into perpetual\n twilight, there lived a dragon named Kaedrith. Her scales shimmered like molten copper, each one edged in\n obsidian black, and her eyes held the amber glow of dying stars.\n\n\n Kaedrith was ancient—so old that she had witnessed the rise and fall of three kingdoms in the valley below.\n She had once been fearsome, a terror that sent knights fleeing and villages scrambling to offer tribute. But\n those days had faded like morning mist. Now she spent her centuries in solitude, tending to her greatest\n treasure: not gold or jewels, but a garden of fire lilies that grew only in dragon flame.\n\n\n One winter evening, as ash-snow drifted through the mountain passes, a child appeared at the mouth of her\n cave. A girl, no more than ten, with eyes too weary for her age and hands wrapped in frost-bitten cloth. She\n didn't scream. She didn't run. She simply stood there, shivering, and said: \"They told me you eat people. I\n need to not be a person anymore.\"\n\n\n Kaedrith, who had lived long enough to understand the weight of such words, curled her massive form around the\n child like a shield of scales and warmth. \"What are you running from?\" she rumbled, her voice like distant\n thunder.\n\n\n \"A king who thinks children are coin,\" the girl whispered. \"He sells us to factories in the dark cities.\"\n\n\n The dragon's eyes blazed brighter. Deep in her chest, something that had been dormant for centuries\n stirred—the ancient rage that had once made mountains tremble. But she had learned patience through time's\n long lessons.\n\n\n Instead of descending upon the valley in fury, Kaedrith taught the girl. She showed her how to tend the fire\n lilies, whose petals held healing properties. She shared stories of the old world, when dragons and humans had\n been allies, not enemies. And slowly, other children found their way up the mountain—runaways, orphans, the\n forgotten.\n\n\n Kaedrith's cave became a sanctuary, warmed by dragon fire and filled with laughter that echoed off stone\n walls. And when the king finally sent his soldiers to drag the children back, they found not helpless\n refugees, but a dragon fully awakened—with a family worth protecting.\n\n\n The battle lasted seven minutes. The soldiers never returned.\n\n\n The king, wisely, never sent more.\n - role: user\n content: Continue the story with more details about the dragon's castle.\n - role: user\n content: ${compaction_prompt}\n - role: assistant\n content: >-\n \n\n The user requested creative storytelling content: first a detailed story about a dragon, then a continuation\n focusing on the dragon's castle. This is a pure creative writing task with no technical work, code changes, or\n file modifications involved.\n\n \n\n\n \n\n 1. The user asked for a detailed story about a dragon\n - Composed \"The Last Ember of Thornkeep\" - a story about Kaedrith, an ancient copper-scaled dragon in the Ashfall Mountains\n - Story focused on the dragon creating a sanctuary for runaway children fleeing a tyrannical king\n - Included detailed descriptions of the dragon's appearance, personality, and transformation from solitary guardian to protector of refugees\n\n 2. The user asked to continue the story with more details about the dragon's castle\n - Request received just before checkpoint compaction was triggered\n - No response provided yet to this continuation request\n \n\n\n \n\n Creative content delivered:\n\n - Completed initial dragon story (approximately 400 words)\n\n - Story established: setting (Ashfall Mountains), protagonist (Kaedrith the dragon), conflict (children\n fleeing exploitation), resolution (dragon creates sanctuary and defeats the king's soldiers)\n\n\n Work in progress:\n\n - Continuation about the dragon's castle/dwelling has been requested but not yet written\n\n \n\n\n \n\n - This is purely creative writing work - no code, files, or technical systems involved\n\n - No tools were needed or used for this storytelling task\n\n - User preference appears to be for detailed, narrative-driven fantasy content with emotional depth\n\n \n\n\n \n\n None. This conversation involves only creative writing responses with no file system interaction.\n\n \n\n\n \n\n Immediate next step:\n\n - Continue the dragon story with detailed descriptions of Kaedrith's castle/cave sanctuary, expanding on the\n world-building and the community that has formed there\n\n \n\n\n Dragon storytelling creative writing\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Tell me a story about a dragon. Be detailed.\n - role: assistant\n content: >-\n # The Last Ember of Thornkeep\n\n\n In the craggy peaks of the Ashfall Mountains, where volcanic vents still breathed smoke into perpetual\n twilight, there lived a dragon named Kaedrith. Her scales shimmered like molten copper, each one edged in\n obsidian black, and her eyes held the amber glow of dying stars.\n\n\n Kaedrith was ancient—so old that she had witnessed the rise and fall of three kingdoms in the valley below.\n She had once been fearsome, a terror that sent knights fleeing and villages scrambling to offer tribute. But\n those days had faded like morning mist. Now she spent her centuries in solitude, tending to her greatest\n treasure: not gold or jewels, but a garden of fire lilies that grew only in dragon flame.\n\n\n One winter evening, as ash-snow drifted through the mountain passes, a child appeared at the mouth of her\n cave. A girl, no more than ten, with eyes too weary for her age and hands wrapped in frost-bitten cloth. She\n didn't scream. She didn't run. She simply stood there, shivering, and said: \"They told me you eat people. I\n need to not be a person anymore.\"\n\n\n Kaedrith, who had lived long enough to understand the weight of such words, curled her massive form around the\n child like a shield of scales and warmth. \"What are you running from?\" she rumbled, her voice like distant\n thunder.\n\n\n \"A king who thinks children are coin,\" the girl whispered. \"He sells us to factories in the dark cities.\"\n\n\n The dragon's eyes blazed brighter. Deep in her chest, something that had been dormant for centuries\n stirred—the ancient rage that had once made mountains tremble. But she had learned patience through time's\n long lessons.\n\n\n Instead of descending upon the valley in fury, Kaedrith taught the girl. She showed her how to tend the fire\n lilies, whose petals held healing properties. She shared stories of the old world, when dragons and humans had\n been allies, not enemies. And slowly, other children found their way up the mountain—runaways, orphans, the\n forgotten.\n\n\n Kaedrith's cave became a sanctuary, warmed by dragon fire and filled with laughter that echoed off stone\n walls. And when the king finally sent his soldiers to drag the children back, they found not helpless\n refugees, but a dragon fully awakened—with a family worth protecting.\n\n\n The battle lasted seven minutes. The soldiers never returned.\n\n\n The king, wisely, never sent more.\n - role: user\n content: Continue the story with more details about the dragon's castle.\n - role: assistant\n content: >-\n # The Sanctuary of Scales\n\n\n What had begun as a simple cave transformed over the years into something far more magnificent. Kaedrith's\n lair sprawled through the mountain's heart like a labyrinth of wonders, carved not by tools but by dragon fire\n and patient claws over centuries.\n\n\n The **Grand Entrance** was a natural cathedral of stone, its ceiling lost in shadow sixty feet above.\n Stalactites glittered with embedded crystals that caught the light of ever-burning braziers—gifts from\n Kaedrith's own flame, designed never to extinguish. The children had painted murals across the walls: dragons\n soaring through skies, flowers blooming in impossible colors, and portraits of themselves as heroes in their\n own stories.\n\n\n Beyond lay the **Chamber of Wings**, where Kaedrith slept coiled around a natural hot spring. Mineral-rich\n water bubbled up from volcanic depths, filling the air with steam that smelled of minerals and magic. The\n children had built sleeping lofts into the chamber walls using salvaged timber and rope, each one\n customized—some with hanging gardens of cave moss, others with collections of interesting rocks, and one\n ambitious structure that resembled a ship's crow's nest.\n\n\n The **Garden of Eternal Flame** was Kaedrith's pride. This vast cavern had openings in its ceiling that\n created perfect conditions for her fire lilies. The flowers grew in spiral patterns, their petals shifting\n between crimson, gold, and blue depending on the temperature of dragon breath used to nurture them. The\n children learned to harvest them carefully, drying the petals to create medicines they traded with the one\n village brave enough to maintain contact with the dragon's domain.\n\n\n Down twisting corridors carved smooth by ancient lava flows, there was the **Library of Scales**. Here,\n Kaedrith had scratched histories into the walls themselves—accounts of the old world in draconic script that\n glowed faintly in darkness. The children couldn't read it yet, but she was teaching them, letter by letter.\n They'd also added their own contribution: books salvaged from abandoned places, stacked on stone shelves,\n covering everything from fairy tales to blacksmithing manuals.\n\n\n The **Treasury**, ironically, held little gold. Kaedrith had long ago traded most of her hoard for things more\n useful—seeds, tools, warm blankets. What remained was eclectic: a crown she'd taken from a tyrant king three\n centuries ago, now used as a planter for herbs; scattered gems that caught firelight; ancient armor pieces\n repurposed as wall decorations; and most precious of all, a collection of small objects the children had given\n her—crude clay figures, woven bracelets, a wooden carving of a dragon that looked more like a lizard with\n wings.\n\n\n The mountain fortress also contained practical spaces: the **Forge Room**, where heat from volcanic vents\n allowed them to work metal; the **Larder**, naturally cold passages that preserved food; and the **Rain\n Catcher**, an ingenious system of channels carved into the mountain's exterior that funneled fresh water into\n underground cisterns.\n\n\n But the heart of the sanctuary was the **Gathering Hall**, a wide chamber where stalactites and stalagmites\n had been carefully preserved to create natural pillars. Here they shared meals around a great stone table that\n Kaedrith had smoothed to perfect flatness. Here stories were told. Here plans were made. Here, on quiet\n evenings, the dragon would curl at one end of the hall while children used her tail as a climbing structure\n and read aloud from books, their voices echoing off ancient stone.\n\n\n Travelers who glimpsed the mountain from afar spoke of strange lights dancing in its peaks at night—the glow\n of dragon fire and human laughter, weaving together something the world hadn't seen in an age: a true\n alliance, a family forged not by blood but by choice, protected by scale and claw and the fierce love of an\n ancient creature who had finally found her purpose.\n\n\n And in the valley below, the cruel king's power waned, while whispered stories of the Dragon's Sanctuary\n spread—a place where the lost could be found, where the small could become mighty, where an ember of the old\n world still burned bright against the darkness.\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: >-\n Some of the conversation history has been summarized to free up context.\n\n\n You were originally given instructions from a user over one or more turns. Here were the user messages:\n\n \n\n Tell me a story about a dragon. Be detailed.\n\n \n\n \n\n Continue the story with more details about the dragon's castle.\n\n \n\n\n Here is a summary of the prior context:\n\n \n\n \n\n The user requested creative storytelling content: first a detailed story about a dragon, then a continuation\n focusing on the dragon's castle. This is a pure creative writing task with no technical work, code changes, or\n file modifications involved.\n\n \n\n\n \n\n 1. The user asked for a detailed story about a dragon\n - Composed \"The Last Ember of Thornkeep\" - a story about Kaedrith, an ancient copper-scaled dragon in the Ashfall Mountains\n - Story focused on the dragon creating a sanctuary for runaway children fleeing a tyrannical king\n - Included detailed descriptions of the dragon's appearance, personality, and transformation from solitary guardian to protector of refugees\n\n 2. The user asked to continue the story with more details about the dragon's castle\n - Request received just before checkpoint compaction was triggered\n - No response provided yet to this continuation request\n \n\n\n \n\n Creative content delivered:\n\n - Completed initial dragon story (approximately 400 words)\n\n - Story established: setting (Ashfall Mountains), protagonist (Kaedrith the dragon), conflict (children\n fleeing exploitation), resolution (dragon creates sanctuary and defeats the king's soldiers)\n\n\n Work in progress:\n\n - Continuation about the dragon's castle/dwelling has been requested but not yet written\n\n \n\n\n \n\n - This is purely creative writing work - no code, files, or technical systems involved\n\n - No tools were needed or used for this storytelling task\n\n - User preference appears to be for detailed, narrative-driven fantasy content with emotional depth\n\n \n\n\n \n\n None. This conversation involves only creative writing responses with no file system interaction.\n\n \n\n\n \n\n Immediate next step:\n\n - Continue the dragon story with detailed descriptions of Kaedrith's castle/cave sanctuary, expanding on the\n world-building and the community that has formed there\n\n \n\n\n Dragon storytelling creative writing\n\n \n - role: assistant\n content: >-\n # The Sanctuary of Scales\n\n\n What had begun as a simple cave transformed over the years into something far more magnificent. Kaedrith's\n lair sprawled through the mountain's heart like a labyrinth of wonders, carved not by tools but by dragon fire\n and patient claws over centuries.\n\n\n The **Grand Entrance** was a natural cathedral of stone, its ceiling lost in shadow sixty feet above.\n Stalactites glittered with embedded crystals that caught the light of ever-burning braziers—gifts from\n Kaedrith's own flame, designed never to extinguish. The children had painted murals across the walls: dragons\n soaring through skies, flowers blooming in impossible colors, and portraits of themselves as heroes in their\n own stories.\n\n\n Beyond lay the **Chamber of Wings**, where Kaedrith slept coiled around a natural hot spring. Mineral-rich\n water bubbled up from volcanic depths, filling the air with steam that smelled of minerals and magic. The\n children had built sleeping lofts into the chamber walls using salvaged timber and rope, each one\n customized—some with hanging gardens of cave moss, others with collections of interesting rocks, and one\n ambitious structure that resembled a ship's crow's nest.\n\n\n The **Garden of Eternal Flame** was Kaedrith's pride. This vast cavern had openings in its ceiling that\n created perfect conditions for her fire lilies. The flowers grew in spiral patterns, their petals shifting\n between crimson, gold, and blue depending on the temperature of dragon breath used to nurture them. The\n children learned to harvest them carefully, drying the petals to create medicines they traded with the one\n village brave enough to maintain contact with the dragon's domain.\n\n\n Down twisting corridors carved smooth by ancient lava flows, there was the **Library of Scales**. Here,\n Kaedrith had scratched histories into the walls themselves—accounts of the old world in draconic script that\n glowed faintly in darkness. The children couldn't read it yet, but she was teaching them, letter by letter.\n They'd also added their own contribution: books salvaged from abandoned places, stacked on stone shelves,\n covering everything from fairy tales to blacksmithing manuals.\n\n\n The **Treasury**, ironically, held little gold. Kaedrith had long ago traded most of her hoard for things more\n useful—seeds, tools, warm blankets. What remained was eclectic: a crown she'd taken from a tyrant king three\n centuries ago, now used as a planter for herbs; scattered gems that caught firelight; ancient armor pieces\n repurposed as wall decorations; and most precious of all, a collection of small objects the children had given\n her—crude clay figures, woven bracelets, a wooden carving of a dragon that looked more like a lizard with\n wings.\n\n\n The mountain fortress also contained practical spaces: the **Forge Room**, where heat from volcanic vents\n allowed them to work metal; the **Larder**, naturally cold passages that preserved food; and the **Rain\n Catcher**, an ingenious system of channels carved into the mountain's exterior that funneled fresh water into\n underground cisterns.\n\n\n But the heart of the sanctuary was the **Gathering Hall**, a wide chamber where stalactites and stalagmites\n had been carefully preserved to create natural pillars. Here they shared meals around a great stone table that\n Kaedrith had smoothed to perfect flatness. Here stories were told. Here plans were made. Here, on quiet\n evenings, the dragon would curl at one end of the hall while children used her tail as a climbing structure\n and read aloud from books, their voices echoing off ancient stone.\n\n\n Travelers who glimpsed the mountain from afar spoke of strange lights dancing in its peaks at night—the glow\n of dragon fire and human laughter, weaving together something the world hadn't seen in an age: a true\n alliance, a family forged not by blood but by choice, protected by scale and claw and the fierce love of an\n ancient creature who had finally found her purpose.\n\n\n And in the valley below, the cruel king's power waned, while whispered stories of the Dragon's Sanctuary\n spread—a place where the lost could be found, where the small could become mighty, where an ember of the old\n world still burned bright against the darkness.\n - role: user\n content: Now describe the dragon's treasure in great detail.\n - role: assistant\n content: >-\n # The Treasury of Kaedrith\n\n\n Most who spoke of dragons imagined mountains of gold coins, rivers of rubies, chambers so full of wealth you\n could swim through precious metals. Kaedrith's treasury told a different story—one of transformation,\n sacrifice, and the strange alchemy that turns cold metal into warm memory.\n\n\n The chamber itself was circular, perhaps forty feet across, with walls of dark volcanic glass that reflected\n firelight in fractured patterns. The ceiling formed a natural dome where selenite crystals grew in delicate\n formations, casting soft lunar glows even when no flame burned.\n\n\n **The Practical Treasures**\n\n\n Against the eastern wall stood three ancient chests of blackened oak, their iron bindings turned green with\n age. These held what remained of traditional wealth—but repurposed.\n\n\n The first chest contained **The Garden Gold**: approximately two thousand gold coins that Kaedrith had melted\n down and recast into small discs, each stamped with a crude image of a flame lily. These served as trade\n tokens with the one village that maintained peaceful relations. Each disc could be exchanged for\n supplies—grain, cloth, medicine, seeds. The children called them \"fire pennies\" and treated them with more\n respect than any merchant handled true gold.\n\n\n The second chest was **The Gem Repository**—not piles of jewels, but organized purpose. Diamonds sorted by\n size for cutting tools. Rubies and garnets ground into abrasive powder for polishing metal and sharpening\n blades. Emeralds and sapphires kept whole, reserved for trade in emergencies. A handful of opals that Kaedrith\n admitted she kept purely because they were beautiful, their color-play reminding her of dragon scales in\n sunlight.\n\n\n The third chest held **The Silk Hoard**: bolts of fabric accumulated over centuries. Spider silk from the\n great weavers of the Southern Deeps, shimmering white and stronger than steel cables. Royal purple cloth\n embroidered with golden thread, taken from a emperor's palace four hundred years ago, now carefully rationed\n to make warm winter cloaks for the children. Crimson velvet that had once been curtains in a cathedral. Rolls\n of practical wool and linen she'd traded for.\n\n\n **The Crown Garden**\n\n\n Set upon a natural stone pedestal grew what the children called the Crown Garden. **The Tyrant's Circlet**—a\n masterwork of ancient goldsmithing, set with seven blood rubies—had been taken from King Malthus the Terrible\n in the year 823. Kaedrith had personally removed it from his head after he'd ordered the burning of a village\n that refused to pay tribute.\n\n\n Now, three centuries later, soil filled its hollow center and medicinal herbs flourished there. Feverfew\n spilled over its golden rim. Chamomile flowers nodded where rubies gleamed. Tiny sage plants grew between the\n crown's points. The children found it endlessly amusing that something meant to symbolize ultimate power now\n served to cure headaches and soothe upset stomachs.\n\n\n Beside it sat **The Bishop's Mitre**, also converted to a planter, growing mint and lemon balm. And next to\n that, **The Admiral's Tricorn Hat**, bronze and ridiculous, holding a cheerful collection of strawberry\n plants.\n\n\n **The Armor Wall**\n\n\n The northern wall displayed pieces of armor, arranged not for vanity but as a timeline of human ambition and\n folly.\n\n\n **The Silver Paladin's Breastplate** (circa 600) was beautiful—mirror-bright, etched with prayers in Old\n Ecclesiast. The paladin had come to slay the dragon as a demonstration of faith. Kaedrith had spoken with him\n for three days, and he'd left peacefully, a wiser man, leaving his armor as an apology.\n\n\n **The Obsidian Gauntlets of the Void Knight** (circa 1102) were darker, crafted from volcanic glass and black\n steel, radiating residual curses. Kaedrith kept them sealed in a box of salt and silver—dangerous, but too\n powerful to destroy. A reminder that some treasures were better left untouched.\n\n\n **The Dragon-Scale Shield** (circa 945) was tragic—made from the scales of Kaedrith's younger brother,\n Vorthain, who had been slain by kingdom soldiers. She'd hunted the knight who carried it for six months, not\n for revenge but to reclaim what was hers to mourn. The shield hung in a place of honor, sometimes draped with\n flowers.\n\n\n **A Collection of Helmets**—twelve in all—ranged from primitive iron caps to elaborate jousting helms with\n plumes and visors. The children used them as toy buckets, storage containers, and occasionally wore them while\n playing knights-and-dragons (where the dragon always won, but fairly).\n\n\n **The Memory Hoard**\n\n\n This section occupied the western wall, and it was here that Kaedrith spent most of her contemplative hours.\n These were treasures of sentiment, worthless to any other creature, priceless to her.\n\n\n **Clay Figurines**: Dozens of them, carefully arranged on a shelf of smooth stone. The first was barely\n recognizable as a dragon—a lumpy blob with wing-protrusions that might have been ears. It had been made by\n Elena, the first child to arrive at the sanctuary, seven years ago. The progression showed improving skill:\n dragons with proper proportions, some painted, some glazed in the small kiln they'd built. The newest\n additions looked almost professional.\n\n\n **The Bracelet Collection**: Woven from grass, braided leather, twisted copper wire, and once, ambitiously,\n from someone's hair. Forty-three bracelets, each too small for a dragon's limb, each hung carefully on carved\n stone pegs. Some had fallen apart with age; Kaedrith had preserved the pieces in small cloth bags, labeled\n with burnt-wood script: \"Marcus, age 9, spring of 1184.\"\n\n\n **Wooden Carvings**: A menagerie of attempts. Dragon-lizards with too many legs. A remarkably good hawk.\n Several abstract shapes that might have been anything. A tiny wooden sword, no longer than a finger, carved by\n a boy who'd dreamed of being a warrior but found he preferred carpentry.\n\n\n **Letters and Drawings**: Stored in a fireproof iron case, hundreds of pieces of parchment, bark-paper, and\n scraped leather. Drawings of the mountain, of Kaedrith herself (varying wildly in accuracy), of imagined\n adventures. Letters written by children who'd grown up and left the sanctuary, reporting on their\n lives—marriages, businesses started, children of their own born free in a world that was slowly learning to be\n kinder.\n\n\n **The Peculiar Items**\n\n\n Some treasures defied categorization:\n\n\n **The Eternal Candle**: A single white candle that had been burning for ninety-seven years, its flame never\n wavering, never consuming the wax. Kaedrith had found it in the ruins of a wizard's tower and had never\n determined if it was magnificent craftsmanship or genuine magic. Either way, it served as a nightlight in the\n treasury.\n\n\n **The Map That Rewrites Itself**: Spread under crystal glass on a stone table, this ancient map showed the\n kingdom's geography but updated itself annually. Mountains shifted. Rivers changed course. Villages appeared\n and disappeared. Kaedrith used it to monitor the human world, to know where refugees might be fleeing from.\n\n\n **Three Dragon Eggs**: Smooth, dark, cold as stone. Her own children, who had never hatched. She'd laid them\n two hundred years ago, and they had remained dormant. Kept in a nest of cloth and carefully maintained heat.\n She'd long since accepted they were probably lifeless, but she couldn't bring herself to stop caring for them.\n Hope, she'd learned, was its own kind of treasure.\n\n\n **The Sword Without a Name**: The finest blade she'd ever seen, folded steel that held an edge after three\n centuries, with a hilt wrapped in dragon-leather (gifted, not taken—an important distinction). It had belonged\n to the only dragon-slayer who'd succeeded in wounding her, a woman named Cassandra who'd fought not from\n hatred but from duty to protect her village from what she'd believed was a monster. They'd spoken after the\n battle. Cassandra had understood her error. She'd left the sword as payment for a lesson learned and had\n become a defender of dragons ever after, until her death forty years later. The sword hung in peace, a\n monument to the possibility of changed minds.\n\n\n **The Living Treasure**\n\n\n But if you asked Kaedrith what her greatest treasure was, she would unfurl her great wings, gesture with a\n copper-scaled talon toward the chambers beyond, and tell you about different riches entirely.\n\n\n There was Marcus's laugh, bright as silver bells. There was Elena's gift for growing things, more valuable\n than emeralds. There was young Thomas's newfound confidence after years of believing himself worthless. There\n was the sound of children sleeping safely, the warmth of trust given freely, the weight of small arms hugging\n her neck without fear.\n\n\n She would tell you about the morning little Sara had brought her a flower and said, \"I picked this for you\n because you're pretty.\" She would describe the evening when teenage Marcus had asked her advice about his\n future, treating her not as a monster or a legend, but as someone wise whose opinion mattered.\n\n\n *These* were treasures that couldn't be stolen, wouldn't tarnish, and grew more valuable with every passing\n year.\n\n\n The gold and jewels, the ancient armor and magical oddities—these were just things, kept partly from habit,\n partly for utility, partly as reminders of who she'd been and who she'd chosen to become.\n\n\n But the clay dragons? The bracelets? The careful letters reporting on lives lived fully and freely?\n\n\n These were the hoard of a dragon who'd learned that the greatest wealth wasn't what you gathered, but what you\n gave away, and received in return.\n\n\n In the corner of the treasury, almost hidden, sat one final item: a small wooden sign, painted by an\n eleven-year-old with more enthusiasm than skill. It read, in crooked letters:\n\n\n **\"KAEDRITH'S TRESURE: THE BEST DRAGON'S HORD IN THE HOLE WORLD\"**\n\n\n The spelling was atrocious. The grammar made scholars weep. Kaedrith wouldn't have traded it for all the gold\n in all the kingdoms of all the earth.\n - role: user\n content: What was the story about?\n - role: assistant\n content: >-\n The story is about **Kaedrith**, an ancient copper-scaled dragon living in the Ashfall Mountains, who\n transforms from a solitary creature into a guardian and protector of refugee children.\n\n\n **Core Plot:**\n\n - Children fleeing exploitation from a tyrannical king find sanctuary with Kaedrith\n\n - The dragon creates a safe haven in her mountain lair, transforming it from a simple cave into an elaborate\n fortress-home\n\n - She defeats the king's soldiers when they come hunting for the children\n\n - Over time, a true family forms—not based on blood, but on choice, trust, and mutual care\n\n\n **Key Themes:**\n\n - **Transformation & Purpose**: Kaedrith discovers that her true purpose isn't hoarding gold or living in\n isolation, but protecting and nurturing the vulnerable\n\n - **Redefining Treasure**: Her hoard evolves from traditional dragon wealth (gold, jewels, armor) into\n something more meaningful—clay figurines made by children, handmade bracelets, letters from those who grew up\n and left to live free lives\n\n - **Found Family**: The relationship between an ancient, powerful creature and fragile human children who need\n protection\n\n - **Sanctuary vs. Power**: The contrast between the cruel king's dominance and the dragon's protective\n strength used for good\n\n\n **Setting Details:**\n\n The mountain sanctuary includes chambers like the Grand Entrance with painted murals, the Chamber of Wings\n with a hot spring, the Garden of Eternal Flame with fire lilies, a Library, a Treasury filled with repurposed\n crowns-turned-planters, and a Gathering Hall where dragon and children share meals and stories.\n\n\n At its heart, it's a story about how love, purpose, and connection are the most valuable treasures of all.\n" }, { "path": "test/snapshots/customagents/accept_custom_agent_config_on_create.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 5+5?\n - role: assistant\n content: 5 + 5 = 10\n" }, { "path": "test/snapshots/customagents/accept_custom_agent_config_on_resume.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1 + 1 = 2\n - role: user\n content: What is 6+6?\n - role: assistant\n content: 6 + 6 = 12\n" }, { "path": "test/snapshots/event_fidelity/should_emit_assistant_message_with_messageid.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say 'pong'.\n - role: assistant\n content: pong\n" }, { "path": "test/snapshots/event_fidelity/should_emit_events_in_correct_order_for_tool_using_conversation.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the file 'hello.txt' and tell me its contents.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file contents\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/hello.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the file 'hello.txt' and tell me its contents.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file contents\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/hello.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. Hello World\n - role: assistant\n content: \"The file 'hello.txt' contains: \\\"Hello World\\\"\"\n" }, { "path": "test/snapshots/event_fidelity/should_emit_tool_execution_events_with_correct_fields.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the file 'data.txt'.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading data.txt\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/data.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the file 'data.txt'.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading data.txt\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/data.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. test data\n - role: assistant\n content: \"The file 'data.txt' contains: `test data`\"\n" }, { "path": "test/snapshots/event_fidelity/should_include_valid_fields_on_all_events.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 5+5? Reply with just the number.\n - role: assistant\n content: \"10\"\n" }, { "path": "test/snapshots/hooks/deny_tool_execution_when_pre_tool_use_returns_deny.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Edit protected.txt and replace 'Original' with 'Modified'\n - role: assistant\n content: I'll view the file first and then make the edit.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Editing protected.txt file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/protected.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Edit protected.txt and replace 'Original' with 'Modified'\n - role: assistant\n content: I'll view the file first and then make the edit.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Editing protected.txt file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/protected.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: \"Denied by preToolUse hook: No reason provided\"\n - role: tool\n tool_call_id: toolcall_1\n content: \"Denied by preToolUse hook: No reason provided\"\n - role: assistant\n content: \"The tools were denied by a preToolUse hook. Let me try to read the file using bash instead:\"\n - role: assistant\n tool_calls:\n - id: toolcall_2\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"cat protected.txt\",\"description\":\"View protected.txt content\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Edit protected.txt and replace 'Original' with 'Modified'\n - role: assistant\n content: I'll view the file first and then make the edit.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Editing protected.txt file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/protected.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: \"Denied by preToolUse hook: No reason provided\"\n - role: tool\n tool_call_id: toolcall_1\n content: \"Denied by preToolUse hook: No reason provided\"\n - role: assistant\n content: \"The tools were denied by a preToolUse hook. Let me try to read the file using bash instead:\"\n tool_calls:\n - id: toolcall_2\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"cat protected.txt\",\"description\":\"View protected.txt content\"}'\n - role: tool\n tool_call_id: toolcall_2\n content: \"Denied by preToolUse hook: No reason provided\"\n - role: assistant\n content: It appears all tools are being denied by a hook. This might be a permissions or security configuration issue\n with the file or environment. The file is named \"protected.txt\" which suggests it may have special protection\n in place that's preventing access or modification.\n" }, { "path": "test/snapshots/hooks/invoke_both_hooks_for_single_tool_call.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the contents of both.txt\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file contents\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/both.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the contents of both.txt\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file contents\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/both.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. Testing both hooks!\n - role: assistant\n content: 'The file contains: \"Testing both hooks!\"'\n" }, { "path": "test/snapshots/hooks/invoke_post_tool_use_hook_after_model_runs_a_tool.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the contents of world.txt and tell me what it says\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file contents\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/world.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the contents of world.txt and tell me what it says\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file contents\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/world.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. World from the test!\n - role: assistant\n content: 'The file world.txt contains: \"World from the test!\"'\n" }, { "path": "test/snapshots/hooks/invoke_pre_tool_use_hook_when_model_runs_a_tool.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the contents of hello.txt and tell me what it says\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file contents\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/hello.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the contents of hello.txt and tell me what it says\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file contents\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/hello.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. Hello from the test!\n - role: assistant\n content: The file says \"Hello from the test!\"\n" }, { "path": "test/snapshots/hooks/should_deny_tool_execution_when_pretooluse_returns_deny.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Edit protected.txt and replace 'Original' with 'Modified'\n - role: assistant\n content: I'll view the file first and then make the edit.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Editing protected.txt file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/protected.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Edit protected.txt and replace 'Original' with 'Modified'\n - role: assistant\n content: I'll view the file first and then make the edit.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Editing protected.txt file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/protected.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: \"Denied by preToolUse hook: No reason provided\"\n - role: tool\n tool_call_id: toolcall_1\n content: \"Denied by preToolUse hook: No reason provided\"\n - role: assistant\n content: It appears that access to protected.txt is being denied by a security hook. This file seems to be protected\n from viewing and editing operations.\n" }, { "path": "test/snapshots/hooks/should_invoke_both_pretooluse_and_posttooluse_hooks_for_a_single_tool_call.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the contents of both.txt\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file contents\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/both.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the contents of both.txt\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file contents\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/both.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. Testing both hooks!\n - role: assistant\n content: 'The file contains a single line: \"Testing both hooks!\"'\n" }, { "path": "test/snapshots/hooks/should_invoke_both_pretooluse_and_posttooluse_hooks_for_single_tool_call.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the contents of both.txt\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file contents\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/both.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the contents of both.txt\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file contents\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/both.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. Testing both hooks!\n - role: assistant\n content: 'The file `both.txt` contains: \"Testing both hooks!\"'\n" }, { "path": "test/snapshots/hooks/should_invoke_posttooluse_hook_after_model_runs_a_tool.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the contents of world.txt and tell me what it says\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file contents\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/world.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the contents of world.txt and tell me what it says\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file contents\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/world.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. World from the test!\n - role: assistant\n content: 'The file contains: \"World from the test!\"'\n" }, { "path": "test/snapshots/hooks/should_invoke_pretooluse_hook_when_model_runs_a_tool.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the contents of hello.txt and tell me what it says\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file contents\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/hello.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the contents of hello.txt and tell me what it says\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file contents\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/hello.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. Hello from the test!\n - role: assistant\n content: 'The file contains: \"Hello from the test!\"'\n" }, { "path": "test/snapshots/hooks_extended/should_allow_posttooluse_to_return_modifiedresult.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Call the report_intent tool with intent 'Testing post hook', then reply done.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Testing post hook\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Call the report_intent tool with intent 'Testing post hook', then reply done.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Testing post hook\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}\"}'\n - role: tool\n tool_call_id: toolcall_1\n content: Tool 'view' does not exist. Available tools that can be called are report_intent.\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: assistant\n content: Done.\n" }, { "path": "test/snapshots/hooks_extended/should_allow_pretooluse_to_return_modifiedargs_and_suppressoutput.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Call echo_value with value 'original', then reply with the result.\n - role: assistant\n content: I'll call echo_value with 'original' for you.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Calling echo_value\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: echo_value\n arguments: '{\"value\":\"original\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Call echo_value with value 'original', then reply with the result.\n - role: assistant\n content: I'll call echo_value with 'original' for you.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Calling echo_value\"}'\n - id: toolcall_1\n type: function\n function:\n name: echo_value\n arguments: '{\"value\":\"modified by hook\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: modified by hook\n - role: assistant\n content: 'The echo_value returned: **\"modified by hook\"**'\n" }, { "path": "test/snapshots/hooks_extended/should_invoke_onerroroccurred_hook_when_error_occurs.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say hi\n - role: assistant\n content: Hi! I'm GitHub Copilot CLI, ready to help you with software engineering tasks. What would you like to work on?\n" }, { "path": "test/snapshots/hooks_extended/should_invoke_onsessionend_hook_when_session_is_disconnected.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say hi\n - role: assistant\n content: Hi! I'm ready to help you with any software engineering tasks. What would you like to work on?\n" }, { "path": "test/snapshots/hooks_extended/should_invoke_onsessionstart_hook_on_new_session.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say hi\n - role: assistant\n content: Hi! I'm ready to help you with your software engineering tasks. What would you like me to do?\n" }, { "path": "test/snapshots/hooks_extended/should_invoke_onuserpromptsubmitted_hook_when_sending_a_message.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say hello\n - role: assistant\n content: Hello! I'm GitHub Copilot CLI, ready to help you with software engineering tasks. How can I assist you today?\n" }, { "path": "test/snapshots/hooks_extended/should_invoke_sessionend_hook.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say bye\n - role: assistant\n content: Goodbye! Feel free to return anytime you need help with your projects. Have a great day! 👋\n" }, { "path": "test/snapshots/hooks_extended/should_invoke_sessionstart_hook.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Session start hook context.\n - role: user\n content: Say hi\n - role: assistant\n content: >-\n Hi! 👋 \n\n\n I'm GitHub Copilot CLI, powered by claude-sonnet-4.5. I'm here to help you with software engineering tasks\n like exploring codebases, running commands, making code changes, and more. \n\n\n What can I help you with today?\n" }, { "path": "test/snapshots/hooks_extended/should_invoke_userpromptsubmitted_hook_and_modify_prompt.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: \"Reply with exactly: HOOKED_PROMPT\"\n - role: assistant\n content: HOOKED_PROMPT\n" }, { "path": "test/snapshots/hooks_extended/should_register_erroroccurred_hook.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say hi\n - role: assistant\n content: Hi! 👋 I'm GitHub Copilot CLI, ready to help you with your software engineering tasks. What would you like to\n work on today?\n" }, { "path": "test/snapshots/mcp-and-agents/should_accept_both_mcp_servers_and_custom_agents.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 7+7?\n - role: assistant\n content: 7 + 7 = 14\n" }, { "path": "test/snapshots/mcp-and-agents/should_accept_custom_agent_configuration_on_session_create.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 5+5?\n - role: assistant\n content: 5 + 5 = 10\n" }, { "path": "test/snapshots/mcp-and-agents/should_accept_custom_agent_configuration_on_session_resume.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1+1 equals 2.\n - role: user\n content: What is 6+6?\n - role: assistant\n content: 6+6 equals 12.\n" }, { "path": "test/snapshots/mcp-and-agents/should_accept_mcp_server_configuration_on_session_create.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 2+2?\n - role: assistant\n content: 2 + 2 = 4\n" }, { "path": "test/snapshots/mcp-and-agents/should_accept_mcp_server_configuration_on_session_resume.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1 + 1 = 2\n - role: user\n content: What is 3+3?\n - role: assistant\n content: 3 + 3 = 6\n" }, { "path": "test/snapshots/mcp_and_agents/accept_custom_agent_config_on_create.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 5+5?\n - role: assistant\n content: 5 + 5 = 10\n" }, { "path": "test/snapshots/mcp_and_agents/accept_custom_agent_config_on_resume.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1 + 1 = 2\n - role: user\n content: What is 6+6?\n - role: assistant\n content: 6 + 6 = 12\n" }, { "path": "test/snapshots/mcp_and_agents/accept_mcp_server_config_on_create.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 2+2?\n - role: assistant\n content: 2 + 2 = 4\n" }, { "path": "test/snapshots/mcp_and_agents/accept_mcp_server_config_on_resume.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1+1 equals 2.\n - role: user\n content: What is 3+3?\n - role: assistant\n content: 3+3 equals 6.\n" }, { "path": "test/snapshots/mcp_and_agents/accept_mcp_servers_and_custom_agents.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 7+7?\n - role: assistant\n content: 7 + 7 = 14\n" }, { "path": "test/snapshots/mcp_and_agents/should_accept_both_mcp_servers_and_custom_agents.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 7+7?\n - role: assistant\n content: 7 + 7 = 14\n" }, { "path": "test/snapshots/mcp_and_agents/should_accept_custom_agent_configuration_on_session_create.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 5+5?\n - role: assistant\n content: 5 + 5 = 10\n" }, { "path": "test/snapshots/mcp_and_agents/should_accept_custom_agent_configuration_on_session_resume.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1+1 equals 2.\n - role: user\n content: What is 6+6?\n - role: assistant\n content: 6+6 equals 12.\n" }, { "path": "test/snapshots/mcp_and_agents/should_accept_defaultagent_configuration_on_session_resume.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 3+3?\n - role: assistant\n content: 3 + 3 = 6\n - role: user\n content: What is 4+4?\n - role: assistant\n content: 4 + 4 = 8\n" }, { "path": "test/snapshots/mcp_and_agents/should_accept_mcp_server_configuration_on_session_create.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 2+2?\n - role: assistant\n content: 2 + 2 = 4\n" }, { "path": "test/snapshots/mcp_and_agents/should_accept_mcp_server_configuration_on_session_resume.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1 + 1 = 2\n - role: user\n content: What is 3+3?\n - role: assistant\n content: 3 + 3 = 6\n" }, { "path": "test/snapshots/mcp_and_agents/should_hide_excluded_tools_from_default_agent.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Do you have access to a tool called secret_tool? Answer yes or no.\n - role: assistant\n content: No, I don't have access to a tool called secret_tool.\n" }, { "path": "test/snapshots/mcp_and_agents/should_pass_literal_env_values_to_mcp_server_subprocess.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use the env-echo/get_env tool to read the TEST_SECRET environment variable. Reply with just the value, nothing\n else.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: env-echo-get_env\n arguments: '{\"name\":\"TEST_SECRET\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: hunter2\n - role: assistant\n content: hunter2\n" }, { "path": "test/snapshots/mcpservers/accept_mcp_server_config_on_create.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 2+2?\n - role: assistant\n content: 2 + 2 = 4\n" }, { "path": "test/snapshots/mcpservers/accept_mcp_server_config_on_resume.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1 + 1 = 2\n - role: user\n content: What is 3+3?\n - role: assistant\n content: 3 + 3 = 6\n" }, { "path": "test/snapshots/multi_client/both_clients_see_tool_request_and_completion_events.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use the magic_number tool with seed 'hello' and tell me the result\n - role: assistant\n content: I'll use the magic_number tool with seed 'hello' for you.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Getting magic number\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: magic_number\n arguments: '{\"seed\":\"hello\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use the magic_number tool with seed 'hello' and tell me the result\n - role: assistant\n content: I'll use the magic_number tool with seed 'hello' for you.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Getting magic number\"}'\n - id: toolcall_1\n type: function\n function:\n name: magic_number\n arguments: '{\"seed\":\"hello\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: MAGIC_hello_42\n - role: assistant\n content: The magic number for seed 'hello' is **MAGIC_hello_42**.\n" }, { "path": "test/snapshots/multi_client/disconnecting_client_removes_its_tools.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use the stable_tool with input 'test1' and tell me the result.\n - role: assistant\n content: I'll call the stable_tool with input 'test1' for you.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Testing stable_tool\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: stable_tool\n arguments: '{\"input\":\"test1\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use the stable_tool with input 'test1' and tell me the result.\n - role: assistant\n content: I'll call the stable_tool with input 'test1' for you.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Testing stable_tool\"}'\n - id: toolcall_1\n type: function\n function:\n name: stable_tool\n arguments: '{\"input\":\"test1\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: STABLE_test1\n - role: assistant\n content: \"The stable_tool returned: **STABLE_test1**\"\n - role: user\n content: Use the ephemeral_tool with input 'test2' and tell me the result.\n - role: assistant\n content: I'll call the ephemeral_tool with input 'test2' for you.\n - role: assistant\n tool_calls:\n - id: toolcall_2\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Testing ephemeral_tool\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_3\n type: function\n function:\n name: ephemeral_tool\n arguments: '{\"input\":\"test2\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use the stable_tool with input 'test1' and tell me the result.\n - role: assistant\n content: I'll call the stable_tool with input 'test1' for you.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Testing stable_tool\"}'\n - id: toolcall_1\n type: function\n function:\n name: stable_tool\n arguments: '{\"input\":\"test1\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: STABLE_test1\n - role: assistant\n content: \"The stable_tool returned: **STABLE_test1**\"\n - role: user\n content: Use the ephemeral_tool with input 'test2' and tell me the result.\n - role: assistant\n content: I'll call the ephemeral_tool with input 'test2' for you.\n tool_calls:\n - id: toolcall_2\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Testing ephemeral_tool\"}'\n - id: toolcall_3\n type: function\n function:\n name: ephemeral_tool\n arguments: '{\"input\":\"test2\"}'\n - role: tool\n tool_call_id: toolcall_2\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_3\n content: EPHEMERAL_test2\n - role: assistant\n content: \"The ephemeral_tool returned: **EPHEMERAL_test2**\"\n - role: user\n content: >-\n \n\n Tools no longer available: ephemeral_tool\n\n\n Important: Do not attempt to call tools that are no longer available unless you've been notified that they're\n available again.\n\n \n\n\n Use the stable_tool with input 'still_here'. Also try using ephemeral_tool if it is available.\n - role: assistant\n content: I'll call the stable_tool with input 'still_here'. The ephemeral_tool is no longer available, so I can only use\n the stable_tool.\n - role: assistant\n tool_calls:\n - id: toolcall_4\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Testing tool availability\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_5\n type: function\n function:\n name: stable_tool\n arguments: '{\"input\":\"still_here\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use the stable_tool with input 'test1' and tell me the result.\n - role: assistant\n content: I'll call the stable_tool with input 'test1' for you.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Testing stable_tool\"}'\n - id: toolcall_1\n type: function\n function:\n name: stable_tool\n arguments: '{\"input\":\"test1\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: STABLE_test1\n - role: assistant\n content: \"The stable_tool returned: **STABLE_test1**\"\n - role: user\n content: Use the ephemeral_tool with input 'test2' and tell me the result.\n - role: assistant\n content: I'll call the ephemeral_tool with input 'test2' for you.\n tool_calls:\n - id: toolcall_2\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Testing ephemeral_tool\"}'\n - id: toolcall_3\n type: function\n function:\n name: ephemeral_tool\n arguments: '{\"input\":\"test2\"}'\n - role: tool\n tool_call_id: toolcall_2\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_3\n content: EPHEMERAL_test2\n - role: assistant\n content: \"The ephemeral_tool returned: **EPHEMERAL_test2**\"\n - role: user\n content: >-\n \n\n Tools no longer available: ephemeral_tool\n\n\n Important: Do not attempt to call tools that are no longer available unless you've been notified that they're\n available again.\n\n \n\n\n Use the stable_tool with input 'still_here'. Also try using ephemeral_tool if it is available.\n - role: assistant\n content: I'll call the stable_tool with input 'still_here'. The ephemeral_tool is no longer available, so I can only use\n the stable_tool.\n tool_calls:\n - id: toolcall_4\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Testing tool availability\"}'\n - id: toolcall_5\n type: function\n function:\n name: stable_tool\n arguments: '{\"input\":\"still_here\"}'\n - role: tool\n tool_call_id: toolcall_4\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_5\n content: STABLE_still_here\n - role: assistant\n content: >-\n The stable_tool returned: **STABLE_still_here**\n\n\n The ephemeral_tool is not available anymore (it was removed as indicated in the tools_changed_notice), so I\n could only call the stable_tool.\n" }, { "path": "test/snapshots/multi_client/one_client_approves_permission_and_both_see_the_result.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Create a file called hello.txt containing the text 'hello world'\n - role: assistant\n content: I'll create the hello.txt file for you.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Creating hello.txt file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: create\n arguments: '{\"file_text\":\"hello world\",\"path\":\"${workdir}/hello.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Create a file called hello.txt containing the text 'hello world'\n - role: assistant\n content: I'll create the hello.txt file for you.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Creating hello.txt file\"}'\n - id: toolcall_1\n type: function\n function:\n name: create\n arguments: '{\"file_text\":\"hello world\",\"path\":\"${workdir}/hello.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: Created file ${workdir}/hello.txt with 11 characters\n - role: assistant\n content: Done! I've created hello.txt with the text \"hello world\" in your current directory.\n" }, { "path": "test/snapshots/multi_client/one_client_rejects_permission_and_both_see_the_result.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Edit protected.txt and replace 'protected' with 'hacked'.\n - role: assistant\n content: I'll help you edit protected.txt to replace 'protected' with 'hacked'. Let me first view the file and then make\n the change.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Editing protected.txt file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/protected.txt\"}'\n" }, { "path": "test/snapshots/multi_client/two_clients_register_different_tools_and_agent_uses_both.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use the city_lookup tool with countryCode 'US' and tell me the result.\n - role: assistant\n content: I'll call the city_lookup tool with the country code 'US' for you.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Looking up city information\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: city_lookup\n arguments: '{\"countryCode\":\"US\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use the city_lookup tool with countryCode 'US' and tell me the result.\n - role: assistant\n content: I'll call the city_lookup tool with the country code 'US' for you.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Looking up city information\"}'\n - id: toolcall_1\n type: function\n function:\n name: city_lookup\n arguments: '{\"countryCode\":\"US\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: CITY_FOR_US\n - role: assistant\n content: The city_lookup tool returned **\"CITY_FOR_US\"** for the country code 'US'.\n - role: user\n content: Now use the currency_lookup tool with countryCode 'US' and tell me the result.\n - role: assistant\n content: I'll call the currency_lookup tool with the country code 'US' for you.\n - role: assistant\n tool_calls:\n - id: toolcall_2\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Looking up currency information\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_3\n type: function\n function:\n name: currency_lookup\n arguments: '{\"countryCode\":\"US\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use the city_lookup tool with countryCode 'US' and tell me the result.\n - role: assistant\n content: I'll call the city_lookup tool with the country code 'US' for you.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Looking up city information\"}'\n - id: toolcall_1\n type: function\n function:\n name: city_lookup\n arguments: '{\"countryCode\":\"US\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: CITY_FOR_US\n - role: assistant\n content: The city_lookup tool returned **\"CITY_FOR_US\"** for the country code 'US'.\n - role: user\n content: Now use the currency_lookup tool with countryCode 'US' and tell me the result.\n - role: assistant\n content: I'll call the currency_lookup tool with the country code 'US' for you.\n tool_calls:\n - id: toolcall_2\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Looking up currency information\"}'\n - id: toolcall_3\n type: function\n function:\n name: currency_lookup\n arguments: '{\"countryCode\":\"US\"}'\n - role: tool\n tool_call_id: toolcall_2\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_3\n content: CURRENCY_FOR_US\n - role: assistant\n content: The currency_lookup tool returned **\"CURRENCY_FOR_US\"** for the country code 'US'.\n" }, { "path": "test/snapshots/multi_turn/should_handle_file_creation_then_reading_across_turns.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Create a file called 'greeting.txt' with the content 'Hello from multi-turn test'.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Creating greeting file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: create\n arguments: '{\"path\":\"${workdir}/greeting.txt\",\"file_text\":\"Hello from multi-turn test\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Create a file called 'greeting.txt' with the content 'Hello from multi-turn test'.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Creating greeting file\"}'\n - id: toolcall_1\n type: function\n function:\n name: create\n arguments: '{\"path\":\"${workdir}/greeting.txt\",\"file_text\":\"Hello from multi-turn test\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: Created file ${workdir}/greeting.txt with 26 characters\n - role: assistant\n content: Created `greeting.txt` with the content \"Hello from multi-turn test\".\n - role: user\n content: Read the file 'greeting.txt' and tell me its exact contents.\n - role: assistant\n tool_calls:\n - id: toolcall_2\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading greeting file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_3\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/greeting.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Create a file called 'greeting.txt' with the content 'Hello from multi-turn test'.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Creating greeting file\"}'\n - id: toolcall_1\n type: function\n function:\n name: create\n arguments: '{\"path\":\"${workdir}/greeting.txt\",\"file_text\":\"Hello from multi-turn test\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: Created file ${workdir}/greeting.txt with 26 characters\n - role: assistant\n content: Created `greeting.txt` with the content \"Hello from multi-turn test\".\n - role: user\n content: Read the file 'greeting.txt' and tell me its exact contents.\n - role: assistant\n tool_calls:\n - id: toolcall_2\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading greeting file\"}'\n - id: toolcall_3\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/greeting.txt\"}'\n - role: tool\n tool_call_id: toolcall_2\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_3\n content: 1. Hello from multi-turn test\n - role: assistant\n content: \"The exact contents of `greeting.txt` are: `Hello from multi-turn test`\"\n" }, { "path": "test/snapshots/multi_turn/should_use_tool_results_from_previous_turns.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the file 'secret.txt' and tell me what the magic number is.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading secret file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/secret.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the file 'secret.txt' and tell me what the magic number is.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading secret file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/secret.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. The magic number is 42.\n - role: assistant\n content: The magic number is **42**.\n - role: user\n content: What is that magic number multiplied by 2?\n - role: assistant\n content: 42 × 2 = **84**\n" }, { "path": "test/snapshots/pending_work_resume/should_continue_parallel_pending_external_tool_requests_after_resume.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Call pending_lookup_a with value 'alpha' and pending_lookup_b with value 'beta', then reply with both results.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: pending_lookup_a\n arguments: '{\"value\":\"alpha\"}'\n - id: toolcall_1\n type: function\n function:\n name: pending_lookup_b\n arguments: '{\"value\":\"beta\"}'\n - role: tool\n tool_call_id: toolcall_1\n content: PARALLEL_B_BETA\n - role: tool\n tool_call_id: toolcall_0\n content: PARALLEL_A_ALPHA\n - role: assistant\n content: |-\n Both lookups completed successfully:\n - **pending_lookup_a** with 'alpha': `PARALLEL_A_ALPHA`\n - **pending_lookup_b** with value 'beta': `PARALLEL_B_BETA`\n" }, { "path": "test/snapshots/pending_work_resume/should_continue_pending_external_tool_request_after_resume.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use resume_external_tool with value 'beta', then reply with the result.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: resume_external_tool\n arguments: '{\"value\":\"beta\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: EXTERNAL_RESUMED_BETA\n - role: assistant\n content: |-\n I called `resume_external_tool` with the value 'beta' and received the result:\n\n **EXTERNAL_RESUMED_BETA**\n" }, { "path": "test/snapshots/pending_work_resume/should_continue_pending_permission_request_after_resume.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use resume_permission_tool with value 'alpha', then reply with the result.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: resume_permission_tool\n arguments: '{\"value\":\"alpha\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: PERMISSION_RESUMED_ALPHA\n - role: assistant\n content: |-\n I called `resume_permission_tool` with the value 'alpha' and received the result:\n\n **PERMISSION_RESUMED_ALPHA**\n" }, { "path": "test/snapshots/pending_work_resume/should_resume_successfully_when_no_pending_work_exists.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: \"Reply with exactly: NO_PENDING_TURN_ONE\"\n - role: assistant\n content: NO_PENDING_TURN_ONE\n - role: user\n content: \"Reply with exactly: NO_PENDING_TURN_TWO\"\n - role: assistant\n content: NO_PENDING_TURN_TWO\n" }, { "path": "test/snapshots/permissions/async_permission_handler.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'echo test' and tell me what happens\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running echo command\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"echo test\",\"description\":\"Run echo test command\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'echo test' and tell me what happens\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running echo command\"}'\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"echo test\",\"description\":\"Run echo test command\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: |-\n test\n \n - role: assistant\n content: The command successfully executed and outputted \"test\" to the console, then exited with code 0 (indicating\n success).\n" }, { "path": "test/snapshots/permissions/deny_permission.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Edit protected.txt and replace 'protected' with 'hacked'.\n - role: assistant\n content: I'll help you edit the protected.txt file to replace 'protected' with 'hacked'.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Editing protected.txt file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/protected.txt\"}'\n" }, { "path": "test/snapshots/permissions/permission_handler_errors.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'echo test'. If you can't, say 'failed'.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running echo command\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"echo test\",\"description\":\"Run echo test\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'echo test'. If you can't, say 'failed'.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running echo command\"}'\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"echo test\",\"description\":\"Run echo test\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: Permission denied and could not request permission from user\n - role: assistant\n content: failed\n" }, { "path": "test/snapshots/permissions/permission_handler_for_shell_commands.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'echo hello' and tell me the output\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running echo command\"}'\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"echo hello\",\"description\":\"Run echo hello\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: |-\n hello\n \n - role: assistant\n content: The output is `hello`.\n" }, { "path": "test/snapshots/permissions/permission_handler_for_write_operations.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Edit test.txt and replace 'original' with 'modified'\n - role: assistant\n content: I'll view the file first to see its contents, then make the replacement.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Editing test.txt file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/test.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Edit test.txt and replace 'original' with 'modified'\n - role: assistant\n content: I'll view the file first to see its contents, then make the replacement.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Editing test.txt file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/test.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. original content\n - role: assistant\n tool_calls:\n - id: toolcall_2\n type: function\n function:\n name: edit\n arguments: '{\"path\":\"${workdir}/test.txt\",\"old_str\":\"original content\",\"new_str\":\"modified content\"}'\n - role: tool\n tool_call_id: toolcall_2\n content: File ${workdir}/test.txt updated with changes.\n - role: assistant\n content: Done! I've replaced 'original' with 'modified' in test.txt.\n" }, { "path": "test/snapshots/permissions/resume_session_with_permission_handler.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1+1 equals 2.\n - role: user\n content: Run 'echo resumed' for me\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running echo command\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"echo resumed\",\"description\":\"Run echo resumed\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1+1 equals 2.\n - role: user\n content: Run 'echo resumed' for me\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running echo command\"}'\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"echo resumed\",\"description\":\"Run echo resumed\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: |-\n resumed\n \n - role: assistant\n content: 'Command executed successfully - output: \"resumed\"'\n" }, { "path": "test/snapshots/permissions/should_deny_permission_when_handler_returns_denied.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Edit protected.txt and replace 'protected' with 'hacked'.\n - role: assistant\n content: I'll view the file first, then make the edit.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Editing protected.txt file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/protected.txt\"}'\n" }, { "path": "test/snapshots/permissions/should_deny_tool_operations_when_handler_explicitly_denies.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'node --version'\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Checking Node.js version\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"node --version\",\"description\":\"Check Node.js version\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'node --version'\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Checking Node.js version\"}'\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"node --version\",\"description\":\"Check Node.js version\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: Permission denied and could not request permission from user\n - role: assistant\n content: Permission was denied to run the command. This may be due to security policies or execution restrictions in the\n current environment.\n" }, { "path": "test/snapshots/permissions/should_deny_tool_operations_when_handler_explicitly_denies_after_resume.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1+1 equals 2.\n - role: user\n content: Run 'node --version'\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Checking Node.js version\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"node --version\",\"description\":\"Check Node.js version\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1+1 equals 2.\n - role: user\n content: Run 'node --version'\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Checking Node.js version\"}'\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"node --version\",\"description\":\"Check Node.js version\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: Permission denied and could not request permission from user\n - role: assistant\n content: The command was denied due to insufficient permissions. You'll need to grant permission to run commands in this\n session.\n" }, { "path": "test/snapshots/permissions/should_handle_async_permission_handler.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'echo test' and tell me what happens\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running echo command\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"echo test\",\"description\":\"Run echo test\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'echo test' and tell me what happens\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running echo command\"}'\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"echo test\",\"description\":\"Run echo test\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: |-\n test\n \n - role: assistant\n content: The command successfully executed and printed \"test\" to the console, then exited with exit code 0 (indicating\n success).\n" }, { "path": "test/snapshots/permissions/should_handle_permission_handler_errors_gracefully.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'echo test'. If you can't, say 'failed'.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running echo command\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"echo test\",\"description\":\"Run echo test\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'echo test'. If you can't, say 'failed'.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running echo command\"}'\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"echo test\",\"description\":\"Run echo test\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: Permission denied and could not request permission from user\n - role: assistant\n content: failed\n" }, { "path": "test/snapshots/permissions/should_invoke_permission_handler_for_write_operations.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Edit test.txt and replace 'original' with 'modified'\n - role: assistant\n content: I'll view the file first to see its contents, then make the replacement.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Editing test.txt file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/test.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Edit test.txt and replace 'original' with 'modified'\n - role: assistant\n content: I'll view the file first to see its contents, then make the replacement.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Editing test.txt file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/test.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. original content\n - role: assistant\n tool_calls:\n - id: toolcall_2\n type: function\n function:\n name: edit\n arguments: '{\"new_str\":\"modified content\",\"old_str\":\"original content\",\"path\":\"${workdir}/test.txt\"}'\n - role: tool\n tool_call_id: toolcall_2\n content: File ${workdir}/test.txt updated with changes.\n - role: assistant\n content: Done! I've replaced 'original' with 'modified' in test.txt. The file now contains \"modified content\".\n" }, { "path": "test/snapshots/permissions/should_receive_toolcallid_in_permission_requests.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'echo test'\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running echo command\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"echo test\",\"description\":\"Run echo test\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'echo test'\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running echo command\"}'\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"echo test\",\"description\":\"Run echo test\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: |-\n test\n \n - role: assistant\n content: Command executed successfully, output is \"test\".\n" }, { "path": "test/snapshots/permissions/should_resume_session_with_permission_handler.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1+1 = 2\n - role: user\n content: Run 'echo resumed' for me\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running echo command\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"description\":\"Run echo resumed\",\"command\":\"echo resumed\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1+1 = 2\n - role: user\n content: Run 'echo resumed' for me\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running echo command\"}'\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"description\":\"Run echo resumed\",\"command\":\"echo resumed\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: |-\n resumed\n \n - role: assistant\n content: \"The command executed successfully and output: **resumed**\"\n" }, { "path": "test/snapshots/permissions/should_work_with_approve_all_permission_handler.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 2+2?\n - role: assistant\n content: 2+2 = 4\n" }, { "path": "test/snapshots/permissions/tool_call_id_in_permission_requests.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'echo test'\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running echo command\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"echo test\",\"description\":\"Run echo test\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'echo test'\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running echo command\"}'\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"echo test\",\"description\":\"Run echo test\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: |-\n test\n \n - role: assistant\n content: \"The command executed successfully and output: `test`\"\n" }, { "path": "test/snapshots/rpc_session_state/should_compact_session_history_after_messages.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 2+2?\n - role: assistant\n content: 2+2 = 4\n - role: user\n content: ${compaction_prompt}\n - role: assistant\n content: >-\n \n\n The user asked a simple arithmetic question (2+2) which was answered directly. No code work, file\n modifications, or technical tasks were requested or performed. This was a basic informational query with no\n follow-up work required.\n\n \n\n\n \n\n 1. The user asked \"What is 2+2?\"\n - Provided the answer: 4\n - No further actions or requests were made\n \n\n\n \n\n No work was performed. The conversation consisted solely of answering a basic arithmetic question. No files\n were created, modified, or deleted. No code changes, configurations, or technical tasks were executed.\n\n \n\n\n \n\n No technical work was performed, so there are no technical details, decisions, or discoveries to document.\n\n \n\n\n \n\n No files were involved in this conversation.\n\n \n\n\n \n\n No pending work. The user's question was answered completely, and no follow-up tasks were requested or\n identified.\n\n \n\n\n Answered arithmetic question\n" }, { "path": "test/snapshots/rpc_session_state/should_fork_session_with_persisted_messages.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say FORK_SOURCE_ALPHA exactly.\n - role: assistant\n content: FORK_SOURCE_ALPHA\n - role: user\n content: Now say FORK_CHILD_BETA exactly.\n - role: assistant\n content: FORK_CHILD_BETA\n" }, { "path": "test/snapshots/rpc_shell_and_fleet/should_start_fleet_and_complete_custom_tool_task.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: >-\n You are now in fleet mode. Dispatch sub-agents (via the task tool) in parallel to do the work.\n\n\n **Getting Started**\n\n 1. Check for existing todos: `SELECT id, title, status FROM todos WHERE status != 'done'`\n\n 2. If todos exist, dispatch them in parallel (respecting dependencies)\n\n 3. If no todos exist, help decompose the work into todos first. Try to structure todos to minimize\n dependencies and maximize parallel execution.\n\n\n **Parallel Execution**\n\n - Dispatch independent todos simultaneously\n\n - Never dispatch just a single background subagent. Prefer one sync subagent, or better, prefer to efficiently\n dispatch multiple background subagents in the same turn.\n\n - Only serialize todos with true dependencies (check todo_deps)\n\n - Query ready todos: `SELECT * FROM todos WHERE status = 'pending' AND id NOT IN (SELECT todo_id FROM\n todo_deps td JOIN todos t ON td.depends_on = t.id WHERE t.status != 'done')`\n\n\n **Sub-Agent Instructions**\n\n When dispatching a sub-agent, include these instructions in your prompt:\n\n 1. Update the todo status when finished:\n - Success: `UPDATE todos SET status = 'done' WHERE id = ''`\n - Blocked: `UPDATE todos SET status = 'blocked' WHERE id = ''`\n 2. Always return a response summarizing:\n - What was completed\n - Whether the todo is fully done or needs more work\n - Any blockers or questions that need resolution\n\n **Coordination**\n\n - After sub-agents return, check todo status in SQL (source of truth)\n\n - If status is still 'in_progress', the sub-agent may have failed to update - investigate\n\n - Use the sub-agent's response to understand context, but trust SQL for status\n\n\n **After Sub-Agents Complete**\n\n - Check the work done by sub-agents and validate the original request is fully satisfied\n\n - Ensure the work done by sub-agents (both implementation and testing) is sensible, robust, and handles edge\n cases, not just the happy path\n\n - If the original request is not fully satisfied, decompose remaining work into new todos and dispatch more\n sub-agents as needed\n\n\n Now proceed with the user's request using fleet mode.\n\n\n User request: Use the record_fleet_completion tool with content 'copilot-sdk-fleet-rpc', then report that the\n fleet task is complete.\n - role: assistant\n content: I'll complete this fleet validation task by using the record_fleet_completion tool.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Recording fleet completion\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: record_fleet_completion\n arguments: '{\"content\":\"copilot-sdk-fleet-rpc\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: >-\n You are now in fleet mode. Dispatch sub-agents (via the task tool) in parallel to do the work.\n\n\n **Getting Started**\n\n 1. Check for existing todos: `SELECT id, title, status FROM todos WHERE status != 'done'`\n\n 2. If todos exist, dispatch them in parallel (respecting dependencies)\n\n 3. If no todos exist, help decompose the work into todos first. Try to structure todos to minimize\n dependencies and maximize parallel execution.\n\n\n **Parallel Execution**\n\n - Dispatch independent todos simultaneously\n\n - Never dispatch just a single background subagent. Prefer one sync subagent, or better, prefer to efficiently\n dispatch multiple background subagents in the same turn.\n\n - Only serialize todos with true dependencies (check todo_deps)\n\n - Query ready todos: `SELECT * FROM todos WHERE status = 'pending' AND id NOT IN (SELECT todo_id FROM\n todo_deps td JOIN todos t ON td.depends_on = t.id WHERE t.status != 'done')`\n\n\n **Sub-Agent Instructions**\n\n When dispatching a sub-agent, include these instructions in your prompt:\n\n 1. Update the todo status when finished:\n - Success: `UPDATE todos SET status = 'done' WHERE id = ''`\n - Blocked: `UPDATE todos SET status = 'blocked' WHERE id = ''`\n 2. Always return a response summarizing:\n - What was completed\n - Whether the todo is fully done or needs more work\n - Any blockers or questions that need resolution\n\n **Coordination**\n\n - After sub-agents return, check todo status in SQL (source of truth)\n\n - If status is still 'in_progress', the sub-agent may have failed to update - investigate\n\n - Use the sub-agent's response to understand context, but trust SQL for status\n\n\n **After Sub-Agents Complete**\n\n - Check the work done by sub-agents and validate the original request is fully satisfied\n\n - Ensure the work done by sub-agents (both implementation and testing) is sensible, robust, and handles edge\n cases, not just the happy path\n\n - If the original request is not fully satisfied, decompose remaining work into new todos and dispatch more\n sub-agents as needed\n\n\n Now proceed with the user's request using fleet mode.\n\n\n User request: Use the record_fleet_completion tool with content 'copilot-sdk-fleet-rpc', then report that the\n fleet task is complete.\n - role: assistant\n content: I'll complete this fleet validation task by using the record_fleet_completion tool.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Recording fleet completion\"}'\n - id: toolcall_1\n type: function\n function:\n name: record_fleet_completion\n arguments: '{\"content\":\"copilot-sdk-fleet-rpc\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: copilot-sdk-fleet-rpc\n - role: assistant\n content: |-\n ✅ **Fleet task complete!** \n\n I've successfully recorded the fleet completion with content 'copilot-sdk-fleet-rpc'. The validation is done.\n" }, { "path": "test/snapshots/session/disposeasync_from_handler_does_not_deadlock.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1+1 = 2\n" }, { "path": "test/snapshots/session/handler_exception_does_not_halt_event_delivery.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1+1 = 2\n" }, { "path": "test/snapshots/session/send_returns_immediately_while_events_stream_in_background.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'sleep 2 && echo done'\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running command\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"sleep 2 && echo done\",\"description\":\"Run sleep and echo\n command\",\"initial_wait\":5,\"mode\":\"sync\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'sleep 2 && echo done'\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running command\"}'\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"sleep 2 && echo done\",\"description\":\"Run sleep and echo\n command\",\"initial_wait\":5,\"mode\":\"sync\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: |-\n done\n \n - role: assistant\n content: The command completed successfully, waiting 2 seconds before echoing \"done\".\n" }, { "path": "test/snapshots/session/sendandwait_blocks_until_session_idle_and_returns_final_assistant_message.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 2+2?\n - role: assistant\n content: 2 + 2 = 4\n" }, { "path": "test/snapshots/session/sendandwait_throws_on_timeout.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'sleep 2 && echo done'\n" }, { "path": "test/snapshots/session/sendandwait_throws_operationcanceledexception_when_token_cancelled.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: run the shell command 'sleep 10' (note this works on both bash and PowerShell)\n - role: assistant\n content: I'll run the sleep command for you.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running sleep command\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"sleep 10\",\"description\":\"Execute sleep 10 command\",\"initial_wait\":15,\"mode\":\"sync\"}'\n" }, { "path": "test/snapshots/session/should_abort_a_session.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: run the shell command 'sleep 100' (note this works on both bash and PowerShell)\n - role: assistant\n content: I'll run the sleep command for 100 seconds.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running sleep command\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"sleep 100\",\"description\":\"Run sleep 100 command\",\"mode\":\"sync\",\"initial_wait\":105}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: run the shell command 'sleep 100' (note this works on both bash and PowerShell)\n - role: assistant\n content: I'll run the sleep command for 100 seconds.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Running sleep command\"}'\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"sleep 100\",\"description\":\"Run sleep 100 command\",\"mode\":\"sync\",\"initial_wait\":105}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: The execution of this tool, or a previous tool was interrupted.\n - role: user\n content: What is 2+2?\n - role: assistant\n content: \"4\"\n" }, { "path": "test/snapshots/session/should_accept_blob_attachments.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: |-\n Describe this image\n test-pixel.png\n [image]\n - role: assistant\n content: I'll view the image file to describe it for you.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Viewing image file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/test-pixel.png\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: |-\n Describe this image\n test-pixel.png\n [image]\n - role: assistant\n content: I'll view the image file to describe it for you.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Viewing image file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/test-pixel.png\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: Viewed image file successfully.\n - role: user\n content: |-\n Image file at path ${workdir}/test-pixel.png\n [image]\n - role: assistant\n content: >-\n This is an extremely small image - it appears to be essentially a **single white pixel** or a very tiny white\n square on a transparent background. The image is minimal in size and content, likely just a few pixels in\n dimension. It's the kind of test image that might be used for:\n\n\n - Testing image loading/rendering functionality\n\n - Placeholder purposes\n\n - Minimal file size requirements\n\n - Image processing pipeline validation\n\n\n The file name \"test-pixel.png\" confirms this is indeed a test image consisting of just a single pixel or very\n small pixel cluster.\n" }, { "path": "test/snapshots/session/should_create_a_session_with_appended_systemmessage_config.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is your full name?\n - role: assistant\n content: >-\n I am the GitHub Copilot CLI, a terminal assistant built by GitHub. I'm an interactive command-line tool\n designed to help with software engineering tasks.\n\n\n Have a nice day!\n" }, { "path": "test/snapshots/session/should_create_a_session_with_availabletools.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1 + 1 = 2\n" }, { "path": "test/snapshots/session/should_create_a_session_with_customized_systemmessage_config.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Who are you?\n - role: assistant\n content: >-\n I'm **GitHub Copilot CLI**, a terminal assistant built by GitHub. I'm powered by claude-sonnet-4.5 (model ID:\n claude-sonnet-4.5).\n\n\n I'm here to help you with software engineering tasks, including:\n\n - Writing, debugging, and refactoring code\n\n - Running commands and managing development workflows\n\n - Exploring codebases and understanding how things work\n\n - Setting up projects, installing dependencies, and configuring tools\n\n - Working with Git, testing, and deployment tasks\n\n - Planning and implementing features\n\n\n I have access to a variety of tools including file operations, shell commands, code search, and specialized\n sub-agents for specific tasks. I can work with multiple languages and frameworks, and I'm designed to be\n efficient by running tasks in parallel when possible.\n\n\n How can I help you today?\n" }, { "path": "test/snapshots/session/should_create_a_session_with_defaultagent_excludedtools.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1 + 1 = 2\n" }, { "path": "test/snapshots/session/should_create_a_session_with_excludedtools.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1 + 1 = 2\n" }, { "path": "test/snapshots/session/should_create_a_session_with_replaced_systemmessage_config.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is your full name?\n - role: assistant\n content: My full name is **Testy McTestface**.\n" }, { "path": "test/snapshots/session/should_create_session_with_custom_config_dir.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1 + 1 = 2\n" }, { "path": "test/snapshots/session/should_create_session_with_custom_tool.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is the secret number for key ALPHA?\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: get_secret_number\n arguments: '{\"key\":\"ALPHA\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: \"54321\"\n - role: assistant\n content: The secret number for key ALPHA is **54321**.\n" }, { "path": "test/snapshots/session/should_delete_session.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Hello\n - role: assistant\n content: Hello! I'm GitHub Copilot CLI, your terminal assistant. I can help you with software engineering tasks like\n exploring code, making changes, running tests, debugging, and more. What would you like to work on?\n" }, { "path": "test/snapshots/session/should_get_last_session_id.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say hello\n - role: assistant\n content: Hello! I'm GitHub Copilot CLI, ready to help with your software engineering tasks.\n" }, { "path": "test/snapshots/session/should_get_session_metadata.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say hello\n - role: assistant\n content: Hello! I'm GitHub Copilot CLI, ready to help you with your software engineering tasks. What can I assist you\n with today?\n" }, { "path": "test/snapshots/session/should_get_session_metadata_by_id.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say hello\n - role: assistant\n content: Hello! I'm GitHub Copilot CLI, ready to help you with your software engineering tasks. What can I assist you\n with today?\n" }, { "path": "test/snapshots/session/should_have_stateful_conversation.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1+1 = 2\n - role: user\n content: Now if you double that, what do you get?\n - role: assistant\n content: 2 doubled is 4.\n" }, { "path": "test/snapshots/session/should_list_sessions.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say hello\n - role: assistant\n content: Hello! I'm GitHub Copilot CLI, ready to help you with your software engineering tasks. What can I assist you\n with today?\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say goodbye\n - role: assistant\n content: Goodbye! Feel free to return anytime you need help. 👋\n" }, { "path": "test/snapshots/session/should_list_sessions_with_context.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say OK.\n - role: assistant\n content: OK.\n" }, { "path": "test/snapshots/session/should_receive_session_events.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 100+200?\n - role: assistant\n content: 100 + 200 = 300\n" }, { "path": "test/snapshots/session/should_resume_a_session_using_a_new_client.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1 + 1 = 2\n - role: user\n content: Now if you double that, what do you get?\n - role: assistant\n content: 2 doubled is 4.\n" }, { "path": "test/snapshots/session/should_resume_a_session_using_the_same_client.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1 + 1 = 2\n - role: user\n content: Now if you double that, what do you get?\n - role: assistant\n content: If you double 2, you get 4.\n" }, { "path": "test/snapshots/session/should_send_with_custom_requestheaders.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1+1 equals 2.\n" }, { "path": "test/snapshots/session/should_send_with_directory_attachment.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: |-\n List the attached directory.\n\n\n\n \n * ${workdir}/attached-directory (1 items)\n \n - role: assistant\n content: I'll list the contents of the attached directory for you.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Listing directory contents\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/attached-directory\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: |-\n List the attached directory.\n\n\n\n \n * ${workdir}/attached-directory (1 items)\n \n - role: assistant\n content: I'll list the contents of the attached directory for you.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Listing directory contents\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/attached-directory\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: readme.txt\n - role: assistant\n content: |-\n The attached directory contains a single file: **readme.txt**\n\n Would you like me to view its contents?\n" }, { "path": "test/snapshots/session/should_send_with_file_attachment.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: |-\n Read the attached file and reply with its contents.\n\n\n\n \n * ${workdir}/attached-file.txt (line 1 of 1 lines)\n \n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading attached file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/attached-file.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: |-\n Read the attached file and reply with its contents.\n\n\n\n \n * ${workdir}/attached-file.txt (line 1 of 1 lines)\n \n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading attached file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/attached-file.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. FILE_ATTACHMENT_SENTINEL\n - role: assistant\n content: |-\n The attached file contains:\n\n ```\n FILE_ATTACHMENT_SENTINEL\n ```\n" }, { "path": "test/snapshots/session/should_send_with_github_reference_attachment.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: |-\n Summarize the referenced issue.\n\n\n\n \n #1234 - Add E2E attachment coverage [issue] [open] (https://github.com/github/copilot-sdk/issues/1234)\n \n - role: assistant\n content: \"I'll fetch the details of issue #1234 from the GitHub repository.\"\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Fetching GitHub issue details\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"gh issue view 1234 --repo github/copilot-sdk --json\n title,body,labels,state,author,createdAt\",\"description\":\"Fetch issue #1234 details\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: |-\n Summarize the referenced issue.\n\n\n\n \n #1234 - Add E2E attachment coverage [issue] [open] (https://github.com/github/copilot-sdk/issues/1234)\n \n - role: assistant\n content: \"I'll fetch the details of issue #1234 from the GitHub repository.\"\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Fetching GitHub issue details\"}'\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"gh issue view 1234 --repo github/copilot-sdk --json\n title,body,labels,state,author,createdAt\",\"description\":\"Fetch issue #1234 details\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: |-\n ${gh_auth_required}\n \n - role: assistant\n content: I don't have GitHub authentication configured, so I'll use the web fetch tool to access the issue directly.\n - role: assistant\n tool_calls:\n - id: toolcall_2\n type: function\n function:\n name: web_fetch\n arguments: '{\"max_length\":10000,\"url\":\"https://github.com/github/copilot-sdk/issues/1234\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: |-\n Summarize the referenced issue.\n\n\n\n \n #1234 - Add E2E attachment coverage [issue] [open] (https://github.com/github/copilot-sdk/issues/1234)\n \n - role: assistant\n content: \"I'll fetch the details of issue #1234 from the GitHub repository.\"\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Fetching GitHub issue details\"}'\n - id: toolcall_1\n type: function\n function:\n name: ${shell}\n arguments: '{\"command\":\"gh issue view 1234 --repo github/copilot-sdk --json\n title,body,labels,state,author,createdAt\",\"description\":\"Fetch issue #1234 details\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: |-\n ${gh_auth_required}\n \n - role: assistant\n content: I don't have GitHub authentication configured, so I'll use the web fetch tool to access the issue directly.\n tool_calls:\n - id: toolcall_2\n type: function\n function:\n name: web_fetch\n arguments: '{\"max_length\":10000,\"url\":\"https://github.com/github/copilot-sdk/issues/1234\"}'\n - role: tool\n tool_call_id: toolcall_2\n content: \"Failed to fetch https://github.com/github/copilot-sdk/issues/1234: Error: Failed to fetch\n https://github.com/github/copilot-sdk/issues/1234 - status code 404\"\n - role: assistant\n content: >-\n Based on the GitHub reference provided, here's what I can tell you about issue #1234:\n\n\n **Issue #1234: Add E2E attachment coverage**\n\n - **Status:** Open\n\n - **Repository:** github/copilot-sdk\n\n - **Link:** https://github.com/github/copilot-sdk/issues/1234\n\n\n The issue is about adding end-to-end (E2E) test coverage for attachment functionality in the Copilot SDK.\n While I cannot access the full details without authentication, the title suggests this is a testing task to\n ensure attachment features are properly covered by automated end-to-end tests.\n\n\n Would you like me to help with implementing E2E tests for attachments, or would you like to provide more\n context about this issue?\n" }, { "path": "test/snapshots/session/should_send_with_mode_property.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say mode ok.\n - role: assistant\n content: Mode ok.\n" }, { "path": "test/snapshots/session/should_send_with_selection_attachment.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: |-\n \n The user has the following text selected in their IDE. This may or may not be related to their request.\n File: selected-file.cs (line 2)\n ```\n string Value = \"SELECTION_SENTINEL\";\n ```\n \n\n\n\n Summarize the selected code.\n - role: assistant\n content: >-\n This is a C# variable declaration that creates a string variable named `Value` and initializes it with the\n string literal `\"SELECTION_SENTINEL\"`.\n\n\n The code declares a local or field variable of type `string` with the identifier `Value` and assigns it the\n text \"SELECTION_SENTINEL\" as its initial value.\n" }, { "path": "test/snapshots/session/should_set_model_on_existing_session.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'sleep 2 && echo done'\n" }, { "path": "test/snapshots/session/should_set_model_with_reasoningeffort.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Run 'sleep 2 && echo done'\n" }, { "path": "test/snapshots/session_config/should_accept_blob_attachments.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: |-\n What color is this pixel? Reply in one word.\n pixel.png\n [image]\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/pixel.png\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Viewed image file successfully.\n - role: user\n content: |-\n Image file at path ${workdir}/pixel.png\n [image]\n - role: assistant\n content: Red\n" }, { "path": "test/snapshots/session_config/should_accept_message_attachments.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: |-\n Summarize the attached file\n\n\n\n \n * ${workdir}/attached.txt (1 lines)\n \n - role: assistant\n content: I'll read the attached file and summarize it for you.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading attached file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/attached.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: |-\n Summarize the attached file\n\n\n\n \n * ${workdir}/attached.txt (1 lines)\n \n - role: assistant\n content: I'll read the attached file and summarize it for you.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading attached file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/attached.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. This file is attached\n - role: assistant\n content: The attached file contains a single line of text that simply states \"This file is attached\" - it's a minimal\n test file confirming its attachment status.\n" }, { "path": "test/snapshots/session_config/should_apply_availabletools_on_session_resume.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1 + 1 = 2\n" }, { "path": "test/snapshots/session_config/should_apply_systemmessage_on_session_resume.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1 + 1 = 2. RESUME_SYSTEM_MESSAGE_SENTINEL.\n" }, { "path": "test/snapshots/session_config/should_apply_workingdirectory_on_session_resume.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the file resume-marker.txt and tell me what it says\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/resume-subproject/resume-marker.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. I am in the resume working directory\n - role: assistant\n content: |-\n The file `resume-marker.txt` says:\n\n ```\n I am in the resume working directory\n ```\n" }, { "path": "test/snapshots/session_config/should_forward_clientname_in_user_agent.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1+1 equals 2.\n" }, { "path": "test/snapshots/session_config/should_forward_clientname_in_useragent.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1 + 1 = 2\n" }, { "path": "test/snapshots/session_config/should_forward_custom_provider_headers_on_create.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1?\n - role: assistant\n content: 1 + 1 = 2\n" }, { "path": "test/snapshots/session_config/should_forward_custom_provider_headers_on_resume.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 2+2?\n - role: assistant\n content: 2 + 2 = 4\n" }, { "path": "test/snapshots/session_config/should_use_workingdirectory_for_tool_execution.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the file marker.txt and tell me what it says\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/subproject/marker.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the file marker.txt and tell me what it says\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/subproject/marker.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. I am in the subdirectory\n - role: assistant\n content: 'The file marker.txt says: \"I am in the subdirectory\"'\n" }, { "path": "test/snapshots/session_config/vision_disabled_then_enabled_via_setmodel.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use the view tool to look at the file test.png and describe what you see\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Viewing image file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/test.png\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use the view tool to look at the file test.png and describe what you see\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Viewing image file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/test.png\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: Viewed image file successfully.\n - role: assistant\n content: The image shows **GitHub's Octocat mascot** - a cat with octopus tentacles wearing a smile. It's a simple,\n monochromatic illustration (gray/black on white background) of GitHub's iconic logo character.\n - role: user\n content: Use the view tool to look at the file test.png and describe what you see\n - role: assistant\n tool_calls:\n - id: toolcall_2\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Viewing image file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_3\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/test.png\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use the view tool to look at the file test.png and describe what you see\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Viewing image file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/test.png\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: Viewed image file successfully.\n - role: assistant\n content: The image shows **GitHub's Octocat mascot** - a cat with octopus tentacles wearing a smile. It's a simple,\n monochromatic illustration (gray/black on white background) of GitHub's iconic logo character.\n - role: user\n content: Use the view tool to look at the file test.png and describe what you see\n - role: assistant\n tool_calls:\n - id: toolcall_2\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Viewing image file\"}'\n - id: toolcall_3\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/test.png\"}'\n - role: tool\n tool_call_id: toolcall_2\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_3\n content: Viewed image file successfully.\n - role: user\n content: |-\n Image file at path ${workdir}/test.png\n [image]\n - role: assistant\n content: >-\n You're right to show me the actual image! Looking at it now, I can see that **test.png is essentially a blank\n or nearly blank white image**. There's no Octocat or any other visible content - it appears to be just an\n empty white/very light colored image.\n\n\n I apologize for my previous incorrect description. The image file doesn't contain any discernible graphics or\n text.\n" }, { "path": "test/snapshots/session_config/vision_enabled_then_disabled_via_setmodel.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use the view tool to look at the file test.png and describe what you see\n - role: assistant\n content: I'll use the view tool to examine the test.png file.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Viewing image file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/test.png\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use the view tool to look at the file test.png and describe what you see\n - role: assistant\n content: I'll use the view tool to examine the test.png file.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Viewing image file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/test.png\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: Viewed image file successfully.\n - role: user\n content: |-\n Image file at path ${workdir}/test.png\n [image]\n - role: assistant\n content: The image appears to be a small, blank or nearly blank white/light-colored rectangle. There's no visible text,\n graphics, or distinct content in the image - it's essentially an empty or placeholder image file. The\n dimensions appear quite small, and it could be used as a test file or placeholder in a project.\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use the view tool to look at the file test.png and describe what you see\n - role: assistant\n content: I'll use the view tool to examine the test.png file.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Viewing image file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/test.png\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: Viewed image file successfully.\n - role: assistant\n content: The image appears to be a small, blank or nearly blank white/light-colored rectangle. There's no visible text,\n graphics, or distinct content in the image - it's essentially an empty or placeholder image file. The\n dimensions appear quite small, and it could be used as a test file or placeholder in a project.\n - role: user\n content: Use the view tool to look at the file test.png and describe what you see\n - role: assistant\n content: I'll view the test.png file again for you.\n - role: assistant\n tool_calls:\n - id: toolcall_2\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Viewing image file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_3\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/test.png\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use the view tool to look at the file test.png and describe what you see\n - role: assistant\n content: I'll use the view tool to examine the test.png file.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Viewing image file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/test.png\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: Viewed image file successfully.\n - role: assistant\n content: The image appears to be a small, blank or nearly blank white/light-colored rectangle. There's no visible text,\n graphics, or distinct content in the image - it's essentially an empty or placeholder image file. The\n dimensions appear quite small, and it could be used as a test file or placeholder in a project.\n - role: user\n content: Use the view tool to look at the file test.png and describe what you see\n - role: assistant\n content: I'll view the test.png file again for you.\n tool_calls:\n - id: toolcall_2\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Viewing image file\"}'\n - id: toolcall_3\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/test.png\"}'\n - role: tool\n tool_call_id: toolcall_2\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_3\n content: Viewed image file successfully.\n - role: assistant\n content: The image shows a small, blank white or very light-colored rectangle. There's no visible content, text,\n graphics, or imagery - it appears to be an empty or placeholder PNG file. It's likely used as a test file\n given its name \"test.png\".\n" }, { "path": "test/snapshots/session_fs/should_load_session_data_from_fs_provider_on_resume.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 50 + 50?\n - role: assistant\n content: 50 + 50 = 100\n - role: user\n content: What is that times 3?\n - role: assistant\n content: 100 × 3 = 300\n" }, { "path": "test/snapshots/session_fs/should_map_large_output_handling_into_sessionfs.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Call the get_big_string tool and reply with the word DONE only.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: get_big_string\n arguments: \"{}\"\n - role: tool\n tool_call_id: toolcall_0\n content: |-\n Output too large to read at once (97.7 KB). Saved to: /session-state/temp/PLACEHOLDER-copilot-tool-output-PLACEHOLDER\n Consider using tools like grep (for searching), head/tail (for viewing start/end), view with view_range (for specific sections), or jq (for JSON) to examine portions of the output.\n\n Preview (first 500 chars):\n xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n - role: assistant\n content: DONE\n" }, { "path": "test/snapshots/session_fs/should_persist_plan_md_via_sessionfs.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 2 + 3?\n - role: assistant\n content: 2 + 3 = 5\n" }, { "path": "test/snapshots/session_fs/should_reject_setprovider_when_sessions_already_exist.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Hello\n - role: assistant\n content: Hello! How can I help you today?\n" }, { "path": "test/snapshots/session_fs/should_route_file_operations_through_the_session_fs_provider.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 100 + 200?\n - role: assistant\n content: 100 + 200 = 300\n" }, { "path": "test/snapshots/session_fs/should_succeed_with_compaction_while_using_sessionfs.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 2+2?\n - role: assistant\n content: 2 + 2 = 4\n - role: user\n content: ${compaction_prompt}\n - role: assistant\n content: >-\n \n\n The user asked a simple arithmetic question (2+2), which was answered directly. No technical work, file\n modifications, or coding tasks were requested or performed. This was a brief, non-technical exchange.\n\n \n\n\n \n\n 1. The user asked \"What is 2+2?\"\n - Provided the answer: 4\n - No follow-up work was requested\n \n\n\n \n\n No files were created, modified, or deleted.\n\n\n Work completed:\n\n - [x] Answered arithmetic question\n\n\n Current state: No active work or pending tasks.\n\n \n\n\n \n\n No technical work was performed. No issues encountered, no architectural decisions made, and no code-related\n discoveries.\n\n \n\n\n \n\n No files were involved in this conversation.\n\n \n\n\n \n\n No pending work. The user's question was fully addressed.\n\n \n\n\n Answered basic math question\n" }, { "path": "test/snapshots/session_fs/should_write_workspace_metadata_via_sessionfs.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 7 * 8?\n - role: assistant\n content: 7 * 8 = 56\n" }, { "path": "test/snapshots/session_lifecycle/should_delete_session_permanently.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say hi\n - role: assistant\n content: Hi! I'm GitHub Copilot CLI, ready to help with your software engineering tasks. What would you like to work on?\n" }, { "path": "test/snapshots/session_lifecycle/should_list_created_sessions_after_sending_a_message.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say hello\n - role: assistant\n content: Hello! I'm GitHub Copilot CLI, ready to help you with software engineering tasks. What can I assist you with\n today?\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say world\n - role: assistant\n content: world\n" }, { "path": "test/snapshots/session_lifecycle/should_return_events_via_getmessages_after_conversation.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 2+2? Reply with just the number.\n - role: assistant\n content: \"4\"\n" }, { "path": "test/snapshots/session_lifecycle/should_support_multiple_concurrent_sessions.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 1+1? Reply with just the number.\n - role: assistant\n content: \"2\"\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 3+3? Reply with just the number.\n - role: assistant\n content: \"6\"\n" }, { "path": "test/snapshots/skills/should_allow_agent_with_skills_to_invoke_skill.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say hello briefly using the test skill.\n - role: assistant\n content: Hello! PINEAPPLE_COCONUT_42 - I'm ready to help you with your tasks today.\n" }, { "path": "test/snapshots/skills/should_load_and_apply_skill_from_skilldirectories.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say hello briefly using the test skill.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: skill\n arguments: '{\"skill\":\"test-skill\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Skill \"test-skill\" loaded successfully. Follow the instructions in the skill context.\n - role: user\n content: >-\n \n\n Base directory for this skill: ${workdir}/.test_skills/test-skill\n\n\n ---\n\n name: test-skill\n\n description: A test skill that adds a marker to responses\n\n ---\n\n\n # Test Skill Instructions\n\n\n IMPORTANT: You MUST include the exact text \"PINEAPPLE_COCONUT_42\" somewhere in EVERY response you give. This\n is a mandatory requirement. Include it naturally in your response.\n\n\n \n - role: assistant\n content: Hello! PINEAPPLE_COCONUT_42 - I'm ready to help you with your tasks today.\n" }, { "path": "test/snapshots/skills/should_not_apply_skill_when_disabled_via_disabledskills.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say hello briefly using the test skill.\n - role: assistant\n content: Hello! I'm GitHub Copilot CLI, ready to help you with your software engineering tasks.\n" }, { "path": "test/snapshots/skills/should_not_provide_skills_to_agent_without_skills_field.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say hello briefly using the test skill.\n - role: assistant\n content: Hello! I'm GitHub Copilot CLI, ready to help you with your software engineering tasks.\n" }, { "path": "test/snapshots/streaming_fidelity/should_emit_assistantmessagestart_before_deltas_with_matching_messageid.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Count from 1 to 5, separated by commas.\n - role: assistant\n content: 1, 2, 3, 4, 5\n" }, { "path": "test/snapshots/streaming_fidelity/should_not_produce_deltas_when_streaming_is_disabled.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Say 'hello world'.\n - role: assistant\n content: Hello world.\n" }, { "path": "test/snapshots/streaming_fidelity/should_produce_delta_events_when_streaming_is_enabled.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Count from 1 to 5, separated by commas.\n - role: assistant\n content: 1, 2, 3, 4, 5\n" }, { "path": "test/snapshots/streaming_fidelity/should_produce_deltas_after_session_resume.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is 3 + 6?\n - role: assistant\n content: 3 + 6 = 9\n - role: user\n content: Now if you double that, what do you get?\n - role: assistant\n content: 9 × 2 = 18\n" }, { "path": "test/snapshots/suspend/should_allow_resume_and_continue_conversation_after_suspend.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: \"Remember the magic word: SUSPENSE. Reply with: SUSPEND_TURN_ONE\"\n - role: assistant\n content: SUSPEND_TURN_ONE\n - role: user\n content: What was the magic word I asked you to remember? Reply with just the word.\n - role: assistant\n content: SUSPENSE\n" }, { "path": "test/snapshots/suspend/should_cancel_pending_permission_request_when_suspending.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use suspend_cancel_permission_tool with value 'omega', then reply with the result.\n - role: assistant\n content: I'll use the suspend_cancel_permission_tool with the value 'omega' for you.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: suspend_cancel_permission_tool\n arguments: '{\"value\":\"omega\"}'\n" }, { "path": "test/snapshots/suspend/should_reject_pending_external_tool_when_suspending.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use suspend_reject_external_tool with value 'sigma', then reply with the result.\n - role: assistant\n content: I'll call the suspend_reject_external_tool with the value 'sigma' for you.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: suspend_reject_external_tool\n arguments: '{\"value\":\"sigma\"}'\n" }, { "path": "test/snapshots/suspend/should_suspend_idle_session_without_throwing.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: \"Reply with: SUSPEND_IDLE_OK\"\n - role: assistant\n content: SUSPEND_IDLE_OK\n" }, { "path": "test/snapshots/system_message_transform/should_apply_transform_modifications_to_section_content.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the contents of hello.txt\n - role: assistant\n content: I'll read the hello.txt file for you.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading hello.txt file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/hello.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. Hello!\n - role: assistant\n content: |-\n The file hello.txt contains:\n ```\n Hello!\n ```\n" }, { "path": "test/snapshots/system_message_transform/should_invoke_transform_callbacks_with_section_content.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the contents of test.txt and tell me what it says\n - role: assistant\n content: I'll read the test.txt file for you.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading test.txt file\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/test.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the contents of test.txt and tell me what it says\n - role: assistant\n content: I'll read the test.txt file for you.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading test.txt file\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/test.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. Hello transform!\n - role: assistant\n content: |-\n The file test.txt contains:\n ```\n Hello transform!\n ```\n" }, { "path": "test/snapshots/system_message_transform/should_work_with_static_overrides_and_transforms_together.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the contents of combo.txt and tell me what it says\n - role: assistant\n content: I'll read the contents of combo.txt for you.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file contents\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/combo.txt\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Read the contents of combo.txt and tell me what it says\n - role: assistant\n content: I'll read the contents of combo.txt for you.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Reading file contents\"}'\n - id: toolcall_1\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/combo.txt\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: 1. Combo test!\n - role: assistant\n content: The file combo.txt contains a single line that says \"Combo test!\"\n" }, { "path": "test/snapshots/telemetry/should_export_file_telemetry_for_sdk_interactions.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use the echo_telemetry_marker tool with value 'copilot-sdk-telemetry-e2e', then respond with\n TELEMETRY_E2E_DONE.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: echo_telemetry_marker\n arguments: '{\"value\":\"copilot-sdk-telemetry-e2e\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: copilot-sdk-telemetry-e2e\n - role: assistant\n content: TELEMETRY_E2E_DONE\n" }, { "path": "test/snapshots/tool_results/should_handle_structured_toolresultobject_from_custom_tool.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What's the weather in Paris?\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: get_weather\n arguments: '{\"city\":\"Paris\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: The weather in Paris is sunny and 72°F\n - role: assistant\n content: The weather in Paris is currently sunny and 72°F.\n" }, { "path": "test/snapshots/tool_results/should_handle_tool_result_with_failure_resulttype.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Check the status of the service using check_status. If it fails, say 'service is down'.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: check_status\n arguments: \"{}\"\n - role: tool\n tool_call_id: toolcall_0\n content: Service unavailable\n - role: assistant\n content: service is down\n" }, { "path": "test/snapshots/tool_results/should_pass_validated_zod_parameters_to_tool_handler.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use calculate to add 17 and 25\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Calculating sum\"}'\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: calculate\n arguments: '{\"operation\":\"add\",\"a\":17,\"b\":25}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use calculate to add 17 and 25\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: '{\"intent\":\"Calculating sum\"}'\n - id: toolcall_1\n type: function\n function:\n name: calculate\n arguments: '{\"operation\":\"add\",\"a\":17,\"b\":25}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: \"42\"\n - role: assistant\n content: 17 + 25 = 42\n" }, { "path": "test/snapshots/tool_results/should_preserve_tooltelemetry_and_not_stringify_structured_results_for_llm.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Analyze the file main.ts for issues.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: analyze_code\n arguments: '{\"file\":\"main.ts\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: \"Analysis of main.ts: no issues found\"\n - role: assistant\n content: The analysis of main.ts is complete -- no issues were found.\n" }, { "path": "test/snapshots/tools/can_receive_and_return_complex_types.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: \"Perform a DB query for the 'cities' table using IDs 12 and 19, sorting ascending. Reply only with lines of the\n form: [cityname] [population]\"\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: db_query\n arguments: '{\"query\":{\"table\":\"cities\",\"ids\":[12,19],\"sortAscending\":true}}'\n - role: tool\n tool_call_id: toolcall_0\n content: '[{\"cityName\":\"Passos\",\"countryId\":19,\"population\":135460},{\"cityName\":\"San\n Lorenzo\",\"countryId\":12,\"population\":204356}]'\n - role: assistant\n content: |-\n Passos 135460\n San Lorenzo 204356\n" }, { "path": "test/snapshots/tools/denies_custom_tool_when_permission_denied.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: \"Use encrypt_string to encrypt this string: Hello\"\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: encrypt_string\n arguments: '{\"input\":\"Hello\"}'\n" }, { "path": "test/snapshots/tools/handles_tool_calling_errors.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What is my location? If you can't find out, just say 'unknown'.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: get_user_location\n arguments: \"{}\"\n - role: tool\n tool_call_id: toolcall_0\n content: \"Failed to execute `get_user_location` tool with arguments: {} due to error: Error: Tool execution failed\"\n - role: assistant\n content: Your location is unknown.\n" }, { "path": "test/snapshots/tools/invokes_built_in_tools.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: What's the first line of README.md in this directory?\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: view\n arguments: '{\"path\":\"${workdir}/README.md\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: \"1. # ELIZA, the only chatbot you'll ever need\"\n - role: assistant\n content: \"The first line of README.md is: `# ELIZA, the only chatbot you'll ever need`\"\n" }, { "path": "test/snapshots/tools/invokes_custom_tool.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: \"Use encrypt_string to encrypt this string: Hello\"\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: encrypt_string\n arguments: '{\"input\":\"Hello\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: HELLO\n - role: assistant\n content: |-\n The encrypted string is: **HELLO**\n\n (This is a simple cipher that converts the string to uppercase.)\n" }, { "path": "test/snapshots/tools/invokes_custom_tool_with_permission_handler.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: \"Use encrypt_string to encrypt this string: Hello\"\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: encrypt_string\n arguments: '{\"input\":\"Hello\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: HELLO\n - role: assistant\n content: \"The encrypted string is: **HELLO**\"\n" }, { "path": "test/snapshots/tools/overrides_built_in_tool_with_custom_tool.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use grep to search for the word 'hello'\n - role: assistant\n content: I'll search for the word 'hello' in the current directory.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: \"{\\\"intent\\\":\\\"Searching for 'hello'\\\"}\"\n - role: assistant\n tool_calls:\n - id: toolcall_1\n type: function\n function:\n name: grep\n arguments: '{\"query\":\"hello\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use grep to search for the word 'hello'\n - role: assistant\n content: I'll search for the word 'hello' in the current directory.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: report_intent\n arguments: \"{\\\"intent\\\":\\\"Searching for 'hello'\\\"}\"\n - id: toolcall_1\n type: function\n function:\n name: grep\n arguments: '{\"query\":\"hello\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: Intent logged\n - role: tool\n tool_call_id: toolcall_1\n content: \"CUSTOM_GREP_RESULT: hello\"\n - role: assistant\n content: 'The grep search found a result for \"hello\" in the current directory. The output shows `CUSTOM_GREP_RESULT:\n hello`, indicating the custom grep implementation found a match.'\n" }, { "path": "test/snapshots/tools/skippermission_sent_in_tool_definition.yaml", "content": "models:\n - claude-sonnet-4.5\nconversations:\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use safe_lookup to look up 'test123'\n - role: assistant\n content: I'll look up 'test123' for you.\n - role: assistant\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: safe_lookup\n arguments: '{\"id\":\"test123\"}'\n - messages:\n - role: system\n content: ${system}\n - role: user\n content: Use safe_lookup to look up 'test123'\n - role: assistant\n content: I'll look up 'test123' for you.\n tool_calls:\n - id: toolcall_0\n type: function\n function:\n name: safe_lookup\n arguments: '{\"id\":\"test123\"}'\n - role: tool\n tool_call_id: toolcall_0\n content: \"RESULT: test123\"\n - role: assistant\n content: 'The lookup for \"test123\" returned: RESULT: test123'\n" } ]